webexteams

package
Version: v0.4.2 Latest Latest
Warning

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

Go to latest
Published: Aug 6, 2021 License: MIT Imports: 7 Imported by: 63

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdminAuditEventsService added in v0.4.1

type AdminAuditEventsService service

AdminAuditEventsService is the service to communicate with the AdminAuditEvents API endpoint

func (*AdminAuditEventsService) ListAdminAuditEvents added in v0.4.1

func (s *AdminAuditEventsService) ListAdminAuditEvents(listAdminAuditEventsQueryParams *ListAdminAuditEventsQueryParams) (*AuditEvents, *resty.Response, error)

ListAdminAuditEvents List Admin Audit Events

List admin audit events in your organization. Several query parameters are available to filter the response.

@param orgId List events in this organization, by ID @param from List events which occurred after a specific date and tim @param to List events which occurred before a specific date and time @param actorId List events performed by this person, by ID @param max Limit the maximum number of events in the response. The maximum value is 200 Default: 100 @param offset Offset from the first result that you want to fetch. Default: 0

type Attachment added in v0.4.1

type Attachment struct {
	Content     map[string]interface{} `json:"content"`
	ContentType string                 `json:"contentType"`
}

Attachment is the object to manage attachments in messages

type AuditEvents added in v0.4.1

type AuditEvents struct {
	Items []struct {
		Created    string `json:"created,omitempty"`    // The date and time the event took place.
		ActorOrgID string `json:"actorOrgId,omitempty"` // The orgId of the person who made the change.
		ID         string `json:"id,omitempty"`         // A unique identifier for the event.
		ActorID    string `json:"actorId,omitempty"`    // The personId of the person who made the change.
		Data       struct {
			ActorOrgName     string   `json:"actorOrgName,omitempty"`     // The display name of the organization.
			TargetName       string   `json:"targetName,omitempty"`       // The name of the resource being acted upon.
			EventDescription string   `json:"eventDescription,omitempty"` // A description for the event.
			ActorName        string   `json:"actorName,omitempty"`        // The name of the person who performed the action.
			ActorEmail       string   `json:"actorEmail,omitempty"`       // The email of the person who performed the action.
			AdminRoles       []string `json:"adminRoles,omitempty"`       // Admin roles for the person.
			TrackingID       string   `json:"trackingId,omitempty"`       // A tracking identifier for the event.
			TargetType       string   `json:"targetType,omitempty"`       // The type of resource changed by the event.
			TargetID         string   `json:"targetId,omitempty"`         // The identifier for the resource changed by the event.
			EventCategory    string   `json:"eventCategory,omitempty"`    // The category of resource changed by the event.
			ActorUserAgent   string   `json:"actorUserAgent,omitempty"`   // The browser user agent of the person who performed the action.
			ActorIP          string   `json:"actorIp,omitempty"`          // The IP address of the person who performed the action.
			TargetOrgID      string   `json:"targetOrgId,omitempty"`      // The orgId of the organization.
			ActionText       string   `json:"actionText,omitempty"`       // A more detailed description of the change made by the person.
			TargetOrgName    string   `json:"targetOrgName,omitempty"`    // The name of the organization being acted upon.
		} `json:"data,omitempty"` // data
	} `json:"items,omitempty"` // items
}

AuditEvents is the AuditEvents definition

type Client

type Client struct {

	// API Services
	AdminAuditEvents *AdminAuditEventsService
	Contents         *ContentsService
	Events           *EventsService
	Devices          *DevicesService
	Licenses         *LicensesService
	Memberships      *MembershipsService
	Messages         *MessagesService
	Organizations    *OrganizationsService
	People           *PeopleService
	Recordings       *RecordingsService
	Roles            *RolesService
	Rooms            *RoomsService
	TeamMemberships  *TeamMembershipsService
	Teams            *TeamsService
	Webhooks         *WebhooksService
	// contains filtered or unexported fields
}

Client manages communication with the Webex Teams API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewClient

func NewClient() *Client

NewClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*Client) SetAuthToken added in v0.3.0

func (s *Client) SetAuthToken(accessToken string)

SetAuthToken defines the Authorization token sent in the request

type ContentsService

type ContentsService service

ContentsService is the service to communicate with the Contents API endpoint

func (*ContentsService) GetContent

func (s *ContentsService) GetContent(contentID string) (*resty.Response, error)

GetContent Get File contents.

Get File contents by ID. Returns binary of file.

@param contentID Content ID. @return

type Device added in v0.4.1

type Device struct {
	ID               string   `json:"id,omitempty"`               // A unique identifier for the device.
	DisplayName      string   `json:"displayName,omitempty"`      // A friendly name for the device.
	PlaceID          string   `json:"placeId,omitempty"`          // The place associated with the device.
	OrgID            string   `json:"orgId,omitempty"`            // The organization associated with the device.
	Capabilities     []string `json:"capabilities,omitempty"`     // The capabilities of the device.
	Permissions      []string `json:"permissions,omitempty"`      // The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.
	ConnectionStatus string   `json:"connectionStatus,omitempty"` // The connection status of the device.
	Product          string   `json:"product,omitempty"`          // The product name.
	Tags             []string `json:"tags,omitempty"`             // Tags assigned to the device.
	IP               string   `json:"ip,omitempty"`               // The current IP address of the device.
	ActiveInterface  string   `json:"activeInterface,omitempty"`  // The current network connectivty for the device.
	MAC              string   `json:"mac,omitempty"`              // The unique address for the network adapter.
	Serial           string   `json:"serial,omitempty"`           // Serial number for the device.
	Software         string   `json:"software,omitempty"`         // The operating system name data and version tag.
	UpgradeChannel   string   `json:"upgradeChannel,omitempty"`   // The upgrade channel the device is assigned to.
	PrimarySIPURL    string   `json:"primarySipUrl,omitempty"`    // The primary SIP address to dial this device.
	SIPURLs          []string `json:"sipUrls,omitempty"`          // All SIP addresses to dial this device.
	ErrorCodes       []string `json:"errorcodes,omitempty"`       // Device Error codes
}

Device is the Device definition

type DeviceCode added in v0.4.1

type DeviceCode struct {
	ID      string    `json:"id,omitempty"`
	Code    string    `json:"code,omitempty"`
	PlaceID string    `json:"placeId,omitempty"`
	Created time.Time `json:"created,omitempty"`
	Expires time.Time `json:"expires,omitempty"`
}

DeviceCode is the code to activate a device in a Place

type DeviceCodeRequest added in v0.4.1

type DeviceCodeRequest struct {
	PlaceID string `json:"placeId,omitempty"` // The placeId of the place where the device will be activated.
}

DeviceCodeRequest is the Create Device Activation Code Request Parameters

type Devices added in v0.4.1

type Devices struct {
	Items []Device `json:"items,omitempty"`
}

Devices is the List of Devices

func (*Devices) AddDevice added in v0.4.1

func (devices *Devices) AddDevice(item Device) []Device

AddDevice is used to append a device to a slice of Devices

type DevicesService added in v0.4.1

type DevicesService service

DevicesService is the service to communicate with the Devices API endpoint

func (*DevicesService) CreateDeviceActivationCode added in v0.4.1

func (s *DevicesService) CreateDeviceActivationCode(deviceCodeRequest *DeviceCodeRequest) (*DeviceCode, *resty.Response, error)

CreateDeviceActivationCode Create a Device Activation Code

Generate an activation code for a device in a specific place by placeId.

Currently, activation codes may only be generated for shared places--personal mode is not supported.

@param placeId (string) The placeId of the place where the device will be activated.
@return DeviceCode

func (*DevicesService) DeleteDevice added in v0.4.1

func (s *DevicesService) DeleteDevice(deviceID string) (*resty.Response, error)

DeleteDevice Remove a device from the system. Only an admin can remove a device.

Remove a device from the system. Only an admin can remove a device.

Specify the device ID in the deviceID parameter in the URI.

@param deviceID A unique identifier for the device.
@return

func (*DevicesService) GetDevice added in v0.4.1

func (s *DevicesService) GetDevice(deviceID string) (*Device, *resty.Response, error)

GetDevice Shows details for a device, by ID.

Shows details for a device, by ID. Specify the device ID in the deviceId parameter in the URI.

@param deviceID (string) unique identifier for the device. @return Device

func (*DevicesService) ListDevices added in v0.4.1

func (s *DevicesService) ListDevices(queryParams *ListDevicesQueryParams) (*Devices, *resty.Response, error)

ListDevices List devices in your organization.

Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode.

Administrators can list all devices within an organization.

@param personId (string) list devices by person ID.
@param placeId (string ) list devices by place ID.
@param orgId (string) list devices in this organization. Only admin users of another organization (such as partners) may use this parameter.
@param displayName (string) list devices with this display name.
@param product (string) list devices with this product name. Possible values: DX-80, RoomKit, SX-80
@param tag (string) list devices which have a tag. Accepts multiple values separated by commas.
@param connectionStatus (string) list devices with this connection status.
@param serial (string) list devices with this serial number.
@param software (string) list devices with this software version.
@param upgradechannel (string) list devices with this upgrade channel.
@param errorCode (string) list devices with this error code.
@param capability (string) list devices with this capability. Possible values: xapi
@param permission (string) list devices with this permission.
@param start (int) offset. default is 0.
@param max (int) limit the maximum number of items in the response.
@param paginate (bool) indicates if pagination is needed
@return Devices

