Documentation
¶
Index ¶
- Constants
- type Action
- type Answer
- type AppointmentLinks
- type Attachment
- type Availabilities
- type Availability
- type CRMConnect
- type CodeSnippet
- type CodeSnippetParams
- type CodeSnippetResult
- type CodeSnippets
- type Command
- type Commands
- type Contact
- type ContactAnalytics
- type ContactGroup
- type ContactGroups
- type ContactParams
- type ContactPercentages
- type Contacts
- type Device
- type Enhancement
- type Enhancements
- type Event
- type EventName
- type Events
- type ExpandQuery
- type FileRequest
- type FileRequests
- type Folder
- type FollowUp
- type Guest
- type LinkResolver
- type LinkResolvers
- type Location
- type Member
- type MemberParams
- type Members
- type Message
- type MessageSequence
- type Messages
- type Note
- type Notes
- type Object
- type Option
- type Poll
- type Polls
- type QA
- type QAs
- type Question
- type Recipient
- type RecipientStatus
- type Reminder
- type ReminderFilterParams
- type ReminderParams
- type Reminders
- type Respondent
- type Response
- type ResultList
- type Role
- type Rule
- type RuleParams
- type Rules
- type Send
- type Sent
- type Sequence
- type SequenceCancel
- type SequenceFilterParams
- type SequenceRecipient
- type SequenceRecipientDetails
- type SequenceRecipientParams
- type SequenceRecipients
- type SequenceState
- type Sequences
- type Shared
- type SharedRole
- type SharedTeam
- type SharedUser
- type Sidebar
- type Sidebars
- type Snippet
- type SnippetFilterParams
- type SnippetParams
- type SnippetSendParams
- type SnippetTag
- type SnippetTagFilterParams
- type SnippetTags
- type Snippets
- type SortQuery
- type Team
- type TeamParams
- type Teams
- type TimedEvent
- type Timeslot
- type Unsubscribe
- type Unsubscribes
- type Upload
- type User
- type YesNo
- type YesNos
Constants ¶
View Source
const ( EVENT_UNOPENED EventName = "unopened" EVENT_OPENED = "opened" EVENT_CLICKED = "clicked" EVENT_DOWNLOADED = "downloaded" EVENT_RECEIVED = "message:received" EVENT_VOTE = "poll:vote" EVENT_QA_SUBMIT = "qa:submit" EVENT_MEETING_CONFIRMED = "meetinginvited:confirmed" )
View Source
const ( RECIPIENT_SUCCESS = "success" RECIPIENT_ERROR = "error" RECIPIENT_DUPLICATED = "duplicated" RECIPIENT_UNSUBSCRIBED = "unsubscribed" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppointmentLinks ¶
type Attachment ¶
type Availabilities ¶
type Availabilities struct {
Results []*Availability `json:"results,omitempty"`
*ResultList
}
type Availability ¶
type Availability struct {
ID string `json:"_id"`
UserId string `json:"userId,omitempty"`
Location string `json:"location,omitempty"`
Description string `json:"description,omitempty"`
Title string `json:"title,omitempty"`
Timezone string `json:"timezone,omitempty"`
CalendarID string `json:"calendarId,omitempty"`
CalendarName string `json:"calendarName,omitempty"`
Modify bool `json:"guestsCanModify,omitempty"`
Timeslots []Timeslot `json:"timeslots,omitempty"`
DoubleBookings bool `json:"allowDoubleBookings,omitempty"`
Guests []Guest `json:"guests,omitempty"`
}
type CRMConnect ¶
type CodeSnippet ¶
type CodeSnippet struct {
ID string `json:"_id"`
UserId string `json:"userId,omitempty"`
HTML string `json:"html,omitempty"`
Title string `json:"title,omitempty"`
Background string `json:"background,omitempty"`
Code string `json:"code,omitempty"`
Theme string `json:"theme,omitempty"`
Language string `json:"language,omitempty"`
}
type CodeSnippetParams ¶
type CodeSnippetResult ¶
type CodeSnippetResult struct {
ID string `json:"id"`
}
type CodeSnippets ¶
type CodeSnippets struct {
Results []*CodeSnippet `json:"results,omitempty"`
*ResultList
}
type Command ¶
type Command struct {
ID string `json:"_id"`
UserID string `json:"userId"`
CreatedAt time.Time `json:"createdAt"`
Name string `json:"name"`
Commands []string `json:"commands"`
ParameterPlaceholder string `json:"parameterPlaceholder"`
CommandResolveURL string `json:"commandResolveUrl"`
CommandParameterHingsURL string `json:"commandParameterHintsUrl"`
}
type Commands ¶
type Commands struct {
Results []*Command `json:"results"`
*ResultList
}
type ContactAnalytics ¶
type ContactAnalytics struct {
Sent int `json:"sent"`
Opened int `json:"opened"`
Clicked int `json:"clicked"`
Downloaded int `json:"downloaded"`
Replied int `json:"replied"`
Delivered int `json:"delivered"`
DeliveredWithTrackedOpens int `json:"deliveredWithTrackedOpens"`
DeliveredWithTrackedLinks int `json:"deliveredWithTrackedLinks"`
DeliveredWithTrackedFiles int `json:"deliveredWithTrackedFiles"`
Percentages *ContactPercentages `json:"percentages"`
}
type ContactGroup ¶
type ContactGroups ¶
type ContactGroups struct {
Results []*ContactGroup `json:"results"`
*ResultList
}
type ContactParams ¶
type ContactPercentages ¶
type Contacts ¶
type Contacts struct {
Results []*Contact `json:"results"`
*ResultList
}
type Enhancement ¶
type Enhancement struct {
ID string `json:"_id"`
UserID string `json:"userId"`
CreatedAt time.Time `json:"createdAt"`
Name string `json:"name"`
Icon string `json:"icon"`
IconTooltip string `json:"iconTooltip"`
EditorURL string `json:"editorUrl"`
Commands []string `json:"commands"`
ResolveURL string `json:"resolveUrl"`
ActivateURL string `json:"activateUrl"`
EditorHeight int `json:"editorHeight"`
EditorWidth int `json:"editorWidth"`
Category string `json:"category"`
Editable bool `json:"isEditable"`
}
type Enhancements ¶
type Enhancements struct {
Results []*Enhancement `json:"results"`
*ResultList
}
type Event ¶
type Event struct {
ID string `json:"_id"`
ThreadID string `json:"threadId"`
Subject string `json:"subject"`
Timestamp time.Time `json:"timestamp"`
RecipientEmail string `json:"recipientEmail"`
RecipientName string `json:"recipientName"`
UserID string `json:"userId"`
Device *Device `json:"device"`
Location *Location `json:"location"`
Object *Object `json:"object"`
Action string `json:"action"`
Recipients []*Contact `json:"recipients"`
}
type Events ¶
type Events struct {
Results []*Event `json:"results"`
*ResultList
}
type ExpandQuery ¶
type ExpandQuery struct {
Expand string
}
type FileRequest ¶
type FileRequests ¶
type FileRequests struct {
Results []*FileRequest `json:"results"`
*ResultList
}
type LinkResolver ¶
type LinkResolvers ¶
type LinkResolvers struct {
Results []*LinkResolver `json:"results"`
*ResultList
}
type MemberParams ¶
type Members ¶
type Members struct {
Results []*Member `json:"members"`
*ResultList
}
type Message ¶
type Message struct {
ID string `json:"_id"`
UserID string `json:"userId"`
Created time.Time `json:"created"`
Updated time.Time `json:"updated"`
From *Contact `json:"from"`
To *Contact `json:"to"`
CC []*Contact `json:"cc"`
BCC []*Contact `json:"bcc"`
Subject string `json:"subject"`
Tracking bool `json:"trackingEnabled"`
LinkTracking bool `json:"linkTrackingEnabled"`
Notifications bool `json:"notificationsEnabled"`
TeamIDs []string `json:"teamIds"`
FollowUp *FollowUp `json:"followUp"`
Attachments []*Attachment `json:"attachments"`
SnippetIDs []string `json:"snippetIds"`
Sequence *MessageSequence `json:"sequence"`
Body string `json:"body"`
Scheduled time.Time `json:"scheduled"`
Sent time.Time `json:"sent"`
SendingError string `json:"sendingError"`
ErrorResponse string `json:"errorResponse"`
}
type MessageSequence ¶
type Messages ¶
type Messages struct {
Results []*Message `json:"results"`
*ResultList
}
type Notes ¶
type Notes struct {
Results []*Note `json:"results"`
*ResultList
}
type Option ¶
type Option struct {
Text string `json:"text"`
Respondents []*Respondent `json:"respondents"`
}
type Polls ¶
type Polls struct {
Results []*Poll `json:"results"`
*ResultList
}
type QAs ¶
type QAs struct {
Results []*QA `json:"results"`
*ResultList
}
type RecipientStatus ¶
type RecipientStatus string
type Reminder ¶
type Reminder struct {
ID string `json:"_id,omitempty"`
UserID string `json:"userId,omitempty"`
Date time.Time `json:"date"`
CreatedAt time.Time `json:"createdAt,omitempty"`
Dismissed bool `json:"dismissed,omitempty"`
Trigger string `json:"trigger"`
ThreadSubject string `json:"threadSubject,omitempty"`
Description string `json:"description,omitempty"`
Service string `json:"service"`
ServiceMessageID string `json:"serviceMessageId,omitempty"`
ServiceThreadID string `json:"serviceThreadId,omitempty"`
MixmaxMessageID string `json:"mixmaxMessageId,omitempty"`
}
type ReminderFilterParams ¶
type ReminderParams ¶
type ReminderParams struct {
Date time.Time `json:"date,omitempty"`
Trigger string `json:"trigger,omitempty"`
ThreadSubject string `json:"threadSubject,omitempty"`
Description string `json:"description,omitempty"`
Service string `json:"service,omitempty"`
ServiceMessageID string `json:"serviceMessageId,omitempty"`
ServiceThreadID string `json:"serviceThreadId,omitempty"`
MixmaxMessageID string `json:"mixmaxMessageId,omitempty"`
Recipients []*Contact `json:"recipients,omitempty"`
Dismissed bool `json:"dismissed,omitempty"`
ArchiveThread bool
}
type Reminders ¶
type Reminders struct {
Results []*Reminder `json:"results"`
*ResultList
}
type Respondent ¶
type ResultList ¶
type Rule ¶
type Rule struct {
ID string `json:"_id"`
UserID string `json:"userId"`
CreatedAt time.Time `json:"createdAt"`
ModifiedAt time.Time `json:"modifiedAt"`
Name string `json:"name"`
EventName EventName `json:"eventName"`
Filter string `json:"filter,omitempty"`
Action *Action `json:"action"`
Paused bool `json:"isPaused"`
}
type RuleParams ¶
type Rules ¶
type Rules struct {
Results []*Rules `json:"results"`
*ResultList
}
type Sequence ¶
type Sequence struct {
ID string `json:"_id"`
UserID string `json:"userId"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt time.Time `json:"updatedAt"`
Name string `json:"name"`
SendStagesAsReplies bool `json:"sendStagesAsReplies"`
Stages []string `json:"stages"`
CC []*SequenceRecipient `json:"cc"`
BCC []*SequenceRecipient `json:"bcc"`
LinkTracking bool `json:"linkTrackingEnabled"`
Notifications bool `json:"notificationsEnabled"`
TeamIDs []string `json:"teamIds"`
Variables []string `json:"variables"`
CRMsConnnected []CRMConnect `json:"crmConnected"`
Timezone string `json:"timezone"`
}
type SequenceCancel ¶
type SequenceCancel struct {
Recipients []string `json:"recipients"`
}
type SequenceFilterParams ¶
type SequenceFilterParams struct {
Name string
Folder string
*ExpandQuery
}
type SequenceRecipient ¶
type SequenceRecipient struct {
Name string `json:"name"`
Email string `json:"email"`
Status RecipientStatus `json:"status"`
Errors []string `json:"errors"`
}
type SequenceRecipientDetails ¶
type SequenceRecipientDetails struct {
ID string `json:"_id"`
UserID string `json:"userId"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt time.Time `json:"updatedAt"`
SequenceID string `json:"sequenceId"`
Variables map[string]string `json:"variables"`
State SequenceState `json:"state"`
*SequenceRecipient
}
type SequenceRecipientParams ¶
type SequenceRecipients ¶
type SequenceRecipients struct {
Results []*SequenceRecipientDetails `json:"results"`
*ResultList
}
type SequenceState ¶
type SequenceState string
const ( SEQUENCE_ACTIVE SequenceState = "active" SEQUENCE_FAILED SequenceState = "failed" SEQUENCE_COMPLETED SequenceState = "completed" )
type Sequences ¶
type Sequences struct {
Results []*Sequence `json:"results"`
*ResultList
}
type SharedRole ¶
type SharedRole string
const ( SHARED_READ SharedRole = "read-only" SHARED_WRITE = "read-write" )
type SharedTeam ¶
type SharedTeam struct {
}
type SharedUser ¶
type SharedUser struct {
}
type Sidebars ¶
type Sidebars struct {
Results []*Sidebar `json:"results"`
*ResultList
}
type Snippet ¶
type Snippet struct {
ID string `json:"_id"`
UserID string `json:"userId"`
CreatedAt time.Time `json:"createdAt"`
SavedAt time.Time `json:"savedAt"`
DeletedAt time.Time `json:"deletedAt"`
SavedBy string `json:"savedBy"`
Name string `json:"name"`
Title string `json:"title"`
Source string `json:"source"`
}
type SnippetFilterParams ¶
type SnippetFilterParams struct {
IncludeDeleted bool
Fields []string
*ExpandQuery
}
type SnippetParams ¶
type SnippetSendParams ¶
type SnippetTag ¶
type SnippetTagFilterParams ¶
type SnippetTagFilterParams struct {
Search string
*ExpandQuery
*SortQuery
}
type SnippetTags ¶
type SnippetTags struct {
Results []*SnippetTag `json:"results"`
*ResultList
}
type Snippets ¶
type Snippets struct {
Results []*Snippet `json:"results"`
*ResultList
}
type TeamParams ¶
type TeamParams struct {
Name string `json:"name"`
Members []*MemberParams `json:"members"`
}
type Teams ¶
type Teams struct {
Results []*Team `json:"results"`
*ResultList
}
type TimedEvent ¶
type Timeslot ¶
type Timeslot struct {
Start time.Time `json:"start,omitempty"`
End time.Time `json:"end,omitempty"`
Events []TimedEvent `json:"events,omitempty"`
}
type Unsubscribe ¶
type Unsubscribes ¶
type Unsubscribes struct {
Results []*Unsubscribe `json:"results"`
*ResultList
}
type YesNos ¶
type YesNos struct {
Results []*YesNo `json:"results"`
*ResultList
}
Source Files
¶
Click to show internal directories.
Click to hide internal directories.