components

package
v0.9.4 Latest Latest
Warning

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

 Go to latest Published: Oct 1, 2025 License: MIT Imports: 7 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Activity ¶ 

type Activity struct {
	Events []ActivityEvent `json:"events"`
}

func (*Activity) GetEvents ¶ 

func (a *Activity) GetEvents() []ActivityEvent

type ActivityEnum ¶ 

type ActivityEnum string

ActivityEnum - Activity e.g. search, home page visit or all. 

const (
	ActivityEnumAll    ActivityEnum = "ALL"
	ActivityEnumSearch ActivityEnum = "SEARCH"
)

func (ActivityEnum) ToPointer ¶ 

func (e ActivityEnum) ToPointer() *ActivityEnum

func (*ActivityEnum) UnmarshalJSON ¶ 

func (e *ActivityEnum) UnmarshalJSON(data []byte) error

type ActivityEvent ¶ 

type ActivityEvent struct {
	// Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored.
	ID *string `json:"id,omitempty"`
	// The type of activity this represents.
	Action ActivityEventAction  `json:"action"`
	Params *ActivityEventParams `json:"params,omitempty"`
	// The ISO 8601 timestamp when the activity began.
	Timestamp time.Time `json:"timestamp"`
	// The URL of the activity.
	URL string `json:"url"`
}

func (*ActivityEvent) GetAction ¶ 

func (a *ActivityEvent) GetAction() ActivityEventAction

func (*ActivityEvent) GetID ¶ 

func (a *ActivityEvent) GetID() *string

func (*ActivityEvent) GetParams ¶ 

func (a *ActivityEvent) GetParams() *ActivityEventParams

func (*ActivityEvent) GetTimestamp ¶ 

func (a *ActivityEvent) GetTimestamp() time.Time

func (*ActivityEvent) GetURL ¶ 

func (a *ActivityEvent) GetURL() string

func (ActivityEvent) MarshalJSON ¶ 

func (a ActivityEvent) MarshalJSON() ([]byte, error)

func (*ActivityEvent) UnmarshalJSON ¶ 

func (a *ActivityEvent) UnmarshalJSON(data []byte) error

type ActivityEventAction ¶ 

type ActivityEventAction string

ActivityEventAction - The type of activity this represents. 

const (
	ActivityEventActionView             ActivityEventAction = "VIEW"
	ActivityEventActionEdit             ActivityEventAction = "EDIT"
	ActivityEventActionSearch           ActivityEventAction = "SEARCH"
	ActivityEventActionComment          ActivityEventAction = "COMMENT"
	ActivityEventActionCrawl            ActivityEventAction = "CRAWL"
	ActivityEventActionHistoricalSearch ActivityEventAction = "HISTORICAL_SEARCH"
	ActivityEventActionHistoricalView   ActivityEventAction = "HISTORICAL_VIEW"
)

func (ActivityEventAction) ToPointer ¶ 

func (e ActivityEventAction) ToPointer() *ActivityEventAction

func (*ActivityEventAction) UnmarshalJSON ¶ 

func (e *ActivityEventAction) UnmarshalJSON(data []byte) error

type ActivityEventParams ¶ 

type ActivityEventParams struct {
	// The HTML content of the page body.
	BodyContent *string `json:"bodyContent,omitempty"`
	// The full datasource instance name inferred from the URL of the event
	DatasourceInstance *string `json:"datasourceInstance,omitempty"`
	// The datasource without the instance inferred from the URL of the event
	Datasource *string `json:"datasource,omitempty"`
	// The instance only name of the datasource instance, e.g. 1 for jira_1, inferred from the URL of the event
	InstanceOnlyName *string `json:"instanceOnlyName,omitempty"`
	// Length in seconds of the activity. For VIEWS, this represents the amount the page was visible in the foreground.
	Duration *int64 `json:"duration,omitempty"`
	// The user's search query associated with a SEARCH.
	Query *string `json:"query,omitempty"`
	// The referring URL of the VIEW or SEARCH.
	Referrer *string `json:"referrer,omitempty"`
	// The page title associated with the URL of the event
	Title *string `json:"title,omitempty"`
	// Indicates that the parameters are incomplete and more parameters may be sent with the same action+timestamp+URL in the future. This is used for sending the duration when a `VIEW` is finished.
	Truncated *bool `json:"truncated,omitempty"`
}

func (*ActivityEventParams) GetBodyContent ¶ 

func (a *ActivityEventParams) GetBodyContent() *string

func (*ActivityEventParams) GetDatasource ¶ 

func (a *ActivityEventParams) GetDatasource() *string

func (*ActivityEventParams) GetDatasourceInstance ¶ 

func (a *ActivityEventParams) GetDatasourceInstance() *string

func (*ActivityEventParams) GetDuration ¶ 

func (a *ActivityEventParams) GetDuration() *int64

func (*ActivityEventParams) GetInstanceOnlyName ¶ 

func (a *ActivityEventParams) GetInstanceOnlyName() *string

func (*ActivityEventParams) GetQuery ¶ 

func (a *ActivityEventParams) GetQuery() *string

func (*ActivityEventParams) GetReferrer ¶ 

func (a *ActivityEventParams) GetReferrer() *string

func (*ActivityEventParams) GetTitle ¶ 

func (a *ActivityEventParams) GetTitle() *string

func (*ActivityEventParams) GetTruncated ¶ 

func (a *ActivityEventParams) GetTruncated() *bool

type AddCollectionItemsError ¶ 

type AddCollectionItemsError struct {
	ErrorType *AddCollectionItemsErrorErrorType `json:"errorType,omitempty"`
}

func (*AddCollectionItemsError) GetErrorType ¶ 

func (a *AddCollectionItemsError) GetErrorType() *AddCollectionItemsErrorErrorType

type AddCollectionItemsErrorErrorType ¶ 

type AddCollectionItemsErrorErrorType string
const (
	AddCollectionItemsErrorErrorTypeExistingItem AddCollectionItemsErrorErrorType = "EXISTING_ITEM"
)

func (AddCollectionItemsErrorErrorType) ToPointer ¶ 

func (e AddCollectionItemsErrorErrorType) ToPointer() *AddCollectionItemsErrorErrorType

func (*AddCollectionItemsErrorErrorType) UnmarshalJSON ¶ 

func (e *AddCollectionItemsErrorErrorType) UnmarshalJSON(data []byte) error

type AddCollectionItemsRequest ¶ 

type AddCollectionItemsRequest struct {
	// The ID of the Collection to add items to.
	CollectionID float64 `json:"collectionId"`
	// The CollectionItemDescriptors of the items being added.
	AddedCollectionItemDescriptors []CollectionItemDescriptor `json:"addedCollectionItemDescriptors,omitempty"`
}

func (*AddCollectionItemsRequest) GetAddedCollectionItemDescriptors ¶ 

func (a *AddCollectionItemsRequest) GetAddedCollectionItemDescriptors() []CollectionItemDescriptor

func (*AddCollectionItemsRequest) GetCollectionID ¶ 

func (a *AddCollectionItemsRequest) GetCollectionID() float64

type AddCollectionItemsResponse ¶ 

type AddCollectionItemsResponse struct {
	Collection *Collection              `json:"collection,omitempty"`
	Error      *AddCollectionItemsError `json:"error,omitempty"`
}

func (*AddCollectionItemsResponse) GetCollection ¶ 

func (a *AddCollectionItemsResponse) GetCollection() *Collection

func (*AddCollectionItemsResponse) GetError ¶ 

func (a *AddCollectionItemsResponse) GetError() *AddCollectionItemsError

type AdditionalFieldDefinition ¶ 

type AdditionalFieldDefinition struct {
	// Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores.
	Key *string `json:"key,omitempty"`
	// List of type string or HypertextField.
	//
	// HypertextField is defined as
	// “`
	// {
	//   anchor: string,    // Anchor text for the hypertext field.
	//   hyperlink: string, // URL for the hypertext field.
	// }
	// “`
	// Example: “`{"anchor":"Glean","hyperlink":"https://glean.com"}“`
	//
	// When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs.
	//
	// **Note**: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored.
	// Example: “`"languages": [{"lang":"English","lang":"Spanish",...}]“`. In this case, the key "lang" will be ignored and can even be passed in as an empty string.
	//
	Value []Value `json:"value,omitempty"`
}

AdditionalFieldDefinition - Additional information about the employee or team.

func (*AdditionalFieldDefinition) GetKey ¶ 

func (a *AdditionalFieldDefinition) GetKey() *string

func (*AdditionalFieldDefinition) GetValue ¶ 

func (a *AdditionalFieldDefinition) GetValue() []Value

type Agent ¶ 

type Agent struct {
	// The ID of the agent.
	AgentID string `json:"agent_id"`
	// The name of the agent
	Name string `json:"name"`
	// The description of the agent.
	Description *string `json:"description,omitempty"`
	// The agent metadata. Currently not implemented.
	Metadata *AgentMetadata `json:"metadata,omitempty"`
	// Describes features that the agent supports. example: {
	//   "ap.io.messages": true,
	//   "ap.io.streaming": true
	// }
	Capabilities AgentCapabilities `json:"capabilities"`
}

func (*Agent) GetAgentID ¶ 

func (a *Agent) GetAgentID() string

func (*Agent) GetCapabilities ¶ 

func (a *Agent) GetCapabilities() AgentCapabilities

func (*Agent) GetDescription ¶ 

func (a *Agent) GetDescription() *string

func (*Agent) GetMetadata ¶ 

func (a *Agent) GetMetadata() *AgentMetadata

func (*Agent) GetName ¶ 

func (a *Agent) GetName() string

type AgentCapabilities ¶ 

type AgentCapabilities struct {
	// Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent.
	ApIoMessages *bool `json:"ap.io.messages,omitempty"`
	// Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
	ApIoStreaming        *bool          `json:"ap.io.streaming,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}
AgentCapabilities - Describes features that the agent supports. example: {
  "ap.io.messages": true,
  "ap.io.streaming": true
}

func (*AgentCapabilities) GetAdditionalProperties ¶ 

func (a *AgentCapabilities) GetAdditionalProperties() map[string]any

func (*AgentCapabilities) GetApIoMessages ¶ 

func (a *AgentCapabilities) GetApIoMessages() *bool

func (*AgentCapabilities) GetApIoStreaming ¶ 

func (a *AgentCapabilities) GetApIoStreaming() *bool

func (AgentCapabilities) MarshalJSON ¶ 

func (a AgentCapabilities) MarshalJSON() ([]byte, error)

func (*AgentCapabilities) UnmarshalJSON ¶ 

func (a *AgentCapabilities) UnmarshalJSON(data []byte) error

type AgentConfig ¶ 

type AgentConfig struct {
	// Name of the agent.
	Agent *AgentEnum `json:"agent,omitempty"`
	// The types of tools that the agent is allowed to use. Only works with FAST and ADVANCED `agent` values
	ToolSets *ToolSets `json:"toolSets,omitempty"`
	// Top level modes to run GleanChat in.
	Mode *Mode `json:"mode,omitempty"`
}

AgentConfig - Describes the agent that executes the request.

func (*AgentConfig) GetAgent ¶ 

func (a *AgentConfig) GetAgent() *AgentEnum

func (*AgentConfig) GetMode ¶ 

func (a *AgentConfig) GetMode() *Mode

func (*AgentConfig) GetToolSets ¶ added in v0.9.0 

func (a *AgentConfig) GetToolSets() *ToolSets

type AgentEnum ¶ 

type AgentEnum string

AgentEnum - Name of the agent. 

const (
	AgentEnumDefault   AgentEnum = "DEFAULT"
	AgentEnumGpt       AgentEnum = "GPT"
	AgentEnumUniversal AgentEnum = "UNIVERSAL"
	AgentEnumFast      AgentEnum = "FAST"
	AgentEnumAdvanced  AgentEnum = "ADVANCED"
)

func (AgentEnum) ToPointer ¶ 

func (e AgentEnum) ToPointer() *AgentEnum

func (*AgentEnum) UnmarshalJSON ¶ 

func (e *AgentEnum) UnmarshalJSON(data []byte) error

type AgentExecutionStatus ¶ 

type AgentExecutionStatus string

AgentExecutionStatus - The status of the run. One of 'error', 'success'. 

const (
	AgentExecutionStatusError   AgentExecutionStatus = "error"
	AgentExecutionStatusSuccess AgentExecutionStatus = "success"
)

func (AgentExecutionStatus) ToPointer ¶ 

func (e AgentExecutionStatus) ToPointer() *AgentExecutionStatus

func (*AgentExecutionStatus) UnmarshalJSON ¶ 

func (e *AgentExecutionStatus) UnmarshalJSON(data []byte) error

type AgentMetadata ¶ 

type AgentMetadata struct {
}

AgentMetadata - The agent metadata. Currently not implemented.

type AgentRun ¶ 

type AgentRun struct {
	// The ID of the agent to run.
	AgentID string `json:"agent_id"`
	// The input to the agent.
	Input map[string]any `json:"input,omitempty"`
	// The messages to pass an input to the agent.
	Messages []Message `json:"messages,omitempty"`
	// The metadata to pass to the agent.
	Metadata map[string]any `json:"metadata,omitempty"`
	// The status of the run. One of 'error', 'success'.
	Status *AgentExecutionStatus `json:"status,omitempty"`
}

AgentRun - Payload for creating a run.

func (*AgentRun) GetAgentID ¶ 

func (a *AgentRun) GetAgentID() string

func (*AgentRun) GetInput ¶ 

func (a *AgentRun) GetInput() map[string]any

func (*AgentRun) GetMessages ¶ 

func (a *AgentRun) GetMessages() []Message

func (*AgentRun) GetMetadata ¶ added in v0.6.4 

func (a *AgentRun) GetMetadata() map[string]any

func (*AgentRun) GetStatus ¶ 

func (a *AgentRun) GetStatus() *AgentExecutionStatus

type AgentRunCreate ¶ 

type AgentRunCreate struct {
	// The ID of the agent to run.
	AgentID string `json:"agent_id"`
	// The input to the agent.
	Input map[string]any `json:"input,omitempty"`
	// The messages to pass an input to the agent.
	Messages []Message `json:"messages,omitempty"`
	// The metadata to pass to the agent.
	Metadata map[string]any `json:"metadata,omitempty"`
}

AgentRunCreate - Payload for creating a run.

func (*AgentRunCreate) GetAgentID ¶ 

func (a *AgentRunCreate) GetAgentID() string

func (*AgentRunCreate) GetInput ¶ 

func (a *AgentRunCreate) GetInput() map[string]any

func (*AgentRunCreate) GetMessages ¶ 

func (a *AgentRunCreate) GetMessages() []Message

func (*AgentRunCreate) GetMetadata ¶ added in v0.6.4 

func (a *AgentRunCreate) GetMetadata() map[string]any

type AgentRunWaitResponse ¶ 

type AgentRunWaitResponse struct {
	Run *AgentRun `json:"run,omitempty"`
	// The messages returned by the run.
	Messages []Message `json:"messages,omitempty"`
}

func (*AgentRunWaitResponse) GetMessages ¶ 

func (a *AgentRunWaitResponse) GetMessages() []Message

func (*AgentRunWaitResponse) GetRun ¶ 

func (a *AgentRunWaitResponse) GetRun() *AgentRun

type AgentSchemas ¶ 

type AgentSchemas struct {
	// The ID of the agent.
	AgentID string `json:"agent_id"`
	// The schema for the agent input. In JSON Schema format.
	InputSchema InputSchema `json:"input_schema"`
	// The schema for the agent output. In JSON Schema format.
	OutputSchema OutputSchema `json:"output_schema"`
}

AgentSchemas - Defines the structure and properties of an agent.

func (*AgentSchemas) GetAgentID ¶ 

func (a *AgentSchemas) GetAgentID() string

func (*AgentSchemas) GetInputSchema ¶ 

func (a *AgentSchemas) GetInputSchema() InputSchema

func (*AgentSchemas) GetOutputSchema ¶ 

func (a *AgentSchemas) GetOutputSchema() OutputSchema

type AgentsInsightsV2Request ¶ added in v0.9.3 

type AgentsInsightsV2Request struct {
	// IDs of the Agents for which Insights should be returned. An empty array signifies all.
	AgentIds []string `json:"agentIds,omitempty"`
	// Departments for which Insights are requested.
	Departments []string `json:"departments,omitempty"`
	DayRange    *Period  `json:"dayRange,omitempty"`
}

func (*AgentsInsightsV2Request) GetAgentIds ¶ added in v0.9.3 

func (a *AgentsInsightsV2Request) GetAgentIds() []string

func (*AgentsInsightsV2Request) GetDayRange ¶ added in v0.9.3 

func (a *AgentsInsightsV2Request) GetDayRange() *Period

func (*AgentsInsightsV2Request) GetDepartments ¶ added in v0.9.3 

func (a *AgentsInsightsV2Request) GetDepartments() []string

type AiAppActionCounts ¶ 

type AiAppActionCounts struct {
	// Total number of Slackbot responses, both proactive and reactive.
	TotalSlackbotResponses *int64 `json:"totalSlackbotResponses,omitempty"`
	// Total number of Slackbot responses shared publicly (upvoted).
	TotalSlackbotResponsesShared *int64 `json:"totalSlackbotResponsesShared,omitempty"`
	// Total number of Slackbot responses rejected as not helpful (downvoted).
	TotalSlackbotResponsesNotHelpful *int64 `json:"totalSlackbotResponsesNotHelpful,omitempty"`
	// Total number of Chat messages sent in requested period.
	TotalChatMessages *int64 `json:"totalChatMessages,omitempty"`
	// Total number of Chat messages which received upvotes by the user.
	TotalUpvotes *int64 `json:"totalUpvotes,omitempty"`
	// Total number of Chat messages which received downvotes by the user.
	TotalDownvotes       *int64           `json:"totalDownvotes,omitempty"`
	AdditionalProperties map[string]int64 `additionalProperties:"true" json:"-"`
}

AiAppActionCounts - Map from action to frequency.

func (*AiAppActionCounts) GetAdditionalProperties ¶ 

func (a *AiAppActionCounts) GetAdditionalProperties() map[string]int64

func (*AiAppActionCounts) GetTotalChatMessages ¶ 

func (a *AiAppActionCounts) GetTotalChatMessages() *int64

func (*AiAppActionCounts) GetTotalDownvotes ¶ 

func (a *AiAppActionCounts) GetTotalDownvotes() *int64

func (*AiAppActionCounts) GetTotalSlackbotResponses ¶ 

func (a *AiAppActionCounts) GetTotalSlackbotResponses() *int64

func (*AiAppActionCounts) GetTotalSlackbotResponsesNotHelpful ¶ 

func (a *AiAppActionCounts) GetTotalSlackbotResponsesNotHelpful() *int64

func (*AiAppActionCounts) GetTotalSlackbotResponsesShared ¶ 

func (a *AiAppActionCounts) GetTotalSlackbotResponsesShared() *int64

func (*AiAppActionCounts) GetTotalUpvotes ¶ 

func (a *AiAppActionCounts) GetTotalUpvotes() *int64

func (AiAppActionCounts) MarshalJSON ¶ 

func (a AiAppActionCounts) MarshalJSON() ([]byte, error)

func (*AiAppActionCounts) UnmarshalJSON ¶ 

func (a *AiAppActionCounts) UnmarshalJSON(data []byte) error

type AiAppsInsightsResponse ¶ 

type AiAppsInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp *int64                `json:"lastLogTimestamp,omitempty"`
	AiAppInsights    []UserActivityInsight `json:"aiAppInsights,omitempty"`
	// Total number of active users on the Ai App in the requested period.
	TotalActiveUsers *int64 `json:"totalActiveUsers,omitempty"`
	// Map from action to frequency.
	ActionCounts *AiAppActionCounts `json:"actionCounts,omitempty"`
	// list of departments applicable for users tab.
	Departments []string `json:"departments,omitempty"`
}

func (*AiAppsInsightsResponse) GetActionCounts ¶ 

func (a *AiAppsInsightsResponse) GetActionCounts() *AiAppActionCounts

func (*AiAppsInsightsResponse) GetAiAppInsights ¶ 

func (a *AiAppsInsightsResponse) GetAiAppInsights() []UserActivityInsight

func (*AiAppsInsightsResponse) GetDepartments ¶ 

func (a *AiAppsInsightsResponse) GetDepartments() []string

func (*AiAppsInsightsResponse) GetLastLogTimestamp ¶ 

func (a *AiAppsInsightsResponse) GetLastLogTimestamp() *int64

func (*AiAppsInsightsResponse) GetTotalActiveUsers ¶ 

func (a *AiAppsInsightsResponse) GetTotalActiveUsers() *int64

type AiInsightsResponse ¶ 

type AiInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp  *int64                `json:"lastLogTimestamp,omitempty"`
	AssistantInsights []UserActivityInsight `json:"assistantInsights,omitempty"`
	// Total number of Active Assistant users (chat, summary, AIA) in requested period.
	TotalActiveAssistantUsers *int64 `json:"totalActiveAssistantUsers,omitempty"`
	// Total number of Chat messages sent in requested period.
	TotalChatMessages *int64 `json:"totalChatMessages,omitempty"`
	// Total number of AI Document Summarizations invoked in the requested period.
	TotalAiSummarizations *int64 `json:"totalAiSummarizations,omitempty"`
	// Total number of AI Answers generated in the requested period.
	TotalAiAnswers *int64 `json:"totalAiAnswers,omitempty"`
	// Total number of Chat messages which received upvotes by the user.
	TotalUpvotes *int64 `json:"totalUpvotes,omitempty"`
	// Total number of Chat messages which received downvotes by the user.
	TotalDownvotes *int64 `json:"totalDownvotes,omitempty"`
	// Total number of Gleanbot responses, both proactive and reactive.
	TotalGleanbotResponses *int64 `json:"totalGleanbotResponses,omitempty"`
	// Total number of Gleanbot responses shared publicly (upvoted).
	TotalGleanbotResponsesShared *int64 `json:"totalGleanbotResponsesShared,omitempty"`
	// Total number of Glean responses rejected as not helpful (downvoted).
	TotalGleanbotResponsesNotHelpful *int64 `json:"totalGleanbotResponsesNotHelpful,omitempty"`
	// list of departments applicable for users tab.
	Departments []string `json:"departments,omitempty"`
}

func (*AiInsightsResponse) GetAssistantInsights ¶ 

func (a *AiInsightsResponse) GetAssistantInsights() []UserActivityInsight

func (*AiInsightsResponse) GetDepartments ¶ 

func (a *AiInsightsResponse) GetDepartments() []string

func (*AiInsightsResponse) GetLastLogTimestamp ¶ 

func (a *AiInsightsResponse) GetLastLogTimestamp() *int64

func (*AiInsightsResponse) GetTotalActiveAssistantUsers ¶ 

func (a *AiInsightsResponse) GetTotalActiveAssistantUsers() *int64

func (*AiInsightsResponse) GetTotalAiAnswers ¶ 

func (a *AiInsightsResponse) GetTotalAiAnswers() *int64

func (*AiInsightsResponse) GetTotalAiSummarizations ¶ 

func (a *AiInsightsResponse) GetTotalAiSummarizations() *int64

func (*AiInsightsResponse) GetTotalChatMessages ¶ 

func (a *AiInsightsResponse) GetTotalChatMessages() *int64

func (*AiInsightsResponse) GetTotalDownvotes ¶ 

func (a *AiInsightsResponse) GetTotalDownvotes() *int64

func (*AiInsightsResponse) GetTotalGleanbotResponses ¶ 

func (a *AiInsightsResponse) GetTotalGleanbotResponses() *int64

func (*AiInsightsResponse) GetTotalGleanbotResponsesNotHelpful ¶ 

func (a *AiInsightsResponse) GetTotalGleanbotResponsesNotHelpful() *int64

func (*AiInsightsResponse) GetTotalGleanbotResponsesShared ¶ 

func (a *AiInsightsResponse) GetTotalGleanbotResponsesShared() *int64

func (*AiInsightsResponse) GetTotalUpvotes ¶ 

func (a *AiInsightsResponse) GetTotalUpvotes() *int64

type AllowlistOptions ¶ 

type AllowlistOptions struct {
	// list of words and phrases to consider as whitelisted content
	Terms []string `json:"terms,omitempty"`
}

AllowlistOptions - Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation.

func (*AllowlistOptions) GetTerms ¶ 

func (a *AllowlistOptions) GetTerms() []string

type Announcement ¶ 

type Announcement struct {
	// The date and time at which the announcement becomes active.
	StartTime *time.Time `json:"startTime,omitempty"`
	// The date and time at which the announcement expires.
	EndTime *time.Time `json:"endTime,omitempty"`
	// The headline of the announcement.
	Title *string         `json:"title,omitempty"`
	Body  *StructuredText `json:"body,omitempty"`
	// An emoji used to indicate the nature of the announcement.
	Emoji     *string    `json:"emoji,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	Banner    *Thumbnail `json:"banner,omitempty"`
	// Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
	SourceDocumentID *string `json:"sourceDocumentId,omitempty"`
	// Whether or not to hide an author attribution.
	HideAttribution *bool `json:"hideAttribution,omitempty"`
	// This determines whether this is a Social Feed post or a regular announcement.
	Channel *AnnouncementChannel `json:"channel,omitempty"`
	// This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.
	PostType *AnnouncementPostType `json:"postType,omitempty"`
	// Used by the Social Feed to pin posts to the front of the feed.
	IsPrioritized *bool `json:"isPrioritized,omitempty"`
	// URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".
	ViewURL *string `json:"viewUrl,omitempty"`
	// The opaque id of the associated draft.
	DraftID     *int64             `json:"draftId,omitempty"`
	Permissions *ObjectPermissions `json:"permissions,omitempty"`
	// The opaque id of the announcement.
	ID     *int64  `json:"id,omitempty"`
	Author *Person `json:"author,omitempty"`
	// Server Unix timestamp of the creation time (in seconds since epoch UTC).
	CreateTimestamp *int64 `json:"createTimestamp,omitempty"`
	// Server Unix timestamp of the last update time (in seconds since epoch UTC).
	LastUpdateTimestamp *int64                  `json:"lastUpdateTimestamp,omitempty"`
	UpdatedBy           *Person                 `json:"updatedBy,omitempty"`
	ViewerInfo          *AnnouncementViewerInfo `json:"viewerInfo,omitempty"`
	SourceDocument      *Document               `json:"sourceDocument,omitempty"`
	// Whether or not the announcement is published.
	IsPublished *bool `json:"isPublished,omitempty"`
}

func (*Announcement) GetAudienceFilters ¶ 

func (a *Announcement) GetAudienceFilters() []FacetFilter

func (*Announcement) GetAuthor ¶ 

func (a *Announcement) GetAuthor() *Person

func (*Announcement) GetBanner ¶ 

func (a *Announcement) GetBanner() *Thumbnail

func (*Announcement) GetBody ¶ 

func (a *Announcement) GetBody() *StructuredText

func (*Announcement) GetChannel ¶ 

func (a *Announcement) GetChannel() *AnnouncementChannel

func (*Announcement) GetCreateTimestamp ¶ 

func (a *Announcement) GetCreateTimestamp() *int64

func (*Announcement) GetDraftID ¶ 

func (a *Announcement) GetDraftID() *int64

func (*Announcement) GetEmoji ¶ 

func (a *Announcement) GetEmoji() *string

func (*Announcement) GetEndTime ¶ 

func (a *Announcement) GetEndTime() *time.Time

func (*Announcement) GetHideAttribution ¶ 

func (a *Announcement) GetHideAttribution() *bool

func (*Announcement) GetID ¶ 

func (a *Announcement) GetID() *int64

func (*Announcement) GetIsPrioritized ¶ 

func (a *Announcement) GetIsPrioritized() *bool

func (*Announcement) GetIsPublished ¶ 

func (a *Announcement) GetIsPublished() *bool

func (*Announcement) GetLastUpdateTimestamp ¶ 

func (a *Announcement) GetLastUpdateTimestamp() *int64

func (*Announcement) GetPermissions ¶ 

func (a *Announcement) GetPermissions() *ObjectPermissions

func (*Announcement) GetPostType ¶ 

func (a *Announcement) GetPostType() *AnnouncementPostType

func (*Announcement) GetSourceDocument ¶ 

func (a *Announcement) GetSourceDocument() *Document

func (*Announcement) GetSourceDocumentID ¶ 

func (a *Announcement) GetSourceDocumentID() *string

func (*Announcement) GetStartTime ¶ 

func (a *Announcement) GetStartTime() *time.Time

func (*Announcement) GetThumbnail ¶ 

func (a *Announcement) GetThumbnail() *Thumbnail

func (*Announcement) GetTitle ¶ 

func (a *Announcement) GetTitle() *string

func (*Announcement) GetUpdatedBy ¶ 

func (a *Announcement) GetUpdatedBy() *Person

func (*Announcement) GetViewURL ¶ 

func (a *Announcement) GetViewURL() *string

func (*Announcement) GetViewerInfo ¶ 

func (a *Announcement) GetViewerInfo() *AnnouncementViewerInfo

func (Announcement) MarshalJSON ¶ 

func (a Announcement) MarshalJSON() ([]byte, error)

func (*Announcement) UnmarshalJSON ¶ 

func (a *Announcement) UnmarshalJSON(data []byte) error

type AnnouncementChannel ¶ 

type AnnouncementChannel string

AnnouncementChannel - This determines whether this is a Social Feed post or a regular announcement. 

const (
	AnnouncementChannelMain       AnnouncementChannel = "MAIN"
	AnnouncementChannelSocialFeed AnnouncementChannel = "SOCIAL_FEED"
)

func (AnnouncementChannel) ToPointer ¶ 

func (e AnnouncementChannel) ToPointer() *AnnouncementChannel

func (*AnnouncementChannel) UnmarshalJSON ¶ 

func (e *AnnouncementChannel) UnmarshalJSON(data []byte) error

type AnnouncementPostType ¶ 

type AnnouncementPostType string

AnnouncementPostType - This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. 

const (
	AnnouncementPostTypeText AnnouncementPostType = "TEXT"
	AnnouncementPostTypeLink AnnouncementPostType = "LINK"
)

func (AnnouncementPostType) ToPointer ¶ 

func (e AnnouncementPostType) ToPointer() *AnnouncementPostType

func (*AnnouncementPostType) UnmarshalJSON ¶ 

func (e *AnnouncementPostType) UnmarshalJSON(data []byte) error

type AnnouncementViewerInfo ¶ 

type AnnouncementViewerInfo struct {
	// Whether the viewer has dismissed the announcement.
	IsDismissed *bool `json:"isDismissed,omitempty"`
	// Whether the viewer has read the announcement.
	IsRead *bool `json:"isRead,omitempty"`
}

func (*AnnouncementViewerInfo) GetIsDismissed ¶ 

func (a *AnnouncementViewerInfo) GetIsDismissed() *bool

func (*AnnouncementViewerInfo) GetIsRead ¶ 

func (a *AnnouncementViewerInfo) GetIsRead() *bool

type AnonymousEvent ¶ 

type AnonymousEvent struct {
	Time *TimeInterval `json:"time,omitempty"`
	// The nature of the event, for example "out of office".
	EventType *AnonymousEventEventType `json:"eventType,omitempty"`
}

AnonymousEvent - A generic, light-weight calendar event.

func (*AnonymousEvent) GetEventType ¶ 

func (a *AnonymousEvent) GetEventType() *AnonymousEventEventType

func (*AnonymousEvent) GetTime ¶ 

func (a *AnonymousEvent) GetTime() *TimeInterval

func (AnonymousEvent) MarshalJSON ¶ added in v0.9.0 

func (a AnonymousEvent) MarshalJSON() ([]byte, error)

func (*AnonymousEvent) UnmarshalJSON ¶ added in v0.9.0 

func (a *AnonymousEvent) UnmarshalJSON(data []byte) error

type AnonymousEventEventType ¶ 

type AnonymousEventEventType string

AnonymousEventEventType - The nature of the event, for example "out of office". 

const (
	AnonymousEventEventTypeDefault     AnonymousEventEventType = "DEFAULT"
	AnonymousEventEventTypeOutOfOffice AnonymousEventEventType = "OUT_OF_OFFICE"
)

func (AnonymousEventEventType) ToPointer ¶ 

func (e AnonymousEventEventType) ToPointer() *AnonymousEventEventType

func (*AnonymousEventEventType) UnmarshalJSON ¶ 

func (e *AnonymousEventEventType) UnmarshalJSON(data []byte) error

type Answer ¶ 

type Answer struct {
	// The opaque ID of the Answer.
	ID int64 `json:"id"`
	// Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
	DocID    *string `json:"docId,omitempty"`
	Question *string `json:"question,omitempty"`
	// Additional ways of phrasing this question.
	QuestionVariations []string `json:"questionVariations,omitempty"`
	// The plain text answer to the question.
	BodyText *string `json:"bodyText,omitempty"`
	// The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	BoardID *int64 `json:"boardId,omitempty"`
	// Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// A list of user roles for the answer added by the owner.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of user roles for the answer removed by the owner.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// A list of roles for this answer explicitly granted by an owner, editor, or admin.
	Roles              []UserRoleSpecification `json:"roles,omitempty"`
	SourceDocumentSpec *DocumentSpecUnion      `json:"sourceDocumentSpec,omitempty"`
	SourceType         *AnswerSourceType       `json:"sourceType,omitempty"`
	Permissions        *ObjectPermissions      `json:"permissions,omitempty"`
	CombinedAnswerText *StructuredText         `json:"combinedAnswerText,omitempty"`
	Likes              *AnswerLikes            `json:"likes,omitempty"`
	Author             *Person                 `json:"author,omitempty"`
	// The time the answer was created in ISO format (ISO 8601).
	CreateTime *time.Time `json:"createTime,omitempty"`
	// The time the answer was last updated in ISO format (ISO 8601).
	UpdateTime   *time.Time    `json:"updateTime,omitempty"`
	UpdatedBy    *Person       `json:"updatedBy,omitempty"`
	Verification *Verification `json:"verification,omitempty"`
	Board        *AnswerBoard  `json:"board,omitempty"`
	// The collections to which the answer belongs.
	Collections []Collection `json:"collections,omitempty"`
	// The document's document_category(.proto).
	DocumentCategory *string   `json:"documentCategory,omitempty"`
	SourceDocument   *Document `json:"sourceDocument,omitempty"`
}

func (*Answer) GetAddedRoles ¶ 

func (a *Answer) GetAddedRoles() []UserRoleSpecification

func (*Answer) GetAudienceFilters ¶ 

func (a *Answer) GetAudienceFilters() []FacetFilter

func (*Answer) GetAuthor ¶ 

func (a *Answer) GetAuthor() *Person

func (*Answer) GetBoard ¶ 

func (a *Answer) GetBoard() *AnswerBoard

func (*Answer) GetBoardID ¶ 

func (a *Answer) GetBoardID() *int64

func (*Answer) GetBodyText ¶ 

func (a *Answer) GetBodyText() *string

func (*Answer) GetCollections ¶ 

func (a *Answer) GetCollections() []Collection

func (*Answer) GetCombinedAnswerText ¶ 

func (a *Answer) GetCombinedAnswerText() *StructuredText

func (*Answer) GetCreateTime ¶ 

func (a *Answer) GetCreateTime() *time.Time

func (*Answer) GetDocID ¶ 

func (a *Answer) GetDocID() *string

func (*Answer) GetDocumentCategory ¶ 

func (a *Answer) GetDocumentCategory() *string

func (*Answer) GetID ¶ 

func (a *Answer) GetID() int64

func (*Answer) GetLikes ¶ 

func (a *Answer) GetLikes() *AnswerLikes

func (*Answer) GetPermissions ¶ 

func (a *Answer) GetPermissions() *ObjectPermissions

func (*Answer) GetQuestion ¶ 

func (a *Answer) GetQuestion() *string

func (*Answer) GetQuestionVariations ¶ 

func (a *Answer) GetQuestionVariations() []string

func (*Answer) GetRemovedRoles ¶ 

func (a *Answer) GetRemovedRoles() []UserRoleSpecification

func (*Answer) GetRoles ¶ 

func (a *Answer) GetRoles() []UserRoleSpecification

func (*Answer) GetSourceDocument ¶ 

func (a *Answer) GetSourceDocument() *Document

func (*Answer) GetSourceDocumentSpec ¶ 

func (a *Answer) GetSourceDocumentSpec() *DocumentSpecUnion

func (*Answer) GetSourceType ¶ 

func (a *Answer) GetSourceType() *AnswerSourceType

func (*Answer) GetUpdateTime ¶ 

func (a *Answer) GetUpdateTime() *time.Time

func (*Answer) GetUpdatedBy ¶ 

func (a *Answer) GetUpdatedBy() *Person

func (*Answer) GetVerification ¶ 

func (a *Answer) GetVerification() *Verification

func (Answer) MarshalJSON ¶ 

func (a Answer) MarshalJSON() ([]byte, error)

func (*Answer) UnmarshalJSON ¶ 

func (a *Answer) UnmarshalJSON(data []byte) error

type AnswerBoard ¶ 

type AnswerBoard struct {
	// The unique name of the Collection.
	Name string `json:"name"`
	// A brief summary of the Collection's contents.
	Description string `json:"description"`
	// A list of added user roles for the Collection.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of removed user roles for the Collection.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter      `json:"audienceFilters,omitempty"`
	Permissions     *ObjectPermissions `json:"permissions,omitempty"`
	// The unique ID of the Answer Board.
	ID         int64      `json:"id"`
	CreateTime *time.Time `json:"createTime,omitempty"`
	UpdateTime *time.Time `json:"updateTime,omitempty"`
	Creator    *Person    `json:"creator,omitempty"`
	UpdatedBy  *Person    `json:"updatedBy,omitempty"`
	// The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items.
	ItemCount *int64 `json:"itemCount,omitempty"`
	// A list of user roles for the Answer Board.
	Roles []UserRoleSpecification `json:"roles,omitempty"`
}

func (*AnswerBoard) GetAddedRoles ¶ 

func (a *AnswerBoard) GetAddedRoles() []UserRoleSpecification

func (*AnswerBoard) GetAudienceFilters ¶ 

func (a *AnswerBoard) GetAudienceFilters() []FacetFilter

func (*AnswerBoard) GetCreateTime ¶ 

func (a *AnswerBoard) GetCreateTime() *time.Time

func (*AnswerBoard) GetCreator ¶ 

func (a *AnswerBoard) GetCreator() *Person

func (*AnswerBoard) GetDescription ¶ 

func (a *AnswerBoard) GetDescription() string

func (*AnswerBoard) GetID ¶ 

func (a *AnswerBoard) GetID() int64

func (*AnswerBoard) GetItemCount ¶ 

func (a *AnswerBoard) GetItemCount() *int64

func (*AnswerBoard) GetName ¶ 

func (a *AnswerBoard) GetName() string

func (*AnswerBoard) GetPermissions ¶ 

func (a *AnswerBoard) GetPermissions() *ObjectPermissions

func (*AnswerBoard) GetRemovedRoles ¶ 

func (a *AnswerBoard) GetRemovedRoles() []UserRoleSpecification

func (*AnswerBoard) GetRoles ¶ 

func (a *AnswerBoard) GetRoles() []UserRoleSpecification

func (*AnswerBoard) GetUpdateTime ¶ 

func (a *AnswerBoard) GetUpdateTime() *time.Time

func (*AnswerBoard) GetUpdatedBy ¶ 

func (a *AnswerBoard) GetUpdatedBy() *Person

func (AnswerBoard) MarshalJSON ¶ 

func (a AnswerBoard) MarshalJSON() ([]byte, error)

func (*AnswerBoard) UnmarshalJSON ¶ 

func (a *AnswerBoard) UnmarshalJSON(data []byte) error

type AnswerCreationData ¶ 

type AnswerCreationData struct {
	Question *string `json:"question,omitempty"`
	// Additional ways of phrasing this question.
	QuestionVariations []string `json:"questionVariations,omitempty"`
	// The plain text answer to the question.
	BodyText *string `json:"bodyText,omitempty"`
	// The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	BoardID *int64 `json:"boardId,omitempty"`
	// Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// A list of user roles for the answer added by the owner.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of user roles for the answer removed by the owner.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// A list of roles for this answer explicitly granted by an owner, editor, or admin.
	Roles              []UserRoleSpecification       `json:"roles,omitempty"`
	SourceDocumentSpec *DocumentSpecUnion            `json:"sourceDocumentSpec,omitempty"`
	SourceType         *AnswerCreationDataSourceType `json:"sourceType,omitempty"`
	// IDs of Collections to which a document is added.
	AddedCollections   []int64                          `json:"addedCollections,omitempty"`
	CombinedAnswerText *StructuredTextMutableProperties `json:"combinedAnswerText,omitempty"`
}

func (*AnswerCreationData) GetAddedCollections ¶ 

func (a *AnswerCreationData) GetAddedCollections() []int64

func (*AnswerCreationData) GetAddedRoles ¶ 

func (a *AnswerCreationData) GetAddedRoles() []UserRoleSpecification

func (*AnswerCreationData) GetAudienceFilters ¶ 

func (a *AnswerCreationData) GetAudienceFilters() []FacetFilter

func (*AnswerCreationData) GetBoardID ¶ 

func (a *AnswerCreationData) GetBoardID() *int64

func (*AnswerCreationData) GetBodyText ¶ 

func (a *AnswerCreationData) GetBodyText() *string

func (*AnswerCreationData) GetCombinedAnswerText ¶ 

func (a *AnswerCreationData) GetCombinedAnswerText() *StructuredTextMutableProperties

func (*AnswerCreationData) GetQuestion ¶ 

func (a *AnswerCreationData) GetQuestion() *string

func (*AnswerCreationData) GetQuestionVariations ¶ 

func (a *AnswerCreationData) GetQuestionVariations() []string

func (*AnswerCreationData) GetRemovedRoles ¶ 

func (a *AnswerCreationData) GetRemovedRoles() []UserRoleSpecification

func (*AnswerCreationData) GetRoles ¶ 

func (a *AnswerCreationData) GetRoles() []UserRoleSpecification

func (*AnswerCreationData) GetSourceDocumentSpec ¶ 

func (a *AnswerCreationData) GetSourceDocumentSpec() *DocumentSpecUnion

func (*AnswerCreationData) GetSourceType ¶ 

func (a *AnswerCreationData) GetSourceType() *AnswerCreationDataSourceType

type AnswerCreationDataSourceType ¶ 

type AnswerCreationDataSourceType string
const (
	AnswerCreationDataSourceTypeDocument  AnswerCreationDataSourceType = "DOCUMENT"
	AnswerCreationDataSourceTypeAssistant AnswerCreationDataSourceType = "ASSISTANT"
)

func (AnswerCreationDataSourceType) ToPointer ¶ 

func (e AnswerCreationDataSourceType) ToPointer() *AnswerCreationDataSourceType

func (*AnswerCreationDataSourceType) UnmarshalJSON ¶ 

func (e *AnswerCreationDataSourceType) UnmarshalJSON(data []byte) error

type AnswerLike ¶ 

type AnswerLike struct {
	User *Person `json:"user,omitempty"`
	// The time the user liked the answer in ISO format (ISO 8601).
	CreateTime *time.Time `json:"createTime,omitempty"`
}

func (*AnswerLike) GetCreateTime ¶ 

func (a *AnswerLike) GetCreateTime() *time.Time

func (*AnswerLike) GetUser ¶ 

func (a *AnswerLike) GetUser() *Person

func (AnswerLike) MarshalJSON ¶ 

func (a AnswerLike) MarshalJSON() ([]byte, error)

func (*AnswerLike) UnmarshalJSON ¶ 

func (a *AnswerLike) UnmarshalJSON(data []byte) error

type AnswerLikes ¶ 

type AnswerLikes struct {
	LikedBy []AnswerLike `json:"likedBy"`
	// Whether the user in context liked the answer.
	LikedByUser bool `json:"likedByUser"`
	// The total number of likes for the answer.
	NumLikes int64 `json:"numLikes"`
}

func (*AnswerLikes) GetLikedBy ¶ 

func (a *AnswerLikes) GetLikedBy() []AnswerLike

func (*AnswerLikes) GetLikedByUser ¶ 

func (a *AnswerLikes) GetLikedByUser() bool

func (*AnswerLikes) GetNumLikes ¶ 

func (a *AnswerLikes) GetNumLikes() int64

func (AnswerLikes) MarshalJSON ¶ added in v0.9.0 

func (a AnswerLikes) MarshalJSON() ([]byte, error)

func (*AnswerLikes) UnmarshalJSON ¶ added in v0.9.0 

func (a *AnswerLikes) UnmarshalJSON(data []byte) error

type AnswerResult ¶ 

type AnswerResult struct {
	Answer Answer `json:"answer"`
	// An opaque token that represents this particular Answer. To be used for `/feedback` reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
}

func (*AnswerResult) GetAnswer ¶ 

func (a *AnswerResult) GetAnswer() Answer

func (*AnswerResult) GetTrackingToken ¶ 

func (a *AnswerResult) GetTrackingToken() *string

type AnswerSourceType ¶ 

type AnswerSourceType string
const (
	AnswerSourceTypeDocument  AnswerSourceType = "DOCUMENT"
	AnswerSourceTypeAssistant AnswerSourceType = "ASSISTANT"
)

func (AnswerSourceType) ToPointer ¶ 

func (e AnswerSourceType) ToPointer() *AnswerSourceType

func (*AnswerSourceType) UnmarshalJSON ¶ 

func (e *AnswerSourceType) UnmarshalJSON(data []byte) error

type AppResult ¶ 

type AppResult struct {
	// The app or other repository type this represents
	Datasource string `json:"datasource"`
	// The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
	DocType *string `json:"docType,omitempty"`
	// Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive)
	MimeType *string `json:"mimeType,omitempty"`
	// If there is available icon URL.
	IconURL *string `json:"iconUrl,omitempty"`
}

func (*AppResult) GetDatasource ¶ 

func (a *AppResult) GetDatasource() string

func (*AppResult) GetDocType ¶ 

func (a *AppResult) GetDocType() *string

func (*AppResult) GetIconURL ¶ 

func (a *AppResult) GetIconURL() *string

func (*AppResult) GetMimeType ¶ 

func (a *AppResult) GetMimeType() *string

func (AppResult) MarshalJSON ¶ added in v0.9.0 

func (a AppResult) MarshalJSON() ([]byte, error)

func (*AppResult) UnmarshalJSON ¶ added in v0.9.0 

func (a *AppResult) UnmarshalJSON(data []byte) error

type AssistantActivityType ¶ 

type AssistantActivityType string
const (
	AssistantActivityTypeGleanChat        AssistantActivityType = "GLEAN_CHAT"
	AssistantActivityTypeAiSummary        AssistantActivityType = "AI_SUMMARY"
	AssistantActivityTypeAiAnswer         AssistantActivityType = "AI_ANSWER"
	AssistantActivityTypeGleanbotResponse AssistantActivityType = "GLEANBOT_RESPONSE"
)

func (AssistantActivityType) ToPointer ¶ 

func (e AssistantActivityType) ToPointer() *AssistantActivityType

func (*AssistantActivityType) UnmarshalJSON ¶ 

func (e *AssistantActivityType) UnmarshalJSON(data []byte) error

type AuthConfig ¶ 

type AuthConfig struct {
	// Whether or not this tool is hosted on-premise.
	IsOnPrem *bool `json:"isOnPrem,omitempty"`
	// Whether or not this uses central auth.
	UsesCentralAuth *bool `json:"usesCentralAuth,omitempty"`
	// The type of authentication being used.
	// Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token.
	// 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users.
	// 'OAUTH_USER' uses individual user tokens for external API calls.
	// 'DWD' refers to domain wide delegation.
	//
	Type *AuthConfigType `json:"type,omitempty"`
	// The type of grant type being used.
	GrantType *GrantType `json:"grantType,omitempty"`
	// Auth status of the tool.
	Status *AuthConfigStatus `json:"status,omitempty"`
	// The URL where users will be directed to start the OAuth flow.
	ClientURL *string `json:"client_url,omitempty"`
	// A list of strings denoting the different scopes or access levels required by the tool.
	Scopes []string `json:"scopes,omitempty"`
	// A list of strings denoting the different audience which can access the tool.
	Audiences []string `json:"audiences,omitempty"`
	// The OAuth provider's endpoint, where access tokens are requested.
	AuthorizationURL *string `json:"authorization_url,omitempty"`
	// The time the tool was last authorized in ISO format (ISO 8601).
	LastAuthorizedAt *time.Time `json:"lastAuthorizedAt,omitempty"`
}

AuthConfig - Config for tool's authentication method.

func (*AuthConfig) GetAudiences ¶ 

func (a *AuthConfig) GetAudiences() []string

func (*AuthConfig) GetAuthorizationURL ¶ 

func (a *AuthConfig) GetAuthorizationURL() *string

func (*AuthConfig) GetClientURL ¶ 

func (a *AuthConfig) GetClientURL() *string

func (*AuthConfig) GetGrantType ¶ 

func (a *AuthConfig) GetGrantType() *GrantType

func (*AuthConfig) GetIsOnPrem ¶ 

func (a *AuthConfig) GetIsOnPrem() *bool

func (*AuthConfig) GetLastAuthorizedAt ¶ 

func (a *AuthConfig) GetLastAuthorizedAt() *time.Time

func (*AuthConfig) GetScopes ¶ 

func (a *AuthConfig) GetScopes() []string

func (*AuthConfig) GetStatus ¶ 

func (a *AuthConfig) GetStatus() *AuthConfigStatus

func (*AuthConfig) GetType ¶ 

func (a *AuthConfig) GetType() *AuthConfigType

func (*AuthConfig) GetUsesCentralAuth ¶ 

func (a *AuthConfig) GetUsesCentralAuth() *bool

func (AuthConfig) MarshalJSON ¶ 

func (a AuthConfig) MarshalJSON() ([]byte, error)

func (*AuthConfig) UnmarshalJSON ¶ 

func (a *AuthConfig) UnmarshalJSON(data []byte) error

type AuthConfigStatus ¶ 

type AuthConfigStatus string

AuthConfigStatus - Auth status of the tool. 

const (
	AuthConfigStatusAwaitingAuth AuthConfigStatus = "AWAITING_AUTH"
	AuthConfigStatusAuthorized   AuthConfigStatus = "AUTHORIZED"
	AuthConfigStatusAuthDisabled AuthConfigStatus = "AUTH_DISABLED"
)

func (AuthConfigStatus) ToPointer ¶ 

func (e AuthConfigStatus) ToPointer() *AuthConfigStatus

func (*AuthConfigStatus) UnmarshalJSON ¶ 

func (e *AuthConfigStatus) UnmarshalJSON(data []byte) error

type AuthConfigType ¶ 

type AuthConfigType string

AuthConfigType - The type of authentication being used. Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. 'OAUTH_USER' uses individual user tokens for external API calls. 'DWD' refers to domain wide delegation. 

const (
	AuthConfigTypeNone       AuthConfigType = "NONE"
	AuthConfigTypeOauthUser  AuthConfigType = "OAUTH_USER"
	AuthConfigTypeOauthAdmin AuthConfigType = "OAUTH_ADMIN"
	AuthConfigTypeAPIKey     AuthConfigType = "API_KEY"
	AuthConfigTypeBasicAuth  AuthConfigType = "BASIC_AUTH"
	AuthConfigTypeDwd        AuthConfigType = "DWD"
)

func (AuthConfigType) ToPointer ¶ 

func (e AuthConfigType) ToPointer() *AuthConfigType

func (*AuthConfigType) UnmarshalJSON ¶ 

func (e *AuthConfigType) UnmarshalJSON(data []byte) error

type AuthToken ¶ 

type AuthToken struct {
	AccessToken string  `json:"accessToken"`
	Datasource  string  `json:"datasource"`
	Scope       *string `json:"scope,omitempty"`
	TokenType   *string `json:"tokenType,omitempty"`
	// Used by Google to indicate the index of the logged in user. Useful for generating hyperlinks that support multilogin.
	AuthUser *string `json:"authUser,omitempty"`
	// Unix timestamp when this token expires (in seconds since epoch UTC).
	Expiration *int64 `json:"expiration,omitempty"`
}

func (*AuthToken) GetAccessToken ¶ 

func (a *AuthToken) GetAccessToken() string

func (*AuthToken) GetAuthUser ¶ 

func (a *AuthToken) GetAuthUser() *string

func (*AuthToken) GetDatasource ¶ 

func (a *AuthToken) GetDatasource() string

func (*AuthToken) GetExpiration ¶ 

func (a *AuthToken) GetExpiration() *int64

func (*AuthToken) GetScope ¶ 

func (a *AuthToken) GetScope() *string

func (*AuthToken) GetTokenType ¶ 

func (a *AuthToken) GetTokenType() *string

func (AuthToken) MarshalJSON ¶ added in v0.9.0 

func (a AuthToken) MarshalJSON() ([]byte, error)

func (*AuthToken) UnmarshalJSON ¶ added in v0.9.0 

func (a *AuthToken) UnmarshalJSON(data []byte) error

type AuthType ¶ 

type AuthType string

AuthType - The type of authentication being used. Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. 'OAUTH_USER' uses individual user tokens for external API calls. 'DWD' refers to domain wide delegation. 

const (
	AuthTypeNone       AuthType = "NONE"
	AuthTypeOauthUser  AuthType = "OAUTH_USER"
	AuthTypeOauthAdmin AuthType = "OAUTH_ADMIN"
	AuthTypeAPIKey     AuthType = "API_KEY"
	AuthTypeBasicAuth  AuthType = "BASIC_AUTH"
	AuthTypeDwd        AuthType = "DWD"
)

func (AuthType) ToPointer ¶ 

func (e AuthType) ToPointer() *AuthType

func (*AuthType) UnmarshalJSON ¶ 

func (e *AuthType) UnmarshalJSON(data []byte) error

type Author ¶ 

type Author string
const (
	AuthorUser    Author = "USER"
	AuthorGleanAi Author = "GLEAN_AI"
)

func (Author) ToPointer ¶ 

func (e Author) ToPointer() *Author

func (*Author) UnmarshalJSON ¶ 

func (e *Author) UnmarshalJSON(data []byte) error

type AutocompleteRequest ¶ 

type AutocompleteRequest struct {
	TrackingToken *string      `json:"trackingToken,omitempty"`
	SessionInfo   *SessionInfo `json:"sessionInfo,omitempty"`
	// Partially typed query.
	Query *string `json:"query,omitempty"`
	// Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). Results are unfiltered if missing.
	DatasourcesFilter []string `json:"datasourcesFilter,omitempty"`
	// Filter to only return results relevant to the given datasource.
	Datasource *string `json:"datasource,omitempty"`
	// Filter to only return results of the given type(s). All types may be returned if omitted.
	ResultTypes []AutocompleteRequestResultType `json:"resultTypes,omitempty"`
	// Maximum number of results to be returned. If no value is provided, the backend will cap at 200.
	//
	ResultSize *int64 `json:"resultSize,omitempty"`
	// Auth tokens which may be used for federated results.
	AuthTokens []AuthToken `json:"authTokens,omitempty"`
}

func (*AutocompleteRequest) GetAuthTokens ¶ 

func (a *AutocompleteRequest) GetAuthTokens() []AuthToken

func (*AutocompleteRequest) GetDatasource ¶ 

func (a *AutocompleteRequest) GetDatasource() *string

func (*AutocompleteRequest) GetDatasourcesFilter ¶ 

func (a *AutocompleteRequest) GetDatasourcesFilter() []string

func (*AutocompleteRequest) GetQuery ¶ 

func (a *AutocompleteRequest) GetQuery() *string

func (*AutocompleteRequest) GetResultSize ¶ 

func (a *AutocompleteRequest) GetResultSize() *int64

func (*AutocompleteRequest) GetResultTypes ¶ 

func (a *AutocompleteRequest) GetResultTypes() []AutocompleteRequestResultType

func (*AutocompleteRequest) GetSessionInfo ¶ 

func (a *AutocompleteRequest) GetSessionInfo() *SessionInfo

func (*AutocompleteRequest) GetTrackingToken ¶ 

func (a *AutocompleteRequest) GetTrackingToken() *string

type AutocompleteRequestResultType ¶ 

type AutocompleteRequestResultType string
const (
	AutocompleteRequestResultTypeAdditionalDocument AutocompleteRequestResultType = "ADDITIONAL_DOCUMENT"
	AutocompleteRequestResultTypeApp                AutocompleteRequestResultType = "APP"
	AutocompleteRequestResultTypeBrowserHistory     AutocompleteRequestResultType = "BROWSER_HISTORY"
	AutocompleteRequestResultTypeDatasource         AutocompleteRequestResultType = "DATASOURCE"
	AutocompleteRequestResultTypeDocument           AutocompleteRequestResultType = "DOCUMENT"
	AutocompleteRequestResultTypeEntity             AutocompleteRequestResultType = "ENTITY"
	AutocompleteRequestResultTypeGolink             AutocompleteRequestResultType = "GOLINK"
	AutocompleteRequestResultTypeHistory            AutocompleteRequestResultType = "HISTORY"
	AutocompleteRequestResultTypeNewChat            AutocompleteRequestResultType = "NEW_CHAT"
	AutocompleteRequestResultTypeOperator           AutocompleteRequestResultType = "OPERATOR"
	AutocompleteRequestResultTypeOperatorValue      AutocompleteRequestResultType = "OPERATOR_VALUE"
	AutocompleteRequestResultTypeQuicklink          AutocompleteRequestResultType = "QUICKLINK"
	AutocompleteRequestResultTypeSuggestion         AutocompleteRequestResultType = "SUGGESTION"
)

func (AutocompleteRequestResultType) ToPointer ¶ 

func (e AutocompleteRequestResultType) ToPointer() *AutocompleteRequestResultType

func (*AutocompleteRequestResultType) UnmarshalJSON ¶ 

func (e *AutocompleteRequestResultType) UnmarshalJSON(data []byte) error

type AutocompleteResponse ¶ 

type AutocompleteResponse struct {
	// List of experiment ids for the corresponding request.
	ExperimentIds []int64 `json:"experimentIds,omitempty"`
	// An opaque token that represents this particular set of autocomplete results. To be used for /feedback reporting.
	TrackingToken *string              `json:"trackingToken,omitempty"`
	SessionInfo   *SessionInfo         `json:"sessionInfo,omitempty"`
	Results       []AutocompleteResult `json:"results,omitempty"`
	// Subsections of the results list from which distinct sections should be created.
	Groups         []AutocompleteResultGroup `json:"groups,omitempty"`
	GleanDataError *GleanDataError           `json:"errorInfo,omitempty"`
	// Time in milliseconds the backend took to respond to the request.
	BackendTimeMillis *int64 `json:"backendTimeMillis,omitempty"`
}

func (*AutocompleteResponse) GetBackendTimeMillis ¶ 

func (a *AutocompleteResponse) GetBackendTimeMillis() *int64

func (*AutocompleteResponse) GetExperimentIds ¶ 

func (a *AutocompleteResponse) GetExperimentIds() []int64

func (*AutocompleteResponse) GetGleanDataError ¶ 

func (a *AutocompleteResponse) GetGleanDataError() *GleanDataError

func (*AutocompleteResponse) GetGroups ¶ 

func (a *AutocompleteResponse) GetGroups() []AutocompleteResultGroup

func (*AutocompleteResponse) GetResults ¶ 

func (a *AutocompleteResponse) GetResults() []AutocompleteResult

func (*AutocompleteResponse) GetSessionInfo ¶ 

func (a *AutocompleteResponse) GetSessionInfo() *SessionInfo

func (*AutocompleteResponse) GetTrackingToken ¶ 

func (a *AutocompleteResponse) GetTrackingToken() *string

type AutocompleteResult ¶ 

type AutocompleteResult struct {
	Result string `json:"result"`
	// A list of all possible keywords for given result.
	Keywords   []string                      `json:"keywords,omitempty"`
	ResultType *AutocompleteResultResultType `json:"resultType,omitempty"`
	// Higher indicates a more confident match.
	Score            *float64          `json:"score,omitempty"`
	OperatorMetadata *OperatorMetadata `json:"operatorMetadata,omitempty"`
	// An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira.
	Quicklink *Quicklink `json:"quicklink,omitempty"`
	Document  *Document  `json:"document,omitempty"`
	URL       *string    `json:"url,omitempty"`
	// A single object that can support any object in the work graph. Only a single object will be populated.
	StructuredResult *StructuredResult `json:"structuredResult,omitempty"`
	// A token to be passed in /feedback events associated with this autocomplete result.
	TrackingToken *string `json:"trackingToken,omitempty"`
	// Subsections of the result string to which some special formatting should be applied (eg. bold)
	Ranges []TextRange `json:"ranges,omitempty"`
}

func (*AutocompleteResult) GetDocument ¶ 

func (a *AutocompleteResult) GetDocument() *Document

func (*AutocompleteResult) GetKeywords ¶ 

func (a *AutocompleteResult) GetKeywords() []string

func (*AutocompleteResult) GetOperatorMetadata ¶ 

func (a *AutocompleteResult) GetOperatorMetadata() *OperatorMetadata
func (a *AutocompleteResult) GetQuicklink() *Quicklink

func (*AutocompleteResult) GetRanges ¶ 

func (a *AutocompleteResult) GetRanges() []TextRange

func (*AutocompleteResult) GetResult ¶ 

func (a *AutocompleteResult) GetResult() string

func (*AutocompleteResult) GetResultType ¶ 

func (a *AutocompleteResult) GetResultType() *AutocompleteResultResultType

func (*AutocompleteResult) GetScore ¶ 

func (a *AutocompleteResult) GetScore() *float64

func (*AutocompleteResult) GetStructuredResult ¶ 

func (a *AutocompleteResult) GetStructuredResult() *StructuredResult

func (*AutocompleteResult) GetTrackingToken ¶ 

func (a *AutocompleteResult) GetTrackingToken() *string

func (*AutocompleteResult) GetURL ¶ 

func (a *AutocompleteResult) GetURL() *string

type AutocompleteResultGroup ¶ 

type AutocompleteResultGroup struct {
	// The inclusive start index of the range.
	StartIndex *int64 `json:"startIndex,omitempty"`
	// The exclusive end index of the range.
	EndIndex *int64 `json:"endIndex,omitempty"`
	// The title of the result group to be displayed. Empty means no title.
	Title *string `json:"title,omitempty"`
}

AutocompleteResultGroup - A subsection of the results list from which distinct sections should be created.

func (*AutocompleteResultGroup) GetEndIndex ¶ 

func (a *AutocompleteResultGroup) GetEndIndex() *int64

func (*AutocompleteResultGroup) GetStartIndex ¶ 

func (a *AutocompleteResultGroup) GetStartIndex() *int64

func (*AutocompleteResultGroup) GetTitle ¶ 

func (a *AutocompleteResultGroup) GetTitle() *string

type AutocompleteResultResultType ¶ 

type AutocompleteResultResultType string
const (
	AutocompleteResultResultTypeAdditionalDocument AutocompleteResultResultType = "ADDITIONAL_DOCUMENT"
	AutocompleteResultResultTypeApp                AutocompleteResultResultType = "APP"
	AutocompleteResultResultTypeBrowserHistory     AutocompleteResultResultType = "BROWSER_HISTORY"
	AutocompleteResultResultTypeDatasource         AutocompleteResultResultType = "DATASOURCE"
	AutocompleteResultResultTypeDocument           AutocompleteResultResultType = "DOCUMENT"
	AutocompleteResultResultTypeEntity             AutocompleteResultResultType = "ENTITY"
	AutocompleteResultResultTypeGolink             AutocompleteResultResultType = "GOLINK"
	AutocompleteResultResultTypeHistory            AutocompleteResultResultType = "HISTORY"
	AutocompleteResultResultTypeNewChat            AutocompleteResultResultType = "NEW_CHAT"
	AutocompleteResultResultTypeOperator           AutocompleteResultResultType = "OPERATOR"
	AutocompleteResultResultTypeOperatorValue      AutocompleteResultResultType = "OPERATOR_VALUE"
	AutocompleteResultResultTypeQuicklink          AutocompleteResultResultType = "QUICKLINK"
	AutocompleteResultResultTypeSuggestion         AutocompleteResultResultType = "SUGGESTION"
)

func (AutocompleteResultResultType) ToPointer ¶ 

func (e AutocompleteResultResultType) ToPointer() *AutocompleteResultResultType

func (*AutocompleteResultResultType) UnmarshalJSON ¶ 

func (e *AutocompleteResultResultType) UnmarshalJSON(data []byte) error

type Badge ¶ 

type Badge struct {
	// An auto generated unique identifier.
	Key *string `json:"key,omitempty"`
	// The badge name displayed to users
	DisplayName *string `json:"displayName,omitempty"`
	// Defines how to render an icon
	IconConfig *IconConfig `json:"iconConfig,omitempty"`
	// The badge should be shown on the PersonAttribution
	Pinned *bool `json:"pinned,omitempty"`
}

Badge - Displays a user's accomplishment or milestone

func (*Badge) GetDisplayName ¶ 

func (b *Badge) GetDisplayName() *string

func (*Badge) GetIconConfig ¶ 

func (b *Badge) GetIconConfig() *IconConfig

func (*Badge) GetKey ¶ 

func (b *Badge) GetKey() *string

func (*Badge) GetPinned ¶ 

func (b *Badge) GetPinned() *bool

func (Badge) MarshalJSON ¶ added in v0.9.0 

func (b Badge) MarshalJSON() ([]byte, error)

func (*Badge) UnmarshalJSON ¶ added in v0.9.0 

func (b *Badge) UnmarshalJSON(data []byte) error

type BulkIndexDocumentsRequest ¶ 

type BulkIndexDocumentsRequest struct {
	// Unique id that must be used for this bulk upload instance
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// Datasource of the documents
	Datasource string `json:"datasource"`
	// Batch of documents for the datasource
	Documents []DocumentDefinition `json:"documents"`
	// True if older documents need to be force deleted after the upload completes. Defaults to older documents being deleted asynchronously. This must only be set when `isLastPage = true`
	DisableStaleDocumentDeletionCheck *bool `json:"disableStaleDocumentDeletionCheck,omitempty"`
}

BulkIndexDocumentsRequest - Describes the request body of the /bulkindexdocuments API call

func (*BulkIndexDocumentsRequest) GetDatasource ¶ 

func (b *BulkIndexDocumentsRequest) GetDatasource() string

func (*BulkIndexDocumentsRequest) GetDisableStaleDocumentDeletionCheck ¶ 

func (b *BulkIndexDocumentsRequest) GetDisableStaleDocumentDeletionCheck() *bool

func (*BulkIndexDocumentsRequest) GetDocuments ¶ 

func (b *BulkIndexDocumentsRequest) GetDocuments() []DocumentDefinition

func (*BulkIndexDocumentsRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexDocumentsRequest) GetForceRestartUpload() *bool

func (*BulkIndexDocumentsRequest) GetIsFirstPage ¶ 

func (b *BulkIndexDocumentsRequest) GetIsFirstPage() *bool

func (*BulkIndexDocumentsRequest) GetIsLastPage ¶ 

func (b *BulkIndexDocumentsRequest) GetIsLastPage() *bool

func (*BulkIndexDocumentsRequest) GetUploadID ¶ 

func (b *BulkIndexDocumentsRequest) GetUploadID() string

type BulkIndexEmployeesRequest ¶ 

type BulkIndexEmployeesRequest struct {
	// Unique id that must be used for this bulk upload instance
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// Batch of employee information
	Employees []EmployeeInfoDefinition `json:"employees"`
	// True if older employee data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than 20%. This must only be set when `isLastPage = true`
	DisableStaleDataDeletionCheck *bool `json:"disableStaleDataDeletionCheck,omitempty"`
}

BulkIndexEmployeesRequest - Describes the request body of the /bulkindexemployees API call

func (*BulkIndexEmployeesRequest) GetDisableStaleDataDeletionCheck ¶ 

func (b *BulkIndexEmployeesRequest) GetDisableStaleDataDeletionCheck() *bool

func (*BulkIndexEmployeesRequest) GetEmployees ¶ 

func (b *BulkIndexEmployeesRequest) GetEmployees() []EmployeeInfoDefinition

func (*BulkIndexEmployeesRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexEmployeesRequest) GetForceRestartUpload() *bool

func (*BulkIndexEmployeesRequest) GetIsFirstPage ¶ 

func (b *BulkIndexEmployeesRequest) GetIsFirstPage() *bool

func (*BulkIndexEmployeesRequest) GetIsLastPage ¶ 

func (b *BulkIndexEmployeesRequest) GetIsLastPage() *bool

func (*BulkIndexEmployeesRequest) GetUploadID ¶ 

func (b *BulkIndexEmployeesRequest) GetUploadID() string

type BulkIndexGroupsRequest ¶ 

type BulkIndexGroupsRequest struct {
	// Unique id that must be used for this instance of datasource groups upload
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// datasource of the groups
	Datasource string `json:"datasource"`
	// batch of groups for the datasource
	Groups []DatasourceGroupDefinition `json:"groups"`
	// True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true`
	DisableStaleDataDeletionCheck *bool `json:"disableStaleDataDeletionCheck,omitempty"`
}

BulkIndexGroupsRequest - Describes the request body for the /bulkindexgroups API call

func (*BulkIndexGroupsRequest) GetDatasource ¶ 

func (b *BulkIndexGroupsRequest) GetDatasource() string

func (*BulkIndexGroupsRequest) GetDisableStaleDataDeletionCheck ¶ 

func (b *BulkIndexGroupsRequest) GetDisableStaleDataDeletionCheck() *bool

func (*BulkIndexGroupsRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexGroupsRequest) GetForceRestartUpload() *bool

func (*BulkIndexGroupsRequest) GetGroups ¶ 

func (b *BulkIndexGroupsRequest) GetGroups() []DatasourceGroupDefinition

func (*BulkIndexGroupsRequest) GetIsFirstPage ¶ 

func (b *BulkIndexGroupsRequest) GetIsFirstPage() *bool

func (*BulkIndexGroupsRequest) GetIsLastPage ¶ 

func (b *BulkIndexGroupsRequest) GetIsLastPage() *bool

func (*BulkIndexGroupsRequest) GetUploadID ¶ 

func (b *BulkIndexGroupsRequest) GetUploadID() string

type BulkIndexMembershipsRequest ¶ 

type BulkIndexMembershipsRequest struct {
	// Unique id that must be used for this instance of datasource group memberships upload
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// datasource of the memberships
	Datasource string `json:"datasource"`
	// group who's memberships are specified
	Group *string `json:"group,omitempty"`
	// batch of memberships for the group
	Memberships []DatasourceBulkMembershipDefinition `json:"memberships"`
}

BulkIndexMembershipsRequest - Describes the request body for the /bulkindexmemberships API call

func (*BulkIndexMembershipsRequest) GetDatasource ¶ 

func (b *BulkIndexMembershipsRequest) GetDatasource() string

func (*BulkIndexMembershipsRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexMembershipsRequest) GetForceRestartUpload() *bool

func (*BulkIndexMembershipsRequest) GetGroup ¶ 

func (b *BulkIndexMembershipsRequest) GetGroup() *string

func (*BulkIndexMembershipsRequest) GetIsFirstPage ¶ 

func (b *BulkIndexMembershipsRequest) GetIsFirstPage() *bool

func (*BulkIndexMembershipsRequest) GetIsLastPage ¶ 

func (b *BulkIndexMembershipsRequest) GetIsLastPage() *bool

func (*BulkIndexMembershipsRequest) GetMemberships ¶ 

func (b *BulkIndexMembershipsRequest) GetMemberships() []DatasourceBulkMembershipDefinition

func (*BulkIndexMembershipsRequest) GetUploadID ¶ 

func (b *BulkIndexMembershipsRequest) GetUploadID() string

type BulkIndexShortcutsRequest ¶ 

type BulkIndexShortcutsRequest struct {
	// Unique id that must be used for this bulk upload instance
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// Batch of shortcuts information
	Shortcuts []ExternalShortcut `json:"shortcuts"`
}

BulkIndexShortcutsRequest - Describes the request body of the /bulkindexshortcuts API call

func (*BulkIndexShortcutsRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexShortcutsRequest) GetForceRestartUpload() *bool

func (*BulkIndexShortcutsRequest) GetIsFirstPage ¶ 

func (b *BulkIndexShortcutsRequest) GetIsFirstPage() *bool

func (*BulkIndexShortcutsRequest) GetIsLastPage ¶ 

func (b *BulkIndexShortcutsRequest) GetIsLastPage() *bool

func (*BulkIndexShortcutsRequest) GetShortcuts ¶ 

func (b *BulkIndexShortcutsRequest) GetShortcuts() []ExternalShortcut

func (*BulkIndexShortcutsRequest) GetUploadID ¶ 

func (b *BulkIndexShortcutsRequest) GetUploadID() string

type BulkIndexTeamsRequest ¶ 

type BulkIndexTeamsRequest struct {
	// Unique id that must be used for this bulk upload instance
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// Batch of team information
	Teams []TeamInfoDefinition `json:"teams"`
}

BulkIndexTeamsRequest - Describes the request body of the /bulkindexteams API call

func (*BulkIndexTeamsRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexTeamsRequest) GetForceRestartUpload() *bool

func (*BulkIndexTeamsRequest) GetIsFirstPage ¶ 

func (b *BulkIndexTeamsRequest) GetIsFirstPage() *bool

func (*BulkIndexTeamsRequest) GetIsLastPage ¶ 

func (b *BulkIndexTeamsRequest) GetIsLastPage() *bool

func (*BulkIndexTeamsRequest) GetTeams ¶ 

func (b *BulkIndexTeamsRequest) GetTeams() []TeamInfoDefinition

func (*BulkIndexTeamsRequest) GetUploadID ¶ 

func (b *BulkIndexTeamsRequest) GetUploadID() string

type BulkIndexUsersRequest ¶ 

type BulkIndexUsersRequest struct {
	// Unique id that must be used for this instance of datasource users upload
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// datasource of the users
	Datasource string `json:"datasource"`
	// batch of users for the datasource
	Users []DatasourceUserDefinition `json:"users"`
	// True if older user data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true`
	DisableStaleDataDeletionCheck *bool `json:"disableStaleDataDeletionCheck,omitempty"`
}

BulkIndexUsersRequest - Describes the request body for the /bulkindexusers API call

func (*BulkIndexUsersRequest) GetDatasource ¶ 

func (b *BulkIndexUsersRequest) GetDatasource() string

func (*BulkIndexUsersRequest) GetDisableStaleDataDeletionCheck ¶ 

func (b *BulkIndexUsersRequest) GetDisableStaleDataDeletionCheck() *bool

func (*BulkIndexUsersRequest) GetForceRestartUpload ¶ 

func (b *BulkIndexUsersRequest) GetForceRestartUpload() *bool

func (*BulkIndexUsersRequest) GetIsFirstPage ¶ 

func (b *BulkIndexUsersRequest) GetIsFirstPage() *bool

func (*BulkIndexUsersRequest) GetIsLastPage ¶ 

func (b *BulkIndexUsersRequest) GetIsLastPage() *bool

func (*BulkIndexUsersRequest) GetUploadID ¶ 

func (b *BulkIndexUsersRequest) GetUploadID() string

func (*BulkIndexUsersRequest) GetUsers ¶ 

func (b *BulkIndexUsersRequest) GetUsers() []DatasourceUserDefinition

type BulkUploadHistoryEvent ¶ 

type BulkUploadHistoryEvent struct {
	// The unique ID of the upload
	UploadID *string `json:"uploadId,omitempty"`
	// The start time of the upload in ISO 8601 format
	StartTime *string `json:"startTime,omitempty"`
	// The end time of the upload in ISO 8601 format, 'NA' if the upload is still active
	EndTime *string `json:"endTime,omitempty"`
	// The status of the upload, an enum of ACTIVE, SUCCESSFUL
	Status *BulkUploadHistoryEventStatus `json:"status,omitempty"`
	// The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED
	ProcessingState *ProcessingState `json:"processingState,omitempty"`
}

BulkUploadHistoryEvent - Information about a successful bulk upload

func (*BulkUploadHistoryEvent) GetEndTime ¶ 

func (b *BulkUploadHistoryEvent) GetEndTime() *string

func (*BulkUploadHistoryEvent) GetProcessingState ¶ 

func (b *BulkUploadHistoryEvent) GetProcessingState() *ProcessingState

func (*BulkUploadHistoryEvent) GetStartTime ¶ 

func (b *BulkUploadHistoryEvent) GetStartTime() *string

func (*BulkUploadHistoryEvent) GetStatus ¶ 

func (b *BulkUploadHistoryEvent) GetStatus() *BulkUploadHistoryEventStatus

func (*BulkUploadHistoryEvent) GetUploadID ¶ 

func (b *BulkUploadHistoryEvent) GetUploadID() *string

type BulkUploadHistoryEventStatus ¶ 

type BulkUploadHistoryEventStatus string

BulkUploadHistoryEventStatus - The status of the upload, an enum of ACTIVE, SUCCESSFUL 

const (
	BulkUploadHistoryEventStatusActive     BulkUploadHistoryEventStatus = "ACTIVE"
	BulkUploadHistoryEventStatusSuccessful BulkUploadHistoryEventStatus = "SUCCESSFUL"
)

func (BulkUploadHistoryEventStatus) ToPointer ¶ 

func (e BulkUploadHistoryEventStatus) ToPointer() *BulkUploadHistoryEventStatus

func (*BulkUploadHistoryEventStatus) UnmarshalJSON ¶ 

func (e *BulkUploadHistoryEventStatus) UnmarshalJSON(data []byte) error

type CalendarAttendee ¶ 

type CalendarAttendee struct {
	// Whether or not this attendee is an organizer.
	IsOrganizer *bool `json:"isOrganizer,omitempty"`
	// Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility.
	IsInGroup *bool  `json:"isInGroup,omitempty"`
	Person    Person `json:"person"`
	// If this attendee is a group, represents the list of individual attendees in the group.
	GroupAttendees []CalendarAttendee `json:"groupAttendees,omitempty"`
	ResponseStatus *ResponseStatus    `json:"responseStatus,omitempty"`
}

func (*CalendarAttendee) GetGroupAttendees ¶ 

func (c *CalendarAttendee) GetGroupAttendees() []CalendarAttendee

func (*CalendarAttendee) GetIsInGroup ¶ 

func (c *CalendarAttendee) GetIsInGroup() *bool

func (*CalendarAttendee) GetIsOrganizer ¶ 

func (c *CalendarAttendee) GetIsOrganizer() *bool

func (*CalendarAttendee) GetPerson ¶ 

func (c *CalendarAttendee) GetPerson() Person

func (*CalendarAttendee) GetResponseStatus ¶ 

func (c *CalendarAttendee) GetResponseStatus() *ResponseStatus

func (CalendarAttendee) MarshalJSON ¶ added in v0.9.0 

func (c CalendarAttendee) MarshalJSON() ([]byte, error)

func (*CalendarAttendee) UnmarshalJSON ¶ added in v0.9.0 

func (c *CalendarAttendee) UnmarshalJSON(data []byte) error

type CalendarAttendees ¶ 

type CalendarAttendees struct {
	// Full details of some of the attendees of this event
	People []CalendarAttendee `json:"people,omitempty"`
	// Whether the total count of the people returned is at the retrieval limit.
	IsLimit *bool `json:"isLimit,omitempty"`
	// Total number of attendees in this event.
	Total *int64 `json:"total,omitempty"`
	// Total number of attendees who have accepted this event.
	NumAccepted *int64 `json:"numAccepted,omitempty"`
	// Total number of attendees who have declined this event.
	NumDeclined *int64 `json:"numDeclined,omitempty"`
	// Total number of attendees who have not responded to this event.
	NumNoResponse *int64 `json:"numNoResponse,omitempty"`
	// Total number of attendees who have responded tentatively (i.e. responded maybe) to this event.
	NumTentative *int64 `json:"numTentative,omitempty"`
}

func (*CalendarAttendees) GetIsLimit ¶ 

func (c *CalendarAttendees) GetIsLimit() *bool

func (*CalendarAttendees) GetNumAccepted ¶ 

func (c *CalendarAttendees) GetNumAccepted() *int64

func (*CalendarAttendees) GetNumDeclined ¶ 

func (c *CalendarAttendees) GetNumDeclined() *int64

func (*CalendarAttendees) GetNumNoResponse ¶ 

func (c *CalendarAttendees) GetNumNoResponse() *int64

func (*CalendarAttendees) GetNumTentative ¶ 

func (c *CalendarAttendees) GetNumTentative() *int64

func (*CalendarAttendees) GetPeople ¶ 

func (c *CalendarAttendees) GetPeople() []CalendarAttendee

func (*CalendarAttendees) GetTotal ¶ 

func (c *CalendarAttendees) GetTotal() *int64

func (CalendarAttendees) MarshalJSON ¶ added in v0.9.0 

func (c CalendarAttendees) MarshalJSON() ([]byte, error)

func (*CalendarAttendees) UnmarshalJSON ¶ added in v0.9.0 

func (c *CalendarAttendees) UnmarshalJSON(data []byte) error

type CalendarEvent ¶ 

type CalendarEvent struct {
	Time *TimeInterval `json:"time,omitempty"`
	// The nature of the event, for example "out of office".
	EventType *CalendarEventEventType `json:"eventType,omitempty"`
	// The calendar event id
	ID string `json:"id"`
	// A permalink for this calendar event
	URL       string             `json:"url"`
	Attendees *CalendarAttendees `json:"attendees,omitempty"`
	// The location that this event is taking place at.
	Location       *string         `json:"location,omitempty"`
	ConferenceData *ConferenceData `json:"conferenceData,omitempty"`
	// The HTML description of the event.
	Description *string `json:"description,omitempty"`
	// The app or other repository type from which the event was extracted
	Datasource *string `json:"datasource,omitempty"`
	// The event has a transcript associated with it enabling features like summarization
	HasTranscript *bool `json:"hasTranscript,omitempty"`
	// A link to the transcript of the event
	TranscriptURL        *string               `json:"transcriptUrl,omitempty"`
	Classifications      []EventClassification `json:"classifications,omitempty"`
	GeneratedAttachments []GeneratedAttachment `json:"generatedAttachments,omitempty"`
}

CalendarEvent - A generic, light-weight calendar event.

func (*CalendarEvent) GetAttendees ¶ 

func (c *CalendarEvent) GetAttendees() *CalendarAttendees

func (*CalendarEvent) GetClassifications ¶ 

func (c *CalendarEvent) GetClassifications() []EventClassification

func (*CalendarEvent) GetConferenceData ¶ 

func (c *CalendarEvent) GetConferenceData() *ConferenceData

func (*CalendarEvent) GetDatasource ¶ 

func (c *CalendarEvent) GetDatasource() *string

func (*CalendarEvent) GetDescription ¶ 

func (c *CalendarEvent) GetDescription() *string

func (*CalendarEvent) GetEventType ¶ 

func (c *CalendarEvent) GetEventType() *CalendarEventEventType

func (*CalendarEvent) GetGeneratedAttachments ¶ 

func (c *CalendarEvent) GetGeneratedAttachments() []GeneratedAttachment

func (*CalendarEvent) GetHasTranscript ¶ 

func (c *CalendarEvent) GetHasTranscript() *bool

func (*CalendarEvent) GetID ¶ 

func (c *CalendarEvent) GetID() string

func (*CalendarEvent) GetLocation ¶ 

func (c *CalendarEvent) GetLocation() *string

func (*CalendarEvent) GetTime ¶ 

func (c *CalendarEvent) GetTime() *TimeInterval

func (*CalendarEvent) GetTranscriptURL ¶ 

func (c *CalendarEvent) GetTranscriptURL() *string

func (*CalendarEvent) GetURL ¶ 

func (c *CalendarEvent) GetURL() string

type CalendarEventEventType ¶ 

type CalendarEventEventType string

CalendarEventEventType - The nature of the event, for example "out of office". 

const (
	CalendarEventEventTypeDefault     CalendarEventEventType = "DEFAULT"
	CalendarEventEventTypeOutOfOffice CalendarEventEventType = "OUT_OF_OFFICE"
)

func (CalendarEventEventType) ToPointer ¶ 

func (e CalendarEventEventType) ToPointer() *CalendarEventEventType

func (*CalendarEventEventType) UnmarshalJSON ¶ 

func (e *CalendarEventEventType) UnmarshalJSON(data []byte) error

type CanonicalizingRegexType ¶ 

type CanonicalizingRegexType struct {
	// Regular expression to match to an arbitrary string.
	MatchRegex *string `json:"matchRegex,omitempty"`
	// Regular expression to transform into a canonical string.
	RewriteRegex *string `json:"rewriteRegex,omitempty"`
}

CanonicalizingRegexType - Regular expression to apply to an arbitrary string to transform it into a canonical string.

func (*CanonicalizingRegexType) GetMatchRegex ¶ 

func (c *CanonicalizingRegexType) GetMatchRegex() *string

func (*CanonicalizingRegexType) GetRewriteRegex ¶ 

func (c *CanonicalizingRegexType) GetRewriteRegex() *string

type CategoryToResultSize ¶ 

type CategoryToResultSize struct {
	ResultSize *int64 `json:"resultSize,omitempty"`
}

func (*CategoryToResultSize) GetResultSize ¶ 

func (c *CategoryToResultSize) GetResultSize() *int64

type ChannelInviteInfo ¶ 

type ChannelInviteInfo struct {
	Channel *CommunicationChannel `json:"channel,omitempty"`
	// Bit that tracks if this invite was automatically sent or user-sent
	IsAutoInvite *bool   `json:"isAutoInvite,omitempty"`
	Inviter      *Person `json:"inviter,omitempty"`
	// The time this person was invited in ISO format (ISO 8601).
	InviteTime *time.Time `json:"inviteTime,omitempty"`
	// The time this person was reminded in ISO format (ISO 8601) if a reminder was sent.
	ReminderTime *time.Time `json:"reminderTime,omitempty"`
}

ChannelInviteInfo - Information regarding the invite status of a person for a particular channel.

func (*ChannelInviteInfo) GetChannel ¶ 

func (c *ChannelInviteInfo) GetChannel() *CommunicationChannel

func (*ChannelInviteInfo) GetInviteTime ¶ 

func (c *ChannelInviteInfo) GetInviteTime() *time.Time

func (*ChannelInviteInfo) GetInviter ¶ 

func (c *ChannelInviteInfo) GetInviter() *Person

func (*ChannelInviteInfo) GetIsAutoInvite ¶ 

func (c *ChannelInviteInfo) GetIsAutoInvite() *bool

func (*ChannelInviteInfo) GetReminderTime ¶ 

func (c *ChannelInviteInfo) GetReminderTime() *time.Time

func (ChannelInviteInfo) MarshalJSON ¶ 

func (c ChannelInviteInfo) MarshalJSON() ([]byte, error)

func (*ChannelInviteInfo) UnmarshalJSON ¶ 

func (c *ChannelInviteInfo) UnmarshalJSON(data []byte) error

type Chat ¶ 

type Chat struct {
	// The opaque id of the Chat.
	ID *string `json:"id,omitempty"`
	// Server Unix timestamp of the creation time (in seconds since epoch UTC).
	CreateTime *int64  `json:"createTime,omitempty"`
	CreatedBy  *Person `json:"createdBy,omitempty"`
	// Server Unix timestamp of the update time (in seconds since epoch UTC).
	UpdateTime *int64 `json:"updateTime,omitempty"`
	// The name of the Chat.
	Name *string `json:"name,omitempty"`
	// The ID of the AI App that this Chat is associated to.
	ApplicationID *string `json:"applicationId,omitempty"`
	// The display name of the AI App that this Chat is associated to.
	ApplicationName *string `json:"applicationName,omitempty"`
	// Defines how to render an icon
	Icon        *IconConfig        `json:"icon,omitempty"`
	Permissions *ObjectPermissions `json:"permissions,omitempty"`
	// The chat messages within a Chat.
	Messages []ChatMessage `json:"messages,omitempty"`
	// A list of roles for this Chat.
	Roles []UserRoleSpecification `json:"roles,omitempty"`
}

Chat - A historical representation of a series of chat messages a user had with Glean Assistant.

func (*Chat) GetApplicationID ¶ 

func (c *Chat) GetApplicationID() *string

func (*Chat) GetApplicationName ¶ 

func (c *Chat) GetApplicationName() *string

func (*Chat) GetCreateTime ¶ 

func (c *Chat) GetCreateTime() *int64

func (*Chat) GetCreatedBy ¶ 

func (c *Chat) GetCreatedBy() *Person

func (*Chat) GetID ¶ 

func (c *Chat) GetID() *string

func (*Chat) GetIcon ¶ 

func (c *Chat) GetIcon() *IconConfig

func (*Chat) GetMessages ¶ 

func (c *Chat) GetMessages() []ChatMessage

func (*Chat) GetName ¶ 

func (c *Chat) GetName() *string

func (*Chat) GetPermissions ¶ added in v0.9.0 

func (c *Chat) GetPermissions() *ObjectPermissions

func (*Chat) GetRoles ¶ added in v0.9.0 

func (c *Chat) GetRoles() []UserRoleSpecification

func (*Chat) GetUpdateTime ¶ 

func (c *Chat) GetUpdateTime() *int64

type ChatFile ¶ 

type ChatFile struct {
	// Unique identifier of the file.
	ID *string `json:"id,omitempty"`
	// Url of the file.
	URL *string `json:"url,omitempty"`
	// Name of the uploaded file.
	Name *string `json:"name,omitempty"`
	// Metadata of a file uploaded by a user for Chat.
	Metadata *ChatFileMetadata `json:"metadata,omitempty"`
}

ChatFile - Structure for file uploaded by a user for Chat.

func (*ChatFile) GetID ¶ 

func (c *ChatFile) GetID() *string

func (*ChatFile) GetMetadata ¶ 

func (c *ChatFile) GetMetadata() *ChatFileMetadata

func (*ChatFile) GetName ¶ 

func (c *ChatFile) GetName() *string

func (*ChatFile) GetURL ¶ 

func (c *ChatFile) GetURL() *string

type ChatFileFailureReason ¶ 

type ChatFileFailureReason string

ChatFileFailureReason - Reason for failed status. 

const (
	ChatFileFailureReasonParseFailed                ChatFileFailureReason = "PARSE_FAILED"
	ChatFileFailureReasonAvScanFailed               ChatFileFailureReason = "AV_SCAN_FAILED"
	ChatFileFailureReasonFileTooSmall               ChatFileFailureReason = "FILE_TOO_SMALL"
	ChatFileFailureReasonFileTooLarge               ChatFileFailureReason = "FILE_TOO_LARGE"
	ChatFileFailureReasonFileExtensionUnsupported   ChatFileFailureReason = "FILE_EXTENSION_UNSUPPORTED"
	ChatFileFailureReasonFileMetadataValidationFail ChatFileFailureReason = "FILE_METADATA_VALIDATION_FAIL"
	ChatFileFailureReasonFileProcessingTimedOut     ChatFileFailureReason = "FILE_PROCESSING_TIMED_OUT"
)

func (ChatFileFailureReason) ToPointer ¶ 

func (e ChatFileFailureReason) ToPointer() *ChatFileFailureReason

func (*ChatFileFailureReason) UnmarshalJSON ¶ 

func (e *ChatFileFailureReason) UnmarshalJSON(data []byte) error

type ChatFileMetadata ¶ 

type ChatFileMetadata struct {
	// Current status of the file.
	Status *ChatFileStatus `json:"status,omitempty"`
	// Upload time, in epoch seconds.
	UploadTime *int64 `json:"uploadTime,omitempty"`
	// Size of the processed file in bytes.
	ProcessedSize *int64 `json:"processedSize,omitempty"`
	// Reason for failed status.
	FailureReason *ChatFileFailureReason `json:"failureReason,omitempty"`
	// MIME type of the file.
	MimeType *string `json:"mimeType,omitempty"`
}

ChatFileMetadata - Metadata of a file uploaded by a user for Chat.

func (*ChatFileMetadata) GetFailureReason ¶ 

func (c *ChatFileMetadata) GetFailureReason() *ChatFileFailureReason

func (*ChatFileMetadata) GetMimeType ¶ 

func (c *ChatFileMetadata) GetMimeType() *string

func (*ChatFileMetadata) GetProcessedSize ¶ 

func (c *ChatFileMetadata) GetProcessedSize() *int64

func (*ChatFileMetadata) GetStatus ¶ 

func (c *ChatFileMetadata) GetStatus() *ChatFileStatus

func (*ChatFileMetadata) GetUploadTime ¶ 

func (c *ChatFileMetadata) GetUploadTime() *int64

type ChatFileStatus ¶ 

type ChatFileStatus string

ChatFileStatus - Current status of the file. 

const (
	ChatFileStatusProcessing ChatFileStatus = "PROCESSING"
	ChatFileStatusProcessed  ChatFileStatus = "PROCESSED"
	ChatFileStatusFailed     ChatFileStatus = "FAILED"
	ChatFileStatusDeleted    ChatFileStatus = "DELETED"
)

func (ChatFileStatus) ToPointer ¶ 

func (e ChatFileStatus) ToPointer() *ChatFileStatus

func (*ChatFileStatus) UnmarshalJSON ¶ 

func (e *ChatFileStatus) UnmarshalJSON(data []byte) error

type ChatMessage ¶ 

type ChatMessage struct {
	// Describes the agent that executes the request.
	AgentConfig *AgentConfig `json:"agentConfig,omitempty"`
	Author      *Author      `default:"USER" json:"author"`
	// A list of Citations that were used to generate the response.
	Citations []ChatMessageCitation `json:"citations,omitempty"`
	// IDs of files uploaded in the message that are referenced to generate the answer.
	UploadedFileIds []string `json:"uploadedFileIds,omitempty"`
	// A list of rich data used to represent the response or formulate a request. These are linearly stitched together to support richer data formats beyond simple text.
	Fragments []ChatMessageFragment `json:"fragments,omitempty"`
	// Response timestamp of the message.
	Ts *string `json:"ts,omitempty"`
	// A unique server-side generated ID used to identify a message, automatically populated for any USER authored messages.
	MessageID *string `json:"messageId,omitempty"`
	// Opaque tracking token generated server-side.
	MessageTrackingToken *string `json:"messageTrackingToken,omitempty"`
	// Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified.
	MessageType *MessageType `default:"CONTENT" json:"messageType"`
	// Signals there are additional response fragments incoming.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	HasMoreFragments *bool `json:"hasMoreFragments,omitempty"`
}

ChatMessage - A message that is rendered as one coherent unit with one given sender.

func (*ChatMessage) GetAgentConfig ¶ 

func (c *ChatMessage) GetAgentConfig() *AgentConfig

func (*ChatMessage) GetAuthor ¶ 

func (c *ChatMessage) GetAuthor() *Author

func (*ChatMessage) GetCitations ¶ 

func (c *ChatMessage) GetCitations() []ChatMessageCitation

func (*ChatMessage) GetFragments ¶ 

func (c *ChatMessage) GetFragments() []ChatMessageFragment

func (*ChatMessage) GetHasMoreFragments ¶ 

func (c *ChatMessage) GetHasMoreFragments() *bool

func (*ChatMessage) GetMessageID ¶ 

func (c *ChatMessage) GetMessageID() *string

func (*ChatMessage) GetMessageTrackingToken ¶ 

func (c *ChatMessage) GetMessageTrackingToken() *string

func (*ChatMessage) GetMessageType ¶ 

func (c *ChatMessage) GetMessageType() *MessageType

func (*ChatMessage) GetTs ¶ 

func (c *ChatMessage) GetTs() *string

func (*ChatMessage) GetUploadedFileIds ¶ 

func (c *ChatMessage) GetUploadedFileIds() []string

func (ChatMessage) MarshalJSON ¶ 

func (c ChatMessage) MarshalJSON() ([]byte, error)

func (*ChatMessage) UnmarshalJSON ¶ 

func (c *ChatMessage) UnmarshalJSON(data []byte) error

type ChatMessageCitation ¶ 

type ChatMessageCitation struct {
	// An opaque token that represents this particular result in this particular ChatMessage. To be used for /feedback reporting.
	TrackingToken  *string   `json:"trackingToken,omitempty"`
	SourceDocument *Document `json:"sourceDocument,omitempty"`
	// Structure for file uploaded by a user for Chat.
	SourceFile   *ChatFile `json:"sourceFile,omitempty"`
	SourcePerson *Person   `json:"sourcePerson,omitempty"`
	// Each reference range and its corresponding snippets
	ReferenceRanges []ReferenceRange `json:"referenceRanges,omitempty"`
}

ChatMessageCitation - Information about the source for a ChatMessage.

func (*ChatMessageCitation) GetReferenceRanges ¶ 

func (c *ChatMessageCitation) GetReferenceRanges() []ReferenceRange

func (*ChatMessageCitation) GetSourceDocument ¶ 

func (c *ChatMessageCitation) GetSourceDocument() *Document

func (*ChatMessageCitation) GetSourceFile ¶ 

func (c *ChatMessageCitation) GetSourceFile() *ChatFile

func (*ChatMessageCitation) GetSourcePerson ¶ 

func (c *ChatMessageCitation) GetSourcePerson() *Person

func (*ChatMessageCitation) GetTrackingToken ¶ 

func (c *ChatMessageCitation) GetTrackingToken() *string

type ChatMessageFragment ¶ 

type ChatMessageFragment struct {
	// An array of entities in the work graph retrieved via a data request.
	StructuredResults []StructuredResult `json:"structuredResults,omitempty"`
	// An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
	TrackingToken   *string          `json:"trackingToken,omitempty"`
	Text            *string          `json:"text,omitempty"`
	QuerySuggestion *QuerySuggestion `json:"querySuggestion,omitempty"`
	// Structure for file uploaded by a user for Chat.
	File   *ChatFile `json:"file,omitempty"`
	Action *ToolInfo `json:"action,omitempty"`
	// Information about the source for a ChatMessage.
	Citation *ChatMessageCitation `json:"citation,omitempty"`
}

ChatMessageFragment - Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, agentRecommendation or file.

func (*ChatMessageFragment) GetAction ¶ 

func (c *ChatMessageFragment) GetAction() *ToolInfo

func (*ChatMessageFragment) GetCitation ¶ added in v0.8.0 

func (c *ChatMessageFragment) GetCitation() *ChatMessageCitation

func (*ChatMessageFragment) GetFile ¶ 

func (c *ChatMessageFragment) GetFile() *ChatFile

func (*ChatMessageFragment) GetQuerySuggestion ¶ 

func (c *ChatMessageFragment) GetQuerySuggestion() *QuerySuggestion

func (*ChatMessageFragment) GetStructuredResults ¶ 

func (c *ChatMessageFragment) GetStructuredResults() []StructuredResult

func (*ChatMessageFragment) GetText ¶ 

func (c *ChatMessageFragment) GetText() *string

func (*ChatMessageFragment) GetTrackingToken ¶ 

func (c *ChatMessageFragment) GetTrackingToken() *string

type ChatMetadata ¶ 

type ChatMetadata struct {
	// The opaque id of the Chat.
	ID *string `json:"id,omitempty"`
	// Server Unix timestamp of the creation time (in seconds since epoch UTC).
	CreateTime *int64  `json:"createTime,omitempty"`
	CreatedBy  *Person `json:"createdBy,omitempty"`
	// Server Unix timestamp of the update time (in seconds since epoch UTC).
	UpdateTime *int64 `json:"updateTime,omitempty"`
	// The name of the Chat.
	Name *string `json:"name,omitempty"`
	// The ID of the AI App that this Chat is associated to.
	ApplicationID *string `json:"applicationId,omitempty"`
	// The display name of the AI App that this Chat is associated to.
	ApplicationName *string `json:"applicationName,omitempty"`
	// Defines how to render an icon
	Icon *IconConfig `json:"icon,omitempty"`
}

ChatMetadata - Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content.

func (*ChatMetadata) GetApplicationID ¶ 

func (c *ChatMetadata) GetApplicationID() *string

func (*ChatMetadata) GetApplicationName ¶ 

func (c *ChatMetadata) GetApplicationName() *string

func (*ChatMetadata) GetCreateTime ¶ 

func (c *ChatMetadata) GetCreateTime() *int64

func (*ChatMetadata) GetCreatedBy ¶ 

func (c *ChatMetadata) GetCreatedBy() *Person

func (*ChatMetadata) GetID ¶ 

func (c *ChatMetadata) GetID() *string

func (*ChatMetadata) GetIcon ¶ 

func (c *ChatMetadata) GetIcon() *IconConfig

func (*ChatMetadata) GetName ¶ 

func (c *ChatMetadata) GetName() *string

func (*ChatMetadata) GetUpdateTime ¶ 

func (c *ChatMetadata) GetUpdateTime() *int64

type ChatMetadataResult ¶ 

type ChatMetadataResult struct {
	// Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content.
	Chat *ChatMetadata `json:"chat,omitempty"`
	// An opaque token that represents this particular Chat. To be used for `/feedback` reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
}

func (*ChatMetadataResult) GetChat ¶ 

func (c *ChatMetadataResult) GetChat() *ChatMetadata

func (*ChatMetadataResult) GetTrackingToken ¶ 

func (c *ChatMetadataResult) GetTrackingToken() *string

type ChatRequest ¶ 

type ChatRequest struct {
	// Save the current interaction as a Chat for the user to access and potentially continue later.
	SaveChat *bool `json:"saveChat,omitempty"`
	// The id of the Chat that context should be retrieved from and messages added to. An empty id starts a new Chat, and the Chat is saved if saveChat is true.
	ChatID *string `json:"chatId,omitempty"`
	// A list of chat messages, from most recent to least recent. At least one message must specify a USER author.
	Messages []ChatMessage `json:"messages"`
	// Describes the agent that executes the request.
	AgentConfig *AgentConfig            `json:"agentConfig,omitempty"`
	Inclusions  *ChatRestrictionFilters `json:"inclusions,omitempty"`
	Exclusions  *ChatRestrictionFilters `json:"exclusions,omitempty"`
	// Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer.
	TimeoutMillis *int64       `json:"timeoutMillis,omitempty"`
	SessionInfo   *SessionInfo `json:"sessionInfo,omitempty"`
	// The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used.
	ApplicationID *string `json:"applicationId,omitempty"`
	// The ID of the Agent that should process this chat request. Only Agents with trigger set to 'User chat message' are invokable through this API. If not specified, the default chat experience will be used.
	AgentID *string `json:"agentId,omitempty"`
	// If set, response lines will be streamed one-by-one as they become available. Each will be a ChatResponse, formatted as JSON, and separated by a new line. If false, the entire response will be returned at once. Note that if this is set and the model being used does not support streaming, the model's response will not be streamed, but other messages from the endpoint still will be.
	Stream *bool `json:"stream,omitempty"`
}

func (*ChatRequest) GetAgentConfig ¶ 

func (c *ChatRequest) GetAgentConfig() *AgentConfig

func (*ChatRequest) GetAgentID ¶ added in v0.6.2 

func (c *ChatRequest) GetAgentID() *string

func (*ChatRequest) GetApplicationID ¶ 

func (c *ChatRequest) GetApplicationID() *string

func (*ChatRequest) GetChatID ¶ 

func (c *ChatRequest) GetChatID() *string

func (*ChatRequest) GetExclusions ¶ 

func (c *ChatRequest) GetExclusions() *ChatRestrictionFilters

func (*ChatRequest) GetInclusions ¶ 

func (c *ChatRequest) GetInclusions() *ChatRestrictionFilters

func (*ChatRequest) GetMessages ¶ 

func (c *ChatRequest) GetMessages() []ChatMessage

func (*ChatRequest) GetSaveChat ¶ 

func (c *ChatRequest) GetSaveChat() *bool

func (*ChatRequest) GetSessionInfo ¶ added in v0.5.0 

func (c *ChatRequest) GetSessionInfo() *SessionInfo

func (*ChatRequest) GetStream ¶ 

func (c *ChatRequest) GetStream() *bool

func (*ChatRequest) GetTimeoutMillis ¶ 

func (c *ChatRequest) GetTimeoutMillis() *int64

type ChatResponse ¶ 

type ChatResponse struct {
	Messages []ChatMessage `json:"messages,omitempty"`
	// The id of the associated Chat the messages belong to, if one exists.
	ChatID *string `json:"chatId,omitempty"`
	// Follow-up prompts for the user to potentially use
	FollowUpPrompts []string `json:"followUpPrompts,omitempty"`
	// Time in milliseconds the backend took to respond to the request.
	BackendTimeMillis *int64 `json:"backendTimeMillis,omitempty"`
	// A token that is used to track the session.
	ChatSessionTrackingToken *string `json:"chatSessionTrackingToken,omitempty"`
}

ChatResponse - A single response from the /chat backend.

func (*ChatResponse) GetBackendTimeMillis ¶ 

func (c *ChatResponse) GetBackendTimeMillis() *int64

func (*ChatResponse) GetChatID ¶ 

func (c *ChatResponse) GetChatID() *string

func (*ChatResponse) GetChatSessionTrackingToken ¶ 

func (c *ChatResponse) GetChatSessionTrackingToken() *string

func (*ChatResponse) GetFollowUpPrompts ¶ 

func (c *ChatResponse) GetFollowUpPrompts() []string

func (*ChatResponse) GetMessages ¶ 

func (c *ChatResponse) GetMessages() []ChatMessage

type ChatRestrictionFilters ¶ 

type ChatRestrictionFilters struct {
	// Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections.
	ContainerSpecs      []DocumentSpecUnion `json:"containerSpecs,omitempty"`
	DocumentSpecs       []DocumentSpecUnion `json:"documentSpecs,omitempty"`
	DatasourceInstances []string            `json:"datasourceInstances,omitempty"`
}

func (*ChatRestrictionFilters) GetContainerSpecs ¶ 

func (c *ChatRestrictionFilters) GetContainerSpecs() []DocumentSpecUnion

func (*ChatRestrictionFilters) GetDatasourceInstances ¶ 

func (c *ChatRestrictionFilters) GetDatasourceInstances() []string

func (*ChatRestrictionFilters) GetDocumentSpecs ¶ 

func (c *ChatRestrictionFilters) GetDocumentSpecs() []DocumentSpecUnion

type ChatResult ¶ 

type ChatResult struct {
	// A historical representation of a series of chat messages a user had with Glean Assistant.
	Chat *Chat `json:"chat,omitempty"`
	// An opaque token that represents this particular Chat. To be used for `/feedback` reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
}

func (*ChatResult) GetChat ¶ 

func (c *ChatResult) GetChat() *Chat

func (*ChatResult) GetTrackingToken ¶ 

func (c *ChatResult) GetTrackingToken() *string

type ChatSuggestion ¶ added in v0.9.0 

type ChatSuggestion struct {
	// The actionable chat query to run when the user selects this suggestion.
	Query *string `json:"query,omitempty"`
	// Targeted Glean Chat feature for the suggestion.
	Feature *string `json:"feature,omitempty"`
}

func (*ChatSuggestion) GetFeature ¶ added in v0.9.0 

func (c *ChatSuggestion) GetFeature() *string

func (*ChatSuggestion) GetQuery ¶ added in v0.9.0 

func (c *ChatSuggestion) GetQuery() *string

type ChatZeroStateSuggestionOptions ¶ 

type ChatZeroStateSuggestionOptions struct {
	// The Chat Application ID this feed request should be scoped to. Empty means there is no Chat Application ID..
	ApplicationID *string `json:"applicationId,omitempty"`
}

func (*ChatZeroStateSuggestionOptions) GetApplicationID ¶ 

func (c *ChatZeroStateSuggestionOptions) GetApplicationID() *string

type CheckDocumentAccessRequest ¶ 

type CheckDocumentAccessRequest struct {
	// Datasource of document to check access for.
	Datasource string `json:"datasource"`
	// Object type of document to check access for.
	ObjectType string `json:"objectType"`
	// Glean Document ID to check access for.
	DocID string `json:"docId"`
	// Email of user to check access for.
	UserEmail string `json:"userEmail"`
}

CheckDocumentAccessRequest - Describes the request body of the /checkdocumentaccess API call

func (*CheckDocumentAccessRequest) GetDatasource ¶ 

func (c *CheckDocumentAccessRequest) GetDatasource() string

func (*CheckDocumentAccessRequest) GetDocID ¶ 

func (c *CheckDocumentAccessRequest) GetDocID() string

func (*CheckDocumentAccessRequest) GetObjectType ¶ 

func (c *CheckDocumentAccessRequest) GetObjectType() string

func (*CheckDocumentAccessRequest) GetUserEmail ¶ 

func (c *CheckDocumentAccessRequest) GetUserEmail() string

type CheckDocumentAccessResponse ¶ 

type CheckDocumentAccessResponse struct {
	// If true, user has access to document for search
	HasAccess *bool `json:"hasAccess,omitempty"`
}

CheckDocumentAccessResponse - Describes the response body of the /checkdocumentaccess API call

func (*CheckDocumentAccessResponse) GetHasAccess ¶ 

func (c *CheckDocumentAccessResponse) GetHasAccess() *bool

type ClusterGroup ¶ 

type ClusterGroup struct {
	// A list of results that should be displayed as associated with this result.
	ClusteredResults []SearchResult `json:"clusteredResults,omitempty"`
	// The reason for inclusion of clusteredResults.
	ClusterType *ClusterTypeEnum `json:"clusterType,omitempty"`
	// The default number of results to display before truncating and showing a "see more" link
	VisibleCountHint int64 `json:"visibleCountHint"`
}

func (*ClusterGroup) GetClusterType ¶ 

func (c *ClusterGroup) GetClusterType() *ClusterTypeEnum

func (*ClusterGroup) GetClusteredResults ¶ 

func (c *ClusterGroup) GetClusteredResults() []SearchResult

func (*ClusterGroup) GetVisibleCountHint ¶ 

func (c *ClusterGroup) GetVisibleCountHint() int64

func (ClusterGroup) MarshalJSON ¶ added in v0.9.0 

func (c ClusterGroup) MarshalJSON() ([]byte, error)

func (*ClusterGroup) UnmarshalJSON ¶ added in v0.9.0 

func (c *ClusterGroup) UnmarshalJSON(data []byte) error

type ClusterTypeEnum ¶ 

type ClusterTypeEnum string

ClusterTypeEnum - The reason for inclusion of clusteredResults. 

const (
	ClusterTypeEnumSimilar      ClusterTypeEnum = "SIMILAR"
	ClusterTypeEnumFreshness    ClusterTypeEnum = "FRESHNESS"
	ClusterTypeEnumTitle        ClusterTypeEnum = "TITLE"
	ClusterTypeEnumContent      ClusterTypeEnum = "CONTENT"
	ClusterTypeEnumNone         ClusterTypeEnum = "NONE"
	ClusterTypeEnumThreadReply  ClusterTypeEnum = "THREAD_REPLY"
	ClusterTypeEnumThreadRoot   ClusterTypeEnum = "THREAD_ROOT"
	ClusterTypeEnumPrefix       ClusterTypeEnum = "PREFIX"
	ClusterTypeEnumSuffix       ClusterTypeEnum = "SUFFIX"
	ClusterTypeEnumAuthorPrefix ClusterTypeEnum = "AUTHOR_PREFIX"
	ClusterTypeEnumAuthorSuffix ClusterTypeEnum = "AUTHOR_SUFFIX"
)

func (ClusterTypeEnum) ToPointer ¶ 

func (e ClusterTypeEnum) ToPointer() *ClusterTypeEnum

func (*ClusterTypeEnum) UnmarshalJSON ¶ 

func (e *ClusterTypeEnum) UnmarshalJSON(data []byte) error

type Code ¶ 

type Code struct {
	RepoName *string    `json:"repoName,omitempty"`
	FileName *string    `json:"fileName,omitempty"`
	FileURL  *string    `json:"fileUrl,omitempty"`
	Lines    []CodeLine `json:"lines,omitempty"`
	// Last file match for a repo
	IsLastMatch *bool `json:"isLastMatch,omitempty"`
}

func (*Code) GetFileName ¶ 

func (c *Code) GetFileName() *string

func (*Code) GetFileURL ¶ 

func (c *Code) GetFileURL() *string

func (*Code) GetIsLastMatch ¶ 

func (c *Code) GetIsLastMatch() *bool

func (*Code) GetLines ¶ 

func (c *Code) GetLines() []CodeLine

func (*Code) GetRepoName ¶ 

func (c *Code) GetRepoName() *string

func (Code) MarshalJSON ¶ added in v0.9.0 

func (c Code) MarshalJSON() ([]byte, error)

func (*Code) UnmarshalJSON ¶ added in v0.9.0 

func (c *Code) UnmarshalJSON(data []byte) error

type CodeLine ¶ 

type CodeLine struct {
	LineNumber *int64  `json:"lineNumber,omitempty"`
	Content    *string `json:"content,omitempty"`
	// Index ranges depicting matched sections of the line
	Ranges []TextRange `json:"ranges,omitempty"`
}

func (*CodeLine) GetContent ¶ 

func (c *CodeLine) GetContent() *string

func (*CodeLine) GetLineNumber ¶ 

func (c *CodeLine) GetLineNumber() *int64

func (*CodeLine) GetRanges ¶ 

func (c *CodeLine) GetRanges() []TextRange

func (CodeLine) MarshalJSON ¶ added in v0.9.0 

func (c CodeLine) MarshalJSON() ([]byte, error)

func (*CodeLine) UnmarshalJSON ¶ added in v0.9.0 

func (c *CodeLine) UnmarshalJSON(data []byte) error

type Collection ¶ 

type Collection struct {
	// The unique name of the Collection.
	Name string `json:"name"`
	// A brief summary of the Collection's contents.
	Description string `json:"description"`
	// A list of added user roles for the Collection.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of removed user roles for the Collection.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The emoji icon of this Collection.
	Icon *string `json:"icon,omitempty"`
	// Indicates whether edits are allowed for everyone or only admins.
	AdminLocked *bool `json:"adminLocked,omitempty"`
	// The parent of this Collection, or 0 if it's a top-level Collection.
	ParentID  *int64     `json:"parentId,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	// The datasource type this Collection can hold.
	AllowedDatasource *string            `json:"allowedDatasource,omitempty"`
	Permissions       *ObjectPermissions `json:"permissions,omitempty"`
	// The unique ID of the Collection.
	ID         int64      `json:"id"`
	CreateTime *time.Time `json:"createTime,omitempty"`
	UpdateTime *time.Time `json:"updateTime,omitempty"`
	Creator    *Person    `json:"creator,omitempty"`
	UpdatedBy  *Person    `json:"updatedBy,omitempty"`
	// The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
	ItemCount *int64 `json:"itemCount,omitempty"`
	// The number of children Collections. Separated from the actual children so we can grab the count without children.
	ChildCount *int64 `json:"childCount,omitempty"`
	// The items in this Collection.
	Items       []CollectionItem          `json:"items,omitempty"`
	PinMetadata *CollectionPinnedMetadata `json:"pinMetadata,omitempty"`
	// The names of the shortcuts (Go Links) that point to this Collection.
	Shortcuts []string `json:"shortcuts,omitempty"`
	// The children Collections of this Collection.
	Children []Collection `json:"children,omitempty"`
	// A list of user roles for the Collection.
	Roles []UserRoleSpecification `json:"roles,omitempty"`
}

func (*Collection) GetAddedRoles ¶ 

func (c *Collection) GetAddedRoles() []UserRoleSpecification

func (*Collection) GetAdminLocked ¶ 

func (c *Collection) GetAdminLocked() *bool

func (*Collection) GetAllowedDatasource ¶ 

func (c *Collection) GetAllowedDatasource() *string

func (*Collection) GetAudienceFilters ¶ 

func (c *Collection) GetAudienceFilters() []FacetFilter

func (*Collection) GetChildCount ¶ 

func (c *Collection) GetChildCount() *int64

func (*Collection) GetChildren ¶ 

func (c *Collection) GetChildren() []Collection

func (*Collection) GetCreateTime ¶ 

func (c *Collection) GetCreateTime() *time.Time

func (*Collection) GetCreator ¶ 

func (c *Collection) GetCreator() *Person

func (*Collection) GetDescription ¶ 

func (c *Collection) GetDescription() string

func (*Collection) GetID ¶ 

func (c *Collection) GetID() int64

func (*Collection) GetIcon ¶ 

func (c *Collection) GetIcon() *string

func (*Collection) GetItemCount ¶ 

func (c *Collection) GetItemCount() *int64

func (*Collection) GetItems ¶ 

func (c *Collection) GetItems() []CollectionItem

func (*Collection) GetName ¶ 

func (c *Collection) GetName() string

func (*Collection) GetParentID ¶ 

func (c *Collection) GetParentID() *int64

func (*Collection) GetPermissions ¶ 

func (c *Collection) GetPermissions() *ObjectPermissions

func (*Collection) GetPinMetadata ¶ 

func (c *Collection) GetPinMetadata() *CollectionPinnedMetadata

func (*Collection) GetRemovedRoles ¶ 

func (c *Collection) GetRemovedRoles() []UserRoleSpecification

func (*Collection) GetRoles ¶ 

func (c *Collection) GetRoles() []UserRoleSpecification

func (*Collection) GetShortcuts ¶ 

func (c *Collection) GetShortcuts() []string

func (*Collection) GetThumbnail ¶ 

func (c *Collection) GetThumbnail() *Thumbnail

func (*Collection) GetUpdateTime ¶ 

func (c *Collection) GetUpdateTime() *time.Time

func (*Collection) GetUpdatedBy ¶ 

func (c *Collection) GetUpdatedBy() *Person

func (Collection) MarshalJSON ¶ 

func (c Collection) MarshalJSON() ([]byte, error)

func (*Collection) UnmarshalJSON ¶ 

func (c *Collection) UnmarshalJSON(data []byte) error

type CollectionError ¶ 

type CollectionError struct {
	ErrorCode CollectionErrorErrorCode `json:"errorCode"`
}

func (*CollectionError) GetErrorCode ¶ 

func (c *CollectionError) GetErrorCode() CollectionErrorErrorCode

func (CollectionError) MarshalJSON ¶ added in v0.9.0 

func (c CollectionError) MarshalJSON() ([]byte, error)

func (*CollectionError) UnmarshalJSON ¶ added in v0.9.0 

func (c *CollectionError) UnmarshalJSON(data []byte) error

type CollectionErrorErrorCode ¶ 

type CollectionErrorErrorCode string
const (
	CollectionErrorErrorCodeNameExists              CollectionErrorErrorCode = "NAME_EXISTS"
	CollectionErrorErrorCodeNotFound                CollectionErrorErrorCode = "NOT_FOUND"
	CollectionErrorErrorCodeCollectionPinned        CollectionErrorErrorCode = "COLLECTION_PINNED"
	CollectionErrorErrorCodeConcurrentHierarchyEdit CollectionErrorErrorCode = "CONCURRENT_HIERARCHY_EDIT"
	CollectionErrorErrorCodeHeightViolation         CollectionErrorErrorCode = "HEIGHT_VIOLATION"
	CollectionErrorErrorCodeWidthViolation          CollectionErrorErrorCode = "WIDTH_VIOLATION"
	CollectionErrorErrorCodeNoPermissions           CollectionErrorErrorCode = "NO_PERMISSIONS"
)

func (CollectionErrorErrorCode) ToPointer ¶ 

func (e CollectionErrorErrorCode) ToPointer() *CollectionErrorErrorCode

func (*CollectionErrorErrorCode) UnmarshalJSON ¶ 

func (e *CollectionErrorErrorCode) UnmarshalJSON(data []byte) error

type CollectionItem ¶ 

type CollectionItem struct {
	// The optional name of the Collection item.
	Name *string `json:"name,omitempty"`
	// A helpful description of why this CollectionItem is in the Collection that it's in.
	Description *string `json:"description,omitempty"`
	// The emoji icon for this CollectionItem. Only used for Text type items.
	Icon *string `json:"icon,omitempty"`
	// The Collection ID of the Collection that this CollectionItem belongs in.
	CollectionID int64 `json:"collectionId"`
	// If this CollectionItem is indexed, the Glean Document ID of that document.
	DocumentID *string `json:"documentId,omitempty"`
	// The URL of this CollectionItem.
	URL *string `json:"url,omitempty"`
	// Unique identifier for the item within the Collection it belongs to.
	ItemID    *string `json:"itemId,omitempty"`
	CreatedBy *Person `json:"createdBy,omitempty"`
	// Unix timestamp for when the item was first added (in seconds since epoch UTC).
	CreatedAt  *time.Time             `json:"createdAt,omitempty"`
	Document   *Document              `json:"document,omitempty"`
	Shortcut   *Shortcut              `json:"shortcut,omitempty"`
	Collection *Collection            `json:"collection,omitempty"`
	ItemType   CollectionItemItemType `json:"itemType"`
}

func (*CollectionItem) GetCollection ¶ 

func (c *CollectionItem) GetCollection() *Collection

func (*CollectionItem) GetCollectionID ¶ 

func (c *CollectionItem) GetCollectionID() int64

func (*CollectionItem) GetCreatedAt ¶ 

func (c *CollectionItem) GetCreatedAt() *time.Time

func (*CollectionItem) GetCreatedBy ¶ 

func (c *CollectionItem) GetCreatedBy() *Person

func (*CollectionItem) GetDescription ¶ 

func (c *CollectionItem) GetDescription() *string

func (*CollectionItem) GetDocument ¶ 

func (c *CollectionItem) GetDocument() *Document

func (*CollectionItem) GetDocumentID ¶ 

func (c *CollectionItem) GetDocumentID() *string

func (*CollectionItem) GetIcon ¶ 

func (c *CollectionItem) GetIcon() *string

func (*CollectionItem) GetItemID ¶ 

func (c *CollectionItem) GetItemID() *string

func (*CollectionItem) GetItemType ¶ 

func (c *CollectionItem) GetItemType() CollectionItemItemType

func (*CollectionItem) GetName ¶ 

func (c *CollectionItem) GetName() *string

func (*CollectionItem) GetShortcut ¶ 

func (c *CollectionItem) GetShortcut() *Shortcut

func (*CollectionItem) GetURL ¶ 

func (c *CollectionItem) GetURL() *string

func (CollectionItem) MarshalJSON ¶ 

func (c CollectionItem) MarshalJSON() ([]byte, error)

func (*CollectionItem) UnmarshalJSON ¶ 

func (c *CollectionItem) UnmarshalJSON(data []byte) error

type CollectionItemDescriptor ¶ 

type CollectionItemDescriptor struct {
	// The optional name of the Collection item.
	Name *string `json:"name,omitempty"`
	// A helpful description of why this CollectionItem is in the Collection that it's in.
	Description *string `json:"description,omitempty"`
	// The emoji icon for this CollectionItem. Only used for Text type items.
	Icon *string `json:"icon,omitempty"`
	// The URL of the item being added.
	URL *string `json:"url,omitempty"`
	// The Glean Document ID of the item being added if it's an indexed document.
	DocumentID *string `json:"documentId,omitempty"`
	// The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection
	NewNextItemID *string                           `json:"newNextItemId,omitempty"`
	ItemType      *CollectionItemDescriptorItemType `json:"itemType,omitempty"`
}

func (*CollectionItemDescriptor) GetDescription ¶ 

func (c *CollectionItemDescriptor) GetDescription() *string

func (*CollectionItemDescriptor) GetDocumentID ¶ 

func (c *CollectionItemDescriptor) GetDocumentID() *string

func (*CollectionItemDescriptor) GetIcon ¶ 

func (c *CollectionItemDescriptor) GetIcon() *string

func (*CollectionItemDescriptor) GetItemType ¶ 

func (c *CollectionItemDescriptor) GetItemType() *CollectionItemDescriptorItemType

func (*CollectionItemDescriptor) GetName ¶ 

func (c *CollectionItemDescriptor) GetName() *string

func (*CollectionItemDescriptor) GetNewNextItemID ¶ 

func (c *CollectionItemDescriptor) GetNewNextItemID() *string

func (*CollectionItemDescriptor) GetURL ¶ 

func (c *CollectionItemDescriptor) GetURL() *string

type CollectionItemDescriptorItemType ¶ 

type CollectionItemDescriptorItemType string
const (
	CollectionItemDescriptorItemTypeDocument CollectionItemDescriptorItemType = "DOCUMENT"
	CollectionItemDescriptorItemTypeText     CollectionItemDescriptorItemType = "TEXT"
	CollectionItemDescriptorItemTypeURL      CollectionItemDescriptorItemType = "URL"
)

func (CollectionItemDescriptorItemType) ToPointer ¶ 

func (e CollectionItemDescriptorItemType) ToPointer() *CollectionItemDescriptorItemType

func (*CollectionItemDescriptorItemType) UnmarshalJSON ¶ 

func (e *CollectionItemDescriptorItemType) UnmarshalJSON(data []byte) error

type CollectionItemItemType ¶ 

type CollectionItemItemType string
const (
	CollectionItemItemTypeDocument   CollectionItemItemType = "DOCUMENT"
	CollectionItemItemTypeText       CollectionItemItemType = "TEXT"
	CollectionItemItemTypeURL        CollectionItemItemType = "URL"
	CollectionItemItemTypeCollection CollectionItemItemType = "COLLECTION"
)

func (CollectionItemItemType) ToPointer ¶ 

func (e CollectionItemItemType) ToPointer() *CollectionItemItemType

func (*CollectionItemItemType) UnmarshalJSON ¶ 

func (e *CollectionItemItemType) UnmarshalJSON(data []byte) error

type CollectionPinMetadata ¶ 

type CollectionPinMetadata struct {
	// The ID of the Collection.
	ID     int64               `json:"id"`
	Target CollectionPinTarget `json:"target"`
}

func (*CollectionPinMetadata) GetID ¶ 

func (c *CollectionPinMetadata) GetID() int64

func (*CollectionPinMetadata) GetTarget ¶ 

func (c *CollectionPinMetadata) GetTarget() CollectionPinTarget

func (CollectionPinMetadata) MarshalJSON ¶ added in v0.9.0 

func (c CollectionPinMetadata) MarshalJSON() ([]byte, error)

func (*CollectionPinMetadata) UnmarshalJSON ¶ added in v0.9.0 

func (c *CollectionPinMetadata) UnmarshalJSON(data []byte) error

type CollectionPinTarget ¶ 

type CollectionPinTarget struct {
	// Categories a Collection can be pinned to.
	Category CollectionPinnableCategories `json:"category"`
	// Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on.
	Value *string `json:"value,omitempty"`
	// What targets can a Collection be pinned to.
	Target *CollectionPinnableTargets `json:"target,omitempty"`
}

func (*CollectionPinTarget) GetCategory ¶ 

func (c *CollectionPinTarget) GetCategory() CollectionPinnableCategories

func (*CollectionPinTarget) GetTarget ¶ 

func (c *CollectionPinTarget) GetTarget() *CollectionPinnableTargets

func (*CollectionPinTarget) GetValue ¶ 

func (c *CollectionPinTarget) GetValue() *string

func (CollectionPinTarget) MarshalJSON ¶ added in v0.9.0 

func (c CollectionPinTarget) MarshalJSON() ([]byte, error)

func (*CollectionPinTarget) UnmarshalJSON ¶ added in v0.9.0 

func (c *CollectionPinTarget) UnmarshalJSON(data []byte) error

type CollectionPinnableCategories ¶ 

type CollectionPinnableCategories string

CollectionPinnableCategories - Categories a Collection can be pinned to. 

const (
	CollectionPinnableCategoriesCompanyResource    CollectionPinnableCategories = "COMPANY_RESOURCE"
	CollectionPinnableCategoriesDepartmentResource CollectionPinnableCategories = "DEPARTMENT_RESOURCE"
	CollectionPinnableCategoriesTeamResource       CollectionPinnableCategories = "TEAM_RESOURCE"
)

func (CollectionPinnableCategories) ToPointer ¶ 

func (e CollectionPinnableCategories) ToPointer() *CollectionPinnableCategories

func (*CollectionPinnableCategories) UnmarshalJSON ¶ 

func (e *CollectionPinnableCategories) UnmarshalJSON(data []byte) error

type CollectionPinnableTargets ¶ 

type CollectionPinnableTargets string

CollectionPinnableTargets - What targets can a Collection be pinned to. 

const (
	CollectionPinnableTargetsResourceCard    CollectionPinnableTargets = "RESOURCE_CARD"
	CollectionPinnableTargetsTeamProfilePage CollectionPinnableTargets = "TEAM_PROFILE_PAGE"
)

func (CollectionPinnableTargets) ToPointer ¶ 

func (e CollectionPinnableTargets) ToPointer() *CollectionPinnableTargets

func (*CollectionPinnableTargets) UnmarshalJSON ¶ 

func (e *CollectionPinnableTargets) UnmarshalJSON(data []byte) error

type CollectionPinnedMetadata ¶ 

type CollectionPinnedMetadata struct {
	// List of targets this Collection is pinned to.
	ExistingPins []CollectionPinTarget `json:"existingPins,omitempty"`
	// List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection.
	EligiblePins []CollectionPinMetadata `json:"eligiblePins,omitempty"`
}

func (*CollectionPinnedMetadata) GetEligiblePins ¶ 

func (c *CollectionPinnedMetadata) GetEligiblePins() []CollectionPinMetadata

func (*CollectionPinnedMetadata) GetExistingPins ¶ 

func (c *CollectionPinnedMetadata) GetExistingPins() []CollectionPinTarget

func (CollectionPinnedMetadata) MarshalJSON ¶ added in v0.9.0 

func (c CollectionPinnedMetadata) MarshalJSON() ([]byte, error)

func (*CollectionPinnedMetadata) UnmarshalJSON ¶ added in v0.9.0 

func (c *CollectionPinnedMetadata) UnmarshalJSON(data []byte) error

type CommentDefinition ¶ 

type CommentDefinition struct {
	// The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length.
	ID string `json:"id"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	Author *UserReferenceDefinition `json:"author,omitempty"`
	// Describes text content or base64 encoded binary content
	Content *ContentDefinition `json:"content,omitempty"`
	// The creation time, in epoch seconds.
	CreatedAt *int64 `json:"createdAt,omitempty"`
	// The last updated time, in epoch seconds.
	UpdatedAt *int64 `json:"updatedAt,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	UpdatedBy *UserReferenceDefinition `json:"updatedBy,omitempty"`
}

CommentDefinition - Describes a comment on a document

func (*CommentDefinition) GetAuthor ¶ 

func (c *CommentDefinition) GetAuthor() *UserReferenceDefinition

func (*CommentDefinition) GetContent ¶ 

func (c *CommentDefinition) GetContent() *ContentDefinition

func (*CommentDefinition) GetCreatedAt ¶ 

func (c *CommentDefinition) GetCreatedAt() *int64

func (*CommentDefinition) GetID ¶ 

func (c *CommentDefinition) GetID() string

func (*CommentDefinition) GetUpdatedAt ¶ 

func (c *CommentDefinition) GetUpdatedAt() *int64

func (*CommentDefinition) GetUpdatedBy ¶ 

func (c *CommentDefinition) GetUpdatedBy() *UserReferenceDefinition

type CommunicationChannel ¶ 

type CommunicationChannel string
const (
	CommunicationChannelCommunicationChannelEmail CommunicationChannel = "COMMUNICATION_CHANNEL_EMAIL"
	CommunicationChannelCommunicationChannelSlack CommunicationChannel = "COMMUNICATION_CHANNEL_SLACK"
)

func (CommunicationChannel) ToPointer ¶ 

func (e CommunicationChannel) ToPointer() *CommunicationChannel

func (*CommunicationChannel) UnmarshalJSON ¶ 

func (e *CommunicationChannel) UnmarshalJSON(data []byte) error

type Company ¶ 

type Company struct {
	// User-friendly display name.
	Name string `json:"name"`
	// Link to internal company company profile.
	ProfileURL *string `json:"profileUrl,omitempty"`
	// Link to company's associated websites.
	WebsiteUrls []string `json:"websiteUrls,omitempty"`
	// The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
	LogoURL *string `json:"logoUrl,omitempty"`
	// User facing string representing the company's location.
	Location *string `json:"location,omitempty"`
	// Phone number as a number string.
	Phone *string `json:"phone,omitempty"`
	// Fax number as a number string.
	Fax *string `json:"fax,omitempty"`
	// User facing string representing the company's industry.
	Industry *string `json:"industry,omitempty"`
	// Average company's annual revenue for reference.
	AnnualRevenue *float64 `json:"annualRevenue,omitempty"`
	// Average company's number of employees for reference.
	NumberOfEmployees *int64 `json:"numberOfEmployees,omitempty"`
	// Company's stock symbol if company is public.
	StockSymbol *string `json:"stockSymbol,omitempty"`
	// The date when the company was founded.
	FoundedDate *types.Date `json:"foundedDate,omitempty"`
	// User facing description of company.
	About *string `json:"about,omitempty"`
}

func (*Company) GetAbout ¶ 

func (c *Company) GetAbout() *string

func (*Company) GetAnnualRevenue ¶ 

func (c *Company) GetAnnualRevenue() *float64

func (*Company) GetFax ¶ 

func (c *Company) GetFax() *string

func (*Company) GetFoundedDate ¶ 

func (c *Company) GetFoundedDate() *types.Date

func (*Company) GetIndustry ¶ 

func (c *Company) GetIndustry() *string

func (*Company) GetLocation ¶ 

func (c *Company) GetLocation() *string

func (*Company) GetLogoURL ¶ 

func (c *Company) GetLogoURL() *string

func (*Company) GetName ¶ 

func (c *Company) GetName() string

func (*Company) GetNumberOfEmployees ¶ 

func (c *Company) GetNumberOfEmployees() *int64

func (*Company) GetPhone ¶ 

func (c *Company) GetPhone() *string

func (*Company) GetProfileURL ¶ 

func (c *Company) GetProfileURL() *string

func (*Company) GetStockSymbol ¶ 

func (c *Company) GetStockSymbol() *string

func (*Company) GetWebsiteUrls ¶ 

func (c *Company) GetWebsiteUrls() []string

func (Company) MarshalJSON ¶ 

func (c Company) MarshalJSON() ([]byte, error)

func (*Company) UnmarshalJSON ¶ 

func (c *Company) UnmarshalJSON(data []byte) error

type ConferenceData ¶ 

type ConferenceData struct {
	Provider Provider `json:"provider"`
	// A permalink for the conference.
	URI    string                `json:"uri"`
	Source *ConferenceDataSource `json:"source,omitempty"`
}

func (*ConferenceData) GetProvider ¶ 

func (c *ConferenceData) GetProvider() Provider

func (*ConferenceData) GetSource ¶ 

func (c *ConferenceData) GetSource() *ConferenceDataSource

func (*ConferenceData) GetURI ¶ 

func (c *ConferenceData) GetURI() string

type ConferenceDataSource ¶ 

type ConferenceDataSource string
const (
	ConferenceDataSourceNativeConference ConferenceDataSource = "NATIVE_CONFERENCE"
	ConferenceDataSourceLocation         ConferenceDataSource = "LOCATION"
	ConferenceDataSourceDescription      ConferenceDataSource = "DESCRIPTION"
)

func (ConferenceDataSource) ToPointer ¶ 

func (e ConferenceDataSource) ToPointer() *ConferenceDataSource

func (*ConferenceDataSource) UnmarshalJSON ¶ 

func (e *ConferenceDataSource) UnmarshalJSON(data []byte) error

type ConnectorType ¶ 

type ConnectorType string

ConnectorType - The source from which document content was pulled, e.g. an API crawl or browser history 

const (
	ConnectorTypeAPICrawl        ConnectorType = "API_CRAWL"
	ConnectorTypeBrowserCrawl    ConnectorType = "BROWSER_CRAWL"
	ConnectorTypeBrowserHistory  ConnectorType = "BROWSER_HISTORY"
	ConnectorTypeBuiltin         ConnectorType = "BUILTIN"
	ConnectorTypeFederatedSearch ConnectorType = "FEDERATED_SEARCH"
	ConnectorTypePushAPI         ConnectorType = "PUSH_API"
	ConnectorTypeWebCrawl        ConnectorType = "WEB_CRAWL"
	ConnectorTypeNativeHistory   ConnectorType = "NATIVE_HISTORY"
)

func (ConnectorType) ToPointer ¶ 

func (e ConnectorType) ToPointer() *ConnectorType

func (*ConnectorType) UnmarshalJSON ¶ 

func (e *ConnectorType) UnmarshalJSON(data []byte) error

type ContentDefinition ¶ 

type ContentDefinition struct {
	MimeType string `json:"mimeType"`
	// text content. Only one of textContent or binary content can be specified
	TextContent *string `json:"textContent,omitempty"`
	// base64 encoded binary content. Only one of textContent or binary content can be specified
	BinaryContent *string `json:"binaryContent,omitempty"`
}

ContentDefinition - Describes text content or base64 encoded binary content

func (*ContentDefinition) GetBinaryContent ¶ 

func (c *ContentDefinition) GetBinaryContent() *string

func (*ContentDefinition) GetMimeType ¶ 

func (c *ContentDefinition) GetMimeType() string

func (*ContentDefinition) GetTextContent ¶ 

func (c *ContentDefinition) GetTextContent() *string

type ContentInsightsResponse ¶ 

type ContentInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp *int64 `json:"lastLogTimestamp,omitempty"`
	// Insights for documents.
	DocumentInsights []DocumentInsight `json:"documentInsights,omitempty"`
	// list of departments applicable for contents tab.
	Departments []string `json:"departments,omitempty"`
	// Min threshold in size of departments while populating results, otherwise 0.
	MinDepartmentSizeThreshold *int64 `json:"minDepartmentSizeThreshold,omitempty"`
	// Minimum number of visitors to a document required to be included in insights.
	MinVisitorThreshold *int64 `json:"minVisitorThreshold,omitempty"`
}

func (*ContentInsightsResponse) GetDepartments ¶ 

func (c *ContentInsightsResponse) GetDepartments() []string

func (*ContentInsightsResponse) GetDocumentInsights ¶ 

func (c *ContentInsightsResponse) GetDocumentInsights() []DocumentInsight

func (*ContentInsightsResponse) GetLastLogTimestamp ¶ 

func (c *ContentInsightsResponse) GetLastLogTimestamp() *int64

func (*ContentInsightsResponse) GetMinDepartmentSizeThreshold ¶ 

func (c *ContentInsightsResponse) GetMinDepartmentSizeThreshold() *int64

func (*ContentInsightsResponse) GetMinVisitorThreshold ¶ 

func (c *ContentInsightsResponse) GetMinVisitorThreshold() *int64

type ContentType ¶ 

type ContentType string
const (
	ContentTypeText ContentType = "text"
)

func (ContentType) ToPointer ¶ 

func (e ContentType) ToPointer() *ContentType

func (*ContentType) UnmarshalJSON ¶ 

func (e *ContentType) UnmarshalJSON(data []byte) error

type CountInfo ¶ 

type CountInfo struct {
	// The counter value
	Count  int64   `json:"count"`
	Period *Period `json:"period,omitempty"`
	// The unit of organization over which we did the count aggregation, e.g. org (department) or company
	Org *string `json:"org,omitempty"`
}

func (*CountInfo) GetCount ¶ 

func (c *CountInfo) GetCount() int64

func (*CountInfo) GetOrg ¶ 

func (c *CountInfo) GetOrg() *string

func (*CountInfo) GetPeriod ¶ 

func (c *CountInfo) GetPeriod() *Period

func (CountInfo) MarshalJSON ¶ added in v0.9.0 

func (c CountInfo) MarshalJSON() ([]byte, error)

func (*CountInfo) UnmarshalJSON ¶ added in v0.9.0 

func (c *CountInfo) UnmarshalJSON(data []byte) error

type CreateAnnouncementRequest ¶ 

type CreateAnnouncementRequest struct {
	// The date and time at which the announcement becomes active.
	StartTime time.Time `json:"startTime"`
	// The date and time at which the announcement expires.
	EndTime time.Time `json:"endTime"`
	// The headline of the announcement.
	Title string          `json:"title"`
	Body  *StructuredText `json:"body,omitempty"`
	// An emoji used to indicate the nature of the announcement.
	Emoji     *string    `json:"emoji,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	Banner    *Thumbnail `json:"banner,omitempty"`
	// Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
	SourceDocumentID *string `json:"sourceDocumentId,omitempty"`
	// Whether or not to hide an author attribution.
	HideAttribution *bool `json:"hideAttribution,omitempty"`
	// This determines whether this is a Social Feed post or a regular announcement.
	Channel *CreateAnnouncementRequestChannel `json:"channel,omitempty"`
	// This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.
	PostType *CreateAnnouncementRequestPostType `json:"postType,omitempty"`
	// Used by the Social Feed to pin posts to the front of the feed.
	IsPrioritized *bool `json:"isPrioritized,omitempty"`
	// URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".
	ViewURL *string `json:"viewUrl,omitempty"`
}

func (*CreateAnnouncementRequest) GetAudienceFilters ¶ 

func (c *CreateAnnouncementRequest) GetAudienceFilters() []FacetFilter

func (*CreateAnnouncementRequest) GetBanner ¶ 

func (c *CreateAnnouncementRequest) GetBanner() *Thumbnail

func (*CreateAnnouncementRequest) GetBody ¶ 

func (c *CreateAnnouncementRequest) GetBody() *StructuredText

func (*CreateAnnouncementRequest) GetChannel ¶ 

func (c *CreateAnnouncementRequest) GetChannel() *CreateAnnouncementRequestChannel

func (*CreateAnnouncementRequest) GetEmoji ¶ 

func (c *CreateAnnouncementRequest) GetEmoji() *string

func (*CreateAnnouncementRequest) GetEndTime ¶ 

func (c *CreateAnnouncementRequest) GetEndTime() time.Time

func (*CreateAnnouncementRequest) GetHideAttribution ¶ 

func (c *CreateAnnouncementRequest) GetHideAttribution() *bool

func (*CreateAnnouncementRequest) GetIsPrioritized ¶ 

func (c *CreateAnnouncementRequest) GetIsPrioritized() *bool

func (*CreateAnnouncementRequest) GetPostType ¶ 

func (c *CreateAnnouncementRequest) GetPostType() *CreateAnnouncementRequestPostType

func (*CreateAnnouncementRequest) GetSourceDocumentID ¶ 

func (c *CreateAnnouncementRequest) GetSourceDocumentID() *string

func (*CreateAnnouncementRequest) GetStartTime ¶ 

func (c *CreateAnnouncementRequest) GetStartTime() time.Time

func (*CreateAnnouncementRequest) GetThumbnail ¶ 

func (c *CreateAnnouncementRequest) GetThumbnail() *Thumbnail

func (*CreateAnnouncementRequest) GetTitle ¶ 

func (c *CreateAnnouncementRequest) GetTitle() string

func (*CreateAnnouncementRequest) GetViewURL ¶ 

func (c *CreateAnnouncementRequest) GetViewURL() *string

func (CreateAnnouncementRequest) MarshalJSON ¶ 

func (c CreateAnnouncementRequest) MarshalJSON() ([]byte, error)

func (*CreateAnnouncementRequest) UnmarshalJSON ¶ 

func (c *CreateAnnouncementRequest) UnmarshalJSON(data []byte) error

type CreateAnnouncementRequestChannel ¶ 

type CreateAnnouncementRequestChannel string

CreateAnnouncementRequestChannel - This determines whether this is a Social Feed post or a regular announcement. 

const (
	CreateAnnouncementRequestChannelMain       CreateAnnouncementRequestChannel = "MAIN"
	CreateAnnouncementRequestChannelSocialFeed CreateAnnouncementRequestChannel = "SOCIAL_FEED"
)

func (CreateAnnouncementRequestChannel) ToPointer ¶ 

func (e CreateAnnouncementRequestChannel) ToPointer() *CreateAnnouncementRequestChannel

func (*CreateAnnouncementRequestChannel) UnmarshalJSON ¶ 

func (e *CreateAnnouncementRequestChannel) UnmarshalJSON(data []byte) error

type CreateAnnouncementRequestPostType ¶ 

type CreateAnnouncementRequestPostType string

CreateAnnouncementRequestPostType - This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. 

const (
	CreateAnnouncementRequestPostTypeText CreateAnnouncementRequestPostType = "TEXT"
	CreateAnnouncementRequestPostTypeLink CreateAnnouncementRequestPostType = "LINK"
)

func (CreateAnnouncementRequestPostType) ToPointer ¶ 

func (e CreateAnnouncementRequestPostType) ToPointer() *CreateAnnouncementRequestPostType

func (*CreateAnnouncementRequestPostType) UnmarshalJSON ¶ 

func (e *CreateAnnouncementRequestPostType) UnmarshalJSON(data []byte) error

type CreateAnswerRequest ¶ 

type CreateAnswerRequest struct {
	Data AnswerCreationData `json:"data"`
}

func (*CreateAnswerRequest) GetData ¶ 

func (c *CreateAnswerRequest) GetData() AnswerCreationData

type CreateAuthTokenResponse ¶ 

type CreateAuthTokenResponse struct {
	// An authentication token that can be passed to any endpoint via Bearer Authentication
	Token string `json:"token"`
	// Unix timestamp for when this token expires (in seconds since epoch UTC).
	ExpirationTime int64 `json:"expirationTime"`
}

func (*CreateAuthTokenResponse) GetExpirationTime ¶ 

func (c *CreateAuthTokenResponse) GetExpirationTime() int64

func (*CreateAuthTokenResponse) GetToken ¶ 

func (c *CreateAuthTokenResponse) GetToken() string

type CreateCollectionRequest ¶ 

type CreateCollectionRequest struct {
	// The unique name of the Collection.
	Name string `json:"name"`
	// A brief summary of the Collection's contents.
	Description *string `json:"description,omitempty"`
	// A list of added user roles for the Collection.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of removed user roles for the Collection.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The emoji icon of this Collection.
	Icon *string `json:"icon,omitempty"`
	// Indicates whether edits are allowed for everyone or only admins.
	AdminLocked *bool `json:"adminLocked,omitempty"`
	// The parent of this Collection, or 0 if it's a top-level Collection.
	ParentID  *int64     `json:"parentId,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	// The datasource type this Collection can hold.
	AllowedDatasource *string `json:"allowedDatasource,omitempty"`
	// The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection. Only used if parentId is specified.
	NewNextItemID *string `json:"newNextItemId,omitempty"`
}

func (*CreateCollectionRequest) GetAddedRoles ¶ 

func (c *CreateCollectionRequest) GetAddedRoles() []UserRoleSpecification

func (*CreateCollectionRequest) GetAdminLocked ¶ 

func (c *CreateCollectionRequest) GetAdminLocked() *bool

func (*CreateCollectionRequest) GetAllowedDatasource ¶ 

func (c *CreateCollectionRequest) GetAllowedDatasource() *string

func (*CreateCollectionRequest) GetAudienceFilters ¶ 

func (c *CreateCollectionRequest) GetAudienceFilters() []FacetFilter

func (*CreateCollectionRequest) GetDescription ¶ 

func (c *CreateCollectionRequest) GetDescription() *string

func (*CreateCollectionRequest) GetIcon ¶ 

func (c *CreateCollectionRequest) GetIcon() *string

func (*CreateCollectionRequest) GetName ¶ 

func (c *CreateCollectionRequest) GetName() string

func (*CreateCollectionRequest) GetNewNextItemID ¶ 

func (c *CreateCollectionRequest) GetNewNextItemID() *string

func (*CreateCollectionRequest) GetParentID ¶ 

func (c *CreateCollectionRequest) GetParentID() *int64

func (*CreateCollectionRequest) GetRemovedRoles ¶ 

func (c *CreateCollectionRequest) GetRemovedRoles() []UserRoleSpecification

func (*CreateCollectionRequest) GetThumbnail ¶ 

func (c *CreateCollectionRequest) GetThumbnail() *Thumbnail

type CreateDlpReportRequest ¶ 

type CreateDlpReportRequest struct {
	// Name of the policy being created.
	Name *string `json:"name,omitempty"`
	// Detailed configuration of what documents and sensitive content will be scanned.
	Config *DlpConfig `json:"config,omitempty"`
	// Interval between scans. DAILY is deprecated.
	Frequency *DlpFrequency `json:"frequency,omitempty"`
	// Controls whether the policy should hide documents with violations.
	AutoHideDocs *bool `json:"autoHideDocs,omitempty"`
}

func (*CreateDlpReportRequest) GetAutoHideDocs ¶ 

func (c *CreateDlpReportRequest) GetAutoHideDocs() *bool

func (*CreateDlpReportRequest) GetConfig ¶ 

func (c *CreateDlpReportRequest) GetConfig() *DlpConfig

func (*CreateDlpReportRequest) GetFrequency ¶ 

func (c *CreateDlpReportRequest) GetFrequency() *DlpFrequency

func (*CreateDlpReportRequest) GetName ¶ 

func (c *CreateDlpReportRequest) GetName() *string

type CreateDlpReportResponse ¶ 

type CreateDlpReportResponse struct {
	// Full policy information that will be used for scans.
	Report *DlpReport `json:"report,omitempty"`
}

func (*CreateDlpReportResponse) GetReport ¶ 

func (c *CreateDlpReportResponse) GetReport() *DlpReport

type CreateShortcutRequest ¶ 

type CreateShortcutRequest struct {
	Data ShortcutMutableProperties `json:"data"`
}

func (*CreateShortcutRequest) GetData ¶ 

func (c *CreateShortcutRequest) GetData() ShortcutMutableProperties

type CreateShortcutResponse ¶ 

type CreateShortcutResponse struct {
	Shortcut *Shortcut      `json:"shortcut,omitempty"`
	Error    *ShortcutError `json:"error,omitempty"`
}

func (*CreateShortcutResponse) GetError ¶ 

func (c *CreateShortcutResponse) GetError() *ShortcutError

func (*CreateShortcutResponse) GetShortcut ¶ 

func (c *CreateShortcutResponse) GetShortcut() *Shortcut

type CustomDataValue ¶ 

type CustomDataValue struct {
	DisplayLabel *string `json:"displayLabel,omitempty"`
	StringValue  *string `json:"stringValue,omitempty"`
	// list of strings for multi-value properties
	StringListValue []string `json:"stringListValue,omitempty"`
	NumberValue     *float64 `json:"numberValue,omitempty"`
	BooleanValue    *bool    `json:"booleanValue,omitempty"`
}

func (*CustomDataValue) GetBooleanValue ¶ 

func (c *CustomDataValue) GetBooleanValue() *bool

func (*CustomDataValue) GetDisplayLabel ¶ 

func (c *CustomDataValue) GetDisplayLabel() *string

func (*CustomDataValue) GetNumberValue ¶ 

func (c *CustomDataValue) GetNumberValue() *float64

func (*CustomDataValue) GetStringListValue ¶ 

func (c *CustomDataValue) GetStringListValue() []string

func (*CustomDataValue) GetStringValue ¶ 

func (c *CustomDataValue) GetStringValue() *string

func (CustomDataValue) MarshalJSON ¶ added in v0.9.0 

func (c CustomDataValue) MarshalJSON() ([]byte, error)

func (*CustomDataValue) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomDataValue) UnmarshalJSON(data []byte) error

type CustomDatasourceConfig ¶ 

type CustomDatasourceConfig struct {
	// Unique identifier of datasource instance to which this config applies.
	Name string `json:"name"`
	// The user-friendly instance label to display. If omitted, falls back to the title-cased `name`.
	DisplayName *string `json:"displayName,omitempty"`
	// The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details.
	DatasourceCategory *DatasourceCategory `default:"UNCATEGORIZED" json:"datasourceCategory"`
	// Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. **Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.**
	URLRegex *string `json:"urlRegex,omitempty"`
	// The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
	IconURL *string `json:"iconUrl,omitempty"`
	// The list of top-level `objectType`s for the datasource.
	ObjectDefinitions []ObjectDefinition `json:"objectDefinitions,omitempty"`
	// Example text for what to search for in this datasource
	SuggestionText *string `json:"suggestionText,omitempty"`
	// The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page.
	HomeURL *string `json:"homeUrl,omitempty"`
	// This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling.
	CrawlerSeedUrls []string `json:"crawlerSeedUrls,omitempty"`
	// The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
	IconDarkURL *string `json:"iconDarkUrl,omitempty"`
	// List of built-in facet types that should be hidden for the datasource.
	HideBuiltInFacets []HideBuiltInFacet `json:"hideBuiltInFacets,omitempty"`
	// A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list.
	CanonicalizingURLRegex []CanonicalizingRegexType `json:"canonicalizingURLRegex,omitempty"`
	// A list of regular expressions to apply to an arbitrary title to transform it into a title that will be displayed in the search results
	CanonicalizingTitleRegex []CanonicalizingRegexType `json:"canonicalizingTitleRegex,omitempty"`
	// A regex that identifies titles that should not be indexed
	RedlistTitleRegex *string                              `json:"redlistTitleRegex,omitempty"`
	ConnectorType     *CustomDatasourceConfigConnectorType `json:"connectorType,omitempty"`
	// List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira
	Quicklinks []Quicklink `json:"quicklinks,omitempty"`
	// The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to [this](https://developers.glean.com/docs/rendering_search_results/) for more details
	RenderConfigPreset *string `json:"renderConfigPreset,omitempty"`
	// Aliases that can be used as `app` operator-values.
	Aliases []string `json:"aliases,omitempty"`
	// Whether or not this datasource is hosted on-premise.
	IsOnPrem *bool `json:"isOnPrem,omitempty"`
	// True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load.
	TrustURLRegexForViewActivity *bool `default:"true" json:"trustUrlRegexForViewActivity"`
	// If true, a utm_source query param will be added to outbound links to this datasource within Glean.
	IncludeUtmSource *bool `json:"includeUtmSource,omitempty"`
	// If true, the fragment part of the URL will be stripped when converting to a canonical url.
	StripFragmentInCanonicalURL *bool `default:"true" json:"stripFragmentInCanonicalUrl"`
	// If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already.
	IdentityDatasourceName *string `json:"identityDatasourceName,omitempty"`
	// If the datasource uses a specific product access group, then the name of that group.
	ProductAccessGroup *string `json:"productAccessGroup,omitempty"`
	// whether email is used to reference users in document ACLs and in group memberships.
	IsUserReferencedByEmail *bool `json:"isUserReferencedByEmail,omitempty"`
	// True if this datasource is used to push custom entities.
	IsEntityDatasource *bool `default:"false" json:"isEntityDatasource"`
	// True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings.
	IsTestDatasource *bool `default:"false" json:"isTestDatasource"`
}

CustomDatasourceConfig - Structure describing config properties of a custom datasource

func (*CustomDatasourceConfig) GetAliases ¶ 

func (c *CustomDatasourceConfig) GetAliases() []string

func (*CustomDatasourceConfig) GetCanonicalizingTitleRegex ¶ 

func (c *CustomDatasourceConfig) GetCanonicalizingTitleRegex() []CanonicalizingRegexType

func (*CustomDatasourceConfig) GetCanonicalizingURLRegex ¶ 

func (c *CustomDatasourceConfig) GetCanonicalizingURLRegex() []CanonicalizingRegexType

func (*CustomDatasourceConfig) GetConnectorType ¶ 

func (c *CustomDatasourceConfig) GetConnectorType() *CustomDatasourceConfigConnectorType

func (*CustomDatasourceConfig) GetCrawlerSeedUrls ¶ 

func (c *CustomDatasourceConfig) GetCrawlerSeedUrls() []string

func (*CustomDatasourceConfig) GetDatasourceCategory ¶ 

func (c *CustomDatasourceConfig) GetDatasourceCategory() *DatasourceCategory

func (*CustomDatasourceConfig) GetDisplayName ¶ 

func (c *CustomDatasourceConfig) GetDisplayName() *string

func (*CustomDatasourceConfig) GetHideBuiltInFacets ¶ 

func (c *CustomDatasourceConfig) GetHideBuiltInFacets() []HideBuiltInFacet

func (*CustomDatasourceConfig) GetHomeURL ¶ 

func (c *CustomDatasourceConfig) GetHomeURL() *string

func (*CustomDatasourceConfig) GetIconDarkURL ¶ 

func (c *CustomDatasourceConfig) GetIconDarkURL() *string

func (*CustomDatasourceConfig) GetIconURL ¶ 

func (c *CustomDatasourceConfig) GetIconURL() *string

func (*CustomDatasourceConfig) GetIdentityDatasourceName ¶ 

func (c *CustomDatasourceConfig) GetIdentityDatasourceName() *string

func (*CustomDatasourceConfig) GetIncludeUtmSource ¶ 

func (c *CustomDatasourceConfig) GetIncludeUtmSource() *bool

func (*CustomDatasourceConfig) GetIsEntityDatasource ¶ 

func (c *CustomDatasourceConfig) GetIsEntityDatasource() *bool

func (*CustomDatasourceConfig) GetIsOnPrem ¶ 

func (c *CustomDatasourceConfig) GetIsOnPrem() *bool

func (*CustomDatasourceConfig) GetIsTestDatasource ¶ 

func (c *CustomDatasourceConfig) GetIsTestDatasource() *bool

func (*CustomDatasourceConfig) GetIsUserReferencedByEmail ¶ 

func (c *CustomDatasourceConfig) GetIsUserReferencedByEmail() *bool

func (*CustomDatasourceConfig) GetName ¶ 

func (c *CustomDatasourceConfig) GetName() string

func (*CustomDatasourceConfig) GetObjectDefinitions ¶ 

func (c *CustomDatasourceConfig) GetObjectDefinitions() []ObjectDefinition

func (*CustomDatasourceConfig) GetProductAccessGroup ¶ 

func (c *CustomDatasourceConfig) GetProductAccessGroup() *string
func (c *CustomDatasourceConfig) GetQuicklinks() []Quicklink

func (*CustomDatasourceConfig) GetRedlistTitleRegex ¶ 

func (c *CustomDatasourceConfig) GetRedlistTitleRegex() *string

func (*CustomDatasourceConfig) GetRenderConfigPreset ¶ 

func (c *CustomDatasourceConfig) GetRenderConfigPreset() *string

func (*CustomDatasourceConfig) GetStripFragmentInCanonicalURL ¶ 

func (c *CustomDatasourceConfig) GetStripFragmentInCanonicalURL() *bool

func (*CustomDatasourceConfig) GetSuggestionText ¶ 

func (c *CustomDatasourceConfig) GetSuggestionText() *string

func (*CustomDatasourceConfig) GetTrustURLRegexForViewActivity ¶ 

func (c *CustomDatasourceConfig) GetTrustURLRegexForViewActivity() *bool

func (*CustomDatasourceConfig) GetURLRegex ¶ 

func (c *CustomDatasourceConfig) GetURLRegex() *string

func (CustomDatasourceConfig) MarshalJSON ¶ 

func (c CustomDatasourceConfig) MarshalJSON() ([]byte, error)

func (*CustomDatasourceConfig) UnmarshalJSON ¶ 

func (c *CustomDatasourceConfig) UnmarshalJSON(data []byte) error

type CustomDatasourceConfigConnectorType ¶ 

type CustomDatasourceConfigConnectorType string

CustomDatasourceConfigConnectorType - The source from which document content was pulled, e.g. an API crawl or browser history 

const (
	CustomDatasourceConfigConnectorTypeAPICrawl        CustomDatasourceConfigConnectorType = "API_CRAWL"
	CustomDatasourceConfigConnectorTypeBrowserCrawl    CustomDatasourceConfigConnectorType = "BROWSER_CRAWL"
	CustomDatasourceConfigConnectorTypeBrowserHistory  CustomDatasourceConfigConnectorType = "BROWSER_HISTORY"
	CustomDatasourceConfigConnectorTypeBuiltin         CustomDatasourceConfigConnectorType = "BUILTIN"
	CustomDatasourceConfigConnectorTypeFederatedSearch CustomDatasourceConfigConnectorType = "FEDERATED_SEARCH"
	CustomDatasourceConfigConnectorTypePushAPI         CustomDatasourceConfigConnectorType = "PUSH_API"
	CustomDatasourceConfigConnectorTypeWebCrawl        CustomDatasourceConfigConnectorType = "WEB_CRAWL"
	CustomDatasourceConfigConnectorTypeNativeHistory   CustomDatasourceConfigConnectorType = "NATIVE_HISTORY"
)

func (CustomDatasourceConfigConnectorType) ToPointer ¶ 

func (e CustomDatasourceConfigConnectorType) ToPointer() *CustomDatasourceConfigConnectorType

func (*CustomDatasourceConfigConnectorType) UnmarshalJSON ¶ 

func (e *CustomDatasourceConfigConnectorType) UnmarshalJSON(data []byte) error

type CustomEntity ¶ 

type CustomEntity struct {
	Permissions *ObjectPermissions `json:"permissions,omitempty"`
	// Unique identifier.
	ID *string `json:"id,omitempty"`
	// Title or name of the custom entity.
	Title *string `json:"title,omitempty"`
	// The datasource the custom entity is from.
	Datasource *string `json:"datasource,omitempty"`
	// The type of the entity. Interpretation is specific to each datasource
	ObjectType *string               `json:"objectType,omitempty"`
	Metadata   *CustomEntityMetadata `json:"metadata,omitempty"`
	// A list of user roles for the custom entity explicitly granted by the owner.
	Roles []UserRoleSpecification `json:"roles,omitempty"`
}

func (*CustomEntity) GetDatasource ¶ 

func (c *CustomEntity) GetDatasource() *string

func (*CustomEntity) GetID ¶ 

func (c *CustomEntity) GetID() *string

func (*CustomEntity) GetMetadata ¶ 

func (c *CustomEntity) GetMetadata() *CustomEntityMetadata

func (*CustomEntity) GetObjectType ¶ 

func (c *CustomEntity) GetObjectType() *string

func (*CustomEntity) GetPermissions ¶ 

func (c *CustomEntity) GetPermissions() *ObjectPermissions

func (*CustomEntity) GetRoles ¶ 

func (c *CustomEntity) GetRoles() []UserRoleSpecification

func (*CustomEntity) GetTitle ¶ 

func (c *CustomEntity) GetTitle() *string

func (CustomEntity) MarshalJSON ¶ added in v0.9.0 

func (c CustomEntity) MarshalJSON() ([]byte, error)

func (*CustomEntity) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomEntity) UnmarshalJSON(data []byte) error

type CustomEntityMetadata ¶ 

type CustomEntityMetadata struct {
	// Custom fields specific to individual datasources
	CustomData map[string]CustomDataValue `json:"customData,omitempty"`
}

func (*CustomEntityMetadata) GetCustomData ¶ 

func (c *CustomEntityMetadata) GetCustomData() map[string]CustomDataValue

func (CustomEntityMetadata) MarshalJSON ¶ added in v0.9.0 

func (c CustomEntityMetadata) MarshalJSON() ([]byte, error)

func (*CustomEntityMetadata) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomEntityMetadata) UnmarshalJSON(data []byte) error

type CustomFieldData ¶ 

type CustomFieldData struct {
	// A user-facing label for this field.
	Label  string             `json:"label"`
	Values []CustomFieldValue `json:"values"`
	// Determines whether the client should display this custom field
	Displayable *bool `default:"true" json:"displayable"`
}

func (*CustomFieldData) GetDisplayable ¶ 

func (c *CustomFieldData) GetDisplayable() *bool

func (*CustomFieldData) GetLabel ¶ 

func (c *CustomFieldData) GetLabel() string

func (*CustomFieldData) GetValues ¶ 

func (c *CustomFieldData) GetValues() []CustomFieldValue

func (CustomFieldData) MarshalJSON ¶ 

func (c CustomFieldData) MarshalJSON() ([]byte, error)

func (*CustomFieldData) UnmarshalJSON ¶ 

func (c *CustomFieldData) UnmarshalJSON(data []byte) error

type CustomFieldValue ¶ 

type CustomFieldValue struct {
	CustomFieldValueStr       *CustomFieldValueStr       `queryParam:"inline,name=CustomFieldValue"`
	CustomFieldValueHyperlink *CustomFieldValueHyperlink `queryParam:"inline,name=CustomFieldValue"`
	CustomFieldValuePerson    *CustomFieldValuePerson    `queryParam:"inline,name=CustomFieldValue"`

	Type CustomFieldValueType
}
func CreateCustomFieldValueCustomFieldValueHyperlink(customFieldValueHyperlink CustomFieldValueHyperlink) CustomFieldValue

func CreateCustomFieldValueCustomFieldValuePerson ¶ 

func CreateCustomFieldValueCustomFieldValuePerson(customFieldValuePerson CustomFieldValuePerson) CustomFieldValue

func CreateCustomFieldValueCustomFieldValueStr ¶ 

func CreateCustomFieldValueCustomFieldValueStr(customFieldValueStr CustomFieldValueStr) CustomFieldValue

func (CustomFieldValue) MarshalJSON ¶ 

func (u CustomFieldValue) MarshalJSON() ([]byte, error)

func (*CustomFieldValue) UnmarshalJSON ¶ 

func (u *CustomFieldValue) UnmarshalJSON(data []byte) error
type CustomFieldValueHyperlink struct {
	// Anchor text for hyperlink.
	URLAnchor *string `json:"urlAnchor,omitempty"`
	// Link for this URL.
	URLLink *string `json:"urlLink,omitempty"`
}

func (*CustomFieldValueHyperlink) GetURLAnchor ¶ 

func (c *CustomFieldValueHyperlink) GetURLAnchor() *string
func (c *CustomFieldValueHyperlink) GetURLLink() *string

func (CustomFieldValueHyperlink) MarshalJSON ¶ added in v0.9.0 

func (c CustomFieldValueHyperlink) MarshalJSON() ([]byte, error)

func (*CustomFieldValueHyperlink) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomFieldValueHyperlink) UnmarshalJSON(data []byte) error

type CustomFieldValuePerson ¶ 

type CustomFieldValuePerson struct {
	Person *Person `json:"person,omitempty"`
}

func (*CustomFieldValuePerson) GetPerson ¶ 

func (c *CustomFieldValuePerson) GetPerson() *Person

func (CustomFieldValuePerson) MarshalJSON ¶ added in v0.9.0 

func (c CustomFieldValuePerson) MarshalJSON() ([]byte, error)

func (*CustomFieldValuePerson) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomFieldValuePerson) UnmarshalJSON(data []byte) error

type CustomFieldValueStr ¶ 

type CustomFieldValueStr struct {
	// Text field for string value.
	StrText *string `json:"strText,omitempty"`
}

func (*CustomFieldValueStr) GetStrText ¶ 

func (c *CustomFieldValueStr) GetStrText() *string

func (CustomFieldValueStr) MarshalJSON ¶ added in v0.9.0 

func (c CustomFieldValueStr) MarshalJSON() ([]byte, error)

func (*CustomFieldValueStr) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomFieldValueStr) UnmarshalJSON(data []byte) error

type CustomFieldValueType ¶ 

type CustomFieldValueType string
const (
	CustomFieldValueTypeCustomFieldValueStr       CustomFieldValueType = "CustomFieldValueStr"
	CustomFieldValueTypeCustomFieldValueHyperlink CustomFieldValueType = "CustomFieldValueHyperlink"
	CustomFieldValueTypeCustomFieldValuePerson    CustomFieldValueType = "CustomFieldValuePerson"
)

type CustomProperty ¶ 

type CustomProperty struct {
	Name *string `json:"name,omitempty"`
	// Must either be a string or an array of strings. An integer, boolean, etc. is not valid. When OpenAPI Generator supports `oneOf`, we can semantically enforce this.
	Value any `json:"value,omitempty"`
}

CustomProperty - Describes the custom properties of the object.

func (*CustomProperty) GetName ¶ 

func (c *CustomProperty) GetName() *string

func (*CustomProperty) GetValue ¶ 

func (c *CustomProperty) GetValue() any

type Customer ¶ 

type Customer struct {
	// Unique identifier.
	ID string `json:"id"`
	// Link to company's associated website domains.
	Domains []string `json:"domains,omitempty"`
	Company Company  `json:"company"`
	// A map of {string, int} pairs representing counts of each document type associated with this customer.
	DocumentCounts map[string]int64 `json:"documentCounts,omitempty"`
	// A list of POC for company.
	Poc      []Person          `json:"poc,omitempty"`
	Metadata *CustomerMetadata `json:"metadata,omitempty"`
	// A list of Customers.
	MergedCustomers []Customer `json:"mergedCustomers,omitempty"`
	// The date when the interaction with customer started.
	StartDate *types.Date `json:"startDate,omitempty"`
	// Average contract annual revenue with that customer.
	ContractAnnualRevenue *float64 `json:"contractAnnualRevenue,omitempty"`
	// User facing (potentially generated) notes about company.
	Notes *string `json:"notes,omitempty"`
}

func (*Customer) GetCompany ¶ 

func (c *Customer) GetCompany() Company

func (*Customer) GetContractAnnualRevenue ¶ 

func (c *Customer) GetContractAnnualRevenue() *float64

func (*Customer) GetDocumentCounts ¶ 

func (c *Customer) GetDocumentCounts() map[string]int64

func (*Customer) GetDomains ¶ 

func (c *Customer) GetDomains() []string

func (*Customer) GetID ¶ 

func (c *Customer) GetID() string

func (*Customer) GetMergedCustomers ¶ 

func (c *Customer) GetMergedCustomers() []Customer

func (*Customer) GetMetadata ¶ 

func (c *Customer) GetMetadata() *CustomerMetadata

func (*Customer) GetNotes ¶ 

func (c *Customer) GetNotes() *string

func (*Customer) GetPoc ¶ 

func (c *Customer) GetPoc() []Person

func (*Customer) GetStartDate ¶ 

func (c *Customer) GetStartDate() *types.Date

func (Customer) MarshalJSON ¶ 

func (c Customer) MarshalJSON() ([]byte, error)

func (*Customer) UnmarshalJSON ¶ 

func (c *Customer) UnmarshalJSON(data []byte) error

type CustomerMetadata ¶ 

type CustomerMetadata struct {
	// The user visible id of the salesforce customer account.
	DatasourceID *string `json:"datasourceId,omitempty"`
	// Custom fields specific to individual datasources
	CustomData map[string]CustomDataValue `json:"customData,omitempty"`
}

func (*CustomerMetadata) GetCustomData ¶ 

func (c *CustomerMetadata) GetCustomData() map[string]CustomDataValue

func (*CustomerMetadata) GetDatasourceID ¶ 

func (c *CustomerMetadata) GetDatasourceID() *string

func (CustomerMetadata) MarshalJSON ¶ added in v0.9.0 

func (c CustomerMetadata) MarshalJSON() ([]byte, error)

func (*CustomerMetadata) UnmarshalJSON ¶ added in v0.9.0 

func (c *CustomerMetadata) UnmarshalJSON(data []byte) error

type Datasource ¶ 

type Datasource string

Datasource - The type of the data source. Missing field defaults to SLACK. 

const (
	DatasourceSlack             Datasource = "SLACK"
	DatasourceMicrosoftteams    Datasource = "MICROSOFTTEAMS"
	DatasourceFacebookworkplace Datasource = "FACEBOOKWORKPLACE"
)

func (Datasource) ToPointer ¶ 

func (e Datasource) ToPointer() *Datasource

func (*Datasource) UnmarshalJSON ¶ 

func (e *Datasource) UnmarshalJSON(data []byte) error

type DatasourceBulkMembershipDefinition ¶ 

type DatasourceBulkMembershipDefinition struct {
	// If the member is a user, then the email or datasource id for the user
	MemberUserID *string `json:"memberUserId,omitempty"`
	// If the member is a group, then the name of the member group
	MemberGroupName *string `json:"memberGroupName,omitempty"`
}

DatasourceBulkMembershipDefinition - describes the membership row of a group in the bulk uploaded. Only one of memberUserId and memberGroupName can be specified.

func (*DatasourceBulkMembershipDefinition) GetMemberGroupName ¶ 

func (d *DatasourceBulkMembershipDefinition) GetMemberGroupName() *string

func (*DatasourceBulkMembershipDefinition) GetMemberUserID ¶ 

func (d *DatasourceBulkMembershipDefinition) GetMemberUserID() *string

type DatasourceCategory ¶ 

type DatasourceCategory string

DatasourceCategory - The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details. 

const (
	DatasourceCategoryUncategorized        DatasourceCategory = "UNCATEGORIZED"
	DatasourceCategoryTickets              DatasourceCategory = "TICKETS"
	DatasourceCategoryCrm                  DatasourceCategory = "CRM"
	DatasourceCategoryPublishedContent     DatasourceCategory = "PUBLISHED_CONTENT"
	DatasourceCategoryCollaborativeContent DatasourceCategory = "COLLABORATIVE_CONTENT"
	DatasourceCategoryQuestionAnswer       DatasourceCategory = "QUESTION_ANSWER"
	DatasourceCategoryMessaging            DatasourceCategory = "MESSAGING"
	DatasourceCategoryCodeRepository       DatasourceCategory = "CODE_REPOSITORY"
	DatasourceCategoryChangeManagement     DatasourceCategory = "CHANGE_MANAGEMENT"
	DatasourceCategoryPeople               DatasourceCategory = "PEOPLE"
	DatasourceCategoryEmail                DatasourceCategory = "EMAIL"
	DatasourceCategorySso                  DatasourceCategory = "SSO"
	DatasourceCategoryAts                  DatasourceCategory = "ATS"
	DatasourceCategoryKnowledgeHub         DatasourceCategory = "KNOWLEDGE_HUB"
	DatasourceCategoryExternalShortcut     DatasourceCategory = "EXTERNAL_SHORTCUT"
	DatasourceCategoryEntity               DatasourceCategory = "ENTITY"
	DatasourceCategoryCalendar             DatasourceCategory = "CALENDAR"
	DatasourceCategoryAgents               DatasourceCategory = "AGENTS"
)

func (DatasourceCategory) ToPointer ¶ 

func (e DatasourceCategory) ToPointer() *DatasourceCategory

func (*DatasourceCategory) UnmarshalJSON ¶ 

func (e *DatasourceCategory) UnmarshalJSON(data []byte) error

type DatasourceGroupDefinition ¶ 

type DatasourceGroupDefinition struct {
	// name of the group. Should be unique among all groups for the datasource, and cannot have spaces.
	Name string `json:"name"`
}

DatasourceGroupDefinition - describes a group in the datasource

func (*DatasourceGroupDefinition) GetName ¶ 

func (d *DatasourceGroupDefinition) GetName() string

type DatasourceMembershipDefinition ¶ 

type DatasourceMembershipDefinition struct {
	// The group for which the membership is specified
	GroupName string `json:"groupName"`
	// If the member is a user, then the email or datasource id for the user
	MemberUserID *string `json:"memberUserId,omitempty"`
	// If the member is a group, then the name of the member group
	MemberGroupName *string `json:"memberGroupName,omitempty"`
}

DatasourceMembershipDefinition - describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified.

func (*DatasourceMembershipDefinition) GetGroupName ¶ 

func (d *DatasourceMembershipDefinition) GetGroupName() string

func (*DatasourceMembershipDefinition) GetMemberGroupName ¶ 

func (d *DatasourceMembershipDefinition) GetMemberGroupName() *string

func (*DatasourceMembershipDefinition) GetMemberUserID ¶ 

func (d *DatasourceMembershipDefinition) GetMemberUserID() *string

type DatasourceObjectTypeDocumentCountEntry ¶ 

type DatasourceObjectTypeDocumentCountEntry struct {
	// The object type of the document
	ObjectType *string `json:"objectType,omitempty"`
	// The number of documents of the corresponding objectType
	Count *int64 `json:"count,omitempty"`
}

func (*DatasourceObjectTypeDocumentCountEntry) GetCount ¶ 

func (d *DatasourceObjectTypeDocumentCountEntry) GetCount() *int64

func (*DatasourceObjectTypeDocumentCountEntry) GetObjectType ¶ 

func (d *DatasourceObjectTypeDocumentCountEntry) GetObjectType() *string

type DatasourceProfile ¶ 

type DatasourceProfile struct {
	// The datasource the profile is of.
	Datasource string `json:"datasource"`
	// The display name of the entity in the given datasource.
	Handle string `json:"handle"`
	// URL to view the entity's profile.
	URL *string `json:"url,omitempty"`
	// A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...).
	NativeAppURL *string `json:"nativeAppUrl,omitempty"`
	// For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source)
	IsUserGenerated *bool `json:"isUserGenerated,omitempty"`
}

func (*DatasourceProfile) GetDatasource ¶ 

func (d *DatasourceProfile) GetDatasource() string

func (*DatasourceProfile) GetHandle ¶ 

func (d *DatasourceProfile) GetHandle() string

func (*DatasourceProfile) GetIsUserGenerated ¶ 

func (d *DatasourceProfile) GetIsUserGenerated() *bool

func (*DatasourceProfile) GetNativeAppURL ¶ 

func (d *DatasourceProfile) GetNativeAppURL() *string

func (*DatasourceProfile) GetURL ¶ 

func (d *DatasourceProfile) GetURL() *string

func (DatasourceProfile) MarshalJSON ¶ added in v0.9.0 

func (d DatasourceProfile) MarshalJSON() ([]byte, error)

func (*DatasourceProfile) UnmarshalJSON ¶ added in v0.9.0 

func (d *DatasourceProfile) UnmarshalJSON(data []byte) error

type DatasourceUserDefinition ¶ 

type DatasourceUserDefinition struct {
	Email string `json:"email"`
	// To be supplied if the user id in the datasource is not the email
	UserID *string `json:"userId,omitempty"`
	Name   string  `json:"name"`
	// set to false if the user is a former employee or a bot
	IsActive *bool `json:"isActive,omitempty"`
}

DatasourceUserDefinition - describes a user in the datasource

func (*DatasourceUserDefinition) GetEmail ¶ 

func (d *DatasourceUserDefinition) GetEmail() string

func (*DatasourceUserDefinition) GetIsActive ¶ 

func (d *DatasourceUserDefinition) GetIsActive() *bool

func (*DatasourceUserDefinition) GetName ¶ 

func (d *DatasourceUserDefinition) GetName() string

func (*DatasourceUserDefinition) GetUserID ¶ 

func (d *DatasourceUserDefinition) GetUserID() *string

type DatasourceVisibility ¶ 

type DatasourceVisibility string

DatasourceVisibility - The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE 

const (
	DatasourceVisibilityEnabledForAll       DatasourceVisibility = "ENABLED_FOR_ALL"
	DatasourceVisibilityEnabledForTestGroup DatasourceVisibility = "ENABLED_FOR_TEST_GROUP"
	DatasourceVisibilityNotEnabled          DatasourceVisibility = "NOT_ENABLED"
)

func (DatasourceVisibility) ToPointer ¶ 

func (e DatasourceVisibility) ToPointer() *DatasourceVisibility

func (*DatasourceVisibility) UnmarshalJSON ¶ 

func (e *DatasourceVisibility) UnmarshalJSON(data []byte) error

type DatasourcesType ¶ 

type DatasourcesType string

DatasourcesType - The types of datasource for which to run the report/policy. 

const (
	DatasourcesTypeAll    DatasourcesType = "ALL"
	DatasourcesTypeCustom DatasourcesType = "CUSTOM"
)

func (DatasourcesType) ToPointer ¶ 

func (e DatasourcesType) ToPointer() *DatasourcesType

func (*DatasourcesType) UnmarshalJSON ¶ 

func (e *DatasourcesType) UnmarshalJSON(data []byte) error

type DebugDatasourceStatusIdentityResponseComponent ¶ 

type DebugDatasourceStatusIdentityResponseComponent struct {
	// Information about active and recent successful uploads for the datasource
	BulkUploadHistory []BulkUploadHistoryEvent                              `json:"bulkUploadHistory,omitempty"`
	Counts            *DebugDatasourceStatusIdentityResponseComponentCounts `json:"counts,omitempty"`
}

func (*DebugDatasourceStatusIdentityResponseComponent) GetBulkUploadHistory ¶ 

func (d *DebugDatasourceStatusIdentityResponseComponent) GetBulkUploadHistory() []BulkUploadHistoryEvent

func (*DebugDatasourceStatusIdentityResponseComponent) GetCounts ¶ 

func (d *DebugDatasourceStatusIdentityResponseComponent) GetCounts() *DebugDatasourceStatusIdentityResponseComponentCounts

type DebugDatasourceStatusIdentityResponseComponentCounts ¶ 

type DebugDatasourceStatusIdentityResponseComponentCounts struct {
	// The number of users/groups/memberships uploaded
	Uploaded *int64 `json:"uploaded,omitempty"`
}

func (*DebugDatasourceStatusIdentityResponseComponentCounts) GetUploaded ¶ 

func (d *DebugDatasourceStatusIdentityResponseComponentCounts) GetUploaded() *int64

type DebugDatasourceStatusResponse ¶ 

type DebugDatasourceStatusResponse struct {
	Documents *Documents `json:"documents,omitempty"`
	Identity  *Identity  `json:"identity,omitempty"`
	// The visibility of the datasource, an enum of VISIBLE_TO_ALL, VISIBLE_TO_TEST_GROUP, NOT_VISIBLE
	DatasourceVisibility *DatasourceVisibility `json:"datasourceVisibility,omitempty"`
}

DebugDatasourceStatusResponse - Describes the response body of the /debug/{datasource}/status API call

func (*DebugDatasourceStatusResponse) GetDatasourceVisibility ¶ 

func (d *DebugDatasourceStatusResponse) GetDatasourceVisibility() *DatasourceVisibility

func (*DebugDatasourceStatusResponse) GetDocuments ¶ 

func (d *DebugDatasourceStatusResponse) GetDocuments() *Documents

func (*DebugDatasourceStatusResponse) GetIdentity ¶ 

func (d *DebugDatasourceStatusResponse) GetIdentity() *Identity

type DebugDatasourceStatusResponseCounts ¶ 

type DebugDatasourceStatusResponseCounts struct {
	// A list of object types and corresponding upload counts
	Uploaded []DatasourceObjectTypeDocumentCountEntry `json:"uploaded,omitempty"`
	// The number of documents indexed, grouped by objectType
	Indexed []DatasourceObjectTypeDocumentCountEntry `json:"indexed,omitempty"`
}

func (*DebugDatasourceStatusResponseCounts) GetIndexed ¶ 

func (d *DebugDatasourceStatusResponseCounts) GetIndexed() []DatasourceObjectTypeDocumentCountEntry

func (*DebugDatasourceStatusResponseCounts) GetUploaded ¶ 

func (d *DebugDatasourceStatusResponseCounts) GetUploaded() []DatasourceObjectTypeDocumentCountEntry

type DebugDocumentRequest ¶ 

type DebugDocumentRequest struct {
	// Object type of the document to get the status for.
	ObjectType string `json:"objectType"`
	// Glean Document ID within the datasource to get the status for.
	DocID string `json:"docId"`
}

DebugDocumentRequest - Describes the request body of the /debug/{datasource}/document API call.

func (*DebugDocumentRequest) GetDocID ¶ 

func (d *DebugDocumentRequest) GetDocID() string

func (*DebugDocumentRequest) GetObjectType ¶ 

func (d *DebugDocumentRequest) GetObjectType() string

type DebugDocumentResponse ¶ 

type DebugDocumentResponse struct {
	// Describes the document status response body
	Status *DocumentStatusResponse `json:"status,omitempty"`
	// describes the access control details of the document
	UploadedPermissions *DocumentPermissionsDefinition `json:"uploadedPermissions,omitempty"`
}

DebugDocumentResponse - Describes the response body of the /debug/{datasource}/document API call

func (*DebugDocumentResponse) GetStatus ¶ 

func (d *DebugDocumentResponse) GetStatus() *DocumentStatusResponse

func (*DebugDocumentResponse) GetUploadedPermissions ¶ 

func (d *DebugDocumentResponse) GetUploadedPermissions() *DocumentPermissionsDefinition

type DebugDocumentsRequest ¶ 

type DebugDocumentsRequest struct {
	// Documents to fetch debug information for
	DebugDocuments []DebugDocumentRequest `json:"debugDocuments"`
}

DebugDocumentsRequest - Describes the request body of the /debug/{datasource}/documents API call.

func (*DebugDocumentsRequest) GetDebugDocuments ¶ 

func (d *DebugDocumentsRequest) GetDebugDocuments() []DebugDocumentRequest

type DebugDocumentsResponse ¶ 

type DebugDocumentsResponse struct {
	// List of document ids/urls and their debug information
	DocumentStatuses []DebugDocumentsResponseItem `json:"documentStatuses,omitempty"`
}

DebugDocumentsResponse - Describes the response body of a single document in the /debug/{datasource}/documents API call

func (*DebugDocumentsResponse) GetDocumentStatuses ¶ 

func (d *DebugDocumentsResponse) GetDocumentStatuses() []DebugDocumentsResponseItem

type DebugDocumentsResponseItem ¶ 

type DebugDocumentsResponseItem struct {
	// Id of the document
	DocID *string `json:"docId,omitempty"`
	// objectType of the document
	ObjectType *string `json:"objectType,omitempty"`
	// Describes the response body of the /debug/{datasource}/document API call
	DebugInfo *DebugDocumentResponse `json:"debugInfo,omitempty"`
}

DebugDocumentsResponseItem - Describes the response body of a single document in the /debug/{datasource}/documents API call

func (*DebugDocumentsResponseItem) GetDebugInfo ¶ 

func (d *DebugDocumentsResponseItem) GetDebugInfo() *DebugDocumentResponse

func (*DebugDocumentsResponseItem) GetDocID ¶ 

func (d *DebugDocumentsResponseItem) GetDocID() *string

func (*DebugDocumentsResponseItem) GetObjectType ¶ 

func (d *DebugDocumentsResponseItem) GetObjectType() *string

type DebugUserRequest ¶ 

type DebugUserRequest struct {
	// Email ID of the user to get the status for
	Email string `json:"email"`
}

DebugUserRequest - Describes the request body of the /debug/{datasource}/user API call

func (*DebugUserRequest) GetEmail ¶ 

func (d *DebugUserRequest) GetEmail() string

type DebugUserResponse ¶ 

type DebugUserResponse struct {
	// Describes the user status response body
	Status *UserStatusResponse `json:"status,omitempty"`
	// List of groups the user is a member of, as uploaded via permissions API.
	UploadedGroups []DatasourceGroupDefinition `json:"uploadedGroups,omitempty"`
}

DebugUserResponse - Describes the response body of the /debug/{datasource}/user API call

func (*DebugUserResponse) GetStatus ¶ 

func (d *DebugUserResponse) GetStatus() *UserStatusResponse

func (*DebugUserResponse) GetUploadedGroups ¶ 

func (d *DebugUserResponse) GetUploadedGroups() []DatasourceGroupDefinition

type DeleteAnnouncementRequest ¶ 

type DeleteAnnouncementRequest struct {
	// The opaque id of the announcement to be deleted.
	ID int64 `json:"id"`
}

func (*DeleteAnnouncementRequest) GetID ¶ 

func (d *DeleteAnnouncementRequest) GetID() int64

type DeleteAnswerRequest ¶ 

type DeleteAnswerRequest struct {
	// The opaque ID of the Answer.
	ID int64 `json:"id"`
	// Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
	DocID *string `json:"docId,omitempty"`
}

func (*DeleteAnswerRequest) GetDocID ¶ 

func (d *DeleteAnswerRequest) GetDocID() *string

func (*DeleteAnswerRequest) GetID ¶ 

func (d *DeleteAnswerRequest) GetID() int64

type DeleteChatFilesRequest ¶ 

type DeleteChatFilesRequest struct {
	// IDs of files to delete.
	FileIds []string `json:"fileIds"`
}

func (*DeleteChatFilesRequest) GetFileIds ¶ 

func (d *DeleteChatFilesRequest) GetFileIds() []string

type DeleteChatsRequest ¶ 

type DeleteChatsRequest struct {
	// A non-empty list of ids of the Chats to be deleted.
	Ids []string `json:"ids"`
}

func (*DeleteChatsRequest) GetIds ¶ 

func (d *DeleteChatsRequest) GetIds() []string

type DeleteCollectionItemRequest ¶ 

type DeleteCollectionItemRequest struct {
	// The ID of the Collection to remove an item in.
	CollectionID float64 `json:"collectionId"`
	// The item ID of the CollectionItem to remove from this Collection.
	ItemID string `json:"itemId"`
	// The (optional) Glean Document ID of the CollectionItem to remove from this Collection if this is an indexed document.
	DocumentID *string `json:"documentId,omitempty"`
}

func (*DeleteCollectionItemRequest) GetCollectionID ¶ 

func (d *DeleteCollectionItemRequest) GetCollectionID() float64

func (*DeleteCollectionItemRequest) GetDocumentID ¶ 

func (d *DeleteCollectionItemRequest) GetDocumentID() *string

func (*DeleteCollectionItemRequest) GetItemID ¶ 

func (d *DeleteCollectionItemRequest) GetItemID() string

type DeleteCollectionItemResponse ¶ 

type DeleteCollectionItemResponse struct {
	Collection *Collection `json:"collection,omitempty"`
}

func (*DeleteCollectionItemResponse) GetCollection ¶ 

func (d *DeleteCollectionItemResponse) GetCollection() *Collection

type DeleteCollectionRequest ¶ 

type DeleteCollectionRequest struct {
	// The IDs of the Collections to delete.
	Ids []int64 `json:"ids"`
	// The datasource allowed in the Collection to be deleted.
	AllowedDatasource *string `json:"allowedDatasource,omitempty"`
}

func (*DeleteCollectionRequest) GetAllowedDatasource ¶ 

func (d *DeleteCollectionRequest) GetAllowedDatasource() *string

func (*DeleteCollectionRequest) GetIds ¶ 

func (d *DeleteCollectionRequest) GetIds() []int64

type DeleteDocumentRequest ¶ 

type DeleteDocumentRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// datasource of the document
	Datasource string `json:"datasource"`
	// object type of the document
	ObjectType string `json:"objectType"`
	// The id of the document
	ID string `json:"id"`
}

DeleteDocumentRequest - Describes the request body of the /deletedocument API call

func (*DeleteDocumentRequest) GetDatasource ¶ 

func (d *DeleteDocumentRequest) GetDatasource() string

func (*DeleteDocumentRequest) GetID ¶ 

func (d *DeleteDocumentRequest) GetID() string

func (*DeleteDocumentRequest) GetObjectType ¶ 

func (d *DeleteDocumentRequest) GetObjectType() string

func (*DeleteDocumentRequest) GetVersion ¶ 

func (d *DeleteDocumentRequest) GetVersion() *int64

type DeleteEmployeeRequest ¶ 

type DeleteEmployeeRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The deleted employee's email
	EmployeeEmail string `json:"employeeEmail"`
}

DeleteEmployeeRequest - Describes the request body of the /deleteemployee API call

func (*DeleteEmployeeRequest) GetEmployeeEmail ¶ 

func (d *DeleteEmployeeRequest) GetEmployeeEmail() string

func (*DeleteEmployeeRequest) GetVersion ¶ 

func (d *DeleteEmployeeRequest) GetVersion() *int64

type DeleteGroupRequest ¶ 

type DeleteGroupRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The datasource for which the group is removed
	Datasource string `json:"datasource"`
	// the name of the group to be deleted
	GroupName string `json:"groupName"`
}

DeleteGroupRequest - Describes the request body of the /deletegroup API call

func (*DeleteGroupRequest) GetDatasource ¶ 

func (d *DeleteGroupRequest) GetDatasource() string

func (*DeleteGroupRequest) GetGroupName ¶ 

func (d *DeleteGroupRequest) GetGroupName() string

func (*DeleteGroupRequest) GetVersion ¶ 

func (d *DeleteGroupRequest) GetVersion() *int64

type DeleteMembershipRequest ¶ 

type DeleteMembershipRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The datasource for which the membership is removed
	Datasource string `json:"datasource"`
	// describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified.
	Membership DatasourceMembershipDefinition `json:"membership"`
}

DeleteMembershipRequest - Describes the request body of the /deletemembership API call

func (*DeleteMembershipRequest) GetDatasource ¶ 

func (d *DeleteMembershipRequest) GetDatasource() string

func (*DeleteMembershipRequest) GetMembership ¶ 

func (d *DeleteMembershipRequest) GetMembership() DatasourceMembershipDefinition

func (*DeleteMembershipRequest) GetVersion ¶ 

func (d *DeleteMembershipRequest) GetVersion() *int64

type DeleteShortcutRequest ¶ 

type DeleteShortcutRequest struct {
	// The opaque id of the user generated content.
	ID int64 `json:"id"`
}

func (*DeleteShortcutRequest) GetID ¶ 

func (d *DeleteShortcutRequest) GetID() int64

type DeleteTeamRequest ¶ 

type DeleteTeamRequest struct {
	// The deleted team's id
	ID string `json:"id"`
}

DeleteTeamRequest - Describes the request body of the /deleteteam API call

func (*DeleteTeamRequest) GetID ¶ 

func (d *DeleteTeamRequest) GetID() string

type DeleteUserRequest ¶ 

type DeleteUserRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The datasource for which the user is removed
	Datasource string `json:"datasource"`
	// The email of the user to be deleted
	Email string `json:"email"`
}

DeleteUserRequest - Describes the request body of the /deleteuser API call

func (*DeleteUserRequest) GetDatasource ¶ 

func (d *DeleteUserRequest) GetDatasource() string

func (*DeleteUserRequest) GetEmail ¶ 

func (d *DeleteUserRequest) GetEmail() string

func (*DeleteUserRequest) GetVersion ¶ 

func (d *DeleteUserRequest) GetVersion() *int64

type Digest ¶ added in v0.9.0 

type Digest struct {
	// Identifier for the podcast file generated from this digest content.
	PodcastFileID *string `json:"podcastFileId,omitempty"`
	// Duration of the podcast file in seconds.
	PodcastDuration *float32 `json:"podcastDuration,omitempty"`
	// The date this digest covers, in YYYY-MM-DD format. Represents the specific day for which the digest content and updates were compiled. This can be empty if the digest is not yet available.
	DigestDate *string `json:"digestDate,omitempty"`
	// Array of digest sections from which the podcast was created.
	Sections []DigestSection `json:"sections,omitempty"`
}

func (*Digest) GetDigestDate ¶ added in v0.9.0 

func (d *Digest) GetDigestDate() *string

func (*Digest) GetPodcastDuration ¶ added in v0.9.0 

func (d *Digest) GetPodcastDuration() *float32

func (*Digest) GetPodcastFileID ¶ added in v0.9.0 

func (d *Digest) GetPodcastFileID() *string

func (*Digest) GetSections ¶ added in v0.9.0 

func (d *Digest) GetSections() []DigestSection

type DigestSection ¶ added in v0.9.0 

type DigestSection struct {
	// Unique identifier for the digest section.
	ID string `json:"id"`
	// Type of the section. This defines how the section should be interpreted and rendered in the digest.
	Type SectionType `json:"type"`
	// Human-readable name for the digest section.
	DisplayName *string `json:"displayName,omitempty"`
	// Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend.
	ChannelName *string `json:"channelName,omitempty"`
	// Channel visibility/type for CHANNEL sections. For Slack this is typically one of
	// PublicChannel, PrivateChannel. Omit if not applicable or unknown.
	//
	ChannelType *string `json:"channelType,omitempty"`
	// Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend.
	InstanceID *string `json:"instanceId,omitempty"`
	// Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section.
	URL *string `json:"url,omitempty"`
	// List of updates within this digest section.
	Updates []DigestUpdate `json:"updates"`
}

func (*DigestSection) GetChannelName ¶ added in v0.9.0 

func (d *DigestSection) GetChannelName() *string

func (*DigestSection) GetChannelType ¶ added in v0.9.3 

func (d *DigestSection) GetChannelType() *string

func (*DigestSection) GetDisplayName ¶ added in v0.9.0 

func (d *DigestSection) GetDisplayName() *string

func (*DigestSection) GetID ¶ added in v0.9.0 

func (d *DigestSection) GetID() string

func (*DigestSection) GetInstanceID ¶ added in v0.9.0 

func (d *DigestSection) GetInstanceID() *string

func (*DigestSection) GetType ¶ added in v0.9.0 

func (d *DigestSection) GetType() SectionType

func (*DigestSection) GetURL ¶ added in v0.9.0 

func (d *DigestSection) GetURL() *string

func (*DigestSection) GetUpdates ¶ added in v0.9.0 

func (d *DigestSection) GetUpdates() []DigestUpdate

type DigestUpdate ¶ added in v0.9.0 

type DigestUpdate struct {
	// URL link to the content or document.
	URL *string `json:"url,omitempty"`
	// Title or headline of the update.
	Title *string `json:"title,omitempty"`
	// Name or identifier of the data source (e.g., slack, confluence, etc.).
	Datasource *string `json:"datasource,omitempty"`
	// Brief summary or description of the update content.
	Summary *string `json:"summary,omitempty"`
	// Optional type classification for the update.
	Type *UpdateType `json:"type,omitempty"`
}

func (*DigestUpdate) GetDatasource ¶ added in v0.9.0 

func (d *DigestUpdate) GetDatasource() *string

func (*DigestUpdate) GetSummary ¶ added in v0.9.0 

func (d *DigestUpdate) GetSummary() *string

func (*DigestUpdate) GetTitle ¶ added in v0.9.0 

func (d *DigestUpdate) GetTitle() *string

func (*DigestUpdate) GetType ¶ added in v0.9.0 

func (d *DigestUpdate) GetType() *UpdateType

func (*DigestUpdate) GetURL ¶ added in v0.9.0 

func (d *DigestUpdate) GetURL() *string

type Direction ¶ 

type Direction string

Direction - The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. 

const (
	DirectionOlder Direction = "OLDER"
	DirectionNewer Direction = "NEWER"
)

func (Direction) ToPointer ¶ 

func (e Direction) ToPointer() *Direction

func (*Direction) UnmarshalJSON ¶ 

func (e *Direction) UnmarshalJSON(data []byte) error

type Disambiguation ¶ 

type Disambiguation struct {
	// Name of the ambiguous entity
	Name *string `json:"name,omitempty"`
	// The unique id of the entity in the knowledge graph
	ID *string `json:"id,omitempty"`
	// The type of entity.
	Type *EntityType `json:"type,omitempty"`
}

Disambiguation - A disambiguation between multiple entities with the same name

func (*Disambiguation) GetID ¶ 

func (d *Disambiguation) GetID() *string

func (*Disambiguation) GetName ¶ 

func (d *Disambiguation) GetName() *string

func (*Disambiguation) GetType ¶ 

func (d *Disambiguation) GetType() *EntityType

func (Disambiguation) MarshalJSON ¶ added in v0.9.0 

func (d Disambiguation) MarshalJSON() ([]byte, error)

func (*Disambiguation) UnmarshalJSON ¶ added in v0.9.0 

func (d *Disambiguation) UnmarshalJSON(data []byte) error

type DisplayableListItemUIConfig ¶ 

type DisplayableListItemUIConfig struct {
	// show a "New" pill next to the item
	ShowNewIndicator *bool `json:"showNewIndicator,omitempty"`
}

DisplayableListItemUIConfig - UI configurations for each item of the list

func (*DisplayableListItemUIConfig) GetShowNewIndicator ¶ 

func (d *DisplayableListItemUIConfig) GetShowNewIndicator() *bool

type DlpConfig ¶ 

type DlpConfig struct {
	// Synonymous with report/policy id.
	Version *int64 `json:"version,omitempty"`
	// DEPRECATED - use `sensitiveContentOptions` instead.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	SensitiveInfoTypes []SensitiveInfoType `json:"sensitiveInfoTypes,omitempty"`
	// Controls which data-sources and what time-range to include in scans.
	InputOptions *InputOptions `json:"inputOptions,omitempty"`
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	ExternalSharingOptions *ExternalSharingOptions `json:"externalSharingOptions,omitempty"`
	// Controls how "shared" a document must be to get picked for scans.
	BroadSharingOptions *SharingOptions `json:"broadSharingOptions,omitempty"`
	// Options for defining sensitive content within scanned documents.
	SensitiveContentOptions *SensitiveContentOptions `json:"sensitiveContentOptions,omitempty"`
	ReportName              *string                  `json:"reportName,omitempty"`
	// Interval between scans.
	Frequency *string `json:"frequency,omitempty"`
	// Details about the person who created this report/policy.
	CreatedBy *DlpPerson `json:"createdBy,omitempty"`
	// Timestamp at which this configuration was created.
	CreatedAt *string `json:"createdAt,omitempty"`
	// redact quote in findings of the report
	RedactQuote *bool `json:"redactQuote,omitempty"`
	// auto hide documents with findings in the report
	AutoHideDocs *bool `json:"autoHideDocs,omitempty"`
	// Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation.
	AllowlistOptions *AllowlistOptions `json:"allowlistOptions,omitempty"`
}

DlpConfig - Detailed configuration of what documents and sensitive content will be scanned.

func (*DlpConfig) GetAllowlistOptions ¶ 

func (d *DlpConfig) GetAllowlistOptions() *AllowlistOptions

func (*DlpConfig) GetAutoHideDocs ¶ 

func (d *DlpConfig) GetAutoHideDocs() *bool

func (*DlpConfig) GetBroadSharingOptions ¶ 

func (d *DlpConfig) GetBroadSharingOptions() *SharingOptions

func (*DlpConfig) GetCreatedAt ¶ 

func (d *DlpConfig) GetCreatedAt() *string

func (*DlpConfig) GetCreatedBy ¶ 

func (d *DlpConfig) GetCreatedBy() *DlpPerson

func (*DlpConfig) GetExternalSharingOptions ¶ 

func (d *DlpConfig) GetExternalSharingOptions() *ExternalSharingOptions

func (*DlpConfig) GetFrequency ¶ 

func (d *DlpConfig) GetFrequency() *string

func (*DlpConfig) GetInputOptions ¶ 

func (d *DlpConfig) GetInputOptions() *InputOptions

func (*DlpConfig) GetRedactQuote ¶ 

func (d *DlpConfig) GetRedactQuote() *bool

func (*DlpConfig) GetReportName ¶ 

func (d *DlpConfig) GetReportName() *string

func (*DlpConfig) GetSensitiveContentOptions ¶ 

func (d *DlpConfig) GetSensitiveContentOptions() *SensitiveContentOptions

func (*DlpConfig) GetSensitiveInfoTypes ¶ 

func (d *DlpConfig) GetSensitiveInfoTypes() []SensitiveInfoType

func (*DlpConfig) GetVersion ¶ 

func (d *DlpConfig) GetVersion() *int64

type DlpFrequency ¶ 

type DlpFrequency string

DlpFrequency - Interval between scans. DAILY is deprecated. 

const (
	DlpFrequencyOnce       DlpFrequency = "ONCE"
	DlpFrequencyDaily      DlpFrequency = "DAILY"
	DlpFrequencyWeekly     DlpFrequency = "WEEKLY"
	DlpFrequencyContinuous DlpFrequency = "CONTINUOUS"
	DlpFrequencyNone       DlpFrequency = "NONE"
)

func (DlpFrequency) ToPointer ¶ 

func (e DlpFrequency) ToPointer() *DlpFrequency

func (*DlpFrequency) UnmarshalJSON ¶ 

func (e *DlpFrequency) UnmarshalJSON(data []byte) error

type DlpPerson ¶ 

type DlpPerson struct {
	// The display name.
	Name string `json:"name"`
	// An opaque identifier that can be used to request metadata for a Person.
	ObfuscatedID string             `json:"obfuscatedId"`
	Metadata     *DlpPersonMetadata `json:"metadata,omitempty"`
}

DlpPerson - Details about the person who created this report/policy.

func (*DlpPerson) GetMetadata ¶ 

func (d *DlpPerson) GetMetadata() *DlpPersonMetadata

func (*DlpPerson) GetName ¶ 

func (d *DlpPerson) GetName() string

func (*DlpPerson) GetObfuscatedID ¶ 

func (d *DlpPerson) GetObfuscatedID() string

type DlpPersonMetadata ¶ 

type DlpPersonMetadata struct {
	// The first name of the person
	FirstName *string `json:"firstName,omitempty"`
	// The user's primary email address
	Email *string `json:"email,omitempty"`
}

func (*DlpPersonMetadata) GetEmail ¶ 

func (d *DlpPersonMetadata) GetEmail() *string

func (*DlpPersonMetadata) GetFirstName ¶ 

func (d *DlpPersonMetadata) GetFirstName() *string

type DlpReport ¶ 

type DlpReport struct {
	ID   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	// Detailed configuration of what documents and sensitive content will be scanned.
	Config *DlpConfig `json:"config,omitempty"`
	// Interval between scans. DAILY is deprecated.
	Frequency *DlpFrequency `json:"frequency,omitempty"`
	// The status of the policy/report. Only ACTIVE status will be picked for scans.
	Status *DlpReportStatus `json:"status,omitempty"`
	// Details about the person who created this report/policy.
	CreatedBy *DlpPerson `json:"createdBy,omitempty"`
	// Timestamp at which the policy was created.
	CreatedAt *string `json:"createdAt,omitempty"`
	// Timestamp at which the policy was last updated.
	LastUpdatedAt *string `json:"lastUpdatedAt,omitempty"`
	// Auto hide documents with findings in the policy.
	AutoHideDocs   *bool           `json:"autoHideDocs,omitempty"`
	LastScanStatus *LastScanStatus `json:"lastScanStatus,omitempty"`
	// The timestamp at which the report's last run/scan began.
	LastScanStartTime *string `json:"lastScanStartTime,omitempty"`
	// Details about the person who created this report/policy.
	UpdatedBy *DlpPerson `json:"updatedBy,omitempty"`
}

DlpReport - Full policy information that will be used for scans.

func (*DlpReport) GetAutoHideDocs ¶ 

func (d *DlpReport) GetAutoHideDocs() *bool

func (*DlpReport) GetConfig ¶ 

func (d *DlpReport) GetConfig() *DlpConfig

func (*DlpReport) GetCreatedAt ¶ 

func (d *DlpReport) GetCreatedAt() *string

func (*DlpReport) GetCreatedBy ¶ 

func (d *DlpReport) GetCreatedBy() *DlpPerson

func (*DlpReport) GetFrequency ¶ 

func (d *DlpReport) GetFrequency() *DlpFrequency

func (*DlpReport) GetID ¶ 

func (d *DlpReport) GetID() *string

func (*DlpReport) GetLastScanStartTime ¶ 

func (d *DlpReport) GetLastScanStartTime() *string

func (*DlpReport) GetLastScanStatus ¶ 

func (d *DlpReport) GetLastScanStatus() *LastScanStatus

func (*DlpReport) GetLastUpdatedAt ¶ 

func (d *DlpReport) GetLastUpdatedAt() *string

func (*DlpReport) GetName ¶ 

func (d *DlpReport) GetName() *string

func (*DlpReport) GetStatus ¶ 

func (d *DlpReport) GetStatus() *DlpReportStatus

func (*DlpReport) GetUpdatedBy ¶ 

func (d *DlpReport) GetUpdatedBy() *DlpPerson

type DlpReportStatus ¶ 

type DlpReportStatus string

DlpReportStatus - The status of the policy/report. Only ACTIVE status will be picked for scans. 

const (
	DlpReportStatusActive    DlpReportStatus = "ACTIVE"
	DlpReportStatusInactive  DlpReportStatus = "INACTIVE"
	DlpReportStatusCancelled DlpReportStatus = "CANCELLED"
	DlpReportStatusNone      DlpReportStatus = "NONE"
)

func (DlpReportStatus) ToPointer ¶ 

func (e DlpReportStatus) ToPointer() *DlpReportStatus

func (*DlpReportStatus) UnmarshalJSON ¶ 

func (e *DlpReportStatus) UnmarshalJSON(data []byte) error

type DlpSimpleResult ¶ 

type DlpSimpleResult string
const (
	DlpSimpleResultSuccess DlpSimpleResult = "SUCCESS"
	DlpSimpleResultFailure DlpSimpleResult = "FAILURE"
)

func (DlpSimpleResult) ToPointer ¶ 

func (e DlpSimpleResult) ToPointer() *DlpSimpleResult

func (*DlpSimpleResult) UnmarshalJSON ¶ 

func (e *DlpSimpleResult) UnmarshalJSON(data []byte) error

type DocCategory ¶ 

type DocCategory string

DocCategory - The document category of this object type. 

const (
	DocCategoryUncategorized        DocCategory = "UNCATEGORIZED"
	DocCategoryTickets              DocCategory = "TICKETS"
	DocCategoryCrm                  DocCategory = "CRM"
	DocCategoryPublishedContent     DocCategory = "PUBLISHED_CONTENT"
	DocCategoryCollaborativeContent DocCategory = "COLLABORATIVE_CONTENT"
	DocCategoryQuestionAnswer       DocCategory = "QUESTION_ANSWER"
	DocCategoryMessaging            DocCategory = "MESSAGING"
	DocCategoryCodeRepository       DocCategory = "CODE_REPOSITORY"
	DocCategoryChangeManagement     DocCategory = "CHANGE_MANAGEMENT"
	DocCategoryPeople               DocCategory = "PEOPLE"
	DocCategoryEmail                DocCategory = "EMAIL"
	DocCategorySso                  DocCategory = "SSO"
	DocCategoryAts                  DocCategory = "ATS"
	DocCategoryKnowledgeHub         DocCategory = "KNOWLEDGE_HUB"
	DocCategoryExternalShortcut     DocCategory = "EXTERNAL_SHORTCUT"
	DocCategoryEntity               DocCategory = "ENTITY"
	DocCategoryCalendar             DocCategory = "CALENDAR"
	DocCategoryAgents               DocCategory = "AGENTS"
)

func (DocCategory) ToPointer ¶ 

func (e DocCategory) ToPointer() *DocCategory

func (*DocCategory) UnmarshalJSON ¶ 

func (e *DocCategory) UnmarshalJSON(data []byte) error

type Document ¶ 

type Document struct {
	// The Glean Document ID.
	ID *string `json:"id,omitempty"`
	// The app or other repository type from which the document was extracted
	Datasource *string `json:"datasource,omitempty"`
	// The source from which document content was pulled, e.g. an API crawl or browser history
	ConnectorType *ConnectorType `json:"connectorType,omitempty"`
	// The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
	DocType           *string          `json:"docType,omitempty"`
	Content           *DocumentContent `json:"content,omitempty"`
	ContainerDocument *Document        `json:"containerDocument,omitempty"`
	ParentDocument    *Document        `json:"parentDocument,omitempty"`
	// The title of the document.
	Title *string `json:"title,omitempty"`
	// A permalink for the document.
	URL      *string           `json:"url,omitempty"`
	Metadata *DocumentMetadata `json:"metadata,omitempty"`
	// A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
	Sections []DocumentSection `json:"sections,omitempty"`
}

func (*Document) GetConnectorType ¶ 

func (d *Document) GetConnectorType() *ConnectorType

func (*Document) GetContainerDocument ¶ 

func (d *Document) GetContainerDocument() *Document

func (*Document) GetContent ¶ 

func (d *Document) GetContent() *DocumentContent

func (*Document) GetDatasource ¶ 

func (d *Document) GetDatasource() *string

func (*Document) GetDocType ¶ 

func (d *Document) GetDocType() *string

func (*Document) GetID ¶ 

func (d *Document) GetID() *string

func (*Document) GetMetadata ¶ 

func (d *Document) GetMetadata() *DocumentMetadata

func (*Document) GetParentDocument ¶ 

func (d *Document) GetParentDocument() *Document

func (*Document) GetSections ¶ 

func (d *Document) GetSections() []DocumentSection

func (*Document) GetTitle ¶ 

func (d *Document) GetTitle() *string

func (*Document) GetURL ¶ 

func (d *Document) GetURL() *string

func (Document) MarshalJSON ¶ added in v0.9.0 

func (d Document) MarshalJSON() ([]byte, error)

func (*Document) UnmarshalJSON ¶ added in v0.9.0 

func (d *Document) UnmarshalJSON(data []byte) error

type DocumentContent ¶ 

type DocumentContent struct {
	// The plaintext content of the document.
	FullTextList []string `json:"fullTextList,omitempty"`
}

func (*DocumentContent) GetFullTextList ¶ 

func (d *DocumentContent) GetFullTextList() []string

func (DocumentContent) MarshalJSON ¶ added in v0.9.0 

func (d DocumentContent) MarshalJSON() ([]byte, error)

func (*DocumentContent) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentContent) UnmarshalJSON(data []byte) error

type DocumentDefinition ¶ 

type DocumentDefinition struct {
	// Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content.
	Title *string `json:"title,omitempty"`
	// Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file.
	Filename *string `json:"filename,omitempty"`
	// The container name for the content (Folder for example for file content).
	Container *string `json:"container,omitempty"`
	// This represents the datasource sepcific id of the container.
	ContainerDatasourceID *string `json:"containerDatasourceId,omitempty"`
	// This represents the object type of the container. It cannot have spaces or _
	ContainerObjectType *string `json:"containerObjectType,omitempty"`
	Datasource          string  `json:"datasource"`
	// The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _
	ObjectType *string `json:"objectType,omitempty"`
	// The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**'
	//
	ViewURL *string `json:"viewURL,omitempty"`
	// The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length.
	ID *string `json:"id,omitempty"`
	// Describes text content or base64 encoded binary content
	Summary *ContentDefinition `json:"summary,omitempty"`
	// Describes text content or base64 encoded binary content
	Body *ContentDefinition `json:"body,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	Author *UserReferenceDefinition `json:"author,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	Owner *UserReferenceDefinition `json:"owner,omitempty"`
	// describes the access control details of the document
	Permissions *DocumentPermissionsDefinition `json:"permissions,omitempty"`
	// The creation time, in epoch seconds.
	CreatedAt *int64 `json:"createdAt,omitempty"`
	// The last update time, in epoch seconds.
	UpdatedAt *int64 `json:"updatedAt,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	UpdatedBy *UserReferenceDefinition `json:"updatedBy,omitempty"`
	// Labels associated with the document.
	Tags []string `json:"tags,omitempty"`
	// describes the interactions on the document
	Interactions *DocumentInteractionsDefinition `json:"interactions,omitempty"`
	Status       *string                         `json:"status,omitempty"`
	// Additional variations of the URL that this document points to.
	AdditionalUrls []string `json:"additionalUrls,omitempty"`
	// Comments associated with the document.
	Comments []CommentDefinition `json:"comments,omitempty"`
	// Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets).
	CustomProperties []CustomProperty `json:"customProperties,omitempty"`
}

DocumentDefinition - Indexable document structure

func (*DocumentDefinition) GetAdditionalUrls ¶ 

func (d *DocumentDefinition) GetAdditionalUrls() []string

func (*DocumentDefinition) GetAuthor ¶ 

func (d *DocumentDefinition) GetAuthor() *UserReferenceDefinition

func (*DocumentDefinition) GetBody ¶ 

func (d *DocumentDefinition) GetBody() *ContentDefinition

func (*DocumentDefinition) GetComments ¶ 

func (d *DocumentDefinition) GetComments() []CommentDefinition

func (*DocumentDefinition) GetContainer ¶ 

func (d *DocumentDefinition) GetContainer() *string

func (*DocumentDefinition) GetContainerDatasourceID ¶ 

func (d *DocumentDefinition) GetContainerDatasourceID() *string

func (*DocumentDefinition) GetContainerObjectType ¶ 

func (d *DocumentDefinition) GetContainerObjectType() *string

func (*DocumentDefinition) GetCreatedAt ¶ 

func (d *DocumentDefinition) GetCreatedAt() *int64

func (*DocumentDefinition) GetCustomProperties ¶ 

func (d *DocumentDefinition) GetCustomProperties() []CustomProperty

func (*DocumentDefinition) GetDatasource ¶ 

func (d *DocumentDefinition) GetDatasource() string

func (*DocumentDefinition) GetFilename ¶ 

func (d *DocumentDefinition) GetFilename() *string

func (*DocumentDefinition) GetID ¶ 

func (d *DocumentDefinition) GetID() *string

func (*DocumentDefinition) GetInteractions ¶ 

func (d *DocumentDefinition) GetInteractions() *DocumentInteractionsDefinition

func (*DocumentDefinition) GetObjectType ¶ 

func (d *DocumentDefinition) GetObjectType() *string

func (*DocumentDefinition) GetOwner ¶ 

func (d *DocumentDefinition) GetOwner() *UserReferenceDefinition

func (*DocumentDefinition) GetPermissions ¶ 

func (d *DocumentDefinition) GetPermissions() *DocumentPermissionsDefinition

func (*DocumentDefinition) GetStatus ¶ 

func (d *DocumentDefinition) GetStatus() *string

func (*DocumentDefinition) GetSummary ¶ 

func (d *DocumentDefinition) GetSummary() *ContentDefinition

func (*DocumentDefinition) GetTags ¶ 

func (d *DocumentDefinition) GetTags() []string

func (*DocumentDefinition) GetTitle ¶ 

func (d *DocumentDefinition) GetTitle() *string

func (*DocumentDefinition) GetUpdatedAt ¶ 

func (d *DocumentDefinition) GetUpdatedAt() *int64

func (*DocumentDefinition) GetUpdatedBy ¶ 

func (d *DocumentDefinition) GetUpdatedBy() *UserReferenceDefinition

func (*DocumentDefinition) GetViewURL ¶ 

func (d *DocumentDefinition) GetViewURL() *string

type DocumentInsight ¶ 

type DocumentInsight struct {
	Document     Document   `json:"document"`
	ViewCount    *CountInfo `json:"viewCount,omitempty"`
	VisitorCount *CountInfo `json:"visitorCount,omitempty"`
}

func (*DocumentInsight) GetDocument ¶ 

func (d *DocumentInsight) GetDocument() Document

func (*DocumentInsight) GetViewCount ¶ 

func (d *DocumentInsight) GetViewCount() *CountInfo

func (*DocumentInsight) GetVisitorCount ¶ 

func (d *DocumentInsight) GetVisitorCount() *CountInfo

type DocumentInteractions ¶ 

type DocumentInteractions struct {
	// The count of comments (thread replies in the case of slack).
	NumComments *int64 `json:"numComments,omitempty"`
	// The count of reactions on the document.
	NumReactions *int64 `json:"numReactions,omitempty"`
	// To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Reactions []string   `json:"reactions,omitempty"`
	Reacts    []Reaction `json:"reacts,omitempty"`
	// Describes instances of someone posting a link to this document in one of our indexed datasources.
	Shares       []Share    `json:"shares,omitempty"`
	VisitorCount *CountInfo `json:"visitorCount,omitempty"`
}

func (*DocumentInteractions) GetNumComments ¶ 

func (d *DocumentInteractions) GetNumComments() *int64

func (*DocumentInteractions) GetNumReactions ¶ 

func (d *DocumentInteractions) GetNumReactions() *int64

func (*DocumentInteractions) GetReactions ¶ 

func (d *DocumentInteractions) GetReactions() []string

func (*DocumentInteractions) GetReacts ¶ 

func (d *DocumentInteractions) GetReacts() []Reaction

func (*DocumentInteractions) GetShares ¶ 

func (d *DocumentInteractions) GetShares() []Share

func (*DocumentInteractions) GetVisitorCount ¶ 

func (d *DocumentInteractions) GetVisitorCount() *CountInfo

func (DocumentInteractions) MarshalJSON ¶ added in v0.9.0 

func (d DocumentInteractions) MarshalJSON() ([]byte, error)

func (*DocumentInteractions) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentInteractions) UnmarshalJSON(data []byte) error

type DocumentInteractionsDefinition ¶ 

type DocumentInteractionsDefinition struct {
	NumViews    *int64 `json:"numViews,omitempty"`
	NumLikes    *int64 `json:"numLikes,omitempty"`
	NumComments *int64 `json:"numComments,omitempty"`
}

DocumentInteractionsDefinition - describes the interactions on the document

func (*DocumentInteractionsDefinition) GetNumComments ¶ 

func (d *DocumentInteractionsDefinition) GetNumComments() *int64

func (*DocumentInteractionsDefinition) GetNumLikes ¶ 

func (d *DocumentInteractionsDefinition) GetNumLikes() *int64

func (*DocumentInteractionsDefinition) GetNumViews ¶ 

func (d *DocumentInteractionsDefinition) GetNumViews() *int64

type DocumentMetadata ¶ 

type DocumentMetadata struct {
	Datasource *string `json:"datasource,omitempty"`
	// The datasource instance from which the document was extracted.
	DatasourceInstance *string `json:"datasourceInstance,omitempty"`
	// The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
	ObjectType *string `json:"objectType,omitempty"`
	// The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId
	Container *string `json:"container,omitempty"`
	// The Glean Document ID of the container. Uniquely identifies the container.
	ContainerID *string `json:"containerId,omitempty"`
	// The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive.
	SuperContainerID *string `json:"superContainerId,omitempty"`
	// The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container
	ParentID *string `json:"parentId,omitempty"`
	MimeType *string `json:"mimeType,omitempty"`
	// The index-wide unique identifier.
	DocumentID *string `json:"documentId,omitempty"`
	// A unique identifier used to represent the document in any logging or feedback requests in place of documentId.
	LoggingID *string `json:"loggingId,omitempty"`
	// Hash of the Glean Document ID.
	DocumentIDHash *string    `json:"documentIdHash,omitempty"`
	CreateTime     *time.Time `json:"createTime,omitempty"`
	UpdateTime     *time.Time `json:"updateTime,omitempty"`
	Author         *Person    `json:"author,omitempty"`
	Owner          *Person    `json:"owner,omitempty"`
	// A list of people mentioned in the document.
	MentionedPeople []Person `json:"mentionedPeople,omitempty"`
	// The level of visibility of the document as understood by our system.
	Visibility *DocumentVisibility `json:"visibility,omitempty"`
	// A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are [components](https://confluence.atlassian.com/jirasoftwarecloud/organizing-work-with-components-764478279.html).)
	Components []string `json:"components,omitempty"`
	// The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix).
	Status *string `json:"status,omitempty"`
	// The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource.
	StatusCategory *string `json:"statusCategory,omitempty"`
	// A list of stars associated with this result.  "Pin" is an older name.
	Pins []PinDocument `json:"pins,omitempty"`
	// The document priority. Interpretation is datasource specific.
	Priority   *string `json:"priority,omitempty"`
	AssignedTo *Person `json:"assignedTo,omitempty"`
	UpdatedBy  *Person `json:"updatedBy,omitempty"`
	// A list of tags for the document. Interpretation is datasource specific.
	Labels []string `json:"labels,omitempty"`
	// A list of collections that the document belongs to.
	Collections []Collection `json:"collections,omitempty"`
	// The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
	DatasourceID *string               `json:"datasourceId,omitempty"`
	Interactions *DocumentInteractions `json:"interactions,omitempty"`
	Verification *Verification         `json:"verification,omitempty"`
	ViewerInfo   *ViewerInfo           `json:"viewerInfo,omitempty"`
	Permissions  *ObjectPermissions    `json:"permissions,omitempty"`
	VisitCount   *CountInfo            `json:"visitCount,omitempty"`
	// A list of shortcuts of which destination URL is for the document.
	Shortcuts []Shortcut `json:"shortcuts,omitempty"`
	// For file datasources like onedrive/github etc this has the path to the file
	Path *string `json:"path,omitempty"`
	// Custom fields specific to individual datasources
	CustomData map[string]CustomDataValue `json:"customData,omitempty"`
	// The document's document_category(.proto).
	DocumentCategory *string      `json:"documentCategory,omitempty"`
	ContactPerson    *Person      `json:"contactPerson,omitempty"`
	Thumbnail        *Thumbnail   `json:"thumbnail,omitempty"`
	IndexStatus      *IndexStatus `json:"indexStatus,omitempty"`
	// A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list.
	Ancestors []Document `json:"ancestors,omitempty"`
}

func (*DocumentMetadata) GetAncestors ¶ 

func (d *DocumentMetadata) GetAncestors() []Document

func (*DocumentMetadata) GetAssignedTo ¶ 

func (d *DocumentMetadata) GetAssignedTo() *Person

func (*DocumentMetadata) GetAuthor ¶ 

func (d *DocumentMetadata) GetAuthor() *Person

func (*DocumentMetadata) GetCollections ¶ 

func (d *DocumentMetadata) GetCollections() []Collection

func (*DocumentMetadata) GetComponents ¶ 

func (d *DocumentMetadata) GetComponents() []string

func (*DocumentMetadata) GetContactPerson ¶ 

func (d *DocumentMetadata) GetContactPerson() *Person

func (*DocumentMetadata) GetContainer ¶ 

func (d *DocumentMetadata) GetContainer() *string

func (*DocumentMetadata) GetContainerID ¶ 

func (d *DocumentMetadata) GetContainerID() *string

func (*DocumentMetadata) GetCreateTime ¶ 

func (d *DocumentMetadata) GetCreateTime() *time.Time

func (*DocumentMetadata) GetCustomData ¶ 

func (d *DocumentMetadata) GetCustomData() map[string]CustomDataValue

func (*DocumentMetadata) GetDatasource ¶ 

func (d *DocumentMetadata) GetDatasource() *string

func (*DocumentMetadata) GetDatasourceID ¶ 

func (d *DocumentMetadata) GetDatasourceID() *string

func (*DocumentMetadata) GetDatasourceInstance ¶ 

func (d *DocumentMetadata) GetDatasourceInstance() *string

func (*DocumentMetadata) GetDocumentCategory ¶ 

func (d *DocumentMetadata) GetDocumentCategory() *string

func (*DocumentMetadata) GetDocumentID ¶ 

func (d *DocumentMetadata) GetDocumentID() *string

func (*DocumentMetadata) GetDocumentIDHash ¶ 

func (d *DocumentMetadata) GetDocumentIDHash() *string

func (*DocumentMetadata) GetIndexStatus ¶ 

func (d *DocumentMetadata) GetIndexStatus() *IndexStatus

func (*DocumentMetadata) GetInteractions ¶ 

func (d *DocumentMetadata) GetInteractions() *DocumentInteractions

func (*DocumentMetadata) GetLabels ¶ 

func (d *DocumentMetadata) GetLabels() []string

func (*DocumentMetadata) GetLoggingID ¶ 

func (d *DocumentMetadata) GetLoggingID() *string

func (*DocumentMetadata) GetMentionedPeople ¶ 

func (d *DocumentMetadata) GetMentionedPeople() []Person

func (*DocumentMetadata) GetMimeType ¶ 

func (d *DocumentMetadata) GetMimeType() *string

func (*DocumentMetadata) GetObjectType ¶ 

func (d *DocumentMetadata) GetObjectType() *string

func (*DocumentMetadata) GetOwner ¶ 

func (d *DocumentMetadata) GetOwner() *Person

func (*DocumentMetadata) GetParentID ¶ 

func (d *DocumentMetadata) GetParentID() *string

func (*DocumentMetadata) GetPath ¶ 

func (d *DocumentMetadata) GetPath() *string

func (*DocumentMetadata) GetPermissions ¶ 

func (d *DocumentMetadata) GetPermissions() *ObjectPermissions

func (*DocumentMetadata) GetPins ¶ 

func (d *DocumentMetadata) GetPins() []PinDocument

func (*DocumentMetadata) GetPriority ¶ 

func (d *DocumentMetadata) GetPriority() *string

func (*DocumentMetadata) GetShortcuts ¶ 

func (d *DocumentMetadata) GetShortcuts() []Shortcut

func (*DocumentMetadata) GetStatus ¶ 

func (d *DocumentMetadata) GetStatus() *string

func (*DocumentMetadata) GetStatusCategory ¶ 

func (d *DocumentMetadata) GetStatusCategory() *string

func (*DocumentMetadata) GetSuperContainerID ¶ 

func (d *DocumentMetadata) GetSuperContainerID() *string

func (*DocumentMetadata) GetThumbnail ¶ 

func (d *DocumentMetadata) GetThumbnail() *Thumbnail

func (*DocumentMetadata) GetUpdateTime ¶ 

func (d *DocumentMetadata) GetUpdateTime() *time.Time

func (*DocumentMetadata) GetUpdatedBy ¶ 

func (d *DocumentMetadata) GetUpdatedBy() *Person

func (*DocumentMetadata) GetVerification ¶ 

func (d *DocumentMetadata) GetVerification() *Verification

func (*DocumentMetadata) GetViewerInfo ¶ 

func (d *DocumentMetadata) GetViewerInfo() *ViewerInfo

func (*DocumentMetadata) GetVisibility ¶ 

func (d *DocumentMetadata) GetVisibility() *DocumentVisibility

func (*DocumentMetadata) GetVisitCount ¶ 

func (d *DocumentMetadata) GetVisitCount() *CountInfo

func (DocumentMetadata) MarshalJSON ¶ 

func (d DocumentMetadata) MarshalJSON() ([]byte, error)

func (*DocumentMetadata) UnmarshalJSON ¶ 

func (d *DocumentMetadata) UnmarshalJSON(data []byte) error

type DocumentOrError ¶ 

type DocumentOrError struct {
	// The text for error, reason.
	Error *string `json:"error,omitempty"`
}

func (*DocumentOrError) GetError ¶ 

func (d *DocumentOrError) GetError() *string

func (DocumentOrError) MarshalJSON ¶ added in v0.9.0 

func (d DocumentOrError) MarshalJSON() ([]byte, error)

func (*DocumentOrError) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentOrError) UnmarshalJSON(data []byte) error

type DocumentOrErrorUnion ¶ 

type DocumentOrErrorUnion struct {
	Document        *Document        `queryParam:"inline,name=DocumentOrError"`
	DocumentOrError *DocumentOrError `queryParam:"inline,name=DocumentOrError"`

	Type DocumentOrErrorUnionType
}

func CreateDocumentOrErrorUnionDocument ¶ 

func CreateDocumentOrErrorUnionDocument(document Document) DocumentOrErrorUnion

func CreateDocumentOrErrorUnionDocumentOrError ¶ 

func CreateDocumentOrErrorUnionDocumentOrError(documentOrError DocumentOrError) DocumentOrErrorUnion

func (DocumentOrErrorUnion) MarshalJSON ¶ 

func (u DocumentOrErrorUnion) MarshalJSON() ([]byte, error)

func (*DocumentOrErrorUnion) UnmarshalJSON ¶ 

func (u *DocumentOrErrorUnion) UnmarshalJSON(data []byte) error

type DocumentOrErrorUnionType ¶ 

type DocumentOrErrorUnionType string
const (
	DocumentOrErrorUnionTypeDocument        DocumentOrErrorUnionType = "Document"
	DocumentOrErrorUnionTypeDocumentOrError DocumentOrErrorUnionType = "DocumentOrError"
)

type DocumentPermissionsDefinition ¶ 

type DocumentPermissionsDefinition struct {
	// List of users who can view the document
	AllowedUsers []UserReferenceDefinition `json:"allowedUsers,omitempty"`
	// List of groups that can view the document
	AllowedGroups []string `json:"allowedGroups,omitempty"`
	// List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ...
	AllowedGroupIntersections []PermissionsGroupIntersectionDefinition `json:"allowedGroupIntersections,omitempty"`
	// If true, then any Glean user can view the document
	AllowAnonymousAccess *bool `json:"allowAnonymousAccess,omitempty"`
	// If true, then any user who has an account in the datasource can view the document.
	AllowAllDatasourceUsersAccess *bool `json:"allowAllDatasourceUsersAccess,omitempty"`
}

DocumentPermissionsDefinition - describes the access control details of the document

func (*DocumentPermissionsDefinition) GetAllowAllDatasourceUsersAccess ¶ 

func (d *DocumentPermissionsDefinition) GetAllowAllDatasourceUsersAccess() *bool

func (*DocumentPermissionsDefinition) GetAllowAnonymousAccess ¶ 

func (d *DocumentPermissionsDefinition) GetAllowAnonymousAccess() *bool

func (*DocumentPermissionsDefinition) GetAllowedGroupIntersections ¶ 

func (d *DocumentPermissionsDefinition) GetAllowedGroupIntersections() []PermissionsGroupIntersectionDefinition

func (*DocumentPermissionsDefinition) GetAllowedGroups ¶ 

func (d *DocumentPermissionsDefinition) GetAllowedGroups() []string

func (*DocumentPermissionsDefinition) GetAllowedUsers ¶ 

func (d *DocumentPermissionsDefinition) GetAllowedUsers() []UserReferenceDefinition

type DocumentSection ¶ 

type DocumentSection struct {
	// The title of the document section (e.g. the section header).
	Title *string `json:"title,omitempty"`
	// The permalink of the document section.
	URL *string `json:"url,omitempty"`
}

func (*DocumentSection) GetTitle ¶ 

func (d *DocumentSection) GetTitle() *string

func (*DocumentSection) GetURL ¶ 

func (d *DocumentSection) GetURL() *string

func (DocumentSection) MarshalJSON ¶ added in v0.9.0 

func (d DocumentSection) MarshalJSON() ([]byte, error)

func (*DocumentSection) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentSection) UnmarshalJSON(data []byte) error

type DocumentSpec1 ¶ 

type DocumentSpec1 struct {
	// The URL of the document.
	URL string `json:"url"`
}

func (*DocumentSpec1) GetURL ¶ 

func (d *DocumentSpec1) GetURL() string

func (DocumentSpec1) MarshalJSON ¶ added in v0.9.0 

func (d DocumentSpec1) MarshalJSON() ([]byte, error)

func (*DocumentSpec1) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentSpec1) UnmarshalJSON(data []byte) error

type DocumentSpec2 ¶ 

type DocumentSpec2 struct {
	// The ID of the document.
	ID string `json:"id"`
}

func (*DocumentSpec2) GetID ¶ 

func (d *DocumentSpec2) GetID() string

func (DocumentSpec2) MarshalJSON ¶ added in v0.9.0 

func (d DocumentSpec2) MarshalJSON() ([]byte, error)

func (*DocumentSpec2) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentSpec2) UnmarshalJSON(data []byte) error

type DocumentSpec3 ¶ 

type DocumentSpec3 struct {
	// The type of the user generated content (UGC datasource).
	UgcType DocumentSpecUgcType1 `json:"ugcType"`
	// The numeric id for user generated content. Used for ANNOUNCEMENTS, ANSWERS, COLLECTIONS, SHORTCUTS.
	ContentID int64 `json:"contentId"`
	// The specific type of the user generated content type.
	DocType *string `json:"docType,omitempty"`
}

func (*DocumentSpec3) GetContentID ¶ 

func (d *DocumentSpec3) GetContentID() int64

func (*DocumentSpec3) GetDocType ¶ 

func (d *DocumentSpec3) GetDocType() *string

func (*DocumentSpec3) GetUgcType ¶ 

func (d *DocumentSpec3) GetUgcType() DocumentSpecUgcType1

func (DocumentSpec3) MarshalJSON ¶ added in v0.9.0 

func (d DocumentSpec3) MarshalJSON() ([]byte, error)

func (*DocumentSpec3) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentSpec3) UnmarshalJSON(data []byte) error

type DocumentSpec4 ¶ added in v0.9.0 

type DocumentSpec4 struct {
	// The type of the user generated content (UGC datasource).
	UgcType DocumentSpecUgcType2 `json:"ugcType"`
	// The string id for user generated content. Used for CHATS.
	UgcID string `json:"ugcId"`
	// The specific type of the user generated content type.
	DocType *string `json:"docType,omitempty"`
}

func (*DocumentSpec4) GetDocType ¶ added in v0.9.0 

func (d *DocumentSpec4) GetDocType() *string

func (*DocumentSpec4) GetUgcID ¶ added in v0.9.0 

func (d *DocumentSpec4) GetUgcID() string

func (*DocumentSpec4) GetUgcType ¶ added in v0.9.0 

func (d *DocumentSpec4) GetUgcType() DocumentSpecUgcType2

func (DocumentSpec4) MarshalJSON ¶ added in v0.9.0 

func (d DocumentSpec4) MarshalJSON() ([]byte, error)

func (*DocumentSpec4) UnmarshalJSON ¶ added in v0.9.0 

func (d *DocumentSpec4) UnmarshalJSON(data []byte) error

type DocumentSpecUgcType1 ¶ added in v0.9.0 

type DocumentSpecUgcType1 string

DocumentSpecUgcType1 - The type of the user generated content (UGC datasource). 

const (
	DocumentSpecUgcType1Announcements DocumentSpecUgcType1 = "ANNOUNCEMENTS"
	DocumentSpecUgcType1Answers       DocumentSpecUgcType1 = "ANSWERS"
	DocumentSpecUgcType1Collections   DocumentSpecUgcType1 = "COLLECTIONS"
	DocumentSpecUgcType1Shortcuts     DocumentSpecUgcType1 = "SHORTCUTS"
	DocumentSpecUgcType1Chats         DocumentSpecUgcType1 = "CHATS"
)

func (DocumentSpecUgcType1) ToPointer ¶ added in v0.9.0 

func (e DocumentSpecUgcType1) ToPointer() *DocumentSpecUgcType1

func (*DocumentSpecUgcType1) UnmarshalJSON ¶ added in v0.9.0 

func (e *DocumentSpecUgcType1) UnmarshalJSON(data []byte) error

type DocumentSpecUgcType2 ¶ added in v0.9.0 

type DocumentSpecUgcType2 string

DocumentSpecUgcType2 - The type of the user generated content (UGC datasource). 

const (
	DocumentSpecUgcType2Announcements DocumentSpecUgcType2 = "ANNOUNCEMENTS"
	DocumentSpecUgcType2Answers       DocumentSpecUgcType2 = "ANSWERS"
	DocumentSpecUgcType2Collections   DocumentSpecUgcType2 = "COLLECTIONS"
	DocumentSpecUgcType2Shortcuts     DocumentSpecUgcType2 = "SHORTCUTS"
	DocumentSpecUgcType2Chats         DocumentSpecUgcType2 = "CHATS"
)

func (DocumentSpecUgcType2) ToPointer ¶ added in v0.9.0 

func (e DocumentSpecUgcType2) ToPointer() *DocumentSpecUgcType2

func (*DocumentSpecUgcType2) UnmarshalJSON ¶ added in v0.9.0 

func (e *DocumentSpecUgcType2) UnmarshalJSON(data []byte) error

type DocumentSpecUnion ¶ 

type DocumentSpecUnion struct {
	DocumentSpec1 *DocumentSpec1 `queryParam:"inline,name=DocumentSpec"`
	DocumentSpec2 *DocumentSpec2 `queryParam:"inline,name=DocumentSpec"`
	DocumentSpec3 *DocumentSpec3 `queryParam:"inline,name=DocumentSpec"`
	DocumentSpec4 *DocumentSpec4 `queryParam:"inline,name=DocumentSpec"`

	Type DocumentSpecUnionType
}

func CreateDocumentSpecUnionDocumentSpec1 ¶ 

func CreateDocumentSpecUnionDocumentSpec1(documentSpec1 DocumentSpec1) DocumentSpecUnion

func CreateDocumentSpecUnionDocumentSpec2 ¶ 

func CreateDocumentSpecUnionDocumentSpec2(documentSpec2 DocumentSpec2) DocumentSpecUnion

func CreateDocumentSpecUnionDocumentSpec3 ¶ 

func CreateDocumentSpecUnionDocumentSpec3(documentSpec3 DocumentSpec3) DocumentSpecUnion

func CreateDocumentSpecUnionDocumentSpec4 ¶ added in v0.9.0 

func CreateDocumentSpecUnionDocumentSpec4(documentSpec4 DocumentSpec4) DocumentSpecUnion

func (DocumentSpecUnion) MarshalJSON ¶ 

func (u DocumentSpecUnion) MarshalJSON() ([]byte, error)

func (*DocumentSpecUnion) UnmarshalJSON ¶ 

func (u *DocumentSpecUnion) UnmarshalJSON(data []byte) error

type DocumentSpecUnionType ¶ 

type DocumentSpecUnionType string
const (
	DocumentSpecUnionTypeDocumentSpec1 DocumentSpecUnionType = "DocumentSpec_1"
	DocumentSpecUnionTypeDocumentSpec2 DocumentSpecUnionType = "DocumentSpec_2"
	DocumentSpecUnionTypeDocumentSpec3 DocumentSpecUnionType = "DocumentSpec_3"
	DocumentSpecUnionTypeDocumentSpec4 DocumentSpecUnionType = "DocumentSpec_4"
)

type DocumentStatusResponse ¶ 

type DocumentStatusResponse struct {
	// Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN
	UploadStatus *string `json:"uploadStatus,omitempty"`
	// Time of last successful upload for the document, in ISO 8601 format
	LastUploadedAt *string `json:"lastUploadedAt,omitempty"`
	// Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN
	IndexingStatus *string `json:"indexingStatus,omitempty"`
	// Time of last successful indexing for the document, in ISO 8601 format
	LastIndexedAt *string `json:"lastIndexedAt,omitempty"`
	// Permission identity status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN (Always unknown if `identityDatasourceName` is set). Document visibility may be affected status is `NOT_UPLOADED`.
	PermissionIdentityStatus *string `json:"permissionIdentityStatus,omitempty"`
}

DocumentStatusResponse - Describes the document status response body

func (*DocumentStatusResponse) GetIndexingStatus ¶ 

func (d *DocumentStatusResponse) GetIndexingStatus() *string

func (*DocumentStatusResponse) GetLastIndexedAt ¶ 

func (d *DocumentStatusResponse) GetLastIndexedAt() *string

func (*DocumentStatusResponse) GetLastUploadedAt ¶ 

func (d *DocumentStatusResponse) GetLastUploadedAt() *string

func (*DocumentStatusResponse) GetPermissionIdentityStatus ¶ 

func (d *DocumentStatusResponse) GetPermissionIdentityStatus() *string

func (*DocumentStatusResponse) GetUploadStatus ¶ 

func (d *DocumentStatusResponse) GetUploadStatus() *string

type DocumentVisibility ¶ 

type DocumentVisibility string

DocumentVisibility - The level of visibility of the document as understood by our system. 

const (
	DocumentVisibilityPrivate                 DocumentVisibility = "PRIVATE"
	DocumentVisibilitySpecificPeopleAndGroups DocumentVisibility = "SPECIFIC_PEOPLE_AND_GROUPS"
	DocumentVisibilityDomainLink              DocumentVisibility = "DOMAIN_LINK"
	DocumentVisibilityDomainVisible           DocumentVisibility = "DOMAIN_VISIBLE"
	DocumentVisibilityPublicLink              DocumentVisibility = "PUBLIC_LINK"
	DocumentVisibilityPublicVisible           DocumentVisibility = "PUBLIC_VISIBLE"
)

func (DocumentVisibility) ToPointer ¶ 

func (e DocumentVisibility) ToPointer() *DocumentVisibility

func (*DocumentVisibility) UnmarshalJSON ¶ 

func (e *DocumentVisibility) UnmarshalJSON(data []byte) error

type DocumentVisibilityOverride ¶ 

type DocumentVisibilityOverride struct {
	DocID *string `json:"docId,omitempty"`
	// The visibility-override state of the document.
	Override *DocumentVisibilityOverrideOverride `json:"override,omitempty"`
}

func (*DocumentVisibilityOverride) GetDocID ¶ 

func (d *DocumentVisibilityOverride) GetDocID() *string

func (*DocumentVisibilityOverride) GetOverride ¶ 

func (d *DocumentVisibilityOverride) GetOverride() *DocumentVisibilityOverrideOverride

type DocumentVisibilityOverrideOverride ¶ 

type DocumentVisibilityOverrideOverride string

DocumentVisibilityOverrideOverride - The visibility-override state of the document. 

const (
	DocumentVisibilityOverrideOverrideNone                   DocumentVisibilityOverrideOverride = "NONE"
	DocumentVisibilityOverrideOverrideHideFromAll            DocumentVisibilityOverrideOverride = "HIDE_FROM_ALL"
	DocumentVisibilityOverrideOverrideHideFromGroups         DocumentVisibilityOverrideOverride = "HIDE_FROM_GROUPS"
	DocumentVisibilityOverrideOverrideHideFromAllExceptOwner DocumentVisibilityOverrideOverride = "HIDE_FROM_ALL_EXCEPT_OWNER"
)

func (DocumentVisibilityOverrideOverride) ToPointer ¶ 

func (e DocumentVisibilityOverrideOverride) ToPointer() *DocumentVisibilityOverrideOverride

func (*DocumentVisibilityOverrideOverride) UnmarshalJSON ¶ 

func (e *DocumentVisibilityOverrideOverride) UnmarshalJSON(data []byte) error

type DocumentVisibilityUpdateResult ¶ 

type DocumentVisibilityUpdateResult struct {
	DocID *string `json:"docId,omitempty"`
	// The visibility-override state of the document.
	Override *DocumentVisibilityUpdateResultOverride `json:"override,omitempty"`
	// Whether this document was successfully set to its desired visibility state.
	Success *bool `json:"success,omitempty"`
}

func (*DocumentVisibilityUpdateResult) GetDocID ¶ 

func (d *DocumentVisibilityUpdateResult) GetDocID() *string

func (*DocumentVisibilityUpdateResult) GetOverride ¶ 

func (d *DocumentVisibilityUpdateResult) GetOverride() *DocumentVisibilityUpdateResultOverride

func (*DocumentVisibilityUpdateResult) GetSuccess ¶ 

func (d *DocumentVisibilityUpdateResult) GetSuccess() *bool

type DocumentVisibilityUpdateResultOverride ¶ 

type DocumentVisibilityUpdateResultOverride string

DocumentVisibilityUpdateResultOverride - The visibility-override state of the document. 

const (
	DocumentVisibilityUpdateResultOverrideNone                   DocumentVisibilityUpdateResultOverride = "NONE"
	DocumentVisibilityUpdateResultOverrideHideFromAll            DocumentVisibilityUpdateResultOverride = "HIDE_FROM_ALL"
	DocumentVisibilityUpdateResultOverrideHideFromGroups         DocumentVisibilityUpdateResultOverride = "HIDE_FROM_GROUPS"
	DocumentVisibilityUpdateResultOverrideHideFromAllExceptOwner DocumentVisibilityUpdateResultOverride = "HIDE_FROM_ALL_EXCEPT_OWNER"
)

func (DocumentVisibilityUpdateResultOverride) ToPointer ¶ 

func (e DocumentVisibilityUpdateResultOverride) ToPointer() *DocumentVisibilityUpdateResultOverride

func (*DocumentVisibilityUpdateResultOverride) UnmarshalJSON ¶ 

func (e *DocumentVisibilityUpdateResultOverride) UnmarshalJSON(data []byte) error

type Documents ¶ 

type Documents struct {
	// Information about active and recent successful uploads for the datasource
	BulkUploadHistory []BulkUploadHistoryEvent             `json:"bulkUploadHistory,omitempty"`
	Counts            *DebugDatasourceStatusResponseCounts `json:"counts,omitempty"`
	// Information about processing history for the datasource
	ProcessingHistory []ProcessingHistoryEvent `json:"processingHistory,omitempty"`
}

func (*Documents) GetBulkUploadHistory ¶ 

func (d *Documents) GetBulkUploadHistory() []BulkUploadHistoryEvent

func (*Documents) GetCounts ¶ 

func (d *Documents) GetCounts() *DebugDatasourceStatusResponseCounts

func (*Documents) GetProcessingHistory ¶ 

func (d *Documents) GetProcessingHistory() []ProcessingHistoryEvent

type EditAnswerRequest ¶ 

type EditAnswerRequest struct {
	// The opaque ID of the Answer.
	ID int64 `json:"id"`
	// Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
	DocID    *string `json:"docId,omitempty"`
	Question *string `json:"question,omitempty"`
	// Additional ways of phrasing this question.
	QuestionVariations []string `json:"questionVariations,omitempty"`
	// The plain text answer to the question.
	BodyText *string `json:"bodyText,omitempty"`
	// The parent board ID of this Answer, or 0 if it's a floating Answer. Adding Answers to Answer Boards is no longer permitted.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	BoardID *int64 `json:"boardId,omitempty"`
	// Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// A list of user roles for the answer added by the owner.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of user roles for the answer removed by the owner.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// A list of roles for this answer explicitly granted by an owner, editor, or admin.
	Roles              []UserRoleSpecification      `json:"roles,omitempty"`
	SourceDocumentSpec *DocumentSpecUnion           `json:"sourceDocumentSpec,omitempty"`
	SourceType         *EditAnswerRequestSourceType `json:"sourceType,omitempty"`
	// IDs of Collections to which a document is added.
	AddedCollections []int64 `json:"addedCollections,omitempty"`
	// IDs of Collections from which a document is removed.
	RemovedCollections []int64                          `json:"removedCollections,omitempty"`
	CombinedAnswerText *StructuredTextMutableProperties `json:"combinedAnswerText,omitempty"`
}

func (*EditAnswerRequest) GetAddedCollections ¶ 

func (e *EditAnswerRequest) GetAddedCollections() []int64

func (*EditAnswerRequest) GetAddedRoles ¶ 

func (e *EditAnswerRequest) GetAddedRoles() []UserRoleSpecification

func (*EditAnswerRequest) GetAudienceFilters ¶ 

func (e *EditAnswerRequest) GetAudienceFilters() []FacetFilter

func (*EditAnswerRequest) GetBoardID ¶ 

func (e *EditAnswerRequest) GetBoardID() *int64

func (*EditAnswerRequest) GetBodyText ¶ 

func (e *EditAnswerRequest) GetBodyText() *string

func (*EditAnswerRequest) GetCombinedAnswerText ¶ 

func (e *EditAnswerRequest) GetCombinedAnswerText() *StructuredTextMutableProperties

func (*EditAnswerRequest) GetDocID ¶ 

func (e *EditAnswerRequest) GetDocID() *string

func (*EditAnswerRequest) GetID ¶ 

func (e *EditAnswerRequest) GetID() int64

func (*EditAnswerRequest) GetQuestion ¶ 

func (e *EditAnswerRequest) GetQuestion() *string

func (*EditAnswerRequest) GetQuestionVariations ¶ 

func (e *EditAnswerRequest) GetQuestionVariations() []string

func (*EditAnswerRequest) GetRemovedCollections ¶ 

func (e *EditAnswerRequest) GetRemovedCollections() []int64

func (*EditAnswerRequest) GetRemovedRoles ¶ 

func (e *EditAnswerRequest) GetRemovedRoles() []UserRoleSpecification

func (*EditAnswerRequest) GetRoles ¶ 

func (e *EditAnswerRequest) GetRoles() []UserRoleSpecification

func (*EditAnswerRequest) GetSourceDocumentSpec ¶ 

func (e *EditAnswerRequest) GetSourceDocumentSpec() *DocumentSpecUnion

func (*EditAnswerRequest) GetSourceType ¶ 

func (e *EditAnswerRequest) GetSourceType() *EditAnswerRequestSourceType

type EditAnswerRequestSourceType ¶ 

type EditAnswerRequestSourceType string
const (
	EditAnswerRequestSourceTypeDocument  EditAnswerRequestSourceType = "DOCUMENT"
	EditAnswerRequestSourceTypeAssistant EditAnswerRequestSourceType = "ASSISTANT"
)

func (EditAnswerRequestSourceType) ToPointer ¶ 

func (e EditAnswerRequestSourceType) ToPointer() *EditAnswerRequestSourceType

func (*EditAnswerRequestSourceType) UnmarshalJSON ¶ 

func (e *EditAnswerRequestSourceType) UnmarshalJSON(data []byte) error

type EditCollectionItemRequest ¶ 

type EditCollectionItemRequest struct {
	// The optional name of the Collection item.
	Name *string `json:"name,omitempty"`
	// A helpful description of why this CollectionItem is in the Collection that it's in.
	Description *string `json:"description,omitempty"`
	// The emoji icon for this CollectionItem. Only used for Text type items.
	Icon *string `json:"icon,omitempty"`
	// The ID of the Collection to edit CollectionItems in.
	CollectionID int64 `json:"collectionId"`
	// The ID of the CollectionItem to edit.
	ItemID string `json:"itemId"`
}

func (*EditCollectionItemRequest) GetCollectionID ¶ 

func (e *EditCollectionItemRequest) GetCollectionID() int64

func (*EditCollectionItemRequest) GetDescription ¶ 

func (e *EditCollectionItemRequest) GetDescription() *string

func (*EditCollectionItemRequest) GetIcon ¶ 

func (e *EditCollectionItemRequest) GetIcon() *string

func (*EditCollectionItemRequest) GetItemID ¶ 

func (e *EditCollectionItemRequest) GetItemID() string

func (*EditCollectionItemRequest) GetName ¶ 

func (e *EditCollectionItemRequest) GetName() *string

type EditCollectionItemResponse ¶ 

type EditCollectionItemResponse struct {
	Collection *Collection `json:"collection,omitempty"`
}

func (*EditCollectionItemResponse) GetCollection ¶ 

func (e *EditCollectionItemResponse) GetCollection() *Collection

type EditCollectionRequest ¶ 

type EditCollectionRequest struct {
	// The unique name of the Collection.
	Name string `json:"name"`
	// A brief summary of the Collection's contents.
	Description *string `json:"description,omitempty"`
	// A list of added user roles for the Collection.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of removed user roles for the Collection.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The emoji icon of this Collection.
	Icon *string `json:"icon,omitempty"`
	// Indicates whether edits are allowed for everyone or only admins.
	AdminLocked *bool `json:"adminLocked,omitempty"`
	// The parent of this Collection, or 0 if it's a top-level Collection.
	ParentID  *int64     `json:"parentId,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	// The datasource type this Collection can hold.
	AllowedDatasource *string `json:"allowedDatasource,omitempty"`
	// The ID of the Collection to modify.
	ID int64 `json:"id"`
}

func (*EditCollectionRequest) GetAddedRoles ¶ 

func (e *EditCollectionRequest) GetAddedRoles() []UserRoleSpecification

func (*EditCollectionRequest) GetAdminLocked ¶ 

func (e *EditCollectionRequest) GetAdminLocked() *bool

func (*EditCollectionRequest) GetAllowedDatasource ¶ 

func (e *EditCollectionRequest) GetAllowedDatasource() *string

func (*EditCollectionRequest) GetAudienceFilters ¶ 

func (e *EditCollectionRequest) GetAudienceFilters() []FacetFilter

func (*EditCollectionRequest) GetDescription ¶ 

func (e *EditCollectionRequest) GetDescription() *string

func (*EditCollectionRequest) GetID ¶ 

func (e *EditCollectionRequest) GetID() int64

func (*EditCollectionRequest) GetIcon ¶ 

func (e *EditCollectionRequest) GetIcon() *string

func (*EditCollectionRequest) GetName ¶ 

func (e *EditCollectionRequest) GetName() string

func (*EditCollectionRequest) GetParentID ¶ 

func (e *EditCollectionRequest) GetParentID() *int64

func (*EditCollectionRequest) GetRemovedRoles ¶ 

func (e *EditCollectionRequest) GetRemovedRoles() []UserRoleSpecification

func (*EditCollectionRequest) GetThumbnail ¶ 

func (e *EditCollectionRequest) GetThumbnail() *Thumbnail

type EditCollectionResponse ¶ 

type EditCollectionResponse struct {
	// The unique name of the Collection.
	Name string `json:"name"`
	// A brief summary of the Collection's contents.
	Description string `json:"description"`
	// A list of added user roles for the Collection.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of removed user roles for the Collection.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	// Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The emoji icon of this Collection.
	Icon *string `json:"icon,omitempty"`
	// Indicates whether edits are allowed for everyone or only admins.
	AdminLocked *bool `json:"adminLocked,omitempty"`
	// The parent of this Collection, or 0 if it's a top-level Collection.
	ParentID  *int64     `json:"parentId,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	// The datasource type this Collection can hold.
	AllowedDatasource *string            `json:"allowedDatasource,omitempty"`
	Permissions       *ObjectPermissions `json:"permissions,omitempty"`
	// The unique ID of the Collection.
	ID         int64      `json:"id"`
	CreateTime *time.Time `json:"createTime,omitempty"`
	UpdateTime *time.Time `json:"updateTime,omitempty"`
	Creator    *Person    `json:"creator,omitempty"`
	UpdatedBy  *Person    `json:"updatedBy,omitempty"`
	// The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
	ItemCount *int64 `json:"itemCount,omitempty"`
	// The number of children Collections. Separated from the actual children so we can grab the count without children.
	ChildCount *int64 `json:"childCount,omitempty"`
	// The items in this Collection.
	Items       []CollectionItem          `json:"items,omitempty"`
	PinMetadata *CollectionPinnedMetadata `json:"pinMetadata,omitempty"`
	// The names of the shortcuts (Go Links) that point to this Collection.
	Shortcuts []string `json:"shortcuts,omitempty"`
	// The children Collections of this Collection.
	Children []Collection `json:"children,omitempty"`
	// A list of user roles for the Collection.
	Roles      []UserRoleSpecification         `json:"roles,omitempty"`
	ErrorCode  EditCollectionResponseErrorCode `json:"errorCode"`
	Collection *Collection                     `json:"collection,omitempty"`
	Error      *CollectionError                `json:"error,omitempty"`
}

func (*EditCollectionResponse) GetAddedRoles ¶ 

func (e *EditCollectionResponse) GetAddedRoles() []UserRoleSpecification

func (*EditCollectionResponse) GetAdminLocked ¶ 

func (e *EditCollectionResponse) GetAdminLocked() *bool

func (*EditCollectionResponse) GetAllowedDatasource ¶ 

func (e *EditCollectionResponse) GetAllowedDatasource() *string

func (*EditCollectionResponse) GetAudienceFilters ¶ 

func (e *EditCollectionResponse) GetAudienceFilters() []FacetFilter

func (*EditCollectionResponse) GetChildCount ¶ 

func (e *EditCollectionResponse) GetChildCount() *int64

func (*EditCollectionResponse) GetChildren ¶ 

func (e *EditCollectionResponse) GetChildren() []Collection

func (*EditCollectionResponse) GetCollection ¶ 

func (e *EditCollectionResponse) GetCollection() *Collection

func (*EditCollectionResponse) GetCreateTime ¶ 

func (e *EditCollectionResponse) GetCreateTime() *time.Time

func (*EditCollectionResponse) GetCreator ¶ 

func (e *EditCollectionResponse) GetCreator() *Person

func (*EditCollectionResponse) GetDescription ¶ 

func (e *EditCollectionResponse) GetDescription() string

func (*EditCollectionResponse) GetError ¶ 

func (e *EditCollectionResponse) GetError() *CollectionError

func (*EditCollectionResponse) GetErrorCode ¶ 

func (e *EditCollectionResponse) GetErrorCode() EditCollectionResponseErrorCode

func (*EditCollectionResponse) GetID ¶ 

func (e *EditCollectionResponse) GetID() int64

func (*EditCollectionResponse) GetIcon ¶ 

func (e *EditCollectionResponse) GetIcon() *string

func (*EditCollectionResponse) GetItemCount ¶ 

func (e *EditCollectionResponse) GetItemCount() *int64

func (*EditCollectionResponse) GetItems ¶ 

func (e *EditCollectionResponse) GetItems() []CollectionItem

func (*EditCollectionResponse) GetName ¶ 

func (e *EditCollectionResponse) GetName() string

func (*EditCollectionResponse) GetParentID ¶ 

func (e *EditCollectionResponse) GetParentID() *int64

func (*EditCollectionResponse) GetPermissions ¶ 

func (e *EditCollectionResponse) GetPermissions() *ObjectPermissions

func (*EditCollectionResponse) GetPinMetadata ¶ 

func (e *EditCollectionResponse) GetPinMetadata() *CollectionPinnedMetadata

func (*EditCollectionResponse) GetRemovedRoles ¶ 

func (e *EditCollectionResponse) GetRemovedRoles() []UserRoleSpecification

func (*EditCollectionResponse) GetRoles ¶ 

func (e *EditCollectionResponse) GetRoles() []UserRoleSpecification

func (*EditCollectionResponse) GetShortcuts ¶ 

func (e *EditCollectionResponse) GetShortcuts() []string

func (*EditCollectionResponse) GetThumbnail ¶ 

func (e *EditCollectionResponse) GetThumbnail() *Thumbnail

func (*EditCollectionResponse) GetUpdateTime ¶ 

func (e *EditCollectionResponse) GetUpdateTime() *time.Time

func (*EditCollectionResponse) GetUpdatedBy ¶ 

func (e *EditCollectionResponse) GetUpdatedBy() *Person

func (EditCollectionResponse) MarshalJSON ¶ 

func (e EditCollectionResponse) MarshalJSON() ([]byte, error)

func (*EditCollectionResponse) UnmarshalJSON ¶ 

func (e *EditCollectionResponse) UnmarshalJSON(data []byte) error

type EditCollectionResponseErrorCode ¶ 

type EditCollectionResponseErrorCode string
const (
	EditCollectionResponseErrorCodeNameExists              EditCollectionResponseErrorCode = "NAME_EXISTS"
	EditCollectionResponseErrorCodeNotFound                EditCollectionResponseErrorCode = "NOT_FOUND"
	EditCollectionResponseErrorCodeCollectionPinned        EditCollectionResponseErrorCode = "COLLECTION_PINNED"
	EditCollectionResponseErrorCodeConcurrentHierarchyEdit EditCollectionResponseErrorCode = "CONCURRENT_HIERARCHY_EDIT"
	EditCollectionResponseErrorCodeHeightViolation         EditCollectionResponseErrorCode = "HEIGHT_VIOLATION"
	EditCollectionResponseErrorCodeWidthViolation          EditCollectionResponseErrorCode = "WIDTH_VIOLATION"
	EditCollectionResponseErrorCodeNoPermissions           EditCollectionResponseErrorCode = "NO_PERMISSIONS"
)

func (EditCollectionResponseErrorCode) ToPointer ¶ 

func (e EditCollectionResponseErrorCode) ToPointer() *EditCollectionResponseErrorCode

func (*EditCollectionResponseErrorCode) UnmarshalJSON ¶ 

func (e *EditCollectionResponseErrorCode) UnmarshalJSON(data []byte) error

type EditPinRequest ¶ 

type EditPinRequest struct {
	// The query strings for which the pinned result will show.
	Queries []string `json:"queries,omitempty"`
	// Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The opaque id of the pin to be edited.
	ID *string `json:"id,omitempty"`
}

func (*EditPinRequest) GetAudienceFilters ¶ 

func (e *EditPinRequest) GetAudienceFilters() []FacetFilter

func (*EditPinRequest) GetID ¶ 

func (e *EditPinRequest) GetID() *string

func (*EditPinRequest) GetQueries ¶ 

func (e *EditPinRequest) GetQueries() []string

type EmployeeInfoDefinition ¶ 

type EmployeeInfoDefinition struct {
	// The employee's email
	Email string `json:"email"`
	// The first name of the employee. **Note**: The value cannot be empty
	//
	FirstName *string `json:"firstName,omitempty"`
	// The last name of the employee. **Note**: The value cannot be empty
	//
	LastName *string `json:"lastName,omitempty"`
	// The preferred name or nickname of the employee
	PreferredName *string `json:"preferredName,omitempty"`
	// **[Advanced]** A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with `managerId`.
	//
	ID *string `json:"id,omitempty"`
	// The employee's phone number.
	PhoneNumber *string `json:"phoneNumber,omitempty"`
	// The employee's location (city/office name etc).
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Location *string `json:"location,omitempty"`
	// Detailed location with information about country, state, city etc.
	StructuredLocation *StructuredLocation `json:"structuredLocation,omitempty"`
	// The employee's role title.
	Title *string `json:"title,omitempty"`
	// The employee's profile pic
	PhotoURL *string `json:"photoUrl,omitempty"`
	// Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
	BusinessUnit *string `json:"businessUnit,omitempty"`
	// An organizational unit where everyone has a similar task, e.g. `Engineering`.
	Department string `json:"department"`
	// The datasource profiles of the employee, e.g. `Slack`,`Github`.
	DatasourceProfiles []DatasourceProfile `json:"datasourceProfiles,omitempty"`
	// Info about the employee's team(s)
	Teams []EmployeeTeamInfo `json:"teams,omitempty"`
	// The date when the employee started
	StartDate *types.Date `json:"startDate,omitempty"`
	// If a former employee, the last date of employment.
	EndDate *types.Date `json:"endDate,omitempty"`
	// Short biography or mission statement of the employee.
	Bio *string `json:"bio,omitempty"`
	// She/her, He/his or other pronoun.
	Pronoun *string `json:"pronoun,omitempty"`
	// Other names associated with the employee.
	AlsoKnownAs []string `json:"alsoKnownAs,omitempty"`
	// Link to internal company person profile.
	ProfileURL *string `json:"profileUrl,omitempty"`
	// List of social network profiles.
	SocialNetworks []SocialNetworkDefinition `json:"socialNetworks,omitempty"`
	// The email of the employee's manager
	ManagerEmail *string `json:"managerEmail,omitempty"`
	// **[Advanced]** A unique universal internal identifier for the employee's manager. This is solely used in conjunction with `id`.
	//
	ManagerID *string `json:"managerId,omitempty"`
	// The type of the employee, an enum of `FULL_TIME`, `CONTRACTOR`, `NON_EMPLOYEE`
	Type *string `default:"FULL_TIME" json:"type"`
	// List of unidirectional relationships with other employees. E.g. this employee (`A`) is a CHIEF_OF_STAFF to another employee (`B`); or this employee (`A`) is an EXECUTIVE_ASSISTANT of another employee (`C`). The mapping should be attached to `A`'s profile.
	Relationships []EntityRelationship `json:"relationships,omitempty"`
	// The status of the employee, an enum of `CURRENT`, `FUTURE`, `EX`
	Status *string `default:"CURRENT" json:"status"`
	// List of additional fields with more information about the employee.
	AdditionalFields []AdditionalFieldDefinition `json:"additionalFields,omitempty"`
}

EmployeeInfoDefinition - Describes employee info

func (*EmployeeInfoDefinition) GetAdditionalFields ¶ 

func (e *EmployeeInfoDefinition) GetAdditionalFields() []AdditionalFieldDefinition

func (*EmployeeInfoDefinition) GetAlsoKnownAs ¶ 

func (e *EmployeeInfoDefinition) GetAlsoKnownAs() []string

func (*EmployeeInfoDefinition) GetBio ¶ 

func (e *EmployeeInfoDefinition) GetBio() *string

func (*EmployeeInfoDefinition) GetBusinessUnit ¶ 

func (e *EmployeeInfoDefinition) GetBusinessUnit() *string

func (*EmployeeInfoDefinition) GetDatasourceProfiles ¶ 

func (e *EmployeeInfoDefinition) GetDatasourceProfiles() []DatasourceProfile

func (*EmployeeInfoDefinition) GetDepartment ¶ 

func (e *EmployeeInfoDefinition) GetDepartment() string

func (*EmployeeInfoDefinition) GetEmail ¶ 

func (e *EmployeeInfoDefinition) GetEmail() string

func (*EmployeeInfoDefinition) GetEndDate ¶ 

func (e *EmployeeInfoDefinition) GetEndDate() *types.Date

func (*EmployeeInfoDefinition) GetFirstName ¶ 

func (e *EmployeeInfoDefinition) GetFirstName() *string

func (*EmployeeInfoDefinition) GetID ¶ 

func (e *EmployeeInfoDefinition) GetID() *string

func (*EmployeeInfoDefinition) GetLastName ¶ 

func (e *EmployeeInfoDefinition) GetLastName() *string

func (*EmployeeInfoDefinition) GetLocation ¶ 

func (e *EmployeeInfoDefinition) GetLocation() *string

func (*EmployeeInfoDefinition) GetManagerEmail ¶ 

func (e *EmployeeInfoDefinition) GetManagerEmail() *string

func (*EmployeeInfoDefinition) GetManagerID ¶ 

func (e *EmployeeInfoDefinition) GetManagerID() *string

func (*EmployeeInfoDefinition) GetPhoneNumber ¶ 

func (e *EmployeeInfoDefinition) GetPhoneNumber() *string

func (*EmployeeInfoDefinition) GetPhotoURL ¶ 

func (e *EmployeeInfoDefinition) GetPhotoURL() *string

func (*EmployeeInfoDefinition) GetPreferredName ¶ 

func (e *EmployeeInfoDefinition) GetPreferredName() *string

func (*EmployeeInfoDefinition) GetProfileURL ¶ 

func (e *EmployeeInfoDefinition) GetProfileURL() *string

func (*EmployeeInfoDefinition) GetPronoun ¶ 

func (e *EmployeeInfoDefinition) GetPronoun() *string

func (*EmployeeInfoDefinition) GetRelationships ¶ 

func (e *EmployeeInfoDefinition) GetRelationships() []EntityRelationship

func (*EmployeeInfoDefinition) GetSocialNetworks ¶ 

func (e *EmployeeInfoDefinition) GetSocialNetworks() []SocialNetworkDefinition

func (*EmployeeInfoDefinition) GetStartDate ¶ 

func (e *EmployeeInfoDefinition) GetStartDate() *types.Date

func (*EmployeeInfoDefinition) GetStatus ¶ 

func (e *EmployeeInfoDefinition) GetStatus() *string

func (*EmployeeInfoDefinition) GetStructuredLocation ¶ 

func (e *EmployeeInfoDefinition) GetStructuredLocation() *StructuredLocation

func (*EmployeeInfoDefinition) GetTeams ¶ 

func (e *EmployeeInfoDefinition) GetTeams() []EmployeeTeamInfo

func (*EmployeeInfoDefinition) GetTitle ¶ 

func (e *EmployeeInfoDefinition) GetTitle() *string

func (*EmployeeInfoDefinition) GetType ¶ 

func (e *EmployeeInfoDefinition) GetType() *string

func (EmployeeInfoDefinition) MarshalJSON ¶ 

func (e EmployeeInfoDefinition) MarshalJSON() ([]byte, error)

func (*EmployeeInfoDefinition) UnmarshalJSON ¶ 

func (e *EmployeeInfoDefinition) UnmarshalJSON(data []byte) error

type EmployeeTeamInfo ¶ 

type EmployeeTeamInfo struct {
	// unique identifier for this team
	ID *string `json:"id,omitempty"`
	// Team name
	Name *string `json:"name,omitempty"`
	// Link to internal company team page
	URL *string `json:"url,omitempty"`
}

EmployeeTeamInfo - Information about which team an employee belongs to

func (*EmployeeTeamInfo) GetID ¶ 

func (e *EmployeeTeamInfo) GetID() *string

func (*EmployeeTeamInfo) GetName ¶ 

func (e *EmployeeTeamInfo) GetName() *string

func (*EmployeeTeamInfo) GetURL ¶ 

func (e *EmployeeTeamInfo) GetURL() *string

type EntitiesSortOrder ¶ 

type EntitiesSortOrder string

EntitiesSortOrder - Different ways of sorting entities 

const (
	EntitiesSortOrderEntityName   EntitiesSortOrder = "ENTITY_NAME"
	EntitiesSortOrderFirstName    EntitiesSortOrder = "FIRST_NAME"
	EntitiesSortOrderLastName     EntitiesSortOrder = "LAST_NAME"
	EntitiesSortOrderOrgSizeCount EntitiesSortOrder = "ORG_SIZE_COUNT"
	EntitiesSortOrderStartDate    EntitiesSortOrder = "START_DATE"
	EntitiesSortOrderTeamSize     EntitiesSortOrder = "TEAM_SIZE"
	EntitiesSortOrderRelevance    EntitiesSortOrder = "RELEVANCE"
)

func (EntitiesSortOrder) ToPointer ¶ 

func (e EntitiesSortOrder) ToPointer() *EntitiesSortOrder

func (*EntitiesSortOrder) UnmarshalJSON ¶ 

func (e *EntitiesSortOrder) UnmarshalJSON(data []byte) error

type EntityRelationship ¶ 

type EntityRelationship struct {
	// The title or type of relationship. Currently an enum of `CHIEF_OF_STAFF`, `EXECUTIVE_ASSISTANT`
	Name string `json:"name"`
	// Email of the person with whom the relationship exists. Per the example above, either `B` or `C`'s email depending on the relationship.
	Email string `json:"email"`
}

EntityRelationship - Describes a relationship edge between a source and destination entity

func (*EntityRelationship) GetEmail ¶ 

func (e *EntityRelationship) GetEmail() string

func (*EntityRelationship) GetName ¶ 

func (e *EntityRelationship) GetName() string

type EntityType ¶ 

type EntityType string

EntityType - The type of entity. 

const (
	EntityTypePerson   EntityType = "PERSON"
	EntityTypeProject  EntityType = "PROJECT"
	EntityTypeCustomer EntityType = "CUSTOMER"
)

func (EntityType) ToPointer ¶ 

func (e EntityType) ToPointer() *EntityType

func (*EntityType) UnmarshalJSON ¶ 

func (e *EntityType) UnmarshalJSON(data []byte) error

type Error ¶ 

type Error struct {
	Message *string `json:"message,omitempty"`
}

func (*Error) GetMessage ¶ 

func (e *Error) GetMessage() *string

type ErrorMessage ¶ 

type ErrorMessage struct {
	// The datasource this message relates to.
	Source       *string `json:"source,omitempty"`
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

func (*ErrorMessage) GetErrorMessage ¶ 

func (e *ErrorMessage) GetErrorMessage() *string

func (*ErrorMessage) GetSource ¶ 

func (e *ErrorMessage) GetSource() *string

type Event ¶ 

type Event string

Event - The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`. 

const (
	EventClick                    Event = "CLICK"
	EventContainerClick           Event = "CONTAINER_CLICK"
	EventCopyLink                 Event = "COPY_LINK"
	EventCreate                   Event = "CREATE"
	EventDismiss                  Event = "DISMISS"
	EventDownvote                 Event = "DOWNVOTE"
	EventEmail                    Event = "EMAIL"
	EventExecute                  Event = "EXECUTE"
	EventFilter                   Event = "FILTER"
	EventFirstToken               Event = "FIRST_TOKEN"
	EventFocusIn                  Event = "FOCUS_IN"
	EventLastToken                Event = "LAST_TOKEN"
	EventManualFeedback           Event = "MANUAL_FEEDBACK"
	EventManualFeedbackSideBySide Event = "MANUAL_FEEDBACK_SIDE_BY_SIDE"
	EventMarkAsRead               Event = "MARK_AS_READ"
	EventMessage                  Event = "MESSAGE"
	EventMiddleClick              Event = "MIDDLE_CLICK"
	EventPageBlur                 Event = "PAGE_BLUR"
	EventPageFocus                Event = "PAGE_FOCUS"
	EventPageLeave                Event = "PAGE_LEAVE"
	EventPreview                  Event = "PREVIEW"
	EventRelatedClick             Event = "RELATED_CLICK"
	EventRightClick               Event = "RIGHT_CLICK"
	EventSectionClick             Event = "SECTION_CLICK"
	EventSeen                     Event = "SEEN"
	EventShare                    Event = "SHARE"
	EventShowMore                 Event = "SHOW_MORE"
	EventUpvote                   Event = "UPVOTE"
	EventView                     Event = "VIEW"
	EventVisible                  Event = "VISIBLE"
)

func (Event) ToPointer ¶ 

func (e Event) ToPointer() *Event

func (*Event) UnmarshalJSON ¶ 

func (e *Event) UnmarshalJSON(data []byte) error

type EventClassification ¶ 

type EventClassification struct {
	// The name for a generated classification of an event.
	Name       *EventClassificationName `json:"name,omitempty"`
	Strategies []EventStrategyName      `json:"strategies,omitempty"`
}

EventClassification - A generated classification of a given event.

func (*EventClassification) GetName ¶ 

func (e *EventClassification) GetName() *EventClassificationName

func (*EventClassification) GetStrategies ¶ 

func (e *EventClassification) GetStrategies() []EventStrategyName

type EventClassificationName ¶ 

type EventClassificationName string

EventClassificationName - The name for a generated classification of an event. 

const (
	EventClassificationNameExternalEvent EventClassificationName = "External Event"
)

func (EventClassificationName) ToPointer ¶ 

func (e EventClassificationName) ToPointer() *EventClassificationName

func (*EventClassificationName) UnmarshalJSON ¶ 

func (e *EventClassificationName) UnmarshalJSON(data []byte) error

type EventStrategyName ¶ 

type EventStrategyName string

EventStrategyName - The name of method used to surface relevant data for a given calendar event. 

const (
	EventStrategyNameCustomerCard      EventStrategyName = "customerCard"
	EventStrategyNameNews              EventStrategyName = "news"
	EventStrategyNameCall              EventStrategyName = "call"
	EventStrategyNameEmail             EventStrategyName = "email"
	EventStrategyNameMeetingNotes      EventStrategyName = "meetingNotes"
	EventStrategyNameLinkedIn          EventStrategyName = "linkedIn"
	EventStrategyNameRelevantDocuments EventStrategyName = "relevantDocuments"
	EventStrategyNameChatFollowUps     EventStrategyName = "chatFollowUps"
	EventStrategyNameConversations     EventStrategyName = "conversations"
)

func (EventStrategyName) ToPointer ¶ 

func (e EventStrategyName) ToPointer() *EventStrategyName

func (*EventStrategyName) UnmarshalJSON ¶ 

func (e *EventStrategyName) UnmarshalJSON(data []byte) error

type ExternalSharingOptions deprecated 

type ExternalSharingOptions struct {
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Enabled *bool `json:"enabled,omitempty"`
	// The minimum number of users the document is shared with.
	Threshold *int64 `json:"threshold,omitempty"`
	// Documents will be filtered based on how many people have access to it.
	ThresholdEnabled *bool `json:"thresholdEnabled,omitempty"`
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	AnyoneWithLinkEnabled *bool `json:"anyoneWithLinkEnabled,omitempty"`
	// Only users within the organization can access the document.
	AnyoneInternalEnabled *bool `json:"anyoneInternalEnabled,omitempty"`
	// Anyone on the internet can access the document.
	AnonymousAccessEnabled *bool `json:"anonymousAccessEnabled,omitempty"`
	// Enable user access check
	UserAccessEnabled *bool `json:"userAccessEnabled,omitempty"`
	// Any one of the specified users can access the document.
	UserIds             []string `json:"userIds,omitempty"`
	DomainAccessEnabled *bool    `json:"domainAccessEnabled,omitempty"`
}

ExternalSharingOptions - Controls how "shared" a document must be to get picked for scans.

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.

func (*ExternalSharingOptions) GetAnonymousAccessEnabled ¶ 

func (e *ExternalSharingOptions) GetAnonymousAccessEnabled() *bool

func (*ExternalSharingOptions) GetAnyoneInternalEnabled ¶ 

func (e *ExternalSharingOptions) GetAnyoneInternalEnabled() *bool

func (*ExternalSharingOptions) GetAnyoneWithLinkEnabled ¶ 

func (e *ExternalSharingOptions) GetAnyoneWithLinkEnabled() *bool

func (*ExternalSharingOptions) GetDomainAccessEnabled ¶ 

func (e *ExternalSharingOptions) GetDomainAccessEnabled() *bool

func (*ExternalSharingOptions) GetEnabled ¶ 

func (e *ExternalSharingOptions) GetEnabled() *bool

func (*ExternalSharingOptions) GetThreshold ¶ 

func (e *ExternalSharingOptions) GetThreshold() *int64

func (*ExternalSharingOptions) GetThresholdEnabled ¶ 

func (e *ExternalSharingOptions) GetThresholdEnabled() *bool

func (*ExternalSharingOptions) GetUserAccessEnabled ¶ 

func (e *ExternalSharingOptions) GetUserAccessEnabled() *bool

func (*ExternalSharingOptions) GetUserIds ¶ 

func (e *ExternalSharingOptions) GetUserIds() []string

type ExternalShortcut ¶ 

type ExternalShortcut struct {
	// link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias.
	InputAlias string `json:"inputAlias"`
	// A short, plain text blurb to help people understand the intent of the shortcut.
	Description *string `json:"description,omitempty"`
	// destination URL for the shortcut.
	DestinationURL string `json:"destinationUrl"`
	// Email of the user who created this shortcut.
	CreatedBy string `json:"createdBy"`
	// The time the shortcut was created in epoch seconds.
	CreateTime *int64 `json:"createTime,omitempty"`
	// Email of the user who last updated this shortcut.
	UpdatedBy *string `json:"updatedBy,omitempty"`
	// The time the shortcut was updated in epoch seconds.
	UpdateTime *int64 `json:"updateTime,omitempty"`
	// Title of the golink
	Title *string `json:"title,omitempty"`
	// The URL from which the user is then redirected to the destination URL.
	IntermediateURL string `json:"intermediateUrl"`
	// decayed visits score for ranking
	DecayedVisitScore *float64 `json:"decayedVisitScore,omitempty"`
	// The URL using which the user can access the edit page of the shortcut.
	EditURL *string `json:"editUrl,omitempty"`
}

func (*ExternalShortcut) GetCreateTime ¶ 

func (e *ExternalShortcut) GetCreateTime() *int64

func (*ExternalShortcut) GetCreatedBy ¶ 

func (e *ExternalShortcut) GetCreatedBy() string

func (*ExternalShortcut) GetDecayedVisitScore ¶ 

func (e *ExternalShortcut) GetDecayedVisitScore() *float64

func (*ExternalShortcut) GetDescription ¶ 

func (e *ExternalShortcut) GetDescription() *string

func (*ExternalShortcut) GetDestinationURL ¶ 

func (e *ExternalShortcut) GetDestinationURL() string

func (*ExternalShortcut) GetEditURL ¶ 

func (e *ExternalShortcut) GetEditURL() *string

func (*ExternalShortcut) GetInputAlias ¶ 

func (e *ExternalShortcut) GetInputAlias() string

func (*ExternalShortcut) GetIntermediateURL ¶ 

func (e *ExternalShortcut) GetIntermediateURL() string

func (*ExternalShortcut) GetTitle ¶ 

func (e *ExternalShortcut) GetTitle() *string

func (*ExternalShortcut) GetUpdateTime ¶ 

func (e *ExternalShortcut) GetUpdateTime() *int64

func (*ExternalShortcut) GetUpdatedBy ¶ 

func (e *ExternalShortcut) GetUpdatedBy() *string

type ExtractedQnA ¶ 

type ExtractedQnA struct {
	// Heading text that was matched to produce this result.
	Heading *string `json:"heading,omitempty"`
	// Question text that was matched to produce this result.
	Question       *string       `json:"question,omitempty"`
	QuestionResult *SearchResult `json:"questionResult,omitempty"`
}

func (*ExtractedQnA) GetHeading ¶ 

func (e *ExtractedQnA) GetHeading() *string

func (*ExtractedQnA) GetQuestion ¶ 

func (e *ExtractedQnA) GetQuestion() *string

func (*ExtractedQnA) GetQuestionResult ¶ 

func (e *ExtractedQnA) GetQuestionResult() *SearchResult

func (ExtractedQnA) MarshalJSON ¶ added in v0.9.0 

func (e ExtractedQnA) MarshalJSON() ([]byte, error)

func (*ExtractedQnA) UnmarshalJSON ¶ added in v0.9.0 

func (e *ExtractedQnA) UnmarshalJSON(data []byte) error

type FacetBucket ¶ 

type FacetBucket struct {
	// Estimated number of results in this facet.
	Count *int64 `json:"count,omitempty"`
	// The datasource the value belongs to. This will be used by the all tab to show types across all datasources.
	Datasource *string `json:"datasource,omitempty"`
	// Estimated percentage of results in this facet.
	Percentage *int64      `json:"percentage,omitempty"`
	Value      *FacetValue `json:"value,omitempty"`
}

func (*FacetBucket) GetCount ¶ 

func (f *FacetBucket) GetCount() *int64

func (*FacetBucket) GetDatasource ¶ 

func (f *FacetBucket) GetDatasource() *string

func (*FacetBucket) GetPercentage ¶ 

func (f *FacetBucket) GetPercentage() *int64

func (*FacetBucket) GetValue ¶ 

func (f *FacetBucket) GetValue() *FacetValue

type FacetBucketFilter ¶ 

type FacetBucketFilter struct {
	// The facet whose buckets should be filtered.
	Facet *string `json:"facet,omitempty"`
	// The per-term prefix that facet buckets should be filtered on.
	Prefix *string `json:"prefix,omitempty"`
}

func (*FacetBucketFilter) GetFacet ¶ 

func (f *FacetBucketFilter) GetFacet() *string

func (*FacetBucketFilter) GetPrefix ¶ 

func (f *FacetBucketFilter) GetPrefix() *string

func (FacetBucketFilter) MarshalJSON ¶ added in v0.9.0 

func (f FacetBucketFilter) MarshalJSON() ([]byte, error)

func (*FacetBucketFilter) UnmarshalJSON ¶ added in v0.9.0 

func (f *FacetBucketFilter) UnmarshalJSON(data []byte) error

type FacetFilter ¶ 

type FacetFilter struct {
	FieldName *string `json:"fieldName,omitempty"`
	// Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet.
	Values []FacetFilterValue `json:"values,omitempty"`
	// Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet.
	GroupName *string `json:"groupName,omitempty"`
}

func (*FacetFilter) GetFieldName ¶ 

func (f *FacetFilter) GetFieldName() *string

func (*FacetFilter) GetGroupName ¶ 

func (f *FacetFilter) GetGroupName() *string

func (*FacetFilter) GetValues ¶ 

func (f *FacetFilter) GetValues() []FacetFilterValue

func (FacetFilter) MarshalJSON ¶ added in v0.9.0 

func (f FacetFilter) MarshalJSON() ([]byte, error)

func (*FacetFilter) UnmarshalJSON ¶ added in v0.9.0 

func (f *FacetFilter) UnmarshalJSON(data []byte) error

type FacetFilterSet ¶ 

type FacetFilterSet struct {
	Filters []FacetFilter `json:"filters,omitempty"`
}

FacetFilterSet - Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.

func (*FacetFilterSet) GetFilters ¶ 

func (f *FacetFilterSet) GetFilters() []FacetFilter

func (FacetFilterSet) MarshalJSON ¶ added in v0.9.0 

func (f FacetFilterSet) MarshalJSON() ([]byte, error)

func (*FacetFilterSet) UnmarshalJSON ¶ added in v0.9.0 

func (f *FacetFilterSet) UnmarshalJSON(data []byte) error

type FacetFilterValue ¶ 

type FacetFilterValue struct {
	Value        *string       `json:"value,omitempty"`
	RelationType *RelationType `json:"relationType,omitempty"`
	// DEPRECATED - please use relationType instead
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	IsNegated *bool `json:"isNegated,omitempty"`
}

func (*FacetFilterValue) GetIsNegated ¶ 

func (f *FacetFilterValue) GetIsNegated() *bool

func (*FacetFilterValue) GetRelationType ¶ 

func (f *FacetFilterValue) GetRelationType() *RelationType

func (*FacetFilterValue) GetValue ¶ 

func (f *FacetFilterValue) GetValue() *string

func (FacetFilterValue) MarshalJSON ¶ added in v0.9.0 

func (f FacetFilterValue) MarshalJSON() ([]byte, error)

func (*FacetFilterValue) UnmarshalJSON ¶ added in v0.9.0 

func (f *FacetFilterValue) UnmarshalJSON(data []byte) error

type FacetResult ¶ 

type FacetResult struct {
	// The source of this facet (e.g. container_name, type, last_updated_at).
	SourceName *string `json:"sourceName,omitempty"`
	// How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'.
	OperatorName *string `json:"operatorName,omitempty"`
	// A list of unique buckets that exist within this result set.
	Buckets []FacetBucket `json:"buckets,omitempty"`
	// Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize.
	HasMoreBuckets *bool `json:"hasMoreBuckets,omitempty"`
	// For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource)
	GroupName *string `json:"groupName,omitempty"`
}

func (*FacetResult) GetBuckets ¶ 

func (f *FacetResult) GetBuckets() []FacetBucket

func (*FacetResult) GetGroupName ¶ 

func (f *FacetResult) GetGroupName() *string

func (*FacetResult) GetHasMoreBuckets ¶ 

func (f *FacetResult) GetHasMoreBuckets() *bool

func (*FacetResult) GetOperatorName ¶ 

func (f *FacetResult) GetOperatorName() *string

func (*FacetResult) GetSourceName ¶ 

func (f *FacetResult) GetSourceName() *string

type FacetValue ¶ 

type FacetValue struct {
	// The value that should be set in the FacetFilter when applying this filter to a search request.
	StringValue  *string `json:"stringValue,omitempty"`
	IntegerValue *int64  `json:"integerValue,omitempty"`
	// An optional user-friendly label to display in place of the facet value.
	DisplayLabel *string `json:"displayLabel,omitempty"`
	// Defines how to render an icon
	IconConfig *IconConfig `json:"iconConfig,omitempty"`
}

func (*FacetValue) GetDisplayLabel ¶ 

func (f *FacetValue) GetDisplayLabel() *string

func (*FacetValue) GetIconConfig ¶ 

func (f *FacetValue) GetIconConfig() *IconConfig

func (*FacetValue) GetIntegerValue ¶ 

func (f *FacetValue) GetIntegerValue() *int64

func (*FacetValue) GetStringValue ¶ 

func (f *FacetValue) GetStringValue() *string

type FavoriteInfo ¶ 

type FavoriteInfo struct {
	UgcType *UgcType `json:"ugcType,omitempty"`
	// Opaque id of the UGC.
	ID *string `json:"id,omitempty"`
	// Number of users this object has been favorited by.
	Count *int64 `json:"count,omitempty"`
	// If the requesting user has favorited this object.
	FavoritedByUser *bool `json:"favoritedByUser,omitempty"`
}

func (*FavoriteInfo) GetCount ¶ 

func (f *FavoriteInfo) GetCount() *int64

func (*FavoriteInfo) GetFavoritedByUser ¶ 

func (f *FavoriteInfo) GetFavoritedByUser() *bool

func (*FavoriteInfo) GetID ¶ 

func (f *FavoriteInfo) GetID() *string

func (*FavoriteInfo) GetUgcType ¶ 

func (f *FavoriteInfo) GetUgcType() *UgcType

type FeedEntry ¶ 

type FeedEntry struct {
	// optional ID associated with a single feed entry (displayable_list_id)
	EntryID *string `json:"entryId,omitempty"`
	// Title for the result. Can be document title, event title and so on.
	Title     string     `json:"title"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	CreatedBy *Person    `json:"createdBy,omitempty"`
	UIConfig  *UIConfig  `json:"uiConfig,omitempty"`
	// Type of the justification.
	JustificationType *JustificationType `json:"justificationType,omitempty"`
	// Server side generated justification string if server provides one.
	Justification *string `json:"justification,omitempty"`
	// An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
	// View URL for the entry if based on links that are not documents in Glean.
	ViewURL        *string               `json:"viewUrl,omitempty"`
	Document       *Document             `json:"document,omitempty"`
	Event          *CalendarEvent        `json:"event,omitempty"`
	Announcement   *Announcement         `json:"announcement,omitempty"`
	Digest         *Digest               `json:"digest,omitempty"`
	Collection     *Collection           `json:"collection,omitempty"`
	CollectionItem *CollectionItem       `json:"collectionItem,omitempty"`
	Person         *Person               `json:"person,omitempty"`
	App            *AppResult            `json:"app,omitempty"`
	ChatSuggestion *ChatSuggestion       `json:"chatSuggestion,omitempty"`
	PromptTemplate *PromptTemplateResult `json:"promptTemplate,omitempty"`
	Workflow       *WorkflowResult       `json:"workflow,omitempty"`
	// List of activity where each activity has user, action, timestamp.
	Activities           []UserActivity `json:"activities,omitempty"`
	DocumentVisitorCount *CountInfo     `json:"documentVisitorCount,omitempty"`
}

func (*FeedEntry) GetActivities ¶ 

func (f *FeedEntry) GetActivities() []UserActivity

func (*FeedEntry) GetAnnouncement ¶ 

func (f *FeedEntry) GetAnnouncement() *Announcement

func (*FeedEntry) GetApp ¶ 

func (f *FeedEntry) GetApp() *AppResult

func (*FeedEntry) GetChatSuggestion ¶ added in v0.9.0 

func (f *FeedEntry) GetChatSuggestion() *ChatSuggestion

func (*FeedEntry) GetCollection ¶ 

func (f *FeedEntry) GetCollection() *Collection

func (*FeedEntry) GetCollectionItem ¶ 

func (f *FeedEntry) GetCollectionItem() *CollectionItem

func (*FeedEntry) GetCreatedBy ¶ 

func (f *FeedEntry) GetCreatedBy() *Person

func (*FeedEntry) GetDigest ¶ added in v0.9.0 

func (f *FeedEntry) GetDigest() *Digest

func (*FeedEntry) GetDocument ¶ 

func (f *FeedEntry) GetDocument() *Document

func (*FeedEntry) GetDocumentVisitorCount ¶ 

func (f *FeedEntry) GetDocumentVisitorCount() *CountInfo

func (*FeedEntry) GetEntryID ¶ 

func (f *FeedEntry) GetEntryID() *string

func (*FeedEntry) GetEvent ¶ 

func (f *FeedEntry) GetEvent() *CalendarEvent

func (*FeedEntry) GetJustification ¶ 

func (f *FeedEntry) GetJustification() *string

func (*FeedEntry) GetJustificationType ¶ 

func (f *FeedEntry) GetJustificationType() *JustificationType

func (*FeedEntry) GetPerson ¶ 

func (f *FeedEntry) GetPerson() *Person

func (*FeedEntry) GetPromptTemplate ¶ 

func (f *FeedEntry) GetPromptTemplate() *PromptTemplateResult

func (*FeedEntry) GetThumbnail ¶ 

func (f *FeedEntry) GetThumbnail() *Thumbnail

func (*FeedEntry) GetTitle ¶ 

func (f *FeedEntry) GetTitle() string

func (*FeedEntry) GetTrackingToken ¶ 

func (f *FeedEntry) GetTrackingToken() *string

func (*FeedEntry) GetUIConfig ¶ 

func (f *FeedEntry) GetUIConfig() *UIConfig

func (*FeedEntry) GetViewURL ¶ 

func (f *FeedEntry) GetViewURL() *string

func (*FeedEntry) GetWorkflow ¶ 

func (f *FeedEntry) GetWorkflow() *WorkflowResult

type FeedRequest ¶ 

type FeedRequest struct {
	// Categories of content requested. An allowlist gives flexibility to request content separately or together.
	Categories     []FeedRequestCategory `json:"categories,omitempty"`
	RequestOptions *FeedRequestOptions   `json:"requestOptions,omitempty"`
	// Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer.
	TimeoutMillis *int64       `json:"timeoutMillis,omitempty"`
	SessionInfo   *SessionInfo `json:"sessionInfo,omitempty"`
}

func (*FeedRequest) GetCategories ¶ 

func (f *FeedRequest) GetCategories() []FeedRequestCategory

func (*FeedRequest) GetRequestOptions ¶ 

func (f *FeedRequest) GetRequestOptions() *FeedRequestOptions

func (*FeedRequest) GetSessionInfo ¶ 

func (f *FeedRequest) GetSessionInfo() *SessionInfo

func (*FeedRequest) GetTimeoutMillis ¶ 

func (f *FeedRequest) GetTimeoutMillis() *int64

type FeedRequestCategory ¶ 

type FeedRequestCategory string
const (
	FeedRequestCategoryDocumentSuggestion           FeedRequestCategory = "DOCUMENT_SUGGESTION"
	FeedRequestCategoryDocumentSuggestionScenario   FeedRequestCategory = "DOCUMENT_SUGGESTION_SCENARIO"
	FeedRequestCategoryTrendingDocument             FeedRequestCategory = "TRENDING_DOCUMENT"
	FeedRequestCategoryVerificationReminder         FeedRequestCategory = "VERIFICATION_REMINDER"
	FeedRequestCategoryEvent                        FeedRequestCategory = "EVENT"
	FeedRequestCategoryAnnouncement                 FeedRequestCategory = "ANNOUNCEMENT"
	FeedRequestCategoryMention                      FeedRequestCategory = "MENTION"
	FeedRequestCategoryDatasourceAffinity           FeedRequestCategory = "DATASOURCE_AFFINITY"
	FeedRequestCategoryRecent                       FeedRequestCategory = "RECENT"
	FeedRequestCategoryCompanyResource              FeedRequestCategory = "COMPANY_RESOURCE"
	FeedRequestCategoryExperimental                 FeedRequestCategory = "EXPERIMENTAL"
	FeedRequestCategoryPeopleCelebrations           FeedRequestCategory = "PEOPLE_CELEBRATIONS"
	FeedRequestCategoryDisplayableList              FeedRequestCategory = "DISPLAYABLE_LIST"
	FeedRequestCategorySocialLink                   FeedRequestCategory = "SOCIAL_LINK"
	FeedRequestCategoryExternalTasks                FeedRequestCategory = "EXTERNAL_TASKS"
	FeedRequestCategoryWorkflowCollections          FeedRequestCategory = "WORKFLOW_COLLECTIONS"
	FeedRequestCategoryZeroStateChatSuggestion      FeedRequestCategory = "ZERO_STATE_CHAT_SUGGESTION"
	FeedRequestCategoryZeroStateChatToolSuggestion  FeedRequestCategory = "ZERO_STATE_CHAT_TOOL_SUGGESTION"
	FeedRequestCategoryZeroStateWorkflowCreatedByMe FeedRequestCategory = "ZERO_STATE_WORKFLOW_CREATED_BY_ME"
	FeedRequestCategoryZeroStateWorkflowFavorites   FeedRequestCategory = "ZERO_STATE_WORKFLOW_FAVORITES"
	FeedRequestCategoryZeroStateWorkflowPopular     FeedRequestCategory = "ZERO_STATE_WORKFLOW_POPULAR"
	FeedRequestCategoryZeroStateWorkflowSuggestion  FeedRequestCategory = "ZERO_STATE_WORKFLOW_SUGGESTION"
	FeedRequestCategoryPersonalizedChatSuggestion   FeedRequestCategory = "PERSONALIZED_CHAT_SUGGESTION"
	FeedRequestCategoryDailyDigest                  FeedRequestCategory = "DAILY_DIGEST"
)

func (FeedRequestCategory) ToPointer ¶ 

func (e FeedRequestCategory) ToPointer() *FeedRequestCategory

func (*FeedRequestCategory) UnmarshalJSON ¶ 

func (e *FeedRequestCategory) UnmarshalJSON(data []byte) error

type FeedRequestOptions ¶ 

type FeedRequestOptions struct {
	// Number of results asked in response. If a result is a collection, counts as one.
	ResultSize int64 `json:"resultSize"`
	// The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
	TimezoneOffset *int64 `json:"timezoneOffset,omitempty"`
	// Mapping from category to number of results asked for the category.
	CategoryToResultSize map[string]CategoryToResultSize `json:"categoryToResultSize,omitempty"`
	// Datasources for which content should be included. Empty is for all.
	DatasourceFilter               []string                        `json:"datasourceFilter,omitempty"`
	ChatZeroStateSuggestionOptions *ChatZeroStateSuggestionOptions `json:"chatZeroStateSuggestionOptions,omitempty"`
}

func (*FeedRequestOptions) GetCategoryToResultSize ¶ 

func (f *FeedRequestOptions) GetCategoryToResultSize() map[string]CategoryToResultSize

func (*FeedRequestOptions) GetChatZeroStateSuggestionOptions ¶ 

func (f *FeedRequestOptions) GetChatZeroStateSuggestionOptions() *ChatZeroStateSuggestionOptions

func (*FeedRequestOptions) GetDatasourceFilter ¶ 

func (f *FeedRequestOptions) GetDatasourceFilter() []string

func (*FeedRequestOptions) GetResultSize ¶ 

func (f *FeedRequestOptions) GetResultSize() int64

func (*FeedRequestOptions) GetTimezoneOffset ¶ 

func (f *FeedRequestOptions) GetTimezoneOffset() *int64

type FeedResponse ¶ 

type FeedResponse struct {
	// List of experiment ids for the corresponding request.
	ExperimentIds []int64 `json:"experimentIds,omitempty"`
	// An opaque token that represents this particular feed response.
	TrackingToken *string `json:"trackingToken,omitempty"`
	// Server unix timestamp (in seconds since epoch UTC).
	ServerTimestamp int64        `json:"serverTimestamp"`
	Results         []FeedResult `json:"results,omitempty"`
	// Map from category to the list of facets that can be used to filter the entry's content.
	FacetResults map[string][]FacetResult `json:"facetResults,omitempty"`
	// The time window (in hours) used for generating user mentions.
	MentionsTimeWindowInHours *int64 `json:"mentionsTimeWindowInHours,omitempty"`
}

func (*FeedResponse) GetExperimentIds ¶ 

func (f *FeedResponse) GetExperimentIds() []int64

func (*FeedResponse) GetFacetResults ¶ 

func (f *FeedResponse) GetFacetResults() map[string][]FacetResult

func (*FeedResponse) GetMentionsTimeWindowInHours ¶ 

func (f *FeedResponse) GetMentionsTimeWindowInHours() *int64

func (*FeedResponse) GetResults ¶ 

func (f *FeedResponse) GetResults() []FeedResult

func (*FeedResponse) GetServerTimestamp ¶ 

func (f *FeedResponse) GetServerTimestamp() int64

func (*FeedResponse) GetTrackingToken ¶ 

func (f *FeedResponse) GetTrackingToken() *string

type FeedResult ¶ 

type FeedResult struct {
	// Category of the result, one of the requested categories in incoming request.
	Category     FeedResultCategory `json:"category"`
	PrimaryEntry FeedEntry          `json:"primaryEntry"`
	// Secondary entries for the result e.g. suggested docs for the calendar, carousel.
	SecondaryEntries []FeedEntry `json:"secondaryEntries,omitempty"`
	// Rank of the result. Rank is suggested by server. Client side rank may differ.
	Rank *int64 `json:"rank,omitempty"`
}

func (*FeedResult) GetCategory ¶ 

func (f *FeedResult) GetCategory() FeedResultCategory

func (*FeedResult) GetPrimaryEntry ¶ 

func (f *FeedResult) GetPrimaryEntry() FeedEntry

func (*FeedResult) GetRank ¶ 

func (f *FeedResult) GetRank() *int64

func (*FeedResult) GetSecondaryEntries ¶ 

func (f *FeedResult) GetSecondaryEntries() []FeedEntry

type FeedResultCategory ¶ 

type FeedResultCategory string

FeedResultCategory - Category of the result, one of the requested categories in incoming request. 

const (
	FeedResultCategoryDocumentSuggestion           FeedResultCategory = "DOCUMENT_SUGGESTION"
	FeedResultCategoryDocumentSuggestionScenario   FeedResultCategory = "DOCUMENT_SUGGESTION_SCENARIO"
	FeedResultCategoryTrendingDocument             FeedResultCategory = "TRENDING_DOCUMENT"
	FeedResultCategoryUseCase                      FeedResultCategory = "USE_CASE"
	FeedResultCategoryVerificationReminder         FeedResultCategory = "VERIFICATION_REMINDER"
	FeedResultCategoryEvent                        FeedResultCategory = "EVENT"
	FeedResultCategoryAnnouncement                 FeedResultCategory = "ANNOUNCEMENT"
	FeedResultCategoryMention                      FeedResultCategory = "MENTION"
	FeedResultCategoryDatasourceAffinity           FeedResultCategory = "DATASOURCE_AFFINITY"
	FeedResultCategoryRecent                       FeedResultCategory = "RECENT"
	FeedResultCategoryCompanyResource              FeedResultCategory = "COMPANY_RESOURCE"
	FeedResultCategoryExperimental                 FeedResultCategory = "EXPERIMENTAL"
	FeedResultCategoryPeopleCelebrations           FeedResultCategory = "PEOPLE_CELEBRATIONS"
	FeedResultCategorySocialLink                   FeedResultCategory = "SOCIAL_LINK"
	FeedResultCategoryExternalTasks                FeedResultCategory = "EXTERNAL_TASKS"
	FeedResultCategoryDisplayableList              FeedResultCategory = "DISPLAYABLE_LIST"
	FeedResultCategoryZeroStateChatSuggestion      FeedResultCategory = "ZERO_STATE_CHAT_SUGGESTION"
	FeedResultCategoryZeroStateChatToolSuggestion  FeedResultCategory = "ZERO_STATE_CHAT_TOOL_SUGGESTION"
	FeedResultCategoryZeroStateWorkflowCreatedByMe FeedResultCategory = "ZERO_STATE_WORKFLOW_CREATED_BY_ME"
	FeedResultCategoryZeroStateWorkflowFavorites   FeedResultCategory = "ZERO_STATE_WORKFLOW_FAVORITES"
	FeedResultCategoryZeroStateWorkflowPopular     FeedResultCategory = "ZERO_STATE_WORKFLOW_POPULAR"
	FeedResultCategoryZeroStateWorkflowSuggestion  FeedResultCategory = "ZERO_STATE_WORKFLOW_SUGGESTION"
	FeedResultCategoryPersonalizedChatSuggestion   FeedResultCategory = "PERSONALIZED_CHAT_SUGGESTION"
	FeedResultCategoryDailyDigest                  FeedResultCategory = "DAILY_DIGEST"
)

func (FeedResultCategory) ToPointer ¶ 

func (e FeedResultCategory) ToPointer() *FeedResultCategory

func (*FeedResultCategory) UnmarshalJSON ¶ 

func (e *FeedResultCategory) UnmarshalJSON(data []byte) error

type Feedback ¶ 

type Feedback struct {
	// Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored.
	ID *string `json:"id,omitempty"`
	// The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas.
	Category *FeedbackCategory `json:"category,omitempty"`
	// A list of server-generated trackingTokens to which this event applies.
	TrackingTokens []string `json:"trackingTokens"`
	// The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`.
	Event Event `json:"event"`
	// Position of the element in the case that the client controls order (such as feed and autocomplete).
	Position *int64 `json:"position,omitempty"`
	// For type MANUAL_FEEDBACK, contains string of user feedback. For autocomplete, partial query string. For feed, string of user feedback in addition to manual feedback signals extracted from all suggested content.
	Payload     *string      `json:"payload,omitempty"`
	SessionInfo *SessionInfo `json:"sessionInfo,omitempty"`
	// The ISO 8601 timestamp when the event occured.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	User      *User      `json:"user,omitempty"`
	// The path the client was at when the feedback event triggered.
	Pathname *string `json:"pathname,omitempty"`
	// Where the feedback will be sent, e.g. to Glean, the user's company, or both. If no channels are specified, feedback will go only to Glean.
	Channels []FeedbackChannel `json:"channels,omitempty"`
	// The URL the client was at when the feedback event triggered.
	URL *string `json:"url,omitempty"`
	// The UI element tree associated with the event, if any.
	UITree []string `json:"uiTree,omitempty"`
	// The UI element associated with the event, if any.
	UIElement                    *string                       `json:"uiElement,omitempty"`
	ManualFeedbackInfo           *ManualFeedbackInfo           `json:"manualFeedbackInfo,omitempty"`
	ManualFeedbackSideBySideInfo *ManualFeedbackSideBySideInfo `json:"manualFeedbackSideBySideInfo,omitempty"`
	SeenFeedbackInfo             *SeenFeedbackInfo             `json:"seenFeedbackInfo,omitempty"`
	UserViewInfo                 *UserViewInfo                 `json:"userViewInfo,omitempty"`
	WorkflowFeedbackInfo         *WorkflowFeedbackInfo         `json:"workflowFeedbackInfo,omitempty"`
	// The application ID of the client that sent the feedback event.
	ApplicationID *string `json:"applicationId,omitempty"`
	// The agent ID of the client that sent the feedback event.
	AgentID *string `json:"agentId,omitempty"`
}

func (*Feedback) GetAgentID ¶ 

func (f *Feedback) GetAgentID() *string

func (*Feedback) GetApplicationID ¶ 

func (f *Feedback) GetApplicationID() *string

func (*Feedback) GetCategory ¶ 

func (f *Feedback) GetCategory() *FeedbackCategory

func (*Feedback) GetChannels ¶ 

func (f *Feedback) GetChannels() []FeedbackChannel

func (*Feedback) GetEvent ¶ 

func (f *Feedback) GetEvent() Event

func (*Feedback) GetID ¶ 

func (f *Feedback) GetID() *string

func (*Feedback) GetManualFeedbackInfo ¶ 

func (f *Feedback) GetManualFeedbackInfo() *ManualFeedbackInfo

func (*Feedback) GetManualFeedbackSideBySideInfo ¶ added in v0.8.0 

func (f *Feedback) GetManualFeedbackSideBySideInfo() *ManualFeedbackSideBySideInfo

func (*Feedback) GetPathname ¶ 

func (f *Feedback) GetPathname() *string

func (*Feedback) GetPayload ¶ 

func (f *Feedback) GetPayload() *string

func (*Feedback) GetPosition ¶ 

func (f *Feedback) GetPosition() *int64

func (*Feedback) GetSeenFeedbackInfo ¶ 

func (f *Feedback) GetSeenFeedbackInfo() *SeenFeedbackInfo

func (*Feedback) GetSessionInfo ¶ 

func (f *Feedback) GetSessionInfo() *SessionInfo

func (*Feedback) GetTimestamp ¶ 

func (f *Feedback) GetTimestamp() *time.Time

func (*Feedback) GetTrackingTokens ¶ 

func (f *Feedback) GetTrackingTokens() []string

func (*Feedback) GetUIElement ¶ 

func (f *Feedback) GetUIElement() *string

func (*Feedback) GetUITree ¶ 

func (f *Feedback) GetUITree() []string

func (*Feedback) GetURL ¶ 

func (f *Feedback) GetURL() *string

func (*Feedback) GetUser ¶ 

func (f *Feedback) GetUser() *User

func (*Feedback) GetUserViewInfo ¶ 

func (f *Feedback) GetUserViewInfo() *UserViewInfo

func (*Feedback) GetWorkflowFeedbackInfo ¶ 

func (f *Feedback) GetWorkflowFeedbackInfo() *WorkflowFeedbackInfo

func (Feedback) MarshalJSON ¶ 

func (f Feedback) MarshalJSON() ([]byte, error)

func (*Feedback) UnmarshalJSON ¶ 

func (f *Feedback) UnmarshalJSON(data []byte) error

type FeedbackCategory ¶ 

type FeedbackCategory string

FeedbackCategory - The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. 

const (
	FeedbackCategoryAnnouncement FeedbackCategory = "ANNOUNCEMENT"
	FeedbackCategoryAutocomplete FeedbackCategory = "AUTOCOMPLETE"
	FeedbackCategoryCollections  FeedbackCategory = "COLLECTIONS"
	FeedbackCategoryFeed         FeedbackCategory = "FEED"
	FeedbackCategorySearch       FeedbackCategory = "SEARCH"
	FeedbackCategoryChat         FeedbackCategory = "CHAT"
	FeedbackCategoryNtp          FeedbackCategory = "NTP"
	FeedbackCategoryWorkflows    FeedbackCategory = "WORKFLOWS"
	FeedbackCategorySummary      FeedbackCategory = "SUMMARY"
	FeedbackCategoryGeneral      FeedbackCategory = "GENERAL"
	FeedbackCategoryPrompts      FeedbackCategory = "PROMPTS"
)

func (FeedbackCategory) ToPointer ¶ 

func (e FeedbackCategory) ToPointer() *FeedbackCategory

func (*FeedbackCategory) UnmarshalJSON ¶ 

func (e *FeedbackCategory) UnmarshalJSON(data []byte) error

type FeedbackChannel ¶ 

type FeedbackChannel string
const (
	FeedbackChannelCompany FeedbackChannel = "COMPANY"
	FeedbackChannelGlean   FeedbackChannel = "GLEAN"
)

func (FeedbackChannel) ToPointer ¶ 

func (e FeedbackChannel) ToPointer() *FeedbackChannel

func (*FeedbackChannel) UnmarshalJSON ¶ 

func (e *FeedbackChannel) UnmarshalJSON(data []byte) error

type FeedbackChatExchange ¶ 

type FeedbackChatExchange struct {
	// Unix timestamp in millis for the chat request.
	Timestamp *int64 `json:"timestamp,omitempty"`
	// Either DEFAULT (company knowledge) or GPT (world knowledge).
	Agent *string `json:"agent,omitempty"`
	// Initial query entered by the user.
	UserQuery *string `json:"userQuery,omitempty"`
	// Search query performed by the agent.
	SearchQuery *string `json:"searchQuery,omitempty"`
	// List of documents read by the agent.
	ResultDocuments []ResultDocument `json:"resultDocuments,omitempty"`
	Response        *string          `json:"response,omitempty"`
}

func (*FeedbackChatExchange) GetAgent ¶ 

func (f *FeedbackChatExchange) GetAgent() *string

func (*FeedbackChatExchange) GetResponse ¶ 

func (f *FeedbackChatExchange) GetResponse() *string

func (*FeedbackChatExchange) GetResultDocuments ¶ 

func (f *FeedbackChatExchange) GetResultDocuments() []ResultDocument

func (*FeedbackChatExchange) GetSearchQuery ¶ 

func (f *FeedbackChatExchange) GetSearchQuery() *string

func (*FeedbackChatExchange) GetTimestamp ¶ 

func (f *FeedbackChatExchange) GetTimestamp() *int64

func (*FeedbackChatExchange) GetUserQuery ¶ 

func (f *FeedbackChatExchange) GetUserQuery() *string

type File ¶ 

type File struct {
	FileName string `multipartForm:"name=fileName"`
	// This field accepts []byte data or io.Reader implementations, such as *os.File.
	Content any `multipartForm:"content"`
}

func (*File) GetContent ¶ 

func (f *File) GetContent() any

func (*File) GetFileName ¶ 

func (f *File) GetFileName() string

type FollowupAction ¶ 

type FollowupAction struct {
	// Unique identifier for this actionRun recommendation event.
	ActionRunID *string `json:"actionRunId,omitempty"`
	// The ID of the action instance that will be invoked.
	ActionInstanceID *string `json:"actionInstanceId,omitempty"`
	// The ID of the associated action.
	ActionID *string `json:"actionId,omitempty"`
	// Map of assistant predicted parameters and their corresponding values.
	Parameters map[string]string `json:"parameters,omitempty"`
	// Text to be displayed to the user when recommending the action instance.
	RecommendationText *string `json:"recommendationText,omitempty"`
	// The label to be used when displaying a button to execute this action instance.
	ActionLabel *string `json:"actionLabel,omitempty"`
	// Whether user confirmation is needed before executing this action instance.
	UserConfirmationRequired *bool `json:"userConfirmationRequired,omitempty"`
}

FollowupAction - A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately.

func (*FollowupAction) GetActionID ¶ 

func (f *FollowupAction) GetActionID() *string

func (*FollowupAction) GetActionInstanceID ¶ 

func (f *FollowupAction) GetActionInstanceID() *string

func (*FollowupAction) GetActionLabel ¶ 

func (f *FollowupAction) GetActionLabel() *string

func (*FollowupAction) GetActionRunID ¶ 

func (f *FollowupAction) GetActionRunID() *string

func (*FollowupAction) GetParameters ¶ added in v0.9.4 

func (f *FollowupAction) GetParameters() map[string]string

func (*FollowupAction) GetRecommendationText ¶ 

func (f *FollowupAction) GetRecommendationText() *string

func (*FollowupAction) GetUserConfirmationRequired ¶ 

func (f *FollowupAction) GetUserConfirmationRequired() *bool

func (FollowupAction) MarshalJSON ¶ added in v0.9.0 

func (f FollowupAction) MarshalJSON() ([]byte, error)

func (*FollowupAction) UnmarshalJSON ¶ added in v0.9.0 

func (f *FollowupAction) UnmarshalJSON(data []byte) error

type Format ¶ 

type Format string

Format - defines how to render this particular displayable list card 

const (
	FormatList Format = "LIST"
)

func (Format) ToPointer ¶ 

func (e Format) ToPointer() *Format

func (*Format) UnmarshalJSON ¶ 

func (e *Format) UnmarshalJSON(data []byte) error

type GeneratedAttachment ¶ 

type GeneratedAttachment struct {
	// The name of method used to surface relevant data for a given calendar event.
	StrategyName *EventStrategyName `json:"strategyName,omitempty"`
	Documents    []Document         `json:"documents,omitempty"`
	Person       *Person            `json:"person,omitempty"`
	Customer     *Customer          `json:"customer,omitempty"`
	// A list of links to external sources outside of Glean.
	ExternalLinks []StructuredLink             `json:"externalLinks,omitempty"`
	Content       []GeneratedAttachmentContent `json:"content,omitempty"`
}

GeneratedAttachment - These are attachments that aren't natively present on the event, and have been smartly suggested.

func (*GeneratedAttachment) GetContent ¶ 

func (g *GeneratedAttachment) GetContent() []GeneratedAttachmentContent

func (*GeneratedAttachment) GetCustomer ¶ 

func (g *GeneratedAttachment) GetCustomer() *Customer

func (*GeneratedAttachment) GetDocuments ¶ 

func (g *GeneratedAttachment) GetDocuments() []Document
func (g *GeneratedAttachment) GetExternalLinks() []StructuredLink

func (*GeneratedAttachment) GetPerson ¶ 

func (g *GeneratedAttachment) GetPerson() *Person

func (*GeneratedAttachment) GetStrategyName ¶ 

func (g *GeneratedAttachment) GetStrategyName() *EventStrategyName

type GeneratedAttachmentContent ¶ 

type GeneratedAttachmentContent struct {
	// The header describing the generated content.
	DisplayHeader *string `json:"displayHeader,omitempty"`
	// The content that has been generated.
	Text *string `json:"text,omitempty"`
}

GeneratedAttachmentContent - Content that has been generated or extrapolated from the documents present in the document field.

func (*GeneratedAttachmentContent) GetDisplayHeader ¶ 

func (g *GeneratedAttachmentContent) GetDisplayHeader() *string

func (*GeneratedAttachmentContent) GetText ¶ 

func (g *GeneratedAttachmentContent) GetText() *string

type GeneratedQna ¶ 

type GeneratedQna struct {
	// Search query rephrased into a question.
	Question *string `json:"question,omitempty"`
	// Answer generated for the given query or the generated question.
	Answer *string `json:"answer,omitempty"`
	// List of all follow-up prompts generated for the given query or the generated question.
	FollowUpPrompts []string `json:"followUpPrompts,omitempty"`
	// List of follow-up actions generated for the given query or the generated question.
	FollowupActions []FollowupAction `json:"followupActions,omitempty"`
	// Answer subsections to mark with special formatting (citations, bolding etc)
	Ranges []TextRange `json:"ranges,omitempty"`
	// Status of backend generating the answer
	Status *GeneratedQnaStatus `json:"status,omitempty"`
	// An opaque cursor representing the search request
	Cursor *string `json:"cursor,omitempty"`
	// An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
}

func (*GeneratedQna) GetAnswer ¶ 

func (g *GeneratedQna) GetAnswer() *string

func (*GeneratedQna) GetCursor ¶ 

func (g *GeneratedQna) GetCursor() *string

func (*GeneratedQna) GetFollowUpPrompts ¶ 

func (g *GeneratedQna) GetFollowUpPrompts() []string

func (*GeneratedQna) GetFollowupActions ¶ 

func (g *GeneratedQna) GetFollowupActions() []FollowupAction

func (*GeneratedQna) GetQuestion ¶ 

func (g *GeneratedQna) GetQuestion() *string

func (*GeneratedQna) GetRanges ¶ 

func (g *GeneratedQna) GetRanges() []TextRange

func (*GeneratedQna) GetStatus ¶ 

func (g *GeneratedQna) GetStatus() *GeneratedQnaStatus

func (*GeneratedQna) GetTrackingToken ¶ 

func (g *GeneratedQna) GetTrackingToken() *string

func (GeneratedQna) MarshalJSON ¶ added in v0.9.0 

func (g GeneratedQna) MarshalJSON() ([]byte, error)

func (*GeneratedQna) UnmarshalJSON ¶ added in v0.9.0 

func (g *GeneratedQna) UnmarshalJSON(data []byte) error

type GeneratedQnaStatus ¶ 

type GeneratedQnaStatus string

GeneratedQnaStatus - Status of backend generating the answer 

const (
	GeneratedQnaStatusComputing GeneratedQnaStatus = "COMPUTING"
	GeneratedQnaStatusDisabled  GeneratedQnaStatus = "DISABLED"
	GeneratedQnaStatusFailed    GeneratedQnaStatus = "FAILED"
	GeneratedQnaStatusNoAnswer  GeneratedQnaStatus = "NO_ANSWER"
	GeneratedQnaStatusSkipped   GeneratedQnaStatus = "SKIPPED"
	GeneratedQnaStatusStreaming GeneratedQnaStatus = "STREAMING"
	GeneratedQnaStatusSucceeded GeneratedQnaStatus = "SUCCEEDED"
	GeneratedQnaStatusTimeout   GeneratedQnaStatus = "TIMEOUT"
)

func (GeneratedQnaStatus) ToPointer ¶ 

func (e GeneratedQnaStatus) ToPointer() *GeneratedQnaStatus

func (*GeneratedQnaStatus) UnmarshalJSON ¶ 

func (e *GeneratedQnaStatus) UnmarshalJSON(data []byte) error

type GetAnswerError ¶ 

type GetAnswerError struct {
	ErrorType    *GetAnswerErrorErrorType `json:"errorType,omitempty"`
	AnswerAuthor *Person                  `json:"answerAuthor,omitempty"`
}

func (*GetAnswerError) GetAnswerAuthor ¶ 

func (g *GetAnswerError) GetAnswerAuthor() *Person

func (*GetAnswerError) GetErrorType ¶ 

func (g *GetAnswerError) GetErrorType() *GetAnswerErrorErrorType

type GetAnswerErrorErrorType ¶ 

type GetAnswerErrorErrorType string
const (
	GetAnswerErrorErrorTypeNoPermission GetAnswerErrorErrorType = "NO_PERMISSION"
	GetAnswerErrorErrorTypeInvalidID    GetAnswerErrorErrorType = "INVALID_ID"
)

func (GetAnswerErrorErrorType) ToPointer ¶ 

func (e GetAnswerErrorErrorType) ToPointer() *GetAnswerErrorErrorType

func (*GetAnswerErrorErrorType) UnmarshalJSON ¶ 

func (e *GetAnswerErrorErrorType) UnmarshalJSON(data []byte) error

type GetAnswerRequest ¶ 

type GetAnswerRequest struct {
	// The opaque ID of the Answer.
	ID *int64 `json:"id,omitempty"`
	// Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
	DocID *string `json:"docId,omitempty"`
}

func (*GetAnswerRequest) GetDocID ¶ 

func (g *GetAnswerRequest) GetDocID() *string

func (*GetAnswerRequest) GetID ¶ 

func (g *GetAnswerRequest) GetID() *int64

type GetAnswerResponse ¶ 

type GetAnswerResponse struct {
	AnswerResult *AnswerResult   `json:"answerResult,omitempty"`
	Error        *GetAnswerError `json:"error,omitempty"`
}

func (*GetAnswerResponse) GetAnswerResult ¶ 

func (g *GetAnswerResponse) GetAnswerResult() *AnswerResult

func (*GetAnswerResponse) GetError ¶ 

func (g *GetAnswerResponse) GetError() *GetAnswerError

type GetChatApplicationRequest ¶ 

type GetChatApplicationRequest struct {
	// The id of the Chat application to be retrieved.
	ID string `json:"id"`
}

func (*GetChatApplicationRequest) GetID ¶ 

func (g *GetChatApplicationRequest) GetID() string

type GetChatApplicationResponse ¶ 

type GetChatApplicationResponse struct {
	Application any `json:"application,omitempty"`
}

func (*GetChatApplicationResponse) GetApplication ¶ 

func (g *GetChatApplicationResponse) GetApplication() any

type GetChatFilesRequest ¶ 

type GetChatFilesRequest struct {
	// IDs of files to fetch.
	FileIds []string `json:"fileIds"`
	// The ID of the chat that contains the chat file.
	ChatID *string `json:"chatId,omitempty"`
}

func (*GetChatFilesRequest) GetChatID ¶ added in v0.9.0 

func (g *GetChatFilesRequest) GetChatID() *string

func (*GetChatFilesRequest) GetFileIds ¶ 

func (g *GetChatFilesRequest) GetFileIds() []string

type GetChatFilesResponse ¶ 

type GetChatFilesResponse struct {
	// A map of file IDs to ChatFile structs.
	Files map[string]ChatFile `json:"files,omitempty"`
}

func (*GetChatFilesResponse) GetFiles ¶ 

func (g *GetChatFilesResponse) GetFiles() map[string]ChatFile

type GetChatRequest ¶ 

type GetChatRequest struct {
	// The id of the Chat to be retrieved.
	ID string `json:"id"`
}

func (*GetChatRequest) GetID ¶ 

func (g *GetChatRequest) GetID() string

type GetChatResponse ¶ 

type GetChatResponse struct {
	ChatResult *ChatResult `json:"chatResult,omitempty"`
}

func (*GetChatResponse) GetChatResult ¶ 

func (g *GetChatResponse) GetChatResult() *ChatResult

type GetCollectionRequest ¶ 

type GetCollectionRequest struct {
	// The ID of the Collection to be retrieved.
	ID int64 `json:"id"`
	// Whether or not to include the Collection Items in this Collection. Only request if absolutely required, as this is expensive.
	WithItems *bool `json:"withItems,omitempty"`
	// Whether or not to include the top level Collection in this Collection's hierarchy.
	WithHierarchy *bool `json:"withHierarchy,omitempty"`
	// The datasource allowed in the Collection returned.
	AllowedDatasource *string `json:"allowedDatasource,omitempty"`
}

func (*GetCollectionRequest) GetAllowedDatasource ¶ 

func (g *GetCollectionRequest) GetAllowedDatasource() *string

func (*GetCollectionRequest) GetID ¶ 

func (g *GetCollectionRequest) GetID() int64

func (*GetCollectionRequest) GetWithHierarchy ¶ 

func (g *GetCollectionRequest) GetWithHierarchy() *bool

func (*GetCollectionRequest) GetWithItems ¶ 

func (g *GetCollectionRequest) GetWithItems() *bool

type GetCollectionResponse ¶ 

type GetCollectionResponse struct {
	Collection     *Collection `json:"collection,omitempty"`
	RootCollection *Collection `json:"rootCollection,omitempty"`
	// An opaque token that represents this particular Collection. To be used for `/feedback` reporting.
	TrackingToken *string          `json:"trackingToken,omitempty"`
	Error         *CollectionError `json:"error,omitempty"`
}

func (*GetCollectionResponse) GetCollection ¶ 

func (g *GetCollectionResponse) GetCollection() *Collection

func (*GetCollectionResponse) GetError ¶ 

func (g *GetCollectionResponse) GetError() *CollectionError

func (*GetCollectionResponse) GetRootCollection ¶ 

func (g *GetCollectionResponse) GetRootCollection() *Collection

func (*GetCollectionResponse) GetTrackingToken ¶ 

func (g *GetCollectionResponse) GetTrackingToken() *string

type GetDatasourceConfigRequest ¶ 

type GetDatasourceConfigRequest struct {
	// Datasource name for which config is needed.
	Datasource string `json:"datasource"`
}

GetDatasourceConfigRequest - Describes the request body of the /getdatasourceconfig API call

func (*GetDatasourceConfigRequest) GetDatasource ¶ 

func (g *GetDatasourceConfigRequest) GetDatasource() string

type GetDlpReportResponse ¶ 

type GetDlpReportResponse struct {
	// Full policy information that will be used for scans.
	Report *DlpReport `json:"report,omitempty"`
}

func (*GetDlpReportResponse) GetReport ¶ 

func (g *GetDlpReportResponse) GetReport() *DlpReport

type GetDocPermissionsRequest ¶ 

type GetDocPermissionsRequest struct {
	// The Glean Document ID to retrieve permissions for.
	DocumentID *string `json:"documentId,omitempty"`
}

func (*GetDocPermissionsRequest) GetDocumentID ¶ 

func (g *GetDocPermissionsRequest) GetDocumentID() *string

type GetDocPermissionsResponse ¶ 

type GetDocPermissionsResponse struct {
	// A list of emails of users who have access to the document. If the document is visible to all Glean users, a list with only a single value of 'VISIBLE_TO_ALL'.
	AllowedUserEmails []string `json:"allowedUserEmails,omitempty"`
}

func (*GetDocPermissionsResponse) GetAllowedUserEmails ¶ 

func (g *GetDocPermissionsResponse) GetAllowedUserEmails() []string

type GetDocumentCountRequest ¶ 

type GetDocumentCountRequest struct {
	// Datasource name for which document count is needed.
	Datasource string `json:"datasource"`
}

GetDocumentCountRequest - Describes the request body of the /getdocumentcount API call

func (*GetDocumentCountRequest) GetDatasource ¶ 

func (g *GetDocumentCountRequest) GetDatasource() string

type GetDocumentCountResponse ¶ 

type GetDocumentCountResponse struct {
	// Number of documents corresponding to the specified custom datasource.
	DocumentCount *int64 `json:"documentCount,omitempty"`
}

GetDocumentCountResponse - Describes the response body of the /getdocumentcount API call

func (*GetDocumentCountResponse) GetDocumentCount ¶ 

func (g *GetDocumentCountResponse) GetDocumentCount() *int64

type GetDocumentStatusRequest ¶ 

type GetDocumentStatusRequest struct {
	// Datasource to get fetch document status for
	Datasource string `json:"datasource"`
	// Object type of the document to get the status for
	ObjectType string `json:"objectType"`
	// Glean Document ID within the datasource to get the status for.
	DocID string `json:"docId"`
}

GetDocumentStatusRequest - Describes the request body for /getdocumentstatus API call

func (*GetDocumentStatusRequest) GetDatasource ¶ 

func (g *GetDocumentStatusRequest) GetDatasource() string

func (*GetDocumentStatusRequest) GetDocID ¶ 

func (g *GetDocumentStatusRequest) GetDocID() string

func (*GetDocumentStatusRequest) GetObjectType ¶ 

func (g *GetDocumentStatusRequest) GetObjectType() string

type GetDocumentStatusResponse ¶ 

type GetDocumentStatusResponse struct {
	// Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN
	UploadStatus *string `json:"uploadStatus,omitempty"`
	// Time of last successful upload, in epoch seconds
	LastUploadedAt *int64 `json:"lastUploadedAt,omitempty"`
	// Indexing status, enum of NOT_INDEXED, INDEXED, STATUS_UNKNOWN
	IndexingStatus *string `json:"indexingStatus,omitempty"`
	// Time of last successful indexing, in epoch seconds
	LastIndexedAt *int64 `json:"lastIndexedAt,omitempty"`
}

GetDocumentStatusResponse - Describes the response body of the /getdocumentstatus API call

func (*GetDocumentStatusResponse) GetIndexingStatus ¶ 

func (g *GetDocumentStatusResponse) GetIndexingStatus() *string

func (*GetDocumentStatusResponse) GetLastIndexedAt ¶ 

func (g *GetDocumentStatusResponse) GetLastIndexedAt() *int64

func (*GetDocumentStatusResponse) GetLastUploadedAt ¶ 

func (g *GetDocumentStatusResponse) GetLastUploadedAt() *int64

func (*GetDocumentStatusResponse) GetUploadStatus ¶ 

func (g *GetDocumentStatusResponse) GetUploadStatus() *string

type GetDocumentVisibilityOverridesResponse ¶ 

type GetDocumentVisibilityOverridesResponse struct {
	VisibilityOverrides []DocumentVisibilityOverride `json:"visibilityOverrides,omitempty"`
}

func (*GetDocumentVisibilityOverridesResponse) GetVisibilityOverrides ¶ 

func (g *GetDocumentVisibilityOverridesResponse) GetVisibilityOverrides() []DocumentVisibilityOverride

type GetDocumentsByFacetsRequest ¶ 

type GetDocumentsByFacetsRequest struct {
	// Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
	DatasourcesFilter []string `json:"datasourcesFilter,omitempty"`
	// A list of facet filter sets that will be OR'ed together. An AND is assumed between different filters in each set.
	FilterSets []FacetFilterSet `json:"filterSets"`
	// Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.
	Cursor *string `json:"cursor,omitempty"`
}

func (*GetDocumentsByFacetsRequest) GetCursor ¶ 

func (g *GetDocumentsByFacetsRequest) GetCursor() *string

func (*GetDocumentsByFacetsRequest) GetDatasourcesFilter ¶ 

func (g *GetDocumentsByFacetsRequest) GetDatasourcesFilter() []string

func (*GetDocumentsByFacetsRequest) GetFilterSets ¶ 

func (g *GetDocumentsByFacetsRequest) GetFilterSets() []FacetFilterSet

type GetDocumentsByFacetsResponse ¶ 

type GetDocumentsByFacetsResponse struct {
	// The document details, ordered by score.
	Documents []Document `json:"documents,omitempty"`
	// Whether more results are available. Use cursor to retrieve them.
	HasMoreResults *bool `json:"hasMoreResults,omitempty"`
	// Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query.
	Cursor *string `json:"cursor,omitempty"`
}

func (*GetDocumentsByFacetsResponse) GetCursor ¶ 

func (g *GetDocumentsByFacetsResponse) GetCursor() *string

func (*GetDocumentsByFacetsResponse) GetDocuments ¶ 

func (g *GetDocumentsByFacetsResponse) GetDocuments() []Document

func (*GetDocumentsByFacetsResponse) GetHasMoreResults ¶ 

func (g *GetDocumentsByFacetsResponse) GetHasMoreResults() *bool

type GetDocumentsRequest ¶ 

type GetDocumentsRequest struct {
	// The specification for the documents to be retrieved.
	DocumentSpecs []DocumentSpecUnion `json:"documentSpecs"`
	// List of Document fields to return (that aren't returned by default)
	IncludeFields []GetDocumentsRequestIncludeField `json:"includeFields,omitempty"`
}

func (*GetDocumentsRequest) GetDocumentSpecs ¶ 

func (g *GetDocumentsRequest) GetDocumentSpecs() []DocumentSpecUnion

func (*GetDocumentsRequest) GetIncludeFields ¶ 

func (g *GetDocumentsRequest) GetIncludeFields() []GetDocumentsRequestIncludeField

type GetDocumentsRequestIncludeField ¶ 

type GetDocumentsRequestIncludeField string
const (
	GetDocumentsRequestIncludeFieldLastViewedAt    GetDocumentsRequestIncludeField = "LAST_VIEWED_AT"
	GetDocumentsRequestIncludeFieldVisitorsCount   GetDocumentsRequestIncludeField = "VISITORS_COUNT"
	GetDocumentsRequestIncludeFieldRecentShares    GetDocumentsRequestIncludeField = "RECENT_SHARES"
	GetDocumentsRequestIncludeFieldDocumentContent GetDocumentsRequestIncludeField = "DOCUMENT_CONTENT"
)

func (GetDocumentsRequestIncludeField) ToPointer ¶ 

func (e GetDocumentsRequestIncludeField) ToPointer() *GetDocumentsRequestIncludeField

func (*GetDocumentsRequestIncludeField) UnmarshalJSON ¶ 

func (e *GetDocumentsRequestIncludeField) UnmarshalJSON(data []byte) error

type GetDocumentsResponse ¶ 

type GetDocumentsResponse struct {
	// The document details or the error if document is not found.
	Documents map[string]DocumentOrErrorUnion `json:"documents,omitempty"`
}

func (*GetDocumentsResponse) GetDocuments ¶ 

func (g *GetDocumentsResponse) GetDocuments() map[string]DocumentOrErrorUnion

type GetPinRequest ¶ 

type GetPinRequest struct {
	// The opaque id of the pin to be fetched.
	ID *string `json:"id,omitempty"`
}

func (*GetPinRequest) GetID ¶ 

func (g *GetPinRequest) GetID() *string

type GetPinResponse ¶ 

type GetPinResponse struct {
	Pin *PinDocument `json:"pin,omitempty"`
}

func (*GetPinResponse) GetPin ¶ 

func (g *GetPinResponse) GetPin() *PinDocument

type GetShortcutRequest ¶ 

type GetShortcutRequest struct {
	// The alias for the shortcut, including any arguments for variable shortcuts.
	Alias string `json:"alias"`
}

func (*GetShortcutRequest) GetAlias ¶ 

func (g *GetShortcutRequest) GetAlias() string

func (GetShortcutRequest) MarshalJSON ¶ added in v0.9.0 

func (g GetShortcutRequest) MarshalJSON() ([]byte, error)

func (*GetShortcutRequest) UnmarshalJSON ¶ added in v0.9.0 

func (g *GetShortcutRequest) UnmarshalJSON(data []byte) error

type GetShortcutRequestUnion ¶ 

type GetShortcutRequestUnion struct {
	UserGeneratedContentID *UserGeneratedContentID `queryParam:"inline,name=GetShortcutRequest"`
	GetShortcutRequest     *GetShortcutRequest     `queryParam:"inline,name=GetShortcutRequest"`

	Type GetShortcutRequestUnionType
}

func CreateGetShortcutRequestUnionGetShortcutRequest ¶ 

func CreateGetShortcutRequestUnionGetShortcutRequest(getShortcutRequest GetShortcutRequest) GetShortcutRequestUnion

func CreateGetShortcutRequestUnionUserGeneratedContentID ¶ 

func CreateGetShortcutRequestUnionUserGeneratedContentID(userGeneratedContentID UserGeneratedContentID) GetShortcutRequestUnion

func (GetShortcutRequestUnion) MarshalJSON ¶ 

func (u GetShortcutRequestUnion) MarshalJSON() ([]byte, error)

func (*GetShortcutRequestUnion) UnmarshalJSON ¶ 

func (u *GetShortcutRequestUnion) UnmarshalJSON(data []byte) error

type GetShortcutRequestUnionType ¶ 

type GetShortcutRequestUnionType string
const (
	GetShortcutRequestUnionTypeUserGeneratedContentID GetShortcutRequestUnionType = "UserGeneratedContentId"
	GetShortcutRequestUnionTypeGetShortcutRequest     GetShortcutRequestUnionType = "GetShortcutRequest"
)

type GetShortcutResponse ¶ 

type GetShortcutResponse struct {
	Shortcut *Shortcut      `json:"shortcut,omitempty"`
	Error    *ShortcutError `json:"error,omitempty"`
}

func (*GetShortcutResponse) GetError ¶ 

func (g *GetShortcutResponse) GetError() *ShortcutError

func (*GetShortcutResponse) GetShortcut ¶ 

func (g *GetShortcutResponse) GetShortcut() *Shortcut

type GetUserCountRequest ¶ 

type GetUserCountRequest struct {
	// Datasource name for which user count is needed.
	Datasource string `json:"datasource"`
}

GetUserCountRequest - Describes the request body of the /getusercount API call

func (*GetUserCountRequest) GetDatasource ¶ 

func (g *GetUserCountRequest) GetDatasource() string

type GetUserCountResponse ¶ 

type GetUserCountResponse struct {
	// Number of users corresponding to the specified custom datasource.
	UserCount *int64 `json:"userCount,omitempty"`
}

GetUserCountResponse - Describes the response body of the /getusercount API call

func (*GetUserCountResponse) GetUserCount ¶ 

func (g *GetUserCountResponse) GetUserCount() *int64

type GleanAssistInsightsResponse ¶ 

type GleanAssistInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp *int64 `json:"lastLogTimestamp,omitempty"`
	// Insights for all active users with respect to set of actions.
	ActivityInsights []UserActivityInsight `json:"activityInsights,omitempty"`
	// Total number of active users in the requested period.
	TotalActiveUsers *int64 `json:"totalActiveUsers,omitempty"`
	// List of datasource instances for which glean assist is enabled.
	DatasourceInstances []string `json:"datasourceInstances,omitempty"`
	// List of departments applicable for users tab.
	Departments []string `json:"departments,omitempty"`
}

func (*GleanAssistInsightsResponse) GetActivityInsights ¶ 

func (g *GleanAssistInsightsResponse) GetActivityInsights() []UserActivityInsight

func (*GleanAssistInsightsResponse) GetDatasourceInstances ¶ 

func (g *GleanAssistInsightsResponse) GetDatasourceInstances() []string

func (*GleanAssistInsightsResponse) GetDepartments ¶ 

func (g *GleanAssistInsightsResponse) GetDepartments() []string

func (*GleanAssistInsightsResponse) GetLastLogTimestamp ¶ 

func (g *GleanAssistInsightsResponse) GetLastLogTimestamp() *int64

func (*GleanAssistInsightsResponse) GetTotalActiveUsers ¶ 

func (g *GleanAssistInsightsResponse) GetTotalActiveUsers() *int64

type GleanDataError ¶ 

type GleanDataError struct {
	// Indicates the gmail results could not be fetched due to bad token.
	BadGmailToken *bool `json:"badGmailToken,omitempty"`
	// Indicates the outlook results could not be fetched due to bad token.
	BadOutlookToken *bool `json:"badOutlookToken,omitempty"`
	// Indicates results could not be fetched due to invalid operators in the query.
	InvalidOperators []InvalidOperatorValueError `json:"invalidOperators,omitempty"`
	ErrorMessages    []ErrorMessage              `json:"errorMessages,omitempty"`
}

func (*GleanDataError) GetBadGmailToken ¶ 

func (g *GleanDataError) GetBadGmailToken() *bool

func (*GleanDataError) GetBadOutlookToken ¶ 

func (g *GleanDataError) GetBadOutlookToken() *bool

func (*GleanDataError) GetErrorMessages ¶ 

func (g *GleanDataError) GetErrorMessages() []ErrorMessage

func (*GleanDataError) GetInvalidOperators ¶ 

func (g *GleanDataError) GetInvalidOperators() []InvalidOperatorValueError

type GrantPermission ¶ 

type GrantPermission struct {
	// Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
	ScopeType *ScopeType `json:"scopeType,omitempty"`
}

GrantPermission - Describes the grant permission level that a user has for a specific feature

func (*GrantPermission) GetScopeType ¶ 

func (g *GrantPermission) GetScopeType() *ScopeType

func (GrantPermission) MarshalJSON ¶ added in v0.9.0 

func (g GrantPermission) MarshalJSON() ([]byte, error)

func (*GrantPermission) UnmarshalJSON ¶ added in v0.9.0 

func (g *GrantPermission) UnmarshalJSON(data []byte) error

type GrantType ¶ 

type GrantType string

GrantType - The type of grant type being used. 

const (
	GrantTypeAuthCode          GrantType = "AUTH_CODE"
	GrantTypeClientCredentials GrantType = "CLIENT_CREDENTIALS"
)

func (GrantType) ToPointer ¶ 

func (e GrantType) ToPointer() *GrantType

func (*GrantType) UnmarshalJSON ¶ 

func (e *GrantType) UnmarshalJSON(data []byte) error

type GreenlistUsersRequest ¶ 

type GreenlistUsersRequest struct {
	// Datasource which needs to be made visible to users specified in the `emails` field.
	Datasource string `json:"datasource"`
	// The emails of the beta users
	Emails []string `json:"emails"`
}

GreenlistUsersRequest - Describes the request body of the /betausers API call

func (*GreenlistUsersRequest) GetDatasource ¶ 

func (g *GreenlistUsersRequest) GetDatasource() string

func (*GreenlistUsersRequest) GetEmails ¶ 

func (g *GreenlistUsersRequest) GetEmails() []string

type Group ¶ 

type Group struct {
	// The type of user group
	Type GroupType `json:"type"`
	// A unique identifier for the group. May be the same as name.
	ID string `json:"id"`
	// Name of the group.
	Name *string `json:"name,omitempty"`
	// Datasource instance if the group belongs to one e.g. external groups.
	DatasourceInstance *string `json:"datasourceInstance,omitempty"`
	// identifier for greenlist provisioning, aka sciokey
	ProvisioningID *string `json:"provisioningId,omitempty"`
}

func (*Group) GetDatasourceInstance ¶ added in v0.9.0 

func (g *Group) GetDatasourceInstance() *string

func (*Group) GetID ¶ 

func (g *Group) GetID() string

func (*Group) GetName ¶ 

func (g *Group) GetName() *string

func (*Group) GetProvisioningID ¶ added in v0.9.0 

func (g *Group) GetProvisioningID() *string

func (*Group) GetType ¶ 

func (g *Group) GetType() GroupType

func (Group) MarshalJSON ¶ added in v0.9.0 

func (g Group) MarshalJSON() ([]byte, error)

func (*Group) UnmarshalJSON ¶ added in v0.9.0 

func (g *Group) UnmarshalJSON(data []byte) error

type GroupType ¶ 

type GroupType string

GroupType - The type of user group 

const (
	GroupTypeDepartment    GroupType = "DEPARTMENT"
	GroupTypeAll           GroupType = "ALL"
	GroupTypeTeam          GroupType = "TEAM"
	GroupTypeJobTitle      GroupType = "JOB_TITLE"
	GroupTypeRoleType      GroupType = "ROLE_TYPE"
	GroupTypeLocation      GroupType = "LOCATION"
	GroupTypeRegion        GroupType = "REGION"
	GroupTypeExternalGroup GroupType = "EXTERNAL_GROUP"
)

func (GroupType) ToPointer ¶ 

func (e GroupType) ToPointer() *GroupType

func (*GroupType) UnmarshalJSON ¶ 

func (e *GroupType) UnmarshalJSON(data []byte) error

type HTTPMetadata ¶ 

type HTTPMetadata struct {
	// Raw HTTP response; suitable for custom response parsing
	Response *http.Response `json:"-"`
	// Raw HTTP request; suitable for debugging
	Request *http.Request `json:"-"`
}

func (*HTTPMetadata) GetRequest ¶ 

func (h *HTTPMetadata) GetRequest() *http.Request

func (*HTTPMetadata) GetResponse ¶ 

func (h *HTTPMetadata) GetResponse() *http.Response

type HideBuiltInFacet ¶ 

type HideBuiltInFacet string
const (
	HideBuiltInFacetType   HideBuiltInFacet = "TYPE"
	HideBuiltInFacetTag    HideBuiltInFacet = "TAG"
	HideBuiltInFacetAuthor HideBuiltInFacet = "AUTHOR"
	HideBuiltInFacetOwner  HideBuiltInFacet = "OWNER"
)

func (HideBuiltInFacet) ToPointer ¶ 

func (e HideBuiltInFacet) ToPointer() *HideBuiltInFacet

func (*HideBuiltInFacet) UnmarshalJSON ¶ 

func (e *HideBuiltInFacet) UnmarshalJSON(data []byte) error

type Hotword ¶ 

type Hotword struct {
	Regex     *string           `json:"regex,omitempty"`
	Proximity *HotwordProximity `json:"proximity,omitempty"`
}

func (*Hotword) GetProximity ¶ 

func (h *Hotword) GetProximity() *HotwordProximity

func (*Hotword) GetRegex ¶ 

func (h *Hotword) GetRegex() *string

type HotwordProximity ¶ 

type HotwordProximity struct {
	WindowBefore *int64 `json:"windowBefore,omitempty"`
	WindowAfter  *int64 `json:"windowAfter,omitempty"`
}

func (*HotwordProximity) GetWindowAfter ¶ 

func (h *HotwordProximity) GetWindowAfter() *int64

func (*HotwordProximity) GetWindowBefore ¶ 

func (h *HotwordProximity) GetWindowBefore() *int64

type IDType ¶ 

type IDType string

IDType - Type of the id in the incoming request. 

const (
	IDTypeChannelName    IDType = "CHANNEL_NAME"
	IDTypeThreadID       IDType = "THREAD_ID"
	IDTypeConversationID IDType = "CONVERSATION_ID"
)

func (IDType) ToPointer ¶ 

func (e IDType) ToPointer() *IDType

func (*IDType) UnmarshalJSON ¶ 

func (e *IDType) UnmarshalJSON(data []byte) error

type IconConfig ¶ 

type IconConfig struct {
	GeneratedBackgroundColorKey *string   `json:"generatedBackgroundColorKey,omitempty"`
	BackgroundColor             *string   `json:"backgroundColor,omitempty"`
	Color                       *string   `json:"color,omitempty"`
	Key                         *string   `json:"key,omitempty"`
	IconType                    *IconType `json:"iconType,omitempty"`
	// Whether the icon should be masked based on current theme.
	Masked *bool `json:"masked,omitempty"`
	// The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons.
	Name *string `json:"name,omitempty"`
	// The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons.
	URL *string `json:"url,omitempty"`
}

IconConfig - Defines how to render an icon

func (*IconConfig) GetBackgroundColor ¶ 

func (i *IconConfig) GetBackgroundColor() *string

func (*IconConfig) GetColor ¶ 

func (i *IconConfig) GetColor() *string

func (*IconConfig) GetGeneratedBackgroundColorKey ¶ 

func (i *IconConfig) GetGeneratedBackgroundColorKey() *string

func (*IconConfig) GetIconType ¶ 

func (i *IconConfig) GetIconType() *IconType

func (*IconConfig) GetKey ¶ 

func (i *IconConfig) GetKey() *string

func (*IconConfig) GetMasked ¶ 

func (i *IconConfig) GetMasked() *bool

func (*IconConfig) GetName ¶ 

func (i *IconConfig) GetName() *string

func (*IconConfig) GetURL ¶ 

func (i *IconConfig) GetURL() *string

func (IconConfig) MarshalJSON ¶ added in v0.9.0 

func (i IconConfig) MarshalJSON() ([]byte, error)

func (*IconConfig) UnmarshalJSON ¶ added in v0.9.0 

func (i *IconConfig) UnmarshalJSON(data []byte) error

type IconType ¶ 

type IconType string
const (
	IconTypeCollection          IconType = "COLLECTION"
	IconTypeCustom              IconType = "CUSTOM"
	IconTypeDatasource          IconType = "DATASOURCE"
	IconTypeDatasourceInstance  IconType = "DATASOURCE_INSTANCE"
	IconTypeFavicon             IconType = "FAVICON"
	IconTypeFileType            IconType = "FILE_TYPE"
	IconTypeGeneratedBackground IconType = "GENERATED_BACKGROUND"
	IconTypeGlyph               IconType = "GLYPH"
	IconTypeMimeType            IconType = "MIME_TYPE"
	IconTypeNoIcon              IconType = "NO_ICON"
	IconTypePerson              IconType = "PERSON"
	IconTypeReactions           IconType = "REACTIONS"
	IconTypeURL                 IconType = "URL"
)

func (IconType) ToPointer ¶ 

func (e IconType) ToPointer() *IconType

func (*IconType) UnmarshalJSON ¶ 

func (e *IconType) UnmarshalJSON(data []byte) error

type Identity ¶ 

type Identity struct {
	// Information about processing history for the datasource
	ProcessingHistory []ProcessingHistoryEvent                        `json:"processingHistory,omitempty"`
	Users             *DebugDatasourceStatusIdentityResponseComponent `json:"users,omitempty"`
	Groups            *DebugDatasourceStatusIdentityResponseComponent `json:"groups,omitempty"`
	Memberships       *DebugDatasourceStatusIdentityResponseComponent `json:"memberships,omitempty"`
}

func (*Identity) GetGroups ¶ 

func (i *Identity) GetGroups() *DebugDatasourceStatusIdentityResponseComponent

func (*Identity) GetMemberships ¶ 

func (i *Identity) GetMemberships() *DebugDatasourceStatusIdentityResponseComponent

func (*Identity) GetProcessingHistory ¶ 

func (i *Identity) GetProcessingHistory() []ProcessingHistoryEvent

func (*Identity) GetUsers ¶ 

func (i *Identity) GetUsers() *DebugDatasourceStatusIdentityResponseComponent

type IncludeType ¶ 

type IncludeType string
const (
	IncludeTypePeopleWithoutManager IncludeType = "PEOPLE_WITHOUT_MANAGER"
	IncludeTypeInvalidEntities      IncludeType = "INVALID_ENTITIES"
)

func (IncludeType) ToPointer ¶ 

func (e IncludeType) ToPointer() *IncludeType

func (*IncludeType) UnmarshalJSON ¶ 

func (e *IncludeType) UnmarshalJSON(data []byte) error

type IndexDocumentRequest ¶ 

type IndexDocumentRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// Indexable document structure
	Document DocumentDefinition `json:"document"`
}

IndexDocumentRequest - Describes the request body of the /indexdocument API call

func (*IndexDocumentRequest) GetDocument ¶ 

func (i *IndexDocumentRequest) GetDocument() DocumentDefinition

func (*IndexDocumentRequest) GetVersion ¶ 

func (i *IndexDocumentRequest) GetVersion() *int64

type IndexDocumentsRequest ¶ 

type IndexDocumentsRequest struct {
	// Optional id parameter to identify and track a batch of documents.
	UploadID *string `json:"uploadId,omitempty"`
	// Datasource of the documents
	Datasource string `json:"datasource"`
	// Batch of documents being added/updated
	Documents []DocumentDefinition `json:"documents"`
}

IndexDocumentsRequest - Describes the request body of the /indexdocuments API call

func (*IndexDocumentsRequest) GetDatasource ¶ 

func (i *IndexDocumentsRequest) GetDatasource() string

func (*IndexDocumentsRequest) GetDocuments ¶ 

func (i *IndexDocumentsRequest) GetDocuments() []DocumentDefinition

func (*IndexDocumentsRequest) GetUploadID ¶ 

func (i *IndexDocumentsRequest) GetUploadID() *string

type IndexEmployeeRequest ¶ 

type IndexEmployeeRequest struct {
	// Describes employee info
	Employee EmployeeInfoDefinition `json:"employee"`
	// Version number for the employee object. If absent or 0 then no version checks are done
	Version *int64 `json:"version,omitempty"`
}

IndexEmployeeRequest - Info about an employee and optional version for that info

func (*IndexEmployeeRequest) GetEmployee ¶ 

func (i *IndexEmployeeRequest) GetEmployee() EmployeeInfoDefinition

func (*IndexEmployeeRequest) GetVersion ¶ 

func (i *IndexEmployeeRequest) GetVersion() *int64

type IndexGroupRequest ¶ 

type IndexGroupRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The datasource for which the group is added
	Datasource string `json:"datasource"`
	// describes a group in the datasource
	Group DatasourceGroupDefinition `json:"group"`
}

IndexGroupRequest - Describes the request body of the /indexgroup API call

func (*IndexGroupRequest) GetDatasource ¶ 

func (i *IndexGroupRequest) GetDatasource() string

func (*IndexGroupRequest) GetGroup ¶ 

func (i *IndexGroupRequest) GetGroup() DatasourceGroupDefinition

func (*IndexGroupRequest) GetVersion ¶ 

func (i *IndexGroupRequest) GetVersion() *int64

type IndexMembershipRequest ¶ 

type IndexMembershipRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The datasource for which the membership is added
	Datasource string `json:"datasource"`
	// describes the membership row of a group. Only one of memberUserId and memberGroupName can be specified.
	Membership DatasourceMembershipDefinition `json:"membership"`
}

IndexMembershipRequest - Describes the request body of the /indexmembership API call

func (*IndexMembershipRequest) GetDatasource ¶ 

func (i *IndexMembershipRequest) GetDatasource() string

func (*IndexMembershipRequest) GetMembership ¶ 

func (i *IndexMembershipRequest) GetMembership() DatasourceMembershipDefinition

func (*IndexMembershipRequest) GetVersion ¶ 

func (i *IndexMembershipRequest) GetVersion() *int64

type IndexStatus ¶ 

type IndexStatus struct {
	// When the document was last crawled
	LastCrawledTime *time.Time `json:"lastCrawledTime,omitempty"`
	// When the document was last indexed
	LastIndexedTime *time.Time `json:"lastIndexedTime,omitempty"`
}

func (*IndexStatus) GetLastCrawledTime ¶ 

func (i *IndexStatus) GetLastCrawledTime() *time.Time

func (*IndexStatus) GetLastIndexedTime ¶ 

func (i *IndexStatus) GetLastIndexedTime() *time.Time

func (IndexStatus) MarshalJSON ¶ 

func (i IndexStatus) MarshalJSON() ([]byte, error)

func (*IndexStatus) UnmarshalJSON ¶ 

func (i *IndexStatus) UnmarshalJSON(data []byte) error

type IndexTeamRequest ¶ 

type IndexTeamRequest struct {
	// Information about an employee's team
	Team TeamInfoDefinition `json:"team"`
	// Version number for the team object. If absent or 0 then no version checks are done
	Version *int64 `json:"version,omitempty"`
}

IndexTeamRequest - Info about a team and optional version for that info

func (*IndexTeamRequest) GetTeam ¶ 

func (i *IndexTeamRequest) GetTeam() TeamInfoDefinition

func (*IndexTeamRequest) GetVersion ¶ 

func (i *IndexTeamRequest) GetVersion() *int64

type IndexUserRequest ¶ 

type IndexUserRequest struct {
	// Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
	Version *int64 `json:"version,omitempty"`
	// The datasource for which the user is added
	Datasource string `json:"datasource"`
	// describes a user in the datasource
	User DatasourceUserDefinition `json:"user"`
}

IndexUserRequest - Describes the request body of the /indexuser API call

func (*IndexUserRequest) GetDatasource ¶ 

func (i *IndexUserRequest) GetDatasource() string

func (*IndexUserRequest) GetUser ¶ 

func (i *IndexUserRequest) GetUser() DatasourceUserDefinition

func (*IndexUserRequest) GetVersion ¶ 

func (i *IndexUserRequest) GetVersion() *int64

type IndexingShortcut ¶ 

type IndexingShortcut struct {
	// link text following the viewPrefix as entered by the user. For example, if the view prefix is `go/` and the shortened URL is `go/abc`, then `abc` is the inputAlias.
	InputAlias string `json:"inputAlias"`
	// A short, plain text blurb to help people understand the intent of the shortcut.
	Description *string `json:"description,omitempty"`
	// destination URL for the shortcut.
	DestinationURL string `json:"destinationUrl"`
	// Email of the user who created this shortcut.
	CreatedBy string `json:"createdBy"`
	// The time the shortcut was created in epoch seconds.
	CreateTime *int64 `json:"createTime,omitempty"`
	// Email of the user who last updated this shortcut.
	UpdatedBy *string `json:"updatedBy,omitempty"`
	// The time the shortcut was updated in epoch seconds.
	UpdateTime *int64 `json:"updateTime,omitempty"`
	// Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author and admins only.
	Unlisted *bool `json:"unlisted,omitempty"`
	// For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL.
	URLTemplate *string `json:"urlTemplate,omitempty"`
}

func (*IndexingShortcut) GetCreateTime ¶ 

func (i *IndexingShortcut) GetCreateTime() *int64

func (*IndexingShortcut) GetCreatedBy ¶ 

func (i *IndexingShortcut) GetCreatedBy() string

func (*IndexingShortcut) GetDescription ¶ 

func (i *IndexingShortcut) GetDescription() *string

func (*IndexingShortcut) GetDestinationURL ¶ 

func (i *IndexingShortcut) GetDestinationURL() string

func (*IndexingShortcut) GetInputAlias ¶ 

func (i *IndexingShortcut) GetInputAlias() string

func (*IndexingShortcut) GetURLTemplate ¶ 

func (i *IndexingShortcut) GetURLTemplate() *string

func (*IndexingShortcut) GetUnlisted ¶ 

func (i *IndexingShortcut) GetUnlisted() *bool

func (*IndexingShortcut) GetUpdateTime ¶ 

func (i *IndexingShortcut) GetUpdateTime() *int64

func (*IndexingShortcut) GetUpdatedBy ¶ 

func (i *IndexingShortcut) GetUpdatedBy() *string

type InputOptions ¶ 

type InputOptions struct {
	// list of url regex matching documents excluded from report
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	URLGreenlist []string `json:"urlGreenlist,omitempty"`
	// The types of datasource for which to run the report/policy.
	DatasourcesType *DatasourcesType `json:"datasourcesType,omitempty"`
	// List of datasources to consider for report. DEPRECATED - use datasourceInstances instead.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Datasources []string `json:"datasources,omitempty"`
	// List of datasource instances to consider for report/policy.
	DatasourceInstances []string `json:"datasourceInstances,omitempty"`
	// Type of time period for which to run the report/policy. PAST_DAY is deprecated.
	TimePeriodType  *TimePeriodType `json:"timePeriodType,omitempty"`
	CustomTimeRange *TimeRange      `json:"customTimeRange,omitempty"`
}

InputOptions - Controls which data-sources and what time-range to include in scans.

func (*InputOptions) GetCustomTimeRange ¶ 

func (i *InputOptions) GetCustomTimeRange() *TimeRange

func (*InputOptions) GetDatasourceInstances ¶ 

func (i *InputOptions) GetDatasourceInstances() []string

func (*InputOptions) GetDatasources ¶ 

func (i *InputOptions) GetDatasources() []string

func (*InputOptions) GetDatasourcesType ¶ 

func (i *InputOptions) GetDatasourcesType() *DatasourcesType

func (*InputOptions) GetTimePeriodType ¶ 

func (i *InputOptions) GetTimePeriodType() *TimePeriodType

func (*InputOptions) GetURLGreenlist ¶ 

func (i *InputOptions) GetURLGreenlist() []string

type InputSchema ¶ 

type InputSchema struct {
}

InputSchema - The schema for the agent input. In JSON Schema format.

type InsightsAgentsRequestOptions ¶ 

type InsightsAgentsRequestOptions struct {
	// IDs of the Agents for which Insights should be returned. An empty array signifies all.
	AgentIds []string `json:"agentIds,omitempty"`
}

func (*InsightsAgentsRequestOptions) GetAgentIds ¶ 

func (i *InsightsAgentsRequestOptions) GetAgentIds() []string

type InsightsAiAppRequestOptions ¶ 

type InsightsAiAppRequestOptions struct {
	// IDs of the AI Apps for which Insights should be returned. An empty array signifies all.
	AiAppIds []string `json:"aiAppIds,omitempty"`
}

func (*InsightsAiAppRequestOptions) GetAiAppIds ¶ 

func (i *InsightsAiAppRequestOptions) GetAiAppIds() []string

type InsightsAssistantRequest ¶ added in v0.9.3 

type InsightsAssistantRequest struct {
	// Departments for which Insights are requested.
	Departments []string `json:"departments,omitempty"`
	DayRange    *Period  `json:"dayRange,omitempty"`
}

func (*InsightsAssistantRequest) GetDayRange ¶ added in v0.9.3 

func (i *InsightsAssistantRequest) GetDayRange() *Period

func (*InsightsAssistantRequest) GetDepartments ¶ added in v0.9.3 

func (i *InsightsAssistantRequest) GetDepartments() []string

type InsightsOverviewRequest ¶ added in v0.9.3 

type InsightsOverviewRequest struct {
	// Departments for which Insights are requested.
	Departments []string `json:"departments,omitempty"`
	DayRange    *Period  `json:"dayRange,omitempty"`
}

func (*InsightsOverviewRequest) GetDayRange ¶ added in v0.9.3 

func (i *InsightsOverviewRequest) GetDayRange() *Period

func (*InsightsOverviewRequest) GetDepartments ¶ added in v0.9.3 

func (i *InsightsOverviewRequest) GetDepartments() []string

type InsightsRequest ¶ 

type InsightsRequest struct {
	OverviewRequest  *InsightsOverviewRequest  `json:"overviewRequest,omitempty"`
	AssistantRequest *InsightsAssistantRequest `json:"assistantRequest,omitempty"`
	AgentsRequest    *AgentsInsightsV2Request  `json:"agentsRequest,omitempty"`
	// If true, suppresses the generation of per-user Insights in the response. Default is false.
	DisablePerUserInsights *bool `json:"disablePerUserInsights,omitempty"`
	// Categories of data requested. Request can include single or multiple types.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Categories []InsightsRequestCategory `json:"categories,omitempty"`
	// Departments that the data is requested for. If this is empty, corresponds to whole company.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Departments          []string                      `json:"departments,omitempty"`
	DayRange             *Period                       `json:"dayRange,omitempty"`
	AiAppRequestOptions  *InsightsAiAppRequestOptions  `json:"aiAppRequestOptions,omitempty"`
	AgentsRequestOptions *InsightsAgentsRequestOptions `json:"agentsRequestOptions,omitempty"`
	// Types of activity that should count in the definition of an Assistant Active User. Affects only insights for AI category.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	AssistantActivityTypes []AssistantActivityType `json:"assistantActivityTypes,omitempty"`
}

func (*InsightsRequest) GetAgentsRequest ¶ added in v0.9.3 

func (i *InsightsRequest) GetAgentsRequest() *AgentsInsightsV2Request

func (*InsightsRequest) GetAgentsRequestOptions ¶ 

func (i *InsightsRequest) GetAgentsRequestOptions() *InsightsAgentsRequestOptions

func (*InsightsRequest) GetAiAppRequestOptions ¶ 

func (i *InsightsRequest) GetAiAppRequestOptions() *InsightsAiAppRequestOptions

func (*InsightsRequest) GetAssistantActivityTypes ¶ 

func (i *InsightsRequest) GetAssistantActivityTypes() []AssistantActivityType

func (*InsightsRequest) GetAssistantRequest ¶ added in v0.9.3 

func (i *InsightsRequest) GetAssistantRequest() *InsightsAssistantRequest

func (*InsightsRequest) GetCategories ¶ 

func (i *InsightsRequest) GetCategories() []InsightsRequestCategory

func (*InsightsRequest) GetDayRange ¶ 

func (i *InsightsRequest) GetDayRange() *Period

func (*InsightsRequest) GetDepartments ¶ 

func (i *InsightsRequest) GetDepartments() []string

func (*InsightsRequest) GetDisablePerUserInsights ¶ 

func (i *InsightsRequest) GetDisablePerUserInsights() *bool

func (*InsightsRequest) GetOverviewRequest ¶ added in v0.9.3 

func (i *InsightsRequest) GetOverviewRequest() *InsightsOverviewRequest

type InsightsRequestCategory ¶ 

type InsightsRequestCategory string
const (
	InsightsRequestCategoryAgents                  InsightsRequestCategory = "AGENTS"
	InsightsRequestCategoryAgentUsers              InsightsRequestCategory = "AGENT_USERS"
	InsightsRequestCategoryTopAgents               InsightsRequestCategory = "TOP_AGENTS"
	InsightsRequestCategoryAgentsUsageByDepartment InsightsRequestCategory = "AGENTS_USAGE_BY_DEPARTMENT"
	InsightsRequestCategoryAi                      InsightsRequestCategory = "AI"
	InsightsRequestCategoryAiApps                  InsightsRequestCategory = "AI_APPS"
	InsightsRequestCategoryAnnouncements           InsightsRequestCategory = "ANNOUNCEMENTS"
	InsightsRequestCategoryAnswers                 InsightsRequestCategory = "ANSWERS"
	InsightsRequestCategoryCollections             InsightsRequestCategory = "COLLECTIONS"
	InsightsRequestCategoryContent                 InsightsRequestCategory = "CONTENT"
	InsightsRequestCategoryGleanAssist             InsightsRequestCategory = "GLEAN_ASSIST"
	InsightsRequestCategoryQueries                 InsightsRequestCategory = "QUERIES"
	InsightsRequestCategoryShortcuts               InsightsRequestCategory = "SHORTCUTS"
	InsightsRequestCategoryUsers                   InsightsRequestCategory = "USERS"
)

func (InsightsRequestCategory) ToPointer ¶ 

func (e InsightsRequestCategory) ToPointer() *InsightsRequestCategory

func (*InsightsRequestCategory) UnmarshalJSON ¶ 

func (e *InsightsRequestCategory) UnmarshalJSON(data []byte) error

type InsightsResponse ¶ 

type InsightsResponse struct {
	// List of timeseries to make charts (if applicable).
	Timeseries    []LabeledCountInfo           `json:"timeseries,omitempty"`
	Users         *UserInsightsResponse        `json:"users,omitempty"`
	Content       *ContentInsightsResponse     `json:"content,omitempty"`
	Queries       *QueryInsightsResponse       `json:"queries,omitempty"`
	Collections   *ContentInsightsResponse     `json:"collections,omitempty"`
	CollectionsV2 *ContentInsightsResponse     `json:"collectionsV2,omitempty"`
	Shortcuts     *ShortcutInsightsResponse    `json:"shortcuts,omitempty"`
	Announcements *ContentInsightsResponse     `json:"announcements,omitempty"`
	Answers       *ContentInsightsResponse     `json:"answers,omitempty"`
	Ai            *AiInsightsResponse          `json:"ai,omitempty"`
	AiApps        *AiAppsInsightsResponse      `json:"aiApps,omitempty"`
	GleanAssist   *GleanAssistInsightsResponse `json:"gleanAssist,omitempty"`
	// list of all departments.
	Departments []string `json:"departments,omitempty"`
}

func (*InsightsResponse) GetAi ¶ 

func (i *InsightsResponse) GetAi() *AiInsightsResponse

func (*InsightsResponse) GetAiApps ¶ 

func (i *InsightsResponse) GetAiApps() *AiAppsInsightsResponse

func (*InsightsResponse) GetAnnouncements ¶ 

func (i *InsightsResponse) GetAnnouncements() *ContentInsightsResponse

func (*InsightsResponse) GetAnswers ¶ 

func (i *InsightsResponse) GetAnswers() *ContentInsightsResponse

func (*InsightsResponse) GetCollections ¶ 

func (i *InsightsResponse) GetCollections() *ContentInsightsResponse

func (*InsightsResponse) GetCollectionsV2 ¶ 

func (i *InsightsResponse) GetCollectionsV2() *ContentInsightsResponse

func (*InsightsResponse) GetContent ¶ 

func (i *InsightsResponse) GetContent() *ContentInsightsResponse

func (*InsightsResponse) GetDepartments ¶ 

func (i *InsightsResponse) GetDepartments() []string

func (*InsightsResponse) GetGleanAssist ¶ 

func (i *InsightsResponse) GetGleanAssist() *GleanAssistInsightsResponse

func (*InsightsResponse) GetQueries ¶ 

func (i *InsightsResponse) GetQueries() *QueryInsightsResponse

func (*InsightsResponse) GetShortcuts ¶ 

func (i *InsightsResponse) GetShortcuts() *ShortcutInsightsResponse

func (*InsightsResponse) GetTimeseries ¶ 

func (i *InsightsResponse) GetTimeseries() []LabeledCountInfo

func (*InsightsResponse) GetUsers ¶ 

func (i *InsightsResponse) GetUsers() *UserInsightsResponse

type InvalidOperatorValueError ¶ 

type InvalidOperatorValueError struct {
	// The operator key that has an invalid value.
	Key *string `json:"key,omitempty"`
	// The invalid operator value.
	Value *string `json:"value,omitempty"`
}

func (*InvalidOperatorValueError) GetKey ¶ 

func (i *InvalidOperatorValueError) GetKey() *string

func (*InvalidOperatorValueError) GetValue ¶ 

func (i *InvalidOperatorValueError) GetValue() *string

type InviteInfo ¶ 

type InviteInfo struct {
	// The time this person signed up in ISO format (ISO 8601).
	SignUpTime *time.Time `json:"signUpTime,omitempty"`
	// Latest invites received by the user for each channel
	Invites []ChannelInviteInfo `json:"invites,omitempty"`
	Inviter *Person             `json:"inviter,omitempty"`
	// The time this person was invited in ISO format (ISO 8601).
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	InviteTime *time.Time `json:"inviteTime,omitempty"`
	// The time this person was reminded in ISO format (ISO 8601) if a reminder was sent.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	ReminderTime *time.Time `json:"reminderTime,omitempty"`
}

InviteInfo - Information regarding the invite status of a person.

func (*InviteInfo) GetInviteTime ¶ 

func (i *InviteInfo) GetInviteTime() *time.Time

func (*InviteInfo) GetInviter ¶ 

func (i *InviteInfo) GetInviter() *Person

func (*InviteInfo) GetInvites ¶ 

func (i *InviteInfo) GetInvites() []ChannelInviteInfo

func (*InviteInfo) GetReminderTime ¶ 

func (i *InviteInfo) GetReminderTime() *time.Time

func (*InviteInfo) GetSignUpTime ¶ 

func (i *InviteInfo) GetSignUpTime() *time.Time

func (InviteInfo) MarshalJSON ¶ 

func (i InviteInfo) MarshalJSON() ([]byte, error)

func (*InviteInfo) UnmarshalJSON ¶ 

func (i *InviteInfo) UnmarshalJSON(data []byte) error

type Issue ¶ 

type Issue string
const (
	IssueInaccurateResponse    Issue = "INACCURATE_RESPONSE"
	IssueIncompleteOrNoAnswer  Issue = "INCOMPLETE_OR_NO_ANSWER"
	IssueIncorrectCitation     Issue = "INCORRECT_CITATION"
	IssueMissingCitation       Issue = "MISSING_CITATION"
	IssueOther                 Issue = "OTHER"
	IssueOutdatedResponse      Issue = "OUTDATED_RESPONSE"
	IssueResultMissing         Issue = "RESULT_MISSING"
	IssueResultShouldNotAppear Issue = "RESULT_SHOULD_NOT_APPEAR"
	IssueResultsHelpful        Issue = "RESULTS_HELPFUL"
	IssueResultsPoorOrder      Issue = "RESULTS_POOR_ORDER"
	IssueTooMuchOneKind        Issue = "TOO_MUCH_ONE_KIND"
)

func (Issue) ToPointer ¶ 

func (e Issue) ToPointer() *Issue

func (*Issue) UnmarshalJSON ¶ 

func (e *Issue) UnmarshalJSON(data []byte) error

type JustificationType ¶ 

type JustificationType string

JustificationType - Type of the justification. 

const (
	JustificationTypeFrequentlyAccessed                JustificationType = "FREQUENTLY_ACCESSED"
	JustificationTypeRecentlyAccessed                  JustificationType = "RECENTLY_ACCESSED"
	JustificationTypeTrendingDocument                  JustificationType = "TRENDING_DOCUMENT"
	JustificationTypeVerificationReminder              JustificationType = "VERIFICATION_REMINDER"
	JustificationTypeSuggestedDocument                 JustificationType = "SUGGESTED_DOCUMENT"
	JustificationTypeEmptyStateSuggestion              JustificationType = "EMPTY_STATE_SUGGESTION"
	JustificationTypeFrecencyScored                    JustificationType = "FRECENCY_SCORED"
	JustificationTypeServerGenerated                   JustificationType = "SERVER_GENERATED"
	JustificationTypeUseCase                           JustificationType = "USE_CASE"
	JustificationTypeUpdateSinceLastView               JustificationType = "UPDATE_SINCE_LAST_VIEW"
	JustificationTypeRecentlyStarted                   JustificationType = "RECENTLY_STARTED"
	JustificationTypeEvent                             JustificationType = "EVENT"
	JustificationTypeUserMention                       JustificationType = "USER_MENTION"
	JustificationTypeAnnouncement                      JustificationType = "ANNOUNCEMENT"
	JustificationTypeExternalAnnouncement              JustificationType = "EXTERNAL_ANNOUNCEMENT"
	JustificationTypePopularityBasedTrending           JustificationType = "POPULARITY_BASED_TRENDING"
	JustificationTypeCompanyResource                   JustificationType = "COMPANY_RESOURCE"
	JustificationTypeEventDocumentFromContent          JustificationType = "EVENT_DOCUMENT_FROM_CONTENT"
	JustificationTypeEventDocumentFromSearch           JustificationType = "EVENT_DOCUMENT_FROM_SEARCH"
	JustificationTypeVisitAffinityScored               JustificationType = "VISIT_AFFINITY_SCORED"
	JustificationTypeSuggestedApp                      JustificationType = "SUGGESTED_APP"
	JustificationTypeSuggestedPerson                   JustificationType = "SUGGESTED_PERSON"
	JustificationTypeActivityHighlight                 JustificationType = "ACTIVITY_HIGHLIGHT"
	JustificationTypeSavedSearch                       JustificationType = "SAVED_SEARCH"
	JustificationTypeSuggestedChannel                  JustificationType = "SUGGESTED_CHANNEL"
	JustificationTypePeopleCelebrations                JustificationType = "PEOPLE_CELEBRATIONS"
	JustificationTypeSocialLink                        JustificationType = "SOCIAL_LINK"
	JustificationTypeZeroStateChatSuggestion           JustificationType = "ZERO_STATE_CHAT_SUGGESTION"
	JustificationTypeZeroStateChatToolSuggestion       JustificationType = "ZERO_STATE_CHAT_TOOL_SUGGESTION"
	JustificationTypeZeroStatePromptTemplateSuggestion JustificationType = "ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION"
	JustificationTypeZeroStateStaticWorkflowSuggestion JustificationType = "ZERO_STATE_STATIC_WORKFLOW_SUGGESTION"
	JustificationTypeZeroStateAgentSuggestion          JustificationType = "ZERO_STATE_AGENT_SUGGESTION"
	JustificationTypePersonalizedChatSuggestion        JustificationType = "PERSONALIZED_CHAT_SUGGESTION"
	JustificationTypeDailyDigest                       JustificationType = "DAILY_DIGEST"
)

func (JustificationType) ToPointer ¶ 

func (e JustificationType) ToPointer() *JustificationType

func (*JustificationType) UnmarshalJSON ¶ 

func (e *JustificationType) UnmarshalJSON(data []byte) error

type KnowledgeType ¶ 

type KnowledgeType string

KnowledgeType - Indicates the kind of knowledge a tool would access or modify. 

const (
	KnowledgeTypeNeutralKnowledge KnowledgeType = "NEUTRAL_KNOWLEDGE"
	KnowledgeTypeCompanyKnowledge KnowledgeType = "COMPANY_KNOWLEDGE"
	KnowledgeTypeWorldKnowledge   KnowledgeType = "WORLD_KNOWLEDGE"
)

func (KnowledgeType) ToPointer ¶ 

func (e KnowledgeType) ToPointer() *KnowledgeType

func (*KnowledgeType) UnmarshalJSON ¶ 

func (e *KnowledgeType) UnmarshalJSON(data []byte) error

type LabeledCountInfo ¶ 

type LabeledCountInfo struct {
	// Label for the included count information.
	Label string `json:"label"`
	// List of data points for counts for a given date period.
	CountInfo []CountInfo `json:"countInfo,omitempty"`
}

func (*LabeledCountInfo) GetCountInfo ¶ 

func (l *LabeledCountInfo) GetCountInfo() []CountInfo

func (*LabeledCountInfo) GetLabel ¶ 

func (l *LabeledCountInfo) GetLabel() string

type LastScanStatus ¶ 

type LastScanStatus string
const (
	LastScanStatusPending    LastScanStatus = "PENDING"
	LastScanStatusSuccess    LastScanStatus = "SUCCESS"
	LastScanStatusFailure    LastScanStatus = "FAILURE"
	LastScanStatusCancelled  LastScanStatus = "CANCELLED"
	LastScanStatusCancelling LastScanStatus = "CANCELLING"
	LastScanStatusActive     LastScanStatus = "ACTIVE"
)

func (LastScanStatus) ToPointer ¶ 

func (e LastScanStatus) ToPointer() *LastScanStatus

func (*LastScanStatus) UnmarshalJSON ¶ 

func (e *LastScanStatus) UnmarshalJSON(data []byte) error

type LikelihoodThreshold deprecated 

type LikelihoodThreshold string

LikelihoodThreshold

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible. 

const (
	LikelihoodThresholdLikely     LikelihoodThreshold = "LIKELY"
	LikelihoodThresholdVeryLikely LikelihoodThreshold = "VERY_LIKELY"
)

func (LikelihoodThreshold) ToPointer ¶ 

func (e LikelihoodThreshold) ToPointer() *LikelihoodThreshold

func (*LikelihoodThreshold) UnmarshalJSON ¶ 

func (e *LikelihoodThreshold) UnmarshalJSON(data []byte) error

type ListAnswersRequest ¶ 

type ListAnswersRequest struct {
	// The Answer Board Id to list answers on.
	BoardID *int64 `json:"boardId,omitempty"`
}

func (*ListAnswersRequest) GetBoardID ¶ 

func (l *ListAnswersRequest) GetBoardID() *int64

type ListAnswersResponse ¶ 

type ListAnswersResponse struct {
	// List of answers with tracking tokens.
	AnswerResults []AnswerResult `json:"answerResults"`
}

func (*ListAnswersResponse) GetAnswerResults ¶ 

func (l *ListAnswersResponse) GetAnswerResults() []AnswerResult

type ListChatsResponse ¶ 

type ListChatsResponse struct {
	ChatResults []ChatMetadataResult `json:"chatResults,omitempty"`
}

func (*ListChatsResponse) GetChatResults ¶ 

func (l *ListChatsResponse) GetChatResults() []ChatMetadataResult

type ListCollectionsRequest ¶ 

type ListCollectionsRequest struct {
	// Whether to include the audience filters with the listed Collections.
	IncludeAudience *bool `json:"includeAudience,omitempty"`
	// Whether to include the editor roles with the listed Collections.
	IncludeRoles *bool `json:"includeRoles,omitempty"`
	// The datasource type this Collection can hold.
	// ANSWERS - for Collections representing answer boards
	AllowedDatasource *string `json:"allowedDatasource,omitempty"`
}

func (*ListCollectionsRequest) GetAllowedDatasource ¶ 

func (l *ListCollectionsRequest) GetAllowedDatasource() *string

func (*ListCollectionsRequest) GetIncludeAudience ¶ 

func (l *ListCollectionsRequest) GetIncludeAudience() *bool

func (*ListCollectionsRequest) GetIncludeRoles ¶ 

func (l *ListCollectionsRequest) GetIncludeRoles() *bool

type ListCollectionsResponse ¶ 

type ListCollectionsResponse struct {
	// List of all Collections, no Collection items are fetched.
	Collections []Collection `json:"collections"`
}

func (*ListCollectionsResponse) GetCollections ¶ 

func (l *ListCollectionsResponse) GetCollections() []Collection

type ListDlpReportsResponse ¶ 

type ListDlpReportsResponse struct {
	Reports []DlpReport `json:"reports,omitempty"`
}

func (*ListDlpReportsResponse) GetReports ¶ 

func (l *ListDlpReportsResponse) GetReports() []DlpReport

type ListEntitiesRequest ¶ 

type ListEntitiesRequest struct {
	Filter []FacetFilter `json:"filter,omitempty"`
	// Use EntitiesSortOrder enum for SortOptions.sortBy
	Sort       []SortOptions                  `json:"sort,omitempty"`
	EntityType *ListEntitiesRequestEntityType `default:"PEOPLE" json:"entityType"`
	// The datasource associated with the entity type, most commonly used with CUSTOM_ENTITIES
	Datasource *string `json:"datasource,omitempty"`
	// A query string to search for entities that each entity in the response must conform to. An empty query does not filter any entities.
	Query *string `json:"query,omitempty"`
	// List of entity fields to return (that aren't returned by default)
	IncludeFields []ListEntitiesRequestIncludeField `json:"includeFields,omitempty"`
	// Hint to the server about how many results to send back. Server may return less.
	PageSize *int64 `json:"pageSize,omitempty"`
	// Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.
	Cursor *string `json:"cursor,omitempty"`
	// A string denoting the search surface from which the endpoint is called.
	Source *string `json:"source,omitempty"`
	// The type of request being made.
	RequestType *RequestType `default:"STANDARD" json:"requestType"`
}

func (*ListEntitiesRequest) GetCursor ¶ 

func (l *ListEntitiesRequest) GetCursor() *string

func (*ListEntitiesRequest) GetDatasource ¶ 

func (l *ListEntitiesRequest) GetDatasource() *string

func (*ListEntitiesRequest) GetEntityType ¶ 

func (l *ListEntitiesRequest) GetEntityType() *ListEntitiesRequestEntityType

func (*ListEntitiesRequest) GetFilter ¶ 

func (l *ListEntitiesRequest) GetFilter() []FacetFilter

func (*ListEntitiesRequest) GetIncludeFields ¶ 

func (l *ListEntitiesRequest) GetIncludeFields() []ListEntitiesRequestIncludeField

func (*ListEntitiesRequest) GetPageSize ¶ 

func (l *ListEntitiesRequest) GetPageSize() *int64

func (*ListEntitiesRequest) GetQuery ¶ 

func (l *ListEntitiesRequest) GetQuery() *string

func (*ListEntitiesRequest) GetRequestType ¶ added in v0.7.0 

func (l *ListEntitiesRequest) GetRequestType() *RequestType

func (*ListEntitiesRequest) GetSort ¶ 

func (l *ListEntitiesRequest) GetSort() []SortOptions

func (*ListEntitiesRequest) GetSource ¶ 

func (l *ListEntitiesRequest) GetSource() *string

func (ListEntitiesRequest) MarshalJSON ¶ 

func (l ListEntitiesRequest) MarshalJSON() ([]byte, error)

func (*ListEntitiesRequest) UnmarshalJSON ¶ 

func (l *ListEntitiesRequest) UnmarshalJSON(data []byte) error

type ListEntitiesRequestEntityType ¶ 

type ListEntitiesRequestEntityType string
const (
	ListEntitiesRequestEntityTypePeople         ListEntitiesRequestEntityType = "PEOPLE"
	ListEntitiesRequestEntityTypeTeams          ListEntitiesRequestEntityType = "TEAMS"
	ListEntitiesRequestEntityTypeCustomEntities ListEntitiesRequestEntityType = "CUSTOM_ENTITIES"
)

func (ListEntitiesRequestEntityType) ToPointer ¶ 

func (e ListEntitiesRequestEntityType) ToPointer() *ListEntitiesRequestEntityType

func (*ListEntitiesRequestEntityType) UnmarshalJSON ¶ 

func (e *ListEntitiesRequestEntityType) UnmarshalJSON(data []byte) error

type ListEntitiesRequestIncludeField ¶ 

type ListEntitiesRequestIncludeField string
const (
	ListEntitiesRequestIncludeFieldPeople            ListEntitiesRequestIncludeField = "PEOPLE"
	ListEntitiesRequestIncludeFieldTeams             ListEntitiesRequestIncludeField = "TEAMS"
	ListEntitiesRequestIncludeFieldPeopleDistance    ListEntitiesRequestIncludeField = "PEOPLE_DISTANCE"
	ListEntitiesRequestIncludeFieldPermissions       ListEntitiesRequestIncludeField = "PERMISSIONS"
	ListEntitiesRequestIncludeFieldFacets            ListEntitiesRequestIncludeField = "FACETS"
	ListEntitiesRequestIncludeFieldInviteInfo        ListEntitiesRequestIncludeField = "INVITE_INFO"
	ListEntitiesRequestIncludeFieldLastExtensionUse  ListEntitiesRequestIncludeField = "LAST_EXTENSION_USE"
	ListEntitiesRequestIncludeFieldManagementDetails ListEntitiesRequestIncludeField = "MANAGEMENT_DETAILS"
	ListEntitiesRequestIncludeFieldUnprocessedTeams  ListEntitiesRequestIncludeField = "UNPROCESSED_TEAMS"
)

func (ListEntitiesRequestIncludeField) ToPointer ¶ 

func (e ListEntitiesRequestIncludeField) ToPointer() *ListEntitiesRequestIncludeField

func (*ListEntitiesRequestIncludeField) UnmarshalJSON ¶ 

func (e *ListEntitiesRequestIncludeField) UnmarshalJSON(data []byte) error

type ListEntitiesResponse ¶ 

type ListEntitiesResponse struct {
	Results             []Person       `json:"results,omitempty"`
	TeamResults         []Team         `json:"teamResults,omitempty"`
	CustomEntityResults []CustomEntity `json:"customEntityResults,omitempty"`
	FacetResults        []FacetResult  `json:"facetResults,omitempty"`
	// Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.
	Cursor *string `json:"cursor,omitempty"`
	// The total number of entities available
	TotalCount *int64 `json:"totalCount,omitempty"`
	// Whether or not more entities can be fetched.
	HasMoreResults *bool `json:"hasMoreResults,omitempty"`
	// Sort options from EntitiesSortOrder supported for this response. Default is empty list.
	SortOptions []EntitiesSortOrder `json:"sortOptions,omitempty"`
	// list of Person attributes that are custom setup by deployment
	CustomFacetNames []string `json:"customFacetNames,omitempty"`
}

func (*ListEntitiesResponse) GetCursor ¶ 

func (l *ListEntitiesResponse) GetCursor() *string

func (*ListEntitiesResponse) GetCustomEntityResults ¶ 

func (l *ListEntitiesResponse) GetCustomEntityResults() []CustomEntity

func (*ListEntitiesResponse) GetCustomFacetNames ¶ 

func (l *ListEntitiesResponse) GetCustomFacetNames() []string

func (*ListEntitiesResponse) GetFacetResults ¶ 

func (l *ListEntitiesResponse) GetFacetResults() []FacetResult

func (*ListEntitiesResponse) GetHasMoreResults ¶ 

func (l *ListEntitiesResponse) GetHasMoreResults() *bool

func (*ListEntitiesResponse) GetResults ¶ 

func (l *ListEntitiesResponse) GetResults() []Person

func (*ListEntitiesResponse) GetSortOptions ¶ 

func (l *ListEntitiesResponse) GetSortOptions() []EntitiesSortOrder

func (*ListEntitiesResponse) GetTeamResults ¶ 

func (l *ListEntitiesResponse) GetTeamResults() []Team

func (*ListEntitiesResponse) GetTotalCount ¶ 

func (l *ListEntitiesResponse) GetTotalCount() *int64

type ListPinsResponse ¶ 

type ListPinsResponse struct {
	// List of pinned documents.
	Pins []PinDocument `json:"pins"`
}

func (*ListPinsResponse) GetPins ¶ 

func (l *ListPinsResponse) GetPins() []PinDocument

type ListShortcutsPaginatedRequest ¶ 

type ListShortcutsPaginatedRequest struct {
	// Array of fields/data to be included in response that are not included by default
	IncludeFields []ListShortcutsPaginatedRequestIncludeField `json:"includeFields,omitempty"`
	PageSize      int64                                       `json:"pageSize"`
	// A token specifying the position in the overall results to start at. Received from the endpoint and iterated back. Currently being used as page no (as we implement offset pagination)
	Cursor *string `json:"cursor,omitempty"`
	// A list of filters for the query. An AND is assumed between different filters. We support filters on Go Link name, author, department and type.
	Filters []FacetFilter `json:"filters,omitempty"`
	Sort    *SortOptions  `json:"sort,omitempty"`
	// Search query that should be a substring in atleast one of the fields (alias , inputAlias, destinationUrl, description). Empty query does not filter shortcuts.
	Query *string `json:"query,omitempty"`
}

func (*ListShortcutsPaginatedRequest) GetCursor ¶ 

func (l *ListShortcutsPaginatedRequest) GetCursor() *string

func (*ListShortcutsPaginatedRequest) GetFilters ¶ 

func (l *ListShortcutsPaginatedRequest) GetFilters() []FacetFilter

func (*ListShortcutsPaginatedRequest) GetIncludeFields ¶ 

func (l *ListShortcutsPaginatedRequest) GetIncludeFields() []ListShortcutsPaginatedRequestIncludeField

func (*ListShortcutsPaginatedRequest) GetPageSize ¶ 

func (l *ListShortcutsPaginatedRequest) GetPageSize() int64

func (*ListShortcutsPaginatedRequest) GetQuery ¶ 

func (l *ListShortcutsPaginatedRequest) GetQuery() *string

func (*ListShortcutsPaginatedRequest) GetSort ¶ 

func (l *ListShortcutsPaginatedRequest) GetSort() *SortOptions

type ListShortcutsPaginatedRequestIncludeField ¶ 

type ListShortcutsPaginatedRequestIncludeField string
const (
	ListShortcutsPaginatedRequestIncludeFieldFacets        ListShortcutsPaginatedRequestIncludeField = "FACETS"
	ListShortcutsPaginatedRequestIncludeFieldPeopleDetails ListShortcutsPaginatedRequestIncludeField = "PEOPLE_DETAILS"
)

func (ListShortcutsPaginatedRequestIncludeField) ToPointer ¶ 

func (e ListShortcutsPaginatedRequestIncludeField) ToPointer() *ListShortcutsPaginatedRequestIncludeField

func (*ListShortcutsPaginatedRequestIncludeField) UnmarshalJSON ¶ 

func (e *ListShortcutsPaginatedRequestIncludeField) UnmarshalJSON(data []byte) error

type ListShortcutsPaginatedResponse ¶ 

type ListShortcutsPaginatedResponse struct {
	// List of all shortcuts accessible to the user
	Shortcuts    []Shortcut                  `json:"shortcuts"`
	FacetResults []FacetResult               `json:"facetResults,omitempty"`
	Meta         ShortcutsPaginationMetadata `json:"meta"`
}

func (*ListShortcutsPaginatedResponse) GetFacetResults ¶ 

func (l *ListShortcutsPaginatedResponse) GetFacetResults() []FacetResult

func (*ListShortcutsPaginatedResponse) GetMeta ¶ 

func (l *ListShortcutsPaginatedResponse) GetMeta() ShortcutsPaginationMetadata

func (*ListShortcutsPaginatedResponse) GetShortcuts ¶ 

func (l *ListShortcutsPaginatedResponse) GetShortcuts() []Shortcut

type ManualFeedbackInfo ¶ 

type ManualFeedbackInfo struct {
	// The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Email *string `json:"email,omitempty"`
	// The source associated with the Feedback.event.MANUAL_FEEDBACK event.
	Source *ManualFeedbackInfoSource `json:"source,omitempty"`
	// The issue the user indicated in the feedback.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Issue *string `json:"issue,omitempty"`
	// The issue(s) the user indicated in the feedback.
	Issues []Issue `json:"issues,omitempty"`
	// URLs of images uploaded by user when providing feedback
	ImageUrls []string `json:"imageUrls,omitempty"`
	// The query associated with the Feedback.event.MANUAL_FEEDBACK event.
	Query *string `json:"query,omitempty"`
	// The query associated with the Feedback.event.MANUAL_FEEDBACK event, but obscured such that the vowels are replaced with special characters. For search feedback events only.
	ObscuredQuery *string `json:"obscuredQuery,omitempty"`
	// Which tabs the user had chosen at the time of the Feedback.event.MANUAL_FEEDBACK event. For search feedback events only.
	ActiveTab *string `json:"activeTab,omitempty"`
	// The comments users can optionally add to the Feedback.event.MANUAL_FEEDBACK events.
	Comments *string `json:"comments,omitempty"`
	// The array of search result Glean Document IDs, ordered by top to bottom result.
	SearchResults []string `json:"searchResults,omitempty"`
	// The array of previous messages in a chat session, ordered by oldest to newest.
	PreviousMessages []string `json:"previousMessages,omitempty"`
	// Array of previous request/response exchanges, ordered by oldest to newest.
	ChatTranscript []FeedbackChatExchange `json:"chatTranscript,omitempty"`
	// How many times this query has been run in the past.
	NumQueriesFromFirstRun *int64 `json:"numQueriesFromFirstRun,omitempty"`
	// The vote associated with the Feedback.event.MANUAL_FEEDBACK event.
	Vote *ManualFeedbackInfoVote `json:"vote,omitempty"`
	// A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive.
	Rating *int64 `json:"rating,omitempty"`
	// A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied".
	RatingKey *string `json:"ratingKey,omitempty"`
	// The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2.
	RatingScale *int64 `json:"ratingScale,omitempty"`
}

func (*ManualFeedbackInfo) GetActiveTab ¶ 

func (m *ManualFeedbackInfo) GetActiveTab() *string

func (*ManualFeedbackInfo) GetChatTranscript ¶ 

func (m *ManualFeedbackInfo) GetChatTranscript() []FeedbackChatExchange

func (*ManualFeedbackInfo) GetComments ¶ 

func (m *ManualFeedbackInfo) GetComments() *string

func (*ManualFeedbackInfo) GetEmail ¶ 

func (m *ManualFeedbackInfo) GetEmail() *string

func (*ManualFeedbackInfo) GetImageUrls ¶ 

func (m *ManualFeedbackInfo) GetImageUrls() []string

func (*ManualFeedbackInfo) GetIssue ¶ 

func (m *ManualFeedbackInfo) GetIssue() *string

func (*ManualFeedbackInfo) GetIssues ¶ 

func (m *ManualFeedbackInfo) GetIssues() []Issue

func (*ManualFeedbackInfo) GetNumQueriesFromFirstRun ¶ 

func (m *ManualFeedbackInfo) GetNumQueriesFromFirstRun() *int64

func (*ManualFeedbackInfo) GetObscuredQuery ¶ 

func (m *ManualFeedbackInfo) GetObscuredQuery() *string

func (*ManualFeedbackInfo) GetPreviousMessages ¶ 

func (m *ManualFeedbackInfo) GetPreviousMessages() []string

func (*ManualFeedbackInfo) GetQuery ¶ 

func (m *ManualFeedbackInfo) GetQuery() *string

func (*ManualFeedbackInfo) GetRating ¶ 

func (m *ManualFeedbackInfo) GetRating() *int64

func (*ManualFeedbackInfo) GetRatingKey ¶ 

func (m *ManualFeedbackInfo) GetRatingKey() *string

func (*ManualFeedbackInfo) GetRatingScale ¶ 

func (m *ManualFeedbackInfo) GetRatingScale() *int64

func (*ManualFeedbackInfo) GetSearchResults ¶ 

func (m *ManualFeedbackInfo) GetSearchResults() []string

func (*ManualFeedbackInfo) GetSource ¶ 

func (m *ManualFeedbackInfo) GetSource() *ManualFeedbackInfoSource

func (*ManualFeedbackInfo) GetVote ¶ 

func (m *ManualFeedbackInfo) GetVote() *ManualFeedbackInfoVote

type ManualFeedbackInfoSource ¶ 

type ManualFeedbackInfoSource string

ManualFeedbackInfoSource - The source associated with the Feedback.event.MANUAL_FEEDBACK event. 

const (
	ManualFeedbackInfoSourceAutocomplete       ManualFeedbackInfoSource = "AUTOCOMPLETE"
	ManualFeedbackInfoSourceCalendar           ManualFeedbackInfoSource = "CALENDAR"
	ManualFeedbackInfoSourceChat               ManualFeedbackInfoSource = "CHAT"
	ManualFeedbackInfoSourceChatGeneral        ManualFeedbackInfoSource = "CHAT_GENERAL"
	ManualFeedbackInfoSourceConceptCard        ManualFeedbackInfoSource = "CONCEPT_CARD"
	ManualFeedbackInfoSourceDesktopApp         ManualFeedbackInfoSource = "DESKTOP_APP"
	ManualFeedbackInfoSourceDisambiguationCard ManualFeedbackInfoSource = "DISAMBIGUATION_CARD"
	ManualFeedbackInfoSourceExpertDetection    ManualFeedbackInfoSource = "EXPERT_DETECTION"
	ManualFeedbackInfoSourceFeed               ManualFeedbackInfoSource = "FEED"
	ManualFeedbackInfoSourceGeneratedQAndA     ManualFeedbackInfoSource = "GENERATED_Q_AND_A"
	ManualFeedbackInfoSourceInlineMenu         ManualFeedbackInfoSource = "INLINE_MENU"
	ManualFeedbackInfoSourceNativeResult       ManualFeedbackInfoSource = "NATIVE_RESULT"
	ManualFeedbackInfoSourceQAndA              ManualFeedbackInfoSource = "Q_AND_A"
	ManualFeedbackInfoSourceRelatedQuestions   ManualFeedbackInfoSource = "RELATED_QUESTIONS"
	ManualFeedbackInfoSourceReportIssue        ManualFeedbackInfoSource = "REPORT_ISSUE"
	ManualFeedbackInfoSourceSciobot            ManualFeedbackInfoSource = "SCIOBOT"
	ManualFeedbackInfoSourceSearch             ManualFeedbackInfoSource = "SEARCH"
	ManualFeedbackInfoSourceSidebar            ManualFeedbackInfoSource = "SIDEBAR"
	ManualFeedbackInfoSourceSummary            ManualFeedbackInfoSource = "SUMMARY"
	ManualFeedbackInfoSourceTasks              ManualFeedbackInfoSource = "TASKS"
)

func (ManualFeedbackInfoSource) ToPointer ¶ 

func (e ManualFeedbackInfoSource) ToPointer() *ManualFeedbackInfoSource

func (*ManualFeedbackInfoSource) UnmarshalJSON ¶ 

func (e *ManualFeedbackInfoSource) UnmarshalJSON(data []byte) error

type ManualFeedbackInfoVote ¶ added in v0.8.0 

type ManualFeedbackInfoVote string

ManualFeedbackInfoVote - The vote associated with the Feedback.event.MANUAL_FEEDBACK event. 

const (
	ManualFeedbackInfoVoteUpvote   ManualFeedbackInfoVote = "UPVOTE"
	ManualFeedbackInfoVoteDownvote ManualFeedbackInfoVote = "DOWNVOTE"
)

func (ManualFeedbackInfoVote) ToPointer ¶ added in v0.8.0 

func (e ManualFeedbackInfoVote) ToPointer() *ManualFeedbackInfoVote

func (*ManualFeedbackInfoVote) UnmarshalJSON ¶ added in v0.8.0 

func (e *ManualFeedbackInfoVote) UnmarshalJSON(data []byte) error

type ManualFeedbackSideBySideInfo ¶ added in v0.8.0 

type ManualFeedbackSideBySideInfo struct {
	// The email address of the user who submitted the side-by-side feedback.
	Email *string `json:"email,omitempty"`
	// The source associated with the side-by-side feedback event.
	Source *ManualFeedbackSideBySideInfoSource `json:"source,omitempty"`
	// The query or prompt that was evaluated across multiple implementations.
	Query *string `json:"query,omitempty"`
	// Array of implementations that were compared side-by-side.
	Implementations []SideBySideImplementation `json:"implementations,omitempty"`
	// Unique identifier for this evaluation session to group related feedback events.
	EvaluationSessionID *string `json:"evaluationSessionId,omitempty"`
	// The ID of the implementation this specific feedback event is for.
	ImplementationID *string `json:"implementationId,omitempty"`
	// The vote for this specific implementation.
	Vote *ManualFeedbackSideBySideInfoVote `json:"vote,omitempty"`
	// Specific feedback comments for this implementation.
	Comments *string `json:"comments,omitempty"`
}

func (*ManualFeedbackSideBySideInfo) GetComments ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetComments() *string

func (*ManualFeedbackSideBySideInfo) GetEmail ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetEmail() *string

func (*ManualFeedbackSideBySideInfo) GetEvaluationSessionID ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetEvaluationSessionID() *string

func (*ManualFeedbackSideBySideInfo) GetImplementationID ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetImplementationID() *string

func (*ManualFeedbackSideBySideInfo) GetImplementations ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetImplementations() []SideBySideImplementation

func (*ManualFeedbackSideBySideInfo) GetQuery ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetQuery() *string

func (*ManualFeedbackSideBySideInfo) GetSource ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetSource() *ManualFeedbackSideBySideInfoSource

func (*ManualFeedbackSideBySideInfo) GetVote ¶ added in v0.8.0 

func (m *ManualFeedbackSideBySideInfo) GetVote() *ManualFeedbackSideBySideInfoVote

type ManualFeedbackSideBySideInfoSource ¶ added in v0.8.0 

type ManualFeedbackSideBySideInfoSource string

ManualFeedbackSideBySideInfoSource - The source associated with the side-by-side feedback event. 

const (
	ManualFeedbackSideBySideInfoSourceLiveEval ManualFeedbackSideBySideInfoSource = "LIVE_EVAL"
	ManualFeedbackSideBySideInfoSourceChat     ManualFeedbackSideBySideInfoSource = "CHAT"
	ManualFeedbackSideBySideInfoSourceSearch   ManualFeedbackSideBySideInfoSource = "SEARCH"
)

func (ManualFeedbackSideBySideInfoSource) ToPointer ¶ added in v0.8.0 

func (e ManualFeedbackSideBySideInfoSource) ToPointer() *ManualFeedbackSideBySideInfoSource

func (*ManualFeedbackSideBySideInfoSource) UnmarshalJSON ¶ added in v0.8.0 

func (e *ManualFeedbackSideBySideInfoSource) UnmarshalJSON(data []byte) error

type ManualFeedbackSideBySideInfoVote ¶ added in v0.8.0 

type ManualFeedbackSideBySideInfoVote string

ManualFeedbackSideBySideInfoVote - The vote for this specific implementation. 

const (
	ManualFeedbackSideBySideInfoVoteUpvote   ManualFeedbackSideBySideInfoVote = "UPVOTE"
	ManualFeedbackSideBySideInfoVoteDownvote ManualFeedbackSideBySideInfoVote = "DOWNVOTE"
	ManualFeedbackSideBySideInfoVoteNeutral  ManualFeedbackSideBySideInfoVote = "NEUTRAL"
)

func (ManualFeedbackSideBySideInfoVote) ToPointer ¶ added in v0.8.0 

func (e ManualFeedbackSideBySideInfoVote) ToPointer() *ManualFeedbackSideBySideInfoVote

func (*ManualFeedbackSideBySideInfoVote) UnmarshalJSON ¶ added in v0.8.0 

func (e *ManualFeedbackSideBySideInfoVote) UnmarshalJSON(data []byte) error

type Meeting ¶ 

type Meeting struct {
	ID          *string            `json:"id,omitempty"`
	Title       *string            `json:"title,omitempty"`
	Description *string            `json:"description,omitempty"`
	URL         *string            `json:"url,omitempty"`
	StartTime   *time.Time         `json:"startTime,omitempty"`
	EndTime     *time.Time         `json:"endTime,omitempty"`
	Attendees   *CalendarAttendees `json:"attendees,omitempty"`
}

func (*Meeting) GetAttendees ¶ 

func (m *Meeting) GetAttendees() *CalendarAttendees

func (*Meeting) GetDescription ¶ 

func (m *Meeting) GetDescription() *string

func (*Meeting) GetEndTime ¶ 

func (m *Meeting) GetEndTime() *time.Time

func (*Meeting) GetID ¶ 

func (m *Meeting) GetID() *string

func (*Meeting) GetStartTime ¶ 

func (m *Meeting) GetStartTime() *time.Time

func (*Meeting) GetTitle ¶ 

func (m *Meeting) GetTitle() *string

func (*Meeting) GetURL ¶ 

func (m *Meeting) GetURL() *string

func (Meeting) MarshalJSON ¶ 

func (m Meeting) MarshalJSON() ([]byte, error)

func (*Meeting) UnmarshalJSON ¶ 

func (m *Meeting) UnmarshalJSON(data []byte) error

type Message ¶ 

type Message struct {
	// The role of the message.
	Role *string `json:"role,omitempty"`
	// The content of the message.
	Content []MessageTextBlock `json:"content,omitempty"`
}

func (*Message) GetContent ¶ 

func (m *Message) GetContent() []MessageTextBlock

func (*Message) GetRole ¶ 

func (m *Message) GetRole() *string

type MessageTextBlock ¶ 

type MessageTextBlock struct {
	Text string      `json:"text"`
	Type ContentType `json:"type"`
}

func (*MessageTextBlock) GetText ¶ 

func (m *MessageTextBlock) GetText() string

func (*MessageTextBlock) GetType ¶ 

func (m *MessageTextBlock) GetType() ContentType

type MessageType ¶ 

type MessageType string

MessageType - Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified. 

const (
	MessageTypeUpdate        MessageType = "UPDATE"
	MessageTypeContent       MessageType = "CONTENT"
	MessageTypeContext       MessageType = "CONTEXT"
	MessageTypeDebug         MessageType = "DEBUG"
	MessageTypeDebugExternal MessageType = "DEBUG_EXTERNAL"
	MessageTypeError         MessageType = "ERROR"
	MessageTypeHeading       MessageType = "HEADING"
	MessageTypeWarning       MessageType = "WARNING"
	MessageTypeServerTool    MessageType = "SERVER_TOOL"
)

func (MessageType) ToPointer ¶ 

func (e MessageType) ToPointer() *MessageType

func (*MessageType) UnmarshalJSON ¶ 

func (e *MessageType) UnmarshalJSON(data []byte) error

type MessagesRequest ¶ 

type MessagesRequest struct {
	// Type of the id in the incoming request.
	IDType IDType `json:"idType"`
	// ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID.
	ID string `json:"id"`
	// Id for the for the workspace in case of multiple workspaces.
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id.
	Direction *Direction `json:"direction,omitempty"`
	// Timestamp in millis of the reference message. Only applicable when using a message_id.
	TimestampMillis *int64 `json:"timestampMillis,omitempty"`
	// Whether to include root message in response.
	IncludeRootMessage *bool `json:"includeRootMessage,omitempty"`
	// The type of the data source. Missing field defaults to SLACK.
	Datasource *Datasource `json:"datasource,omitempty"`
	// The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances.
	DatasourceInstanceDisplayName *string `json:"datasourceInstanceDisplayName,omitempty"`
}

func (*MessagesRequest) GetDatasource ¶ 

func (m *MessagesRequest) GetDatasource() *Datasource

func (*MessagesRequest) GetDatasourceInstanceDisplayName ¶ 

func (m *MessagesRequest) GetDatasourceInstanceDisplayName() *string

func (*MessagesRequest) GetDirection ¶ 

func (m *MessagesRequest) GetDirection() *Direction

func (*MessagesRequest) GetID ¶ 

func (m *MessagesRequest) GetID() string

func (*MessagesRequest) GetIDType ¶ 

func (m *MessagesRequest) GetIDType() IDType

func (*MessagesRequest) GetIncludeRootMessage ¶ 

func (m *MessagesRequest) GetIncludeRootMessage() *bool

func (*MessagesRequest) GetTimestampMillis ¶ 

func (m *MessagesRequest) GetTimestampMillis() *int64

func (*MessagesRequest) GetWorkspaceID ¶ 

func (m *MessagesRequest) GetWorkspaceID() *string

type MessagesResponse ¶ 

type MessagesResponse struct {
	// Whether there are more results for client to continue requesting.
	HasMore        bool            `json:"hasMore"`
	SearchResponse *SearchResponse `json:"searchResponse,omitempty"`
	RootMessage    *SearchResult   `json:"rootMessage,omitempty"`
}

func (*MessagesResponse) GetHasMore ¶ 

func (m *MessagesResponse) GetHasMore() bool

func (*MessagesResponse) GetRootMessage ¶ 

func (m *MessagesResponse) GetRootMessage() *SearchResult

func (*MessagesResponse) GetSearchResponse ¶ 

func (m *MessagesResponse) GetSearchResponse() *SearchResponse

type Mode ¶ 

type Mode string

Mode - Top level modes to run GleanChat in. 

const (
	ModeDefault Mode = "DEFAULT"
	ModeQuick   Mode = "QUICK"
)

func (Mode) ToPointer ¶ 

func (e Mode) ToPointer() *Mode

func (*Mode) UnmarshalJSON ¶ 

func (e *Mode) UnmarshalJSON(data []byte) error

type ObjectDefinition ¶ 

type ObjectDefinition struct {
	// Unique identifier for this `DocumentMetadata.objectType`. If omitted, this definition is used as a default for all unmatched `DocumentMetadata.objectType`s in this datasource.
	Name *string `json:"name,omitempty"`
	// The user-friendly name of the object for display.
	DisplayLabel *string `json:"displayLabel,omitempty"`
	// The document category of this object type.
	DocCategory         *DocCategory         `json:"docCategory,omitempty"`
	PropertyDefinitions []PropertyDefinition `json:"propertyDefinitions,omitempty"`
	// A list of `PropertyGroup`s belonging to this object type, which will group properties to be displayed together in the UI.
	PropertyGroups []PropertyGroup `json:"propertyGroups,omitempty"`
	// Whether or not the object is summarizable
	Summarizable *bool `json:"summarizable,omitempty"`
}

ObjectDefinition - The definition for an `DocumentMetadata.objectType` within a datasource.

func (*ObjectDefinition) GetDisplayLabel ¶ 

func (o *ObjectDefinition) GetDisplayLabel() *string

func (*ObjectDefinition) GetDocCategory ¶ 

func (o *ObjectDefinition) GetDocCategory() *DocCategory

func (*ObjectDefinition) GetName ¶ 

func (o *ObjectDefinition) GetName() *string

func (*ObjectDefinition) GetPropertyDefinitions ¶ 

func (o *ObjectDefinition) GetPropertyDefinitions() []PropertyDefinition

func (*ObjectDefinition) GetPropertyGroups ¶ 

func (o *ObjectDefinition) GetPropertyGroups() []PropertyGroup

func (*ObjectDefinition) GetSummarizable ¶ 

func (o *ObjectDefinition) GetSummarizable() *bool

type ObjectPermissions ¶ 

type ObjectPermissions struct {
	// Describes the write permissions levels that a user has for a specific feature
	Write *WritePermission `json:"write,omitempty"`
}

func (*ObjectPermissions) GetWrite ¶ 

func (o *ObjectPermissions) GetWrite() *WritePermission

func (ObjectPermissions) MarshalJSON ¶ added in v0.9.0 

func (o ObjectPermissions) MarshalJSON() ([]byte, error)

func (*ObjectPermissions) UnmarshalJSON ¶ added in v0.9.0 

func (o *ObjectPermissions) UnmarshalJSON(data []byte) error

type OperatorMetadata ¶ 

type OperatorMetadata struct {
	Name string `json:"name"`
	// Whether this operator is supported by default or something that was created within a workplace app (e.g. custom jira field).
	IsCustom     *bool           `json:"isCustom,omitempty"`
	OperatorType *OperatorType   `json:"operatorType,omitempty"`
	HelpText     *string         `json:"helpText,omitempty"`
	Scopes       []OperatorScope `json:"scopes,omitempty"`
	// Raw/canonical value of the operator. Only applies when result is an operator value.
	Value *string `json:"value,omitempty"`
	// Human readable value of the operator that can be shown to the user. Only applies when result is an operator value.
	DisplayValue *string `json:"displayValue,omitempty"`
}

func (*OperatorMetadata) GetDisplayValue ¶ 

func (o *OperatorMetadata) GetDisplayValue() *string

func (*OperatorMetadata) GetHelpText ¶ 

func (o *OperatorMetadata) GetHelpText() *string

func (*OperatorMetadata) GetIsCustom ¶ 

func (o *OperatorMetadata) GetIsCustom() *bool

func (*OperatorMetadata) GetName ¶ 

func (o *OperatorMetadata) GetName() string

func (*OperatorMetadata) GetOperatorType ¶ 

func (o *OperatorMetadata) GetOperatorType() *OperatorType

func (*OperatorMetadata) GetScopes ¶ 

func (o *OperatorMetadata) GetScopes() []OperatorScope

func (*OperatorMetadata) GetValue ¶ 

func (o *OperatorMetadata) GetValue() *string

type OperatorScope ¶ 

type OperatorScope struct {
	Datasource *string `json:"datasource,omitempty"`
	DocType    *string `json:"docType,omitempty"`
}

func (*OperatorScope) GetDatasource ¶ 

func (o *OperatorScope) GetDatasource() *string

func (*OperatorScope) GetDocType ¶ 

func (o *OperatorScope) GetDocType() *string

type OperatorType ¶ 

type OperatorType string
const (
	OperatorTypeText   OperatorType = "TEXT"
	OperatorTypeDouble OperatorType = "DOUBLE"
	OperatorTypeDate   OperatorType = "DATE"
	OperatorTypeUser   OperatorType = "USER"
)

func (OperatorType) ToPointer ¶ 

func (e OperatorType) ToPointer() *OperatorType

func (*OperatorType) UnmarshalJSON ¶ 

func (e *OperatorType) UnmarshalJSON(data []byte) error

type OrderBy ¶ 

type OrderBy string
const (
	OrderByAsc  OrderBy = "ASC"
	OrderByDesc OrderBy = "DESC"
)

func (OrderBy) ToPointer ¶ 

func (e OrderBy) ToPointer() *OrderBy

func (*OrderBy) UnmarshalJSON ¶ 

func (e *OrderBy) UnmarshalJSON(data []byte) error

type OutputSchema ¶ 

type OutputSchema struct {
}

OutputSchema - The schema for the agent output. In JSON Schema format.

type PeopleRequest ¶ 

type PeopleRequest struct {
	// The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
	TimezoneOffset *int64 `json:"timezoneOffset,omitempty"`
	// The Person IDs to retrieve. If no IDs are requested, the current user's details are returned.
	ObfuscatedIds []string `json:"obfuscatedIds,omitempty"`
	// The email IDs to retrieve. The result is the deduplicated union of emailIds and obfuscatedIds.
	EmailIds []string `json:"emailIds,omitempty"`
	// List of PersonMetadata fields to return (that aren't returned by default)
	IncludeFields []PeopleRequestIncludeField `json:"includeFields,omitempty"`
	// The types of people entities to include in the response in addition to those returned by default.
	IncludeTypes []IncludeType `json:"includeTypes,omitempty"`
	// A string denoting the search surface from which the endpoint is called.
	Source *string `json:"source,omitempty"`
}

func (*PeopleRequest) GetEmailIds ¶ 

func (p *PeopleRequest) GetEmailIds() []string

func (*PeopleRequest) GetIncludeFields ¶ 

func (p *PeopleRequest) GetIncludeFields() []PeopleRequestIncludeField

func (*PeopleRequest) GetIncludeTypes ¶ 

func (p *PeopleRequest) GetIncludeTypes() []IncludeType

func (*PeopleRequest) GetObfuscatedIds ¶ 

func (p *PeopleRequest) GetObfuscatedIds() []string

func (*PeopleRequest) GetSource ¶ 

func (p *PeopleRequest) GetSource() *string

func (*PeopleRequest) GetTimezoneOffset ¶ 

func (p *PeopleRequest) GetTimezoneOffset() *int64

type PeopleRequestIncludeField ¶ 

type PeopleRequestIncludeField string
const (
	PeopleRequestIncludeFieldBadges                PeopleRequestIncludeField = "BADGES"
	PeopleRequestIncludeFieldBusyEvents            PeopleRequestIncludeField = "BUSY_EVENTS"
	PeopleRequestIncludeFieldDocumentActivity      PeopleRequestIncludeField = "DOCUMENT_ACTIVITY"
	PeopleRequestIncludeFieldInviteInfo            PeopleRequestIncludeField = "INVITE_INFO"
	PeopleRequestIncludeFieldPeopleDistance        PeopleRequestIncludeField = "PEOPLE_DISTANCE"
	PeopleRequestIncludeFieldPermissions           PeopleRequestIncludeField = "PERMISSIONS"
	PeopleRequestIncludeFieldPeopleDetails         PeopleRequestIncludeField = "PEOPLE_DETAILS"
	PeopleRequestIncludeFieldManagementDetails     PeopleRequestIncludeField = "MANAGEMENT_DETAILS"
	PeopleRequestIncludeFieldPeopleProfileSettings PeopleRequestIncludeField = "PEOPLE_PROFILE_SETTINGS"
	PeopleRequestIncludeFieldPeopleWithoutManager  PeopleRequestIncludeField = "PEOPLE_WITHOUT_MANAGER"
)

func (PeopleRequestIncludeField) ToPointer ¶ 

func (e PeopleRequestIncludeField) ToPointer() *PeopleRequestIncludeField

func (*PeopleRequestIncludeField) UnmarshalJSON ¶ 

func (e *PeopleRequestIncludeField) UnmarshalJSON(data []byte) error

type PeopleResponse ¶ 

type PeopleResponse struct {
	// A Person for each ID in the request, each with PersonMetadata populated.
	Results []Person `json:"results,omitempty"`
	// A list of documents related to this people response. This is only included if DOCUMENT_ACTIVITY is requested and only 1 person is included in the request.
	RelatedDocuments []RelatedDocuments `json:"relatedDocuments,omitempty"`
	// A list of IDs that could not be found.
	Errors []string `json:"errors,omitempty"`
}

func (*PeopleResponse) GetErrors ¶ 

func (p *PeopleResponse) GetErrors() []string

func (*PeopleResponse) GetRelatedDocuments ¶ 

func (p *PeopleResponse) GetRelatedDocuments() []RelatedDocuments

func (*PeopleResponse) GetResults ¶ 

func (p *PeopleResponse) GetResults() []Person

type Period ¶ 

type Period struct {
	// DEPRECATED - The number of days from now in the past to define upper boundary of time period.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	MinDaysFromNow *int64 `json:"minDaysFromNow,omitempty"`
	// DEPRECATED - The number of days from now in the past to define lower boundary of time period.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	MaxDaysFromNow *int64     `json:"maxDaysFromNow,omitempty"`
	Start          *TimePoint `json:"start,omitempty"`
	End            *TimePoint `json:"end,omitempty"`
}

func (*Period) GetEnd ¶ 

func (p *Period) GetEnd() *TimePoint

func (*Period) GetMaxDaysFromNow ¶ 

func (p *Period) GetMaxDaysFromNow() *int64

func (*Period) GetMinDaysFromNow ¶ 

func (p *Period) GetMinDaysFromNow() *int64

func (*Period) GetStart ¶ 

func (p *Period) GetStart() *TimePoint

func (Period) MarshalJSON ¶ added in v0.9.0 

func (p Period) MarshalJSON() ([]byte, error)

func (*Period) UnmarshalJSON ¶ added in v0.9.0 

func (p *Period) UnmarshalJSON(data []byte) error

type Permissions ¶ 

type Permissions struct {
	// TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch
	CanAdminSearch *bool `json:"canAdminSearch,omitempty"`
	// TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope
	CanAdminClientAPIGlobalTokens *bool `json:"canAdminClientApiGlobalTokens,omitempty"`
	// TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features
	CanDlp *bool `json:"canDlp,omitempty"`
	// Describes the read permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
	Read map[string][]ReadPermission `json:"read,omitempty"`
	// Describes the write permissions levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
	Write map[string][]WritePermission `json:"write,omitempty"`
	// Describes the grant permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
	Grant map[string][]GrantPermission `json:"grant,omitempty"`
	// The roleId of the canonical role a user has. The displayName is equal to the roleId.
	Role *string `json:"role,omitempty"`
	// The roleIds of the roles a user has.
	Roles []string `json:"roles,omitempty"`
}

Permissions - Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.

func (*Permissions) GetCanAdminClientAPIGlobalTokens ¶ 

func (p *Permissions) GetCanAdminClientAPIGlobalTokens() *bool

func (*Permissions) GetCanAdminSearch ¶ 

func (p *Permissions) GetCanAdminSearch() *bool

func (*Permissions) GetCanDlp ¶ 

func (p *Permissions) GetCanDlp() *bool

func (*Permissions) GetGrant ¶ 

func (p *Permissions) GetGrant() map[string][]GrantPermission

func (*Permissions) GetRead ¶ 

func (p *Permissions) GetRead() map[string][]ReadPermission

func (*Permissions) GetRole ¶ 

func (p *Permissions) GetRole() *string

func (*Permissions) GetRoles ¶ 

func (p *Permissions) GetRoles() []string

func (*Permissions) GetWrite ¶ 

func (p *Permissions) GetWrite() map[string][]WritePermission

func (Permissions) MarshalJSON ¶ added in v0.9.0 

func (p Permissions) MarshalJSON() ([]byte, error)

func (*Permissions) UnmarshalJSON ¶ added in v0.9.0 

func (p *Permissions) UnmarshalJSON(data []byte) error

type PermissionsGroupIntersectionDefinition ¶ 

type PermissionsGroupIntersectionDefinition struct {
	RequiredGroups []string `json:"requiredGroups,omitempty"`
}

PermissionsGroupIntersectionDefinition - describes a list of groups that are all required in a permissions constraint

func (*PermissionsGroupIntersectionDefinition) GetRequiredGroups ¶ 

func (p *PermissionsGroupIntersectionDefinition) GetRequiredGroups() []string

type Person ¶ 

type Person struct {
	// The display name.
	Name string `json:"name"`
	// An opaque identifier that can be used to request metadata for a Person.
	ObfuscatedID string `json:"obfuscatedId"`
	// A list of documents related to this person.
	RelatedDocuments []RelatedDocuments `json:"relatedDocuments,omitempty"`
	Metadata         *PersonMetadata    `json:"metadata,omitempty"`
}

func (*Person) GetMetadata ¶ 

func (p *Person) GetMetadata() *PersonMetadata

func (*Person) GetName ¶ 

func (p *Person) GetName() string

func (*Person) GetObfuscatedID ¶ 

func (p *Person) GetObfuscatedID() string

func (*Person) GetRelatedDocuments ¶ 

func (p *Person) GetRelatedDocuments() []RelatedDocuments

func (Person) MarshalJSON ¶ added in v0.9.0 

func (p Person) MarshalJSON() ([]byte, error)

func (*Person) UnmarshalJSON ¶ added in v0.9.0 

func (p *Person) UnmarshalJSON(data []byte) error

type PersonDistance ¶ 

type PersonDistance struct {
	// The display name.
	Name string `json:"name"`
	// An opaque identifier that can be used to request metadata for a Person.
	ObfuscatedID string `json:"obfuscatedId"`
	// Distance to person, refer to PeopleDistance pipeline on interpretation of the value.
	Distance float32 `json:"distance"`
}

func (*PersonDistance) GetDistance ¶ 

func (p *PersonDistance) GetDistance() float32

func (*PersonDistance) GetName ¶ 

func (p *PersonDistance) GetName() string

func (*PersonDistance) GetObfuscatedID ¶ 

func (p *PersonDistance) GetObfuscatedID() string

func (PersonDistance) MarshalJSON ¶ added in v0.9.0 

func (p PersonDistance) MarshalJSON() ([]byte, error)

func (*PersonDistance) UnmarshalJSON ¶ added in v0.9.0 

func (p *PersonDistance) UnmarshalJSON(data []byte) error

type PersonMetadata ¶ 

type PersonMetadata struct {
	Type *PersonMetadataType `json:"type,omitempty"`
	// The first name of the person
	FirstName *string `json:"firstName,omitempty"`
	// The last name of the person
	LastName *string `json:"lastName,omitempty"`
	// Job title.
	Title *string `json:"title,omitempty"`
	// Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
	BusinessUnit *string `json:"businessUnit,omitempty"`
	// An organizational unit where everyone has a similar task, e.g. `Engineering`.
	Department *string `json:"department,omitempty"`
	// Info about the employee's team(s).
	Teams []PersonTeam `json:"teams,omitempty"`
	// The number of people in this person's department.
	DepartmentCount *int64 `json:"departmentCount,omitempty"`
	// The user's primary email address
	Email *string `json:"email,omitempty"`
	// Additional email addresses of this user beyond the primary, if any.
	AliasEmails []string `json:"aliasEmails,omitempty"`
	// User facing string representing the person's location.
	Location *string `json:"location,omitempty"`
	// Detailed location with information about country, state, city etc.
	StructuredLocation *StructuredLocation `json:"structuredLocation,omitempty"`
	// Link to a customer's internal profile page. This is set to '#' when no link is desired.
	ExternalProfileLink *string `json:"externalProfileLink,omitempty"`
	Manager             *Person `json:"manager,omitempty"`
	// The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
	ManagementChain []Person `json:"managementChain,omitempty"`
	// Phone number as a number string.
	Phone *string `json:"phone,omitempty"`
	// The timezone of the person. E.g. "Pacific Daylight Time".
	Timezone *string `json:"timezone,omitempty"`
	// The offset of the person's timezone in seconds from UTC.
	TimezoneOffset *int64 `json:"timezoneOffset,omitempty"`
	// The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
	PhotoURL *string `json:"photoUrl,omitempty"`
	// The original photo URL of the person's avatar before any edits they made are applied
	UneditedPhotoURL *string `json:"uneditedPhotoUrl,omitempty"`
	// The URL of the person's banner photo.
	BannerURL *string  `json:"bannerUrl,omitempty"`
	Reports   []Person `json:"reports,omitempty"`
	// The date when the employee started.
	StartDate *types.Date `json:"startDate,omitempty"`
	// If a former employee, the last date of employment.
	EndDate *types.Date `json:"endDate,omitempty"`
	// Short biography or mission statement of the employee.
	Bio *string `json:"bio,omitempty"`
	// She/her, He/his or other pronoun.
	Pronoun *string `json:"pronoun,omitempty"`
	// The total recursive size of the people reporting to this person, or 1
	OrgSizeCount *int64 `json:"orgSizeCount,omitempty"`
	// The total number of people who directly report to this person, or 0
	DirectReportsCount *int64 `json:"directReportsCount,omitempty"`
	// The preferred name of the person, or a nickname.
	PreferredName *string `json:"preferredName,omitempty"`
	// List of social network profiles.
	SocialNetwork []SocialNetwork `json:"socialNetwork,omitempty"`
	// List of profiles this user has in different datasources / tools that they use.
	DatasourceProfile []DatasourceProfile  `json:"datasourceProfile,omitempty"`
	QuerySuggestions  *QuerySuggestionList `json:"querySuggestions,omitempty"`
	// List of people and distances to those people from this person. Optionally with metadata.
	PeopleDistance []PersonDistance `json:"peopleDistance,omitempty"`
	// Information regarding the invite status of a person.
	InviteInfo *InviteInfo `json:"inviteInfo,omitempty"`
	// Whether the user has signed into Glean at least once.
	IsSignedUp *bool `json:"isSignedUp,omitempty"`
	// The last time the user has used the Glean extension in ISO 8601 format.
	LastExtensionUse *time.Time `json:"lastExtensionUse,omitempty"`
	// Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles.
	// When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
	Permissions *Permissions `json:"permissions,omitempty"`
	// User customizable fields for additional people information.
	CustomFields []CustomFieldData `json:"customFields,omitempty"`
	// The logging id of the person used in scrubbed logs, tracking GA metrics.
	LoggingID *string `json:"loggingId,omitempty"`
	// Percentage of the company that started strictly after this person. Between [0,100).
	StartDatePercentile *float32 `json:"startDatePercentile,omitempty"`
	// Intervals of busy time for this person, along with the type of event they're busy with.
	BusyEvents []AnonymousEvent `json:"busyEvents,omitempty"`
	// flag settings to indicate user profile settings for certain items
	ProfileBoolSettings map[string]bool `json:"profileBoolSettings,omitempty"`
	// The badges that a user has earned over their lifetime.
	Badges []Badge `json:"badges,omitempty"`
	// Whether this person is a "root" node in their organization's hierarchy.
	IsOrgRoot *bool `json:"isOrgRoot,omitempty"`
}

func (*PersonMetadata) GetAliasEmails ¶ 

func (p *PersonMetadata) GetAliasEmails() []string

func (*PersonMetadata) GetBadges ¶ 

func (p *PersonMetadata) GetBadges() []Badge

func (*PersonMetadata) GetBannerURL ¶ 

func (p *PersonMetadata) GetBannerURL() *string

func (*PersonMetadata) GetBio ¶ 

func (p *PersonMetadata) GetBio() *string

func (*PersonMetadata) GetBusinessUnit ¶ 

func (p *PersonMetadata) GetBusinessUnit() *string

func (*PersonMetadata) GetBusyEvents ¶ 

func (p *PersonMetadata) GetBusyEvents() []AnonymousEvent

func (*PersonMetadata) GetCustomFields ¶ 

func (p *PersonMetadata) GetCustomFields() []CustomFieldData

func (*PersonMetadata) GetDatasourceProfile ¶ 

func (p *PersonMetadata) GetDatasourceProfile() []DatasourceProfile

func (*PersonMetadata) GetDepartment ¶ 

func (p *PersonMetadata) GetDepartment() *string

func (*PersonMetadata) GetDepartmentCount ¶ 

func (p *PersonMetadata) GetDepartmentCount() *int64

func (*PersonMetadata) GetDirectReportsCount ¶ 

func (p *PersonMetadata) GetDirectReportsCount() *int64

func (*PersonMetadata) GetEmail ¶ 

func (p *PersonMetadata) GetEmail() *string

func (*PersonMetadata) GetEndDate ¶ 

func (p *PersonMetadata) GetEndDate() *types.Date
func (p *PersonMetadata) GetExternalProfileLink() *string

func (*PersonMetadata) GetFirstName ¶ 

func (p *PersonMetadata) GetFirstName() *string

func (*PersonMetadata) GetInviteInfo ¶ 

func (p *PersonMetadata) GetInviteInfo() *InviteInfo

func (*PersonMetadata) GetIsOrgRoot ¶ 

func (p *PersonMetadata) GetIsOrgRoot() *bool

func (*PersonMetadata) GetIsSignedUp ¶ 

func (p *PersonMetadata) GetIsSignedUp() *bool

func (*PersonMetadata) GetLastExtensionUse ¶ 

func (p *PersonMetadata) GetLastExtensionUse() *time.Time

func (*PersonMetadata) GetLastName ¶ 

func (p *PersonMetadata) GetLastName() *string

func (*PersonMetadata) GetLocation ¶ 

func (p *PersonMetadata) GetLocation() *string

func (*PersonMetadata) GetLoggingID ¶ 

func (p *PersonMetadata) GetLoggingID() *string

func (*PersonMetadata) GetManagementChain ¶ 

func (p *PersonMetadata) GetManagementChain() []Person

func (*PersonMetadata) GetManager ¶ 

func (p *PersonMetadata) GetManager() *Person

func (*PersonMetadata) GetOrgSizeCount ¶ 

func (p *PersonMetadata) GetOrgSizeCount() *int64

func (*PersonMetadata) GetPeopleDistance ¶ 

func (p *PersonMetadata) GetPeopleDistance() []PersonDistance

func (*PersonMetadata) GetPermissions ¶ 

func (p *PersonMetadata) GetPermissions() *Permissions

func (*PersonMetadata) GetPhone ¶ 

func (p *PersonMetadata) GetPhone() *string

func (*PersonMetadata) GetPhotoURL ¶ 

func (p *PersonMetadata) GetPhotoURL() *string

func (*PersonMetadata) GetPreferredName ¶ 

func (p *PersonMetadata) GetPreferredName() *string

func (*PersonMetadata) GetProfileBoolSettings ¶ 

func (p *PersonMetadata) GetProfileBoolSettings() map[string]bool

func (*PersonMetadata) GetPronoun ¶ 

func (p *PersonMetadata) GetPronoun() *string

func (*PersonMetadata) GetQuerySuggestions ¶ 

func (p *PersonMetadata) GetQuerySuggestions() *QuerySuggestionList

func (*PersonMetadata) GetReports ¶ 

func (p *PersonMetadata) GetReports() []Person

func (*PersonMetadata) GetSocialNetwork ¶ 

func (p *PersonMetadata) GetSocialNetwork() []SocialNetwork

func (*PersonMetadata) GetStartDate ¶ 

func (p *PersonMetadata) GetStartDate() *types.Date

func (*PersonMetadata) GetStartDatePercentile ¶ 

func (p *PersonMetadata) GetStartDatePercentile() *float32

func (*PersonMetadata) GetStructuredLocation ¶ 

func (p *PersonMetadata) GetStructuredLocation() *StructuredLocation

func (*PersonMetadata) GetTeams ¶ 

func (p *PersonMetadata) GetTeams() []PersonTeam

func (*PersonMetadata) GetTimezone ¶ 

func (p *PersonMetadata) GetTimezone() *string

func (*PersonMetadata) GetTimezoneOffset ¶ 

func (p *PersonMetadata) GetTimezoneOffset() *int64

func (*PersonMetadata) GetTitle ¶ 

func (p *PersonMetadata) GetTitle() *string

func (*PersonMetadata) GetType ¶ 

func (p *PersonMetadata) GetType() *PersonMetadataType

func (*PersonMetadata) GetUneditedPhotoURL ¶ 

func (p *PersonMetadata) GetUneditedPhotoURL() *string

func (PersonMetadata) MarshalJSON ¶ 

func (p PersonMetadata) MarshalJSON() ([]byte, error)

func (*PersonMetadata) UnmarshalJSON ¶ 

func (p *PersonMetadata) UnmarshalJSON(data []byte) error

type PersonMetadataType ¶ 

type PersonMetadataType string
const (
	PersonMetadataTypeFullTime       PersonMetadataType = "FULL_TIME"
	PersonMetadataTypeContractor     PersonMetadataType = "CONTRACTOR"
	PersonMetadataTypeNonEmployee    PersonMetadataType = "NON_EMPLOYEE"
	PersonMetadataTypeFormerEmployee PersonMetadataType = "FORMER_EMPLOYEE"
)

func (PersonMetadataType) ToPointer ¶ 

func (e PersonMetadataType) ToPointer() *PersonMetadataType

func (*PersonMetadataType) UnmarshalJSON ¶ 

func (e *PersonMetadataType) UnmarshalJSON(data []byte) error

type PersonObject ¶ 

type PersonObject struct {
	// The display name.
	Name string `json:"name"`
	// An opaque identifier that can be used to request metadata for a Person.
	ObfuscatedID string `json:"obfuscatedId"`
}

func (*PersonObject) GetName ¶ 

func (p *PersonObject) GetName() string

func (*PersonObject) GetObfuscatedID ¶ 

func (p *PersonObject) GetObfuscatedID() string

type PersonTeam ¶ 

type PersonTeam struct {
	// Unique identifier
	ID *string `json:"id,omitempty"`
	// Team name
	Name *string `json:"name,omitempty"`
	// Link to a team page on the internet or your company's intranet
	ExternalLink *string `json:"externalLink,omitempty"`
	// The team member's relationship to the team. This defaults to MEMBER if not set.
	Relationship *PersonTeamRelationship `default:"MEMBER" json:"relationship"`
	// The team member's start date
	JoinDate *time.Time `json:"joinDate,omitempty"`
}

PersonTeam - Use `id` if you index teams via Glean, and use `name` and `externalLink` if you want to use your own team pages 

func (p *PersonTeam) GetExternalLink() *string

func (*PersonTeam) GetID ¶ 

func (p *PersonTeam) GetID() *string

func (*PersonTeam) GetJoinDate ¶ 

func (p *PersonTeam) GetJoinDate() *time.Time

func (*PersonTeam) GetName ¶ 

func (p *PersonTeam) GetName() *string

func (*PersonTeam) GetRelationship ¶ 

func (p *PersonTeam) GetRelationship() *PersonTeamRelationship

func (PersonTeam) MarshalJSON ¶ 

func (p PersonTeam) MarshalJSON() ([]byte, error)

func (*PersonTeam) UnmarshalJSON ¶ 

func (p *PersonTeam) UnmarshalJSON(data []byte) error

type PersonTeamRelationship ¶ 

type PersonTeamRelationship string

PersonTeamRelationship - The team member's relationship to the team. This defaults to MEMBER if not set. 

const (
	PersonTeamRelationshipMember         PersonTeamRelationship = "MEMBER"
	PersonTeamRelationshipManager        PersonTeamRelationship = "MANAGER"
	PersonTeamRelationshipLead           PersonTeamRelationship = "LEAD"
	PersonTeamRelationshipPointOfContact PersonTeamRelationship = "POINT_OF_CONTACT"
	PersonTeamRelationshipOther          PersonTeamRelationship = "OTHER"
)

func (PersonTeamRelationship) ToPointer ¶ 

func (e PersonTeamRelationship) ToPointer() *PersonTeamRelationship

func (*PersonTeamRelationship) UnmarshalJSON ¶ 

func (e *PersonTeamRelationship) UnmarshalJSON(data []byte) error

type PersonToTeamRelationship ¶ 

type PersonToTeamRelationship struct {
	Person Person `json:"person"`
	// The team member's relationship to the team. This defaults to MEMBER if not set.
	Relationship *PersonToTeamRelationshipRelationship `default:"MEMBER" json:"relationship"`
	// Displayed name for the relationship if relationship is set to `OTHER`.
	CustomRelationshipStr *string `json:"customRelationshipStr,omitempty"`
	// The team member's start date
	JoinDate *time.Time `json:"joinDate,omitempty"`
}

PersonToTeamRelationship - Metadata about the relationship of a person to a team.

func (*PersonToTeamRelationship) GetCustomRelationshipStr ¶ 

func (p *PersonToTeamRelationship) GetCustomRelationshipStr() *string

func (*PersonToTeamRelationship) GetJoinDate ¶ 

func (p *PersonToTeamRelationship) GetJoinDate() *time.Time

func (*PersonToTeamRelationship) GetPerson ¶ 

func (p *PersonToTeamRelationship) GetPerson() Person

func (*PersonToTeamRelationship) GetRelationship ¶ 

func (p *PersonToTeamRelationship) GetRelationship() *PersonToTeamRelationshipRelationship

func (PersonToTeamRelationship) MarshalJSON ¶ 

func (p PersonToTeamRelationship) MarshalJSON() ([]byte, error)

func (*PersonToTeamRelationship) UnmarshalJSON ¶ 

func (p *PersonToTeamRelationship) UnmarshalJSON(data []byte) error

type PersonToTeamRelationshipRelationship ¶ 

type PersonToTeamRelationshipRelationship string

PersonToTeamRelationshipRelationship - The team member's relationship to the team. This defaults to MEMBER if not set. 

const (
	PersonToTeamRelationshipRelationshipMember         PersonToTeamRelationshipRelationship = "MEMBER"
	PersonToTeamRelationshipRelationshipManager        PersonToTeamRelationshipRelationship = "MANAGER"
	PersonToTeamRelationshipRelationshipLead           PersonToTeamRelationshipRelationship = "LEAD"
	PersonToTeamRelationshipRelationshipPointOfContact PersonToTeamRelationshipRelationship = "POINT_OF_CONTACT"
	PersonToTeamRelationshipRelationshipOther          PersonToTeamRelationshipRelationship = "OTHER"
)

func (PersonToTeamRelationshipRelationship) ToPointer ¶ 

func (e PersonToTeamRelationshipRelationship) ToPointer() *PersonToTeamRelationshipRelationship

func (*PersonToTeamRelationshipRelationship) UnmarshalJSON ¶ 

func (e *PersonToTeamRelationshipRelationship) UnmarshalJSON(data []byte) error

type PinDocument ¶ 

type PinDocument struct {
	// The query strings for which the pinned result will show.
	Queries []string `json:"queries,omitempty"`
	// Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The opaque id of the pin.
	ID *string `json:"id,omitempty"`
	// The document which should be a pinned result.
	DocumentID  string     `json:"documentId"`
	Attribution *Person    `json:"attribution,omitempty"`
	UpdatedBy   *Person    `json:"updatedBy,omitempty"`
	CreateTime  *time.Time `json:"createTime,omitempty"`
	UpdateTime  *time.Time `json:"updateTime,omitempty"`
}

func (*PinDocument) GetAttribution ¶ 

func (p *PinDocument) GetAttribution() *Person

func (*PinDocument) GetAudienceFilters ¶ 

func (p *PinDocument) GetAudienceFilters() []FacetFilter

func (*PinDocument) GetCreateTime ¶ 

func (p *PinDocument) GetCreateTime() *time.Time

func (*PinDocument) GetDocumentID ¶ 

func (p *PinDocument) GetDocumentID() string

func (*PinDocument) GetID ¶ 

func (p *PinDocument) GetID() *string

func (*PinDocument) GetQueries ¶ 

func (p *PinDocument) GetQueries() []string

func (*PinDocument) GetUpdateTime ¶ 

func (p *PinDocument) GetUpdateTime() *time.Time

func (*PinDocument) GetUpdatedBy ¶ 

func (p *PinDocument) GetUpdatedBy() *Person

func (PinDocument) MarshalJSON ¶ 

func (p PinDocument) MarshalJSON() ([]byte, error)

func (*PinDocument) UnmarshalJSON ¶ 

func (p *PinDocument) UnmarshalJSON(data []byte) error

type PinRequest ¶ 

type PinRequest struct {
	// The query strings for which the pinned result will show.
	Queries []string `json:"queries,omitempty"`
	// Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The document to be pinned.
	DocumentID *string `json:"documentId,omitempty"`
}

func (*PinRequest) GetAudienceFilters ¶ 

func (p *PinRequest) GetAudienceFilters() []FacetFilter

func (*PinRequest) GetDocumentID ¶ 

func (p *PinRequest) GetDocumentID() *string

func (*PinRequest) GetQueries ¶ 

func (p *PinRequest) GetQueries() []string

type PossibleValue ¶ 

type PossibleValue struct {
	// Possible value
	Value *string `json:"value,omitempty"`
	// User-friendly label associated with the value
	Label *string `json:"label,omitempty"`
}

PossibleValue - Possible value of a specific parameter

func (*PossibleValue) GetLabel ¶ 

func (p *PossibleValue) GetLabel() *string

func (*PossibleValue) GetValue ¶ 

func (p *PossibleValue) GetValue() *string

type ProcessAllDocumentsRequest ¶ 

type ProcessAllDocumentsRequest struct {
	// If provided, process documents only for this custom datasource. Otherwise all uploaded documents are processed.
	Datasource *string `json:"datasource,omitempty"`
}

ProcessAllDocumentsRequest - Describes the request body of the /processalldocuments API call

func (*ProcessAllDocumentsRequest) GetDatasource ¶ 

func (p *ProcessAllDocumentsRequest) GetDatasource() *string

type ProcessAllMembershipsRequest ¶ 

type ProcessAllMembershipsRequest struct {
	// If provided, process group memberships only for this custom datasource. Otherwise all uploaded memberships are processed.
	Datasource *string `json:"datasource,omitempty"`
}

ProcessAllMembershipsRequest - Describes the request body of the /processallmemberships API call

func (*ProcessAllMembershipsRequest) GetDatasource ¶ 

func (p *ProcessAllMembershipsRequest) GetDatasource() *string

type ProcessingHistoryEvent ¶ 

type ProcessingHistoryEvent struct {
	// The start time of the processing in ISO 8601 format
	StartTime *string `json:"startTime,omitempty"`
	// The end time of the processing in ISO 8601 format, 'NA' if still in progress
	EndTime *string `json:"endTime,omitempty"`
}

ProcessingHistoryEvent - Processing history event for a datasource

func (*ProcessingHistoryEvent) GetEndTime ¶ 

func (p *ProcessingHistoryEvent) GetEndTime() *string

func (*ProcessingHistoryEvent) GetStartTime ¶ 

func (p *ProcessingHistoryEvent) GetStartTime() *string

type ProcessingState ¶ 

type ProcessingState string

ProcessingState - The current state of the upload, an enum of UNAVAILABLE, UPLOAD STARTED, UPLOAD IN PROGRESS, UPLOAD COMPLETED, DELETION PAUSED, INDEXING COMPLETED 

const (
	ProcessingStateUnavailable       ProcessingState = "UNAVAILABLE"
	ProcessingStateUploadStarted     ProcessingState = "UPLOAD STARTED"
	ProcessingStateUploadInProgress  ProcessingState = "UPLOAD IN PROGRESS"
	ProcessingStateUploadCompleted   ProcessingState = "UPLOAD COMPLETED"
	ProcessingStateDeletionPaused    ProcessingState = "DELETION PAUSED"
	ProcessingStateIndexingCompleted ProcessingState = "INDEXING COMPLETED"
)

func (ProcessingState) ToPointer ¶ 

func (e ProcessingState) ToPointer() *ProcessingState

func (*ProcessingState) UnmarshalJSON ¶ 

func (e *ProcessingState) UnmarshalJSON(data []byte) error

type Prominence ¶ 

type Prominence string

Prominence - The level of visual distinction that should be given to a result. 

const (
	ProminenceHero     Prominence = "HERO"
	ProminencePromoted Prominence = "PROMOTED"
	ProminenceStandard Prominence = "STANDARD"
)

func (Prominence) ToPointer ¶ 

func (e Prominence) ToPointer() *Prominence

func (*Prominence) UnmarshalJSON ¶ 

func (e *Prominence) UnmarshalJSON(data []byte) error

type PromptTemplate ¶ 

type PromptTemplate struct {
	// The user-given identifier for this prompt template.
	Name *string `json:"name,omitempty"`
	// The actual template string.
	Template string `json:"template"`
	// The Application Id the prompt template should be created under. Empty for default assistant.
	ApplicationID *string                 `json:"applicationId,omitempty"`
	Inclusions    *ChatRestrictionFilters `json:"inclusions,omitempty"`
	// A list of added user roles for the Workflow.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of removed user roles for the Workflow.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	Permissions  *ObjectPermissions      `json:"permissions,omitempty"`
	// Opaque id for this prompt template
	ID     *string `json:"id,omitempty"`
	Author *Person `json:"author,omitempty"`
	// Server Unix timestamp of the creation time.
	CreateTimestamp *int64 `json:"createTimestamp,omitempty"`
	// Server Unix timestamp of the last update time.
	LastUpdateTimestamp *int64  `json:"lastUpdateTimestamp,omitempty"`
	LastUpdatedBy       *Person `json:"lastUpdatedBy,omitempty"`
	// A list of roles for this prompt template explicitly granted.
	Roles []UserRoleSpecification `json:"roles,omitempty"`
}

func (*PromptTemplate) GetAddedRoles ¶ 

func (p *PromptTemplate) GetAddedRoles() []UserRoleSpecification

func (*PromptTemplate) GetApplicationID ¶ 

func (p *PromptTemplate) GetApplicationID() *string

func (*PromptTemplate) GetAuthor ¶ 

func (p *PromptTemplate) GetAuthor() *Person

func (*PromptTemplate) GetCreateTimestamp ¶ 

func (p *PromptTemplate) GetCreateTimestamp() *int64

func (*PromptTemplate) GetID ¶ 

func (p *PromptTemplate) GetID() *string

func (*PromptTemplate) GetInclusions ¶ 

func (p *PromptTemplate) GetInclusions() *ChatRestrictionFilters

func (*PromptTemplate) GetLastUpdateTimestamp ¶ 

func (p *PromptTemplate) GetLastUpdateTimestamp() *int64

func (*PromptTemplate) GetLastUpdatedBy ¶ 

func (p *PromptTemplate) GetLastUpdatedBy() *Person

func (*PromptTemplate) GetName ¶ 

func (p *PromptTemplate) GetName() *string

func (*PromptTemplate) GetPermissions ¶ 

func (p *PromptTemplate) GetPermissions() *ObjectPermissions

func (*PromptTemplate) GetRemovedRoles ¶ 

func (p *PromptTemplate) GetRemovedRoles() []UserRoleSpecification

func (*PromptTemplate) GetRoles ¶ 

func (p *PromptTemplate) GetRoles() []UserRoleSpecification

func (*PromptTemplate) GetTemplate ¶ 

func (p *PromptTemplate) GetTemplate() string

type PromptTemplateResult ¶ 

type PromptTemplateResult struct {
	PromptTemplate *PromptTemplate `json:"promptTemplate,omitempty"`
	// An opaque token that represents this prompt template
	TrackingToken *string       `json:"trackingToken,omitempty"`
	FavoriteInfo  *FavoriteInfo `json:"favoriteInfo,omitempty"`
	RunCount      *CountInfo    `json:"runCount,omitempty"`
}

func (*PromptTemplateResult) GetFavoriteInfo ¶ 

func (p *PromptTemplateResult) GetFavoriteInfo() *FavoriteInfo

func (*PromptTemplateResult) GetPromptTemplate ¶ 

func (p *PromptTemplateResult) GetPromptTemplate() *PromptTemplate

func (*PromptTemplateResult) GetRunCount ¶ 

func (p *PromptTemplateResult) GetRunCount() *CountInfo

func (*PromptTemplateResult) GetTrackingToken ¶ 

func (p *PromptTemplateResult) GetTrackingToken() *string

type PropertyDefinition ¶ 

type PropertyDefinition struct {
	// The name of the property in the `DocumentMetadata` (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too.
	Name *string `json:"name,omitempty"`
	// The user friendly label for the property.
	DisplayLabel *string `json:"displayLabel,omitempty"`
	// The user friendly label for the property that will be used if a plural context.
	DisplayLabelPlural *string `json:"displayLabelPlural,omitempty"`
	// The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported.
	PropertyType *PropertyType `json:"propertyType,omitempty"`
	UIOptions    *UIOptions    `json:"uiOptions,omitempty"`
	// If true then the property will not show up as a facet in the UI.
	HideUIFacet *bool `json:"hideUiFacet,omitempty"`
	// Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators.
	UIFacetOrder *int64 `json:"uiFacetOrder,omitempty"`
	// If true then the property will not be indexed for retrieval and ranking.
	SkipIndexing *bool `json:"skipIndexing,omitempty"`
	// The unique identifier of the `PropertyGroup` to which this property belongs.
	Group *string `json:"group,omitempty"`
}

func (*PropertyDefinition) GetDisplayLabel ¶ 

func (p *PropertyDefinition) GetDisplayLabel() *string

func (*PropertyDefinition) GetDisplayLabelPlural ¶ 

func (p *PropertyDefinition) GetDisplayLabelPlural() *string

func (*PropertyDefinition) GetGroup ¶ 

func (p *PropertyDefinition) GetGroup() *string

func (*PropertyDefinition) GetHideUIFacet ¶ 

func (p *PropertyDefinition) GetHideUIFacet() *bool

func (*PropertyDefinition) GetName ¶ 

func (p *PropertyDefinition) GetName() *string

func (*PropertyDefinition) GetPropertyType ¶ 

func (p *PropertyDefinition) GetPropertyType() *PropertyType

func (*PropertyDefinition) GetSkipIndexing ¶ 

func (p *PropertyDefinition) GetSkipIndexing() *bool

func (*PropertyDefinition) GetUIFacetOrder ¶ 

func (p *PropertyDefinition) GetUIFacetOrder() *int64

func (*PropertyDefinition) GetUIOptions ¶ 

func (p *PropertyDefinition) GetUIOptions() *UIOptions

type PropertyGroup ¶ 

type PropertyGroup struct {
	// The unique identifier of the group.
	Name *string `json:"name,omitempty"`
	// The user-friendly group label to display.
	DisplayLabel *string `json:"displayLabel,omitempty"`
}

PropertyGroup - A grouping for multiple PropertyDefinition. Grouped properties will be displayed together in the UI.

func (*PropertyGroup) GetDisplayLabel ¶ 

func (p *PropertyGroup) GetDisplayLabel() *string

func (*PropertyGroup) GetName ¶ 

func (p *PropertyGroup) GetName() *string

type PropertyType ¶ 

type PropertyType string

PropertyType - The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. 

const (
	PropertyTypeText          PropertyType = "TEXT"
	PropertyTypeDate          PropertyType = "DATE"
	PropertyTypeInt           PropertyType = "INT"
	PropertyTypeUserid        PropertyType = "USERID"
	PropertyTypePicklist      PropertyType = "PICKLIST"
	PropertyTypeTextlist      PropertyType = "TEXTLIST"
	PropertyTypeMultipicklist PropertyType = "MULTIPICKLIST"
)

func (PropertyType) ToPointer ¶ 

func (e PropertyType) ToPointer() *PropertyType

func (*PropertyType) UnmarshalJSON ¶ 

func (e *PropertyType) UnmarshalJSON(data []byte) error

type Provider ¶ 

type Provider string
const (
	ProviderZoom     Provider = "ZOOM"
	ProviderHangouts Provider = "HANGOUTS"
)

func (Provider) ToPointer ¶ 

func (e Provider) ToPointer() *Provider

func (*Provider) UnmarshalJSON ¶ 

func (e *Provider) UnmarshalJSON(data []byte) error

type QueryInsight ¶ 

type QueryInsight struct {
	// The query string the information is about.
	Query                string     `json:"query"`
	SearchCount          *CountInfo `json:"searchCount,omitempty"`
	SearchorCount        *CountInfo `json:"searchorCount,omitempty"`
	SearchWithClickCount *CountInfo `json:"searchWithClickCount,omitempty"`
	ClickCount           *CountInfo `json:"clickCount,omitempty"`
	// list of similar queries to current one.
	SimilarQueries []QueryInsight `json:"similarQueries,omitempty"`
}

func (*QueryInsight) GetClickCount ¶ 

func (q *QueryInsight) GetClickCount() *CountInfo

func (*QueryInsight) GetQuery ¶ 

func (q *QueryInsight) GetQuery() string

func (*QueryInsight) GetSearchCount ¶ 

func (q *QueryInsight) GetSearchCount() *CountInfo

func (*QueryInsight) GetSearchWithClickCount ¶ 

func (q *QueryInsight) GetSearchWithClickCount() *CountInfo

func (*QueryInsight) GetSearchorCount ¶ 

func (q *QueryInsight) GetSearchorCount() *CountInfo

func (*QueryInsight) GetSimilarQueries ¶ 

func (q *QueryInsight) GetSimilarQueries() []QueryInsight

type QueryInsightsResponse ¶ 

type QueryInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp *int64 `json:"lastLogTimestamp,omitempty"`
	// Insights for queries.
	QueryInsights []QueryInsight `json:"queryInsights,omitempty"`
	// Insights for low performing queries without good results.
	LowPerformingQueryInsights []QueryInsight `json:"lowPerformingQueryInsights,omitempty"`
	// list of departments applicable for queries tab.
	Departments []string `json:"departments,omitempty"`
	// Min threshold in number of visitors while populating results, otherwise 0.
	MinVisitorThreshold *int64 `json:"minVisitorThreshold,omitempty"`
}

func (*QueryInsightsResponse) GetDepartments ¶ 

func (q *QueryInsightsResponse) GetDepartments() []string

func (*QueryInsightsResponse) GetLastLogTimestamp ¶ 

func (q *QueryInsightsResponse) GetLastLogTimestamp() *int64

func (*QueryInsightsResponse) GetLowPerformingQueryInsights ¶ 

func (q *QueryInsightsResponse) GetLowPerformingQueryInsights() []QueryInsight

func (*QueryInsightsResponse) GetMinVisitorThreshold ¶ 

func (q *QueryInsightsResponse) GetMinVisitorThreshold() *int64

func (*QueryInsightsResponse) GetQueryInsights ¶ 

func (q *QueryInsightsResponse) GetQueryInsights() []QueryInsight

type QuerySuggestion ¶ 

type QuerySuggestion struct {
	// A query term missing from the original query on which this suggestion is based.
	MissingTerm *string `json:"missingTerm,omitempty"`
	// The query being suggested (e.g. enforcing the missing term from the original query).
	Query              string              `json:"query"`
	SearchProviderInfo *SearchProviderInfo `json:"searchProviderInfo,omitempty"`
	// A user-facing description to display for the suggestion.
	Label *string `json:"label,omitempty"`
	// The datasource associated with the suggestion.
	Datasource     *string               `json:"datasource,omitempty"`
	RequestOptions *SearchRequestOptions `json:"requestOptions,omitempty"`
	// The bolded ranges within the query of the QuerySuggestion.
	Ranges       []TextRange                `json:"ranges,omitempty"`
	InputDetails *SearchRequestInputDetails `json:"inputDetails,omitempty"`
}

func (*QuerySuggestion) GetDatasource ¶ 

func (q *QuerySuggestion) GetDatasource() *string

func (*QuerySuggestion) GetInputDetails ¶ 

func (q *QuerySuggestion) GetInputDetails() *SearchRequestInputDetails

func (*QuerySuggestion) GetLabel ¶ 

func (q *QuerySuggestion) GetLabel() *string

func (*QuerySuggestion) GetMissingTerm ¶ 

func (q *QuerySuggestion) GetMissingTerm() *string

func (*QuerySuggestion) GetQuery ¶ 

func (q *QuerySuggestion) GetQuery() string

func (*QuerySuggestion) GetRanges ¶ 

func (q *QuerySuggestion) GetRanges() []TextRange

func (*QuerySuggestion) GetRequestOptions ¶ 

func (q *QuerySuggestion) GetRequestOptions() *SearchRequestOptions

func (*QuerySuggestion) GetSearchProviderInfo ¶ 

func (q *QuerySuggestion) GetSearchProviderInfo() *SearchProviderInfo

func (QuerySuggestion) MarshalJSON ¶ added in v0.9.0 

func (q QuerySuggestion) MarshalJSON() ([]byte, error)

func (*QuerySuggestion) UnmarshalJSON ¶ added in v0.9.0 

func (q *QuerySuggestion) UnmarshalJSON(data []byte) error

type QuerySuggestionList ¶ 

type QuerySuggestionList struct {
	Suggestions []QuerySuggestion `json:"suggestions,omitempty"`
	Person      *Person           `json:"person,omitempty"`
}

func (*QuerySuggestionList) GetPerson ¶ 

func (q *QuerySuggestionList) GetPerson() *Person

func (*QuerySuggestionList) GetSuggestions ¶ 

func (q *QuerySuggestionList) GetSuggestions() []QuerySuggestion

func (QuerySuggestionList) MarshalJSON ¶ added in v0.9.0 

func (q QuerySuggestionList) MarshalJSON() ([]byte, error)

func (*QuerySuggestionList) UnmarshalJSON ¶ added in v0.9.0 

func (q *QuerySuggestionList) UnmarshalJSON(data []byte) error
type Quicklink struct {
	// Full action name. Used in autocomplete.
	Name *string `json:"name,omitempty"`
	// Shortened name. Used in app cards.
	ShortName *string `json:"shortName,omitempty"`
	// The URL of the action.
	URL *string `json:"url,omitempty"`
	// Defines how to render an icon
	IconConfig *IconConfig `json:"iconConfig,omitempty"`
	// Unique identifier of this quicklink
	ID *string `json:"id,omitempty"`
	// The scopes for which this quicklink is applicable
	Scopes []Scope `json:"scopes,omitempty"`
}

Quicklink - An action for a specific datasource that will show up in autocomplete and app card, e.g. "Create new issue" for jira.

func (*Quicklink) GetID ¶ 

func (q *Quicklink) GetID() *string

func (*Quicklink) GetIconConfig ¶ 

func (q *Quicklink) GetIconConfig() *IconConfig

func (*Quicklink) GetName ¶ 

func (q *Quicklink) GetName() *string

func (*Quicklink) GetScopes ¶ 

func (q *Quicklink) GetScopes() []Scope

func (*Quicklink) GetShortName ¶ 

func (q *Quicklink) GetShortName() *string

func (*Quicklink) GetURL ¶ 

func (q *Quicklink) GetURL() *string

type Reaction ¶ 

type Reaction struct {
	Type *string `json:"type,omitempty"`
	// The count of the reaction type on the document.
	Count    *int64   `json:"count,omitempty"`
	Reactors []Person `json:"reactors,omitempty"`
	// Whether the user in context reacted with this type to the document.
	ReactedByViewer *bool `json:"reactedByViewer,omitempty"`
}

func (*Reaction) GetCount ¶ 

func (r *Reaction) GetCount() *int64

func (*Reaction) GetReactedByViewer ¶ 

func (r *Reaction) GetReactedByViewer() *bool

func (*Reaction) GetReactors ¶ 

func (r *Reaction) GetReactors() []Person

func (*Reaction) GetType ¶ 

func (r *Reaction) GetType() *string

func (Reaction) MarshalJSON ¶ added in v0.9.0 

func (r Reaction) MarshalJSON() ([]byte, error)

func (*Reaction) UnmarshalJSON ¶ added in v0.9.0 

func (r *Reaction) UnmarshalJSON(data []byte) error

type ReadPermission ¶ 

type ReadPermission struct {
	// Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
	ScopeType *ScopeType `json:"scopeType,omitempty"`
}

ReadPermission - Describes the read permission level that a user has for a specific feature

func (*ReadPermission) GetScopeType ¶ 

func (r *ReadPermission) GetScopeType() *ScopeType

func (ReadPermission) MarshalJSON ¶ added in v0.9.0 

func (r ReadPermission) MarshalJSON() ([]byte, error)

func (*ReadPermission) UnmarshalJSON ¶ added in v0.9.0 

func (r *ReadPermission) UnmarshalJSON(data []byte) error

type RecommendationsRequest ¶ 

type RecommendationsRequest struct {
	// The ISO 8601 timestamp associated with the client request.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs.
	TrackingToken  *string      `json:"trackingToken,omitempty"`
	SessionInfo    *SessionInfo `json:"sessionInfo,omitempty"`
	SourceDocument *Document    `json:"sourceDocument,omitempty"`
	// Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize.
	PageSize *int64 `json:"pageSize,omitempty"`
	// Hint to the server about how many characters long a snippet may be. Server may return less or more.
	MaxSnippetSize             *int64                         `json:"maxSnippetSize,omitempty"`
	RecommendationDocumentSpec *DocumentSpecUnion             `json:"recommendationDocumentSpec,omitempty"`
	RequestOptions             *RecommendationsRequestOptions `json:"requestOptions,omitempty"`
}

func (*RecommendationsRequest) GetMaxSnippetSize ¶ 

func (r *RecommendationsRequest) GetMaxSnippetSize() *int64

func (*RecommendationsRequest) GetPageSize ¶ 

func (r *RecommendationsRequest) GetPageSize() *int64

func (*RecommendationsRequest) GetRecommendationDocumentSpec ¶ 

func (r *RecommendationsRequest) GetRecommendationDocumentSpec() *DocumentSpecUnion

func (*RecommendationsRequest) GetRequestOptions ¶ 

func (r *RecommendationsRequest) GetRequestOptions() *RecommendationsRequestOptions

func (*RecommendationsRequest) GetSessionInfo ¶ 

func (r *RecommendationsRequest) GetSessionInfo() *SessionInfo

func (*RecommendationsRequest) GetSourceDocument ¶ 

func (r *RecommendationsRequest) GetSourceDocument() *Document

func (*RecommendationsRequest) GetTimestamp ¶ 

func (r *RecommendationsRequest) GetTimestamp() *time.Time

func (*RecommendationsRequest) GetTrackingToken ¶ 

func (r *RecommendationsRequest) GetTrackingToken() *string

func (RecommendationsRequest) MarshalJSON ¶ 

func (r RecommendationsRequest) MarshalJSON() ([]byte, error)

func (*RecommendationsRequest) UnmarshalJSON ¶ 

func (r *RecommendationsRequest) UnmarshalJSON(data []byte) error

type RecommendationsRequestOptions ¶ 

type RecommendationsRequestOptions struct {
	// Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
	DatasourceFilter *string `json:"datasourceFilter,omitempty"`
	// Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). All results are returned if missing.
	DatasourcesFilter []string `json:"datasourcesFilter,omitempty"`
	// A list of facet filter sets that will be OR'ed together.
	FacetFilterSets []FacetFilterSet `json:"facetFilterSets,omitempty"`
	Context         *Document        `json:"context,omitempty"`
	// The types of prominence wanted in results returned. Default is any type.
	ResultProminence []SearchResultProminenceEnum `json:"resultProminence,omitempty"`
}

func (*RecommendationsRequestOptions) GetContext ¶ 

func (r *RecommendationsRequestOptions) GetContext() *Document

func (*RecommendationsRequestOptions) GetDatasourceFilter ¶ 

func (r *RecommendationsRequestOptions) GetDatasourceFilter() *string

func (*RecommendationsRequestOptions) GetDatasourcesFilter ¶ 

func (r *RecommendationsRequestOptions) GetDatasourcesFilter() []string

func (*RecommendationsRequestOptions) GetFacetFilterSets ¶ 

func (r *RecommendationsRequestOptions) GetFacetFilterSets() []FacetFilterSet

func (*RecommendationsRequestOptions) GetResultProminence ¶ 

func (r *RecommendationsRequestOptions) GetResultProminence() []SearchResultProminenceEnum

type ReferenceRange ¶ 

type ReferenceRange struct {
	// A subsection of a given string to which some special formatting should be applied.
	TextRange *TextRange            `json:"textRange,omitempty"`
	Snippets  []SearchResultSnippet `json:"snippets,omitempty"`
}

ReferenceRange - Each text range from the response can correspond to an array of snippets from the citation source.

func (*ReferenceRange) GetSnippets ¶ 

func (r *ReferenceRange) GetSnippets() []SearchResultSnippet

func (*ReferenceRange) GetTextRange ¶ 

func (r *ReferenceRange) GetTextRange() *TextRange

type RelatedDocuments ¶ 

type RelatedDocuments struct {
	// How this document relates to the including entity.
	Relation *Relation `json:"relation,omitempty"`
	// Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers)
	AssociatedEntityID *string          `json:"associatedEntityId,omitempty"`
	QuerySuggestion    *QuerySuggestion `json:"querySuggestion,omitempty"`
	// A truncated list of documents with this relation. TO BE DEPRECATED.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Documents []Document `json:"documents,omitempty"`
	// A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken.
	Results []SearchResult `json:"results,omitempty"`
}

func (*RelatedDocuments) GetAssociatedEntityID ¶ 

func (r *RelatedDocuments) GetAssociatedEntityID() *string

func (*RelatedDocuments) GetDocuments ¶ 

func (r *RelatedDocuments) GetDocuments() []Document

func (*RelatedDocuments) GetQuerySuggestion ¶ 

func (r *RelatedDocuments) GetQuerySuggestion() *QuerySuggestion

func (*RelatedDocuments) GetRelation ¶ 

func (r *RelatedDocuments) GetRelation() *Relation

func (*RelatedDocuments) GetResults ¶ 

func (r *RelatedDocuments) GetResults() []SearchResult

func (RelatedDocuments) MarshalJSON ¶ added in v0.9.0 

func (r RelatedDocuments) MarshalJSON() ([]byte, error)

func (*RelatedDocuments) UnmarshalJSON ¶ added in v0.9.0 

func (r *RelatedDocuments) UnmarshalJSON(data []byte) error

type RelatedObject ¶ 

type RelatedObject struct {
	// The ID of the related object
	ID string `json:"id"`
	// Some metadata of the object which can be displayed, while not having the actual object.
	Metadata *RelatedObjectMetadata `json:"metadata,omitempty"`
}

func (*RelatedObject) GetID ¶ 

func (r *RelatedObject) GetID() string

func (*RelatedObject) GetMetadata ¶ 

func (r *RelatedObject) GetMetadata() *RelatedObjectMetadata

func (RelatedObject) MarshalJSON ¶ added in v0.9.0 

func (r RelatedObject) MarshalJSON() ([]byte, error)

func (*RelatedObject) UnmarshalJSON ¶ added in v0.9.0 

func (r *RelatedObject) UnmarshalJSON(data []byte) error

type RelatedObjectEdge ¶ 

type RelatedObjectEdge struct {
	Objects []RelatedObject `json:"objects,omitempty"`
}

func (*RelatedObjectEdge) GetObjects ¶ 

func (r *RelatedObjectEdge) GetObjects() []RelatedObject

func (RelatedObjectEdge) MarshalJSON ¶ added in v0.9.0 

func (r RelatedObjectEdge) MarshalJSON() ([]byte, error)

func (*RelatedObjectEdge) UnmarshalJSON ¶ added in v0.9.0 

func (r *RelatedObjectEdge) UnmarshalJSON(data []byte) error

type RelatedObjectMetadata ¶ 

type RelatedObjectMetadata struct {
	// Placeholder name of the object, not the relationship.
	Name *string `json:"name,omitempty"`
}

RelatedObjectMetadata - Some metadata of the object which can be displayed, while not having the actual object.

func (*RelatedObjectMetadata) GetName ¶ 

func (r *RelatedObjectMetadata) GetName() *string

func (RelatedObjectMetadata) MarshalJSON ¶ added in v0.9.0 

func (r RelatedObjectMetadata) MarshalJSON() ([]byte, error)

func (*RelatedObjectMetadata) UnmarshalJSON ¶ added in v0.9.0 

func (r *RelatedObjectMetadata) UnmarshalJSON(data []byte) error

type RelatedQuestion ¶ 

type RelatedQuestion struct {
	// The text of the related question
	Question *string `json:"question,omitempty"`
	// The answer for the related question
	Answer *string `json:"answer,omitempty"`
	// Subsections of the answer string to which some special formatting should be applied (eg. bold)
	Ranges []TextRange `json:"ranges,omitempty"`
}

func (*RelatedQuestion) GetAnswer ¶ 

func (r *RelatedQuestion) GetAnswer() *string

func (*RelatedQuestion) GetQuestion ¶ 

func (r *RelatedQuestion) GetQuestion() *string

func (*RelatedQuestion) GetRanges ¶ 

func (r *RelatedQuestion) GetRanges() []TextRange

func (RelatedQuestion) MarshalJSON ¶ added in v0.9.0 

func (r RelatedQuestion) MarshalJSON() ([]byte, error)

func (*RelatedQuestion) UnmarshalJSON ¶ added in v0.9.0 

func (r *RelatedQuestion) UnmarshalJSON(data []byte) error

type Relation ¶ 

type Relation string

Relation - How this document relates to the including entity. 

const (
	RelationAttachment           Relation = "ATTACHMENT"
	RelationCanonical            Relation = "CANONICAL"
	RelationCase                 Relation = "CASE"
	RelationContactLower         Relation = "contact"
	RelationContactUpper         Relation = "CONTACT"
	RelationConversationMessages Relation = "CONVERSATION_MESSAGES"
	RelationExpert               Relation = "EXPERT"
	RelationFrom                 Relation = "FROM"
	RelationHighlight            Relation = "HIGHLIGHT"
	RelationOpportunityLower     Relation = "opportunity"
	RelationOpportunityUpper     Relation = "OPPORTUNITY"
	RelationRecent               Relation = "RECENT"
	RelationSource               Relation = "SOURCE"
	RelationTicket               Relation = "TICKET"
	RelationTranscript           Relation = "TRANSCRIPT"
	RelationWith                 Relation = "WITH"
)

func (Relation) ToPointer ¶ 

func (e Relation) ToPointer() *Relation

func (*Relation) UnmarshalJSON ¶ 

func (e *Relation) UnmarshalJSON(data []byte) error

type RelationType ¶ 

type RelationType string
const (
	RelationTypeEquals    RelationType = "EQUALS"
	RelationTypeIDEquals  RelationType = "ID_EQUALS"
	RelationTypeLt        RelationType = "LT"
	RelationTypeGt        RelationType = "GT"
	RelationTypeNotEquals RelationType = "NOT_EQUALS"
)

func (RelationType) ToPointer ¶ 

func (e RelationType) ToPointer() *RelationType

func (*RelationType) UnmarshalJSON ¶ 

func (e *RelationType) UnmarshalJSON(data []byte) error

type Reminder ¶ 

type Reminder struct {
	Assignee  Person  `json:"assignee"`
	Requestor *Person `json:"requestor,omitempty"`
	// Unix timestamp for when the reminder should trigger (in seconds since epoch UTC).
	RemindAt int64 `json:"remindAt"`
	// Unix timestamp for when the reminder was first created (in seconds since epoch UTC).
	CreatedAt *int64 `json:"createdAt,omitempty"`
	// An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect").
	Reason *string `json:"reason,omitempty"`
}

func (*Reminder) GetAssignee ¶ 

func (r *Reminder) GetAssignee() Person

func (*Reminder) GetCreatedAt ¶ 

func (r *Reminder) GetCreatedAt() *int64

func (*Reminder) GetReason ¶ 

func (r *Reminder) GetReason() *string

func (*Reminder) GetRemindAt ¶ 

func (r *Reminder) GetRemindAt() int64

func (*Reminder) GetRequestor ¶ 

func (r *Reminder) GetRequestor() *Person

func (Reminder) MarshalJSON ¶ added in v0.9.0 

func (r Reminder) MarshalJSON() ([]byte, error)

func (*Reminder) UnmarshalJSON ¶ added in v0.9.0 

func (r *Reminder) UnmarshalJSON(data []byte) error

type ReminderRequest ¶ 

type ReminderRequest struct {
	// The document which the verification is for new reminders and/or update.
	DocumentID string `json:"documentId"`
	// The obfuscated id of the person this verification is assigned to.
	Assignee *string `json:"assignee,omitempty"`
	// Reminder for the next verifications in terms of days. For deletion, this will be omitted.
	RemindInDays *int64 `json:"remindInDays,omitempty"`
	// An optional free-text reason for the reminder. This is particularly useful when a reminder is used to ask for verification from another user (for example, "Duplicate", "Incomplete", "Incorrect").
	Reason *string `json:"reason,omitempty"`
}

func (*ReminderRequest) GetAssignee ¶ 

func (r *ReminderRequest) GetAssignee() *string

func (*ReminderRequest) GetDocumentID ¶ 

func (r *ReminderRequest) GetDocumentID() string

func (*ReminderRequest) GetReason ¶ 

func (r *ReminderRequest) GetReason() *string

func (*ReminderRequest) GetRemindInDays ¶ 

func (r *ReminderRequest) GetRemindInDays() *int64

type ReportStatusResponse ¶ 

type ReportStatusResponse struct {
	Status *ReportStatusResponseStatus `json:"status,omitempty"`
	// The timestamp at which the report's run/scan began.
	StartTime *string `json:"startTime,omitempty"`
}

func (*ReportStatusResponse) GetStartTime ¶ 

func (r *ReportStatusResponse) GetStartTime() *string

func (*ReportStatusResponse) GetStatus ¶ 

func (r *ReportStatusResponse) GetStatus() *ReportStatusResponseStatus

type ReportStatusResponseStatus ¶ 

type ReportStatusResponseStatus string
const (
	ReportStatusResponseStatusPending    ReportStatusResponseStatus = "PENDING"
	ReportStatusResponseStatusSuccess    ReportStatusResponseStatus = "SUCCESS"
	ReportStatusResponseStatusFailure    ReportStatusResponseStatus = "FAILURE"
	ReportStatusResponseStatusCancelled  ReportStatusResponseStatus = "CANCELLED"
	ReportStatusResponseStatusCancelling ReportStatusResponseStatus = "CANCELLING"
	ReportStatusResponseStatusActive     ReportStatusResponseStatus = "ACTIVE"
)

func (ReportStatusResponseStatus) ToPointer ¶ 

func (e ReportStatusResponseStatus) ToPointer() *ReportStatusResponseStatus

func (*ReportStatusResponseStatus) UnmarshalJSON ¶ 

func (e *ReportStatusResponseStatus) UnmarshalJSON(data []byte) error

type RequestType ¶ added in v0.7.0 

type RequestType string

RequestType - The type of request being made. 

const (
	RequestTypeStandard      RequestType = "STANDARD"
	RequestTypeFullDirectory RequestType = "FULL_DIRECTORY"
)

func (RequestType) ToPointer ¶ added in v0.7.0 

func (e RequestType) ToPointer() *RequestType

func (*RequestType) UnmarshalJSON ¶ added in v0.7.0 

func (e *RequestType) UnmarshalJSON(data []byte) error

type ResponseHint ¶ 

type ResponseHint string

ResponseHint - Hints for the response content. 

const (
	ResponseHintAllResultCounts    ResponseHint = "ALL_RESULT_COUNTS"
	ResponseHintFacetResults       ResponseHint = "FACET_RESULTS"
	ResponseHintQueryMetadata      ResponseHint = "QUERY_METADATA"
	ResponseHintResults            ResponseHint = "RESULTS"
	ResponseHintSpellcheckMetadata ResponseHint = "SPELLCHECK_METADATA"
)

func (ResponseHint) ToPointer ¶ 

func (e ResponseHint) ToPointer() *ResponseHint

func (*ResponseHint) UnmarshalJSON ¶ 

func (e *ResponseHint) UnmarshalJSON(data []byte) error

type ResponseMetadata ¶ added in v0.8.0 

type ResponseMetadata struct {
	// Time taken to generate the response in milliseconds.
	LatencyMs *int64 `json:"latencyMs,omitempty"`
	// Number of tokens in the response.
	TokenCount *int64 `json:"tokenCount,omitempty"`
	// The specific model version used.
	ModelUsed *string `json:"modelUsed,omitempty"`
}

ResponseMetadata - Metadata about the response (e.g., latency, token count).

func (*ResponseMetadata) GetLatencyMs ¶ added in v0.8.0 

func (r *ResponseMetadata) GetLatencyMs() *int64

func (*ResponseMetadata) GetModelUsed ¶ added in v0.8.0 

func (r *ResponseMetadata) GetModelUsed() *string

func (*ResponseMetadata) GetTokenCount ¶ added in v0.8.0 

func (r *ResponseMetadata) GetTokenCount() *int64

type ResponseStatus ¶ 

type ResponseStatus string
const (
	ResponseStatusAccepted   ResponseStatus = "ACCEPTED"
	ResponseStatusDeclined   ResponseStatus = "DECLINED"
	ResponseStatusNoResponse ResponseStatus = "NO_RESPONSE"
	ResponseStatusTentative  ResponseStatus = "TENTATIVE"
)

func (ResponseStatus) ToPointer ¶ 

func (e ResponseStatus) ToPointer() *ResponseStatus

func (*ResponseStatus) UnmarshalJSON ¶ 

func (e *ResponseStatus) UnmarshalJSON(data []byte) error

type RestrictionFilters ¶ 

type RestrictionFilters struct {
	// Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections.
	ContainerSpecs []DocumentSpecUnion `json:"containerSpecs,omitempty"`
}

func (*RestrictionFilters) GetContainerSpecs ¶ 

func (r *RestrictionFilters) GetContainerSpecs() []DocumentSpecUnion

func (RestrictionFilters) MarshalJSON ¶ added in v0.9.0 

func (r RestrictionFilters) MarshalJSON() ([]byte, error)

func (*RestrictionFilters) UnmarshalJSON ¶ added in v0.9.0 

func (r *RestrictionFilters) UnmarshalJSON(data []byte) error

type ResultDocument ¶ 

type ResultDocument struct {
	Title *string `json:"title,omitempty"`
	URL   *string `json:"url,omitempty"`
}

func (*ResultDocument) GetTitle ¶ 

func (r *ResultDocument) GetTitle() *string

func (*ResultDocument) GetURL ¶ 

func (r *ResultDocument) GetURL() *string

type ResultTab ¶ 

type ResultTab struct {
	// The unique ID of the tab. Can be passed in a search request to get results for that tab.
	ID *string `json:"id,omitempty"`
	// The number of results in this tab for the current query.
	Count *int64 `json:"count,omitempty"`
	// The datasource associated with the tab, if any.
	Datasource *string `json:"datasource,omitempty"`
	// The datasource instance associated with the tab, if any.
	DatasourceInstance *string `json:"datasourceInstance,omitempty"`
}

func (*ResultTab) GetCount ¶ 

func (r *ResultTab) GetCount() *int64

func (*ResultTab) GetDatasource ¶ 

func (r *ResultTab) GetDatasource() *string

func (*ResultTab) GetDatasourceInstance ¶ 

func (r *ResultTab) GetDatasourceInstance() *string

func (*ResultTab) GetID ¶ 

func (r *ResultTab) GetID() *string

type ResultsDescription ¶ 

type ResultsDescription struct {
	// Textual description of the results. Can be shown at the top of SERP, e.g. 'People who write about this topic' for experts in people tab.
	Text *string `json:"text,omitempty"`
	// Defines how to render an icon
	IconConfig *IconConfig `json:"iconConfig,omitempty"`
}

func (*ResultsDescription) GetIconConfig ¶ 

func (r *ResultsDescription) GetIconConfig() *IconConfig

func (*ResultsDescription) GetText ¶ 

func (r *ResultsDescription) GetText() *string

type ResultsResponse ¶ 

type ResultsResponse struct {
	// A token that should be passed for additional requests related to this request (such as more results requests).
	TrackingToken      *string            `json:"trackingToken,omitempty"`
	SessionInfo        *SessionInfo       `json:"sessionInfo,omitempty"`
	Results            []SearchResult     `json:"results,omitempty"`
	StructuredResults  []StructuredResult `json:"structuredResults,omitempty"`
	GeneratedQnaResult *GeneratedQna      `json:"generatedQnaResult,omitempty"`
	GleanDataError     *GleanDataError    `json:"errorInfo,omitempty"`
	// A platform-generated request ID to correlate backend logs.
	RequestID *string `json:"requestID,omitempty"`
	// Time in milliseconds the backend took to respond to the request.
	BackendTimeMillis *int64 `json:"backendTimeMillis,omitempty"`
}

func (*ResultsResponse) GetBackendTimeMillis ¶ 

func (r *ResultsResponse) GetBackendTimeMillis() *int64

func (*ResultsResponse) GetGeneratedQnaResult ¶ 

func (r *ResultsResponse) GetGeneratedQnaResult() *GeneratedQna

func (*ResultsResponse) GetGleanDataError ¶ 

func (r *ResultsResponse) GetGleanDataError() *GleanDataError

func (*ResultsResponse) GetRequestID ¶ 

func (r *ResultsResponse) GetRequestID() *string

func (*ResultsResponse) GetResults ¶ 

func (r *ResultsResponse) GetResults() []SearchResult

func (*ResultsResponse) GetSessionInfo ¶ 

func (r *ResultsResponse) GetSessionInfo() *SessionInfo

func (*ResultsResponse) GetStructuredResults ¶ 

func (r *ResultsResponse) GetStructuredResults() []StructuredResult

func (*ResultsResponse) GetTrackingToken ¶ 

func (r *ResultsResponse) GetTrackingToken() *string

type Role deprecated 

type Role string

Role - DEPRECATED - use permissions instead. Viewer's role on the specific document.

Deprecated: This will be removed in a future release, please migrate away from it as soon as possible. 

const (
	RoleAnswerModerator Role = "ANSWER_MODERATOR"
	RoleOwner           Role = "OWNER"
	RoleViewer          Role = "VIEWER"
)

func (Role) ToPointer ¶ 

func (e Role) ToPointer() *Role

func (*Role) UnmarshalJSON ¶ 

func (e *Role) UnmarshalJSON(data []byte) error

type RotateTokenResponse ¶ 

type RotateTokenResponse struct {
	// New raw secret
	RawSecret *string `json:"rawSecret,omitempty"`
	// Unix timestamp in seconds when the new secret value is assigned to the token. The token needs to be rotated before `rotationPeriodMinutes` past the createdAt timestamp otherwise it would be rendered unusable.
	CreatedAt *int64 `json:"createdAt,omitempty"`
	// Refers to the time period in minutes before which this token needs to be rotated. It is required to rotate the token within the specified `rotationPeriodMinutes` after each `/rotatetoken` call, otherwise the tokens would expire. Note that the token would still expire at `expiresAt` timestamp provided during token creation even if the token is being regularly rotated. `rotationPeriodMinutes` property is inherited from the parent token being rotated
	RotationPeriodMinutes *int64 `json:"rotationPeriodMinutes,omitempty"`
}

RotateTokenResponse - Describes the response body of the /rotatetoken API call

func (*RotateTokenResponse) GetCreatedAt ¶ 

func (r *RotateTokenResponse) GetCreatedAt() *int64

func (*RotateTokenResponse) GetRawSecret ¶ 

func (r *RotateTokenResponse) GetRawSecret() *string

func (*RotateTokenResponse) GetRotationPeriodMinutes ¶ 

func (r *RotateTokenResponse) GetRotationPeriodMinutes() *int64

type Scope ¶ 

type Scope string
const (
	ScopeAppCard                Scope = "APP_CARD"
	ScopeAutocompleteExactMatch Scope = "AUTOCOMPLETE_EXACT_MATCH"
	ScopeAutocompleteFuzzyMatch Scope = "AUTOCOMPLETE_FUZZY_MATCH"
	ScopeAutocompleteZeroQuery  Scope = "AUTOCOMPLETE_ZERO_QUERY"
	ScopeNewTabPage             Scope = "NEW_TAB_PAGE"
)

func (Scope) ToPointer ¶ 

func (e Scope) ToPointer() *Scope

func (*Scope) UnmarshalJSON ¶ 

func (e *Scope) UnmarshalJSON(data []byte) error

type ScopeType ¶ 

type ScopeType string

ScopeType - Describes the scope for a ReadPermission, WritePermission, or GrantPermission object 

const (
	ScopeTypeGlobal ScopeType = "GLOBAL"
	ScopeTypeOwn    ScopeType = "OWN"
)

func (ScopeType) ToPointer ¶ 

func (e ScopeType) ToPointer() *ScopeType

func (*ScopeType) UnmarshalJSON ¶ 

func (e *ScopeType) UnmarshalJSON(data []byte) error

type SearchAgentsRequest ¶ 

type SearchAgentsRequest struct {
	// Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter.
	Name *string `json:"name,omitempty"`
}

func (*SearchAgentsRequest) GetName ¶ 

func (s *SearchAgentsRequest) GetName() *string

type SearchAgentsResponse ¶ 

type SearchAgentsResponse struct {
	Agents []Agent `json:"agents,omitempty"`
}

func (*SearchAgentsResponse) GetAgents ¶ 

func (s *SearchAgentsResponse) GetAgents() []Agent

type SearchProviderInfo ¶ 

type SearchProviderInfo struct {
	// Name of the search provider.
	Name *string `json:"name,omitempty"`
	// URL to the provider's logo.
	LogoURL *string `json:"logoUrl,omitempty"`
	// URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
	SearchLinkURLTemplate *string `json:"searchLinkUrlTemplate,omitempty"`
}

func (*SearchProviderInfo) GetLogoURL ¶ 

func (s *SearchProviderInfo) GetLogoURL() *string

func (*SearchProviderInfo) GetName ¶ 

func (s *SearchProviderInfo) GetName() *string

func (*SearchProviderInfo) GetSearchLinkURLTemplate ¶ 

func (s *SearchProviderInfo) GetSearchLinkURLTemplate() *string

func (SearchProviderInfo) MarshalJSON ¶ added in v0.9.0 

func (s SearchProviderInfo) MarshalJSON() ([]byte, error)

func (*SearchProviderInfo) UnmarshalJSON ¶ added in v0.9.0 

func (s *SearchProviderInfo) UnmarshalJSON(data []byte) error

type SearchRequest ¶ 

type SearchRequest struct {
	// The ISO 8601 timestamp associated with the client request.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs.
	TrackingToken  *string      `json:"trackingToken,omitempty"`
	SessionInfo    *SessionInfo `json:"sessionInfo,omitempty"`
	SourceDocument *Document    `json:"sourceDocument,omitempty"`
	// Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize.
	PageSize *int64 `json:"pageSize,omitempty"`
	// Hint to the server about how many characters long a snippet may be. Server may return less or more.
	MaxSnippetSize *int64 `json:"maxSnippetSize,omitempty"`
	// The search terms.
	Query string `json:"query"`
	// Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.
	Cursor *string `json:"cursor,omitempty"`
	// The unique IDs of the result tabs for which to fetch results. This will have precedence over datasource filters if both are specified and in conflict.
	ResultTabIds   []string                   `json:"resultTabIds,omitempty"`
	InputDetails   *SearchRequestInputDetails `json:"inputDetails,omitempty"`
	RequestOptions *SearchRequestOptions      `json:"requestOptions,omitempty"`
	// Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer.
	TimeoutMillis *int64 `json:"timeoutMillis,omitempty"`
	// Whether or not to disable spellcheck.
	DisableSpellcheck *bool `json:"disableSpellcheck,omitempty"`
}

func (*SearchRequest) GetCursor ¶ 

func (s *SearchRequest) GetCursor() *string

func (*SearchRequest) GetDisableSpellcheck ¶ 

func (s *SearchRequest) GetDisableSpellcheck() *bool

func (*SearchRequest) GetInputDetails ¶ 

func (s *SearchRequest) GetInputDetails() *SearchRequestInputDetails

func (*SearchRequest) GetMaxSnippetSize ¶ 

func (s *SearchRequest) GetMaxSnippetSize() *int64

func (*SearchRequest) GetPageSize ¶ 

func (s *SearchRequest) GetPageSize() *int64

func (*SearchRequest) GetQuery ¶ 

func (s *SearchRequest) GetQuery() string

func (*SearchRequest) GetRequestOptions ¶ 

func (s *SearchRequest) GetRequestOptions() *SearchRequestOptions

func (*SearchRequest) GetResultTabIds ¶ 

func (s *SearchRequest) GetResultTabIds() []string

func (*SearchRequest) GetSessionInfo ¶ 

func (s *SearchRequest) GetSessionInfo() *SessionInfo

func (*SearchRequest) GetSourceDocument ¶ 

func (s *SearchRequest) GetSourceDocument() *Document

func (*SearchRequest) GetTimeoutMillis ¶ 

func (s *SearchRequest) GetTimeoutMillis() *int64

func (*SearchRequest) GetTimestamp ¶ 

func (s *SearchRequest) GetTimestamp() *time.Time

func (*SearchRequest) GetTrackingToken ¶ 

func (s *SearchRequest) GetTrackingToken() *string

func (SearchRequest) MarshalJSON ¶ 

func (s SearchRequest) MarshalJSON() ([]byte, error)

func (*SearchRequest) UnmarshalJSON ¶ 

func (s *SearchRequest) UnmarshalJSON(data []byte) error

type SearchRequestInputDetails ¶ 

type SearchRequestInputDetails struct {
	// Whether the associated query was at least partially copy-pasted.  If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
	HasCopyPaste *bool `json:"hasCopyPaste,omitempty"`
}

func (*SearchRequestInputDetails) GetHasCopyPaste ¶ 

func (s *SearchRequestInputDetails) GetHasCopyPaste() *bool

func (SearchRequestInputDetails) MarshalJSON ¶ added in v0.9.0 

func (s SearchRequestInputDetails) MarshalJSON() ([]byte, error)

func (*SearchRequestInputDetails) UnmarshalJSON ¶ added in v0.9.0 

func (s *SearchRequestInputDetails) UnmarshalJSON(data []byte) error

type SearchRequestOptions ¶ 

type SearchRequestOptions struct {
	// Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
	DatasourceFilter *string `json:"datasourceFilter,omitempty"`
	// Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
	DatasourcesFilter []string `json:"datasourcesFilter,omitempty"`
	// If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
	QueryOverridesFacetFilters *bool `json:"queryOverridesFacetFilters,omitempty"`
	// A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
	FacetFilters []FacetFilter `json:"facetFilters,omitempty"`
	// A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
	FacetFilterSets   []FacetFilterSet   `json:"facetFilterSets,omitempty"`
	FacetBucketFilter *FacetBucketFilter `json:"facetBucketFilter,omitempty"`
	// The maximum number of FacetBuckets to return in each FacetResult.
	FacetBucketSize int64 `json:"facetBucketSize"`
	// Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
	DefaultFacets []string `json:"defaultFacets,omitempty"`
	// Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
	AuthTokens []AuthToken `json:"authTokens,omitempty"`
	// Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
	FetchAllDatasourceCounts *bool `json:"fetchAllDatasourceCounts,omitempty"`
	// Array of hints containing which fields should be populated in the response.
	ResponseHints []ResponseHint `json:"responseHints,omitempty"`
	// The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
	TimezoneOffset *int64 `json:"timezoneOffset,omitempty"`
	// Whether or not to disable spellcheck.
	DisableSpellcheck *bool `json:"disableSpellcheck,omitempty"`
	// Disables automatic adjustment of the input query for spelling corrections or other reasons.
	DisableQueryAutocorrect *bool `json:"disableQueryAutocorrect,omitempty"`
	// Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, see https://developers.glean.com/guides/search/llm-content.
	ReturnLlmContentOverSnippets *bool               `json:"returnLlmContentOverSnippets,omitempty"`
	Inclusions                   *RestrictionFilters `json:"inclusions,omitempty"`
	Exclusions                   *RestrictionFilters `json:"exclusions,omitempty"`
}

func (*SearchRequestOptions) GetAuthTokens ¶ 

func (s *SearchRequestOptions) GetAuthTokens() []AuthToken

func (*SearchRequestOptions) GetDatasourceFilter ¶ 

func (s *SearchRequestOptions) GetDatasourceFilter() *string

func (*SearchRequestOptions) GetDatasourcesFilter ¶ 

func (s *SearchRequestOptions) GetDatasourcesFilter() []string

func (*SearchRequestOptions) GetDefaultFacets ¶ 

func (s *SearchRequestOptions) GetDefaultFacets() []string

func (*SearchRequestOptions) GetDisableQueryAutocorrect ¶ 

func (s *SearchRequestOptions) GetDisableQueryAutocorrect() *bool

func (*SearchRequestOptions) GetDisableSpellcheck ¶ 

func (s *SearchRequestOptions) GetDisableSpellcheck() *bool

func (*SearchRequestOptions) GetExclusions ¶ 

func (s *SearchRequestOptions) GetExclusions() *RestrictionFilters

func (*SearchRequestOptions) GetFacetBucketFilter ¶ 

func (s *SearchRequestOptions) GetFacetBucketFilter() *FacetBucketFilter

func (*SearchRequestOptions) GetFacetBucketSize ¶ 

func (s *SearchRequestOptions) GetFacetBucketSize() int64

func (*SearchRequestOptions) GetFacetFilterSets ¶ 

func (s *SearchRequestOptions) GetFacetFilterSets() []FacetFilterSet

func (*SearchRequestOptions) GetFacetFilters ¶ 

func (s *SearchRequestOptions) GetFacetFilters() []FacetFilter

func (*SearchRequestOptions) GetFetchAllDatasourceCounts ¶ 

func (s *SearchRequestOptions) GetFetchAllDatasourceCounts() *bool

func (*SearchRequestOptions) GetInclusions ¶ 

func (s *SearchRequestOptions) GetInclusions() *RestrictionFilters

func (*SearchRequestOptions) GetQueryOverridesFacetFilters ¶ 

func (s *SearchRequestOptions) GetQueryOverridesFacetFilters() *bool

func (*SearchRequestOptions) GetResponseHints ¶ 

func (s *SearchRequestOptions) GetResponseHints() []ResponseHint

func (*SearchRequestOptions) GetReturnLlmContentOverSnippets ¶ 

func (s *SearchRequestOptions) GetReturnLlmContentOverSnippets() *bool

func (*SearchRequestOptions) GetTimezoneOffset ¶ 

func (s *SearchRequestOptions) GetTimezoneOffset() *int64

func (SearchRequestOptions) MarshalJSON ¶ added in v0.9.0 

func (s SearchRequestOptions) MarshalJSON() ([]byte, error)

func (*SearchRequestOptions) UnmarshalJSON ¶ added in v0.9.0 

func (s *SearchRequestOptions) UnmarshalJSON(data []byte) error

type SearchResponse ¶ 

type SearchResponse struct {
	// A token that should be passed for additional requests related to this request (such as more results requests).
	TrackingToken      *string            `json:"trackingToken,omitempty"`
	SessionInfo        *SessionInfo       `json:"sessionInfo,omitempty"`
	Results            []SearchResult     `json:"results,omitempty"`
	StructuredResults  []StructuredResult `json:"structuredResults,omitempty"`
	GeneratedQnaResult *GeneratedQna      `json:"generatedQnaResult,omitempty"`
	GleanDataError     *GleanDataError    `json:"errorInfo,omitempty"`
	// A platform-generated request ID to correlate backend logs.
	RequestID *string `json:"requestID,omitempty"`
	// Time in milliseconds the backend took to respond to the request.
	BackendTimeMillis *int64 `json:"backendTimeMillis,omitempty"`
	// List of experiment ids for the corresponding request.
	ExperimentIds []int64                 `json:"experimentIds,omitempty"`
	Metadata      *SearchResponseMetadata `json:"metadata,omitempty"`
	FacetResults  []FacetResult           `json:"facetResults,omitempty"`
	// All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request.
	ResultTabs []ResultTab `json:"resultTabs,omitempty"`
	// The unique IDs of the result tabs to which this response belongs.
	ResultTabIds       []string            `json:"resultTabIds,omitempty"`
	ResultsDescription *ResultsDescription `json:"resultsDescription,omitempty"`
	// The actual applied facet filters based on the operators and facetFilters in the query. Useful for mapping typed operators to visual facets.
	RewrittenFacetFilters []FacetFilter `json:"rewrittenFacetFilters,omitempty"`
	// Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query.
	Cursor *string `json:"cursor,omitempty"`
	// Whether more results are available. Use cursor to retrieve them.
	HasMoreResults *bool `json:"hasMoreResults,omitempty"`
}

func (*SearchResponse) GetBackendTimeMillis ¶ 

func (s *SearchResponse) GetBackendTimeMillis() *int64

func (*SearchResponse) GetCursor ¶ 

func (s *SearchResponse) GetCursor() *string

func (*SearchResponse) GetExperimentIds ¶ 

func (s *SearchResponse) GetExperimentIds() []int64

func (*SearchResponse) GetFacetResults ¶ 

func (s *SearchResponse) GetFacetResults() []FacetResult

func (*SearchResponse) GetGeneratedQnaResult ¶ 

func (s *SearchResponse) GetGeneratedQnaResult() *GeneratedQna

func (*SearchResponse) GetGleanDataError ¶ 

func (s *SearchResponse) GetGleanDataError() *GleanDataError

func (*SearchResponse) GetHasMoreResults ¶ 

func (s *SearchResponse) GetHasMoreResults() *bool

func (*SearchResponse) GetMetadata ¶ 

func (s *SearchResponse) GetMetadata() *SearchResponseMetadata

func (*SearchResponse) GetRequestID ¶ 

func (s *SearchResponse) GetRequestID() *string

func (*SearchResponse) GetResultTabIds ¶ 

func (s *SearchResponse) GetResultTabIds() []string

func (*SearchResponse) GetResultTabs ¶ 

func (s *SearchResponse) GetResultTabs() []ResultTab

func (*SearchResponse) GetResults ¶ 

func (s *SearchResponse) GetResults() []SearchResult

func (*SearchResponse) GetResultsDescription ¶ 

func (s *SearchResponse) GetResultsDescription() *ResultsDescription

func (*SearchResponse) GetRewrittenFacetFilters ¶ 

func (s *SearchResponse) GetRewrittenFacetFilters() []FacetFilter

func (*SearchResponse) GetSessionInfo ¶ 

func (s *SearchResponse) GetSessionInfo() *SessionInfo

func (*SearchResponse) GetStructuredResults ¶ 

func (s *SearchResponse) GetStructuredResults() []StructuredResult

func (*SearchResponse) GetTrackingToken ¶ 

func (s *SearchResponse) GetTrackingToken() *string

type SearchResponseMetadata ¶ 

type SearchResponseMetadata struct {
	// A cleaned up or updated version of the query to be displayed in the query box. Useful for mapping visual facets to search operators.
	RewrittenQuery *string `json:"rewrittenQuery,omitempty"`
	// The actual query used to perform search and return results.
	SearchedQuery *string `json:"searchedQuery,omitempty"`
	// The query used to perform search and return results, with negated terms and facets removed.
	SearchedQueryWithoutNegation *string `json:"searchedQueryWithoutNegation,omitempty"`
	// The bolded ranges within the searched query.
	SearchedQueryRanges []TextRange `json:"searchedQueryRanges,omitempty"`
	// The query text sent by the client in the request.
	OriginalQuery              *string              `json:"originalQuery,omitempty"`
	QuerySuggestion            *QuerySuggestion     `json:"querySuggestion,omitempty"`
	AdditionalQuerySuggestions *QuerySuggestionList `json:"additionalQuerySuggestions,omitempty"`
	// A list of terms that were negated when processing the query.
	NegatedTerms []string `json:"negatedTerms,omitempty"`
	// A different query was performed than the one requested.
	ModifiedQueryWasUsed *bool `json:"modifiedQueryWasUsed,omitempty"`
	// No results were found for the original query. The usage of this bit in conjunction with modifiedQueryWasUsed will dictate whether the full page replacement is 0-result or few-result based.
	OriginalQueryHadNoResults *bool          `json:"originalQueryHadNoResults,omitempty"`
	SearchWarning             *SearchWarning `json:"searchWarning,omitempty"`
	// Whether the query triggered expert detection results in the People tab.
	TriggeredExpertDetection *bool `json:"triggeredExpertDetection,omitempty"`
	// Whether the query was modified to remove quotes
	IsNoQuotesSuggestion *bool `json:"isNoQuotesSuggestion,omitempty"`
}

func (*SearchResponseMetadata) GetAdditionalQuerySuggestions ¶ 

func (s *SearchResponseMetadata) GetAdditionalQuerySuggestions() *QuerySuggestionList

func (*SearchResponseMetadata) GetIsNoQuotesSuggestion ¶ 

func (s *SearchResponseMetadata) GetIsNoQuotesSuggestion() *bool

func (*SearchResponseMetadata) GetModifiedQueryWasUsed ¶ 

func (s *SearchResponseMetadata) GetModifiedQueryWasUsed() *bool

func (*SearchResponseMetadata) GetNegatedTerms ¶ 

func (s *SearchResponseMetadata) GetNegatedTerms() []string

func (*SearchResponseMetadata) GetOriginalQuery ¶ 

func (s *SearchResponseMetadata) GetOriginalQuery() *string

func (*SearchResponseMetadata) GetOriginalQueryHadNoResults ¶ 

func (s *SearchResponseMetadata) GetOriginalQueryHadNoResults() *bool

func (*SearchResponseMetadata) GetQuerySuggestion ¶ 

func (s *SearchResponseMetadata) GetQuerySuggestion() *QuerySuggestion

func (*SearchResponseMetadata) GetRewrittenQuery ¶ 

func (s *SearchResponseMetadata) GetRewrittenQuery() *string

func (*SearchResponseMetadata) GetSearchWarning ¶ 

func (s *SearchResponseMetadata) GetSearchWarning() *SearchWarning

func (*SearchResponseMetadata) GetSearchedQuery ¶ 

func (s *SearchResponseMetadata) GetSearchedQuery() *string

func (*SearchResponseMetadata) GetSearchedQueryRanges ¶ 

func (s *SearchResponseMetadata) GetSearchedQueryRanges() []TextRange

func (*SearchResponseMetadata) GetSearchedQueryWithoutNegation ¶ added in v0.8.0 

func (s *SearchResponseMetadata) GetSearchedQueryWithoutNegation() *string

func (*SearchResponseMetadata) GetTriggeredExpertDetection ¶ 

func (s *SearchResponseMetadata) GetTriggeredExpertDetection() *bool

type SearchResult ¶ 

type SearchResult struct {
	// An array of entities in the work graph retrieved via a data request.
	StructuredResults []StructuredResult `json:"structuredResults,omitempty"`
	// An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
	TrackingToken *string   `json:"trackingToken,omitempty"`
	Document      *Document `json:"document,omitempty"`
	Title         *string   `json:"title,omitempty"`
	URL           string    `json:"url"`
	// A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
	NativeAppURL *string `json:"nativeAppUrl,omitempty"`
	// Text content from the result document which contains search query terms, if available.
	Snippets []SearchResultSnippet `json:"snippets,omitempty"`
	// The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
	FullText *string `json:"fullText,omitempty"`
	// The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
	FullTextList []string `json:"fullTextList,omitempty"`
	// A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
	RelatedResults []RelatedDocuments `json:"relatedResults,omitempty"`
	// A list of results that should be displayed as associated with this result.
	ClusteredResults []SearchResult `json:"clusteredResults,omitempty"`
	// A list of results that should be displayed as associated with this result.
	AllClusteredResults []ClusterGroup `json:"allClusteredResults,omitempty"`
	// The total number of attachments.
	AttachmentCount *int64 `json:"attachmentCount,omitempty"`
	// A (potentially partial) list of results representing documents attached to the main result document.
	Attachments []SearchResult `json:"attachments,omitempty"`
	// A list of results that should be displayed as backlinks of this result in reverse chronological order.
	BacklinkResults []SearchResult `json:"backlinkResults,omitempty"`
	// The reason for inclusion of clusteredResults.
	ClusterType            *ClusterTypeEnum     `json:"clusterType,omitempty"`
	MustIncludeSuggestions *QuerySuggestionList `json:"mustIncludeSuggestions,omitempty"`
	QuerySuggestion        *QuerySuggestion     `json:"querySuggestion,omitempty"`
	// The level of visual distinction that should be given to a result.
	//
	Prominence *SearchResultProminenceEnum `json:"prominence,omitempty"`
	// Additional context for the relationship between the result and the document it's attached to.
	AttachmentContext *string `json:"attachmentContext,omitempty"`
	// A list of pins associated with this search result.
	Pins []PinDocument `json:"pins,omitempty"`
}

func (*SearchResult) GetAllClusteredResults ¶ 

func (s *SearchResult) GetAllClusteredResults() []ClusterGroup

func (*SearchResult) GetAttachmentContext ¶ 

func (s *SearchResult) GetAttachmentContext() *string

func (*SearchResult) GetAttachmentCount ¶ 

func (s *SearchResult) GetAttachmentCount() *int64

func (*SearchResult) GetAttachments ¶ 

func (s *SearchResult) GetAttachments() []SearchResult

func (*SearchResult) GetBacklinkResults ¶ 

func (s *SearchResult) GetBacklinkResults() []SearchResult

func (*SearchResult) GetClusterType ¶ 

func (s *SearchResult) GetClusterType() *ClusterTypeEnum

func (*SearchResult) GetClusteredResults ¶ 

func (s *SearchResult) GetClusteredResults() []SearchResult

func (*SearchResult) GetDocument ¶ 

func (s *SearchResult) GetDocument() *Document

func (*SearchResult) GetFullText ¶ 

func (s *SearchResult) GetFullText() *string

func (*SearchResult) GetFullTextList ¶ 

func (s *SearchResult) GetFullTextList() []string

func (*SearchResult) GetMustIncludeSuggestions ¶ 

func (s *SearchResult) GetMustIncludeSuggestions() *QuerySuggestionList

func (*SearchResult) GetNativeAppURL ¶ 

func (s *SearchResult) GetNativeAppURL() *string

func (*SearchResult) GetPins ¶ 

func (s *SearchResult) GetPins() []PinDocument

func (*SearchResult) GetProminence ¶ 

func (s *SearchResult) GetProminence() *SearchResultProminenceEnum

func (*SearchResult) GetQuerySuggestion ¶ 

func (s *SearchResult) GetQuerySuggestion() *QuerySuggestion

func (*SearchResult) GetRelatedResults ¶ 

func (s *SearchResult) GetRelatedResults() []RelatedDocuments

func (*SearchResult) GetSnippets ¶ 

func (s *SearchResult) GetSnippets() []SearchResultSnippet

func (*SearchResult) GetStructuredResults ¶ 

func (s *SearchResult) GetStructuredResults() []StructuredResult

func (*SearchResult) GetTitle ¶ 

func (s *SearchResult) GetTitle() *string

func (*SearchResult) GetTrackingToken ¶ 

func (s *SearchResult) GetTrackingToken() *string

func (*SearchResult) GetURL ¶ 

func (s *SearchResult) GetURL() string

func (SearchResult) MarshalJSON ¶ added in v0.9.0 

func (s SearchResult) MarshalJSON() ([]byte, error)

func (*SearchResult) UnmarshalJSON ¶ added in v0.9.0 

func (s *SearchResult) UnmarshalJSON(data []byte) error

type SearchResultProminenceEnum ¶ 

type SearchResultProminenceEnum string

SearchResultProminenceEnum - The level of visual distinction that should be given to a result. 

const (
	SearchResultProminenceEnumHero     SearchResultProminenceEnum = "HERO"
	SearchResultProminenceEnumPromoted SearchResultProminenceEnum = "PROMOTED"
	SearchResultProminenceEnumStandard SearchResultProminenceEnum = "STANDARD"
)

func (SearchResultProminenceEnum) ToPointer ¶ 

func (e SearchResultProminenceEnum) ToPointer() *SearchResultProminenceEnum

func (*SearchResultProminenceEnum) UnmarshalJSON ¶ 

func (e *SearchResultProminenceEnum) UnmarshalJSON(data []byte) error

type SearchResultSnippet ¶ 

type SearchResultSnippet struct {
	// The mime type of the snippets, currently either text/plain or text/html.
	MimeType *string `json:"mimeType,omitempty"`
	// A matching snippet from the document with no highlights.
	Text *string `json:"text,omitempty"`
	// Used for sorting based off the snippet's location within all_snippetable_text
	SnippetTextOrdering *int64 `json:"snippetTextOrdering,omitempty"`
	// The bolded ranges within text.
	Ranges []TextRange `json:"ranges,omitempty"`
	// A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
	URL *string `json:"url,omitempty"`
	// A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007. Use 'text' field instead.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Snippet string `json:"snippet"`
}

func (*SearchResultSnippet) GetMimeType ¶ 

func (s *SearchResultSnippet) GetMimeType() *string

func (*SearchResultSnippet) GetRanges ¶ 

func (s *SearchResultSnippet) GetRanges() []TextRange

func (*SearchResultSnippet) GetSnippet ¶ 

func (s *SearchResultSnippet) GetSnippet() string

func (*SearchResultSnippet) GetSnippetTextOrdering ¶ 

func (s *SearchResultSnippet) GetSnippetTextOrdering() *int64

func (*SearchResultSnippet) GetText ¶ 

func (s *SearchResultSnippet) GetText() *string

func (*SearchResultSnippet) GetURL ¶ 

func (s *SearchResultSnippet) GetURL() *string

func (SearchResultSnippet) MarshalJSON ¶ added in v0.9.0 

func (s SearchResultSnippet) MarshalJSON() ([]byte, error)

func (*SearchResultSnippet) UnmarshalJSON ¶ added in v0.9.0 

func (s *SearchResultSnippet) UnmarshalJSON(data []byte) error

type SearchWarning ¶ 

type SearchWarning struct {
	// The type of the warning.
	WarningType WarningType `json:"warningType"`
	// The last term we considered in the user's long query.
	LastUsedTerm *string `json:"lastUsedTerm,omitempty"`
	// The query after ignoring/removing quotes.
	QuotesIgnoredQuery *string `json:"quotesIgnoredQuery,omitempty"`
	// A list of query terms that were ignored when generating search results, if any. For example, terms containing invalid filters such as "updated:invalid_date" will be ignored.
	IgnoredTerms []string `json:"ignoredTerms,omitempty"`
}

func (*SearchWarning) GetIgnoredTerms ¶ 

func (s *SearchWarning) GetIgnoredTerms() []string

func (*SearchWarning) GetLastUsedTerm ¶ 

func (s *SearchWarning) GetLastUsedTerm() *string

func (*SearchWarning) GetQuotesIgnoredQuery ¶ 

func (s *SearchWarning) GetQuotesIgnoredQuery() *string

func (*SearchWarning) GetWarningType ¶ 

func (s *SearchWarning) GetWarningType() WarningType

type SectionType ¶ added in v0.9.0 

type SectionType string

SectionType - Type of the section. This defines how the section should be interpreted and rendered in the digest. 

const (
	SectionTypeChannel  SectionType = "CHANNEL"
	SectionTypeMentions SectionType = "MENTIONS"
	SectionTypeTopic    SectionType = "TOPIC"
)

func (SectionType) ToPointer ¶ added in v0.9.0 

func (e SectionType) ToPointer() *SectionType

func (*SectionType) UnmarshalJSON ¶ added in v0.9.0 

func (e *SectionType) UnmarshalJSON(data []byte) error

type Security ¶ 

type Security struct {
	APIToken *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=glean_api_token"`
}

func (*Security) GetAPIToken ¶ added in v0.4.1 

func (s *Security) GetAPIToken() *string

type SeenFeedbackInfo ¶ 

type SeenFeedbackInfo struct {
	// The confidence of the user seeing the object is high because they explicitly interacted with it e.g. answer impression in SERP with additional user interaction.
	IsExplicit *bool `json:"isExplicit,omitempty"`
}

func (*SeenFeedbackInfo) GetIsExplicit ¶ 

func (s *SeenFeedbackInfo) GetIsExplicit() *bool

type SensitiveContentOptions ¶ 

type SensitiveContentOptions struct {
	// Predefined categories of terms to consider as sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available types.
	SensitiveInfoTypes []SensitiveInfoType `json:"sensitiveInfoTypes,omitempty"`
	// list of words and phrases to consider as sensitive content
	SensitiveTerms []SensitiveExpression `json:"sensitiveTerms,omitempty"`
	// list of regular expressions to consider as sensitive content
	SensitiveRegexes []SensitiveExpression `json:"sensitiveRegexes,omitempty"`
}

SensitiveContentOptions - Options for defining sensitive content within scanned documents.

func (*SensitiveContentOptions) GetSensitiveInfoTypes ¶ 

func (s *SensitiveContentOptions) GetSensitiveInfoTypes() []SensitiveInfoType

func (*SensitiveContentOptions) GetSensitiveRegexes ¶ 

func (s *SensitiveContentOptions) GetSensitiveRegexes() []SensitiveExpression

func (*SensitiveContentOptions) GetSensitiveTerms ¶ 

func (s *SensitiveContentOptions) GetSensitiveTerms() []SensitiveExpression

type SensitiveExpression ¶ 

type SensitiveExpression struct {
	// Sensitive word, phrase, or regular expression.
	Expression *string `json:"expression,omitempty"`
	// Zero to three proximate regular expressions necessary to consider an expression as sensitive content.
	Hotwords []Hotword `json:"hotwords,omitempty"`
}

func (*SensitiveExpression) GetExpression ¶ 

func (s *SensitiveExpression) GetExpression() *string

func (*SensitiveExpression) GetHotwords ¶ 

func (s *SensitiveExpression) GetHotwords() []Hotword

type SensitiveInfoType ¶ 

type SensitiveInfoType struct {
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	LikelihoodThreshold *LikelihoodThreshold `json:"likelihoodThreshold,omitempty"`
	// Text representation of an info-type to scan for.
	InfoType *string `json:"infoType,omitempty"`
}

func (*SensitiveInfoType) GetInfoType ¶ 

func (s *SensitiveInfoType) GetInfoType() *string

func (*SensitiveInfoType) GetLikelihoodThreshold ¶ 

func (s *SensitiveInfoType) GetLikelihoodThreshold() *LikelihoodThreshold

type SessionInfo ¶ 

type SessionInfo struct {
	// A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab.
	SessionTrackingToken *string `json:"sessionTrackingToken,omitempty"`
	// A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab.
	TabID *string `json:"tabId,omitempty"`
	// The last time the server saw this token.
	LastSeen *time.Time `json:"lastSeen,omitempty"`
	// The last query seen by the server.
	LastQuery *string `json:"lastQuery,omitempty"`
}

func (*SessionInfo) GetLastQuery ¶ 

func (s *SessionInfo) GetLastQuery() *string

func (*SessionInfo) GetLastSeen ¶ 

func (s *SessionInfo) GetLastSeen() *time.Time

func (*SessionInfo) GetSessionTrackingToken ¶ 

func (s *SessionInfo) GetSessionTrackingToken() *string

func (*SessionInfo) GetTabID ¶ 

func (s *SessionInfo) GetTabID() *string

func (SessionInfo) MarshalJSON ¶ 

func (s SessionInfo) MarshalJSON() ([]byte, error)

func (*SessionInfo) UnmarshalJSON ¶ 

func (s *SessionInfo) UnmarshalJSON(data []byte) error

type Share ¶ 

type Share struct {
	// The number of days that has passed since the share happened
	NumDaysAgo      int64     `json:"numDaysAgo"`
	Sharer          *Person   `json:"sharer,omitempty"`
	SharingDocument *Document `json:"sharingDocument,omitempty"`
}

Share - Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip

func (*Share) GetNumDaysAgo ¶ 

func (s *Share) GetNumDaysAgo() int64

func (*Share) GetSharer ¶ 

func (s *Share) GetSharer() *Person

func (*Share) GetSharingDocument ¶ 

func (s *Share) GetSharingDocument() *Document

func (Share) MarshalJSON ¶ added in v0.9.0 

func (s Share) MarshalJSON() ([]byte, error)

func (*Share) UnmarshalJSON ¶ added in v0.9.0 

func (s *Share) UnmarshalJSON(data []byte) error

type SharingOptions ¶ 

type SharingOptions struct {
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Enabled *bool `json:"enabled,omitempty"`
	// The minimum number of users the document is shared with.
	Threshold *int64 `json:"threshold,omitempty"`
	// Documents will be filtered based on how many people have access to it.
	ThresholdEnabled *bool `json:"thresholdEnabled,omitempty"`
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	AnyoneWithLinkEnabled *bool `json:"anyoneWithLinkEnabled,omitempty"`
	// Only users within the organization can access the document.
	AnyoneInternalEnabled *bool `json:"anyoneInternalEnabled,omitempty"`
	// Anyone on the internet can access the document.
	AnonymousAccessEnabled *bool `json:"anonymousAccessEnabled,omitempty"`
	// Enable user access check
	UserAccessEnabled *bool `json:"userAccessEnabled,omitempty"`
	// Any one of the specified users can access the document.
	UserIds []string `json:"userIds,omitempty"`
}

SharingOptions - Controls how "shared" a document must be to get picked for scans.

func (*SharingOptions) GetAnonymousAccessEnabled ¶ 

func (s *SharingOptions) GetAnonymousAccessEnabled() *bool

func (*SharingOptions) GetAnyoneInternalEnabled ¶ 

func (s *SharingOptions) GetAnyoneInternalEnabled() *bool

func (*SharingOptions) GetAnyoneWithLinkEnabled ¶ 

func (s *SharingOptions) GetAnyoneWithLinkEnabled() *bool

func (*SharingOptions) GetEnabled ¶ 

func (s *SharingOptions) GetEnabled() *bool

func (*SharingOptions) GetThreshold ¶ 

func (s *SharingOptions) GetThreshold() *int64

func (*SharingOptions) GetThresholdEnabled ¶ 

func (s *SharingOptions) GetThresholdEnabled() *bool

func (*SharingOptions) GetUserAccessEnabled ¶ 

func (s *SharingOptions) GetUserAccessEnabled() *bool

func (*SharingOptions) GetUserIds ¶ 

func (s *SharingOptions) GetUserIds() []string

type Shortcut ¶ 

type Shortcut struct {
	// The opaque id of the user generated content.
	ID *int64 `json:"id,omitempty"`
	// Link text following go/ prefix as entered by the user.
	InputAlias string `json:"inputAlias"`
	// Destination URL for the shortcut.
	DestinationURL *string `json:"destinationUrl,omitempty"`
	// Glean Document ID for the URL, if known.
	DestinationDocumentID *string `json:"destinationDocumentId,omitempty"`
	// A short, plain text blurb to help people understand the intent of the shortcut.
	Description *string `json:"description,omitempty"`
	// Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
	Unlisted *bool `json:"unlisted,omitempty"`
	// For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL.
	URLTemplate *string `json:"urlTemplate,omitempty"`
	// A list of user roles added for the Shortcut.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of user roles removed for the Shortcut.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
	Permissions  *ObjectPermissions      `json:"permissions,omitempty"`
	CreatedBy    *Person                 `json:"createdBy,omitempty"`
	// The time the shortcut was created in ISO format (ISO 8601).
	CreateTime *time.Time `json:"createTime,omitempty"`
	UpdatedBy  *Person    `json:"updatedBy,omitempty"`
	// The time the shortcut was updated in ISO format (ISO 8601).
	UpdateTime          *time.Time `json:"updateTime,omitempty"`
	DestinationDocument *Document  `json:"destinationDocument,omitempty"`
	// The URL from which the user is then redirected to the destination URL. Full replacement for https://go/<inputAlias>.
	IntermediateURL *string `json:"intermediateUrl,omitempty"`
	// The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts.
	ViewPrefix *string `json:"viewPrefix,omitempty"`
	// Indicates whether a shortcut is native or external.
	IsExternal *bool `json:"isExternal,omitempty"`
	// The URL using which the user can access the edit page of the shortcut.
	EditURL *string `json:"editUrl,omitempty"`
	// canonical link text following go/ prefix where hyphen/underscore is removed.
	Alias *string `json:"alias,omitempty"`
	// Title for the Go Link
	Title *string `json:"title,omitempty"`
	// A list of user roles for the Go Link.
	Roles []UserRoleSpecification `json:"roles,omitempty"`
}

func (*Shortcut) GetAddedRoles ¶ 

func (s *Shortcut) GetAddedRoles() []UserRoleSpecification

func (*Shortcut) GetAlias ¶ 

func (s *Shortcut) GetAlias() *string

func (*Shortcut) GetCreateTime ¶ 

func (s *Shortcut) GetCreateTime() *time.Time

func (*Shortcut) GetCreatedBy ¶ 

func (s *Shortcut) GetCreatedBy() *Person

func (*Shortcut) GetDescription ¶ 

func (s *Shortcut) GetDescription() *string

func (*Shortcut) GetDestinationDocument ¶ 

func (s *Shortcut) GetDestinationDocument() *Document

func (*Shortcut) GetDestinationDocumentID ¶ 

func (s *Shortcut) GetDestinationDocumentID() *string

func (*Shortcut) GetDestinationURL ¶ 

func (s *Shortcut) GetDestinationURL() *string

func (*Shortcut) GetEditURL ¶ 

func (s *Shortcut) GetEditURL() *string

func (*Shortcut) GetID ¶ 

func (s *Shortcut) GetID() *int64

func (*Shortcut) GetInputAlias ¶ 

func (s *Shortcut) GetInputAlias() string

func (*Shortcut) GetIntermediateURL ¶ 

func (s *Shortcut) GetIntermediateURL() *string

func (*Shortcut) GetIsExternal ¶ 

func (s *Shortcut) GetIsExternal() *bool

func (*Shortcut) GetPermissions ¶ 

func (s *Shortcut) GetPermissions() *ObjectPermissions

func (*Shortcut) GetRemovedRoles ¶ 

func (s *Shortcut) GetRemovedRoles() []UserRoleSpecification

func (*Shortcut) GetRoles ¶ 

func (s *Shortcut) GetRoles() []UserRoleSpecification

func (*Shortcut) GetTitle ¶ 

func (s *Shortcut) GetTitle() *string

func (*Shortcut) GetURLTemplate ¶ 

func (s *Shortcut) GetURLTemplate() *string

func (*Shortcut) GetUnlisted ¶ 

func (s *Shortcut) GetUnlisted() *bool

func (*Shortcut) GetUpdateTime ¶ 

func (s *Shortcut) GetUpdateTime() *time.Time

func (*Shortcut) GetUpdatedBy ¶ 

func (s *Shortcut) GetUpdatedBy() *Person

func (*Shortcut) GetViewPrefix ¶ 

func (s *Shortcut) GetViewPrefix() *string

func (Shortcut) MarshalJSON ¶ 

func (s Shortcut) MarshalJSON() ([]byte, error)

func (*Shortcut) UnmarshalJSON ¶ 

func (s *Shortcut) UnmarshalJSON(data []byte) error

type ShortcutError ¶ 

type ShortcutError struct {
	ErrorType *ShortcutErrorErrorType `json:"errorType,omitempty"`
}

func (*ShortcutError) GetErrorType ¶ 

func (s *ShortcutError) GetErrorType() *ShortcutErrorErrorType

type ShortcutErrorErrorType ¶ 

type ShortcutErrorErrorType string
const (
	ShortcutErrorErrorTypeNoPermission     ShortcutErrorErrorType = "NO_PERMISSION"
	ShortcutErrorErrorTypeInvalidID        ShortcutErrorErrorType = "INVALID_ID"
	ShortcutErrorErrorTypeExistingShortcut ShortcutErrorErrorType = "EXISTING_SHORTCUT"
	ShortcutErrorErrorTypeInvalidChars     ShortcutErrorErrorType = "INVALID_CHARS"
)

func (ShortcutErrorErrorType) ToPointer ¶ 

func (e ShortcutErrorErrorType) ToPointer() *ShortcutErrorErrorType

func (*ShortcutErrorErrorType) UnmarshalJSON ¶ 

func (e *ShortcutErrorErrorType) UnmarshalJSON(data []byte) error

type ShortcutInsight ¶ 

type ShortcutInsight struct {
	Shortcut     Shortcut   `json:"shortcut"`
	VisitCount   *CountInfo `json:"visitCount,omitempty"`
	VisitorCount *CountInfo `json:"visitorCount,omitempty"`
}

func (*ShortcutInsight) GetShortcut ¶ 

func (s *ShortcutInsight) GetShortcut() Shortcut

func (*ShortcutInsight) GetVisitCount ¶ 

func (s *ShortcutInsight) GetVisitCount() *CountInfo

func (*ShortcutInsight) GetVisitorCount ¶ 

func (s *ShortcutInsight) GetVisitorCount() *CountInfo

type ShortcutInsightsResponse ¶ 

type ShortcutInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp *int64 `json:"lastLogTimestamp,omitempty"`
	// Insights for shortcuts.
	ShortcutInsights []ShortcutInsight `json:"shortcutInsights,omitempty"`
	// list of departments applicable for shortcuts tab.
	Departments []string `json:"departments,omitempty"`
	// Min threshold in number of visitors while populating results, otherwise 0.
	MinVisitorThreshold *int64 `json:"minVisitorThreshold,omitempty"`
}

func (*ShortcutInsightsResponse) GetDepartments ¶ 

func (s *ShortcutInsightsResponse) GetDepartments() []string

func (*ShortcutInsightsResponse) GetLastLogTimestamp ¶ 

func (s *ShortcutInsightsResponse) GetLastLogTimestamp() *int64

func (*ShortcutInsightsResponse) GetMinVisitorThreshold ¶ 

func (s *ShortcutInsightsResponse) GetMinVisitorThreshold() *int64

func (*ShortcutInsightsResponse) GetShortcutInsights ¶ 

func (s *ShortcutInsightsResponse) GetShortcutInsights() []ShortcutInsight

type ShortcutMutableProperties ¶ 

type ShortcutMutableProperties struct {
	// Link text following go/ prefix as entered by the user.
	InputAlias *string `json:"inputAlias,omitempty"`
	// Destination URL for the shortcut.
	DestinationURL *string `json:"destinationUrl,omitempty"`
	// Glean Document ID for the URL, if known.
	DestinationDocumentID *string `json:"destinationDocumentId,omitempty"`
	// A short, plain text blurb to help people understand the intent of the shortcut.
	Description *string `json:"description,omitempty"`
	// Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
	Unlisted *bool `json:"unlisted,omitempty"`
	// For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL.
	URLTemplate *string `json:"urlTemplate,omitempty"`
	// A list of user roles added for the Shortcut.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of user roles removed for the Shortcut.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
}

func (*ShortcutMutableProperties) GetAddedRoles ¶ 

func (s *ShortcutMutableProperties) GetAddedRoles() []UserRoleSpecification

func (*ShortcutMutableProperties) GetDescription ¶ 

func (s *ShortcutMutableProperties) GetDescription() *string

func (*ShortcutMutableProperties) GetDestinationDocumentID ¶ 

func (s *ShortcutMutableProperties) GetDestinationDocumentID() *string

func (*ShortcutMutableProperties) GetDestinationURL ¶ 

func (s *ShortcutMutableProperties) GetDestinationURL() *string

func (*ShortcutMutableProperties) GetInputAlias ¶ 

func (s *ShortcutMutableProperties) GetInputAlias() *string

func (*ShortcutMutableProperties) GetRemovedRoles ¶ 

func (s *ShortcutMutableProperties) GetRemovedRoles() []UserRoleSpecification

func (*ShortcutMutableProperties) GetURLTemplate ¶ 

func (s *ShortcutMutableProperties) GetURLTemplate() *string

func (*ShortcutMutableProperties) GetUnlisted ¶ 

func (s *ShortcutMutableProperties) GetUnlisted() *bool

type ShortcutsPaginationMetadata ¶ 

type ShortcutsPaginationMetadata struct {
	// Cursor indicates the start of the next page of results
	Cursor         *string `json:"cursor,omitempty"`
	HasNextPage    *bool   `json:"hasNextPage,omitempty"`
	TotalItemCount *int64  `json:"totalItemCount,omitempty"`
}

func (*ShortcutsPaginationMetadata) GetCursor ¶ 

func (s *ShortcutsPaginationMetadata) GetCursor() *string

func (*ShortcutsPaginationMetadata) GetHasNextPage ¶ 

func (s *ShortcutsPaginationMetadata) GetHasNextPage() *bool

func (*ShortcutsPaginationMetadata) GetTotalItemCount ¶ 

func (s *ShortcutsPaginationMetadata) GetTotalItemCount() *int64

type SideBySideImplementation ¶ added in v0.8.0 

type SideBySideImplementation struct {
	// Unique identifier for this implementation variant.
	ImplementationID *string `json:"implementationId,omitempty"`
	// Human-readable name for this implementation (e.g., "Variant A", "GPT-4", "Claude").
	ImplementationName *string `json:"implementationName,omitempty"`
	// The search/chat parameters used for this implementation.
	SearchParams map[string]string `json:"searchParams,omitempty"`
	// The full response generated by this implementation.
	Response *string `json:"response,omitempty"`
	// Metadata about the response (e.g., latency, token count).
	ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
}

func (*SideBySideImplementation) GetImplementationID ¶ added in v0.8.0 

func (s *SideBySideImplementation) GetImplementationID() *string

func (*SideBySideImplementation) GetImplementationName ¶ added in v0.8.0 

func (s *SideBySideImplementation) GetImplementationName() *string

func (*SideBySideImplementation) GetResponse ¶ added in v0.8.0 

func (s *SideBySideImplementation) GetResponse() *string

func (*SideBySideImplementation) GetResponseMetadata ¶ added in v0.8.0 

func (s *SideBySideImplementation) GetResponseMetadata() *ResponseMetadata

func (*SideBySideImplementation) GetSearchParams ¶ added in v0.8.0 

func (s *SideBySideImplementation) GetSearchParams() map[string]string

type SocialNetwork ¶ 

type SocialNetwork struct {
	// Possible values are "twitter", "linkedin".
	Name string `json:"name"`
	// Human-readable profile name.
	ProfileName *string `json:"profileName,omitempty"`
	// Link to profile.
	ProfileURL string `json:"profileUrl"`
}

func (*SocialNetwork) GetName ¶ 

func (s *SocialNetwork) GetName() string

func (*SocialNetwork) GetProfileName ¶ 

func (s *SocialNetwork) GetProfileName() *string

func (*SocialNetwork) GetProfileURL ¶ 

func (s *SocialNetwork) GetProfileURL() string

func (SocialNetwork) MarshalJSON ¶ added in v0.9.0 

func (s SocialNetwork) MarshalJSON() ([]byte, error)

func (*SocialNetwork) UnmarshalJSON ¶ added in v0.9.0 

func (s *SocialNetwork) UnmarshalJSON(data []byte) error

type SocialNetworkDefinition ¶ 

type SocialNetworkDefinition struct {
	// Possible values are "twitter", "linkedin".
	Name *string `json:"name,omitempty"`
	// Human-readable profile name.
	ProfileName *string `json:"profileName,omitempty"`
	// Link to profile.
	ProfileURL *string `json:"profileUrl,omitempty"`
}

SocialNetworkDefinition - Employee's social network profile

func (*SocialNetworkDefinition) GetName ¶ 

func (s *SocialNetworkDefinition) GetName() *string

func (*SocialNetworkDefinition) GetProfileName ¶ 

func (s *SocialNetworkDefinition) GetProfileName() *string

func (*SocialNetworkDefinition) GetProfileURL ¶ 

func (s *SocialNetworkDefinition) GetProfileURL() *string

type SortOptions ¶ 

type SortOptions struct {
	OrderBy *OrderBy `json:"orderBy,omitempty"`
	SortBy  *string  `json:"sortBy,omitempty"`
}

func (*SortOptions) GetOrderBy ¶ 

func (s *SortOptions) GetOrderBy() *OrderBy

func (*SortOptions) GetSortBy ¶ 

func (s *SortOptions) GetSortBy() *string

type State ¶ 

type State string

State - The verification state for the document. 

const (
	StateUnverified State = "UNVERIFIED"
	StateVerified   State = "VERIFIED"
	StateDeprecated State = "DEPRECATED"
)

func (State) ToPointer ¶ 

func (e State) ToPointer() *State

func (*State) UnmarshalJSON ¶ 

func (e *State) UnmarshalJSON(data []byte) error
type StructuredLink struct {
	// The display name for the link
	Name *string `json:"name,omitempty"`
	// The URL for the link.
	URL *string `json:"url,omitempty"`
	// Defines how to render an icon
	IconConfig *IconConfig `json:"iconConfig,omitempty"`
}

StructuredLink - The display configuration for a link.

func (*StructuredLink) GetIconConfig ¶ 

func (s *StructuredLink) GetIconConfig() *IconConfig

func (*StructuredLink) GetName ¶ 

func (s *StructuredLink) GetName() *string

func (*StructuredLink) GetURL ¶ 

func (s *StructuredLink) GetURL() *string

type StructuredLocation ¶ 

type StructuredLocation struct {
	// Desk number.
	DeskLocation *string `json:"deskLocation,omitempty"`
	// Location's timezone, e.g. UTC, PST.
	Timezone *string `json:"timezone,omitempty"`
	// Office address or name.
	Address *string `json:"address,omitempty"`
	// Name of the city.
	City *string `json:"city,omitempty"`
	// State code.
	State *string `json:"state,omitempty"`
	// Region information, e.g. NORAM, APAC.
	Region *string `json:"region,omitempty"`
	// ZIP Code for the address.
	ZipCode *string `json:"zipCode,omitempty"`
	// Country name.
	Country *string `json:"country,omitempty"`
	// Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA.
	CountryCode *string `json:"countryCode,omitempty"`
}

StructuredLocation - Detailed location with information about country, state, city etc.

func (*StructuredLocation) GetAddress ¶ 

func (s *StructuredLocation) GetAddress() *string

func (*StructuredLocation) GetCity ¶ 

func (s *StructuredLocation) GetCity() *string

func (*StructuredLocation) GetCountry ¶ 

func (s *StructuredLocation) GetCountry() *string

func (*StructuredLocation) GetCountryCode ¶ 

func (s *StructuredLocation) GetCountryCode() *string

func (*StructuredLocation) GetDeskLocation ¶ 

func (s *StructuredLocation) GetDeskLocation() *string

func (*StructuredLocation) GetRegion ¶ 

func (s *StructuredLocation) GetRegion() *string

func (*StructuredLocation) GetState ¶ 

func (s *StructuredLocation) GetState() *string

func (*StructuredLocation) GetTimezone ¶ 

func (s *StructuredLocation) GetTimezone() *string

func (*StructuredLocation) GetZipCode ¶ 

func (s *StructuredLocation) GetZipCode() *string

func (StructuredLocation) MarshalJSON ¶ added in v0.9.0 

func (s StructuredLocation) MarshalJSON() ([]byte, error)

func (*StructuredLocation) UnmarshalJSON ¶ added in v0.9.0 

func (s *StructuredLocation) UnmarshalJSON(data []byte) error

type StructuredResult ¶ 

type StructuredResult struct {
	Document         *Document            `json:"document,omitempty"`
	Person           *Person              `json:"person,omitempty"`
	Customer         *Customer            `json:"customer,omitempty"`
	Team             *Team                `json:"team,omitempty"`
	CustomEntity     *CustomEntity        `json:"customEntity,omitempty"`
	Answer           *Answer              `json:"answer,omitempty"`
	GeneratedQna     *GeneratedQna        `json:"generatedQna,omitempty"`
	ExtractedQnA     *ExtractedQnA        `json:"extractedQnA,omitempty"`
	Meeting          *Meeting             `json:"meeting,omitempty"`
	App              *AppResult           `json:"app,omitempty"`
	Collection       *Collection          `json:"collection,omitempty"`
	AnswerBoard      *AnswerBoard         `json:"answerBoard,omitempty"`
	Code             *Code                `json:"code,omitempty"`
	Shortcut         *Shortcut            `json:"shortcut,omitempty"`
	QuerySuggestions *QuerySuggestionList `json:"querySuggestions,omitempty"`
	// A list of documents related to this structured result.
	RelatedDocuments []RelatedDocuments `json:"relatedDocuments,omitempty"`
	RelatedQuestion  *RelatedQuestion   `json:"relatedQuestion,omitempty"`
	// A disambiguation between multiple entities with the same name
	Disambiguation *Disambiguation `json:"disambiguation,omitempty"`
	// Any snippets associated to the populated object.
	Snippets []SearchResultSnippet `json:"snippets,omitempty"`
	// An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
	// The level of visual distinction that should be given to a result.
	Prominence *Prominence `json:"prominence,omitempty"`
	// Source context for this result. Possible values depend on the result type.
	Source *StructuredResultSource `json:"source,omitempty"`
}

StructuredResult - A single object that can support any object in the work graph. Only a single object will be populated.

func (*StructuredResult) GetAnswer ¶ 

func (s *StructuredResult) GetAnswer() *Answer

func (*StructuredResult) GetAnswerBoard ¶ 

func (s *StructuredResult) GetAnswerBoard() *AnswerBoard

func (*StructuredResult) GetApp ¶ 

func (s *StructuredResult) GetApp() *AppResult

func (*StructuredResult) GetCode ¶ 

func (s *StructuredResult) GetCode() *Code

func (*StructuredResult) GetCollection ¶ 

func (s *StructuredResult) GetCollection() *Collection

func (*StructuredResult) GetCustomEntity ¶ 

func (s *StructuredResult) GetCustomEntity() *CustomEntity

func (*StructuredResult) GetCustomer ¶ 

func (s *StructuredResult) GetCustomer() *Customer

func (*StructuredResult) GetDisambiguation ¶ 

func (s *StructuredResult) GetDisambiguation() *Disambiguation

func (*StructuredResult) GetDocument ¶ 

func (s *StructuredResult) GetDocument() *Document

func (*StructuredResult) GetExtractedQnA ¶ 

func (s *StructuredResult) GetExtractedQnA() *ExtractedQnA

func (*StructuredResult) GetGeneratedQna ¶ added in v0.8.0 

func (s *StructuredResult) GetGeneratedQna() *GeneratedQna

func (*StructuredResult) GetMeeting ¶ 

func (s *StructuredResult) GetMeeting() *Meeting

func (*StructuredResult) GetPerson ¶ 

func (s *StructuredResult) GetPerson() *Person

func (*StructuredResult) GetProminence ¶ 

func (s *StructuredResult) GetProminence() *Prominence

func (*StructuredResult) GetQuerySuggestions ¶ 

func (s *StructuredResult) GetQuerySuggestions() *QuerySuggestionList

func (*StructuredResult) GetRelatedDocuments ¶ 

func (s *StructuredResult) GetRelatedDocuments() []RelatedDocuments

func (*StructuredResult) GetRelatedQuestion ¶ 

func (s *StructuredResult) GetRelatedQuestion() *RelatedQuestion

func (*StructuredResult) GetShortcut ¶ 

func (s *StructuredResult) GetShortcut() *Shortcut

func (*StructuredResult) GetSnippets ¶ 

func (s *StructuredResult) GetSnippets() []SearchResultSnippet

func (*StructuredResult) GetSource ¶ 

func (s *StructuredResult) GetSource() *StructuredResultSource

func (*StructuredResult) GetTeam ¶ 

func (s *StructuredResult) GetTeam() *Team

func (*StructuredResult) GetTrackingToken ¶ 

func (s *StructuredResult) GetTrackingToken() *string

func (StructuredResult) MarshalJSON ¶ added in v0.9.0 

func (s StructuredResult) MarshalJSON() ([]byte, error)

func (*StructuredResult) UnmarshalJSON ¶ added in v0.9.0 

func (s *StructuredResult) UnmarshalJSON(data []byte) error

type StructuredResultSource ¶ 

type StructuredResultSource string

StructuredResultSource - Source context for this result. Possible values depend on the result type. 

const (
	StructuredResultSourceExpertDetection StructuredResultSource = "EXPERT_DETECTION"
	StructuredResultSourceEntityNlq       StructuredResultSource = "ENTITY_NLQ"
)

func (StructuredResultSource) ToPointer ¶ 

func (e StructuredResultSource) ToPointer() *StructuredResultSource

func (*StructuredResultSource) UnmarshalJSON ¶ 

func (e *StructuredResultSource) UnmarshalJSON(data []byte) error

type StructuredText ¶ 

type StructuredText struct {
	Text string `json:"text"`
	// An array of objects each of which contains either a string or a link which optionally corresponds to a document.
	StructuredList []StructuredTextItem `json:"structuredList,omitempty"`
}

func (*StructuredText) GetStructuredList ¶ 

func (s *StructuredText) GetStructuredList() []StructuredTextItem

func (*StructuredText) GetText ¶ 

func (s *StructuredText) GetText() string

func (StructuredText) MarshalJSON ¶ added in v0.9.0 

func (s StructuredText) MarshalJSON() ([]byte, error)

func (*StructuredText) UnmarshalJSON ¶ added in v0.9.0 

func (s *StructuredText) UnmarshalJSON(data []byte) error

type StructuredTextItem ¶ 

type StructuredTextItem struct {
	Link     *string   `json:"link,omitempty"`
	Document *Document `json:"document,omitempty"`
	Text     *string   `json:"text,omitempty"`
	// A single object that can support any object in the work graph. Only a single object will be populated.
	StructuredResult *StructuredResult `json:"structuredResult,omitempty"`
}

func (*StructuredTextItem) GetDocument ¶ 

func (s *StructuredTextItem) GetDocument() *Document
func (s *StructuredTextItem) GetLink() *string

func (*StructuredTextItem) GetStructuredResult ¶ 

func (s *StructuredTextItem) GetStructuredResult() *StructuredResult

func (*StructuredTextItem) GetText ¶ 

func (s *StructuredTextItem) GetText() *string

func (StructuredTextItem) MarshalJSON ¶ added in v0.9.0 

func (s StructuredTextItem) MarshalJSON() ([]byte, error)

func (*StructuredTextItem) UnmarshalJSON ¶ added in v0.9.0 

func (s *StructuredTextItem) UnmarshalJSON(data []byte) error

type StructuredTextMutableProperties ¶ 

type StructuredTextMutableProperties struct {
	Text string `json:"text"`
}

func (*StructuredTextMutableProperties) GetText ¶ 

func (s *StructuredTextMutableProperties) GetText() string

type SummarizeRequest ¶ 

type SummarizeRequest struct {
	// The ISO 8601 timestamp associated with the client request.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Optional query that the summary should be about
	Query *string `json:"query,omitempty"`
	// Optional length of summary output. If not given, defaults to 500 chars.
	PreferredSummaryLength *int64 `json:"preferredSummaryLength,omitempty"`
	// Specifications of documents to summarize
	DocumentSpecs []DocumentSpecUnion `json:"documentSpecs"`
	// An opaque token that represents this particular result. To be used for /feedback reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
}

SummarizeRequest - Summary of the document

func (*SummarizeRequest) GetDocumentSpecs ¶ 

func (s *SummarizeRequest) GetDocumentSpecs() []DocumentSpecUnion

func (*SummarizeRequest) GetPreferredSummaryLength ¶ 

func (s *SummarizeRequest) GetPreferredSummaryLength() *int64

func (*SummarizeRequest) GetQuery ¶ 

func (s *SummarizeRequest) GetQuery() *string

func (*SummarizeRequest) GetTimestamp ¶ 

func (s *SummarizeRequest) GetTimestamp() *time.Time

func (*SummarizeRequest) GetTrackingToken ¶ 

func (s *SummarizeRequest) GetTrackingToken() *string

func (SummarizeRequest) MarshalJSON ¶ 

func (s SummarizeRequest) MarshalJSON() ([]byte, error)

func (*SummarizeRequest) UnmarshalJSON ¶ 

func (s *SummarizeRequest) UnmarshalJSON(data []byte) error

type SummarizeResponse ¶ 

type SummarizeResponse struct {
	Error   *Error   `json:"error,omitempty"`
	Summary *Summary `json:"summary,omitempty"`
	// An opaque token that represents this summary in this particular query. To be used for /feedback reporting.
	TrackingToken *string `json:"trackingToken,omitempty"`
}

func (*SummarizeResponse) GetError ¶ 

func (s *SummarizeResponse) GetError() *Error

func (*SummarizeResponse) GetSummary ¶ 

func (s *SummarizeResponse) GetSummary() *Summary

func (*SummarizeResponse) GetTrackingToken ¶ 

func (s *SummarizeResponse) GetTrackingToken() *string

type Summary ¶ 

type Summary struct {
	Text *string `json:"text,omitempty"`
	// Follow-up prompts based on the summarized doc
	FollowUpPrompts []string `json:"followUpPrompts,omitempty"`
}

func (*Summary) GetFollowUpPrompts ¶ 

func (s *Summary) GetFollowUpPrompts() []string

func (*Summary) GetText ¶ 

func (s *Summary) GetText() *string

type Team ¶ 

type Team struct {
	// A list of objects related to a source object.
	RelatedObjects map[string]RelatedObjectEdge `json:"relatedObjects,omitempty"`
	Permissions    *ObjectPermissions           `json:"permissions,omitempty"`
	// Unique identifier
	ID string `json:"id"`
	// Team name
	Name string `json:"name"`
	// A description of the team
	Description *string `json:"description,omitempty"`
	// Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
	BusinessUnit *string `json:"businessUnit,omitempty"`
	// An organizational unit where everyone has a similar task, e.g. `Engineering`.
	Department *string `json:"department,omitempty"`
	// A link to the team's photo.
	PhotoURL *string `json:"photoUrl,omitempty"`
	// A link to the team's banner photo.
	BannerURL *string `json:"bannerUrl,omitempty"`
	// Link to a team page on the internet or your company's intranet
	ExternalLink *string `json:"externalLink,omitempty"`
	// The members on this team
	Members []PersonToTeamRelationship `json:"members,omitempty"`
	// Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team)
	MemberCount *int64 `json:"memberCount,omitempty"`
	// The emails for this team
	Emails []TeamEmail `json:"emails,omitempty"`
	// Customizable fields for additional team information.
	CustomFields []CustomFieldData `json:"customFields,omitempty"`
	// The datasource profiles of the team
	DatasourceProfiles []DatasourceProfile `json:"datasourceProfiles,omitempty"`
	// the data source of the team, e.g. GDRIVE
	Datasource *string `json:"datasource,omitempty"`
	// For teams created from docs, the doc title. Otherwise empty.
	CreatedFrom *string `json:"createdFrom,omitempty"`
	// when this team was last updated.
	LastUpdatedAt *time.Time `json:"lastUpdatedAt,omitempty"`
	// whether this team is fully processed or there are still unprocessed operations that'll affect it
	Status *TeamStatus `default:"PROCESSED" json:"status"`
	// can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot
	CanBeDeleted *bool `default:"true" json:"canBeDeleted"`
	// The logging id of the team used in scrubbed logs, client analytics, and metrics.
	LoggingID *string `json:"loggingId,omitempty"`
}

func (*Team) GetBannerURL ¶ 

func (t *Team) GetBannerURL() *string

func (*Team) GetBusinessUnit ¶ 

func (t *Team) GetBusinessUnit() *string

func (*Team) GetCanBeDeleted ¶ 

func (t *Team) GetCanBeDeleted() *bool

func (*Team) GetCreatedFrom ¶ 

func (t *Team) GetCreatedFrom() *string

func (*Team) GetCustomFields ¶ 

func (t *Team) GetCustomFields() []CustomFieldData

func (*Team) GetDatasource ¶ 

func (t *Team) GetDatasource() *string

func (*Team) GetDatasourceProfiles ¶ 

func (t *Team) GetDatasourceProfiles() []DatasourceProfile

func (*Team) GetDepartment ¶ 

func (t *Team) GetDepartment() *string

func (*Team) GetDescription ¶ 

func (t *Team) GetDescription() *string

func (*Team) GetEmails ¶ 

func (t *Team) GetEmails() []TeamEmail
func (t *Team) GetExternalLink() *string

func (*Team) GetID ¶ 

func (t *Team) GetID() string

func (*Team) GetLastUpdatedAt ¶ 

func (t *Team) GetLastUpdatedAt() *time.Time

func (*Team) GetLoggingID ¶ 

func (t *Team) GetLoggingID() *string

func (*Team) GetMemberCount ¶ 

func (t *Team) GetMemberCount() *int64

func (*Team) GetMembers ¶ 

func (t *Team) GetMembers() []PersonToTeamRelationship

func (*Team) GetName ¶ 

func (t *Team) GetName() string

func (*Team) GetPermissions ¶ 

func (t *Team) GetPermissions() *ObjectPermissions

func (*Team) GetPhotoURL ¶ 

func (t *Team) GetPhotoURL() *string

func (*Team) GetRelatedObjects ¶ 

func (t *Team) GetRelatedObjects() map[string]RelatedObjectEdge

func (*Team) GetStatus ¶ 

func (t *Team) GetStatus() *TeamStatus

func (Team) MarshalJSON ¶ 

func (t Team) MarshalJSON() ([]byte, error)

func (*Team) UnmarshalJSON ¶ 

func (t *Team) UnmarshalJSON(data []byte) error

type TeamEmail ¶ 

type TeamEmail struct {
	// An email address
	Email string `json:"email"`
	// An enum of `PRIMARY`, `SECONDARY`, `ONCALL`, `OTHER`
	Type *string `default:"OTHER" json:"type"`
}

TeamEmail - Information about a team's email

func (*TeamEmail) GetEmail ¶ 

func (t *TeamEmail) GetEmail() string

func (*TeamEmail) GetType ¶ 

func (t *TeamEmail) GetType() *string

func (TeamEmail) MarshalJSON ¶ 

func (t TeamEmail) MarshalJSON() ([]byte, error)

func (*TeamEmail) UnmarshalJSON ¶ 

func (t *TeamEmail) UnmarshalJSON(data []byte) error

type TeamInfoDefinition ¶ 

type TeamInfoDefinition struct {
	// The unique ID of the team
	ID string `json:"id"`
	// Human-readable team name
	Name string `json:"name"`
	// The description of this team
	Description *string `json:"description,omitempty"`
	// Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
	BusinessUnit *string `json:"businessUnit,omitempty"`
	// An organizational unit where everyone has a similar task, e.g. `Engineering`.
	Department *string `json:"department,omitempty"`
	// A link to the team's photo
	PhotoURL *string `json:"photoUrl,omitempty"`
	// A link to an external team page. If set, team results will link to it.
	//
	ExternalLink *string `json:"externalLink,omitempty"`
	// The emails of the team
	Emails []TeamEmail `json:"emails,omitempty"`
	// The datasource profiles of the team, e.g. `Slack`,`Github`.
	DatasourceProfiles []DatasourceProfile `json:"datasourceProfiles,omitempty"`
	// The members of the team
	Members []TeamMember `json:"members"`
	// List of additional fields with more information about the team.
	AdditionalFields []AdditionalFieldDefinition `json:"additionalFields,omitempty"`
}

TeamInfoDefinition - Information about an employee's team

func (*TeamInfoDefinition) GetAdditionalFields ¶ 

func (t *TeamInfoDefinition) GetAdditionalFields() []AdditionalFieldDefinition

func (*TeamInfoDefinition) GetBusinessUnit ¶ 

func (t *TeamInfoDefinition) GetBusinessUnit() *string

func (*TeamInfoDefinition) GetDatasourceProfiles ¶ 

func (t *TeamInfoDefinition) GetDatasourceProfiles() []DatasourceProfile

func (*TeamInfoDefinition) GetDepartment ¶ 

func (t *TeamInfoDefinition) GetDepartment() *string

func (*TeamInfoDefinition) GetDescription ¶ 

func (t *TeamInfoDefinition) GetDescription() *string

func (*TeamInfoDefinition) GetEmails ¶ 

func (t *TeamInfoDefinition) GetEmails() []TeamEmail
func (t *TeamInfoDefinition) GetExternalLink() *string

func (*TeamInfoDefinition) GetID ¶ 

func (t *TeamInfoDefinition) GetID() string

func (*TeamInfoDefinition) GetMembers ¶ 

func (t *TeamInfoDefinition) GetMembers() []TeamMember

func (*TeamInfoDefinition) GetName ¶ 

func (t *TeamInfoDefinition) GetName() string

func (*TeamInfoDefinition) GetPhotoURL ¶ 

func (t *TeamInfoDefinition) GetPhotoURL() *string

type TeamMember ¶ 

type TeamMember struct {
	// The member's email
	Email string `json:"email"`
	// The member's relationship to the team, an enum of `MEMBER`, `MANAGER`, `LEAD`, `POINT_OF_CONTACT`, `OTHER`
	Relationship *string `default:"MEMBER" json:"relationship"`
	// The member's start date
	JoinDate *types.Date `json:"join_date,omitempty"`
}

TeamMember - Information about a team's member

func (*TeamMember) GetEmail ¶ 

func (t *TeamMember) GetEmail() string

func (*TeamMember) GetJoinDate ¶ 

func (t *TeamMember) GetJoinDate() *types.Date

func (*TeamMember) GetRelationship ¶ 

func (t *TeamMember) GetRelationship() *string

func (TeamMember) MarshalJSON ¶ 

func (t TeamMember) MarshalJSON() ([]byte, error)

func (*TeamMember) UnmarshalJSON ¶ 

func (t *TeamMember) UnmarshalJSON(data []byte) error

type TeamStatus ¶ 

type TeamStatus string

TeamStatus - whether this team is fully processed or there are still unprocessed operations that'll affect it 

const (
	TeamStatusProcessed         TeamStatus = "PROCESSED"
	TeamStatusQueuedForCreation TeamStatus = "QUEUED_FOR_CREATION"
	TeamStatusQueuedForDeletion TeamStatus = "QUEUED_FOR_DELETION"
)

func (TeamStatus) ToPointer ¶ 

func (e TeamStatus) ToPointer() *TeamStatus

func (*TeamStatus) UnmarshalJSON ¶ 

func (e *TeamStatus) UnmarshalJSON(data []byte) error

type TextRange ¶ 

type TextRange struct {
	// The inclusive start index of the range.
	StartIndex int64 `json:"startIndex"`
	// The exclusive end index of the range.
	EndIndex *int64         `json:"endIndex,omitempty"`
	Type     *TextRangeType `json:"type,omitempty"`
	// The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
	URL      *string   `json:"url,omitempty"`
	Document *Document `json:"document,omitempty"`
}

TextRange - A subsection of a given string to which some special formatting should be applied.

func (*TextRange) GetDocument ¶ 

func (t *TextRange) GetDocument() *Document

func (*TextRange) GetEndIndex ¶ 

func (t *TextRange) GetEndIndex() *int64

func (*TextRange) GetStartIndex ¶ 

func (t *TextRange) GetStartIndex() int64

func (*TextRange) GetType ¶ 

func (t *TextRange) GetType() *TextRangeType

func (*TextRange) GetURL ¶ 

func (t *TextRange) GetURL() *string

func (TextRange) MarshalJSON ¶ added in v0.9.0 

func (t TextRange) MarshalJSON() ([]byte, error)

func (*TextRange) UnmarshalJSON ¶ added in v0.9.0 

func (t *TextRange) UnmarshalJSON(data []byte) error

type TextRangeType ¶ 

type TextRangeType string
const (
	TextRangeTypeBold      TextRangeType = "BOLD"
	TextRangeTypeCitation  TextRangeType = "CITATION"
	TextRangeTypeHighlight TextRangeType = "HIGHLIGHT"
	TextRangeTypeLink      TextRangeType = "LINK"
)

func (TextRangeType) ToPointer ¶ 

func (e TextRangeType) ToPointer() *TextRangeType

func (*TextRangeType) UnmarshalJSON ¶ 

func (e *TextRangeType) UnmarshalJSON(data []byte) error

type Thumbnail ¶ 

type Thumbnail struct {
	// Photo id if the thumbnail is from splash.
	PhotoID *string `json:"photoId,omitempty"`
	// Thumbnail URL. This can be user provided image and/or from downloaded images hosted by Glean.
	URL *string `json:"url,omitempty"`
}

func (*Thumbnail) GetPhotoID ¶ 

func (t *Thumbnail) GetPhotoID() *string

func (*Thumbnail) GetURL ¶ 

func (t *Thumbnail) GetURL() *string

func (Thumbnail) MarshalJSON ¶ added in v0.9.0 

func (t Thumbnail) MarshalJSON() ([]byte, error)

func (*Thumbnail) UnmarshalJSON ¶ added in v0.9.0 

func (t *Thumbnail) UnmarshalJSON(data []byte) error

type TimeInterval ¶ 

type TimeInterval struct {
	// The RFC3339 timestamp formatted start time of this event.
	Start string `json:"start"`
	// The RFC3339 timestamp formatted end time of this event.
	End string `json:"end"`
}

func (*TimeInterval) GetEnd ¶ 

func (t *TimeInterval) GetEnd() string

func (*TimeInterval) GetStart ¶ 

func (t *TimeInterval) GetStart() string

func (TimeInterval) MarshalJSON ¶ added in v0.9.0 

func (t TimeInterval) MarshalJSON() ([]byte, error)

func (*TimeInterval) UnmarshalJSON ¶ added in v0.9.0 

func (t *TimeInterval) UnmarshalJSON(data []byte) error

type TimePeriodType ¶ 

type TimePeriodType string

TimePeriodType - Type of time period for which to run the report/policy. PAST_DAY is deprecated. 

const (
	TimePeriodTypeAllTime   TimePeriodType = "ALL_TIME"
	TimePeriodTypePastYear  TimePeriodType = "PAST_YEAR"
	TimePeriodTypePastDay   TimePeriodType = "PAST_DAY"
	TimePeriodTypeCustom    TimePeriodType = "CUSTOM"
	TimePeriodTypeLastNDays TimePeriodType = "LAST_N_DAYS"
)

func (TimePeriodType) ToPointer ¶ 

func (e TimePeriodType) ToPointer() *TimePeriodType

func (*TimePeriodType) UnmarshalJSON ¶ 

func (e *TimePeriodType) UnmarshalJSON(data []byte) error

type TimePoint ¶ 

type TimePoint struct {
	// Epoch seconds. Has precedence over daysFromNow.
	EpochSeconds *int64 `json:"epochSeconds,omitempty"`
	// The number of days from now. Specification relative to current time. Can be negative.
	DaysFromNow *int64 `json:"daysFromNow,omitempty"`
}

func (*TimePoint) GetDaysFromNow ¶ 

func (t *TimePoint) GetDaysFromNow() *int64

func (*TimePoint) GetEpochSeconds ¶ 

func (t *TimePoint) GetEpochSeconds() *int64

func (TimePoint) MarshalJSON ¶ added in v0.9.0 

func (t TimePoint) MarshalJSON() ([]byte, error)

func (*TimePoint) UnmarshalJSON ¶ added in v0.9.0 

func (t *TimePoint) UnmarshalJSON(data []byte) error

type TimeRange ¶ 

type TimeRange struct {
	// start time of the time range, applicable for the CUSTOM type.
	StartTime *time.Time `json:"startTime,omitempty"`
	// end time of the time range, applicable for the CUSTOM type.
	EndTime *time.Time `json:"endTime,omitempty"`
	// The number of days to look back from the current time, applicable for the LAST_N_DAYS type.
	LastNDaysValue *int64 `json:"lastNDaysValue,omitempty"`
}

func (*TimeRange) GetEndTime ¶ 

func (t *TimeRange) GetEndTime() *time.Time

func (*TimeRange) GetLastNDaysValue ¶ added in v0.7.0 

func (t *TimeRange) GetLastNDaysValue() *int64

func (*TimeRange) GetStartTime ¶ 

func (t *TimeRange) GetStartTime() *time.Time

func (TimeRange) MarshalJSON ¶ 

func (t TimeRange) MarshalJSON() ([]byte, error)

func (*TimeRange) UnmarshalJSON ¶ 

func (t *TimeRange) UnmarshalJSON(data []byte) error

type Tool ¶ added in v0.4.3 

type Tool struct {
	// Type of tool (READ, WRITE)
	Type *ToolType `json:"type,omitempty"`
	// Unique identifier for the tool
	Name *string `json:"name,omitempty"`
	// Human-readable name
	DisplayName *string `json:"displayName,omitempty"`
	// LLM friendly description of the tool
	Description *string `json:"description,omitempty"`
	// The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
	Parameters map[string]ToolParameter `json:"parameters,omitempty"`
}

func (*Tool) GetDescription ¶ added in v0.4.3 

func (t *Tool) GetDescription() *string

func (*Tool) GetDisplayName ¶ added in v0.4.3 

func (t *Tool) GetDisplayName() *string

func (*Tool) GetName ¶ added in v0.4.3 

func (t *Tool) GetName() *string

func (*Tool) GetParameters ¶ added in v0.4.3 

func (t *Tool) GetParameters() map[string]ToolParameter

func (*Tool) GetType ¶ added in v0.4.3 

func (t *Tool) GetType() *ToolType

type ToolInfo ¶ 

type ToolInfo struct {
	// The manifest for a tool that can be used to augment Glean Assistant.
	Metadata *ToolMetadata `json:"metadata,omitempty"`
	// Parameters supported by the tool.
	Parameters map[string]WriteActionParameter `json:"parameters,omitempty"`
}

func (*ToolInfo) GetMetadata ¶ 

func (t *ToolInfo) GetMetadata() *ToolMetadata

func (*ToolInfo) GetParameters ¶ 

func (t *ToolInfo) GetParameters() map[string]WriteActionParameter

type ToolMetadata ¶ 

type ToolMetadata struct {
	// The type of tool.
	Type ToolMetadataType `json:"type"`
	// Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool.
	Name string `json:"name"`
	// Human understandable name of the tool. Max 50 characters.
	DisplayName string `json:"displayName"`
	// An opaque id which is unique identifier for the tool.
	ToolID *string `json:"toolId,omitempty"`
	// Description of the tool meant for a human.
	DisplayDescription string `json:"displayDescription"`
	// URL used to fetch the logo.
	LogoURL *string `json:"logoUrl,omitempty"`
	// Name of the generated object. This will be used to indicate to the end user what the generated object contains.
	ObjectName *string `json:"objectName,omitempty"`
	// Indicates the kind of knowledge a tool would access or modify.
	KnowledgeType *KnowledgeType `json:"knowledgeType,omitempty"`
	CreatedBy     *PersonObject  `json:"createdBy,omitempty"`
	LastUpdatedBy *PersonObject  `json:"lastUpdatedBy,omitempty"`
	// The time the tool was created in ISO format (ISO 8601)
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// The time the tool was last updated in ISO format (ISO 8601)
	LastUpdatedAt *time.Time `json:"lastUpdatedAt,omitempty"`
	// Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.
	WriteActionType *WriteActionType `json:"writeActionType,omitempty"`
	// The type of authentication being used.
	// Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token.
	// 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users.
	// 'OAUTH_USER' uses individual user tokens for external API calls.
	// 'DWD' refers to domain wide delegation.
	//
	AuthType *AuthType `json:"authType,omitempty"`
	// Config for tool's authentication method.
	Auth        *AuthConfig        `json:"auth,omitempty"`
	Permissions *ObjectPermissions `json:"permissions,omitempty"`
	// Usage instructions for the LLM to use this action.
	UsageInstructions *string `json:"usageInstructions,omitempty"`
	// Whether this action has been fully configured and validated.
	IsSetupFinished *bool `json:"isSetupFinished,omitempty"`
}

ToolMetadata - The manifest for a tool that can be used to augment Glean Assistant.

func (*ToolMetadata) GetAuth ¶ 

func (t *ToolMetadata) GetAuth() *AuthConfig

func (*ToolMetadata) GetAuthType ¶ 

func (t *ToolMetadata) GetAuthType() *AuthType

func (*ToolMetadata) GetCreatedAt ¶ 

func (t *ToolMetadata) GetCreatedAt() *time.Time

func (*ToolMetadata) GetCreatedBy ¶ 

func (t *ToolMetadata) GetCreatedBy() *PersonObject

func (*ToolMetadata) GetDisplayDescription ¶ 

func (t *ToolMetadata) GetDisplayDescription() string

func (*ToolMetadata) GetDisplayName ¶ 

func (t *ToolMetadata) GetDisplayName() string

func (*ToolMetadata) GetIsSetupFinished ¶ 

func (t *ToolMetadata) GetIsSetupFinished() *bool

func (*ToolMetadata) GetKnowledgeType ¶ 

func (t *ToolMetadata) GetKnowledgeType() *KnowledgeType

func (*ToolMetadata) GetLastUpdatedAt ¶ 

func (t *ToolMetadata) GetLastUpdatedAt() *time.Time

func (*ToolMetadata) GetLastUpdatedBy ¶ 

func (t *ToolMetadata) GetLastUpdatedBy() *PersonObject

func (*ToolMetadata) GetLogoURL ¶ 

func (t *ToolMetadata) GetLogoURL() *string

func (*ToolMetadata) GetName ¶ 

func (t *ToolMetadata) GetName() string

func (*ToolMetadata) GetObjectName ¶ 

func (t *ToolMetadata) GetObjectName() *string

func (*ToolMetadata) GetPermissions ¶ 

func (t *ToolMetadata) GetPermissions() *ObjectPermissions

func (*ToolMetadata) GetToolID ¶ 

func (t *ToolMetadata) GetToolID() *string

func (*ToolMetadata) GetType ¶ 

func (t *ToolMetadata) GetType() ToolMetadataType

func (*ToolMetadata) GetUsageInstructions ¶ 

func (t *ToolMetadata) GetUsageInstructions() *string

func (*ToolMetadata) GetWriteActionType ¶ 

func (t *ToolMetadata) GetWriteActionType() *WriteActionType

func (ToolMetadata) MarshalJSON ¶ 

func (t ToolMetadata) MarshalJSON() ([]byte, error)

func (*ToolMetadata) UnmarshalJSON ¶ 

func (t *ToolMetadata) UnmarshalJSON(data []byte) error

type ToolMetadataType ¶ 

type ToolMetadataType string

ToolMetadataType - The type of tool. 

const (
	ToolMetadataTypeRetrieval ToolMetadataType = "RETRIEVAL"
	ToolMetadataTypeAction    ToolMetadataType = "ACTION"
)

func (ToolMetadataType) ToPointer ¶ 

func (e ToolMetadataType) ToPointer() *ToolMetadataType

func (*ToolMetadataType) UnmarshalJSON ¶ 

func (e *ToolMetadataType) UnmarshalJSON(data []byte) error

type ToolParameter ¶ added in v0.4.3 

type ToolParameter struct {
	// Parameter type (string, number, boolean, object, array)
	Type *ToolParameterType `json:"type,omitempty"`
	// The name of the parameter
	Name *string `json:"name,omitempty"`
	// The description of the parameter
	Description *string `json:"description,omitempty"`
	// Whether the parameter is required
	IsRequired *bool `json:"isRequired,omitempty"`
	// The possible values for the parameter. Can contain only primitive values or arrays of primitive values.
	PossibleValues []string       `json:"possibleValues,omitempty"`
	Items          *ToolParameter `json:"items,omitempty"`
	// When type is 'object', this describes the structure of the object.
	Properties map[string]ToolParameter `json:"properties,omitempty"`
}

func (*ToolParameter) GetDescription ¶ added in v0.4.3 

func (t *ToolParameter) GetDescription() *string

func (*ToolParameter) GetIsRequired ¶ added in v0.4.3 

func (t *ToolParameter) GetIsRequired() *bool

func (*ToolParameter) GetItems ¶ added in v0.4.3 

func (t *ToolParameter) GetItems() *ToolParameter

func (*ToolParameter) GetName ¶ added in v0.4.3 

func (t *ToolParameter) GetName() *string

func (*ToolParameter) GetPossibleValues ¶ added in v0.4.3 

func (t *ToolParameter) GetPossibleValues() []string

func (*ToolParameter) GetProperties ¶ added in v0.4.3 

func (t *ToolParameter) GetProperties() map[string]ToolParameter

func (*ToolParameter) GetType ¶ added in v0.4.3 

func (t *ToolParameter) GetType() *ToolParameterType

type ToolParameterType ¶ added in v0.4.3 

type ToolParameterType string

ToolParameterType - Parameter type (string, number, boolean, object, array) 

const (
	ToolParameterTypeString  ToolParameterType = "string"
	ToolParameterTypeNumber  ToolParameterType = "number"
	ToolParameterTypeBoolean ToolParameterType = "boolean"
	ToolParameterTypeObject  ToolParameterType = "object"
	ToolParameterTypeArray   ToolParameterType = "array"
)

func (ToolParameterType) ToPointer ¶ added in v0.4.3 

func (e ToolParameterType) ToPointer() *ToolParameterType

func (*ToolParameterType) UnmarshalJSON ¶ added in v0.4.3 

func (e *ToolParameterType) UnmarshalJSON(data []byte) error

type ToolSets ¶ added in v0.9.0 

type ToolSets struct {
	// Whether the agent is allowed to use web search (default: true).
	EnableWebSearch *bool `json:"enableWebSearch,omitempty"`
	// Whether the agent is allowed to search internal company resources (default: true).
	EnableCompanyTools *bool `json:"enableCompanyTools,omitempty"`
}

ToolSets - The types of tools that the agent is allowed to use. Only works with FAST and ADVANCED `agent` values

func (*ToolSets) GetEnableCompanyTools ¶ added in v0.9.0 

func (t *ToolSets) GetEnableCompanyTools() *bool

func (*ToolSets) GetEnableWebSearch ¶ added in v0.9.0 

func (t *ToolSets) GetEnableWebSearch() *bool

type ToolType ¶ added in v0.4.3 

type ToolType string

ToolType - Type of tool (READ, WRITE) 

const (
	ToolTypeRead  ToolType = "READ"
	ToolTypeWrite ToolType = "WRITE"
)

func (ToolType) ToPointer ¶ added in v0.4.3 

func (e ToolType) ToPointer() *ToolType

func (*ToolType) UnmarshalJSON ¶ added in v0.4.3 

func (e *ToolType) UnmarshalJSON(data []byte) error

type ToolsCallParameter ¶ added in v0.4.3 

type ToolsCallParameter struct {
	// The name of the parameter
	Name string `json:"name"`
	// The value of the parameter (for primitive types)
	Value string `json:"value"`
	// The value of the parameter (for array types)
	Items []ToolsCallParameter `json:"items,omitempty"`
	// The value of the parameter (for object types)
	Properties map[string]ToolsCallParameter `json:"properties,omitempty"`
}

func (*ToolsCallParameter) GetItems ¶ added in v0.4.3 

func (t *ToolsCallParameter) GetItems() []ToolsCallParameter

func (*ToolsCallParameter) GetName ¶ added in v0.4.3 

func (t *ToolsCallParameter) GetName() string

func (*ToolsCallParameter) GetProperties ¶ added in v0.4.3 

func (t *ToolsCallParameter) GetProperties() map[string]ToolsCallParameter

func (*ToolsCallParameter) GetValue ¶ added in v0.4.3 

func (t *ToolsCallParameter) GetValue() string

type ToolsCallRequest ¶ added in v0.4.3 

type ToolsCallRequest struct {
	// Required name of the tool to execute
	Name string `json:"name"`
	// The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
	Parameters map[string]ToolsCallParameter `json:"parameters"`
}

func (*ToolsCallRequest) GetName ¶ added in v0.4.3 

func (t *ToolsCallRequest) GetName() string

func (*ToolsCallRequest) GetParameters ¶ added in v0.4.3 

func (t *ToolsCallRequest) GetParameters() map[string]ToolsCallParameter

type ToolsCallResponse ¶ added in v0.4.3 

type ToolsCallResponse struct {
	// The raw response from the tool
	RawResponse map[string]any `json:"rawResponse,omitempty"`
	// The error message if applicable
	Error *string `json:"error,omitempty"`
}

func (*ToolsCallResponse) GetError ¶ added in v0.4.3 

func (t *ToolsCallResponse) GetError() *string

func (*ToolsCallResponse) GetRawResponse ¶ added in v0.4.3 

func (t *ToolsCallResponse) GetRawResponse() map[string]any

type ToolsListResponse ¶ added in v0.4.3 

type ToolsListResponse struct {
	Tools []Tool `json:"tools,omitempty"`
}

func (*ToolsListResponse) GetTools ¶ added in v0.4.3 

func (t *ToolsListResponse) GetTools() []Tool

type UIConfig ¶ 

type UIConfig struct {
	// defines how to render this particular displayable list card
	Format *Format `json:"format,omitempty"`
	// UI configurations for each item of the list
	AdditionalFlags *DisplayableListItemUIConfig `json:"additionalFlags,omitempty"`
}

func (*UIConfig) GetAdditionalFlags ¶ 

func (u *UIConfig) GetAdditionalFlags() *DisplayableListItemUIConfig

func (*UIConfig) GetFormat ¶ 

func (u *UIConfig) GetFormat() *Format

type UIOptions ¶ 

type UIOptions string
const (
	UIOptionsNone         UIOptions = "NONE"
	UIOptionsSearchResult UIOptions = "SEARCH_RESULT"
	UIOptionsDocHovercard UIOptions = "DOC_HOVERCARD"
)

func (UIOptions) ToPointer ¶ 

func (e UIOptions) ToPointer() *UIOptions

func (*UIOptions) UnmarshalJSON ¶ 

func (e *UIOptions) UnmarshalJSON(data []byte) error

type UgcType ¶ 

type UgcType string
const (
	UgcTypeAnnouncementsType   UgcType = "ANNOUNCEMENTS_TYPE"
	UgcTypeAnswersType         UgcType = "ANSWERS_TYPE"
	UgcTypeCollectionsType     UgcType = "COLLECTIONS_TYPE"
	UgcTypeShortcutsType       UgcType = "SHORTCUTS_TYPE"
	UgcTypeWorkflowsType       UgcType = "WORKFLOWS_TYPE"
	UgcTypePromptTemplatesType UgcType = "PROMPT_TEMPLATES_TYPE"
)

func (UgcType) ToPointer ¶ 

func (e UgcType) ToPointer() *UgcType

func (*UgcType) UnmarshalJSON ¶ 

func (e *UgcType) UnmarshalJSON(data []byte) error

type Unpin ¶ 

type Unpin struct {
	// The opaque id of the pin to be unpinned.
	ID *string `json:"id,omitempty"`
}

func (*Unpin) GetID ¶ 

func (u *Unpin) GetID() *string

type UpdateAnnouncementRequest ¶ 

type UpdateAnnouncementRequest struct {
	// The date and time at which the announcement becomes active.
	StartTime time.Time `json:"startTime"`
	// The date and time at which the announcement expires.
	EndTime time.Time `json:"endTime"`
	// The headline of the announcement.
	Title string          `json:"title"`
	Body  *StructuredText `json:"body,omitempty"`
	// An emoji used to indicate the nature of the announcement.
	Emoji     *string    `json:"emoji,omitempty"`
	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`
	Banner    *Thumbnail `json:"banner,omitempty"`
	// Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
	AudienceFilters []FacetFilter `json:"audienceFilters,omitempty"`
	// The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
	SourceDocumentID *string `json:"sourceDocumentId,omitempty"`
	// Whether or not to hide an author attribution.
	HideAttribution *bool `json:"hideAttribution,omitempty"`
	// This determines whether this is a Social Feed post or a regular announcement.
	Channel *UpdateAnnouncementRequestChannel `json:"channel,omitempty"`
	// This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.
	PostType *UpdateAnnouncementRequestPostType `json:"postType,omitempty"`
	// Used by the Social Feed to pin posts to the front of the feed.
	IsPrioritized *bool `json:"isPrioritized,omitempty"`
	// URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".
	ViewURL *string `json:"viewUrl,omitempty"`
	// The opaque id of the announcement.
	ID int64 `json:"id"`
}

func (*UpdateAnnouncementRequest) GetAudienceFilters ¶ 

func (u *UpdateAnnouncementRequest) GetAudienceFilters() []FacetFilter

func (*UpdateAnnouncementRequest) GetBanner ¶ 

func (u *UpdateAnnouncementRequest) GetBanner() *Thumbnail

func (*UpdateAnnouncementRequest) GetBody ¶ 

func (u *UpdateAnnouncementRequest) GetBody() *StructuredText

func (*UpdateAnnouncementRequest) GetChannel ¶ 

func (u *UpdateAnnouncementRequest) GetChannel() *UpdateAnnouncementRequestChannel

func (*UpdateAnnouncementRequest) GetEmoji ¶ 

func (u *UpdateAnnouncementRequest) GetEmoji() *string

func (*UpdateAnnouncementRequest) GetEndTime ¶ 

func (u *UpdateAnnouncementRequest) GetEndTime() time.Time

func (*UpdateAnnouncementRequest) GetHideAttribution ¶ 

func (u *UpdateAnnouncementRequest) GetHideAttribution() *bool

func (*UpdateAnnouncementRequest) GetID ¶ 

func (u *UpdateAnnouncementRequest) GetID() int64

func (*UpdateAnnouncementRequest) GetIsPrioritized ¶ 

func (u *UpdateAnnouncementRequest) GetIsPrioritized() *bool

func (*UpdateAnnouncementRequest) GetPostType ¶ 

func (u *UpdateAnnouncementRequest) GetPostType() *UpdateAnnouncementRequestPostType

func (*UpdateAnnouncementRequest) GetSourceDocumentID ¶ 

func (u *UpdateAnnouncementRequest) GetSourceDocumentID() *string

func (*UpdateAnnouncementRequest) GetStartTime ¶ 

func (u *UpdateAnnouncementRequest) GetStartTime() time.Time

func (*UpdateAnnouncementRequest) GetThumbnail ¶ 

func (u *UpdateAnnouncementRequest) GetThumbnail() *Thumbnail

func (*UpdateAnnouncementRequest) GetTitle ¶ 

func (u *UpdateAnnouncementRequest) GetTitle() string

func (*UpdateAnnouncementRequest) GetViewURL ¶ 

func (u *UpdateAnnouncementRequest) GetViewURL() *string

func (UpdateAnnouncementRequest) MarshalJSON ¶ 

func (u UpdateAnnouncementRequest) MarshalJSON() ([]byte, error)

func (*UpdateAnnouncementRequest) UnmarshalJSON ¶ 

func (u *UpdateAnnouncementRequest) UnmarshalJSON(data []byte) error

type UpdateAnnouncementRequestChannel ¶ 

type UpdateAnnouncementRequestChannel string

UpdateAnnouncementRequestChannel - This determines whether this is a Social Feed post or a regular announcement. 

const (
	UpdateAnnouncementRequestChannelMain       UpdateAnnouncementRequestChannel = "MAIN"
	UpdateAnnouncementRequestChannelSocialFeed UpdateAnnouncementRequestChannel = "SOCIAL_FEED"
)

func (UpdateAnnouncementRequestChannel) ToPointer ¶ 

func (e UpdateAnnouncementRequestChannel) ToPointer() *UpdateAnnouncementRequestChannel

func (*UpdateAnnouncementRequestChannel) UnmarshalJSON ¶ 

func (e *UpdateAnnouncementRequestChannel) UnmarshalJSON(data []byte) error

type UpdateAnnouncementRequestPostType ¶ 

type UpdateAnnouncementRequestPostType string

UpdateAnnouncementRequestPostType - This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. 

const (
	UpdateAnnouncementRequestPostTypeText UpdateAnnouncementRequestPostType = "TEXT"
	UpdateAnnouncementRequestPostTypeLink UpdateAnnouncementRequestPostType = "LINK"
)

func (UpdateAnnouncementRequestPostType) ToPointer ¶ 

func (e UpdateAnnouncementRequestPostType) ToPointer() *UpdateAnnouncementRequestPostType

func (*UpdateAnnouncementRequestPostType) UnmarshalJSON ¶ 

func (e *UpdateAnnouncementRequestPostType) UnmarshalJSON(data []byte) error

type UpdateDlpConfigRequest ¶ 

type UpdateDlpConfigRequest struct {
	// Detailed configuration of what documents and sensitive content will be scanned.
	Config *DlpConfig `json:"config,omitempty"`
	// Only "ONCE" is supported for reports.
	Frequency *string `json:"frequency,omitempty"`
}

func (*UpdateDlpConfigRequest) GetConfig ¶ 

func (u *UpdateDlpConfigRequest) GetConfig() *DlpConfig

func (*UpdateDlpConfigRequest) GetFrequency ¶ 

func (u *UpdateDlpConfigRequest) GetFrequency() *string

type UpdateDlpConfigResponse ¶ 

type UpdateDlpConfigResponse struct {
	Result *DlpSimpleResult `json:"result,omitempty"`
	// The id of the report that was just created and run.
	ReportID *string `json:"reportId,omitempty"`
}

func (*UpdateDlpConfigResponse) GetReportID ¶ 

func (u *UpdateDlpConfigResponse) GetReportID() *string

func (*UpdateDlpConfigResponse) GetResult ¶ 

func (u *UpdateDlpConfigResponse) GetResult() *DlpSimpleResult

type UpdateDlpReportRequest ¶ 

type UpdateDlpReportRequest struct {
	// Detailed configuration of what documents and sensitive content will be scanned.
	Config *DlpConfig `json:"config,omitempty"`
	// Interval between scans. DAILY is deprecated.
	Frequency *DlpFrequency `json:"frequency,omitempty"`
	// The status of the policy/report. Only ACTIVE status will be picked for scans.
	Status *DlpReportStatus `json:"status,omitempty"`
	// The new autoHideDoc boolean the policy will be updated to if provided.
	AutoHideDocs *bool `json:"autoHideDocs,omitempty"`
	// The new name of the policy if provided.
	ReportName *string `json:"reportName,omitempty"`
}

func (*UpdateDlpReportRequest) GetAutoHideDocs ¶ 

func (u *UpdateDlpReportRequest) GetAutoHideDocs() *bool

func (*UpdateDlpReportRequest) GetConfig ¶ 

func (u *UpdateDlpReportRequest) GetConfig() *DlpConfig

func (*UpdateDlpReportRequest) GetFrequency ¶ 

func (u *UpdateDlpReportRequest) GetFrequency() *DlpFrequency

func (*UpdateDlpReportRequest) GetReportName ¶ 

func (u *UpdateDlpReportRequest) GetReportName() *string

func (*UpdateDlpReportRequest) GetStatus ¶ 

func (u *UpdateDlpReportRequest) GetStatus() *DlpReportStatus

type UpdateDlpReportResponse ¶ 

type UpdateDlpReportResponse struct {
	Result *DlpSimpleResult `json:"result,omitempty"`
}

func (*UpdateDlpReportResponse) GetResult ¶ 

func (u *UpdateDlpReportResponse) GetResult() *DlpSimpleResult

type UpdateDocumentVisibilityOverridesRequest ¶ 

type UpdateDocumentVisibilityOverridesRequest struct {
	VisibilityOverrides []DocumentVisibilityOverride `json:"visibilityOverrides,omitempty"`
}

func (*UpdateDocumentVisibilityOverridesRequest) GetVisibilityOverrides ¶ 

func (u *UpdateDocumentVisibilityOverridesRequest) GetVisibilityOverrides() []DocumentVisibilityOverride

type UpdateDocumentVisibilityOverridesResponse ¶ 

type UpdateDocumentVisibilityOverridesResponse struct {
	// The documents and whether their visibility was successfully updated.
	Results []DocumentVisibilityUpdateResult `json:"results,omitempty"`
}

func (*UpdateDocumentVisibilityOverridesResponse) GetResults ¶ 

func (u *UpdateDocumentVisibilityOverridesResponse) GetResults() []DocumentVisibilityUpdateResult

type UpdatePermissionsRequest ¶ 

type UpdatePermissionsRequest struct {
	Datasource string `json:"datasource"`
	// The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _
	ObjectType *string `json:"objectType,omitempty"`
	// The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length.
	ID *string `json:"id,omitempty"`
	// The permalink for viewing the document. **Note: viewURL is a required field if id was not set when uploading the document.**'
	//
	ViewURL *string `json:"viewURL,omitempty"`
	// describes the access control details of the document
	Permissions DocumentPermissionsDefinition `json:"permissions"`
}

UpdatePermissionsRequest - Describes the request body of the /updatepermissions API call

func (*UpdatePermissionsRequest) GetDatasource ¶ 

func (u *UpdatePermissionsRequest) GetDatasource() string

func (*UpdatePermissionsRequest) GetID ¶ 

func (u *UpdatePermissionsRequest) GetID() *string

func (*UpdatePermissionsRequest) GetObjectType ¶ 

func (u *UpdatePermissionsRequest) GetObjectType() *string

func (*UpdatePermissionsRequest) GetPermissions ¶ 

func (u *UpdatePermissionsRequest) GetPermissions() DocumentPermissionsDefinition

func (*UpdatePermissionsRequest) GetViewURL ¶ 

func (u *UpdatePermissionsRequest) GetViewURL() *string

type UpdateShortcutRequest ¶ 

type UpdateShortcutRequest struct {
	// The opaque id of the user generated content.
	ID int64 `json:"id"`
	// Link text following go/ prefix as entered by the user.
	InputAlias *string `json:"inputAlias,omitempty"`
	// Destination URL for the shortcut.
	DestinationURL *string `json:"destinationUrl,omitempty"`
	// Glean Document ID for the URL, if known.
	DestinationDocumentID *string `json:"destinationDocumentId,omitempty"`
	// A short, plain text blurb to help people understand the intent of the shortcut.
	Description *string `json:"description,omitempty"`
	// Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
	Unlisted *bool `json:"unlisted,omitempty"`
	// For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL.
	URLTemplate *string `json:"urlTemplate,omitempty"`
	// A list of user roles added for the Shortcut.
	AddedRoles []UserRoleSpecification `json:"addedRoles,omitempty"`
	// A list of user roles removed for the Shortcut.
	RemovedRoles []UserRoleSpecification `json:"removedRoles,omitempty"`
}

func (*UpdateShortcutRequest) GetAddedRoles ¶ 

func (u *UpdateShortcutRequest) GetAddedRoles() []UserRoleSpecification

func (*UpdateShortcutRequest) GetDescription ¶ 

func (u *UpdateShortcutRequest) GetDescription() *string

func (*UpdateShortcutRequest) GetDestinationDocumentID ¶ 

func (u *UpdateShortcutRequest) GetDestinationDocumentID() *string

func (*UpdateShortcutRequest) GetDestinationURL ¶ 

func (u *UpdateShortcutRequest) GetDestinationURL() *string

func (*UpdateShortcutRequest) GetID ¶ 

func (u *UpdateShortcutRequest) GetID() int64

func (*UpdateShortcutRequest) GetInputAlias ¶ 

func (u *UpdateShortcutRequest) GetInputAlias() *string

func (*UpdateShortcutRequest) GetRemovedRoles ¶ 

func (u *UpdateShortcutRequest) GetRemovedRoles() []UserRoleSpecification

func (*UpdateShortcutRequest) GetURLTemplate ¶ 

func (u *UpdateShortcutRequest) GetURLTemplate() *string

func (*UpdateShortcutRequest) GetUnlisted ¶ 

func (u *UpdateShortcutRequest) GetUnlisted() *bool

type UpdateShortcutResponse ¶ 

type UpdateShortcutResponse struct {
	Shortcut *Shortcut      `json:"shortcut,omitempty"`
	Error    *ShortcutError `json:"error,omitempty"`
}

func (*UpdateShortcutResponse) GetError ¶ 

func (u *UpdateShortcutResponse) GetError() *ShortcutError

func (*UpdateShortcutResponse) GetShortcut ¶ 

func (u *UpdateShortcutResponse) GetShortcut() *Shortcut

type UpdateType ¶ added in v0.9.0 

type UpdateType string

UpdateType - Optional type classification for the update. 

const (
	UpdateTypeActionable  UpdateType = "ACTIONABLE"
	UpdateTypeInformative UpdateType = "INFORMATIVE"
)

func (UpdateType) ToPointer ¶ added in v0.9.0 

func (e UpdateType) ToPointer() *UpdateType

func (*UpdateType) UnmarshalJSON ¶ added in v0.9.0 

func (e *UpdateType) UnmarshalJSON(data []byte) error

type UploadChatFilesRequest ¶ 

type UploadChatFilesRequest struct {
	// Raw files to be uploaded for chat in binary format.
	Files []File `multipartForm:"file,name=files"`
}

func (*UploadChatFilesRequest) GetFiles ¶ 

func (u *UploadChatFilesRequest) GetFiles() []File

type UploadChatFilesResponse ¶ 

type UploadChatFilesResponse struct {
	// Files uploaded for chat.
	Files []ChatFile `json:"files,omitempty"`
}

func (*UploadChatFilesResponse) GetFiles ¶ 

func (u *UploadChatFilesResponse) GetFiles() []ChatFile

type UploadShortcutsRequest ¶ 

type UploadShortcutsRequest struct {
	// Unique id that must be used for this bulk upload instance
	UploadID string `json:"uploadId"`
	// true if this is the first page of the upload. Defaults to false
	IsFirstPage *bool `json:"isFirstPage,omitempty"`
	// true if this is the last page of the upload. Defaults to false
	IsLastPage *bool `json:"isLastPage,omitempty"`
	// Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
	ForceRestartUpload *bool `json:"forceRestartUpload,omitempty"`
	// Batch of shortcuts information
	Shortcuts []IndexingShortcut `json:"shortcuts"`
}

UploadShortcutsRequest - Describes the request body of the /uploadshortcuts API call

func (*UploadShortcutsRequest) GetForceRestartUpload ¶ 

func (u *UploadShortcutsRequest) GetForceRestartUpload() *bool

func (*UploadShortcutsRequest) GetIsFirstPage ¶ 

func (u *UploadShortcutsRequest) GetIsFirstPage() *bool

func (*UploadShortcutsRequest) GetIsLastPage ¶ 

func (u *UploadShortcutsRequest) GetIsLastPage() *bool

func (*UploadShortcutsRequest) GetShortcuts ¶ 

func (u *UploadShortcutsRequest) GetShortcuts() []IndexingShortcut

func (*UploadShortcutsRequest) GetUploadID ¶ 

func (u *UploadShortcutsRequest) GetUploadID() string

type UploadStatusEnum ¶ 

type UploadStatusEnum string

UploadStatusEnum - Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN 

const (
	UploadStatusEnumUploaded      UploadStatusEnum = "UPLOADED"
	UploadStatusEnumNotUploaded   UploadStatusEnum = "NOT_UPLOADED"
	UploadStatusEnumStatusUnknown UploadStatusEnum = "STATUS_UNKNOWN"
)

func (UploadStatusEnum) ToPointer ¶ 

func (e UploadStatusEnum) ToPointer() *UploadStatusEnum

func (*UploadStatusEnum) UnmarshalJSON ¶ 

func (e *UploadStatusEnum) UnmarshalJSON(data []byte) error

type User ¶ 

type User struct {
	// An opaque user ID for the claimed authority (i.e., the actas param, or the origid if actas is not specified).
	UserID *string `json:"userID,omitempty"`
	// An opaque user ID for the authenticated user (ignores actas).
	OrigID *string `json:"origID,omitempty"`
}

func (*User) GetOrigID ¶ 

func (u *User) GetOrigID() *string

func (*User) GetUserID ¶ 

func (u *User) GetUserID() *string

type UserActivity ¶ 

type UserActivity struct {
	Actor *Person `json:"actor,omitempty"`
	// Unix timestamp of the activity (in seconds since epoch UTC).
	Timestamp *int64 `json:"timestamp,omitempty"`
	// The action for the activity
	Action              *UserActivityAction `json:"action,omitempty"`
	AggregateVisitCount *CountInfo          `json:"aggregateVisitCount,omitempty"`
}

func (*UserActivity) GetAction ¶ 

func (u *UserActivity) GetAction() *UserActivityAction

func (*UserActivity) GetActor ¶ 

func (u *UserActivity) GetActor() *Person

func (*UserActivity) GetAggregateVisitCount ¶ 

func (u *UserActivity) GetAggregateVisitCount() *CountInfo

func (*UserActivity) GetTimestamp ¶ 

func (u *UserActivity) GetTimestamp() *int64

type UserActivityAction ¶ 

type UserActivityAction string

UserActivityAction - The action for the activity 

const (
	UserActivityActionAdd         UserActivityAction = "ADD"
	UserActivityActionAddReminder UserActivityAction = "ADD_REMINDER"
	UserActivityActionClick       UserActivityAction = "CLICK"
	UserActivityActionComment     UserActivityAction = "COMMENT"
	UserActivityActionDelete      UserActivityAction = "DELETE"
	UserActivityActionDismiss     UserActivityAction = "DISMISS"
	UserActivityActionEdit        UserActivityAction = "EDIT"
	UserActivityActionMention     UserActivityAction = "MENTION"
	UserActivityActionMove        UserActivityAction = "MOVE"
	UserActivityActionOther       UserActivityAction = "OTHER"
	UserActivityActionRestore     UserActivityAction = "RESTORE"
	UserActivityActionUnknown     UserActivityAction = "UNKNOWN"
	UserActivityActionVerify      UserActivityAction = "VERIFY"
	UserActivityActionView        UserActivityAction = "VIEW"
)

func (UserActivityAction) ToPointer ¶ 

func (e UserActivityAction) ToPointer() *UserActivityAction

func (*UserActivityAction) UnmarshalJSON ¶ 

func (e *UserActivityAction) UnmarshalJSON(data []byte) error

type UserActivityInsight ¶ 

type UserActivityInsight struct {
	User Person `json:"user"`
	// Activity e.g. search, home page visit or all.
	Activity ActivityEnum `json:"activity"`
	// Unix timestamp of the last activity (in seconds since epoch UTC).
	LastActivityTimestamp *int64     `json:"lastActivityTimestamp,omitempty"`
	ActivityCount         *CountInfo `json:"activityCount,omitempty"`
	ActiveDayCount        *CountInfo `json:"activeDayCount,omitempty"`
}

func (*UserActivityInsight) GetActiveDayCount ¶ 

func (u *UserActivityInsight) GetActiveDayCount() *CountInfo

func (*UserActivityInsight) GetActivity ¶ 

func (u *UserActivityInsight) GetActivity() ActivityEnum

func (*UserActivityInsight) GetActivityCount ¶ 

func (u *UserActivityInsight) GetActivityCount() *CountInfo

func (*UserActivityInsight) GetLastActivityTimestamp ¶ 

func (u *UserActivityInsight) GetLastActivityTimestamp() *int64

func (*UserActivityInsight) GetUser ¶ 

func (u *UserActivityInsight) GetUser() Person

type UserGeneratedContentID ¶ 

type UserGeneratedContentID struct {
	// The opaque id of the user generated content.
	ID *int64 `json:"id,omitempty"`
}

func (*UserGeneratedContentID) GetID ¶ 

func (u *UserGeneratedContentID) GetID() *int64

func (UserGeneratedContentID) MarshalJSON ¶ added in v0.9.0 

func (u UserGeneratedContentID) MarshalJSON() ([]byte, error)

func (*UserGeneratedContentID) UnmarshalJSON ¶ added in v0.9.0 

func (u *UserGeneratedContentID) UnmarshalJSON(data []byte) error

type UserInsightsResponse ¶ 

type UserInsightsResponse struct {
	// Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC).
	LastLogTimestamp *int64 `json:"lastLogTimestamp,omitempty"`
	// Insights for all active users with respect to set of actions.
	ActivityInsights []UserActivityInsight `json:"activityInsights,omitempty"`
	// Insights for all in inactive users with respect to set of actions and time period. Activity count will be set to 0.
	InactiveInsights []UserActivityInsight `json:"inactiveInsights,omitempty"`
	// Total number of teammates that have logged in to the product, that are still valid teammates.
	TotalTeammates *int64 `json:"totalTeammates,omitempty"`
	// Total number of active users in the requested period.
	TotalActiveUsers *int64 `json:"totalActiveUsers,omitempty"`
	// list of departments applicable for users tab.
	Departments []string `json:"departments,omitempty"`
}

func (*UserInsightsResponse) GetActivityInsights ¶ 

func (u *UserInsightsResponse) GetActivityInsights() []UserActivityInsight

func (*UserInsightsResponse) GetDepartments ¶ 

func (u *UserInsightsResponse) GetDepartments() []string

func (*UserInsightsResponse) GetInactiveInsights ¶ 

func (u *UserInsightsResponse) GetInactiveInsights() []UserActivityInsight

func (*UserInsightsResponse) GetLastLogTimestamp ¶ 

func (u *UserInsightsResponse) GetLastLogTimestamp() *int64

func (*UserInsightsResponse) GetTotalActiveUsers ¶ 

func (u *UserInsightsResponse) GetTotalActiveUsers() *int64

func (*UserInsightsResponse) GetTotalTeammates ¶ 

func (u *UserInsightsResponse) GetTotalTeammates() *int64

type UserReferenceDefinition ¶ 

type UserReferenceDefinition struct {
	Email *string `json:"email,omitempty"`
	// some datasources refer to the user by the datasource user id in the document
	DatasourceUserID *string `json:"datasourceUserId,omitempty"`
	Name             *string `json:"name,omitempty"`
}

UserReferenceDefinition - Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.

func (*UserReferenceDefinition) GetDatasourceUserID ¶ 

func (u *UserReferenceDefinition) GetDatasourceUserID() *string

func (*UserReferenceDefinition) GetEmail ¶ 

func (u *UserReferenceDefinition) GetEmail() *string

func (*UserReferenceDefinition) GetName ¶ 

func (u *UserReferenceDefinition) GetName() *string

type UserRole ¶ 

type UserRole string

UserRole - A user's role with respect to a specific document. 

const (
	UserRoleOwner           UserRole = "OWNER"
	UserRoleViewer          UserRole = "VIEWER"
	UserRoleAnswerModerator UserRole = "ANSWER_MODERATOR"
	UserRoleEditor          UserRole = "EDITOR"
	UserRoleVerifier        UserRole = "VERIFIER"
)

func (UserRole) ToPointer ¶ 

func (e UserRole) ToPointer() *UserRole

func (*UserRole) UnmarshalJSON ¶ 

func (e *UserRole) UnmarshalJSON(data []byte) error

type UserRoleSpecification ¶ 

type UserRoleSpecification struct {
	SourceDocumentSpec *DocumentSpecUnion `json:"sourceDocumentSpec,omitempty"`
	Person             *Person            `json:"person,omitempty"`
	Group              *Group             `json:"group,omitempty"`
	// A user's role with respect to a specific document.
	Role UserRole `json:"role"`
}

func (*UserRoleSpecification) GetGroup ¶ 

func (u *UserRoleSpecification) GetGroup() *Group

func (*UserRoleSpecification) GetPerson ¶ 

func (u *UserRoleSpecification) GetPerson() *Person

func (*UserRoleSpecification) GetRole ¶ 

func (u *UserRoleSpecification) GetRole() UserRole

func (*UserRoleSpecification) GetSourceDocumentSpec ¶ 

func (u *UserRoleSpecification) GetSourceDocumentSpec() *DocumentSpecUnion

func (UserRoleSpecification) MarshalJSON ¶ added in v0.9.0 

func (u UserRoleSpecification) MarshalJSON() ([]byte, error)

func (*UserRoleSpecification) UnmarshalJSON ¶ added in v0.9.0 

func (u *UserRoleSpecification) UnmarshalJSON(data []byte) error

type UserStatusResponse ¶ 

type UserStatusResponse struct {
	// Whether the user is active or not
	IsActiveUser *bool `json:"isActiveUser,omitempty"`
	// Upload status, enum of NOT_UPLOADED, UPLOADED, STATUS_UNKNOWN
	UploadStatus *UploadStatusEnum `json:"uploadStatus,omitempty"`
	// Time of last successful upload for the user, in ISO 8601 format
	LastUploadedAt *string `json:"lastUploadedAt,omitempty"`
}

UserStatusResponse - Describes the user status response body

func (*UserStatusResponse) GetIsActiveUser ¶ 

func (u *UserStatusResponse) GetIsActiveUser() *bool

func (*UserStatusResponse) GetLastUploadedAt ¶ 

func (u *UserStatusResponse) GetLastUploadedAt() *string

func (*UserStatusResponse) GetUploadStatus ¶ 

func (u *UserStatusResponse) GetUploadStatus() *UploadStatusEnum

type UserViewInfo ¶ 

type UserViewInfo struct {
	// Unique Glean Document ID of the associated document.
	DocID *string `json:"docId,omitempty"`
	// Title of associated document.
	DocTitle *string `json:"docTitle,omitempty"`
	// URL of associated document.
	DocURL *string `json:"docUrl,omitempty"`
}

func (*UserViewInfo) GetDocID ¶ 

func (u *UserViewInfo) GetDocID() *string

func (*UserViewInfo) GetDocTitle ¶ 

func (u *UserViewInfo) GetDocTitle() *string

func (*UserViewInfo) GetDocURL ¶ 

func (u *UserViewInfo) GetDocURL() *string

type Value ¶ 

type Value struct {
}

Value - Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs.

type Verification ¶ 

type Verification struct {
	// The verification state for the document.
	State    State                 `json:"state"`
	Metadata *VerificationMetadata `json:"metadata,omitempty"`
}

func (*Verification) GetMetadata ¶ 

func (v *Verification) GetMetadata() *VerificationMetadata

func (*Verification) GetState ¶ 

func (v *Verification) GetState() State

func (Verification) MarshalJSON ¶ added in v0.9.0 

func (v Verification) MarshalJSON() ([]byte, error)

func (*Verification) UnmarshalJSON ¶ added in v0.9.0 

func (v *Verification) UnmarshalJSON(data []byte) error

type VerificationFeed ¶ 

type VerificationFeed struct {
	// List of document infos that include verification related information for them.
	Documents []Verification `json:"documents,omitempty"`
}

func (*VerificationFeed) GetDocuments ¶ 

func (v *VerificationFeed) GetDocuments() []Verification

type VerificationMetadata ¶ 

type VerificationMetadata struct {
	LastVerifier *Person `json:"lastVerifier,omitempty"`
	// The unix timestamp of the verification (in seconds since epoch UTC).
	LastVerificationTs *int64 `json:"lastVerificationTs,omitempty"`
	// The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC).
	ExpirationTs *int64    `json:"expirationTs,omitempty"`
	Document     *Document `json:"document,omitempty"`
	// Info about all outstanding verification reminders for the document if exists.
	Reminders    []Reminder `json:"reminders,omitempty"`
	LastReminder *Reminder  `json:"lastReminder,omitempty"`
	// Number of visitors to the document during included time periods.
	VisitorCount []CountInfo `json:"visitorCount,omitempty"`
	// List of potential verifiers for the document e.g. old verifiers and/or users with view/edit permissions.
	CandidateVerifiers []Person `json:"candidateVerifiers,omitempty"`
}

func (*VerificationMetadata) GetCandidateVerifiers ¶ 

func (v *VerificationMetadata) GetCandidateVerifiers() []Person

func (*VerificationMetadata) GetDocument ¶ 

func (v *VerificationMetadata) GetDocument() *Document

func (*VerificationMetadata) GetExpirationTs ¶ 

func (v *VerificationMetadata) GetExpirationTs() *int64

func (*VerificationMetadata) GetLastReminder ¶ 

func (v *VerificationMetadata) GetLastReminder() *Reminder

func (*VerificationMetadata) GetLastVerificationTs ¶ 

func (v *VerificationMetadata) GetLastVerificationTs() *int64

func (*VerificationMetadata) GetLastVerifier ¶ 

func (v *VerificationMetadata) GetLastVerifier() *Person

func (*VerificationMetadata) GetReminders ¶ 

func (v *VerificationMetadata) GetReminders() []Reminder

func (*VerificationMetadata) GetVisitorCount ¶ 

func (v *VerificationMetadata) GetVisitorCount() []CountInfo

func (VerificationMetadata) MarshalJSON ¶ added in v0.9.0 

func (v VerificationMetadata) MarshalJSON() ([]byte, error)

func (*VerificationMetadata) UnmarshalJSON ¶ added in v0.9.0 

func (v *VerificationMetadata) UnmarshalJSON(data []byte) error

type VerifyRequest ¶ 

type VerifyRequest struct {
	// The document which is verified.
	DocumentID string `json:"documentId"`
	// The verification action requested.
	Action *VerifyRequestAction `json:"action,omitempty"`
}

func (*VerifyRequest) GetAction ¶ 

func (v *VerifyRequest) GetAction() *VerifyRequestAction

func (*VerifyRequest) GetDocumentID ¶ 

func (v *VerifyRequest) GetDocumentID() string

type VerifyRequestAction ¶ 

type VerifyRequestAction string

VerifyRequestAction - The verification action requested. 

const (
	VerifyRequestActionVerify    VerifyRequestAction = "VERIFY"
	VerifyRequestActionDeprecate VerifyRequestAction = "DEPRECATE"
	VerifyRequestActionUnverify  VerifyRequestAction = "UNVERIFY"
)

func (VerifyRequestAction) ToPointer ¶ 

func (e VerifyRequestAction) ToPointer() *VerifyRequestAction

func (*VerifyRequestAction) UnmarshalJSON ¶ 

func (e *VerifyRequestAction) UnmarshalJSON(data []byte) error

type ViewerInfo ¶ 

type ViewerInfo struct {
	// DEPRECATED - use permissions instead. Viewer's role on the specific document.
	//
	// Deprecated: This will be removed in a future release, please migrate away from it as soon as possible.
	Role           *Role      `json:"role,omitempty"`
	LastViewedTime *time.Time `json:"lastViewedTime,omitempty"`
}

func (*ViewerInfo) GetLastViewedTime ¶ 

func (v *ViewerInfo) GetLastViewedTime() *time.Time

func (*ViewerInfo) GetRole ¶ 

func (v *ViewerInfo) GetRole() *Role

func (ViewerInfo) MarshalJSON ¶ 

func (v ViewerInfo) MarshalJSON() ([]byte, error)

func (*ViewerInfo) UnmarshalJSON ¶ 

func (v *ViewerInfo) UnmarshalJSON(data []byte) error

type WarningType ¶ 

type WarningType string

WarningType - The type of the warning. 

const (
	WarningTypeLongQuery               WarningType = "LONG_QUERY"
	WarningTypeQuotedPunctuation       WarningType = "QUOTED_PUNCTUATION"
	WarningTypePunctuationOnly         WarningType = "PUNCTUATION_ONLY"
	WarningTypeCopypastedQuotes        WarningType = "COPYPASTED_QUOTES"
	WarningTypeInvalidOperator         WarningType = "INVALID_OPERATOR"
	WarningTypeMaybeInvalidFacetQuery  WarningType = "MAYBE_INVALID_FACET_QUERY"
	WarningTypeTooManyDatasourceGroups WarningType = "TOO_MANY_DATASOURCE_GROUPS"
)

func (WarningType) ToPointer ¶ 

func (e WarningType) ToPointer() *WarningType

func (*WarningType) UnmarshalJSON ¶ 

func (e *WarningType) UnmarshalJSON(data []byte) error

type Workflow ¶ 

type Workflow struct {
	// The name of the workflow.
	Name   *string `json:"name,omitempty"`
	Author *Person `json:"author,omitempty"`
	// Server Unix timestamp of the creation time.
	CreateTimestamp *int64 `json:"createTimestamp,omitempty"`
	// Server Unix timestamp of the last update time.
	LastUpdateTimestamp *int64             `json:"lastUpdateTimestamp,omitempty"`
	LastUpdatedBy       *Person            `json:"lastUpdatedBy,omitempty"`
	Permissions         *ObjectPermissions `json:"permissions,omitempty"`
	// The ID of the workflow.
	ID *string `json:"id,omitempty"`
}

func (*Workflow) GetAuthor ¶ 

func (w *Workflow) GetAuthor() *Person

func (*Workflow) GetCreateTimestamp ¶ 

func (w *Workflow) GetCreateTimestamp() *int64

func (*Workflow) GetID ¶ 

func (w *Workflow) GetID() *string

func (*Workflow) GetLastUpdateTimestamp ¶ 

func (w *Workflow) GetLastUpdateTimestamp() *int64

func (*Workflow) GetLastUpdatedBy ¶ 

func (w *Workflow) GetLastUpdatedBy() *Person

func (*Workflow) GetName ¶ 

func (w *Workflow) GetName() *string

func (*Workflow) GetPermissions ¶ 

func (w *Workflow) GetPermissions() *ObjectPermissions

type WorkflowFeedbackInfo ¶ 

type WorkflowFeedbackInfo struct {
	// Where the feedback of the workflow originated from
	Source *WorkflowFeedbackInfoSource `json:"source,omitempty"`
}

func (*WorkflowFeedbackInfo) GetSource ¶ 

func (w *WorkflowFeedbackInfo) GetSource() *WorkflowFeedbackInfoSource

type WorkflowFeedbackInfoSource ¶ 

type WorkflowFeedbackInfoSource string

WorkflowFeedbackInfoSource - Where the feedback of the workflow originated from 

const (
	WorkflowFeedbackInfoSourceZeroState WorkflowFeedbackInfoSource = "ZERO_STATE"
	WorkflowFeedbackInfoSourceLibrary   WorkflowFeedbackInfoSource = "LIBRARY"
	WorkflowFeedbackInfoSourceHomepage  WorkflowFeedbackInfoSource = "HOMEPAGE"
)

func (WorkflowFeedbackInfoSource) ToPointer ¶ 

func (e WorkflowFeedbackInfoSource) ToPointer() *WorkflowFeedbackInfoSource

func (*WorkflowFeedbackInfoSource) UnmarshalJSON ¶ 

func (e *WorkflowFeedbackInfoSource) UnmarshalJSON(data []byte) error

type WorkflowResult ¶ 

type WorkflowResult struct {
	Workflow Workflow `json:"workflow"`
}

func (*WorkflowResult) GetWorkflow ¶ 

func (w *WorkflowResult) GetWorkflow() Workflow

type WriteActionParameter ¶ 

type WriteActionParameter struct {
	// The type of the value (e.g., integer, string, boolean, etc.)
	Type *WriteActionParameterType `json:"type,omitempty"`
	// Human readable display name for the key.
	DisplayName *string `json:"displayName,omitempty"`
	// The value of the field.
	Value *string `json:"value,omitempty"`
	// Is the parameter a required field.
	IsRequired *bool `json:"isRequired,omitempty"`
	// Description of the parameter.
	Description *string `json:"description,omitempty"`
	// Possible values that the parameter can take.
	PossibleValues []PossibleValue `json:"possibleValues,omitempty"`
}

func (*WriteActionParameter) GetDescription ¶ 

func (w *WriteActionParameter) GetDescription() *string

func (*WriteActionParameter) GetDisplayName ¶ 

func (w *WriteActionParameter) GetDisplayName() *string

func (*WriteActionParameter) GetIsRequired ¶ 

func (w *WriteActionParameter) GetIsRequired() *bool

func (*WriteActionParameter) GetPossibleValues ¶ 

func (w *WriteActionParameter) GetPossibleValues() []PossibleValue

func (*WriteActionParameter) GetType ¶ 

func (w *WriteActionParameter) GetType() *WriteActionParameterType

func (*WriteActionParameter) GetValue ¶ 

func (w *WriteActionParameter) GetValue() *string

type WriteActionParameterType ¶ 

type WriteActionParameterType string

WriteActionParameterType - The type of the value (e.g., integer, string, boolean, etc.) 

const (
	WriteActionParameterTypeUnknown WriteActionParameterType = "UNKNOWN"
	WriteActionParameterTypeInteger WriteActionParameterType = "INTEGER"
	WriteActionParameterTypeString  WriteActionParameterType = "STRING"
	WriteActionParameterTypeBoolean WriteActionParameterType = "BOOLEAN"
)

func (WriteActionParameterType) ToPointer ¶ 

func (e WriteActionParameterType) ToPointer() *WriteActionParameterType

func (*WriteActionParameterType) UnmarshalJSON ¶ 

func (e *WriteActionParameterType) UnmarshalJSON(data []byte) error

type WriteActionType ¶ 

type WriteActionType string

WriteActionType - Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. 

const (
	WriteActionTypeRedirect  WriteActionType = "REDIRECT"
	WriteActionTypeExecution WriteActionType = "EXECUTION"
)

func (WriteActionType) ToPointer ¶ 

func (e WriteActionType) ToPointer() *WriteActionType

func (*WriteActionType) UnmarshalJSON ¶ 

func (e *WriteActionType) UnmarshalJSON(data []byte) error

type WritePermission ¶ 

type WritePermission struct {
	// Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
	ScopeType *ScopeType `json:"scopeType,omitempty"`
	// True if user has create permission for this feature and scope
	Create *bool `json:"create,omitempty"`
	// True if user has update permission for this feature and scope
	Update *bool `json:"update,omitempty"`
	// True if user has delete permission for this feature and scope
	Delete *bool `json:"delete,omitempty"`
}

WritePermission - Describes the write permissions levels that a user has for a specific feature

func (*WritePermission) GetCreate ¶ 

func (w *WritePermission) GetCreate() *bool

func (*WritePermission) GetDelete ¶ 

func (w *WritePermission) GetDelete() *bool

func (*WritePermission) GetScopeType ¶ 

func (w *WritePermission) GetScopeType() *ScopeType

func (*WritePermission) GetUpdate ¶ 

func (w *WritePermission) GetUpdate() *bool

func (WritePermission) MarshalJSON ¶ added in v0.9.0 

func (w WritePermission) MarshalJSON() ([]byte, error)

func (*WritePermission) UnmarshalJSON ¶ added in v0.9.0 

func (w *WritePermission) UnmarshalJSON(data []byte) error

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.