type Error added in v0.4.1

type Error struct{}

Error indicates an error from the invocation of a Webex API. See the following documentation for error context: https://developer.webex.com/docs/api/basics#api-errors.

type Event added in v0.4.1

type Event struct {
	ID         string    `json:"id,omitempty"`         // A unique identifier for the event.
	Resource   string    `json:"resource,omitempty"`   // The type of resource in the event.
	AppID      string    `json:"appId,omitempty"`      // The ID of the application for the event.
	ActorID    string    `json:"actorId,omitempty"`    // The personId of the person who made the change.
	OrgID      string    `json:"orgId,omitempty"`      // The ID of the organization for the event.
	Created    time.Time `json:"created,omitempty"`    // The date and time of the event.
	ActorOrgID string    `json:"actorOrgId,omitempty"` // The orgId of the person who made the change.
	Data       struct {
		ID          string `json:"id,omitempty"`          // Action ID.
		RoomID      string `json:"roomId,omitempty"`      // Room ID where the event happened.
		RoomType    string `json:"roomType,omitempty"`    // Room type where the event happened.
		Text        string `json:"text,omitempty"`        // Text related to the event, in the case of a message.
		PersonID    string `json:"personId,omitempty"`    // Person ID of the user who triggered the event.
		PersonEmail string `json:"personEmail,omitempty"` // Person Email of the user who triggered the event.
		Created     string `json:"created,omitempty"`     // The date and time of the event.
	} `json:"data,omitempty"` // data
}

Event is the Event definition

type Events added in v0.4.1

type Events struct {
	Items []Event `json:"items,omitempty"` //
}

Events is the Events definition

type EventsService added in v0.4.1

type EventsService service

EventsService is the service to communicate with the Events API endpoint

func (*EventsService) GetEvent added in v0.4.1

func (s *EventsService) GetEvent(eventID string) (*Event, *resty.Response, error)

GetEvent Get Event Details

Shows details for an event, by event ID.

Specify the event ID in the eventId parameter in the URI.

@param eventId The unique identifier for the event.

func (*EventsService) ListEvents added in v0.4.1

func (s *EventsService) ListEvents(listEventsQueryParams *ListEventsQueryParams) (*Events, *resty.Response, error)

ListEvents List Events

List events in your organization. Several query parameters are available to filter the response.

Long result sets will be split into pages.

@param resource List events with a specific resource type. Possible values: messages, memberships, tabs, rooms, attachmentActions @param type List events with a specific event type. Possible values: created, updated, deleted @param actorId List events performed by this person, by ID. @param from List events which occurred after a specific date and time. @param to List events which occurred before a specific date and time. If unspecified or set to a time in the future, lists events up to the present. @param max Limit the maximum number of events in the response. The maximum value is 200 Default: 100

type License

type License struct {
	ID            string `json:"id,omitempty"`            // License ID.
	Name          string `json:"name,omitempty"`          // License Display Name.
	TotalUnits    int    `json:"totalUnits,omitempty"`    // License quantity total.
	ConsumedUnits int    `json:"consumedUnits,omitempty"` // License quantity consumed.
}

License is the License definition

type Licenses

type Licenses struct {
	Items []License `json:"items,omitempty"`
}

Licenses is the List of Licenses

func (*Licenses) AddLicense

func (licenses *Licenses) AddLicense(item License) []License

AddLicense is used to append a license to a slice of licenses

type LicensesService

type LicensesService service

LicensesService is the service to communicate with the Licenses API endpoint

func (*LicensesService) GetLicense

func (s *LicensesService) GetLicense(licenseID string) (*License, *resty.Response, error)

GetLicense Shows details for a license, by ID.

Shows details for a license, by ID.

Specify the license ID in the licenseID parameter in the URI.

@param licenseID License ID.
@return License

func (*LicensesService) ListLicenses

func (s *LicensesService) ListLicenses(queryParams *ListLicensesQueryParams) (*Licenses, *resty.Response, error)

ListLicenses List all licenses for a given organization.

List all licenses for a given organization.

If no orgID is specified, the default is the organization of the authenticated user.

@param "max" (int) Limit the maximum number of items in the response.
@param paginate (bool) indicates if pagination is needed
@return Licenses

type ListAdminAuditEventsQueryParams added in v0.4.1

type ListAdminAuditEventsQueryParams struct {
	OrgID   string `url:"orgId,omitempty"`   // List events in this organization, by ID
	From    string `url:"from,omitempty"`    // List events which occurred after a specific date and tim
	To      string `url:"to,omitempty"`      // List events which occurred before a specific date and time
	ActorID string `url:"actorId,omitempty"` // List events performed by this person, by ID
	Max     int    `url:"max,omitempty"`     // Limit the maximum number of events in the response. The maximum value is 200 Default: 100
	Offset  int    `url:"offset,omitempty"`  // Offset from the first result that you want to fetch. Default: 0
}

ListAdminAuditEventsQueryParams defines the query parameters for this request

type ListDevicesQueryParams added in v0.4.1

type ListDevicesQueryParams struct {
	PersonID         string `url:"personId,omitempty"`         // List devices by person ID.
	PlaceID          string `url:"placeId,omitempty"`          // List devices by place ID.
	OrgID            string `url:"orgId,omitempty"`            // List devices in this organization. Only admin users of another organization (such as partners) may use this parameter.
	DisplayName      string `url:"displayName,omitempty"`      // List devices with this display name.
	Product          string `url:"product,omitempty"`          // List devices with this product name. Possible values: DX-80, RoomKit, SX-80
	Tag              string `url:"tag,omitempty"`              // List devices which have a tag. Accepts multiple values separated by commas.
	ConnectionStatus string `url:"connectionStatus,omitempty"` // List devices with this connection status.
	Serial           string `url:"serial,omitempty"`           // List devices with this serial number.
	Software         string `url:"software,omitempty"`         // List devices with this software version.
	UpgradeChannel   string `url:"upgradeChannel,omitempty"`   // List devices with this upgrade channel.
	ErrorCode        string `url:"errorcode,omitempty"`        // List devices with this error code.
	Capability       string `url:"capability,omitempty"`       // List devices with this capability. Possible values: xapi
	Permission       string `url:"permission,omitempty"`       // List devices with this permission.
	Start            int    `url:"start,omitempty"`            // Offset. Default is 0.
	Max              int    `url:"max,omitempty"`              // Limit the maximum number of items in the response.
	Paginate         bool   // Indicates if pagination is needed
}

ListDevicesQueryParams are the query params for the ListDevices API Call

type ListEventsQueryParams added in v0.4.1

type ListEventsQueryParams struct {
	Resource string `url:"resource,omitempty"` // List events with a specific resource type. Possible values: messages, memberships, tabs, rooms, attachmentActions
	Type     string `url:"type,omitempty"`     // List events with a specific event type. Possible values: created, updated, deleted
	ActorID  string `url:"actorId,omitempty"`  // List events performed by this person, by ID.
	From     string `url:"from,omitempty"`     // List events which occurred after a specific date and time.
	To       string `url:"to,omitempty"`       // List events which occurred before a specific date and time. If unspecified or set to a time in the future, lists events up to the present.
	Max      int    `url:"max,omitempty"`      // Limit the maximum number of events in the response. The maximum value is 200 Default: 100
}

ListEventsQueryParams defines the query parameters for this request

type ListLicensesQueryParams

type ListLicensesQueryParams struct {
	Max      int  `url:"max,omitempty"` // Limit the maximum number of items in the response.
	Paginate bool // Indicates if pagination is needed
}

ListLicensesQueryParams are the query params for the ListLicenses API Call

type ListMeetingsQueryParams added in v0.4.1

type ListMeetingsQueryParams struct {
	RoomID          string    `url:"roomId,omitempty"`          // List meetings for a room, by ID.
	MentionedPeople string    `url:"mentionedPeople,omitempty"` // List meetings where the caller is mentioned by specifying *me* or the caller personId.
	Before          time.Time `url:"before,omitempty"`          // List meetings sent before a date and time, in ISO8601 format. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
	BeforeMeeting   string    `url:"beforeMeeting,omitempty"`   // List meetings sent before a meeting, by ID.
	Max             int       `url:"max,omitempty"`             // Limit the maximum number of items in the response.
	Paginate        bool      // Indicates if pagination is needed
}

ListMeetingsQueryParams are the query params for the ListMeetings API Call

type ListMembershipsQueryParams

type ListMembershipsQueryParams struct {
	RoomID      string `url:"roomId,omitempty"`      // Room ID.
	PersonID    string `url:"personId,omitempty"`    // Person ID.
	PersonEmail string `url:"personEmail,omitempty"` // Person email.
	Max         int    `url:"max,omitempty"`         // Limit the maximum number of items in the response.
	Paginate    bool   // Indicates if pagination is needed
}

ListMembershipsQueryParams are the query params for the ListMemberships API Call

type ListMessagesQueryParams

type ListMessagesQueryParams struct {
	RoomID          string    `url:"roomId,omitempty"`          // List messages for a room, by ID.
	MentionedPeople string    `url:"mentionedPeople,omitempty"` // List messages where the caller is mentioned by specifying *me* or the caller personId.
	Before          time.Time `url:"before,omitempty"`          // List messages sent before a date and time, in ISO8601 format. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
	BeforeMessage   string    `url:"beforeMessage,omitempty"`   // List messages sent before a message, by ID.
	Max             int       `url:"max,omitempty"`             // Limit the maximum number of items in the response.
	Paginate        bool      // Indicates if pagination is needed
}

ListMessagesQueryParams are the query params for the ListMessages API Call

type ListOrganizationsQueryParams

type ListOrganizationsQueryParams struct {
	Max      int  `url:"max,omitempty"` // Limit the maximum number of items in the response.
	Paginate bool // Indicates if pagination is needed
}

ListOrganizationsQueryParams are the query params for the ListOrganizations API Call

type ListPeopleQueryParams

type ListPeopleQueryParams struct {
	ID          string `url:"id,omitempty"`          // List people by ID. Accepts up to 85 person IDs separated by commas.
	Email       string `url:"email,omitempty"`       // List people with this email address. For non-admin requests, either this or displayName are required.
	DisplayName string `url:"displayName,omitempty"` // List people whose name starts with this string. For non-admin requests, either this or email are required.
	Max         int    `url:"max,omitempty"`         // Limit the maximum number of items in the response.
	OrgID       string `url:"orgId,omitempty"`       // List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
	Paginate    bool   // Indicates if pagination is needed
}

ListPeopleQueryParams are the query params for the ListPeople API Call

type ListPlacesQueryParams added in v0.4.1

type ListPlacesQueryParams struct {
	TeamID    string `url:"teamId,omitempty"` // Limit the places to those associated with a team, by ID.
	PlaceType string `url:"type,omitempty"`   // direct returns all 1-to-1 places. group returns all group places.
	SortBy    string `url:"sortBy,omitempty"` // Sort results by place ID (id), most recent activity (lastactivity), or most recently created (created).
	Max       int    `url:"max,omitempty"`    // Limit the maximum number of items in the response.
	Paginate  bool   // Indicates if pagination is needed
}

ListPlacesQueryParams are the query params for the ListPlaces API Call

type ListRecordingsQueryParams added in v0.4.1

type ListRecordingsQueryParams struct {
	From     string `url:"from,omitempty"` // Starting date and time (inclusive) for recordings to return, in any ISO 8601 compliant format. from cannot be after current date and time or after to.
	To       string `url:"To,omitempty"`   // Ending date and time (exclusive) for List recordings to return, in any ISO 8601 compliant format. to cannot be after current date and time or before from.
	Max      int    `url:"max,omitempty"`  // Limit the maximum number of items in the response.
	Paginate bool   // Indicates if pagination is needed
}

ListRecordingsQueryParams are the query params for the ListRecordings API Call

type ListRoomsQueryParams

type ListRoomsQueryParams struct {
	TeamID   string `url:"teamId,omitempty"` // Limit the rooms to those associated with a team, by ID.
	RoomType string `url:"type,omitempty"`   // direct returns all 1-to-1 rooms. group returns all group rooms.
	SortBy   string `url:"sortBy,omitempty"` // Sort results by room ID (id), most recent activity (lastactivity), or most recently created (created).
	Max      int    `url:"max,omitempty"`    // Limit the maximum number of items in the response.
	Paginate bool   // Indicates if pagination is needed
}

ListRoomsQueryParams are the query params for the ListRooms API Call

type ListTeamMemberhipsQueryParams

type ListTeamMemberhipsQueryParams struct {
	TeamID   string `url:"teamId,omitempty"` // Team ID.
	Max      int    `url:"max,omitempty"`    // Limit the maximum number of items in the response.
	Paginate bool   // Indicates if pagination is needed
}

ListTeamMemberhipsQueryParams are the query params for the ListTeamMemberhips API Call

type ListTeamsQueryParams

type ListTeamsQueryParams struct {
	Max      int  `url:"max,omitempty"` // Limit the maximum number of items in the response.
	Paginate bool // Indicates if pagination is needed
}

ListTeamsQueryParams are the query params for the ListTeams API Call

type ListWebhooksQueryParams

type ListWebhooksQueryParams struct {
	Max      int  `url:"max,omitempty"` // Limit the maximum number of items in the response.
	Paginate bool // Indicates if pagination is needed
}

ListWebhooksQueryParams are the query params for the ListWebhooks API Call

type Meeting added in v0.4.1

type Meeting struct {
	ID                       string             `json:"id,omitempty"`                          // Unique identifier for meeting
	MeetingSeriesID          string             `json:"meetingSeriesId,omitempty"`             // Unique identifier for meeting series.
	MeetingNumber            string             `json:"meetingNumber,omitempty"`               // Meeting number.
	Title                    string             `json:"title,omitempty"`                       // Meeting title.
	Agenda                   string             `json:"agenda,omitempty"`                      // Meeting agenda. The agenda can be a maximum of 2500 characters long.
	Password                 string             `json:"password,omitempty"`                    //  Meeting password.
	MeetingType              string             `json:"meetingType,omitempty"`                 // One Of: meetingSeries, scheduledMeeting o meeting
	State                    string             `json:"state,omitempty"`                       // Meeting state.
	Timezone                 string             `json:"timezone,omitempty"`                    // Time zone of start and end, conforming with the IANA time zone database.
	Start                    time.Time          `json:"start,omitempty"`                       // Start time for meeting in ISO 8601 compliant format.
	End                      time.Time          `json:"end,omitempty"`                         // End time for meeting in ISO 8601 compliant format.
	Recurrence               string             `json:"recurrence,omitempty"`                  // Meeting series recurrence rule (conforming with RFC 2445), applying only to recurring meeting series.
	HostUserID               string             `json:"hostUserId,omitempty"`                  // Unique identifier for meeting host.
	HostDisplayName          string             `json:"hostDisplayName,omitempty"`             // Display name for meeting host.
	HostEmail                string             `json:"hostEmail,omitempty"`                   // Email address for meeting host.
	HostKey                  string             `json:"hostKey,omitempty"`                     // Key for joining meeting as host.
	WebLink                  string             `json:"webLink,omitempty"`                     // Link to meeting information page where meeting client will be launched if the meeting is ready for start or join.
	SIPAddress               string             `json:"sipAddress,omitempty"`                  // SIP address for callback from a video system.
	DialInIPAddress          string             `json:"dialInIpAddress,omitempty"`             // IP address for callback from a video system.
	EnabledAutoRecordMeeting bool               `json:"enabledAutoRecordingMeeting,omitempty"` // Whether or not meeting is recorded automatically.
	AllowAnyUserToBeCoHost   bool               `json:"allowAnyUserToBeCoHost,omitempty"`      // Whether or not to allow any invitee to be a cohost
	Telephony                []MeetingTelephony `json:"telephony,omitempty"`                   // Information for callbacks from meeting to phone or for joining a teleconference using a phone.
}

Meeting is the Meeting definition

type MeetingCreateRequest added in v0.4.1

type MeetingCreateRequest struct {
	Title                    string           `json:"title,omitempty"`                    // Meeting title.
	Agenda                   string           `json:"agenda,omitempty"`                   // Meeting agenda. The agenda can be a maximum of 2500 characters long.
	Password                 string           `json:"password,omitempty"`                 // Meeting password.
	Start                    time.Time        `json:"start,omitempty"`                    // Date and time for the start of meeting in any ISO 8601 compliant format. start cannot be before current date and time or after end.
	End                      time.Time        `json:"end,omitempty"`                      // Date and time for the end of meeting in any ISO 8601 compliant format. end cannot be before current date and time or before start.
	Timezone                 string           `json:"timezone,omitempty"`                 // Time zone in which meeting was originally scheduled (conforming with the IANA time zone database).
	Recurrence               string           `json:"recurrence,omitempty"`               // Meeting series recurrence rule (conforming with RFC 2445), applying only to meeting series.
	EnabledAutoRecordMeeting string           `json:"enabledAutoRecordMeeting,omitempty"` // Whether or not meeting is recorded automatically.
	AllowAnyUserToBeCoHost   string           `json:"allowAnyUserToBeCoHost,omitempty"`   // Whether or not to allow any invitee to be a cohost.
	Invitees                 []MeetingInvitee `json:"invitees,omitempty"`                 // Invitees for meeting.
}

MeetingCreateRequest is the Create Meeting Request Parameters

type MeetingInvitee added in v0.4.1

type MeetingInvitee struct {
	Email       string `json:"email,omitempty"`
	DisplayName string `json:"DisplayName,omitempty"`
	CoHost      string `json:"CoHost,omitempty"`
}

MeetingInvitee is the invitee definition

type MeetingTelephony added in v0.4.1

type MeetingTelephony struct {
	AccessCode    string `json:"accessCode,omitempty"` // Code for authenticating a user to join teleconference.
	CallInNumbers struct {
		Label        string `json:"label,omitempty"`
		CallInNumber string `json:"callInNumber,omitempty"`
		TollType     string `json:"tollType,omitempty"`
	} `json:",omitempty"` // Array of call-in numbers for joining teleconference from a phone.
	Links struct {
		Rel    string `json:"rel,omitempty"`    // Link relation describing how the target resource is related to the current context (conforming with RFC5998).
		HREF   string `json:"href,omitempty"`   // Target resource URI (conforming with RFC5998).
		Method string `json:"method,omitempty"` // Target resource method (conforming with RFC5998).
	} `json:"links,omitempty"` // HATEOAS information of global call-in numbers for joining teleconference from a phone.
}

MeetingTelephony is the Meeting Telephony definition

type Meetings added in v0.4.1

type Meetings struct {
	Items []Meeting `json:"items,omitempty"`
}

Meetings is the List of Meetings

func (*Meetings) AddMeeting added in v0.4.1

func (meetings *Meetings) AddMeeting(item Meeting) []Meeting

AddMeeting is used to append a meeting to a slice of meetings

type MeetingsService added in v0.4.1

type MeetingsService service

MeetingsService is the service to communicate with the Meetings API endpoint

func (*MeetingsService) CreateMeeting added in v0.4.1

func (s *MeetingsService) CreateMeeting(meetingCreateRequest *MeetingCreateRequest) (*Meeting, *resty.Response, error)

CreateMeeting Post a plain text or rich text meeting, and optionally, a media content attachment, to a room.

Post a plain text or rich text meeting, and optionally, a media content attachment, to a room.

The files parameter is an array, which accepts multiple values to allow for future expansion, but currently only one file may be included with the meeting.

@param meetingCreateRequest
@return Meeting

func (*MeetingsService) DeleteMeeting added in v0.4.1

func (s *MeetingsService) DeleteMeeting(meetingID string) (*resty.Response, error)

DeleteMeeting Delete a Meeting.

Deletes a meeting by ID.

@param meetingID Meeting ID. @return

func (*MeetingsService) GetMeeting added in v0.4.1

func (s *MeetingsService) GetMeeting(meetingID string) (*Meeting, *resty.Response, error)

GetMeeting Shows details for a meeting, by meeting ID.

Shows details for a meeting, by meeting ID.

Specify the meeting ID in the meetingID parameter in the URI.

@param meetingID Meeting ID.
@return Meeting

func (*MeetingsService) ListMeetings added in v0.4.1

func (s *MeetingsService) ListMeetings(queryParams *ListMeetingsQueryParams) (*Meetings, *resty.Response, error)

ListMeetings Lists all meetings in a room. Each meeting will include content attachments if present.

Lists all meetings in a room. Each meeting will include content attachments if present.

The list sorts the meetings in descending order by creation date. Long result sets will be split into pages.

@param roomID List meetings for a room, by ID.
@param "mentionedPeople" (string) List meetings where the caller is mentioned by specifying *me* or the caller personId.
@param "before" (time.Time) List meetings sent before a date and time, in ISO8601 format. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
@param "beforeMeeting" (string) List meetings sent before a meeting, by ID.
@param "max" (int) Limit the maximum number of items in the response.
@param "paginate" (bool) Indicates if pagination is needed
@return Meetings

type Membership

type Membership struct {
	ID                string    `json:"id,omitempty"`                // Membership ID.
	RoomID            string    `json:"roomId,omitempty"`            // Room ID.
	PersonID          string    `json:"personId,omitempty"`          // Person ID.
	PersonEmail       string    `json:"personEmail,omitempty"`       // Person email.
	PersonDisplayName string    `json:"personDisplayName,omitempty"` // Person display name.
	IsModerator       bool      `json:"isModerator,omitempty"`       // Membership is moderator.
	IsMonitor         bool      `json:"isMonitor,omitempty"`         // Membership is monitor.
	Created           time.Time `json:"created,omitempty"`           // Membership creation date/time.
}

Membership is the Membership definition

type MembershipCreateRequest

type MembershipCreateRequest struct {
	RoomID      string `json:"roomId,omitempty"`      // Room ID.
	PersonID    string `json:"personId,omitempty"`    // Person ID.
	PersonEmail string `json:"personEmail,omitempty"` // Person email.
	IsModerator bool   `json:"isModerator,omitempty"` // Membership is a moderator.
}

MembershipCreateRequest is the Create Membership Request Parameters

type MembershipUpdateRequest

type MembershipUpdateRequest struct {
	IsModerator bool `json:"isModerator,omitempty"` // Membership is a moderator.
}

MembershipUpdateRequest is the Update Membership Request object

type Memberships

type Memberships struct {
	Items []Membership `json:"items,omitempty"`
}

Memberships is the List of Memberships

func (*Memberships) AddMembership

func (memberships *Memberships) AddMembership(item Membership) []Membership

AddMembership is used to append a membership to a slice of memberships

type MembershipsService

type MembershipsService service

MembershipsService is the service to communicate with the Memberships API endpoint

func (*MembershipsService) CreateMembership

func (s *MembershipsService) CreateMembership(membershipCreateRequest *MembershipCreateRequest) (*Membership, *resty.Response, error)

CreateMembership Add someone to a membership by Person ID or email address; optionally making them a moderator.

Add someone to a membership by Person ID or email address; optionally making them a moderator.

@param membershipCreateRequest @return Membership

func (*MembershipsService) DeleteMembership

func (s *MembershipsService) DeleteMembership(membershipID string) (*resty.Response, error)

DeleteMembership Deletes a membership by ID.

Deletes a membership by ID.

Specify the membership ID in the membershipID URI parameter.

@param membershipID Membership ID.
@return

func (*MembershipsService) GetMembership

func (s *MembershipsService) GetMembership(membershipID string) (*Membership, *resty.Response, error)

GetMembership Get details for a membership by ID.

Get details for a membership by ID.

Specify the membership ID in the membershipID URI parameter.

@param membershipID Membership ID.
@return Membership

func (*MembershipsService) ListMemberships

func (s *MembershipsService) ListMemberships(queryParams *ListMembershipsQueryParams) (*Memberships, *resty.Response, error)

ListMemberships Lists all membership memberships. By default, lists memberships for Memberships to which the authenticated user belongs.

Lists all membership memberships. By default, lists memberships for Memberships to which the authenticated user belongs.

Use query parameters to filter the response. Use roomID to list memberships for a membership, by ID. Use either personID or personEmail to filter the results. Long result sets will be split into pages.

@param "roomId" (string) Room ID.
@param "personId" (string) Person ID.
@param "personEmail" (string) Person email.
@param "max" (int) Limit the maximum number of items in the response.
@param "paginate" (bool) Indicates if pagination is needed
@return Memberships

func (*MembershipsService) UpdateMembership

func (s *MembershipsService) UpdateMembership(membershipID string, membershipUpdateRequest *MembershipUpdateRequest) (*Membership, *resty.Response, error)

UpdateMembership Updates properties for a membership by ID.

Updates properties for a membership by ID.

Specify the membership ID in the membershipID URI parameter.

@param membershipID Membership ID.
@param membershipUpdateRequest
@return Membership

type Message

type Message struct {
	ID              string       `json:"id,omitempty"`              // Message ID.
	RoomID          string       `json:"roomId,omitempty"`          // Room ID.
	RoomType        string       `json:"roomType,omitempty"`        // Room type (group or direct).
	ToPersonID      string       `json:"toPersonId,omitempty"`      // Person ID (for type=direct).
	ToPersonEmail   string       `json:"toPersonEmail,omitempty"`   // Person email (for type=direct).
	Text            string       `json:"text,omitempty"`            // Message in plain text format.
	Markdown        string       `json:"markdown,omitempty"`        // Message in markdown format.
	HTML            string       `json:"html,omitempty"`            // Message in HTML format.
	Files           []string     `json:"files,omitempty"`           // File URL array.
	PersonID        string       `json:"personId,omitempty"`        // Person ID.
	PersonEmail     string       `json:"personEmail,omitempty"`     // Person Email.
	Created         time.Time    `json:"created,omitempty"`         // Message creation date/time.
	MentionedPeople []string     `json:"mentionedPeople,omitempty"` // Person ID array.
	MentionedGroups []string     `json:"mentionedGroups,omitempty"` // Groups array.
	Attachments     []Attachment `json:"attachments,omitempty"`     // Attachment array
}

Message is the Message definition

type MessageCreateRequest

type MessageCreateRequest struct {
	RoomID        string       `json:"roomId,omitempty"`        // Room ID.
	ToPersonID    string       `json:"toPersonId,omitempty"`    // Person ID (for type=direct).
	ToPersonEmail string       `json:"toPersonEmail,omitempty"` // Person email (for type=direct).
	Text          string       `json:"text,omitempty"`          // Message in plain text format.
	Markdown      string       `json:"markdown,omitempty"`      // Message in markdown format.
	Files         []string     `json:"files,omitempty"`         // File URL array.
	Attachments   []Attachment `json:"attachments,omitempty"`   //Attachment Array
}

MessageCreateRequest is the Create Message Request Parameters

type Messages

type Messages struct {
	Items []Message `json:"items,omitempty"`
}

Messages is the List of Messages

func (*Messages) AddMessage

func (messages *Messages) AddMessage(item Message) []Message

AddMessage is used to append a message to a slice of messages

type MessagesService

type MessagesService service

MessagesService is the service to communicate with the Messages API endpoint

func (*MessagesService) CreateMessage

func (s *MessagesService) CreateMessage(messageCreateRequest *MessageCreateRequest) (*Message, *resty.Response, error)

CreateMessage Post a plain text or rich text message, and optionally, a media content attachment, to a room.

Post a plain text or rich text message, and optionally, a media content attachment, to a room.

The files parameter is an array, which accepts multiple values to allow for future expansion, but currently only one file may be included with the message.

@param messageCreateRequest
@return Message

func (*MessagesService) DeleteMessage

func (s *MessagesService) DeleteMessage(messageID string) (*resty.Response, error)

DeleteMessage Delete a Message.

Deletes a message by ID.

@param messageID Message ID. @return

func (*MessagesService) GetMessage

func (s *MessagesService) GetMessage(messageID string) (*Message, *resty.Response, error)

GetMessage Shows details for a message, by message ID.

Shows details for a message, by message ID.

Specify the message ID in the messageID parameter in the URI.

@param messageID Message ID.
@return Message

func (*MessagesService) ListMessages

func (s *MessagesService) ListMessages(queryParams *ListMessagesQueryParams) (*Messages, *resty.Response, error)

ListMessages Lists all messages in a room. Each message will include content attachments if present.

Lists all messages in a room. Each message will include content attachments if present.

The list sorts the messages in descending order by creation date. Long result sets will be split into pages.

@param roomID List messages for a room, by ID.
@param "mentionedPeople" (string) List messages where the caller is mentioned by specifying *me* or the caller personId.
@param "before" (time.Time) List messages sent before a date and time, in ISO8601 format. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
@param "beforeMessage" (string) List messages sent before a message, by ID.
@param "max" (int) Limit the maximum number of items in the response.
@param "paginate" (bool) Indicates if pagination is needed
@return Messages

type Organization

type Organization struct {
	ID          string    `json:"id,omitempty"`          // Organization ID.
	DisplayName string    `json:"displayName,omitempty"` // Organization Display Name.
	Created     time.Time `json:"created,omitempty"`     // Organization creation date/time.
}

Organization is the Organization definition

type Organizations

type Organizations struct {
	Items []Organization `json:"items,omitempty"`
}

Organizations is the List of Organizations

func (*Organizations) AddOrganization

func (organizations *Organizations) AddOrganization(item Organization) []Organization

AddOrganization is used to append a organization to a slice of organizations

type OrganizationsService

type OrganizationsService service

OrganizationsService is the service to communicate with the Organizations API endpoint

func (*OrganizationsService) GetOrganization

func (s *OrganizationsService) GetOrganization(orgID string) (*Organization, *resty.Response, error)

GetOrganization Shows details for an organization, by ID.

Shows details for an organization, by ID.

Specify the org ID in the orgID parameter in the URI.

@param orgID Organization ID.
@return Organization

func (*OrganizationsService) ListOrganizations

func (s *OrganizationsService) ListOrganizations(queryParams *ListOrganizationsQueryParams) (*Organizations, *resty.Response, error)

ListOrganizations List all organizations visible by your account. The results will not be paginated.

List all organizations visible by your account. The results will not be paginated.

@param "max" (int) Limit the maximum number of items in the response. @param paginate (bool) indicates if pagination is needed @return Organizations

type People

type People struct {
	Items []Person `json:"items,omitempty"`
}

People is the List of Persons

func (*People) AddPerson

func (people *People) AddPerson(item Person) []Person

AddPerson is used to append a person to a slice of People

type PeopleService

type PeopleService service

PeopleService is the service to communicate with the People API endpoint

func (*PeopleService) CreatePerson

func (s *PeopleService) CreatePerson(personRequest *PersonRequest) (*Person, *resty.Response, error)

CreatePerson Create a new user account for a given organization.

Create a new user account for a given organization. Only an admin can create a new user account.

Currently, users may have only one email address associated with their account. The emails parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.

@param personRequest
@return Person

func (*PeopleService) DeletePerson

func (s *PeopleService) DeletePerson(personID string) (*resty.Response, error)

DeletePerson Remove a person from the system. Only an admin can remove a person.

Remove a person from the system. Only an admin can remove a person.

Specify the person ID in the personID parameter in the URI.

@param personID Person ID.
@return

func (*PeopleService) GetMe

func (s *PeopleService) GetMe() (*Person, *resty.Response, error)

GetMe Show the profile for the authenticated user.

Show the profile for the authenticated user. This is the same as GET /people/:id using the Person ID associated with your Auth token.

@return Person

func (*PeopleService) GetPerson

func (s *PeopleService) GetPerson(personID string) (*Person, *resty.Response, error)

GetPerson Shows details for a person, by ID.

Shows details for a person, by ID. Certain fields, such as status or lastActivity, will only be displayed for people within your organization or an organzation you manage.

Specify the person ID in the personID parameter in the URI.

@param personID Person ID.
@return Person

func (*PeopleService) ListPeople

func (s *PeopleService) ListPeople(queryParams *ListPeopleQueryParams) (*People, *resty.Response, error)

ListPeople List people in your organization.

List people in your organization. For most users, either the email or displayName parameter is required.

Admin users can omit these fields and list all users in their organization.

@param "id" (string) List people by ID. Accepts up to 85 person IDs separated by commas.
@param "email" (string) List people with this email address. For non-admin requests, either this or displayName are required.
@param "displayName" (string) List people whose name starts with this string. For non-admin requests, either this or email are required.
@param "max" (int) Limit the maximum number of items in the response.
@param "orgId" (string) List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
@param paginate (bool) indicates if pagination is needed
@return People

func (*PeopleService) Update

func (s *PeopleService) Update(personID string, personRequest *PersonRequest) (*Person, *resty.Response, error)

Update Update details for a person, by ID.

Update details for a person, by ID.

Specify the person ID in the personID parameter in the URI. Only an admin can update a person details. Email addresses for a person cannot be changed via the Cisco Webex Teams API. Include all details for the person. This action expects all user details to be present in the request. A common approach is to first GET the person's details, make changes, then PUT both the changed and unchanged values.

@param personID Person ID.
@param personRequest
@return Person

type Person

type Person struct {
	ID            string              `json:"id,omitempty"`            // Person ID.
	Emails        []string            `json:"emails,omitempty"`        // Person email array.
	SIPAddresses  []PersonSIPAddress  `json:"sipAddresses,omitempty"`  // Person SIP Addresses
	PhoneNumbers  []PersonPhoneNumber `json:"phoneNumbers,omitempty"`  //Person phone numbers
	DisplayName   string              `json:"displayName,omitempty"`   // Person display name.
	NickName      string              `json:"nickName,omitempty"`      // Person nickname.
	FirstName     string              `json:"firstName,omitempty"`     // Person first name.
	LastName      string              `json:"lastName,omitempty"`      // Person last name.
	Avatar        string              `json:"avatar,omitempty"`        // Person avatar URL.
	OrgID         string              `json:"orgId,omitempty"`         // Person organization ID.
	Roles         []string            `json:"roles,omitempty"`         // Person roles.
	Licenses      []string            `json:"licenses,omitempty"`      // Person licenses.
	Created       time.Time           `json:"created,omitempty"`       // Person creation date/time.
	LastModified  time.Time           `json:"lastModified,omitempty"`  // Person last modified
	TimeZone      string              `json:"timeZone,omitempty"`      // Person time zone.
	LastActivity  time.Time           `json:"lastActivity,omitempty"`  // Person last active date/time.
	Status        string              `json:"status,omitempty"`        // Person presence status
	InvitePending bool                `json:"invitePending,omitempty"` // Person invite pending
	LoginEnabled  bool                `json:"loginEnabled,omitempty"`  // Person login Enabled
	PersonType    string              `json:"type,omitempty"`          // Person type (person or bot).
}

Person is the Person definition

type PersonPhoneNumber added in v0.4.1

type PersonPhoneNumber struct {
	NumberType string `json:"type,omitempty"`  // Phone number type
	Value      string `json:"value,omitempty"` // Phone number value
}

PersonPhoneNumber is the list of phone numbers of a person

type PersonRequest

type PersonRequest struct {
	Emails      []string `json:"emails,omitempty"`      // Email addresses of the person
	DisplayName string   `json:"displayName,omitempty"` // Full name of the person
	FirstName   string   `json:"firstName,omitempty"`   // First name of the person
	LastName    string   `json:"lastName,omitempty"`    // Last name of the person
	Avatar      string   `json:"avatar,omitempty"`      // URL to the person's avatar in PNG format
	OrgID       string   `json:"orgId,omitempty"`       // ID of the organization to which this person belongs
	Roles       []string `json:"roles,omitempty"`       // Roles of the person
	Licenses    []string `json:"licenses,omitempty"`    // Licenses allocated to the person
}

PersonRequest is the Create Person Request Parameters

type PersonSIPAddress added in v0.4.1

type PersonSIPAddress struct {
	AddressType string `json:"type,omitempty"`    // SIP Address type
	Value       string `json:"value,omitempty"`   // SIP Address value
	Primary     bool   `json:"primary,omitempty"` // SIP Address flag
}

PersonSIPAddress is the list of phone numbers of a person

type Place added in v0.4.1

type Place struct {
	ID           string    `json:"id,omitempty"`           // Place ID.
	Title        string    `json:"title,omitempty"`        // Place title.
	PlaceType    string    `json:"type,omitempty"`         // Place type (group or direct).
	IsLocked     bool      `json:"isLocked,omitempty"`     // Place is moderated.
	TeamID       string    `json:"teamId,omitempty"`       // Place Team ID.
	CreatorID    string    `json:"creatorId,omitempty"`    // Place creator Person ID.
	LastActivity time.Time `json:"lastActivity,omitempty"` // Place last activity date/time.
	Created      time.Time `json:"created,omitempty"`      // Place creation date/time.
}

Place is the Place definition

type PlaceCreateRequest added in v0.4.1

type PlaceCreateRequest struct {
	Title  string `json:"title,omitempty"`  // A user-friendly name for the place.
	TeamID string `json:"teamId,omitempty"` // The ID for the team with which this place is associated.
}

PlaceCreateRequest is the Place Create Request Parameters

type PlaceUpdateRequest added in v0.4.1

type PlaceUpdateRequest struct {
	Title string `json:"title,omitempty"` // Place title.
}

PlaceUpdateRequest is the Place Update Request Parameters

type Places added in v0.4.1

type Places struct {
	Items []Place `json:"items,omitempty"`
}

Places is the List of Places

func (*Places) AddPlace added in v0.4.1

func (places *Places) AddPlace(item Place) []Place

AddPlace is used to append a place to a slice of places

type PlacesService added in v0.4.1

type PlacesService service

PlacesService is the service to communicate with the Places API endpoint

func (*PlacesService) CreatePlace added in v0.4.1

func (s *PlacesService) CreatePlace(placeCreateRequest *PlaceCreateRequest) (*Place, *resty.Response, error)

CreatePlace Creates a place. The authenticated user is automatically added as a member of the place.

Creates a place. The authenticated user is automatically added as a member of the place. See the Memberships API to learn how to add more people to the place.

To create a 1-to-1 place, use the Create Messages endpoint to send a message directly to another person by using the toPersonID or toPersonEmail parameters.

@param placeCreateRequest
@return Place

func (*PlacesService) DeletePlace added in v0.4.1

func (s *PlacesService) DeletePlace(placeID string) (*resty.Response, error)

DeletePlace Deletes a place, by ID. Deleted places cannot be recovered.

Deletes a place, by ID. Deleted places cannot be recovered.

Deleting a place that is part of a team will archive the place instead. Specify the place ID in the placeID parameter in the URI

@param placeID Place ID.
@return

func (*PlacesService) GetPlace added in v0.4.1

func (s *PlacesService) GetPlace(placeID string) (*Place, *resty.Response, error)

GetPlace Shows details for a place, by ID.

Shows details for a place, by ID.

The title of the place for 1-to-1 places will be the display name of the other person. Specify the place ID in the placeID parameter in the URI.

@param placeID Place ID.
@return Place

func (*PlacesService) ListPlaces added in v0.4.1

func (s *PlacesService) ListPlaces(queryParams *ListPlacesQueryParams) (*Places, *resty.Response, error)

ListPlaces List places.

List places.

The title of the place for 1-to-1 places will be the display name of the other person. By default, lists places to which the authenticated user belongs. Long result sets will be split into pages.

@param "teamId" (string) Limit the places to those associated with a team, by ID.
@param "type_" (string) direct returns all 1-to-1 places. group returns all group places.
@param "sortBy" (string) Sort results by place ID (id), most recent activity (lastactivity), or most recently created (created).
@param "max" (int) Limit the maximum number of items in the response.
@param paginate (bool) indicates if pagination is needed
@return Places

func (*PlacesService) UpdatePlace added in v0.4.1

func (s *PlacesService) UpdatePlace(placeID string, placeUpdateRequest *PlaceUpdateRequest) (*Place, *resty.Response, error)

UpdatePlace Updates details for a place, by ID.

Updates details for a place, by ID.

Specify the place ID in the placeID parameter in the URI.

@param placeID Place ID.
@param placeUpdateRequest
@return Place

type Recording added in v0.4.1

type Recording struct {
	ID              string    `json:"id,omitempty"`              // A unique identifier for recording.
	Topic           string    `json:"topic,omitempty"`           //The recording's topic.
	CreateTime      time.Time `json:"createTime,omitempty"`      // The date and time recording was created in ISO 8601 compliant format.
	DownloadURL     string    `json:"downloadUrl,omitempty"`     // The download link for recording.
	PlaybackURL     string    `json:"playbackUrl,omitempty"`     // The playback link for recording.
	Password        string    `json:"password,omitempty"`        // The recording's password.
	Format          string    `json:"format,omitempty"`          // MP4 or ARF
	DurationSeconds int       `json:"durationSeconds,omitempty"` // The duration of the recording, in seconds.
	SizeBytes       int       `json:"sizeBytes,omitempty"`       // The size of the recording file, in bytes.
	ShareToMe       bool      `json:"shareToMe,omitempty"`       // Whether or not the recording has been shared to the current user.
}

Recording is the Recording definition

type RecordingDetails added in v0.4.1

type RecordingDetails struct {
	ID                           string                       `json:"id,omitempty"`                           // A unique identifier for recording.
	Topic                        string                       `json:"topic,omitempty"`                        //The recording's topic.
	CreateTime                   time.Time                    `json:"createTime,omitempty"`                   // The date and time recording was created in ISO 8601 compliant format.
	DownloadURL                  string                       `json:"downloadUrl,omitempty"`                  // The download link for recording.
	PlaybackURL                  string                       `json:"playbackUrl,omitempty"`                  // The playback link for recording.
	Password                     string                       `json:"password,omitempty"`                     // The recording's password.
	TemporaryDirectDownloadLinks TemporaryDirectDownloadLinks `json:"temporaryDirectDownloadLinks,omitempty"` // The download links for MP4, audio, and transcript of the recording without HTML page rendering in browser or HTTP redirect. This attribute is only available for Meeting Center.
	Format                       string                       `json:"format,omitempty"`                       // MP4 or ARF
	DurationSeconds              int                          `json:"durationSeconds,omitempty"`              // The duration of the recording, in seconds.
	SizeBytes                    int                          `json:"sizeBytes,omitempty"`                    // The size of the recording file, in bytes.
	ShareToMe                    bool                         `json:"shareToMe,omitempty"`                    // Whether or not the recording has been shared to the current user.
}

RecordingDetails is the Recording definition

type Recordings added in v0.4.1

type Recordings struct {
	Items []Recording `json:"items,omitempty"`
}

Recordings is the List of Recordings

func (*Recordings) AddRecording added in v0.4.1

func (recordings *Recordings) AddRecording(item Recording) []Recording

AddRecording is used to append a recording to a slice of Recordings

type RecordingsService added in v0.4.1

type RecordingsService service

RecordingsService is the service to communicate with the Recordings API endpoint

func (*RecordingsService) DeleteRecording added in v0.4.1

func (s *RecordingsService) DeleteRecording(recordingID string) (*resty.Response, error)

DeleteRecording Removes a recording with a specified recording ID. The deleted recording cannot be recovered.

Removes a recording with a specified recording ID. The deleted recording cannot be recovered.

Only recordings of meetings hosted by the authenticated user can be deleted.

@param recordingID A unique identifier for the recording.
@return

func (*RecordingsService) GetRecording added in v0.4.1

func (s *RecordingsService) GetRecording(recordingID string) (*RecordingDetails, *resty.Response, error)

GetRecording Shows details for a recording, by ID.

Shows details for a recording, by ID. Specify the recording ID in the recordingId parameter in the URI.

@param recordingID (string) unique identifier for the recording. @return Recording

func (*RecordingsService) ListRecordings added in v0.4.1

func (s *RecordingsService) ListRecordings(queryParams *ListRecordingsQueryParams) (*Recordings, *resty.Response, error)

ListRecordings List recordings.

Lists recordings. You can specify a date range and the maximum number of recordings to return.

Only recordings of meetings hosted by or shared with the authenticated user will be listed. The list returned is sorted in descending order by the date and time that the recordings were created. Long result sets are split into pages.

@param from (string) Starting date and time (inclusive) for recordings to return, in any ISO 8601 compliant format.
@param to (string) Ending date and time (exclusive) for List recordings to return, in any ISO 8601 compliant format.
@param max (int) limit the maximum number of items in the response.
@param paginate (bool) indicates if pagination is needed
@return Recordings

type Role

type Role struct {
	ID   string `json:"id,omitempty"`   // Role ID.
	Name string `json:"name,omitempty"` // Role Display Name.
}

Role is the Role definition

type Roles

type Roles struct {
	Items []Role `json:"items,omitempty"`
}

Roles is the List of Roles

func (*Roles) AddRole

func (roles *Roles) AddRole(item Role) []Role

AddRole is used to append a role to a slice of roles

type RolesListQueryParams

type RolesListQueryParams struct {
	Max      int  `url:"max,omitempty"` // Limit the maximum number of items in the response.
	Paginate bool // Indicates if pagination is needed
}

RolesListQueryParams are the query params for the GetRoles API Call

type RolesService

type RolesService service

RolesService is the service to communicate with the Roles API endpoint

func (*RolesService) GetRole

func (s *RolesService) GetRole(roleID string) (*Role, *resty.Response, error)

GetRole Shows details for a role, by ID.

Shows details for a role, by ID.

Specify the role ID in the roleID parameter in the URI.

@param roleID Role ID.
@return Role

func (*RolesService) ListRoles

func (s *RolesService) ListRoles(queryParams *RolesListQueryParams) (*Roles, *resty.Response, error)

ListRoles List all roles.

List all roles.

@param "max" (int) Limit the maximum number of items in the response. @param paginate (bool) indicates if pagination is needed @return Roles

type Room

type Room struct {
	ID           string    `json:"id,omitempty"`           // Room ID.
	Title        string    `json:"title,omitempty"`        // Room title.
	RoomType     string    `json:"type,omitempty"`         // Room type (group or direct).
	IsLocked     bool      `json:"isLocked,omitempty"`     // Room is moderated.
	TeamID       string    `json:"teamId,omitempty"`       // Room Team ID.
	CreatorID    string    `json:"creatorId,omitempty"`    // Room creator Person ID.
	LastActivity time.Time `json:"lastActivity,omitempty"` // Room last activity date/time.
	Created      time.Time `json:"created,omitempty"`      // Room creation date/time.
}

Room is the Room definition

type RoomCreateRequest

type RoomCreateRequest struct {
	Title  string `json:"title,omitempty"`  // A user-friendly name for the room.
	TeamID string `json:"teamId,omitempty"` // The ID for the team with which this room is associated.
}

RoomCreateRequest is the Room Create Request Parameters

type RoomUpdateRequest

type RoomUpdateRequest struct {
	Title string `json:"title,omitempty"` // Room title.
}

RoomUpdateRequest is the Room Update Request Parameters

type Rooms

type Rooms struct {
	Items []Room `json:"items,omitempty"`
}

Rooms is the List of Rooms

func (*Rooms) AddRoom

func (rooms *Rooms) AddRoom(item Room) []Room

AddRoom is used to append a room to a slice of rooms

type RoomsService

type RoomsService service

RoomsService is the service to communicate with the Rooms API endpoint

func (*RoomsService) CreateRoom

func (s *RoomsService) CreateRoom(roomCreateRequest *RoomCreateRequest) (*Room, *resty.Response, error)

CreateRoom Creates a room. The authenticated user is automatically added as a member of the room.

Creates a room. The authenticated user is automatically added as a member of the room. See the Memberships API to learn how to add more people to the room.

To create a 1-to-1 room, use the Create Messages endpoint to send a message directly to another person by using the toPersonID or toPersonEmail parameters.

@param roomCreateRequest
@return Room

func (*RoomsService) DeleteRoom

func (s *RoomsService) DeleteRoom(roomID string) (*resty.Response, error)

DeleteRoom Deletes a room, by ID. Deleted rooms cannot be recovered.

Deletes a room, by ID. Deleted rooms cannot be recovered.

Deleting a room that is part of a team will archive the room instead. Specify the room ID in the roomID parameter in the URI

@param roomID Room ID.
@return

func (*RoomsService) GetRoom

func (s *RoomsService) GetRoom(roomID string) (*Room, *resty.Response, error)

GetRoom Shows details for a room, by ID.

Shows details for a room, by ID.

The title of the room for 1-to-1 rooms will be the display name of the other person. Specify the room ID in the roomID parameter in the URI.

@param roomID Room ID.
@return Room

func (*RoomsService) ListRooms

func (s *RoomsService) ListRooms(queryParams *ListRoomsQueryParams) (*Rooms, *resty.Response, error)

ListRooms List rooms.

List rooms.

The title of the room for 1-to-1 rooms will be the display name of the other person. By default, lists rooms to which the authenticated user belongs. Long result sets will be split into pages.

@param "teamId" (string) Limit the rooms to those associated with a team, by ID.
@param "type_" (string) direct returns all 1-to-1 rooms. group returns all group rooms.
@param "sortBy" (string) Sort results by room ID (id), most recent activity (lastactivity), or most recently created (created).
@param "max" (int) Limit the maximum number of items in the response.
@param paginate (bool) indicates if pagination is needed
@return Rooms

func (*RoomsService) UpdateRoom

func (s *RoomsService) UpdateRoom(roomID string, roomUpdateRequest *RoomUpdateRequest) (*Room, *resty.Response, error)

UpdateRoom Updates details for a room, by ID.

Updates details for a room, by ID.

Specify the room ID in the roomID parameter in the URI.

@param roomID Room ID.
@param roomUpdateRequest
@return Room

type Team

type Team struct {
	ID        string    `json:"id,omitempty"`        // Team ID.
	Name      string    `json:"name,omitempty"`      // Team Name.
	CreatorID string    `json:"creatorId,omitempty"` // Team creator ID.
	Created   time.Time `json:"created,omitempty"`   // Team creation date/time.
}

Team is the Team definition

type TeamCreateRequest

type TeamCreateRequest struct {
	Name string `json:"name,omitempty"` // Team name.
}

TeamCreateRequest is the Team Create Request Parameters

type TeamMembership

type TeamMembership struct {
	ID                string    `json:"id,omitempty"`                // Team Membership ID.
	TeamID            string    `json:"teamId,omitempty"`            // Team ID.
	PersonID          string    `json:"personId,omitempty"`          // Person ID.
	PersonEmail       string    `json:"personEmail,omitempty"`       // Person email.
	PersonDisplayName string    `json:"personDisplayName,omitempty"` // Person display name.
	IsModerator       bool      `json:"isModerator,omitempty"`       // Team Membership is moderator.
	Created           time.Time `json:"created,omitempty"`           // Team Membership creation date/time.
}

TeamMembership is the Team Membership definition

type TeamMembershipCreateRequest

type TeamMembershipCreateRequest struct {
	TeamID      string `json:"teamId,omitempty"`      // Team ID.
	PersonID    string `json:"personId,omitempty"`    // Person ID.
	PersonEmail string `json:"personEmail,omitempty"` // Person Email.
	IsModerator bool   `json:"isModerator,omitempty"` // Team Membership is a moderator.
}

TeamMembershipCreateRequest is the Team Membership Create Request Parameters

type TeamMembershipUpdateRequest

type TeamMembershipUpdateRequest struct {
	IsModerator bool `json:"isModerator,omitempty"` // Team Membership is a moderator.
}

TeamMembershipUpdateRequest is the Team Membership Update Request object

type TeamMemberships

type TeamMemberships struct {
	Items []TeamMembership `json:"items,omitempty"`
}

TeamMemberships is the List of Team Memberships

func (*TeamMemberships) AddTeamMembership

func (teamMembership *TeamMemberships) AddTeamMembership(item TeamMembership) []TeamMembership

AddTeamMembership is used to append a teamMembership to a slice of teamMemberships

type TeamMembershipsService

type TeamMembershipsService service

TeamMembershipsService is the service to communicate with the TeamMemberships API endpoint

func (*TeamMembershipsService) CreateTeamMembership

func (s *TeamMembershipsService) CreateTeamMembership(teamMemberhipCreateRequest *TeamMembershipCreateRequest) (*TeamMembership, *resty.Response, error)

CreateTeamMembership Add someone to a team by Person ID or email address; optionally making them a moderator.

Add someone to a team by Person ID or email address; optionally making them a moderator.

@param teamMemberhipCreateRequest @return TeamMembership

func (*TeamMembershipsService) DeleteTeamMembership

func (s *TeamMembershipsService) DeleteTeamMembership(membershipID string) (*resty.Response, error)

DeleteTeamMembership Deletes a team membership, by ID.

Deletes a team membership, by ID.

Specify the team membership ID in the membershipID URI parameter.

@param membershipID Membership ID.
@return

func (*TeamMembershipsService) GetTeamMembership

func (s *TeamMembershipsService) GetTeamMembership(membershipID string) (*TeamMembership, *resty.Response, error)

GetTeamMembership Shows details for a team membership, by ID.

Shows details for a team membership, by ID.

Specify the team membership ID in the membershipID URI parameter.

@param membershipID Membership ID.
@return TeamMembership

func (*TeamMembershipsService) ListTeamMemberhips

func (s *TeamMembershipsService) ListTeamMemberhips(queryParams *ListTeamMemberhipsQueryParams) (*TeamMemberships, *resty.Response, error)

ListTeamMemberhips Lists all team memberships for a given team, specified by the teamID query parameter.

Lists all team memberships for a given team, specified by the teamID query parameter.

Use query parameters to filter the response.

@param teamID Team ID.
@param "max" (int) Limit the maximum number of items in the response.
@param paginate (bool) indicates if pagination is needed
@return TeamMemberships

func (*TeamMembershipsService) UpdateTeamMembership

func (s *TeamMembershipsService) UpdateTeamMembership(membershipID string, teamMembershipUpdateRequest *TeamMembershipUpdateRequest) (*TeamMembership, *resty.Response, error)

UpdateTeamMembership Updates a team membership, by ID.

Updates a team membership, by ID.

Specify the team membership ID in the membershipID URI parameter.

@param membershipID Membership ID.
@param teamMembershipUpdateRequest
@return TeamMembership

type TeamUpdateRequest

type TeamUpdateRequest struct {
	Name string `json:"name,omitempty"` // Team name.
}

TeamUpdateRequest is the Team Update Request Object

type Teams

type Teams struct {
	Items []Team `json:"items,omitempty"`
}

Teams is the List of Teams

func (*Teams) AddTeam

func (teams *Teams) AddTeam(item Team) []Team

AddTeam is used to append a team to a slice of teams

type TeamsService

type TeamsService service

TeamsService is the service to communicate with the Teams API endpoint

func (*TeamsService) CreateTeam

func (s *TeamsService) CreateTeam(teamCreateRequest *TeamCreateRequest) (*Team, *resty.Response, error)

CreateTeam Creates a team.

Creates a team. The authenticated user is automatically added as a member of the team.

See the Team Memberships API to learn how to add more people to the team.

@param teamCreateRequest
@return Team

func (*TeamsService) DeleteTeam

func (s *TeamsService) DeleteTeam(teamID string) (*resty.Response, error)

DeleteTeam Deletes a team, by ID.

Deletes a team, by ID.

Specify the team ID in the teamID parameter in the URI.

@param teamID Team ID.
@return

func (*TeamsService) GetTeam

func (s *TeamsService) GetTeam(teamID string) (*Team, *resty.Response, error)

GetTeam Shows details for a team, by ID.

Shows details for a team, by ID.

Specify the team ID in the teamID parameter in the URI.

@param teamID Team ID.
@return Team

func (*TeamsService) ListTeams

func (s *TeamsService) ListTeams(queryParams *ListTeamsQueryParams) (*Teams, *resty.Response, error)

ListTeams Lists teams to which the authenticated user belongs.

Lists teams to which the authenticated user belongs.

@param "max" (int) Limit the maximum number of items in the response. @param paginate (bool) indicates if pagination is needed @return Teams

func (*TeamsService) UpdateTeam

func (s *TeamsService) UpdateTeam(teamID string, teamUpdateRequest *TeamUpdateRequest) (*Team, *resty.Response, error)

UpdateTeam Updates details for a team, by ID.

Updates details for a team, by ID.

Specify the team ID in the teamID parameter in the URI.

@param teamID Team ID.
@param teamUpdateRequest
@return Team
type TemporaryDirectDownloadLinks struct {
	RecordingDownloadLink  string `json:"recordingDownloadLink,omitempty"`  // The download link for recording MP4 file without HTML page rendering in browser or HTTP redirect. It expires in 3 hours after the API request.
	AudioDownloadLink      string `json:"audioDownloadLink,omitempty"`      // The download link for recording audio file without HTML page rendering in browser or HTTP redirect. It expires in 3 hours after the API request.
	TranscriptDownloadLink string `json:"transcriptDownloadLink,omitempty"` // The download link for recording transcript file without HTML page rendering in browser or HTTP redirect. It expires in 3 hours after the API request.
	Expiration             string `json:"expiration,omitempty"`             // The date and time when recordingDownloadLink, audioDownloadLink, and transcriptDownloadLink expire in ISO 8601 compliant format.
}

TemporaryDirectDownloadLinks definition

type Webhook

type Webhook struct {
	ID        string    `json:"id,omitempty"`        // Webhook ID.
	Name      string    `json:"name,omitempty"`      // Webhook name.
	TargetURL string    `json:"targetUrl,omitempty"` // Webhook target URL.
	Resource  string    `json:"resource,omitempty"`  // Webhook resource.
	Event     string    `json:"event,omitempty"`     // Webhook event.
	OrgID     string    `json:"orgId,omitempty"`     // Webhook organization ID.
	CreatedBy string    `json:"createdBy,omitempty"` // Webhook created by Person ID.
	AppID     string    `json:"appId,omitempty"`     // Webhook application ID.
	OwnedBy   string    `json:"ownedBy,omitempty"`   // Webhook owner Person ID.
	Filter    string    `json:"filter,omitempty"`    // Webhook filter.
	Status    string    `json:"status,omitempty"`    // Webhook status.
	Secret    string    `json:"secret,omitempty"`    // Webhook secret.
	Created   time.Time `json:"created,omitempty"`   // Webhook creation date/time.
}

Webhook is the Webhook definition

type WebhookCreateRequest

type WebhookCreateRequest struct {
	Name      string `json:"name,omitempty"`      // Webhook name.
	TargetURL string `json:"targetUrl,omitempty"` // Webhook target URL.
	Resource  string `json:"resource,omitempty"`  // Webhook resource.
	Event     string `json:"event,omitempty"`     // Webhook event.
	Filter    string `json:"filter,omitempty"`    // Webhook filter.
	Secret    string `json:"secret,omitempty"`    // Webhook secret.
}

WebhookCreateRequest is the Webhook Create Request Parameters

type WebhookRequest added in v0.4.1

type WebhookRequest struct {
	ID        string             `json:"id,omitempty"`
	Name      string             `json:"name,omitempty"`
	Resource  string             `json:"resource,omitempty"`
	Event     string             `json:"event,omitempty"`
	Filter    string             `json:"filter,omitempty"`
	OrgID     string             `json:"orgId,omitempty"`
	CreatedBy string             `json:"createdBy,omitempty"`
	AppID     string             `json:"appId,omitempty"`
	OwnedBy   string             `json:"ownedBy,omitempty"`
	Status    string             `json:"status,omitempty"`
	ActorID   string             `json:"actorId,omitempty"`
	Data      WebhookRequestData `json:"data,omitempty"`
}

WebhookRequest is the Webhook trigger request

type WebhookRequestData added in v0.4.1

type WebhookRequestData struct {
	ID          string    `json:"id,omitempty"`
	RoomID      string    `json:"roomId,omitempty"`
	PersonID    string    `json:"personId,omitempty"`
	PersonEmail string    `json:"personEmail,omitempty"`
	Created     time.Time `json:"created,omitempty"`
}

WebhookRequestData is the Webhook trigger request

type WebhookUpdateRequest

type WebhookUpdateRequest struct {
	Name      string `json:"name,omitempty"`      // Webhook name.
	TargetURL string `json:"targetUrl,omitempty"` // Webhook target URL.
	Secret    string `json:"secret,omitempty"`    // Webhook secret.
	Status    string `json:"status,omitempty"`    // Webhook status.
}

WebhookUpdateRequest is the Update Webhook Request Parameters

type Webhooks

type Webhooks struct {
	Items []Webhook `json:"items,omitempty"`
}

Webhooks is the List of Webhooks

func (*Webhooks) AddWebhook

func (webhooks *Webhooks) AddWebhook(item Webhook) []Webhook

AddWebhook is used to append a webhook to a slice of webhooks

type WebhooksService

type WebhooksService service

WebhooksService is the service to communicate with the Webhooks API endpoint

func (*WebhooksService) CreateWebhook

func (s *WebhooksService) CreateWebhook(webhookCreateRequest *WebhookCreateRequest) (*Webhook, *resty.Response, error)

CreateWebhook Creates a webhook.

Creates a webhook.

@param webhookCreateRequest @return Webhook

func (*WebhooksService) DeleteWebhook

func (s *WebhooksService) DeleteWebhook(webhookID string) (*resty.Response, error)

DeleteWebhook Deletes a webhook, by ID.

Deletes a webhook, by ID.

Specify the webhook ID in the webhookID parameter in the URI.

@param webhookID Webhook ID.
@return

func (*WebhooksService) GetWebhook

func (s *WebhooksService) GetWebhook(webhookID string) (*Webhook, *resty.Response, error)

GetWebhook Shows details for a webhook, by ID.

Shows details for a webhook, by ID.

Specify the webhook ID in the webhookID parameter in the URI.

@param webhookID Webhook ID.
@return Webhook

func (*WebhooksService) ListWebhooks

func (s *WebhooksService) ListWebhooks(queryParams *ListWebhooksQueryParams) (*Webhooks, *resty.Response, error)

ListWebhooks Lists all of your webhooks.

Lists all of your webhooks.

@param "max" (int) Limit the maximum number of items in the response. @param paginate (bool) indicates if pagination is needed @return Webhooks

func (*WebhooksService) UpdateWebhook

func (s *WebhooksService) UpdateWebhook(webhookID string, webhookUpdateRequest *WebhookUpdateRequest) (*Webhook, *resty.Response, error)

UpdateWebhook Updates a webhook, by ID.

Updates a webhook, by ID.

Specify the webhook ID in the webhookID parameter in the URI.

@param webhookID Webhook ID.
@param webhookUpdateRequest
@return Webhook

Jump to

Keyboard shortcuts

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