realtime_kit

package
v6.7.0 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type ActiveSessionGetActiveSessionParams added in v6.6.0

type ActiveSessionGetActiveSessionParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ActiveSessionGetActiveSessionResponse added in v6.6.0

type ActiveSessionGetActiveSessionResponse struct {
	Data    ActiveSessionGetActiveSessionResponseData `json:"data"`
	Success bool                                      `json:"success"`
	JSON    activeSessionGetActiveSessionResponseJSON `json:"-"`
}

func (*ActiveSessionGetActiveSessionResponse) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionGetActiveSessionResponse) UnmarshalJSON(data []byte) (err error)

type ActiveSessionGetActiveSessionResponseData added in v6.6.0

type ActiveSessionGetActiveSessionResponseData struct {
	// ID of the session
	ID string `json:"id,required"`
	// ID of the meeting this session is associated with. In the case of V2 meetings,
	// it is always a UUID. In V1 meetings, it is a room name of the form
	// `abcdef-ghijkl`
	AssociatedID string `json:"associated_id,required"`
	// timestamp when session created
	CreatedAt string `json:"created_at,required"`
	// number of participants currently in the session
	LiveParticipants float64 `json:"live_participants,required"`
	// number of maximum participants that were in the session
	MaxConcurrentParticipants float64 `json:"max_concurrent_participants,required"`
	// Title of the meeting this session belongs to
	MeetingDisplayName string `json:"meeting_display_name,required"`
	// number of minutes consumed since the session started
	MinutesConsumed float64 `json:"minutes_consumed,required"`
	// App id that hosted this session
	OrganizationID string `json:"organization_id,required"`
	// timestamp when session started
	StartedAt string `json:"started_at,required"`
	// current status of session
	Status ActiveSessionGetActiveSessionResponseDataStatus `json:"status,required"`
	// type of session
	Type ActiveSessionGetActiveSessionResponseDataType `json:"type,required"`
	// timestamp when session was last updated
	UpdatedAt     string        `json:"updated_at,required"`
	BreakoutRooms []interface{} `json:"breakout_rooms"`
	// timestamp when session ended
	EndedAt string `json:"ended_at"`
	// Any meta data about session.
	Meta interface{}                                   `json:"meta"`
	JSON activeSessionGetActiveSessionResponseDataJSON `json:"-"`
}

func (*ActiveSessionGetActiveSessionResponseData) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionGetActiveSessionResponseData) UnmarshalJSON(data []byte) (err error)

type ActiveSessionGetActiveSessionResponseDataStatus added in v6.6.0

type ActiveSessionGetActiveSessionResponseDataStatus string

current status of session

const (
	ActiveSessionGetActiveSessionResponseDataStatusLive  ActiveSessionGetActiveSessionResponseDataStatus = "LIVE"
	ActiveSessionGetActiveSessionResponseDataStatusEnded ActiveSessionGetActiveSessionResponseDataStatus = "ENDED"
)

func (ActiveSessionGetActiveSessionResponseDataStatus) IsKnown added in v6.6.0

type ActiveSessionGetActiveSessionResponseDataType added in v6.6.0

type ActiveSessionGetActiveSessionResponseDataType string

type of session

const (
	ActiveSessionGetActiveSessionResponseDataTypeMeeting     ActiveSessionGetActiveSessionResponseDataType = "meeting"
	ActiveSessionGetActiveSessionResponseDataTypeLivestream  ActiveSessionGetActiveSessionResponseDataType = "livestream"
	ActiveSessionGetActiveSessionResponseDataTypeParticipant ActiveSessionGetActiveSessionResponseDataType = "participant"
)

func (ActiveSessionGetActiveSessionResponseDataType) IsKnown added in v6.6.0

type ActiveSessionKickAllParticipantsParams added in v6.6.0

type ActiveSessionKickAllParticipantsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ActiveSessionKickAllParticipantsResponse added in v6.6.0

type ActiveSessionKickAllParticipantsResponse struct {
	Data    ActiveSessionKickAllParticipantsResponseData `json:"data"`
	Success bool                                         `json:"success"`
	JSON    activeSessionKickAllParticipantsResponseJSON `json:"-"`
}

func (*ActiveSessionKickAllParticipantsResponse) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionKickAllParticipantsResponse) UnmarshalJSON(data []byte) (err error)

type ActiveSessionKickAllParticipantsResponseData added in v6.6.0

type ActiveSessionKickAllParticipantsResponseData struct {
	Action                  string                                           `json:"action"`
	KickedParticipantsCount float64                                          `json:"kicked_participants_count"`
	JSON                    activeSessionKickAllParticipantsResponseDataJSON `json:"-"`
}

func (*ActiveSessionKickAllParticipantsResponseData) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionKickAllParticipantsResponseData) UnmarshalJSON(data []byte) (err error)

type ActiveSessionKickParticipantsParams added in v6.6.0

type ActiveSessionKickParticipantsParams struct {
	// The account identifier tag.
	AccountID            param.Field[string]   `path:"account_id,required"`
	CustomParticipantIDs param.Field[[]string] `json:"custom_participant_ids,required"`
	ParticipantIDs       param.Field[[]string] `json:"participant_ids,required"`
}

func (ActiveSessionKickParticipantsParams) MarshalJSON added in v6.6.0

func (r ActiveSessionKickParticipantsParams) MarshalJSON() (data []byte, err error)

type ActiveSessionKickParticipantsResponse added in v6.6.0

type ActiveSessionKickParticipantsResponse struct {
	Data    ActiveSessionKickParticipantsResponseData `json:"data"`
	Success bool                                      `json:"success"`
	JSON    activeSessionKickParticipantsResponseJSON `json:"-"`
}

func (*ActiveSessionKickParticipantsResponse) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionKickParticipantsResponse) UnmarshalJSON(data []byte) (err error)

type ActiveSessionKickParticipantsResponseData added in v6.6.0

type ActiveSessionKickParticipantsResponseData struct {
	Action       string                                                 `json:"action"`
	Participants []ActiveSessionKickParticipantsResponseDataParticipant `json:"participants"`
	JSON         activeSessionKickParticipantsResponseDataJSON          `json:"-"`
}

func (*ActiveSessionKickParticipantsResponseData) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionKickParticipantsResponseData) UnmarshalJSON(data []byte) (err error)

type ActiveSessionKickParticipantsResponseDataParticipant added in v6.6.0

type ActiveSessionKickParticipantsResponseDataParticipant struct {
	// ID of the session participant
	ID        string `json:"id,required"`
	CreatedAt string `json:"created_at,required"`
	UpdatedAt string `json:"updated_at,required"`
	// Email of the session participant.
	Email string `json:"email"`
	// Name of the session participant.
	Name string `json:"name"`
	// A URL pointing to a picture of the participant.
	Picture string                                                   `json:"picture"`
	JSON    activeSessionKickParticipantsResponseDataParticipantJSON `json:"-"`
}

func (*ActiveSessionKickParticipantsResponseDataParticipant) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionKickParticipantsResponseDataParticipant) UnmarshalJSON(data []byte) (err error)

type ActiveSessionNewPollParams added in v6.6.0

type ActiveSessionNewPollParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Different options for the question
	Options param.Field[[]string] `json:"options,required"`
	// Question of the poll
	Question param.Field[string] `json:"question,required"`
	// if voters on a poll are anonymous
	Anonymous param.Field[bool] `json:"anonymous"`
	// if votes on an option are visible before a person votes
	HideVotes param.Field[bool] `json:"hide_votes"`
}

func (ActiveSessionNewPollParams) MarshalJSON added in v6.6.0

func (r ActiveSessionNewPollParams) MarshalJSON() (data []byte, err error)

type ActiveSessionNewPollResponse added in v6.6.0

type ActiveSessionNewPollResponse struct {
	Data    ActiveSessionNewPollResponseData `json:"data"`
	Success bool                             `json:"success"`
	JSON    activeSessionNewPollResponseJSON `json:"-"`
}

func (*ActiveSessionNewPollResponse) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionNewPollResponse) UnmarshalJSON(data []byte) (err error)

type ActiveSessionNewPollResponseData added in v6.6.0

type ActiveSessionNewPollResponseData struct {
	Action string                               `json:"action"`
	Poll   ActiveSessionNewPollResponseDataPoll `json:"poll"`
	JSON   activeSessionNewPollResponseDataJSON `json:"-"`
}

func (*ActiveSessionNewPollResponseData) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionNewPollResponseData) UnmarshalJSON(data []byte) (err error)

type ActiveSessionNewPollResponseDataPoll added in v6.6.0

type ActiveSessionNewPollResponseDataPoll struct {
	// ID of the poll
	ID string `json:"id,required"`
	// Answer options
	Options []ActiveSessionNewPollResponseDataPollOption `json:"options,required"`
	// Question asked by the poll
	Question  string                                   `json:"question,required"`
	Anonymous bool                                     `json:"anonymous"`
	CreatedBy string                                   `json:"created_by"`
	HideVotes bool                                     `json:"hide_votes"`
	Voted     []string                                 `json:"voted"`
	JSON      activeSessionNewPollResponseDataPollJSON `json:"-"`
}

func (*ActiveSessionNewPollResponseDataPoll) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionNewPollResponseDataPoll) UnmarshalJSON(data []byte) (err error)

type ActiveSessionNewPollResponseDataPollOption added in v6.6.0

type ActiveSessionNewPollResponseDataPollOption struct {
	Count float64 `json:"count,required"`
	// Text of the answer option
	Text  string                                            `json:"text,required"`
	Votes []ActiveSessionNewPollResponseDataPollOptionsVote `json:"votes,required"`
	JSON  activeSessionNewPollResponseDataPollOptionJSON    `json:"-"`
}

func (*ActiveSessionNewPollResponseDataPollOption) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionNewPollResponseDataPollOption) UnmarshalJSON(data []byte) (err error)

type ActiveSessionNewPollResponseDataPollOptionsVote added in v6.6.0

type ActiveSessionNewPollResponseDataPollOptionsVote struct {
	ID   string                                              `json:"id,required"`
	Name string                                              `json:"name,required"`
	JSON activeSessionNewPollResponseDataPollOptionsVoteJSON `json:"-"`
}

func (*ActiveSessionNewPollResponseDataPollOptionsVote) UnmarshalJSON added in v6.6.0

func (r *ActiveSessionNewPollResponseDataPollOptionsVote) UnmarshalJSON(data []byte) (err error)

type ActiveSessionService added in v6.6.0

type ActiveSessionService struct {
	Options []option.RequestOption
}

ActiveSessionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewActiveSessionService method instead.

func NewActiveSessionService added in v6.6.0

func NewActiveSessionService(opts ...option.RequestOption) (r *ActiveSessionService)

NewActiveSessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ActiveSessionService) GetActiveSession added in v6.6.0

Returns details of an ongoing active session for the given meeting ID.

func (*ActiveSessionService) KickAllParticipants added in v6.6.0

Kicks all participants from an active session for the given meeting ID.

func (*ActiveSessionService) KickParticipants added in v6.6.0

Kicks one or more participants from an active session using user ID or custom participant ID.

func (*ActiveSessionService) NewPoll added in v6.6.0

Creates a new poll in an active session for the given meeting ID.

type AnalyticsGetOrgAnalyticsParams added in v6.6.0

type AnalyticsGetOrgAnalyticsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// end date in YYYY-MM-DD format
	EndDate param.Field[string] `query:"end_date"`
	// start date in YYYY-MM-DD format
	StartDate param.Field[string] `query:"start_date"`
}

func (AnalyticsGetOrgAnalyticsParams) URLQuery added in v6.6.0

func (r AnalyticsGetOrgAnalyticsParams) URLQuery() (v url.Values)

URLQuery serializes AnalyticsGetOrgAnalyticsParams's query parameters as `url.Values`.

type AnalyticsGetOrgAnalyticsResponse added in v6.6.0

type AnalyticsGetOrgAnalyticsResponse struct {
	Data    AnalyticsGetOrgAnalyticsResponseData `json:"data"`
	Success bool                                 `json:"success"`
	JSON    analyticsGetOrgAnalyticsResponseJSON `json:"-"`
}

func (*AnalyticsGetOrgAnalyticsResponse) UnmarshalJSON added in v6.6.0

func (r *AnalyticsGetOrgAnalyticsResponse) UnmarshalJSON(data []byte) (err error)

type AnalyticsGetOrgAnalyticsResponseData added in v6.6.0

type AnalyticsGetOrgAnalyticsResponseData struct {
	// Recording statistics of an App during the range specified
	RecordingStats AnalyticsGetOrgAnalyticsResponseDataRecordingStats `json:"recording_stats"`
	// Session statistics of an App during the range specified
	SessionStats AnalyticsGetOrgAnalyticsResponseDataSessionStats `json:"session_stats"`
	JSON         analyticsGetOrgAnalyticsResponseDataJSON         `json:"-"`
}

func (*AnalyticsGetOrgAnalyticsResponseData) UnmarshalJSON added in v6.6.0

func (r *AnalyticsGetOrgAnalyticsResponseData) UnmarshalJSON(data []byte) (err error)

type AnalyticsGetOrgAnalyticsResponseDataRecordingStats added in v6.6.0

type AnalyticsGetOrgAnalyticsResponseDataRecordingStats struct {
	// Day wise recording stats
	DayStats []AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat `json:"day_stats"`
	// Total number of recordings during the range specified
	RecordingCount int64 `json:"recording_count"`
	// Total recording minutes during the range specified
	RecordingMinutesConsumed float64                                                `json:"recording_minutes_consumed"`
	JSON                     analyticsGetOrgAnalyticsResponseDataRecordingStatsJSON `json:"-"`
}

Recording statistics of an App during the range specified

func (*AnalyticsGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON added in v6.6.0

func (r *AnalyticsGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON(data []byte) (err error)

type AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat added in v6.6.0

type AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat struct {
	Day string `json:"day"`
	// Total recording minutes for a specific day
	TotalRecordingMinutes int64 `json:"total_recording_minutes"`
	// Total number of recordings for a specific day
	TotalRecordings int64                                                         `json:"total_recordings"`
	JSON            analyticsGetOrgAnalyticsResponseDataRecordingStatsDayStatJSON `json:"-"`
}

func (*AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat) UnmarshalJSON added in v6.6.0

type AnalyticsGetOrgAnalyticsResponseDataSessionStats added in v6.6.0

type AnalyticsGetOrgAnalyticsResponseDataSessionStats struct {
	// Day wise session stats
	DayStats []AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat `json:"day_stats"`
	// Total number of sessions during the range specified
	SessionsCount int64 `json:"sessions_count"`
	// Total session minutes during the range specified
	SessionsMinutesConsumed float64                                              `json:"sessions_minutes_consumed"`
	JSON                    analyticsGetOrgAnalyticsResponseDataSessionStatsJSON `json:"-"`
}

Session statistics of an App during the range specified

func (*AnalyticsGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON added in v6.6.0

func (r *AnalyticsGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON(data []byte) (err error)

type AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat added in v6.6.0

type AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat struct {
	Day string `json:"day"`
	// Total session minutes for a specific day
	TotalSessionMinutes float64 `json:"total_session_minutes"`
	// Total number of sessions for a specific day
	TotalSessions int64                                                       `json:"total_sessions"`
	JSON          analyticsGetOrgAnalyticsResponseDataSessionStatsDayStatJSON `json:"-"`
}

func (*AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat) UnmarshalJSON added in v6.6.0

type AnalyticsService added in v6.6.0

type AnalyticsService struct {
	Options []option.RequestOption
}

AnalyticsService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnalyticsService method instead.

func NewAnalyticsService added in v6.6.0

func NewAnalyticsService(opts ...option.RequestOption) (r *AnalyticsService)

NewAnalyticsService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AnalyticsService) GetOrgAnalytics added in v6.6.0

Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.

type AppGetParams added in v6.6.0

type AppGetParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type AppGetResponse added in v6.6.0

type AppGetResponse struct {
	Data    []AppGetResponseData `json:"data"`
	Success bool                 `json:"success"`
	JSON    appGetResponseJSON   `json:"-"`
}

func (*AppGetResponse) UnmarshalJSON added in v6.6.0

func (r *AppGetResponse) UnmarshalJSON(data []byte) (err error)

type AppGetResponseData added in v6.6.0

type AppGetResponseData struct {
	ID        string                 `json:"id"`
	CreatedAt string                 `json:"created_at"`
	Name      string                 `json:"name"`
	JSON      appGetResponseDataJSON `json:"-"`
}

func (*AppGetResponseData) UnmarshalJSON added in v6.6.0

func (r *AppGetResponseData) UnmarshalJSON(data []byte) (err error)

type AppPostParams added in v6.6.0

type AppPostParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	Name      param.Field[string] `json:"name,required"`
}

func (AppPostParams) MarshalJSON added in v6.6.0

func (r AppPostParams) MarshalJSON() (data []byte, err error)

type AppPostResponse added in v6.6.0

type AppPostResponse struct {
	Data    AppPostResponseData `json:"data"`
	Success bool                `json:"success"`
	JSON    appPostResponseJSON `json:"-"`
}

func (*AppPostResponse) UnmarshalJSON added in v6.6.0

func (r *AppPostResponse) UnmarshalJSON(data []byte) (err error)

type AppPostResponseData added in v6.6.0

type AppPostResponseData struct {
	App  AppPostResponseDataApp  `json:"app"`
	JSON appPostResponseDataJSON `json:"-"`
}

func (*AppPostResponseData) UnmarshalJSON added in v6.6.0

func (r *AppPostResponseData) UnmarshalJSON(data []byte) (err error)

type AppPostResponseDataApp added in v6.6.0

type AppPostResponseDataApp struct {
	ID        string                     `json:"id"`
	CreatedAt string                     `json:"created_at"`
	Name      string                     `json:"name"`
	JSON      appPostResponseDataAppJSON `json:"-"`
}

func (*AppPostResponseDataApp) UnmarshalJSON added in v6.6.0

func (r *AppPostResponseDataApp) UnmarshalJSON(data []byte) (err error)

type AppService added in v6.6.0

type AppService struct {
	Options []option.RequestOption
}

AppService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAppService method instead.

func NewAppService added in v6.6.0

func NewAppService(opts ...option.RequestOption) (r *AppService)

NewAppService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AppService) Get added in v6.6.0

func (r *AppService) Get(ctx context.Context, query AppGetParams, opts ...option.RequestOption) (res *AppGetResponse, err error)

Fetch all apps for your account

func (*AppService) Post added in v6.6.0

func (r *AppService) Post(ctx context.Context, params AppPostParams, opts ...option.RequestOption) (res *AppPostResponse, err error)

Create new app for your account

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type LivestreamGetActiveLivestreamsForLivestreamIDParams added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type LivestreamGetActiveLivestreamsForLivestreamIDResponse added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponse struct {
	Data    LivestreamGetActiveLivestreamsForLivestreamIDResponseData `json:"data"`
	Success bool                                                      `json:"success"`
	JSON    livestreamGetActiveLivestreamsForLivestreamIDResponseJSON `json:"-"`
}

func (*LivestreamGetActiveLivestreamsForLivestreamIDResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetActiveLivestreamsForLivestreamIDResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamGetActiveLivestreamsForLivestreamIDResponseData added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseData struct {
	Livestream LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream `json:"livestream"`
	Session    LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession    `json:"session"`
	JSON       livestreamGetActiveLivestreamsForLivestreamIDResponseDataJSON       `json:"-"`
}

func (*LivestreamGetActiveLivestreamsForLivestreamIDResponseData) UnmarshalJSON added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream struct {
	ID string `json:"id"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Specifies if the livestream was disabled.
	Disabled string `json:"disabled"`
	// The server URL to which the RTMP encoder sends the video and audio data.
	IngestServer string `json:"ingest_server"`
	// ID of the meeting.
	MeetingID string `json:"meeting_id"`
	// Name of the livestream.
	Name string `json:"name"`
	// The web address that viewers can use to watch the livestream.
	PlaybackURL string                                                                    `json:"playback_url"`
	Status      LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus `json:"status"`
	// Unique key for accessing each livestream.
	StreamKey string `json:"stream_key"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time                                                               `json:"updated_at" format:"date-time"`
	JSON      livestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamJSON `json:"-"`
}

func (*LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream) UnmarshalJSON added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus string
const (
	LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusLive    LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "LIVE"
	LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusIdle    LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "IDLE"
	LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusErrored LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "ERRORED"
	LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusInvoked LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "INVOKED"
)

func (LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus) IsKnown added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession added in v6.6.0

type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession struct {
	ID string `json:"id"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt  time.Time `json:"created_at" format:"date-time"`
	ErrMessage string    `json:"err_message"`
	// The time duration for which the input was given or the meeting was streamed.
	IngestSeconds string `json:"ingest_seconds"`
	// Timestamp the object was invoked. The time is returned in ISO format.
	InvokedTime  time.Time `json:"invoked_time" format:"date-time"`
	LivestreamID string    `json:"livestream_id"`
	// Timestamp the object was started. The time is returned in ISO format.
	StartedTime time.Time `json:"started_time" format:"date-time"`
	// Timestamp the object was stopped. The time is returned in ISO format.
	StoppedTime time.Time `json:"stopped_time" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at" format:"date-time"`
	// The total view time for which the viewers watched the stream.
	ViewerSeconds string                                                               `json:"viewer_seconds"`
	JSON          livestreamGetActiveLivestreamsForLivestreamIDResponseDataSessionJSON `json:"-"`
}

func (*LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession) UnmarshalJSON added in v6.6.0

type LivestreamGetAllLivestreamsParams added in v6.6.0

type LivestreamGetAllLivestreamsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specify the end time range in ISO format to access the live stream.
	EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
	// Exclude the RealtimeKit meetings that are livestreamed.
	ExcludeMeetings param.Field[bool] `query:"exclude_meetings"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[int64] `query:"page_no"`
	// Number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Specifies the sorting order for the results.
	SortOrder param.Field[LivestreamGetAllLivestreamsParamsSortOrder] `query:"sort_order"`
	// Specify the start time range in ISO format to access the live stream.
	StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
	// Specifies the status of the operation.
	Status param.Field[LivestreamGetAllLivestreamsParamsStatus] `query:"status"`
}

func (LivestreamGetAllLivestreamsParams) URLQuery added in v6.6.0

func (r LivestreamGetAllLivestreamsParams) URLQuery() (v url.Values)

URLQuery serializes LivestreamGetAllLivestreamsParams's query parameters as `url.Values`.

type LivestreamGetAllLivestreamsParamsSortOrder added in v6.6.0

type LivestreamGetAllLivestreamsParamsSortOrder string

Specifies the sorting order for the results.

const (
	LivestreamGetAllLivestreamsParamsSortOrderAsc LivestreamGetAllLivestreamsParamsSortOrder = "ASC"
	LivestreamGetAllLivestreamsParamsSortOrderDsc LivestreamGetAllLivestreamsParamsSortOrder = "DSC"
)

func (LivestreamGetAllLivestreamsParamsSortOrder) IsKnown added in v6.6.0

type LivestreamGetAllLivestreamsParamsStatus added in v6.6.0

type LivestreamGetAllLivestreamsParamsStatus string

Specifies the status of the operation.

const (
	LivestreamGetAllLivestreamsParamsStatusLive    LivestreamGetAllLivestreamsParamsStatus = "LIVE"
	LivestreamGetAllLivestreamsParamsStatusIdle    LivestreamGetAllLivestreamsParamsStatus = "IDLE"
	LivestreamGetAllLivestreamsParamsStatusErrored LivestreamGetAllLivestreamsParamsStatus = "ERRORED"
	LivestreamGetAllLivestreamsParamsStatusInvoked LivestreamGetAllLivestreamsParamsStatus = "INVOKED"
)

func (LivestreamGetAllLivestreamsParamsStatus) IsKnown added in v6.6.0

type LivestreamGetAllLivestreamsResponse added in v6.6.0

type LivestreamGetAllLivestreamsResponse struct {
	Data    LivestreamGetAllLivestreamsResponseData `json:"data"`
	Success bool                                    `json:"success"`
	JSON    livestreamGetAllLivestreamsResponseJSON `json:"-"`
}

func (*LivestreamGetAllLivestreamsResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetAllLivestreamsResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamGetAllLivestreamsResponseData added in v6.6.0

type LivestreamGetAllLivestreamsResponseData struct {
	// The ID of the livestream.
	ID string `json:"id" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Specifies if the livestream was disabled.
	Disabled string `json:"disabled"`
	// The server URL to which the RTMP encoder sends the video and audio data.
	IngestServer string `json:"ingest_server"`
	// ID of the meeting.
	MeetingID string `json:"meeting_id"`
	// Name of the livestream.
	Name   string                                        `json:"name"`
	Paging LivestreamGetAllLivestreamsResponseDataPaging `json:"paging"`
	// The web address that viewers can use to watch the livestream.
	PlaybackURL string                                        `json:"playback_url"`
	Status      LivestreamGetAllLivestreamsResponseDataStatus `json:"status"`
	// Unique key for accessing each livestream.
	StreamKey string `json:"stream_key"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time                                   `json:"updated_at" format:"date-time"`
	JSON      livestreamGetAllLivestreamsResponseDataJSON `json:"-"`
}

func (*LivestreamGetAllLivestreamsResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetAllLivestreamsResponseData) UnmarshalJSON(data []byte) (err error)

type LivestreamGetAllLivestreamsResponseDataPaging added in v6.6.0

type LivestreamGetAllLivestreamsResponseDataPaging struct {
	EndOffset   int64                                             `json:"end_offset"`
	StartOffset int64                                             `json:"start_offset"`
	TotalCount  int64                                             `json:"total_count"`
	JSON        livestreamGetAllLivestreamsResponseDataPagingJSON `json:"-"`
}

func (*LivestreamGetAllLivestreamsResponseDataPaging) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetAllLivestreamsResponseDataPaging) UnmarshalJSON(data []byte) (err error)

type LivestreamGetAllLivestreamsResponseDataStatus added in v6.6.0

type LivestreamGetAllLivestreamsResponseDataStatus string
const (
	LivestreamGetAllLivestreamsResponseDataStatusLive    LivestreamGetAllLivestreamsResponseDataStatus = "LIVE"
	LivestreamGetAllLivestreamsResponseDataStatusIdle    LivestreamGetAllLivestreamsResponseDataStatus = "IDLE"
	LivestreamGetAllLivestreamsResponseDataStatusErrored LivestreamGetAllLivestreamsResponseDataStatus = "ERRORED"
	LivestreamGetAllLivestreamsResponseDataStatusInvoked LivestreamGetAllLivestreamsResponseDataStatus = "INVOKED"
)

func (LivestreamGetAllLivestreamsResponseDataStatus) IsKnown added in v6.6.0

type LivestreamGetLivestreamAnalyticsCompleteParams added in v6.6.0

type LivestreamGetLivestreamAnalyticsCompleteParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specify the end time range in ISO format to access the livestream analytics.
	EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
	// Specify the start time range in ISO format to access the livestream analytics.
	StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
}

func (LivestreamGetLivestreamAnalyticsCompleteParams) URLQuery added in v6.6.0

URLQuery serializes LivestreamGetLivestreamAnalyticsCompleteParams's query parameters as `url.Values`.

type LivestreamGetLivestreamAnalyticsCompleteResponse added in v6.6.0

type LivestreamGetLivestreamAnalyticsCompleteResponse struct {
	Data    LivestreamGetLivestreamAnalyticsCompleteResponseData `json:"data"`
	Success bool                                                 `json:"success"`
	JSON    livestreamGetLivestreamAnalyticsCompleteResponseJSON `json:"-"`
}

func (*LivestreamGetLivestreamAnalyticsCompleteResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetLivestreamAnalyticsCompleteResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamGetLivestreamAnalyticsCompleteResponseData added in v6.6.0

type LivestreamGetLivestreamAnalyticsCompleteResponseData struct {
	// Count of total livestreams.
	Count int64 `json:"count"`
	// Total time duration for which the input was given or the meeting was streamed.
	TotalIngestSeconds int64 `json:"total_ingest_seconds"`
	// Total view time for which the viewers watched the stream.
	TotalViewerSeconds int64                                                    `json:"total_viewer_seconds"`
	JSON               livestreamGetLivestreamAnalyticsCompleteResponseDataJSON `json:"-"`
}

func (*LivestreamGetLivestreamAnalyticsCompleteResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetLivestreamAnalyticsCompleteResponseData) UnmarshalJSON(data []byte) (err error)

type LivestreamGetLivestreamSessionDetailsForSessionIDParams added in v6.6.0

type LivestreamGetLivestreamSessionDetailsForSessionIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type LivestreamGetLivestreamSessionDetailsForSessionIDResponse added in v6.6.0

type LivestreamGetLivestreamSessionDetailsForSessionIDResponse struct {
	Data    LivestreamGetLivestreamSessionDetailsForSessionIDResponseData `json:"data"`
	Success bool                                                          `json:"success"`
	JSON    livestreamGetLivestreamSessionDetailsForSessionIDResponseJSON `json:"-"`
}

func (*LivestreamGetLivestreamSessionDetailsForSessionIDResponse) UnmarshalJSON added in v6.6.0

type LivestreamGetLivestreamSessionDetailsForSessionIDResponseData added in v6.6.0

type LivestreamGetLivestreamSessionDetailsForSessionIDResponseData struct {
	// The livestream ID.
	ID string `json:"id"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The server URL to which the RTMP encoder sends the video and audio data.
	ErrMessage string `json:"err_message"`
	// Name of the livestream.
	IngestSeconds int64  `json:"ingest_seconds"`
	LivestreamID  string `json:"livestream_id"`
	// Unique key for accessing each livestream.
	StartedTime string `json:"started_time"`
	// The web address that viewers can use to watch the livestream.
	StoppedTime string `json:"stopped_time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt string `json:"updated_at"`
	// Specifies if the livestream was disabled.
	ViewerSeconds int64                                                             `json:"viewer_seconds"`
	JSON          livestreamGetLivestreamSessionDetailsForSessionIDResponseDataJSON `json:"-"`
}

func (*LivestreamGetLivestreamSessionDetailsForSessionIDResponseData) UnmarshalJSON added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDParams added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[int64] `query:"page_no"`
	// Number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
}

func (LivestreamGetLivestreamSessionForLivestreamIDParams) URLQuery added in v6.6.0

URLQuery serializes LivestreamGetLivestreamSessionForLivestreamIDParams's query parameters as `url.Values`.

type LivestreamGetLivestreamSessionForLivestreamIDResponse added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponse struct {
	Data    LivestreamGetLivestreamSessionForLivestreamIDResponseData `json:"data"`
	Success bool                                                      `json:"success"`
	JSON    livestreamGetLivestreamSessionForLivestreamIDResponseJSON `json:"-"`
}

func (*LivestreamGetLivestreamSessionForLivestreamIDResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetLivestreamSessionForLivestreamIDResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamGetLivestreamSessionForLivestreamIDResponseData added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseData struct {
	Livestream LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream `json:"livestream"`
	Paging     LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging     `json:"paging"`
	Session    LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession    `json:"session"`
	JSON       livestreamGetLivestreamSessionForLivestreamIDResponseDataJSON       `json:"-"`
}

func (*LivestreamGetLivestreamSessionForLivestreamIDResponseData) UnmarshalJSON added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream struct {
	// ID of the livestream.
	ID string `json:"id"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt string `json:"created_at"`
	// Specifies if the livestream was disabled.
	Disabled string `json:"disabled"`
	// The server URL to which the RTMP encoder sends the video and audio data.
	IngestServer string `json:"ingest_server"`
	// The ID of the meeting.
	MeetingID string `json:"meeting_id"`
	// Name of the livestream.
	Name string `json:"name"`
	// The web address that viewers can use to watch the livestream.
	PlaybackURL string                                                                    `json:"playback_url"`
	Status      LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus `json:"status"`
	// Unique key for accessing each livestream.
	StreamKey string `json:"stream_key"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt string                                                                  `json:"updated_at"`
	JSON      livestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamJSON `json:"-"`
}

func (*LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream) UnmarshalJSON added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus string
const (
	LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusLive    LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "LIVE"
	LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusIdle    LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "IDLE"
	LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusErrored LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "ERRORED"
	LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusInvoked LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "INVOKED"
)

func (LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus) IsKnown added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging struct {
	EndOffset   int64                                                               `json:"end_offset"`
	StartOffset int64                                                               `json:"start_offset"`
	TotalCount  int64                                                               `json:"total_count"`
	JSON        livestreamGetLivestreamSessionForLivestreamIDResponseDataPagingJSON `json:"-"`
}

func (*LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging) UnmarshalJSON added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession added in v6.6.0

type LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession struct {
	// ID of the session.
	ID string `json:"id"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt  time.Time `json:"created_at" format:"date-time"`
	ErrMessage string    `json:"err_message"`
	// The time duration for which the input was given or the meeting was streamed.
	IngestSeconds float64 `json:"ingest_seconds"`
	// Timestamp the object was invoked. The time is returned in ISO format.
	InvokedTime  time.Time `json:"invoked_time" format:"date-time"`
	LivestreamID string    `json:"livestream_id"`
	// Timestamp the object was started. The time is returned in ISO format.
	StartedTime time.Time `json:"started_time" format:"date-time"`
	// Timestamp the object was stopped. The time is returned in ISO format.
	StoppedTime time.Time `json:"stopped_time" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at" format:"date-time"`
	// The total view time for which the viewers watched the stream.
	ViewerSeconds float64                                                              `json:"viewer_seconds"`
	JSON          livestreamGetLivestreamSessionForLivestreamIDResponseDataSessionJSON `json:"-"`
}

func (*LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession) UnmarshalJSON added in v6.6.0

type LivestreamGetMeetingActiveLivestreamsParams added in v6.6.0

type LivestreamGetMeetingActiveLivestreamsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type LivestreamGetMeetingActiveLivestreamsResponse added in v6.6.0

type LivestreamGetMeetingActiveLivestreamsResponse struct {
	Data    LivestreamGetMeetingActiveLivestreamsResponseData `json:"data"`
	Success bool                                              `json:"success"`
	JSON    livestreamGetMeetingActiveLivestreamsResponseJSON `json:"-"`
}

func (*LivestreamGetMeetingActiveLivestreamsResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetMeetingActiveLivestreamsResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamGetMeetingActiveLivestreamsResponseData added in v6.6.0

type LivestreamGetMeetingActiveLivestreamsResponseData struct {
	// The livestream ID.
	ID string `json:"id"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Specifies if the livestream was disabled.
	Disabled string `json:"disabled"`
	// The server URL to which the RTMP encoder sends the video and audio data.
	IngestServer string `json:"ingest_server"`
	MeetingID    string `json:"meeting_id"`
	// Name of the livestream.
	Name string `json:"name,nullable"`
	// The web address that viewers can use to watch the livestream.
	PlaybackURL string                                                  `json:"playback_url"`
	Status      LivestreamGetMeetingActiveLivestreamsResponseDataStatus `json:"status"`
	// Unique key for accessing each livestream.
	StreamKey string `json:"stream_key"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time                                             `json:"updated_at" format:"date-time"`
	JSON      livestreamGetMeetingActiveLivestreamsResponseDataJSON `json:"-"`
}

func (*LivestreamGetMeetingActiveLivestreamsResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetMeetingActiveLivestreamsResponseData) UnmarshalJSON(data []byte) (err error)

type LivestreamGetMeetingActiveLivestreamsResponseDataStatus added in v6.6.0

type LivestreamGetMeetingActiveLivestreamsResponseDataStatus string
const (
	LivestreamGetMeetingActiveLivestreamsResponseDataStatusLive    LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "LIVE"
	LivestreamGetMeetingActiveLivestreamsResponseDataStatusIdle    LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "IDLE"
	LivestreamGetMeetingActiveLivestreamsResponseDataStatusErrored LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "ERRORED"
	LivestreamGetMeetingActiveLivestreamsResponseDataStatusInvoked LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "INVOKED"
)

func (LivestreamGetMeetingActiveLivestreamsResponseDataStatus) IsKnown added in v6.6.0

type LivestreamGetOrgAnalyticsParams added in v6.6.0

type LivestreamGetOrgAnalyticsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// end date in YYYY-MM-DD format
	EndDate param.Field[string] `query:"end_date"`
	// start date in YYYY-MM-DD format
	StartDate param.Field[string] `query:"start_date"`
}

func (LivestreamGetOrgAnalyticsParams) URLQuery added in v6.6.0

func (r LivestreamGetOrgAnalyticsParams) URLQuery() (v url.Values)

URLQuery serializes LivestreamGetOrgAnalyticsParams's query parameters as `url.Values`.

type LivestreamGetOrgAnalyticsResponse added in v6.6.0

type LivestreamGetOrgAnalyticsResponse struct {
	Data    LivestreamGetOrgAnalyticsResponseData `json:"data"`
	Success bool                                  `json:"success"`
	JSON    livestreamGetOrgAnalyticsResponseJSON `json:"-"`
}

func (*LivestreamGetOrgAnalyticsResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetOrgAnalyticsResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamGetOrgAnalyticsResponseData added in v6.6.0

type LivestreamGetOrgAnalyticsResponseData struct {
	// Recording statistics of an App during the range specified
	RecordingStats LivestreamGetOrgAnalyticsResponseDataRecordingStats `json:"recording_stats"`
	// Session statistics of an App during the range specified
	SessionStats LivestreamGetOrgAnalyticsResponseDataSessionStats `json:"session_stats"`
	JSON         livestreamGetOrgAnalyticsResponseDataJSON         `json:"-"`
}

func (*LivestreamGetOrgAnalyticsResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetOrgAnalyticsResponseData) UnmarshalJSON(data []byte) (err error)

type LivestreamGetOrgAnalyticsResponseDataRecordingStats added in v6.6.0

type LivestreamGetOrgAnalyticsResponseDataRecordingStats struct {
	// Day wise recording stats
	DayStats []LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat `json:"day_stats"`
	// Total number of recordings during the range specified
	RecordingCount int64 `json:"recording_count"`
	// Total recording minutes during the range specified
	RecordingMinutesConsumed float64                                                 `json:"recording_minutes_consumed"`
	JSON                     livestreamGetOrgAnalyticsResponseDataRecordingStatsJSON `json:"-"`
}

Recording statistics of an App during the range specified

func (*LivestreamGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON(data []byte) (err error)

type LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat added in v6.6.0

type LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat struct {
	Day string `json:"day"`
	// Total recording minutes for a specific day
	TotalRecordingMinutes int64 `json:"total_recording_minutes"`
	// Total number of recordings for a specific day
	TotalRecordings int64                                                          `json:"total_recordings"`
	JSON            livestreamGetOrgAnalyticsResponseDataRecordingStatsDayStatJSON `json:"-"`
}

func (*LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat) UnmarshalJSON added in v6.6.0

type LivestreamGetOrgAnalyticsResponseDataSessionStats added in v6.6.0

type LivestreamGetOrgAnalyticsResponseDataSessionStats struct {
	// Day wise session stats
	DayStats []LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat `json:"day_stats"`
	// Total number of sessions during the range specified
	SessionsCount int64 `json:"sessions_count"`
	// Total session minutes during the range specified
	SessionsMinutesConsumed float64                                               `json:"sessions_minutes_consumed"`
	JSON                    livestreamGetOrgAnalyticsResponseDataSessionStatsJSON `json:"-"`
}

Session statistics of an App during the range specified

func (*LivestreamGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON added in v6.6.0

func (r *LivestreamGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON(data []byte) (err error)

type LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat added in v6.6.0

type LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat struct {
	Day string `json:"day"`
	// Total session minutes for a specific day
	TotalSessionMinutes float64 `json:"total_session_minutes"`
	// Total number of sessions for a specific day
	TotalSessions int64                                                        `json:"total_sessions"`
	JSON          livestreamGetOrgAnalyticsResponseDataSessionStatsDayStatJSON `json:"-"`
}

func (*LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat) UnmarshalJSON added in v6.6.0

type LivestreamNewIndependentLivestreamParams added in v6.6.0

type LivestreamNewIndependentLivestreamParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Name of the livestream
	Name param.Field[string] `json:"name"`
}

func (LivestreamNewIndependentLivestreamParams) MarshalJSON added in v6.6.0

func (r LivestreamNewIndependentLivestreamParams) MarshalJSON() (data []byte, err error)

type LivestreamNewIndependentLivestreamResponse added in v6.6.0

type LivestreamNewIndependentLivestreamResponse struct {
	Data    LivestreamNewIndependentLivestreamResponseData `json:"data"`
	Success bool                                           `json:"success"`
	JSON    livestreamNewIndependentLivestreamResponseJSON `json:"-"`
}

func (*LivestreamNewIndependentLivestreamResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamNewIndependentLivestreamResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamNewIndependentLivestreamResponseData added in v6.6.0

type LivestreamNewIndependentLivestreamResponseData struct {
	// The livestream ID.
	ID string `json:"id"`
	// Specifies if the livestream was disabled.
	Disabled bool `json:"disabled"`
	// The server URL to which the RTMP encoder should send the video and audio data.
	IngestServer string `json:"ingest_server"`
	MeetingID    string `json:"meeting_id,nullable"`
	Name         string `json:"name"`
	// The web address that viewers can use to watch the livestream.
	PlaybackURL string                                               `json:"playback_url"`
	Status      LivestreamNewIndependentLivestreamResponseDataStatus `json:"status"`
	// Unique key for accessing each livestream.
	StreamKey string                                             `json:"stream_key"`
	JSON      livestreamNewIndependentLivestreamResponseDataJSON `json:"-"`
}

func (*LivestreamNewIndependentLivestreamResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamNewIndependentLivestreamResponseData) UnmarshalJSON(data []byte) (err error)

type LivestreamNewIndependentLivestreamResponseDataStatus added in v6.6.0

type LivestreamNewIndependentLivestreamResponseDataStatus string
const (
	LivestreamNewIndependentLivestreamResponseDataStatusLive    LivestreamNewIndependentLivestreamResponseDataStatus = "LIVE"
	LivestreamNewIndependentLivestreamResponseDataStatusIdle    LivestreamNewIndependentLivestreamResponseDataStatus = "IDLE"
	LivestreamNewIndependentLivestreamResponseDataStatusErrored LivestreamNewIndependentLivestreamResponseDataStatus = "ERRORED"
	LivestreamNewIndependentLivestreamResponseDataStatusInvoked LivestreamNewIndependentLivestreamResponseDataStatus = "INVOKED"
)

func (LivestreamNewIndependentLivestreamResponseDataStatus) IsKnown added in v6.6.0

type LivestreamService added in v6.6.0

type LivestreamService struct {
	Options []option.RequestOption
}

LivestreamService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLivestreamService method instead.

func NewLivestreamService added in v6.6.0

func NewLivestreamService(opts ...option.RequestOption) (r *LivestreamService)

NewLivestreamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*LivestreamService) GetActiveLivestreamsForLivestreamID added in v6.6.0

Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.

func (*LivestreamService) GetAllLivestreams added in v6.6.0

Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the `exclude_meetings` query parameter.

func (*LivestreamService) GetLivestreamAnalyticsComplete added in v6.6.0

Returns livestream analytics for the specified time range.

func (*LivestreamService) GetLivestreamSessionDetailsForSessionID added in v6.6.0

func (r *LivestreamService) GetLivestreamSessionDetailsForSessionID(ctx context.Context, appID string, livestreamSessionID string, query LivestreamGetLivestreamSessionDetailsForSessionIDParams, opts ...option.RequestOption) (res *LivestreamGetLivestreamSessionDetailsForSessionIDResponse, err error)

Returns livestream session details for the given livestream session ID. Retrieve the `livestream_session_id`using the `Fetch livestream session details using a session ID` API.

func (*LivestreamService) GetLivestreamSessionForLivestreamID added in v6.6.0

Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.

func (*LivestreamService) GetMeetingActiveLivestreams added in v6.6.0

Returns details of all active livestreams for the given meeting ID.

func (*LivestreamService) GetOrgAnalytics added in v6.6.0

Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.

func (*LivestreamService) NewIndependentLivestream added in v6.6.0

Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.

func (*LivestreamService) StartLivestreamingAMeeting added in v6.6.0

Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.

func (*LivestreamService) StopLivestreamingAMeeting added in v6.6.0

Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.

type LivestreamStartLivestreamingAMeetingParams added in v6.6.0

type LivestreamStartLivestreamingAMeetingParams struct {
	// The account identifier tag.
	AccountID   param.Field[string]                                                `path:"account_id,required"`
	Name        param.Field[string]                                                `json:"name"`
	VideoConfig param.Field[LivestreamStartLivestreamingAMeetingParamsVideoConfig] `json:"video_config"`
}

func (LivestreamStartLivestreamingAMeetingParams) MarshalJSON added in v6.6.0

func (r LivestreamStartLivestreamingAMeetingParams) MarshalJSON() (data []byte, err error)

type LivestreamStartLivestreamingAMeetingParamsVideoConfig added in v6.6.0

type LivestreamStartLivestreamingAMeetingParamsVideoConfig struct {
	// Height of the livestreaming video in pixels
	Height param.Field[int64] `json:"height"`
	// Width of the livestreaming video in pixels
	Width param.Field[int64] `json:"width"`
}

func (LivestreamStartLivestreamingAMeetingParamsVideoConfig) MarshalJSON added in v6.6.0

type LivestreamStartLivestreamingAMeetingResponse added in v6.6.0

type LivestreamStartLivestreamingAMeetingResponse struct {
	Data    LivestreamStartLivestreamingAMeetingResponseData `json:"data"`
	Success bool                                             `json:"success"`
	JSON    livestreamStartLivestreamingAMeetingResponseJSON `json:"-"`
}

func (*LivestreamStartLivestreamingAMeetingResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamStartLivestreamingAMeetingResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamStartLivestreamingAMeetingResponseData added in v6.6.0

type LivestreamStartLivestreamingAMeetingResponseData struct {
	// The livestream ID.
	ID string `json:"id"`
	// The server URL to which the RTMP encoder sends the video and audio data.
	IngestServer string `json:"ingest_server"`
	// The web address that viewers can use to watch the livestream.
	PlaybackURL string                                                 `json:"playback_url"`
	Status      LivestreamStartLivestreamingAMeetingResponseDataStatus `json:"status"`
	// Unique key for accessing each livestream.
	StreamKey string                                               `json:"stream_key"`
	JSON      livestreamStartLivestreamingAMeetingResponseDataJSON `json:"-"`
}

func (*LivestreamStartLivestreamingAMeetingResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamStartLivestreamingAMeetingResponseData) UnmarshalJSON(data []byte) (err error)

type LivestreamStartLivestreamingAMeetingResponseDataStatus added in v6.6.0

type LivestreamStartLivestreamingAMeetingResponseDataStatus string
const (
	LivestreamStartLivestreamingAMeetingResponseDataStatusLive    LivestreamStartLivestreamingAMeetingResponseDataStatus = "LIVE"
	LivestreamStartLivestreamingAMeetingResponseDataStatusIdle    LivestreamStartLivestreamingAMeetingResponseDataStatus = "IDLE"
	LivestreamStartLivestreamingAMeetingResponseDataStatusErrored LivestreamStartLivestreamingAMeetingResponseDataStatus = "ERRORED"
	LivestreamStartLivestreamingAMeetingResponseDataStatusInvoked LivestreamStartLivestreamingAMeetingResponseDataStatus = "INVOKED"
)

func (LivestreamStartLivestreamingAMeetingResponseDataStatus) IsKnown added in v6.6.0

type LivestreamStopLivestreamingAMeetingParams added in v6.6.0

type LivestreamStopLivestreamingAMeetingParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type LivestreamStopLivestreamingAMeetingResponse added in v6.6.0

type LivestreamStopLivestreamingAMeetingResponse struct {
	Data    LivestreamStopLivestreamingAMeetingResponseData `json:"data"`
	Success bool                                            `json:"success"`
	JSON    livestreamStopLivestreamingAMeetingResponseJSON `json:"-"`
}

func (*LivestreamStopLivestreamingAMeetingResponse) UnmarshalJSON added in v6.6.0

func (r *LivestreamStopLivestreamingAMeetingResponse) UnmarshalJSON(data []byte) (err error)

type LivestreamStopLivestreamingAMeetingResponseData added in v6.6.0

type LivestreamStopLivestreamingAMeetingResponseData struct {
	Message string                                              `json:"message"`
	JSON    livestreamStopLivestreamingAMeetingResponseDataJSON `json:"-"`
}

func (*LivestreamStopLivestreamingAMeetingResponseData) UnmarshalJSON added in v6.6.0

func (r *LivestreamStopLivestreamingAMeetingResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingAddParticipantParams added in v6.6.0

type MeetingAddParticipantParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// A unique participant ID. You must specify a unique ID for the participant, for
	// example, UUID, email address, and so on.
	CustomParticipantID param.Field[string] `json:"custom_participant_id,required"`
	// Name of the preset to apply to this participant.
	PresetName param.Field[string] `json:"preset_name,required"`
	// (Optional) Name of the participant.
	Name param.Field[string] `json:"name"`
	// (Optional) A URL to a picture to be used for the participant.
	Picture param.Field[string] `json:"picture" format:"uri"`
}

func (MeetingAddParticipantParams) MarshalJSON added in v6.6.0

func (r MeetingAddParticipantParams) MarshalJSON() (data []byte, err error)

type MeetingAddParticipantResponse added in v6.6.0

type MeetingAddParticipantResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Represents a participant.
	Data MeetingAddParticipantResponseData `json:"data"`
	JSON meetingAddParticipantResponseJSON `json:"-"`
}

func (*MeetingAddParticipantResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingAddParticipantResponse) UnmarshalJSON(data []byte) (err error)

type MeetingAddParticipantResponseData added in v6.6.0

type MeetingAddParticipantResponseData struct {
	// ID of the participant.
	ID string `json:"id,required" format:"uuid"`
	// The participant's auth token that can be used for joining a meeting from the
	// client side.
	Token string `json:"token,required"`
	// When this object was created. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// A unique participant ID generated by the client.
	CustomParticipantID string `json:"custom_participant_id,required"`
	// Preset applied to the participant.
	PresetName string `json:"preset_name,required"`
	// When this object was updated. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Name of the participant.
	Name string `json:"name,nullable"`
	// URL to a picture of the participant.
	Picture string                                `json:"picture,nullable" format:"uri"`
	JSON    meetingAddParticipantResponseDataJSON `json:"-"`
}

Represents a participant.

func (*MeetingAddParticipantResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingAddParticipantResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingDeleteMeetingParticipantParams added in v6.6.0

type MeetingDeleteMeetingParticipantParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MeetingDeleteMeetingParticipantResponse added in v6.6.0

type MeetingDeleteMeetingParticipantResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data MeetingDeleteMeetingParticipantResponseData `json:"data"`
	JSON meetingDeleteMeetingParticipantResponseJSON `json:"-"`
}

func (*MeetingDeleteMeetingParticipantResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingDeleteMeetingParticipantResponse) UnmarshalJSON(data []byte) (err error)

type MeetingDeleteMeetingParticipantResponseData added in v6.6.0

type MeetingDeleteMeetingParticipantResponseData struct {
	// Timestamp this object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// A unique participant ID generated by the client.
	CustomParticipantID string `json:"custom_participant_id,required"`
	// ID of the preset applied to this participant.
	PresetID string `json:"preset_id,required" format:"uuid"`
	// Timestamp this object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time                                       `json:"updated_at,required" format:"date-time"`
	JSON      meetingDeleteMeetingParticipantResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingDeleteMeetingParticipantResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingDeleteMeetingParticipantResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingEditParticipantParams added in v6.6.0

type MeetingEditParticipantParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// (Optional) Name of the participant.
	Name param.Field[string] `json:"name"`
	// (Optional) A URL to a picture to be used for the participant.
	Picture param.Field[string] `json:"picture" format:"uri"`
	// (Optional) Name of the preset to apply to this participant.
	PresetName param.Field[string] `json:"preset_name"`
}

func (MeetingEditParticipantParams) MarshalJSON added in v6.6.0

func (r MeetingEditParticipantParams) MarshalJSON() (data []byte, err error)

type MeetingEditParticipantResponse added in v6.6.0

type MeetingEditParticipantResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Represents a participant.
	Data MeetingEditParticipantResponseData `json:"data"`
	JSON meetingEditParticipantResponseJSON `json:"-"`
}

func (*MeetingEditParticipantResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingEditParticipantResponse) UnmarshalJSON(data []byte) (err error)

type MeetingEditParticipantResponseData added in v6.6.0

type MeetingEditParticipantResponseData struct {
	// ID of the participant.
	ID string `json:"id,required" format:"uuid"`
	// The participant's auth token that can be used for joining a meeting from the
	// client side.
	Token string `json:"token,required"`
	// When this object was created. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// A unique participant ID generated by the client.
	CustomParticipantID string `json:"custom_participant_id,required"`
	// Preset applied to the participant.
	PresetName string `json:"preset_name,required"`
	// When this object was updated. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Name of the participant.
	Name string `json:"name,nullable"`
	// URL to a picture of the participant.
	Picture string                                 `json:"picture,nullable" format:"uri"`
	JSON    meetingEditParticipantResponseDataJSON `json:"-"`
}

Represents a participant.

func (*MeetingEditParticipantResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingEditParticipantResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDParams added in v6.6.0

type MeetingGetMeetingByIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	Name      param.Field[string] `query:"name"`
}

func (MeetingGetMeetingByIDParams) URLQuery added in v6.6.0

func (r MeetingGetMeetingByIDParams) URLQuery() (v url.Values)

URLQuery serializes MeetingGetMeetingByIDParams's query parameters as `url.Values`.

type MeetingGetMeetingByIDResponse added in v6.6.0

type MeetingGetMeetingByIDResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data MeetingGetMeetingByIDResponseData `json:"data"`
	JSON meetingGetMeetingByIDResponseJSON `json:"-"`
}

func (*MeetingGetMeetingByIDResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingByIDResponse) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDResponseData added in v6.6.0

type MeetingGetMeetingByIDResponseData struct {
	// ID of the meeting.
	ID string `json:"id,required" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig MeetingGetMeetingByIDResponseDataAIConfig `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart bool `json:"live_stream_on_start"`
	// Specifies if Chat within a meeting should persist for a week.
	PersistChat bool `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart bool `json:"record_on_start"`
	// Recording Configurations to be used for this meeting. This level of configs
	// takes higher preference over App level configs on the RealtimeKit developer
	// portal.
	RecordingConfig MeetingGetMeetingByIDResponseDataRecordingConfig `json:"recording_config"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status MeetingGetMeetingByIDResponseDataStatus `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd bool `json:"summarize_on_end"`
	// Title of the meeting.
	Title string                                `json:"title"`
	JSON  meetingGetMeetingByIDResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingGetMeetingByIDResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingByIDResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDResponseDataAIConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfig struct {
	// Summary Config
	Summarization MeetingGetMeetingByIDResponseDataAIConfigSummarization `json:"summarization"`
	// Transcription Configurations
	Transcription MeetingGetMeetingByIDResponseDataAIConfigTranscription `json:"transcription"`
	JSON          meetingGetMeetingByIDResponseDataAIConfigJSON          `json:"-"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (*MeetingGetMeetingByIDResponseDataAIConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingByIDResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDResponseDataAIConfigSummarization added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit int64                                                      `json:"word_limit"`
	JSON      meetingGetMeetingByIDResponseDataAIConfigSummarizationJSON `json:"-"`
}

Summary Config

func (*MeetingGetMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeGeneral         MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "general"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeTeamMeeting     MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "team_meeting"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeSalesCall       MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "sales_call"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeClientCheckIn   MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "client_check_in"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeInterview       MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "interview"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeDailyStandup    MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "daily_standup"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeLecture         MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "lecture"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeCodeReview      MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormatPlainText MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat = "plain_text"
	MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormatMarkdown  MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigTranscription added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords []string `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter bool                                                       `json:"profanity_filter"`
	JSON            meetingGetMeetingByIDResponseDataAIConfigTranscriptionJSON `json:"-"`
}

Transcription Configurations

func (*MeetingGetMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage added in v6.6.0

type MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageEnUs MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-US"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageEnIn MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-IN"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageDe   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "de"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageHi   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "hi"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageSv   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "sv"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageRu   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "ru"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguagePl   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "pl"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageEl   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "el"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageFr   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "fr"
	MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageNl   MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "nl"
)

func (MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfig struct {
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig `json:"audio_config"`
	// Adds a prefix to the beginning of the file name of the recording.
	FileNamePrefix      string                                                              `json:"file_name_prefix"`
	LiveStreamingConfig MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds              float64                                                                 `json:"max_seconds"`
	RealtimekitBucketConfig MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
	StorageConfig           MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig           `json:"storage_config,nullable"`
	VideoConfig             MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig             `json:"video_config"`
	JSON                    meetingGetMeetingByIDResponseDataRecordingConfigJSON                    `json:"-"`
}

Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

func (*MeetingGetMeetingByIDResponseDataRecordingConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingByIDResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile bool                                                            `json:"export_file"`
	JSON       meetingGetMeetingByIDResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}

Object containing configuration regarding the audio that is being recorded.

func (*MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannelMono   MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "mono"
	MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannelStereo MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "stereo"
)

func (MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodecMP3 MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "MP3"
	MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodecAac MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "AAC"
)

func (MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig struct {
	// RTMP URL to stream to
	RtmpURL string                                                                  `json:"rtmp_url" format:"uri"`
	JSON    meetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}

func (*MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled bool                                                                        `json:"enabled,required"`
	JSON    meetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}

func (*MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig struct {
	// Type of storage media.
	Type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                            `json:"username"`
	JSON     meetingGetMeetingByIDResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}

func (*MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodKey      MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "KEY"
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD"
)

func (MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType string

Type of storage media.

const (
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeAws          MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "aws"
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeAzure        MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "azure"
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "digitalocean"
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeGcs          MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "gcs"
	MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeSftp         MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "sftp"
)

func (MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile bool `json:"export_file"`
	// Height of the recording video in pixels
	Height int64 `json:"height"`
	// Watermark to be added to the recording
	Watermark MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
	// Width of the recording video in pixels
	Width int64                                                           `json:"width"`
	JSON  meetingGetMeetingByIDResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}

func (*MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodecH264 MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "H264"
	MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodecVp8  MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "VP8"
)

func (MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark struct {
	// Position of the watermark
	Position MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
	// Size of the watermark
	Size MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
	// URL of the watermark image
	URL  string                                                                   `json:"url" format:"uri"`
	JSON meetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}

Watermark to be added to the recording

func (*MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition string

Position of the watermark

const (
	MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop     MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top"
	MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop    MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top"
	MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom  MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom"
	MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom"
)

func (MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize added in v6.6.0

type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height int64 `json:"height"`
	// Width of the watermark in px
	Width int64                                                                        `json:"width"`
	JSON  meetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}

Size of the watermark

func (*MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON added in v6.6.0

type MeetingGetMeetingByIDResponseDataStatus added in v6.6.0

type MeetingGetMeetingByIDResponseDataStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	MeetingGetMeetingByIDResponseDataStatusActive   MeetingGetMeetingByIDResponseDataStatus = "ACTIVE"
	MeetingGetMeetingByIDResponseDataStatusInactive MeetingGetMeetingByIDResponseDataStatus = "INACTIVE"
)

func (MeetingGetMeetingByIDResponseDataStatus) IsKnown added in v6.6.0

type MeetingGetMeetingParticipantParams added in v6.6.0

type MeetingGetMeetingParticipantParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MeetingGetMeetingParticipantResponse added in v6.6.0

type MeetingGetMeetingParticipantResponse struct {
	// Data returned by the operation
	Data MeetingGetMeetingParticipantResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                                     `json:"success,required"`
	JSON    meetingGetMeetingParticipantResponseJSON `json:"-"`
}

func (*MeetingGetMeetingParticipantResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingParticipantResponse) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingParticipantResponseData added in v6.6.0

type MeetingGetMeetingParticipantResponseData struct {
	// ID of the participant.
	ID string `json:"id,required" format:"uuid"`
	// When this object was created. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// A unique participant ID generated by the client.
	CustomParticipantID string `json:"custom_participant_id,required"`
	// Preset applied to the participant.
	PresetName string `json:"preset_name,required"`
	// When this object was updated. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Name of the participant.
	Name string `json:"name,nullable"`
	// URL to a picture of the participant.
	Picture string                                       `json:"picture,nullable" format:"uri"`
	JSON    meetingGetMeetingParticipantResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingGetMeetingParticipantResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingParticipantResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingParticipantsParams added in v6.6.0

type MeetingGetMeetingParticipantsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[float64] `query:"page_no"`
	// Number of results per page
	PerPage param.Field[float64] `query:"per_page"`
}

func (MeetingGetMeetingParticipantsParams) URLQuery added in v6.6.0

URLQuery serializes MeetingGetMeetingParticipantsParams's query parameters as `url.Values`.

type MeetingGetMeetingParticipantsResponse added in v6.6.0

type MeetingGetMeetingParticipantsResponse struct {
	Data    []MeetingGetMeetingParticipantsResponseData `json:"data,required"`
	Paging  MeetingGetMeetingParticipantsResponsePaging `json:"paging,required"`
	Success bool                                        `json:"success,required"`
	JSON    meetingGetMeetingParticipantsResponseJSON   `json:"-"`
}

func (*MeetingGetMeetingParticipantsResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingParticipantsResponse) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingParticipantsResponseData added in v6.6.0

type MeetingGetMeetingParticipantsResponseData struct {
	// ID of the participant.
	ID string `json:"id,required" format:"uuid"`
	// When this object was created. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// A unique participant ID generated by the client.
	CustomParticipantID string `json:"custom_participant_id,required"`
	// Preset applied to the participant.
	PresetName string `json:"preset_name,required"`
	// When this object was updated. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Name of the participant.
	Name string `json:"name,nullable"`
	// URL to a picture of the participant.
	Picture string                                        `json:"picture,nullable" format:"uri"`
	JSON    meetingGetMeetingParticipantsResponseDataJSON `json:"-"`
}

Represents a participant.

func (*MeetingGetMeetingParticipantsResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingParticipantsResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingGetMeetingParticipantsResponsePaging added in v6.6.0

type MeetingGetMeetingParticipantsResponsePaging struct {
	EndOffset   float64                                         `json:"end_offset,required"`
	StartOffset float64                                         `json:"start_offset,required"`
	TotalCount  float64                                         `json:"total_count,required"`
	JSON        meetingGetMeetingParticipantsResponsePagingJSON `json:"-"`
}

func (*MeetingGetMeetingParticipantsResponsePaging) UnmarshalJSON added in v6.6.0

func (r *MeetingGetMeetingParticipantsResponsePaging) UnmarshalJSON(data []byte) (err error)

type MeetingGetParams added in v6.6.0

type MeetingGetParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The end time range for which you want to retrieve the meetings. The time must be
	// specified in ISO format.
	EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[float64] `query:"page_no"`
	// Number of results per page
	PerPage param.Field[float64] `query:"per_page"`
	// The search query string. You can search using the meeting ID or title.
	Search param.Field[string] `query:"search"`
	// The start time range for which you want to retrieve the meetings. The time must
	// be specified in ISO format.
	StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
}

func (MeetingGetParams) URLQuery added in v6.6.0

func (r MeetingGetParams) URLQuery() (v url.Values)

URLQuery serializes MeetingGetParams's query parameters as `url.Values`.

type MeetingGetResponse added in v6.6.0

type MeetingGetResponse struct {
	Data    []MeetingGetResponseData `json:"data,required"`
	Paging  MeetingGetResponsePaging `json:"paging,required"`
	Success bool                     `json:"success,required"`
	JSON    meetingGetResponseJSON   `json:"-"`
}

func (*MeetingGetResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingGetResponse) UnmarshalJSON(data []byte) (err error)

type MeetingGetResponseData added in v6.6.0

type MeetingGetResponseData struct {
	// ID of the meeting.
	ID string `json:"id,required" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart bool `json:"live_stream_on_start"`
	// Specifies if Chat within a meeting should persist for a week.
	PersistChat bool `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart bool `json:"record_on_start"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status MeetingGetResponseDataStatus `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd bool `json:"summarize_on_end"`
	// Title of the meeting.
	Title string                     `json:"title"`
	JSON  meetingGetResponseDataJSON `json:"-"`
}

func (*MeetingGetResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingGetResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingGetResponseDataStatus added in v6.6.0

type MeetingGetResponseDataStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	MeetingGetResponseDataStatusActive   MeetingGetResponseDataStatus = "ACTIVE"
	MeetingGetResponseDataStatusInactive MeetingGetResponseDataStatus = "INACTIVE"
)

func (MeetingGetResponseDataStatus) IsKnown added in v6.6.0

func (r MeetingGetResponseDataStatus) IsKnown() bool

type MeetingGetResponsePaging added in v6.6.0

type MeetingGetResponsePaging struct {
	EndOffset   float64                      `json:"end_offset,required"`
	StartOffset float64                      `json:"start_offset,required"`
	TotalCount  float64                      `json:"total_count,required"`
	JSON        meetingGetResponsePagingJSON `json:"-"`
}

func (*MeetingGetResponsePaging) UnmarshalJSON added in v6.6.0

func (r *MeetingGetResponsePaging) UnmarshalJSON(data []byte) (err error)

type MeetingNewParams added in v6.6.0

type MeetingNewParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig param.Field[MeetingNewParamsAIConfig] `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart param.Field[bool] `json:"live_stream_on_start"`
	// If a meeting is set to persist_chat, meeting chat would remain for a week within
	// the meeting space.
	PersistChat param.Field[bool] `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart param.Field[bool] `json:"record_on_start"`
	// Recording Configurations to be used for this meeting. This level of configs
	// takes higher preference over App level configs on the RealtimeKit developer
	// portal.
	RecordingConfig param.Field[MeetingNewParamsRecordingConfig] `json:"recording_config"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs param.Field[float64] `json:"session_keep_alive_time_in_secs"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd param.Field[bool] `json:"summarize_on_end"`
	// Title of the meeting
	Title param.Field[string] `json:"title"`
}

func (MeetingNewParams) MarshalJSON added in v6.6.0

func (r MeetingNewParams) MarshalJSON() (data []byte, err error)

type MeetingNewParamsAIConfig added in v6.6.0

type MeetingNewParamsAIConfig struct {
	// Summary Config
	Summarization param.Field[MeetingNewParamsAIConfigSummarization] `json:"summarization"`
	// Transcription Configurations
	Transcription param.Field[MeetingNewParamsAIConfigTranscription] `json:"transcription"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (MeetingNewParamsAIConfig) MarshalJSON added in v6.6.0

func (r MeetingNewParamsAIConfig) MarshalJSON() (data []byte, err error)

type MeetingNewParamsAIConfigSummarization added in v6.6.0

type MeetingNewParamsAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType param.Field[MeetingNewParamsAIConfigSummarizationSummaryType] `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat param.Field[MeetingNewParamsAIConfigSummarizationTextFormat] `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit param.Field[int64] `json:"word_limit"`
}

Summary Config

func (MeetingNewParamsAIConfigSummarization) MarshalJSON added in v6.6.0

func (r MeetingNewParamsAIConfigSummarization) MarshalJSON() (data []byte, err error)

type MeetingNewParamsAIConfigSummarizationSummaryType added in v6.6.0

type MeetingNewParamsAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingNewParamsAIConfigSummarizationSummaryTypeGeneral         MeetingNewParamsAIConfigSummarizationSummaryType = "general"
	MeetingNewParamsAIConfigSummarizationSummaryTypeTeamMeeting     MeetingNewParamsAIConfigSummarizationSummaryType = "team_meeting"
	MeetingNewParamsAIConfigSummarizationSummaryTypeSalesCall       MeetingNewParamsAIConfigSummarizationSummaryType = "sales_call"
	MeetingNewParamsAIConfigSummarizationSummaryTypeClientCheckIn   MeetingNewParamsAIConfigSummarizationSummaryType = "client_check_in"
	MeetingNewParamsAIConfigSummarizationSummaryTypeInterview       MeetingNewParamsAIConfigSummarizationSummaryType = "interview"
	MeetingNewParamsAIConfigSummarizationSummaryTypeDailyStandup    MeetingNewParamsAIConfigSummarizationSummaryType = "daily_standup"
	MeetingNewParamsAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingNewParamsAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingNewParamsAIConfigSummarizationSummaryTypeLecture         MeetingNewParamsAIConfigSummarizationSummaryType = "lecture"
	MeetingNewParamsAIConfigSummarizationSummaryTypeCodeReview      MeetingNewParamsAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingNewParamsAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingNewParamsAIConfigSummarizationTextFormat added in v6.6.0

type MeetingNewParamsAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingNewParamsAIConfigSummarizationTextFormatPlainText MeetingNewParamsAIConfigSummarizationTextFormat = "plain_text"
	MeetingNewParamsAIConfigSummarizationTextFormatMarkdown  MeetingNewParamsAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingNewParamsAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingNewParamsAIConfigTranscription added in v6.6.0

type MeetingNewParamsAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords param.Field[[]string] `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language param.Field[MeetingNewParamsAIConfigTranscriptionLanguage] `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter param.Field[bool] `json:"profanity_filter"`
}

Transcription Configurations

func (MeetingNewParamsAIConfigTranscription) MarshalJSON added in v6.6.0

func (r MeetingNewParamsAIConfigTranscription) MarshalJSON() (data []byte, err error)

type MeetingNewParamsAIConfigTranscriptionLanguage added in v6.6.0

type MeetingNewParamsAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingNewParamsAIConfigTranscriptionLanguageEnUs MeetingNewParamsAIConfigTranscriptionLanguage = "en-US"
	MeetingNewParamsAIConfigTranscriptionLanguageEnIn MeetingNewParamsAIConfigTranscriptionLanguage = "en-IN"
	MeetingNewParamsAIConfigTranscriptionLanguageDe   MeetingNewParamsAIConfigTranscriptionLanguage = "de"
	MeetingNewParamsAIConfigTranscriptionLanguageHi   MeetingNewParamsAIConfigTranscriptionLanguage = "hi"
	MeetingNewParamsAIConfigTranscriptionLanguageSv   MeetingNewParamsAIConfigTranscriptionLanguage = "sv"
	MeetingNewParamsAIConfigTranscriptionLanguageRu   MeetingNewParamsAIConfigTranscriptionLanguage = "ru"
	MeetingNewParamsAIConfigTranscriptionLanguagePl   MeetingNewParamsAIConfigTranscriptionLanguage = "pl"
	MeetingNewParamsAIConfigTranscriptionLanguageEl   MeetingNewParamsAIConfigTranscriptionLanguage = "el"
	MeetingNewParamsAIConfigTranscriptionLanguageFr   MeetingNewParamsAIConfigTranscriptionLanguage = "fr"
	MeetingNewParamsAIConfigTranscriptionLanguageNl   MeetingNewParamsAIConfigTranscriptionLanguage = "nl"
)

func (MeetingNewParamsAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfig added in v6.6.0

type MeetingNewParamsRecordingConfig struct {
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig param.Field[MeetingNewParamsRecordingConfigAudioConfig] `json:"audio_config"`
	// Adds a prefix to the beginning of the file name of the recording.
	FileNamePrefix      param.Field[string]                                             `json:"file_name_prefix"`
	LiveStreamingConfig param.Field[MeetingNewParamsRecordingConfigLiveStreamingConfig] `json:"live_streaming_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds              param.Field[float64]                                                `json:"max_seconds"`
	RealtimekitBucketConfig param.Field[MeetingNewParamsRecordingConfigRealtimekitBucketConfig] `json:"realtimekit_bucket_config"`
	StorageConfig           param.Field[MeetingNewParamsRecordingConfigStorageConfig]           `json:"storage_config"`
	VideoConfig             param.Field[MeetingNewParamsRecordingConfigVideoConfig]             `json:"video_config"`
}

Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

func (MeetingNewParamsRecordingConfig) MarshalJSON added in v6.6.0

func (r MeetingNewParamsRecordingConfig) MarshalJSON() (data []byte, err error)

type MeetingNewParamsRecordingConfigAudioConfig added in v6.6.0

type MeetingNewParamsRecordingConfigAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel param.Field[MeetingNewParamsRecordingConfigAudioConfigChannel] `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec param.Field[MeetingNewParamsRecordingConfigAudioConfigCodec] `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile param.Field[bool] `json:"export_file"`
}

Object containing configuration regarding the audio that is being recorded.

func (MeetingNewParamsRecordingConfigAudioConfig) MarshalJSON added in v6.6.0

func (r MeetingNewParamsRecordingConfigAudioConfig) MarshalJSON() (data []byte, err error)

type MeetingNewParamsRecordingConfigAudioConfigChannel added in v6.6.0

type MeetingNewParamsRecordingConfigAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	MeetingNewParamsRecordingConfigAudioConfigChannelMono   MeetingNewParamsRecordingConfigAudioConfigChannel = "mono"
	MeetingNewParamsRecordingConfigAudioConfigChannelStereo MeetingNewParamsRecordingConfigAudioConfigChannel = "stereo"
)

func (MeetingNewParamsRecordingConfigAudioConfigChannel) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfigAudioConfigCodec added in v6.6.0

type MeetingNewParamsRecordingConfigAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	MeetingNewParamsRecordingConfigAudioConfigCodecMP3 MeetingNewParamsRecordingConfigAudioConfigCodec = "MP3"
	MeetingNewParamsRecordingConfigAudioConfigCodecAac MeetingNewParamsRecordingConfigAudioConfigCodec = "AAC"
)

func (MeetingNewParamsRecordingConfigAudioConfigCodec) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfigLiveStreamingConfig added in v6.6.0

type MeetingNewParamsRecordingConfigLiveStreamingConfig struct {
	// RTMP URL to stream to
	RtmpURL param.Field[string] `json:"rtmp_url" format:"uri"`
}

func (MeetingNewParamsRecordingConfigLiveStreamingConfig) MarshalJSON added in v6.6.0

func (r MeetingNewParamsRecordingConfigLiveStreamingConfig) MarshalJSON() (data []byte, err error)

type MeetingNewParamsRecordingConfigRealtimekitBucketConfig added in v6.6.0

type MeetingNewParamsRecordingConfigRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (MeetingNewParamsRecordingConfigRealtimekitBucketConfig) MarshalJSON added in v6.6.0

type MeetingNewParamsRecordingConfigStorageConfig added in v6.6.0

type MeetingNewParamsRecordingConfigStorageConfig struct {
	// Type of storage media.
	Type param.Field[MeetingNewParamsRecordingConfigStorageConfigType] `json:"type,required"`
	// Access key of the storage medium. Access key is not required for the `gcs`
	// storage media type.
	//
	// Note that this field is not readable by clients, only writeable.
	AccessKey param.Field[string] `json:"access_key"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod param.Field[MeetingNewParamsRecordingConfigStorageConfigAuthMethod] `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket param.Field[string] `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host param.Field[string] `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password param.Field[string] `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path param.Field[string] `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port param.Field[float64] `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey param.Field[string] `json:"private_key"`
	// Region of the storage medium.
	Region param.Field[string] `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret param.Field[string] `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username param.Field[string] `json:"username"`
}

func (MeetingNewParamsRecordingConfigStorageConfig) MarshalJSON added in v6.6.0

func (r MeetingNewParamsRecordingConfigStorageConfig) MarshalJSON() (data []byte, err error)

type MeetingNewParamsRecordingConfigStorageConfigAuthMethod added in v6.6.0

type MeetingNewParamsRecordingConfigStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	MeetingNewParamsRecordingConfigStorageConfigAuthMethodKey      MeetingNewParamsRecordingConfigStorageConfigAuthMethod = "KEY"
	MeetingNewParamsRecordingConfigStorageConfigAuthMethodPassword MeetingNewParamsRecordingConfigStorageConfigAuthMethod = "PASSWORD"
)

func (MeetingNewParamsRecordingConfigStorageConfigAuthMethod) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfigStorageConfigType added in v6.6.0

type MeetingNewParamsRecordingConfigStorageConfigType string

Type of storage media.

const (
	MeetingNewParamsRecordingConfigStorageConfigTypeAws          MeetingNewParamsRecordingConfigStorageConfigType = "aws"
	MeetingNewParamsRecordingConfigStorageConfigTypeAzure        MeetingNewParamsRecordingConfigStorageConfigType = "azure"
	MeetingNewParamsRecordingConfigStorageConfigTypeDigitalocean MeetingNewParamsRecordingConfigStorageConfigType = "digitalocean"
	MeetingNewParamsRecordingConfigStorageConfigTypeGcs          MeetingNewParamsRecordingConfigStorageConfigType = "gcs"
	MeetingNewParamsRecordingConfigStorageConfigTypeSftp         MeetingNewParamsRecordingConfigStorageConfigType = "sftp"
)

func (MeetingNewParamsRecordingConfigStorageConfigType) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfig added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec param.Field[MeetingNewParamsRecordingConfigVideoConfigCodec] `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile param.Field[bool] `json:"export_file"`
	// Height of the recording video in pixels
	Height param.Field[int64] `json:"height"`
	// Watermark to be added to the recording
	Watermark param.Field[MeetingNewParamsRecordingConfigVideoConfigWatermark] `json:"watermark"`
	// Width of the recording video in pixels
	Width param.Field[int64] `json:"width"`
}

func (MeetingNewParamsRecordingConfigVideoConfig) MarshalJSON added in v6.6.0

func (r MeetingNewParamsRecordingConfigVideoConfig) MarshalJSON() (data []byte, err error)

type MeetingNewParamsRecordingConfigVideoConfigCodec added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	MeetingNewParamsRecordingConfigVideoConfigCodecH264 MeetingNewParamsRecordingConfigVideoConfigCodec = "H264"
	MeetingNewParamsRecordingConfigVideoConfigCodecVp8  MeetingNewParamsRecordingConfigVideoConfigCodec = "VP8"
)

func (MeetingNewParamsRecordingConfigVideoConfigCodec) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfigWatermark added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfigWatermark struct {
	// Position of the watermark
	Position param.Field[MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition] `json:"position"`
	// Size of the watermark
	Size param.Field[MeetingNewParamsRecordingConfigVideoConfigWatermarkSize] `json:"size"`
	// URL of the watermark image
	URL param.Field[string] `json:"url" format:"uri"`
}

Watermark to be added to the recording

func (MeetingNewParamsRecordingConfigVideoConfigWatermark) MarshalJSON added in v6.6.0

func (r MeetingNewParamsRecordingConfigVideoConfigWatermark) MarshalJSON() (data []byte, err error)

type MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition string

Position of the watermark

const (
	MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionLeftTop     MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "left top"
	MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionRightTop    MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "right top"
	MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionLeftBottom  MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "left bottom"
	MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "right bottom"
)

func (MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfigWatermarkSize added in v6.6.0

type MeetingNewParamsRecordingConfigVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height param.Field[int64] `json:"height"`
	// Width of the watermark in px
	Width param.Field[int64] `json:"width"`
}

Size of the watermark

func (MeetingNewParamsRecordingConfigVideoConfigWatermarkSize) MarshalJSON added in v6.6.0

type MeetingNewResponse added in v6.6.0

type MeetingNewResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data MeetingNewResponseData `json:"data"`
	JSON meetingNewResponseJSON `json:"-"`
}

func (*MeetingNewResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponse) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseData added in v6.6.0

type MeetingNewResponseData struct {
	// ID of the meeting.
	ID string `json:"id,required" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig MeetingNewResponseDataAIConfig `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart bool `json:"live_stream_on_start"`
	// Specifies if Chat within a meeting should persist for a week.
	PersistChat bool `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart bool `json:"record_on_start"`
	// Recording Configurations to be used for this meeting. This level of configs
	// takes higher preference over App level configs on the RealtimeKit developer
	// portal.
	RecordingConfig MeetingNewResponseDataRecordingConfig `json:"recording_config"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status MeetingNewResponseDataStatus `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd bool `json:"summarize_on_end"`
	// Title of the meeting.
	Title string                     `json:"title"`
	JSON  meetingNewResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingNewResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataAIConfig added in v6.6.0

type MeetingNewResponseDataAIConfig struct {
	// Summary Config
	Summarization MeetingNewResponseDataAIConfigSummarization `json:"summarization"`
	// Transcription Configurations
	Transcription MeetingNewResponseDataAIConfigTranscription `json:"transcription"`
	JSON          meetingNewResponseDataAIConfigJSON          `json:"-"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (*MeetingNewResponseDataAIConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataAIConfigSummarization added in v6.6.0

type MeetingNewResponseDataAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType MeetingNewResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat MeetingNewResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit int64                                           `json:"word_limit"`
	JSON      meetingNewResponseDataAIConfigSummarizationJSON `json:"-"`
}

Summary Config

func (*MeetingNewResponseDataAIConfigSummarization) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataAIConfigSummarization) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataAIConfigSummarizationSummaryType added in v6.6.0

type MeetingNewResponseDataAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeGeneral         MeetingNewResponseDataAIConfigSummarizationSummaryType = "general"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeTeamMeeting     MeetingNewResponseDataAIConfigSummarizationSummaryType = "team_meeting"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeSalesCall       MeetingNewResponseDataAIConfigSummarizationSummaryType = "sales_call"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeClientCheckIn   MeetingNewResponseDataAIConfigSummarizationSummaryType = "client_check_in"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeInterview       MeetingNewResponseDataAIConfigSummarizationSummaryType = "interview"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeDailyStandup    MeetingNewResponseDataAIConfigSummarizationSummaryType = "daily_standup"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingNewResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeLecture         MeetingNewResponseDataAIConfigSummarizationSummaryType = "lecture"
	MeetingNewResponseDataAIConfigSummarizationSummaryTypeCodeReview      MeetingNewResponseDataAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingNewResponseDataAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingNewResponseDataAIConfigSummarizationTextFormat added in v6.6.0

type MeetingNewResponseDataAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingNewResponseDataAIConfigSummarizationTextFormatPlainText MeetingNewResponseDataAIConfigSummarizationTextFormat = "plain_text"
	MeetingNewResponseDataAIConfigSummarizationTextFormatMarkdown  MeetingNewResponseDataAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingNewResponseDataAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingNewResponseDataAIConfigTranscription added in v6.6.0

type MeetingNewResponseDataAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords []string `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language MeetingNewResponseDataAIConfigTranscriptionLanguage `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter bool                                            `json:"profanity_filter"`
	JSON            meetingNewResponseDataAIConfigTranscriptionJSON `json:"-"`
}

Transcription Configurations

func (*MeetingNewResponseDataAIConfigTranscription) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataAIConfigTranscription) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataAIConfigTranscriptionLanguage added in v6.6.0

type MeetingNewResponseDataAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingNewResponseDataAIConfigTranscriptionLanguageEnUs MeetingNewResponseDataAIConfigTranscriptionLanguage = "en-US"
	MeetingNewResponseDataAIConfigTranscriptionLanguageEnIn MeetingNewResponseDataAIConfigTranscriptionLanguage = "en-IN"
	MeetingNewResponseDataAIConfigTranscriptionLanguageDe   MeetingNewResponseDataAIConfigTranscriptionLanguage = "de"
	MeetingNewResponseDataAIConfigTranscriptionLanguageHi   MeetingNewResponseDataAIConfigTranscriptionLanguage = "hi"
	MeetingNewResponseDataAIConfigTranscriptionLanguageSv   MeetingNewResponseDataAIConfigTranscriptionLanguage = "sv"
	MeetingNewResponseDataAIConfigTranscriptionLanguageRu   MeetingNewResponseDataAIConfigTranscriptionLanguage = "ru"
	MeetingNewResponseDataAIConfigTranscriptionLanguagePl   MeetingNewResponseDataAIConfigTranscriptionLanguage = "pl"
	MeetingNewResponseDataAIConfigTranscriptionLanguageEl   MeetingNewResponseDataAIConfigTranscriptionLanguage = "el"
	MeetingNewResponseDataAIConfigTranscriptionLanguageFr   MeetingNewResponseDataAIConfigTranscriptionLanguage = "fr"
	MeetingNewResponseDataAIConfigTranscriptionLanguageNl   MeetingNewResponseDataAIConfigTranscriptionLanguage = "nl"
)

func (MeetingNewResponseDataAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfig added in v6.6.0

type MeetingNewResponseDataRecordingConfig struct {
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig MeetingNewResponseDataRecordingConfigAudioConfig `json:"audio_config"`
	// Adds a prefix to the beginning of the file name of the recording.
	FileNamePrefix      string                                                   `json:"file_name_prefix"`
	LiveStreamingConfig MeetingNewResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds              float64                                                      `json:"max_seconds"`
	RealtimekitBucketConfig MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
	StorageConfig           MeetingNewResponseDataRecordingConfigStorageConfig           `json:"storage_config,nullable"`
	VideoConfig             MeetingNewResponseDataRecordingConfigVideoConfig             `json:"video_config"`
	JSON                    meetingNewResponseDataRecordingConfigJSON                    `json:"-"`
}

Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

func (*MeetingNewResponseDataRecordingConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataRecordingConfigAudioConfig added in v6.6.0

type MeetingNewResponseDataRecordingConfigAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel MeetingNewResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec MeetingNewResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile bool                                                 `json:"export_file"`
	JSON       meetingNewResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}

Object containing configuration regarding the audio that is being recorded.

func (*MeetingNewResponseDataRecordingConfigAudioConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataRecordingConfigAudioConfig) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataRecordingConfigAudioConfigChannel added in v6.6.0

type MeetingNewResponseDataRecordingConfigAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	MeetingNewResponseDataRecordingConfigAudioConfigChannelMono   MeetingNewResponseDataRecordingConfigAudioConfigChannel = "mono"
	MeetingNewResponseDataRecordingConfigAudioConfigChannelStereo MeetingNewResponseDataRecordingConfigAudioConfigChannel = "stereo"
)

func (MeetingNewResponseDataRecordingConfigAudioConfigChannel) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfigAudioConfigCodec added in v6.6.0

type MeetingNewResponseDataRecordingConfigAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	MeetingNewResponseDataRecordingConfigAudioConfigCodecMP3 MeetingNewResponseDataRecordingConfigAudioConfigCodec = "MP3"
	MeetingNewResponseDataRecordingConfigAudioConfigCodecAac MeetingNewResponseDataRecordingConfigAudioConfigCodec = "AAC"
)

func (MeetingNewResponseDataRecordingConfigAudioConfigCodec) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfigLiveStreamingConfig added in v6.6.0

type MeetingNewResponseDataRecordingConfigLiveStreamingConfig struct {
	// RTMP URL to stream to
	RtmpURL string                                                       `json:"rtmp_url" format:"uri"`
	JSON    meetingNewResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}

func (*MeetingNewResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON added in v6.6.0

type MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig added in v6.6.0

type MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled bool                                                             `json:"enabled,required"`
	JSON    meetingNewResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}

func (*MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON added in v6.6.0

type MeetingNewResponseDataRecordingConfigStorageConfig added in v6.6.0

type MeetingNewResponseDataRecordingConfigStorageConfig struct {
	// Type of storage media.
	Type MeetingNewResponseDataRecordingConfigStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                 `json:"username"`
	JSON     meetingNewResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}

func (*MeetingNewResponseDataRecordingConfigStorageConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataRecordingConfigStorageConfig) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod added in v6.6.0

type MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	MeetingNewResponseDataRecordingConfigStorageConfigAuthMethodKey      MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod = "KEY"
	MeetingNewResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD"
)

func (MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfigStorageConfigType added in v6.6.0

type MeetingNewResponseDataRecordingConfigStorageConfigType string

Type of storage media.

const (
	MeetingNewResponseDataRecordingConfigStorageConfigTypeAws          MeetingNewResponseDataRecordingConfigStorageConfigType = "aws"
	MeetingNewResponseDataRecordingConfigStorageConfigTypeAzure        MeetingNewResponseDataRecordingConfigStorageConfigType = "azure"
	MeetingNewResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingNewResponseDataRecordingConfigStorageConfigType = "digitalocean"
	MeetingNewResponseDataRecordingConfigStorageConfigTypeGcs          MeetingNewResponseDataRecordingConfigStorageConfigType = "gcs"
	MeetingNewResponseDataRecordingConfigStorageConfigTypeSftp         MeetingNewResponseDataRecordingConfigStorageConfigType = "sftp"
)

func (MeetingNewResponseDataRecordingConfigStorageConfigType) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfig added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec MeetingNewResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile bool `json:"export_file"`
	// Height of the recording video in pixels
	Height int64 `json:"height"`
	// Watermark to be added to the recording
	Watermark MeetingNewResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
	// Width of the recording video in pixels
	Width int64                                                `json:"width"`
	JSON  meetingNewResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}

func (*MeetingNewResponseDataRecordingConfigVideoConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingNewResponseDataRecordingConfigVideoConfig) UnmarshalJSON(data []byte) (err error)

type MeetingNewResponseDataRecordingConfigVideoConfigCodec added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	MeetingNewResponseDataRecordingConfigVideoConfigCodecH264 MeetingNewResponseDataRecordingConfigVideoConfigCodec = "H264"
	MeetingNewResponseDataRecordingConfigVideoConfigCodecVp8  MeetingNewResponseDataRecordingConfigVideoConfigCodec = "VP8"
)

func (MeetingNewResponseDataRecordingConfigVideoConfigCodec) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigWatermark added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigWatermark struct {
	// Position of the watermark
	Position MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
	// Size of the watermark
	Size MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
	// URL of the watermark image
	URL  string                                                        `json:"url" format:"uri"`
	JSON meetingNewResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}

Watermark to be added to the recording

func (*MeetingNewResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition string

Position of the watermark

const (
	MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop     MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top"
	MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop    MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top"
	MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom  MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom"
	MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom"
)

func (MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize added in v6.6.0

type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height int64 `json:"height"`
	// Width of the watermark in px
	Width int64                                                             `json:"width"`
	JSON  meetingNewResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}

Size of the watermark

func (*MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON added in v6.6.0

type MeetingNewResponseDataStatus added in v6.6.0

type MeetingNewResponseDataStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	MeetingNewResponseDataStatusActive   MeetingNewResponseDataStatus = "ACTIVE"
	MeetingNewResponseDataStatusInactive MeetingNewResponseDataStatus = "INACTIVE"
)

func (MeetingNewResponseDataStatus) IsKnown added in v6.6.0

func (r MeetingNewResponseDataStatus) IsKnown() bool

type MeetingRefreshParticipantTokenParams added in v6.6.0

type MeetingRefreshParticipantTokenParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MeetingRefreshParticipantTokenResponse added in v6.6.0

type MeetingRefreshParticipantTokenResponse struct {
	// Data returned by the operation
	Data MeetingRefreshParticipantTokenResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                                       `json:"success,required"`
	JSON    meetingRefreshParticipantTokenResponseJSON `json:"-"`
}

func (*MeetingRefreshParticipantTokenResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingRefreshParticipantTokenResponse) UnmarshalJSON(data []byte) (err error)

type MeetingRefreshParticipantTokenResponseData added in v6.6.0

type MeetingRefreshParticipantTokenResponseData struct {
	// Regenerated participant's authentication token.
	Token string                                         `json:"token,required"`
	JSON  meetingRefreshParticipantTokenResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingRefreshParticipantTokenResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingRefreshParticipantTokenResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingReplaceMeetingByIDParams added in v6.6.0

type MeetingReplaceMeetingByIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig param.Field[MeetingReplaceMeetingByIDParamsAIConfig] `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart param.Field[bool] `json:"live_stream_on_start"`
	// If a meeting is set to persist_chat, meeting chat would remain for a week within
	// the meeting space.
	PersistChat param.Field[bool] `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart param.Field[bool] `json:"record_on_start"`
	// Recording Configurations to be used for this meeting. This level of configs
	// takes higher preference over App level configs on the RealtimeKit developer
	// portal.
	RecordingConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfig] `json:"recording_config"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs param.Field[float64] `json:"session_keep_alive_time_in_secs"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd param.Field[bool] `json:"summarize_on_end"`
	// Title of the meeting
	Title param.Field[string] `json:"title"`
}

func (MeetingReplaceMeetingByIDParams) MarshalJSON added in v6.6.0

func (r MeetingReplaceMeetingByIDParams) MarshalJSON() (data []byte, err error)

type MeetingReplaceMeetingByIDParamsAIConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfig struct {
	// Summary Config
	Summarization param.Field[MeetingReplaceMeetingByIDParamsAIConfigSummarization] `json:"summarization"`
	// Transcription Configurations
	Transcription param.Field[MeetingReplaceMeetingByIDParamsAIConfigTranscription] `json:"transcription"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (MeetingReplaceMeetingByIDParamsAIConfig) MarshalJSON added in v6.6.0

func (r MeetingReplaceMeetingByIDParamsAIConfig) MarshalJSON() (data []byte, err error)

type MeetingReplaceMeetingByIDParamsAIConfigSummarization added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType param.Field[MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType] `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat param.Field[MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat] `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit param.Field[int64] `json:"word_limit"`
}

Summary Config

func (MeetingReplaceMeetingByIDParamsAIConfigSummarization) MarshalJSON added in v6.6.0

func (r MeetingReplaceMeetingByIDParamsAIConfigSummarization) MarshalJSON() (data []byte, err error)

type MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeGeneral         MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "general"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeTeamMeeting     MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "team_meeting"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeSalesCall       MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "sales_call"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeClientCheckIn   MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "client_check_in"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeInterview       MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "interview"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeDailyStandup    MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "daily_standup"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeLecture         MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "lecture"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeCodeReview      MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormatPlainText MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat = "plain_text"
	MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormatMarkdown  MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigTranscription added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords param.Field[[]string] `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language param.Field[MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage] `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter param.Field[bool] `json:"profanity_filter"`
}

Transcription Configurations

func (MeetingReplaceMeetingByIDParamsAIConfigTranscription) MarshalJSON added in v6.6.0

func (r MeetingReplaceMeetingByIDParamsAIConfigTranscription) MarshalJSON() (data []byte, err error)

type MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage added in v6.6.0

type MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageEnUs MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "en-US"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageEnIn MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "en-IN"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageDe   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "de"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageHi   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "hi"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageSv   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "sv"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageRu   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "ru"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguagePl   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "pl"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageEl   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "el"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageFr   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "fr"
	MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageNl   MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "nl"
)

func (MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfig struct {
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig] `json:"audio_config"`
	// Adds a prefix to the beginning of the file name of the recording.
	FileNamePrefix      param.Field[string]                                                            `json:"file_name_prefix"`
	LiveStreamingConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig] `json:"live_streaming_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds              param.Field[float64]                                                               `json:"max_seconds"`
	RealtimekitBucketConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig] `json:"realtimekit_bucket_config"`
	StorageConfig           param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig]           `json:"storage_config"`
	VideoConfig             param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig]             `json:"video_config"`
}

Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

func (MeetingReplaceMeetingByIDParamsRecordingConfig) MarshalJSON added in v6.6.0

func (r MeetingReplaceMeetingByIDParamsRecordingConfig) MarshalJSON() (data []byte, err error)

type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel] `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec] `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile param.Field[bool] `json:"export_file"`
}

Object containing configuration regarding the audio that is being recorded.

func (MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannelMono   MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel = "mono"
	MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannelStereo MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel = "stereo"
)

func (MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodecMP3 MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec = "MP3"
	MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodecAac MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec = "AAC"
)

func (MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig struct {
	// RTMP URL to stream to
	RtmpURL param.Field[string] `json:"rtmp_url" format:"uri"`
}

func (MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig struct {
	// Type of storage media.
	Type param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType] `json:"type,required"`
	// Access key of the storage medium. Access key is not required for the `gcs`
	// storage media type.
	//
	// Note that this field is not readable by clients, only writeable.
	AccessKey param.Field[string] `json:"access_key"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod] `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket param.Field[string] `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host param.Field[string] `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password param.Field[string] `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path param.Field[string] `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port param.Field[float64] `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey param.Field[string] `json:"private_key"`
	// Region of the storage medium.
	Region param.Field[string] `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret param.Field[string] `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username param.Field[string] `json:"username"`
}

func (MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethodKey      MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod = "KEY"
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethodPassword MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod = "PASSWORD"
)

func (MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType string

Type of storage media.

const (
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeAws          MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "aws"
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeAzure        MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "azure"
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeDigitalocean MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "digitalocean"
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeGcs          MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "gcs"
	MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeSftp         MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "sftp"
)

func (MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec] `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile param.Field[bool] `json:"export_file"`
	// Height of the recording video in pixels
	Height param.Field[int64] `json:"height"`
	// Watermark to be added to the recording
	Watermark param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark] `json:"watermark"`
	// Width of the recording video in pixels
	Width param.Field[int64] `json:"width"`
}

func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodecH264 MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec = "H264"
	MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodecVp8  MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec = "VP8"
)

func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark struct {
	// Position of the watermark
	Position param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition] `json:"position"`
	// Size of the watermark
	Size param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize] `json:"size"`
	// URL of the watermark image
	URL param.Field[string] `json:"url" format:"uri"`
}

Watermark to be added to the recording

func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition string

Position of the watermark

const (
	MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionLeftTop     MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "left top"
	MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionRightTop    MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "right top"
	MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionLeftBottom  MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "left bottom"
	MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "right bottom"
)

func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize added in v6.6.0

type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height param.Field[int64] `json:"height"`
	// Width of the watermark in px
	Width param.Field[int64] `json:"width"`
}

Size of the watermark

func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize) MarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponse added in v6.6.0

type MeetingReplaceMeetingByIDResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data MeetingReplaceMeetingByIDResponseData `json:"data"`
	JSON meetingReplaceMeetingByIDResponseJSON `json:"-"`
}

func (*MeetingReplaceMeetingByIDResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingReplaceMeetingByIDResponse) UnmarshalJSON(data []byte) (err error)

type MeetingReplaceMeetingByIDResponseData added in v6.6.0

type MeetingReplaceMeetingByIDResponseData struct {
	// ID of the meeting.
	ID string `json:"id,required" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig MeetingReplaceMeetingByIDResponseDataAIConfig `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart bool `json:"live_stream_on_start"`
	// Specifies if Chat within a meeting should persist for a week.
	PersistChat bool `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart bool `json:"record_on_start"`
	// Recording Configurations to be used for this meeting. This level of configs
	// takes higher preference over App level configs on the RealtimeKit developer
	// portal.
	RecordingConfig MeetingReplaceMeetingByIDResponseDataRecordingConfig `json:"recording_config"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status MeetingReplaceMeetingByIDResponseDataStatus `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd bool `json:"summarize_on_end"`
	// Title of the meeting.
	Title string                                    `json:"title"`
	JSON  meetingReplaceMeetingByIDResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingReplaceMeetingByIDResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingReplaceMeetingByIDResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingReplaceMeetingByIDResponseDataAIConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfig struct {
	// Summary Config
	Summarization MeetingReplaceMeetingByIDResponseDataAIConfigSummarization `json:"summarization"`
	// Transcription Configurations
	Transcription MeetingReplaceMeetingByIDResponseDataAIConfigTranscription `json:"transcription"`
	JSON          meetingReplaceMeetingByIDResponseDataAIConfigJSON          `json:"-"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (*MeetingReplaceMeetingByIDResponseDataAIConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingReplaceMeetingByIDResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)

type MeetingReplaceMeetingByIDResponseDataAIConfigSummarization added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit int64                                                          `json:"word_limit"`
	JSON      meetingReplaceMeetingByIDResponseDataAIConfigSummarizationJSON `json:"-"`
}

Summary Config

func (*MeetingReplaceMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeGeneral         MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "general"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeTeamMeeting     MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "team_meeting"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeSalesCall       MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "sales_call"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeClientCheckIn   MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "client_check_in"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeInterview       MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "interview"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeDailyStandup    MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "daily_standup"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeLecture         MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "lecture"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeCodeReview      MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormatPlainText MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat = "plain_text"
	MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormatMarkdown  MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigTranscription added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords []string `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter bool                                                           `json:"profanity_filter"`
	JSON            meetingReplaceMeetingByIDResponseDataAIConfigTranscriptionJSON `json:"-"`
}

Transcription Configurations

func (*MeetingReplaceMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageEnUs MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-US"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageEnIn MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-IN"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageDe   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "de"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageHi   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "hi"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageSv   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "sv"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageRu   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "ru"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguagePl   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "pl"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageEl   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "el"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageFr   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "fr"
	MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageNl   MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "nl"
)

func (MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfig struct {
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig `json:"audio_config"`
	// Adds a prefix to the beginning of the file name of the recording.
	FileNamePrefix      string                                                                  `json:"file_name_prefix"`
	LiveStreamingConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds              float64                                                                     `json:"max_seconds"`
	RealtimekitBucketConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
	StorageConfig           MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig           `json:"storage_config,nullable"`
	VideoConfig             MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig             `json:"video_config"`
	JSON                    meetingReplaceMeetingByIDResponseDataRecordingConfigJSON                    `json:"-"`
}

Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)

type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile bool                                                                `json:"export_file"`
	JSON       meetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}

Object containing configuration regarding the audio that is being recorded.

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannelMono   MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "mono"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannelStereo MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "stereo"
)

func (MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodecMP3 MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "MP3"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodecAac MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "AAC"
)

func (MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig struct {
	// RTMP URL to stream to
	RtmpURL string                                                                      `json:"rtmp_url" format:"uri"`
	JSON    meetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled bool                                                                            `json:"enabled,required"`
	JSON    meetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig struct {
	// Type of storage media.
	Type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                                `json:"username"`
	JSON     meetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodKey      MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "KEY"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD"
)

func (MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType string

Type of storage media.

const (
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeAws          MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "aws"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeAzure        MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "azure"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "digitalocean"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeGcs          MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "gcs"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeSftp         MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "sftp"
)

func (MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile bool `json:"export_file"`
	// Height of the recording video in pixels
	Height int64 `json:"height"`
	// Watermark to be added to the recording
	Watermark MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
	// Width of the recording video in pixels
	Width int64                                                               `json:"width"`
	JSON  meetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodecH264 MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "H264"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodecVp8  MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "VP8"
)

func (MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark struct {
	// Position of the watermark
	Position MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
	// Size of the watermark
	Size MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
	// URL of the watermark image
	URL  string                                                                       `json:"url" format:"uri"`
	JSON meetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}

Watermark to be added to the recording

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition string

Position of the watermark

const (
	MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop     MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop    MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom  MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom"
	MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom"
)

func (MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height int64 `json:"height"`
	// Width of the watermark in px
	Width int64                                                                            `json:"width"`
	JSON  meetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}

Size of the watermark

func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataStatus added in v6.6.0

type MeetingReplaceMeetingByIDResponseDataStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	MeetingReplaceMeetingByIDResponseDataStatusActive   MeetingReplaceMeetingByIDResponseDataStatus = "ACTIVE"
	MeetingReplaceMeetingByIDResponseDataStatusInactive MeetingReplaceMeetingByIDResponseDataStatus = "INACTIVE"
)

func (MeetingReplaceMeetingByIDResponseDataStatus) IsKnown added in v6.6.0

type MeetingService added in v6.6.0

type MeetingService struct {
	Options []option.RequestOption
}

MeetingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewMeetingService method instead.

func NewMeetingService added in v6.6.0

func NewMeetingService(opts ...option.RequestOption) (r *MeetingService)

NewMeetingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*MeetingService) AddParticipant added in v6.6.0

func (r *MeetingService) AddParticipant(ctx context.Context, appID string, meetingID string, params MeetingAddParticipantParams, opts ...option.RequestOption) (res *MeetingAddParticipantResponse, err error)

Adds a participant to the given meeting ID.

func (*MeetingService) DeleteMeetingParticipant added in v6.6.0

func (r *MeetingService) DeleteMeetingParticipant(ctx context.Context, appID string, meetingID string, participantID string, body MeetingDeleteMeetingParticipantParams, opts ...option.RequestOption) (res *MeetingDeleteMeetingParticipantResponse, err error)

Deletes a participant for the given meeting and participant ID.

func (*MeetingService) EditParticipant added in v6.6.0

func (r *MeetingService) EditParticipant(ctx context.Context, appID string, meetingID string, participantID string, params MeetingEditParticipantParams, opts ...option.RequestOption) (res *MeetingEditParticipantResponse, err error)

Updates a participant's details for the given meeting and participant ID.

func (*MeetingService) Get added in v6.6.0

func (r *MeetingService) Get(ctx context.Context, appID string, params MeetingGetParams, opts ...option.RequestOption) (res *MeetingGetResponse, err error)

Returns all meetings for the given App ID.

func (*MeetingService) GetMeetingByID added in v6.6.0

func (r *MeetingService) GetMeetingByID(ctx context.Context, appID string, meetingID string, params MeetingGetMeetingByIDParams, opts ...option.RequestOption) (res *MeetingGetMeetingByIDResponse, err error)

Returns a meeting details in an App for the given meeting ID.

func (*MeetingService) GetMeetingParticipant added in v6.6.0

func (r *MeetingService) GetMeetingParticipant(ctx context.Context, appID string, meetingID string, participantID string, query MeetingGetMeetingParticipantParams, opts ...option.RequestOption) (res *MeetingGetMeetingParticipantResponse, err error)

Returns a participant details for the given meeting and participant ID.

func (*MeetingService) GetMeetingParticipants added in v6.6.0

func (r *MeetingService) GetMeetingParticipants(ctx context.Context, appID string, meetingID string, params MeetingGetMeetingParticipantsParams, opts ...option.RequestOption) (res *MeetingGetMeetingParticipantsResponse, err error)

Returns all participants detail for the given meeting ID.

func (*MeetingService) New added in v6.6.0

func (r *MeetingService) New(ctx context.Context, appID string, params MeetingNewParams, opts ...option.RequestOption) (res *MeetingNewResponse, err error)

Create a meeting for the given App ID.

func (*MeetingService) RefreshParticipantToken added in v6.6.0

func (r *MeetingService) RefreshParticipantToken(ctx context.Context, appID string, meetingID string, participantID string, body MeetingRefreshParticipantTokenParams, opts ...option.RequestOption) (res *MeetingRefreshParticipantTokenResponse, err error)

Regenerates participant's authentication token for the given meeting and participant ID.

func (*MeetingService) ReplaceMeetingByID added in v6.6.0

func (r *MeetingService) ReplaceMeetingByID(ctx context.Context, appID string, meetingID string, params MeetingReplaceMeetingByIDParams, opts ...option.RequestOption) (res *MeetingReplaceMeetingByIDResponse, err error)

Replaces all the details for the given meeting ID.

func (*MeetingService) UpdateMeetingByID added in v6.6.0

func (r *MeetingService) UpdateMeetingByID(ctx context.Context, appID string, meetingID string, params MeetingUpdateMeetingByIDParams, opts ...option.RequestOption) (res *MeetingUpdateMeetingByIDResponse, err error)

Updates a meeting in an App for the given meeting ID.

type MeetingUpdateMeetingByIDParams added in v6.6.0

type MeetingUpdateMeetingByIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig param.Field[MeetingUpdateMeetingByIDParamsAIConfig] `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart param.Field[bool] `json:"live_stream_on_start"`
	// If a meeting is updated to persist_chat, meeting chat would remain for a week
	// within the meeting space.
	PersistChat param.Field[bool] `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart param.Field[bool] `json:"record_on_start"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs param.Field[float64] `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status param.Field[MeetingUpdateMeetingByIDParamsStatus] `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd param.Field[bool] `json:"summarize_on_end"`
	// Title of the meeting
	Title param.Field[string] `json:"title"`
}

func (MeetingUpdateMeetingByIDParams) MarshalJSON added in v6.6.0

func (r MeetingUpdateMeetingByIDParams) MarshalJSON() (data []byte, err error)

type MeetingUpdateMeetingByIDParamsAIConfig added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfig struct {
	// Summary Config
	Summarization param.Field[MeetingUpdateMeetingByIDParamsAIConfigSummarization] `json:"summarization"`
	// Transcription Configurations
	Transcription param.Field[MeetingUpdateMeetingByIDParamsAIConfigTranscription] `json:"transcription"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (MeetingUpdateMeetingByIDParamsAIConfig) MarshalJSON added in v6.6.0

func (r MeetingUpdateMeetingByIDParamsAIConfig) MarshalJSON() (data []byte, err error)

type MeetingUpdateMeetingByIDParamsAIConfigSummarization added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType param.Field[MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType] `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat param.Field[MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat] `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit param.Field[int64] `json:"word_limit"`
}

Summary Config

func (MeetingUpdateMeetingByIDParamsAIConfigSummarization) MarshalJSON added in v6.6.0

func (r MeetingUpdateMeetingByIDParamsAIConfigSummarization) MarshalJSON() (data []byte, err error)

type MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeGeneral         MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "general"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeTeamMeeting     MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "team_meeting"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeSalesCall       MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "sales_call"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeClientCheckIn   MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "client_check_in"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeInterview       MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "interview"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeDailyStandup    MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "daily_standup"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeLecture         MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "lecture"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeCodeReview      MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormatPlainText MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat = "plain_text"
	MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormatMarkdown  MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigTranscription added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords param.Field[[]string] `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language param.Field[MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage] `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter param.Field[bool] `json:"profanity_filter"`
}

Transcription Configurations

func (MeetingUpdateMeetingByIDParamsAIConfigTranscription) MarshalJSON added in v6.6.0

func (r MeetingUpdateMeetingByIDParamsAIConfigTranscription) MarshalJSON() (data []byte, err error)

type MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage added in v6.6.0

type MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageEnUs MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "en-US"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageEnIn MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "en-IN"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageDe   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "de"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageHi   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "hi"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageSv   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "sv"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageRu   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "ru"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguagePl   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "pl"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageEl   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "el"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageFr   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "fr"
	MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageNl   MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "nl"
)

func (MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDParamsStatus added in v6.6.0

type MeetingUpdateMeetingByIDParamsStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	MeetingUpdateMeetingByIDParamsStatusActive   MeetingUpdateMeetingByIDParamsStatus = "ACTIVE"
	MeetingUpdateMeetingByIDParamsStatusInactive MeetingUpdateMeetingByIDParamsStatus = "INACTIVE"
)

func (MeetingUpdateMeetingByIDParamsStatus) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponse added in v6.6.0

type MeetingUpdateMeetingByIDResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data MeetingUpdateMeetingByIDResponseData `json:"data"`
	JSON meetingUpdateMeetingByIDResponseJSON `json:"-"`
}

func (*MeetingUpdateMeetingByIDResponse) UnmarshalJSON added in v6.6.0

func (r *MeetingUpdateMeetingByIDResponse) UnmarshalJSON(data []byte) (err error)

type MeetingUpdateMeetingByIDResponseData added in v6.6.0

type MeetingUpdateMeetingByIDResponseData struct {
	// ID of the meeting.
	ID string `json:"id,required" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// The AI Config allows you to customize the behavior of meeting transcriptions and
	// summaries
	AIConfig MeetingUpdateMeetingByIDResponseDataAIConfig `json:"ai_config"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart bool `json:"live_stream_on_start"`
	// Specifies if Chat within a meeting should persist for a week.
	PersistChat bool `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart bool `json:"record_on_start"`
	// Recording Configurations to be used for this meeting. This level of configs
	// takes higher preference over App level configs on the RealtimeKit developer
	// portal.
	RecordingConfig MeetingUpdateMeetingByIDResponseDataRecordingConfig `json:"recording_config"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status MeetingUpdateMeetingByIDResponseDataStatus `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd bool `json:"summarize_on_end"`
	// Title of the meeting.
	Title string                                   `json:"title"`
	JSON  meetingUpdateMeetingByIDResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*MeetingUpdateMeetingByIDResponseData) UnmarshalJSON added in v6.6.0

func (r *MeetingUpdateMeetingByIDResponseData) UnmarshalJSON(data []byte) (err error)

type MeetingUpdateMeetingByIDResponseDataAIConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfig struct {
	// Summary Config
	Summarization MeetingUpdateMeetingByIDResponseDataAIConfigSummarization `json:"summarization"`
	// Transcription Configurations
	Transcription MeetingUpdateMeetingByIDResponseDataAIConfigTranscription `json:"transcription"`
	JSON          meetingUpdateMeetingByIDResponseDataAIConfigJSON          `json:"-"`
}

The AI Config allows you to customize the behavior of meeting transcriptions and summaries

func (*MeetingUpdateMeetingByIDResponseDataAIConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingUpdateMeetingByIDResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)

type MeetingUpdateMeetingByIDResponseDataAIConfigSummarization added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigSummarization struct {
	// Defines the style of the summary, such as general, team meeting, or sales call.
	SummaryType MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
	// Determines the text format of the summary, such as plain text or markdown.
	TextFormat MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
	// Sets the maximum number of words in the meeting summary.
	WordLimit int64                                                         `json:"word_limit"`
	JSON      meetingUpdateMeetingByIDResponseDataAIConfigSummarizationJSON `json:"-"`
}

Summary Config

func (*MeetingUpdateMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType string

Defines the style of the summary, such as general, team meeting, or sales call.

const (
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeGeneral         MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "general"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeTeamMeeting     MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "team_meeting"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeSalesCall       MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "sales_call"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeClientCheckIn   MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "client_check_in"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeInterview       MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "interview"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeDailyStandup    MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "daily_standup"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeLecture         MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "lecture"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeCodeReview      MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "code_review"
)

func (MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat string

Determines the text format of the summary, such as plain text or markdown.

const (
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormatPlainText MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat = "plain_text"
	MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormatMarkdown  MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat = "markdown"
)

func (MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigTranscription added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigTranscription struct {
	// Adds specific terms to improve accurate detection during transcription.
	Keywords []string `json:"keywords"`
	// Specifies the language code for transcription to ensure accurate results.
	Language MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage `json:"language"`
	// Control the inclusion of offensive language in transcriptions.
	ProfanityFilter bool                                                          `json:"profanity_filter"`
	JSON            meetingUpdateMeetingByIDResponseDataAIConfigTranscriptionJSON `json:"-"`
}

Transcription Configurations

func (*MeetingUpdateMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage string

Specifies the language code for transcription to ensure accurate results.

const (
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageEnUs MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-US"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageEnIn MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-IN"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageDe   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "de"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageHi   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "hi"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageSv   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "sv"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageRu   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "ru"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguagePl   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "pl"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageEl   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "el"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageFr   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "fr"
	MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageNl   MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "nl"
)

func (MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfig struct {
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig `json:"audio_config"`
	// Adds a prefix to the beginning of the file name of the recording.
	FileNamePrefix      string                                                                 `json:"file_name_prefix"`
	LiveStreamingConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds              float64                                                                    `json:"max_seconds"`
	RealtimekitBucketConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
	StorageConfig           MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig           `json:"storage_config,nullable"`
	VideoConfig             MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig             `json:"video_config"`
	JSON                    meetingUpdateMeetingByIDResponseDataRecordingConfigJSON                    `json:"-"`
}

Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfig) UnmarshalJSON added in v6.6.0

func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)

type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile bool                                                               `json:"export_file"`
	JSON       meetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}

Object containing configuration regarding the audio that is being recorded.

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannelMono   MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "mono"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannelStereo MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "stereo"
)

func (MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodecMP3 MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "MP3"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodecAac MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "AAC"
)

func (MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig struct {
	// RTMP URL to stream to
	RtmpURL string                                                                     `json:"rtmp_url" format:"uri"`
	JSON    meetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled bool                                                                           `json:"enabled,required"`
	JSON    meetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig struct {
	// Type of storage media.
	Type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                               `json:"username"`
	JSON     meetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodKey      MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "KEY"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD"
)

func (MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType string

Type of storage media.

const (
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeAws          MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "aws"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeAzure        MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "azure"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "digitalocean"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeGcs          MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "gcs"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeSftp         MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "sftp"
)

func (MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile bool `json:"export_file"`
	// Height of the recording video in pixels
	Height int64 `json:"height"`
	// Watermark to be added to the recording
	Watermark MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
	// Width of the recording video in pixels
	Width int64                                                              `json:"width"`
	JSON  meetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodecH264 MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "H264"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodecVp8  MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "VP8"
)

func (MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark struct {
	// Position of the watermark
	Position MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
	// Size of the watermark
	Size MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
	// URL of the watermark image
	URL  string                                                                      `json:"url" format:"uri"`
	JSON meetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}

Watermark to be added to the recording

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition string

Position of the watermark

const (
	MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop     MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop    MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom  MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom"
	MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom"
)

func (MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height int64 `json:"height"`
	// Width of the watermark in px
	Width int64                                                                           `json:"width"`
	JSON  meetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}

Size of the watermark

func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataStatus added in v6.6.0

type MeetingUpdateMeetingByIDResponseDataStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	MeetingUpdateMeetingByIDResponseDataStatusActive   MeetingUpdateMeetingByIDResponseDataStatus = "ACTIVE"
	MeetingUpdateMeetingByIDResponseDataStatusInactive MeetingUpdateMeetingByIDResponseDataStatus = "INACTIVE"
)

func (MeetingUpdateMeetingByIDResponseDataStatus) IsKnown added in v6.6.0

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type PresetDeleteParams added in v6.6.0

type PresetDeleteParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PresetDeleteResponse added in v6.6.0

type PresetDeleteResponse struct {
	// Data returned by the operation
	Data PresetDeleteResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                     `json:"success,required"`
	JSON    presetDeleteResponseJSON `json:"-"`
}

func (*PresetDeleteResponse) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponse) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseData added in v6.6.0

type PresetDeleteResponseData struct {
	// ID of the preset
	ID     string                         `json:"id,required" format:"uuid"`
	Config PresetDeleteResponseDataConfig `json:"config,required"`
	// Name of the preset
	Name        string                              `json:"name,required"`
	UI          PresetDeleteResponseDataUI          `json:"ui,required"`
	Permissions PresetDeleteResponseDataPermissions `json:"permissions"`
	JSON        presetDeleteResponseDataJSON        `json:"-"`
}

Data returned by the operation

func (*PresetDeleteResponseData) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseData) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfig added in v6.6.0

type PresetDeleteResponseDataConfig struct {
	// Maximum number of screen shares that can be active at a given time
	MaxScreenshareCount int64 `json:"max_screenshare_count,required"`
	// Maximum number of streams that are visible on a device
	MaxVideoStreams PresetDeleteResponseDataConfigMaxVideoStreams `json:"max_video_streams,required"`
	// Media configuration options. eg: Video quality
	Media PresetDeleteResponseDataConfigMedia `json:"media,required"`
	// Type of the meeting
	ViewType PresetDeleteResponseDataConfigViewType `json:"view_type,required"`
	JSON     presetDeleteResponseDataConfigJSON     `json:"-"`
}

func (*PresetDeleteResponseDataConfig) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataConfig) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfigMaxVideoStreams added in v6.6.0

type PresetDeleteResponseDataConfigMaxVideoStreams struct {
	// Maximum number of video streams visible on desktop devices
	Desktop int64 `json:"desktop,required"`
	// Maximum number of streams visible on mobile devices
	Mobile int64                                             `json:"mobile,required"`
	JSON   presetDeleteResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}

Maximum number of streams that are visible on a device

func (*PresetDeleteResponseDataConfigMaxVideoStreams) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfigMedia added in v6.6.0

type PresetDeleteResponseDataConfigMedia struct {
	// Configuration options for participant screen shares
	Screenshare PresetDeleteResponseDataConfigMediaScreenshare `json:"screenshare,required"`
	// Configuration options for participant videos
	Video PresetDeleteResponseDataConfigMediaVideo `json:"video,required"`
	// Control options for Audio quality.
	Audio PresetDeleteResponseDataConfigMediaAudio `json:"audio"`
	JSON  presetDeleteResponseDataConfigMediaJSON  `json:"-"`
}

Media configuration options. eg: Video quality

func (*PresetDeleteResponseDataConfigMedia) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfigMediaAudio added in v6.6.0

type PresetDeleteResponseDataConfigMediaAudio struct {
	// Enable High Quality Audio for your meetings
	EnableHighBitrate bool `json:"enable_high_bitrate"`
	// Enable Stereo for your meetings
	EnableStereo bool                                         `json:"enable_stereo"`
	JSON         presetDeleteResponseDataConfigMediaAudioJSON `json:"-"`
}

Control options for Audio quality.

func (*PresetDeleteResponseDataConfigMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfigMediaScreenshare added in v6.6.0

type PresetDeleteResponseDataConfigMediaScreenshare struct {
	// Frame rate of screen share
	FrameRate int64 `json:"frame_rate,required"`
	// Quality of screen share
	Quality PresetDeleteResponseDataConfigMediaScreenshareQuality `json:"quality,required"`
	JSON    presetDeleteResponseDataConfigMediaScreenshareJSON    `json:"-"`
}

Configuration options for participant screen shares

func (*PresetDeleteResponseDataConfigMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfigMediaScreenshareQuality added in v6.6.0

type PresetDeleteResponseDataConfigMediaScreenshareQuality string

Quality of screen share

const (
	PresetDeleteResponseDataConfigMediaScreenshareQualityHD   PresetDeleteResponseDataConfigMediaScreenshareQuality = "hd"
	PresetDeleteResponseDataConfigMediaScreenshareQualityVga  PresetDeleteResponseDataConfigMediaScreenshareQuality = "vga"
	PresetDeleteResponseDataConfigMediaScreenshareQualityQvga PresetDeleteResponseDataConfigMediaScreenshareQuality = "qvga"
)

func (PresetDeleteResponseDataConfigMediaScreenshareQuality) IsKnown added in v6.6.0

type PresetDeleteResponseDataConfigMediaVideo added in v6.6.0

type PresetDeleteResponseDataConfigMediaVideo struct {
	// Frame rate of participants' video
	FrameRate int64 `json:"frame_rate,required"`
	// Video quality of participants
	Quality PresetDeleteResponseDataConfigMediaVideoQuality `json:"quality,required"`
	JSON    presetDeleteResponseDataConfigMediaVideoJSON    `json:"-"`
}

Configuration options for participant videos

func (*PresetDeleteResponseDataConfigMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataConfigMediaVideoQuality added in v6.6.0

type PresetDeleteResponseDataConfigMediaVideoQuality string

Video quality of participants

const (
	PresetDeleteResponseDataConfigMediaVideoQualityHD   PresetDeleteResponseDataConfigMediaVideoQuality = "hd"
	PresetDeleteResponseDataConfigMediaVideoQualityVga  PresetDeleteResponseDataConfigMediaVideoQuality = "vga"
	PresetDeleteResponseDataConfigMediaVideoQualityQvga PresetDeleteResponseDataConfigMediaVideoQuality = "qvga"
)

func (PresetDeleteResponseDataConfigMediaVideoQuality) IsKnown added in v6.6.0

type PresetDeleteResponseDataConfigViewType added in v6.6.0

type PresetDeleteResponseDataConfigViewType string

Type of the meeting

const (
	PresetDeleteResponseDataConfigViewTypeGroupCall PresetDeleteResponseDataConfigViewType = "GROUP_CALL"
	PresetDeleteResponseDataConfigViewTypeWebinar   PresetDeleteResponseDataConfigViewType = "WEBINAR"
	PresetDeleteResponseDataConfigViewTypeAudioRoom PresetDeleteResponseDataConfigViewType = "AUDIO_ROOM"
)

func (PresetDeleteResponseDataConfigViewType) IsKnown added in v6.6.0

type PresetDeleteResponseDataPermissions added in v6.6.0

type PresetDeleteResponseDataPermissions struct {
	// Whether this participant can accept waiting requests
	AcceptWaitingRequests           bool `json:"accept_waiting_requests,required"`
	CanAcceptProductionRequests     bool `json:"can_accept_production_requests,required"`
	CanChangeParticipantPermissions bool `json:"can_change_participant_permissions,required"`
	CanEditDisplayName              bool `json:"can_edit_display_name,required"`
	CanLivestream                   bool `json:"can_livestream,required"`
	CanRecord                       bool `json:"can_record,required"`
	CanSpotlight                    bool `json:"can_spotlight,required"`
	// Chat permissions
	Chat                            PresetDeleteResponseDataPermissionsChat              `json:"chat,required"`
	ConnectedMeetings               PresetDeleteResponseDataPermissionsConnectedMeetings `json:"connected_meetings,required"`
	DisableParticipantAudio         bool                                                 `json:"disable_participant_audio,required"`
	DisableParticipantScreensharing bool                                                 `json:"disable_participant_screensharing,required"`
	DisableParticipantVideo         bool                                                 `json:"disable_participant_video,required"`
	// Whether this participant is visible to others or not
	HiddenParticipant bool `json:"hidden_participant,required"`
	KickParticipant   bool `json:"kick_participant,required"`
	// Media permissions
	Media          PresetDeleteResponseDataPermissionsMedia `json:"media,required"`
	PinParticipant bool                                     `json:"pin_participant,required"`
	// Plugin permissions
	Plugins PresetDeleteResponseDataPermissionsPlugins `json:"plugins,required"`
	// Poll permissions
	Polls PresetDeleteResponseDataPermissionsPolls `json:"polls,required"`
	// Type of the recording peer
	RecorderType        PresetDeleteResponseDataPermissionsRecorderType `json:"recorder_type,required"`
	ShowParticipantList bool                                            `json:"show_participant_list,required"`
	// Waiting room type
	WaitingRoomType PresetDeleteResponseDataPermissionsWaitingRoomType `json:"waiting_room_type,required"`
	IsRecorder      bool                                               `json:"is_recorder"`
	JSON            presetDeleteResponseDataPermissionsJSON            `json:"-"`
}

func (*PresetDeleteResponseDataPermissions) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissions) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsChat added in v6.6.0

type PresetDeleteResponseDataPermissionsChat struct {
	Private PresetDeleteResponseDataPermissionsChatPrivate `json:"private,required"`
	Public  PresetDeleteResponseDataPermissionsChatPublic  `json:"public,required"`
	JSON    presetDeleteResponseDataPermissionsChatJSON    `json:"-"`
}

Chat permissions

func (*PresetDeleteResponseDataPermissionsChat) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsChatPrivate added in v6.6.0

type PresetDeleteResponseDataPermissionsChatPrivate struct {
	CanReceive bool                                               `json:"can_receive,required"`
	CanSend    bool                                               `json:"can_send,required"`
	Files      bool                                               `json:"files,required"`
	Text       bool                                               `json:"text,required"`
	JSON       presetDeleteResponseDataPermissionsChatPrivateJSON `json:"-"`
}

func (*PresetDeleteResponseDataPermissionsChatPrivate) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsChatPublic added in v6.6.0

type PresetDeleteResponseDataPermissionsChatPublic struct {
	// Can send messages in general
	CanSend bool `json:"can_send,required"`
	// Can send file messages
	Files bool `json:"files,required"`
	// Can send text messages
	Text bool                                              `json:"text,required"`
	JSON presetDeleteResponseDataPermissionsChatPublicJSON `json:"-"`
}

func (*PresetDeleteResponseDataPermissionsChatPublic) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsConnectedMeetings added in v6.6.0

type PresetDeleteResponseDataPermissionsConnectedMeetings struct {
	CanAlterConnectedMeetings  bool                                                     `json:"can_alter_connected_meetings,required"`
	CanSwitchConnectedMeetings bool                                                     `json:"can_switch_connected_meetings,required"`
	CanSwitchToParentMeeting   bool                                                     `json:"can_switch_to_parent_meeting,required"`
	JSON                       presetDeleteResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}

func (*PresetDeleteResponseDataPermissionsConnectedMeetings) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsMedia added in v6.6.0

type PresetDeleteResponseDataPermissionsMedia struct {
	// Audio permissions
	Audio PresetDeleteResponseDataPermissionsMediaAudio `json:"audio,required"`
	// Screenshare permissions
	Screenshare PresetDeleteResponseDataPermissionsMediaScreenshare `json:"screenshare,required"`
	// Video permissions
	Video PresetDeleteResponseDataPermissionsMediaVideo `json:"video,required"`
	JSON  presetDeleteResponseDataPermissionsMediaJSON  `json:"-"`
}

Media permissions

func (*PresetDeleteResponseDataPermissionsMedia) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsMediaAudio added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaAudio struct {
	// Can produce audio
	CanProduce PresetDeleteResponseDataPermissionsMediaAudioCanProduce `json:"can_produce,required"`
	JSON       presetDeleteResponseDataPermissionsMediaAudioJSON       `json:"-"`
}

Audio permissions

func (*PresetDeleteResponseDataPermissionsMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsMediaAudioCanProduce added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaAudioCanProduce string

Can produce audio

const (
	PresetDeleteResponseDataPermissionsMediaAudioCanProduceAllowed    PresetDeleteResponseDataPermissionsMediaAudioCanProduce = "ALLOWED"
	PresetDeleteResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetDeleteResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED"
	PresetDeleteResponseDataPermissionsMediaAudioCanProduceCanRequest PresetDeleteResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST"
)

func (PresetDeleteResponseDataPermissionsMediaAudioCanProduce) IsKnown added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaScreenshare added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaScreenshare struct {
	// Can produce screen share video
	CanProduce PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce `json:"can_produce,required"`
	JSON       presetDeleteResponseDataPermissionsMediaScreenshareJSON       `json:"-"`
}

Screenshare permissions

func (*PresetDeleteResponseDataPermissionsMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce string

Can produce screen share video

const (
	PresetDeleteResponseDataPermissionsMediaScreenshareCanProduceAllowed    PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce = "ALLOWED"
	PresetDeleteResponseDataPermissionsMediaScreenshareCanProduceNotAllowed PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce = "NOT_ALLOWED"
	PresetDeleteResponseDataPermissionsMediaScreenshareCanProduceCanRequest PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce = "CAN_REQUEST"
)

func (PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce) IsKnown added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaVideo added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaVideo struct {
	// Can produce video
	CanProduce PresetDeleteResponseDataPermissionsMediaVideoCanProduce `json:"can_produce,required"`
	JSON       presetDeleteResponseDataPermissionsMediaVideoJSON       `json:"-"`
}

Video permissions

func (*PresetDeleteResponseDataPermissionsMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsMediaVideoCanProduce added in v6.6.0

type PresetDeleteResponseDataPermissionsMediaVideoCanProduce string

Can produce video

const (
	PresetDeleteResponseDataPermissionsMediaVideoCanProduceAllowed    PresetDeleteResponseDataPermissionsMediaVideoCanProduce = "ALLOWED"
	PresetDeleteResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetDeleteResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED"
	PresetDeleteResponseDataPermissionsMediaVideoCanProduceCanRequest PresetDeleteResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST"
)

func (PresetDeleteResponseDataPermissionsMediaVideoCanProduce) IsKnown added in v6.6.0

type PresetDeleteResponseDataPermissionsPlugins added in v6.6.0

type PresetDeleteResponseDataPermissionsPlugins struct {
	// Can close plugins that are already open
	CanClose bool `json:"can_close,required"`
	// Can edit plugin config
	CanEditConfig bool `json:"can_edit_config,required"`
	// Can start plugins
	CanStart bool                                                  `json:"can_start,required"`
	Config   PresetDeleteResponseDataPermissionsPluginsConfigUnion `json:"config,required" format:"uuid"`
	JSON     presetDeleteResponseDataPermissionsPluginsJSON        `json:"-"`
}

Plugin permissions

func (*PresetDeleteResponseDataPermissionsPlugins) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsPluginsConfigObject added in v6.6.0

type PresetDeleteResponseDataPermissionsPluginsConfigObject struct {
	AccessControl   PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control,required"`
	HandlesViewOnly bool                                                                `json:"handles_view_only,required"`
	JSON            presetDeleteResponseDataPermissionsPluginsConfigObjectJSON          `json:"-"`
}

func (PresetDeleteResponseDataPermissionsPluginsConfigObject) ImplementsPresetDeleteResponseDataPermissionsPluginsConfigUnion added in v6.6.0

func (r PresetDeleteResponseDataPermissionsPluginsConfigObject) ImplementsPresetDeleteResponseDataPermissionsPluginsConfigUnion()

func (*PresetDeleteResponseDataPermissionsPluginsConfigObject) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl added in v6.6.0

type PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl string
const (
	PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS"
	PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly   PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY"
)

func (PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown added in v6.6.0

type PresetDeleteResponseDataPermissionsPluginsConfigUnion added in v6.6.0

type PresetDeleteResponseDataPermissionsPluginsConfigUnion interface {
	ImplementsPresetDeleteResponseDataPermissionsPluginsConfigUnion()
}

Union satisfied by shared.UnionString or PresetDeleteResponseDataPermissionsPluginsConfigObject.

type PresetDeleteResponseDataPermissionsPolls added in v6.6.0

type PresetDeleteResponseDataPermissionsPolls struct {
	// Can create polls
	CanCreate bool `json:"can_create,required"`
	// Can view polls
	CanView bool `json:"can_view,required"`
	// Can vote on polls
	CanVote bool                                         `json:"can_vote,required"`
	JSON    presetDeleteResponseDataPermissionsPollsJSON `json:"-"`
}

Poll permissions

func (*PresetDeleteResponseDataPermissionsPolls) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataPermissionsRecorderType added in v6.6.0

type PresetDeleteResponseDataPermissionsRecorderType string

Type of the recording peer

const (
	PresetDeleteResponseDataPermissionsRecorderTypeRecorder     PresetDeleteResponseDataPermissionsRecorderType = "RECORDER"
	PresetDeleteResponseDataPermissionsRecorderTypeLivestreamer PresetDeleteResponseDataPermissionsRecorderType = "LIVESTREAMER"
	PresetDeleteResponseDataPermissionsRecorderTypeNone         PresetDeleteResponseDataPermissionsRecorderType = "NONE"
)

func (PresetDeleteResponseDataPermissionsRecorderType) IsKnown added in v6.6.0

type PresetDeleteResponseDataPermissionsWaitingRoomType added in v6.6.0

type PresetDeleteResponseDataPermissionsWaitingRoomType string

Waiting room type

const (
	PresetDeleteResponseDataPermissionsWaitingRoomTypeSkip                  PresetDeleteResponseDataPermissionsWaitingRoomType = "SKIP"
	PresetDeleteResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetDeleteResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY"
	PresetDeleteResponseDataPermissionsWaitingRoomTypeSkipOnAccept          PresetDeleteResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT"
)

func (PresetDeleteResponseDataPermissionsWaitingRoomType) IsKnown added in v6.6.0

type PresetDeleteResponseDataUI added in v6.6.0

type PresetDeleteResponseDataUI struct {
	DesignTokens PresetDeleteResponseDataUIDesignTokens `json:"design_tokens,required"`
	ConfigDiff   interface{}                            `json:"config_diff"`
	JSON         presetDeleteResponseDataUIJSON         `json:"-"`
}

func (*PresetDeleteResponseDataUI) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataUI) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataUIDesignTokens added in v6.6.0

type PresetDeleteResponseDataUIDesignTokens struct {
	BorderRadius PresetDeleteResponseDataUIDesignTokensBorderRadius `json:"border_radius,required"`
	BorderWidth  PresetDeleteResponseDataUIDesignTokensBorderWidth  `json:"border_width,required"`
	Colors       PresetDeleteResponseDataUIDesignTokensColors       `json:"colors,required"`
	SpacingBase  float64                                            `json:"spacing_base,required"`
	Theme        PresetDeleteResponseDataUIDesignTokensTheme        `json:"theme,required"`
	JSON         presetDeleteResponseDataUIDesignTokensJSON         `json:"-"`
}

func (*PresetDeleteResponseDataUIDesignTokens) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataUIDesignTokensBorderRadius added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensBorderRadius string
const (
	PresetDeleteResponseDataUIDesignTokensBorderRadiusRounded PresetDeleteResponseDataUIDesignTokensBorderRadius = "rounded"
)

func (PresetDeleteResponseDataUIDesignTokensBorderRadius) IsKnown added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensBorderWidth added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensBorderWidth string
const (
	PresetDeleteResponseDataUIDesignTokensBorderWidthThin PresetDeleteResponseDataUIDesignTokensBorderWidth = "thin"
)

func (PresetDeleteResponseDataUIDesignTokensBorderWidth) IsKnown added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensColors added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensColors struct {
	Background  PresetDeleteResponseDataUIDesignTokensColorsBackground `json:"background,required"`
	Brand       PresetDeleteResponseDataUIDesignTokensColorsBrand      `json:"brand,required"`
	Danger      string                                                 `json:"danger,required"`
	Success     string                                                 `json:"success,required"`
	Text        string                                                 `json:"text,required"`
	TextOnBrand string                                                 `json:"text_on_brand,required"`
	VideoBg     string                                                 `json:"video_bg,required"`
	Warning     string                                                 `json:"warning,required"`
	JSON        presetDeleteResponseDataUIDesignTokensColorsJSON       `json:"-"`
}

func (*PresetDeleteResponseDataUIDesignTokensColors) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataUIDesignTokensColorsBackground added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensColorsBackground struct {
	Number1000 string                                                     `json:"1000,required"`
	Number600  string                                                     `json:"600,required"`
	Number700  string                                                     `json:"700,required"`
	Number800  string                                                     `json:"800,required"`
	Number900  string                                                     `json:"900,required"`
	JSON       presetDeleteResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}

func (*PresetDeleteResponseDataUIDesignTokensColorsBackground) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataUIDesignTokensColorsBrand added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensColorsBrand struct {
	Number300 string                                                `json:"300,required"`
	Number400 string                                                `json:"400,required"`
	Number500 string                                                `json:"500,required"`
	Number600 string                                                `json:"600,required"`
	Number700 string                                                `json:"700,required"`
	JSON      presetDeleteResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}

func (*PresetDeleteResponseDataUIDesignTokensColorsBrand) UnmarshalJSON added in v6.6.0

func (r *PresetDeleteResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)

type PresetDeleteResponseDataUIDesignTokensTheme added in v6.6.0

type PresetDeleteResponseDataUIDesignTokensTheme string
const (
	PresetDeleteResponseDataUIDesignTokensThemeDark PresetDeleteResponseDataUIDesignTokensTheme = "dark"
)

func (PresetDeleteResponseDataUIDesignTokensTheme) IsKnown added in v6.6.0

type PresetGetParams added in v6.6.0

type PresetGetParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[float64] `query:"page_no"`
	// Number of results per page
	PerPage param.Field[float64] `query:"per_page"`
}

func (PresetGetParams) URLQuery added in v6.6.0

func (r PresetGetParams) URLQuery() (v url.Values)

URLQuery serializes PresetGetParams's query parameters as `url.Values`.

type PresetGetPresetByIDParams added in v6.6.0

type PresetGetPresetByIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PresetGetPresetByIDResponse added in v6.6.0

type PresetGetPresetByIDResponse struct {
	// Data returned by the operation
	Data PresetGetPresetByIDResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                            `json:"success,required"`
	JSON    presetGetPresetByIDResponseJSON `json:"-"`
}

func (*PresetGetPresetByIDResponse) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponse) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseData added in v6.6.0

type PresetGetPresetByIDResponseData struct {
	// ID of the preset
	ID     string                                `json:"id,required" format:"uuid"`
	Config PresetGetPresetByIDResponseDataConfig `json:"config,required"`
	// Name of the preset
	Name        string                                     `json:"name,required"`
	UI          PresetGetPresetByIDResponseDataUI          `json:"ui,required"`
	Permissions PresetGetPresetByIDResponseDataPermissions `json:"permissions"`
	JSON        presetGetPresetByIDResponseDataJSON        `json:"-"`
}

Data returned by the operation

func (*PresetGetPresetByIDResponseData) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseData) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfig added in v6.6.0

type PresetGetPresetByIDResponseDataConfig struct {
	// Maximum number of screen shares that can be active at a given time
	MaxScreenshareCount int64 `json:"max_screenshare_count,required"`
	// Maximum number of streams that are visible on a device
	MaxVideoStreams PresetGetPresetByIDResponseDataConfigMaxVideoStreams `json:"max_video_streams,required"`
	// Media configuration options. eg: Video quality
	Media PresetGetPresetByIDResponseDataConfigMedia `json:"media,required"`
	// Type of the meeting
	ViewType PresetGetPresetByIDResponseDataConfigViewType `json:"view_type,required"`
	JSON     presetGetPresetByIDResponseDataConfigJSON     `json:"-"`
}

func (*PresetGetPresetByIDResponseDataConfig) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataConfig) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfigMaxVideoStreams added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMaxVideoStreams struct {
	// Maximum number of video streams visible on desktop devices
	Desktop int64 `json:"desktop,required"`
	// Maximum number of streams visible on mobile devices
	Mobile int64                                                    `json:"mobile,required"`
	JSON   presetGetPresetByIDResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}

Maximum number of streams that are visible on a device

func (*PresetGetPresetByIDResponseDataConfigMaxVideoStreams) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfigMedia added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMedia struct {
	// Configuration options for participant screen shares
	Screenshare PresetGetPresetByIDResponseDataConfigMediaScreenshare `json:"screenshare,required"`
	// Configuration options for participant videos
	Video PresetGetPresetByIDResponseDataConfigMediaVideo `json:"video,required"`
	// Control options for Audio quality.
	Audio PresetGetPresetByIDResponseDataConfigMediaAudio `json:"audio"`
	JSON  presetGetPresetByIDResponseDataConfigMediaJSON  `json:"-"`
}

Media configuration options. eg: Video quality

func (*PresetGetPresetByIDResponseDataConfigMedia) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfigMediaAudio added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMediaAudio struct {
	// Enable High Quality Audio for your meetings
	EnableHighBitrate bool `json:"enable_high_bitrate"`
	// Enable Stereo for your meetings
	EnableStereo bool                                                `json:"enable_stereo"`
	JSON         presetGetPresetByIDResponseDataConfigMediaAudioJSON `json:"-"`
}

Control options for Audio quality.

func (*PresetGetPresetByIDResponseDataConfigMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfigMediaScreenshare added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMediaScreenshare struct {
	// Frame rate of screen share
	FrameRate int64 `json:"frame_rate,required"`
	// Quality of screen share
	Quality PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality `json:"quality,required"`
	JSON    presetGetPresetByIDResponseDataConfigMediaScreenshareJSON    `json:"-"`
}

Configuration options for participant screen shares

func (*PresetGetPresetByIDResponseDataConfigMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality string

Quality of screen share

const (
	PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityHD   PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "hd"
	PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityVga  PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "vga"
	PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityQvga PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "qvga"
)

func (PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMediaVideo added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMediaVideo struct {
	// Frame rate of participants' video
	FrameRate int64 `json:"frame_rate,required"`
	// Video quality of participants
	Quality PresetGetPresetByIDResponseDataConfigMediaVideoQuality `json:"quality,required"`
	JSON    presetGetPresetByIDResponseDataConfigMediaVideoJSON    `json:"-"`
}

Configuration options for participant videos

func (*PresetGetPresetByIDResponseDataConfigMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataConfigMediaVideoQuality added in v6.6.0

type PresetGetPresetByIDResponseDataConfigMediaVideoQuality string

Video quality of participants

const (
	PresetGetPresetByIDResponseDataConfigMediaVideoQualityHD   PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "hd"
	PresetGetPresetByIDResponseDataConfigMediaVideoQualityVga  PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "vga"
	PresetGetPresetByIDResponseDataConfigMediaVideoQualityQvga PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "qvga"
)

func (PresetGetPresetByIDResponseDataConfigMediaVideoQuality) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataConfigViewType added in v6.6.0

type PresetGetPresetByIDResponseDataConfigViewType string

Type of the meeting

const (
	PresetGetPresetByIDResponseDataConfigViewTypeGroupCall PresetGetPresetByIDResponseDataConfigViewType = "GROUP_CALL"
	PresetGetPresetByIDResponseDataConfigViewTypeWebinar   PresetGetPresetByIDResponseDataConfigViewType = "WEBINAR"
	PresetGetPresetByIDResponseDataConfigViewTypeAudioRoom PresetGetPresetByIDResponseDataConfigViewType = "AUDIO_ROOM"
)

func (PresetGetPresetByIDResponseDataConfigViewType) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataPermissions added in v6.6.0

type PresetGetPresetByIDResponseDataPermissions struct {
	// Whether this participant can accept waiting requests
	AcceptWaitingRequests           bool `json:"accept_waiting_requests,required"`
	CanAcceptProductionRequests     bool `json:"can_accept_production_requests,required"`
	CanChangeParticipantPermissions bool `json:"can_change_participant_permissions,required"`
	CanEditDisplayName              bool `json:"can_edit_display_name,required"`
	CanLivestream                   bool `json:"can_livestream,required"`
	CanRecord                       bool `json:"can_record,required"`
	CanSpotlight                    bool `json:"can_spotlight,required"`
	// Chat permissions
	Chat                            PresetGetPresetByIDResponseDataPermissionsChat              `json:"chat,required"`
	ConnectedMeetings               PresetGetPresetByIDResponseDataPermissionsConnectedMeetings `json:"connected_meetings,required"`
	DisableParticipantAudio         bool                                                        `json:"disable_participant_audio,required"`
	DisableParticipantScreensharing bool                                                        `json:"disable_participant_screensharing,required"`
	DisableParticipantVideo         bool                                                        `json:"disable_participant_video,required"`
	// Whether this participant is visible to others or not
	HiddenParticipant bool `json:"hidden_participant,required"`
	KickParticipant   bool `json:"kick_participant,required"`
	// Media permissions
	Media          PresetGetPresetByIDResponseDataPermissionsMedia `json:"media,required"`
	PinParticipant bool                                            `json:"pin_participant,required"`
	// Plugin permissions
	Plugins PresetGetPresetByIDResponseDataPermissionsPlugins `json:"plugins,required"`
	// Poll permissions
	Polls PresetGetPresetByIDResponseDataPermissionsPolls `json:"polls,required"`
	// Type of the recording peer
	RecorderType        PresetGetPresetByIDResponseDataPermissionsRecorderType `json:"recorder_type,required"`
	ShowParticipantList bool                                                   `json:"show_participant_list,required"`
	// Waiting room type
	WaitingRoomType PresetGetPresetByIDResponseDataPermissionsWaitingRoomType `json:"waiting_room_type,required"`
	IsRecorder      bool                                                      `json:"is_recorder"`
	JSON            presetGetPresetByIDResponseDataPermissionsJSON            `json:"-"`
}

func (*PresetGetPresetByIDResponseDataPermissions) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissions) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsChat added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsChat struct {
	Private PresetGetPresetByIDResponseDataPermissionsChatPrivate `json:"private,required"`
	Public  PresetGetPresetByIDResponseDataPermissionsChatPublic  `json:"public,required"`
	JSON    presetGetPresetByIDResponseDataPermissionsChatJSON    `json:"-"`
}

Chat permissions

func (*PresetGetPresetByIDResponseDataPermissionsChat) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsChatPrivate added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsChatPrivate struct {
	CanReceive bool                                                      `json:"can_receive,required"`
	CanSend    bool                                                      `json:"can_send,required"`
	Files      bool                                                      `json:"files,required"`
	Text       bool                                                      `json:"text,required"`
	JSON       presetGetPresetByIDResponseDataPermissionsChatPrivateJSON `json:"-"`
}

func (*PresetGetPresetByIDResponseDataPermissionsChatPrivate) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsChatPublic added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsChatPublic struct {
	// Can send messages in general
	CanSend bool `json:"can_send,required"`
	// Can send file messages
	Files bool `json:"files,required"`
	// Can send text messages
	Text bool                                                     `json:"text,required"`
	JSON presetGetPresetByIDResponseDataPermissionsChatPublicJSON `json:"-"`
}

func (*PresetGetPresetByIDResponseDataPermissionsChatPublic) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsConnectedMeetings added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsConnectedMeetings struct {
	CanAlterConnectedMeetings  bool                                                            `json:"can_alter_connected_meetings,required"`
	CanSwitchConnectedMeetings bool                                                            `json:"can_switch_connected_meetings,required"`
	CanSwitchToParentMeeting   bool                                                            `json:"can_switch_to_parent_meeting,required"`
	JSON                       presetGetPresetByIDResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}

func (*PresetGetPresetByIDResponseDataPermissionsConnectedMeetings) UnmarshalJSON added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMedia added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMedia struct {
	// Audio permissions
	Audio PresetGetPresetByIDResponseDataPermissionsMediaAudio `json:"audio,required"`
	// Screenshare permissions
	Screenshare PresetGetPresetByIDResponseDataPermissionsMediaScreenshare `json:"screenshare,required"`
	// Video permissions
	Video PresetGetPresetByIDResponseDataPermissionsMediaVideo `json:"video,required"`
	JSON  presetGetPresetByIDResponseDataPermissionsMediaJSON  `json:"-"`
}

Media permissions

func (*PresetGetPresetByIDResponseDataPermissionsMedia) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsMediaAudio added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaAudio struct {
	// Can produce audio
	CanProduce PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce `json:"can_produce,required"`
	JSON       presetGetPresetByIDResponseDataPermissionsMediaAudioJSON       `json:"-"`
}

Audio permissions

func (*PresetGetPresetByIDResponseDataPermissionsMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce string

Can produce audio

const (
	PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceAllowed    PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "ALLOWED"
	PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED"
	PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST"
)

func (PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaScreenshare added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaScreenshare struct {
	// Can produce screen share video
	CanProduce PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce `json:"can_produce,required"`
	JSON       presetGetPresetByIDResponseDataPermissionsMediaScreenshareJSON       `json:"-"`
}

Screenshare permissions

func (*PresetGetPresetByIDResponseDataPermissionsMediaScreenshare) UnmarshalJSON added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce string

Can produce screen share video

const (
	PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduceAllowed    PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce = "ALLOWED"
	PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce = "NOT_ALLOWED"
	PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce = "CAN_REQUEST"
)

func (PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaVideo added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaVideo struct {
	// Can produce video
	CanProduce PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce `json:"can_produce,required"`
	JSON       presetGetPresetByIDResponseDataPermissionsMediaVideoJSON       `json:"-"`
}

Video permissions

func (*PresetGetPresetByIDResponseDataPermissionsMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce string

Can produce video

const (
	PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceAllowed    PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "ALLOWED"
	PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED"
	PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST"
)

func (PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPlugins added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPlugins struct {
	// Can close plugins that are already open
	CanClose bool `json:"can_close,required"`
	// Can edit plugin config
	CanEditConfig bool `json:"can_edit_config,required"`
	// Can start plugins
	CanStart bool                                                         `json:"can_start,required"`
	Config   PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion `json:"config,required" format:"uuid"`
	JSON     presetGetPresetByIDResponseDataPermissionsPluginsJSON        `json:"-"`
}

Plugin permissions

func (*PresetGetPresetByIDResponseDataPermissionsPlugins) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject struct {
	AccessControl   PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control,required"`
	HandlesViewOnly bool                                                                       `json:"handles_view_only,required"`
	JSON            presetGetPresetByIDResponseDataPermissionsPluginsConfigObjectJSON          `json:"-"`
}

func (PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) ImplementsPresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion added in v6.6.0

func (r PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) ImplementsPresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion()

func (*PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) UnmarshalJSON added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl string
const (
	PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS"
	PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly   PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY"
)

func (PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion interface {
	ImplementsPresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion()
}

Union satisfied by shared.UnionString or PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject.

type PresetGetPresetByIDResponseDataPermissionsPolls added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsPolls struct {
	// Can create polls
	CanCreate bool `json:"can_create,required"`
	// Can view polls
	CanView bool `json:"can_view,required"`
	// Can vote on polls
	CanVote bool                                                `json:"can_vote,required"`
	JSON    presetGetPresetByIDResponseDataPermissionsPollsJSON `json:"-"`
}

Poll permissions

func (*PresetGetPresetByIDResponseDataPermissionsPolls) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataPermissionsRecorderType added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsRecorderType string

Type of the recording peer

const (
	PresetGetPresetByIDResponseDataPermissionsRecorderTypeRecorder     PresetGetPresetByIDResponseDataPermissionsRecorderType = "RECORDER"
	PresetGetPresetByIDResponseDataPermissionsRecorderTypeLivestreamer PresetGetPresetByIDResponseDataPermissionsRecorderType = "LIVESTREAMER"
	PresetGetPresetByIDResponseDataPermissionsRecorderTypeNone         PresetGetPresetByIDResponseDataPermissionsRecorderType = "NONE"
)

func (PresetGetPresetByIDResponseDataPermissionsRecorderType) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsWaitingRoomType added in v6.6.0

type PresetGetPresetByIDResponseDataPermissionsWaitingRoomType string

Waiting room type

const (
	PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeSkip                  PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "SKIP"
	PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY"
	PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeSkipOnAccept          PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT"
)

func (PresetGetPresetByIDResponseDataPermissionsWaitingRoomType) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataUI added in v6.6.0

type PresetGetPresetByIDResponseDataUI struct {
	DesignTokens PresetGetPresetByIDResponseDataUIDesignTokens `json:"design_tokens,required"`
	ConfigDiff   interface{}                                   `json:"config_diff"`
	JSON         presetGetPresetByIDResponseDataUIJSON         `json:"-"`
}

func (*PresetGetPresetByIDResponseDataUI) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataUI) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataUIDesignTokens added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokens struct {
	BorderRadius PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius `json:"border_radius,required"`
	BorderWidth  PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth  `json:"border_width,required"`
	Colors       PresetGetPresetByIDResponseDataUIDesignTokensColors       `json:"colors,required"`
	SpacingBase  float64                                                   `json:"spacing_base,required"`
	Theme        PresetGetPresetByIDResponseDataUIDesignTokensTheme        `json:"theme,required"`
	JSON         presetGetPresetByIDResponseDataUIDesignTokensJSON         `json:"-"`
}

func (*PresetGetPresetByIDResponseDataUIDesignTokens) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius string
const (
	PresetGetPresetByIDResponseDataUIDesignTokensBorderRadiusRounded PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius = "rounded"
)

func (PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth string
const (
	PresetGetPresetByIDResponseDataUIDesignTokensBorderWidthThin PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth = "thin"
)

func (PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth) IsKnown added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensColors added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensColors struct {
	Background  PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground `json:"background,required"`
	Brand       PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand      `json:"brand,required"`
	Danger      string                                                        `json:"danger,required"`
	Success     string                                                        `json:"success,required"`
	Text        string                                                        `json:"text,required"`
	TextOnBrand string                                                        `json:"text_on_brand,required"`
	VideoBg     string                                                        `json:"video_bg,required"`
	Warning     string                                                        `json:"warning,required"`
	JSON        presetGetPresetByIDResponseDataUIDesignTokensColorsJSON       `json:"-"`
}

func (*PresetGetPresetByIDResponseDataUIDesignTokensColors) UnmarshalJSON added in v6.6.0

func (r *PresetGetPresetByIDResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)

type PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground struct {
	Number1000 string                                                            `json:"1000,required"`
	Number600  string                                                            `json:"600,required"`
	Number700  string                                                            `json:"700,required"`
	Number800  string                                                            `json:"800,required"`
	Number900  string                                                            `json:"900,required"`
	JSON       presetGetPresetByIDResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}

func (*PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground) UnmarshalJSON added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand struct {
	Number300 string                                                       `json:"300,required"`
	Number400 string                                                       `json:"400,required"`
	Number500 string                                                       `json:"500,required"`
	Number600 string                                                       `json:"600,required"`
	Number700 string                                                       `json:"700,required"`
	JSON      presetGetPresetByIDResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}

func (*PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand) UnmarshalJSON added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensTheme added in v6.6.0

type PresetGetPresetByIDResponseDataUIDesignTokensTheme string
const (
	PresetGetPresetByIDResponseDataUIDesignTokensThemeDark PresetGetPresetByIDResponseDataUIDesignTokensTheme = "dark"
)

func (PresetGetPresetByIDResponseDataUIDesignTokensTheme) IsKnown added in v6.6.0

type PresetGetResponse added in v6.6.0

type PresetGetResponse struct {
	Data    []PresetGetResponseData `json:"data,required"`
	Paging  PresetGetResponsePaging `json:"paging,required"`
	Success bool                    `json:"success,required"`
	JSON    presetGetResponseJSON   `json:"-"`
}

func (*PresetGetResponse) UnmarshalJSON added in v6.6.0

func (r *PresetGetResponse) UnmarshalJSON(data []byte) (err error)

type PresetGetResponseData added in v6.6.0

type PresetGetResponseData struct {
	// ID of the preset
	ID string `json:"id" format:"uuid"`
	// Timestamp this preset was created at
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Name of the preset
	Name string `json:"name"`
	// Timestamp this preset was last updated
	UpdatedAt time.Time                 `json:"updated_at" format:"date-time"`
	JSON      presetGetResponseDataJSON `json:"-"`
}

Returned by Get All Presets route

func (*PresetGetResponseData) UnmarshalJSON added in v6.6.0

func (r *PresetGetResponseData) UnmarshalJSON(data []byte) (err error)

type PresetGetResponsePaging added in v6.6.0

type PresetGetResponsePaging struct {
	EndOffset   float64                     `json:"end_offset,required"`
	StartOffset float64                     `json:"start_offset,required"`
	TotalCount  float64                     `json:"total_count,required"`
	JSON        presetGetResponsePagingJSON `json:"-"`
}

func (*PresetGetResponsePaging) UnmarshalJSON added in v6.6.0

func (r *PresetGetResponsePaging) UnmarshalJSON(data []byte) (err error)

type PresetNewParams added in v6.6.0

type PresetNewParams struct {
	// The account identifier tag.
	AccountID param.Field[string]                `path:"account_id,required"`
	Config    param.Field[PresetNewParamsConfig] `json:"config,required"`
	// Name of the preset
	Name        param.Field[string]                     `json:"name,required"`
	UI          param.Field[PresetNewParamsUI]          `json:"ui,required"`
	Permissions param.Field[PresetNewParamsPermissions] `json:"permissions"`
}

func (PresetNewParams) MarshalJSON added in v6.6.0

func (r PresetNewParams) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfig added in v6.6.0

type PresetNewParamsConfig struct {
	// Maximum number of screen shares that can be active at a given time
	MaxScreenshareCount param.Field[int64] `json:"max_screenshare_count,required"`
	// Maximum number of streams that are visible on a device
	MaxVideoStreams param.Field[PresetNewParamsConfigMaxVideoStreams] `json:"max_video_streams,required"`
	// Media configuration options. eg: Video quality
	Media param.Field[PresetNewParamsConfigMedia] `json:"media,required"`
	// Type of the meeting
	ViewType param.Field[PresetNewParamsConfigViewType] `json:"view_type,required"`
}

func (PresetNewParamsConfig) MarshalJSON added in v6.6.0

func (r PresetNewParamsConfig) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfigMaxVideoStreams added in v6.6.0

type PresetNewParamsConfigMaxVideoStreams struct {
	// Maximum number of video streams visible on desktop devices
	Desktop param.Field[int64] `json:"desktop,required"`
	// Maximum number of streams visible on mobile devices
	Mobile param.Field[int64] `json:"mobile,required"`
}

Maximum number of streams that are visible on a device

func (PresetNewParamsConfigMaxVideoStreams) MarshalJSON added in v6.6.0

func (r PresetNewParamsConfigMaxVideoStreams) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfigMedia added in v6.6.0

type PresetNewParamsConfigMedia struct {
	// Configuration options for participant screen shares
	Screenshare param.Field[PresetNewParamsConfigMediaScreenshare] `json:"screenshare,required"`
	// Configuration options for participant videos
	Video param.Field[PresetNewParamsConfigMediaVideo] `json:"video,required"`
	// Control options for Audio quality.
	Audio param.Field[PresetNewParamsConfigMediaAudio] `json:"audio"`
}

Media configuration options. eg: Video quality

func (PresetNewParamsConfigMedia) MarshalJSON added in v6.6.0

func (r PresetNewParamsConfigMedia) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfigMediaAudio added in v6.6.0

type PresetNewParamsConfigMediaAudio struct {
	// Enable High Quality Audio for your meetings
	EnableHighBitrate param.Field[bool] `json:"enable_high_bitrate"`
	// Enable Stereo for your meetings
	EnableStereo param.Field[bool] `json:"enable_stereo"`
}

Control options for Audio quality.

func (PresetNewParamsConfigMediaAudio) MarshalJSON added in v6.6.0

func (r PresetNewParamsConfigMediaAudio) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfigMediaScreenshare added in v6.6.0

type PresetNewParamsConfigMediaScreenshare struct {
	// Frame rate of screen share
	FrameRate param.Field[int64] `json:"frame_rate,required"`
	// Quality of screen share
	Quality param.Field[PresetNewParamsConfigMediaScreenshareQuality] `json:"quality,required"`
}

Configuration options for participant screen shares

func (PresetNewParamsConfigMediaScreenshare) MarshalJSON added in v6.6.0

func (r PresetNewParamsConfigMediaScreenshare) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfigMediaScreenshareQuality added in v6.6.0

type PresetNewParamsConfigMediaScreenshareQuality string

Quality of screen share

const (
	PresetNewParamsConfigMediaScreenshareQualityHD   PresetNewParamsConfigMediaScreenshareQuality = "hd"
	PresetNewParamsConfigMediaScreenshareQualityVga  PresetNewParamsConfigMediaScreenshareQuality = "vga"
	PresetNewParamsConfigMediaScreenshareQualityQvga PresetNewParamsConfigMediaScreenshareQuality = "qvga"
)

func (PresetNewParamsConfigMediaScreenshareQuality) IsKnown added in v6.6.0

type PresetNewParamsConfigMediaVideo added in v6.6.0

type PresetNewParamsConfigMediaVideo struct {
	// Frame rate of participants' video
	FrameRate param.Field[int64] `json:"frame_rate,required"`
	// Video quality of participants
	Quality param.Field[PresetNewParamsConfigMediaVideoQuality] `json:"quality,required"`
}

Configuration options for participant videos

func (PresetNewParamsConfigMediaVideo) MarshalJSON added in v6.6.0

func (r PresetNewParamsConfigMediaVideo) MarshalJSON() (data []byte, err error)

type PresetNewParamsConfigMediaVideoQuality added in v6.6.0

type PresetNewParamsConfigMediaVideoQuality string

Video quality of participants

const (
	PresetNewParamsConfigMediaVideoQualityHD   PresetNewParamsConfigMediaVideoQuality = "hd"
	PresetNewParamsConfigMediaVideoQualityVga  PresetNewParamsConfigMediaVideoQuality = "vga"
	PresetNewParamsConfigMediaVideoQualityQvga PresetNewParamsConfigMediaVideoQuality = "qvga"
)

func (PresetNewParamsConfigMediaVideoQuality) IsKnown added in v6.6.0

type PresetNewParamsConfigViewType added in v6.6.0

type PresetNewParamsConfigViewType string

Type of the meeting

const (
	PresetNewParamsConfigViewTypeGroupCall PresetNewParamsConfigViewType = "GROUP_CALL"
	PresetNewParamsConfigViewTypeWebinar   PresetNewParamsConfigViewType = "WEBINAR"
	PresetNewParamsConfigViewTypeAudioRoom PresetNewParamsConfigViewType = "AUDIO_ROOM"
)

func (PresetNewParamsConfigViewType) IsKnown added in v6.6.0

func (r PresetNewParamsConfigViewType) IsKnown() bool

type PresetNewParamsPermissions added in v6.6.0

type PresetNewParamsPermissions struct {
	// Whether this participant can accept waiting requests
	AcceptWaitingRequests           param.Field[bool] `json:"accept_waiting_requests,required"`
	CanAcceptProductionRequests     param.Field[bool] `json:"can_accept_production_requests,required"`
	CanChangeParticipantPermissions param.Field[bool] `json:"can_change_participant_permissions,required"`
	CanEditDisplayName              param.Field[bool] `json:"can_edit_display_name,required"`
	CanLivestream                   param.Field[bool] `json:"can_livestream,required"`
	CanRecord                       param.Field[bool] `json:"can_record,required"`
	CanSpotlight                    param.Field[bool] `json:"can_spotlight,required"`
	// Chat permissions
	Chat                            param.Field[PresetNewParamsPermissionsChat]              `json:"chat,required"`
	ConnectedMeetings               param.Field[PresetNewParamsPermissionsConnectedMeetings] `json:"connected_meetings,required"`
	DisableParticipantAudio         param.Field[bool]                                        `json:"disable_participant_audio,required"`
	DisableParticipantScreensharing param.Field[bool]                                        `json:"disable_participant_screensharing,required"`
	DisableParticipantVideo         param.Field[bool]                                        `json:"disable_participant_video,required"`
	// Whether this participant is visible to others or not
	HiddenParticipant param.Field[bool] `json:"hidden_participant,required"`
	KickParticipant   param.Field[bool] `json:"kick_participant,required"`
	// Media permissions
	Media          param.Field[PresetNewParamsPermissionsMedia] `json:"media,required"`
	PinParticipant param.Field[bool]                            `json:"pin_participant,required"`
	// Plugin permissions
	Plugins param.Field[PresetNewParamsPermissionsPlugins] `json:"plugins,required"`
	// Poll permissions
	Polls param.Field[PresetNewParamsPermissionsPolls] `json:"polls,required"`
	// Type of the recording peer
	RecorderType        param.Field[PresetNewParamsPermissionsRecorderType] `json:"recorder_type,required"`
	ShowParticipantList param.Field[bool]                                   `json:"show_participant_list,required"`
	// Waiting room type
	WaitingRoomType param.Field[PresetNewParamsPermissionsWaitingRoomType] `json:"waiting_room_type,required"`
	IsRecorder      param.Field[bool]                                      `json:"is_recorder"`
}

func (PresetNewParamsPermissions) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissions) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsChat added in v6.6.0

type PresetNewParamsPermissionsChat struct {
	Private param.Field[PresetNewParamsPermissionsChatPrivate] `json:"private,required"`
	Public  param.Field[PresetNewParamsPermissionsChatPublic]  `json:"public,required"`
}

Chat permissions

func (PresetNewParamsPermissionsChat) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsChat) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsChatPrivate added in v6.6.0

type PresetNewParamsPermissionsChatPrivate struct {
	CanReceive param.Field[bool] `json:"can_receive,required"`
	CanSend    param.Field[bool] `json:"can_send,required"`
	Files      param.Field[bool] `json:"files,required"`
	Text       param.Field[bool] `json:"text,required"`
}

func (PresetNewParamsPermissionsChatPrivate) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsChatPrivate) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsChatPublic added in v6.6.0

type PresetNewParamsPermissionsChatPublic struct {
	// Can send messages in general
	CanSend param.Field[bool] `json:"can_send,required"`
	// Can send file messages
	Files param.Field[bool] `json:"files,required"`
	// Can send text messages
	Text param.Field[bool] `json:"text,required"`
}

func (PresetNewParamsPermissionsChatPublic) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsChatPublic) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsConnectedMeetings added in v6.6.0

type PresetNewParamsPermissionsConnectedMeetings struct {
	CanAlterConnectedMeetings  param.Field[bool] `json:"can_alter_connected_meetings,required"`
	CanSwitchConnectedMeetings param.Field[bool] `json:"can_switch_connected_meetings,required"`
	CanSwitchToParentMeeting   param.Field[bool] `json:"can_switch_to_parent_meeting,required"`
}

func (PresetNewParamsPermissionsConnectedMeetings) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsConnectedMeetings) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsMedia added in v6.6.0

type PresetNewParamsPermissionsMedia struct {
	// Audio permissions
	Audio param.Field[PresetNewParamsPermissionsMediaAudio] `json:"audio,required"`
	// Screenshare permissions
	Screenshare param.Field[PresetNewParamsPermissionsMediaScreenshare] `json:"screenshare,required"`
	// Video permissions
	Video param.Field[PresetNewParamsPermissionsMediaVideo] `json:"video,required"`
}

Media permissions

func (PresetNewParamsPermissionsMedia) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsMedia) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsMediaAudio added in v6.6.0

type PresetNewParamsPermissionsMediaAudio struct {
	// Can produce audio
	CanProduce param.Field[PresetNewParamsPermissionsMediaAudioCanProduce] `json:"can_produce,required"`
}

Audio permissions

func (PresetNewParamsPermissionsMediaAudio) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsMediaAudio) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsMediaAudioCanProduce added in v6.6.0

type PresetNewParamsPermissionsMediaAudioCanProduce string

Can produce audio

const (
	PresetNewParamsPermissionsMediaAudioCanProduceAllowed    PresetNewParamsPermissionsMediaAudioCanProduce = "ALLOWED"
	PresetNewParamsPermissionsMediaAudioCanProduceNotAllowed PresetNewParamsPermissionsMediaAudioCanProduce = "NOT_ALLOWED"
	PresetNewParamsPermissionsMediaAudioCanProduceCanRequest PresetNewParamsPermissionsMediaAudioCanProduce = "CAN_REQUEST"
)

func (PresetNewParamsPermissionsMediaAudioCanProduce) IsKnown added in v6.6.0

type PresetNewParamsPermissionsMediaScreenshare added in v6.6.0

type PresetNewParamsPermissionsMediaScreenshare struct {
	// Can produce screen share video
	CanProduce param.Field[PresetNewParamsPermissionsMediaScreenshareCanProduce] `json:"can_produce,required"`
}

Screenshare permissions

func (PresetNewParamsPermissionsMediaScreenshare) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsMediaScreenshare) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsMediaScreenshareCanProduce added in v6.6.0

type PresetNewParamsPermissionsMediaScreenshareCanProduce string

Can produce screen share video

const (
	PresetNewParamsPermissionsMediaScreenshareCanProduceAllowed    PresetNewParamsPermissionsMediaScreenshareCanProduce = "ALLOWED"
	PresetNewParamsPermissionsMediaScreenshareCanProduceNotAllowed PresetNewParamsPermissionsMediaScreenshareCanProduce = "NOT_ALLOWED"
	PresetNewParamsPermissionsMediaScreenshareCanProduceCanRequest PresetNewParamsPermissionsMediaScreenshareCanProduce = "CAN_REQUEST"
)

func (PresetNewParamsPermissionsMediaScreenshareCanProduce) IsKnown added in v6.6.0

type PresetNewParamsPermissionsMediaVideo added in v6.6.0

type PresetNewParamsPermissionsMediaVideo struct {
	// Can produce video
	CanProduce param.Field[PresetNewParamsPermissionsMediaVideoCanProduce] `json:"can_produce,required"`
}

Video permissions

func (PresetNewParamsPermissionsMediaVideo) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsMediaVideo) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsMediaVideoCanProduce added in v6.6.0

type PresetNewParamsPermissionsMediaVideoCanProduce string

Can produce video

const (
	PresetNewParamsPermissionsMediaVideoCanProduceAllowed    PresetNewParamsPermissionsMediaVideoCanProduce = "ALLOWED"
	PresetNewParamsPermissionsMediaVideoCanProduceNotAllowed PresetNewParamsPermissionsMediaVideoCanProduce = "NOT_ALLOWED"
	PresetNewParamsPermissionsMediaVideoCanProduceCanRequest PresetNewParamsPermissionsMediaVideoCanProduce = "CAN_REQUEST"
)

func (PresetNewParamsPermissionsMediaVideoCanProduce) IsKnown added in v6.6.0

type PresetNewParamsPermissionsPlugins added in v6.6.0

type PresetNewParamsPermissionsPlugins struct {
	// Can close plugins that are already open
	CanClose param.Field[bool] `json:"can_close,required"`
	// Can edit plugin config
	CanEditConfig param.Field[bool] `json:"can_edit_config,required"`
	// Can start plugins
	CanStart param.Field[bool]                                         `json:"can_start,required"`
	Config   param.Field[PresetNewParamsPermissionsPluginsConfigUnion] `json:"config,required" format:"uuid"`
}

Plugin permissions

func (PresetNewParamsPermissionsPlugins) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsPlugins) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsPluginsConfigObject added in v6.6.0

type PresetNewParamsPermissionsPluginsConfigObject struct {
	AccessControl   param.Field[PresetNewParamsPermissionsPluginsConfigObjectAccessControl] `json:"access_control,required"`
	HandlesViewOnly param.Field[bool]                                                       `json:"handles_view_only,required"`
}

func (PresetNewParamsPermissionsPluginsConfigObject) ImplementsPresetNewParamsPermissionsPluginsConfigUnion added in v6.6.0

func (r PresetNewParamsPermissionsPluginsConfigObject) ImplementsPresetNewParamsPermissionsPluginsConfigUnion()

func (PresetNewParamsPermissionsPluginsConfigObject) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsPluginsConfigObject) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsPluginsConfigObjectAccessControl added in v6.6.0

type PresetNewParamsPermissionsPluginsConfigObjectAccessControl string
const (
	PresetNewParamsPermissionsPluginsConfigObjectAccessControlFullAccess PresetNewParamsPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS"
	PresetNewParamsPermissionsPluginsConfigObjectAccessControlViewOnly   PresetNewParamsPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY"
)

func (PresetNewParamsPermissionsPluginsConfigObjectAccessControl) IsKnown added in v6.6.0

type PresetNewParamsPermissionsPluginsConfigUnion added in v6.6.0

type PresetNewParamsPermissionsPluginsConfigUnion interface {
	ImplementsPresetNewParamsPermissionsPluginsConfigUnion()
}

Satisfied by shared.UnionString, realtime_kit.PresetNewParamsPermissionsPluginsConfigObject.

type PresetNewParamsPermissionsPolls added in v6.6.0

type PresetNewParamsPermissionsPolls struct {
	// Can create polls
	CanCreate param.Field[bool] `json:"can_create,required"`
	// Can view polls
	CanView param.Field[bool] `json:"can_view,required"`
	// Can vote on polls
	CanVote param.Field[bool] `json:"can_vote,required"`
}

Poll permissions

func (PresetNewParamsPermissionsPolls) MarshalJSON added in v6.6.0

func (r PresetNewParamsPermissionsPolls) MarshalJSON() (data []byte, err error)

type PresetNewParamsPermissionsRecorderType added in v6.6.0

type PresetNewParamsPermissionsRecorderType string

Type of the recording peer

const (
	PresetNewParamsPermissionsRecorderTypeRecorder     PresetNewParamsPermissionsRecorderType = "RECORDER"
	PresetNewParamsPermissionsRecorderTypeLivestreamer PresetNewParamsPermissionsRecorderType = "LIVESTREAMER"
	PresetNewParamsPermissionsRecorderTypeNone         PresetNewParamsPermissionsRecorderType = "NONE"
)

func (PresetNewParamsPermissionsRecorderType) IsKnown added in v6.6.0

type PresetNewParamsPermissionsWaitingRoomType added in v6.6.0

type PresetNewParamsPermissionsWaitingRoomType string

Waiting room type

const (
	PresetNewParamsPermissionsWaitingRoomTypeSkip                  PresetNewParamsPermissionsWaitingRoomType = "SKIP"
	PresetNewParamsPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetNewParamsPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY"
	PresetNewParamsPermissionsWaitingRoomTypeSkipOnAccept          PresetNewParamsPermissionsWaitingRoomType = "SKIP_ON_ACCEPT"
)

func (PresetNewParamsPermissionsWaitingRoomType) IsKnown added in v6.6.0

type PresetNewParamsUI added in v6.6.0

type PresetNewParamsUI struct {
	DesignTokens param.Field[PresetNewParamsUIDesignTokens] `json:"design_tokens,required"`
	ConfigDiff   param.Field[interface{}]                   `json:"config_diff"`
}

func (PresetNewParamsUI) MarshalJSON added in v6.6.0

func (r PresetNewParamsUI) MarshalJSON() (data []byte, err error)

type PresetNewParamsUIDesignTokens added in v6.6.0

type PresetNewParamsUIDesignTokens struct {
	BorderRadius param.Field[PresetNewParamsUIDesignTokensBorderRadius] `json:"border_radius,required"`
	BorderWidth  param.Field[PresetNewParamsUIDesignTokensBorderWidth]  `json:"border_width,required"`
	Colors       param.Field[PresetNewParamsUIDesignTokensColors]       `json:"colors,required"`
	SpacingBase  param.Field[float64]                                   `json:"spacing_base,required"`
	Theme        param.Field[PresetNewParamsUIDesignTokensTheme]        `json:"theme,required"`
}

func (PresetNewParamsUIDesignTokens) MarshalJSON added in v6.6.0

func (r PresetNewParamsUIDesignTokens) MarshalJSON() (data []byte, err error)

type PresetNewParamsUIDesignTokensBorderRadius added in v6.6.0

type PresetNewParamsUIDesignTokensBorderRadius string
const (
	PresetNewParamsUIDesignTokensBorderRadiusRounded PresetNewParamsUIDesignTokensBorderRadius = "rounded"
)

func (PresetNewParamsUIDesignTokensBorderRadius) IsKnown added in v6.6.0

type PresetNewParamsUIDesignTokensBorderWidth added in v6.6.0

type PresetNewParamsUIDesignTokensBorderWidth string
const (
	PresetNewParamsUIDesignTokensBorderWidthThin PresetNewParamsUIDesignTokensBorderWidth = "thin"
)

func (PresetNewParamsUIDesignTokensBorderWidth) IsKnown added in v6.6.0

type PresetNewParamsUIDesignTokensColors added in v6.6.0

type PresetNewParamsUIDesignTokensColors struct {
	Background  param.Field[PresetNewParamsUIDesignTokensColorsBackground] `json:"background,required"`
	Brand       param.Field[PresetNewParamsUIDesignTokensColorsBrand]      `json:"brand,required"`
	Danger      param.Field[string]                                        `json:"danger,required"`
	Success     param.Field[string]                                        `json:"success,required"`
	Text        param.Field[string]                                        `json:"text,required"`
	TextOnBrand param.Field[string]                                        `json:"text_on_brand,required"`
	VideoBg     param.Field[string]                                        `json:"video_bg,required"`
	Warning     param.Field[string]                                        `json:"warning,required"`
}

func (PresetNewParamsUIDesignTokensColors) MarshalJSON added in v6.6.0

func (r PresetNewParamsUIDesignTokensColors) MarshalJSON() (data []byte, err error)

type PresetNewParamsUIDesignTokensColorsBackground added in v6.6.0

type PresetNewParamsUIDesignTokensColorsBackground struct {
	Number1000 param.Field[string] `json:"1000,required"`
	Number600  param.Field[string] `json:"600,required"`
	Number700  param.Field[string] `json:"700,required"`
	Number800  param.Field[string] `json:"800,required"`
	Number900  param.Field[string] `json:"900,required"`
}

func (PresetNewParamsUIDesignTokensColorsBackground) MarshalJSON added in v6.6.0

func (r PresetNewParamsUIDesignTokensColorsBackground) MarshalJSON() (data []byte, err error)

type PresetNewParamsUIDesignTokensColorsBrand added in v6.6.0

type PresetNewParamsUIDesignTokensColorsBrand struct {
	Number300 param.Field[string] `json:"300,required"`
	Number400 param.Field[string] `json:"400,required"`
	Number500 param.Field[string] `json:"500,required"`
	Number600 param.Field[string] `json:"600,required"`
	Number700 param.Field[string] `json:"700,required"`
}

func (PresetNewParamsUIDesignTokensColorsBrand) MarshalJSON added in v6.6.0

func (r PresetNewParamsUIDesignTokensColorsBrand) MarshalJSON() (data []byte, err error)

type PresetNewParamsUIDesignTokensTheme added in v6.6.0

type PresetNewParamsUIDesignTokensTheme string
const (
	PresetNewParamsUIDesignTokensThemeDark PresetNewParamsUIDesignTokensTheme = "dark"
)

func (PresetNewParamsUIDesignTokensTheme) IsKnown added in v6.6.0

type PresetNewResponse added in v6.6.0

type PresetNewResponse struct {
	// Data returned by the operation
	Data PresetNewResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                  `json:"success,required"`
	JSON    presetNewResponseJSON `json:"-"`
}

func (*PresetNewResponse) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponse) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseData added in v6.6.0

type PresetNewResponseData struct {
	// ID of the preset
	ID     string                      `json:"id,required" format:"uuid"`
	Config PresetNewResponseDataConfig `json:"config,required"`
	// Name of the preset
	Name        string                           `json:"name,required"`
	UI          PresetNewResponseDataUI          `json:"ui,required"`
	Permissions PresetNewResponseDataPermissions `json:"permissions"`
	JSON        presetNewResponseDataJSON        `json:"-"`
}

Data returned by the operation

func (*PresetNewResponseData) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseData) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfig added in v6.6.0

type PresetNewResponseDataConfig struct {
	// Maximum number of screen shares that can be active at a given time
	MaxScreenshareCount int64 `json:"max_screenshare_count,required"`
	// Maximum number of streams that are visible on a device
	MaxVideoStreams PresetNewResponseDataConfigMaxVideoStreams `json:"max_video_streams,required"`
	// Media configuration options. eg: Video quality
	Media PresetNewResponseDataConfigMedia `json:"media,required"`
	// Type of the meeting
	ViewType PresetNewResponseDataConfigViewType `json:"view_type,required"`
	JSON     presetNewResponseDataConfigJSON     `json:"-"`
}

func (*PresetNewResponseDataConfig) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataConfig) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfigMaxVideoStreams added in v6.6.0

type PresetNewResponseDataConfigMaxVideoStreams struct {
	// Maximum number of video streams visible on desktop devices
	Desktop int64 `json:"desktop,required"`
	// Maximum number of streams visible on mobile devices
	Mobile int64                                          `json:"mobile,required"`
	JSON   presetNewResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}

Maximum number of streams that are visible on a device

func (*PresetNewResponseDataConfigMaxVideoStreams) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfigMedia added in v6.6.0

type PresetNewResponseDataConfigMedia struct {
	// Configuration options for participant screen shares
	Screenshare PresetNewResponseDataConfigMediaScreenshare `json:"screenshare,required"`
	// Configuration options for participant videos
	Video PresetNewResponseDataConfigMediaVideo `json:"video,required"`
	// Control options for Audio quality.
	Audio PresetNewResponseDataConfigMediaAudio `json:"audio"`
	JSON  presetNewResponseDataConfigMediaJSON  `json:"-"`
}

Media configuration options. eg: Video quality

func (*PresetNewResponseDataConfigMedia) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfigMediaAudio added in v6.6.0

type PresetNewResponseDataConfigMediaAudio struct {
	// Enable High Quality Audio for your meetings
	EnableHighBitrate bool `json:"enable_high_bitrate"`
	// Enable Stereo for your meetings
	EnableStereo bool                                      `json:"enable_stereo"`
	JSON         presetNewResponseDataConfigMediaAudioJSON `json:"-"`
}

Control options for Audio quality.

func (*PresetNewResponseDataConfigMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfigMediaScreenshare added in v6.6.0

type PresetNewResponseDataConfigMediaScreenshare struct {
	// Frame rate of screen share
	FrameRate int64 `json:"frame_rate,required"`
	// Quality of screen share
	Quality PresetNewResponseDataConfigMediaScreenshareQuality `json:"quality,required"`
	JSON    presetNewResponseDataConfigMediaScreenshareJSON    `json:"-"`
}

Configuration options for participant screen shares

func (*PresetNewResponseDataConfigMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfigMediaScreenshareQuality added in v6.6.0

type PresetNewResponseDataConfigMediaScreenshareQuality string

Quality of screen share

const (
	PresetNewResponseDataConfigMediaScreenshareQualityHD   PresetNewResponseDataConfigMediaScreenshareQuality = "hd"
	PresetNewResponseDataConfigMediaScreenshareQualityVga  PresetNewResponseDataConfigMediaScreenshareQuality = "vga"
	PresetNewResponseDataConfigMediaScreenshareQualityQvga PresetNewResponseDataConfigMediaScreenshareQuality = "qvga"
)

func (PresetNewResponseDataConfigMediaScreenshareQuality) IsKnown added in v6.6.0

type PresetNewResponseDataConfigMediaVideo added in v6.6.0

type PresetNewResponseDataConfigMediaVideo struct {
	// Frame rate of participants' video
	FrameRate int64 `json:"frame_rate,required"`
	// Video quality of participants
	Quality PresetNewResponseDataConfigMediaVideoQuality `json:"quality,required"`
	JSON    presetNewResponseDataConfigMediaVideoJSON    `json:"-"`
}

Configuration options for participant videos

func (*PresetNewResponseDataConfigMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataConfigMediaVideoQuality added in v6.6.0

type PresetNewResponseDataConfigMediaVideoQuality string

Video quality of participants

const (
	PresetNewResponseDataConfigMediaVideoQualityHD   PresetNewResponseDataConfigMediaVideoQuality = "hd"
	PresetNewResponseDataConfigMediaVideoQualityVga  PresetNewResponseDataConfigMediaVideoQuality = "vga"
	PresetNewResponseDataConfigMediaVideoQualityQvga PresetNewResponseDataConfigMediaVideoQuality = "qvga"
)

func (PresetNewResponseDataConfigMediaVideoQuality) IsKnown added in v6.6.0

type PresetNewResponseDataConfigViewType added in v6.6.0

type PresetNewResponseDataConfigViewType string

Type of the meeting

const (
	PresetNewResponseDataConfigViewTypeGroupCall PresetNewResponseDataConfigViewType = "GROUP_CALL"
	PresetNewResponseDataConfigViewTypeWebinar   PresetNewResponseDataConfigViewType = "WEBINAR"
	PresetNewResponseDataConfigViewTypeAudioRoom PresetNewResponseDataConfigViewType = "AUDIO_ROOM"
)

func (PresetNewResponseDataConfigViewType) IsKnown added in v6.6.0

type PresetNewResponseDataPermissions added in v6.6.0

type PresetNewResponseDataPermissions struct {
	// Whether this participant can accept waiting requests
	AcceptWaitingRequests           bool `json:"accept_waiting_requests,required"`
	CanAcceptProductionRequests     bool `json:"can_accept_production_requests,required"`
	CanChangeParticipantPermissions bool `json:"can_change_participant_permissions,required"`
	CanEditDisplayName              bool `json:"can_edit_display_name,required"`
	CanLivestream                   bool `json:"can_livestream,required"`
	CanRecord                       bool `json:"can_record,required"`
	CanSpotlight                    bool `json:"can_spotlight,required"`
	// Chat permissions
	Chat                            PresetNewResponseDataPermissionsChat              `json:"chat,required"`
	ConnectedMeetings               PresetNewResponseDataPermissionsConnectedMeetings `json:"connected_meetings,required"`
	DisableParticipantAudio         bool                                              `json:"disable_participant_audio,required"`
	DisableParticipantScreensharing bool                                              `json:"disable_participant_screensharing,required"`
	DisableParticipantVideo         bool                                              `json:"disable_participant_video,required"`
	// Whether this participant is visible to others or not
	HiddenParticipant bool `json:"hidden_participant,required"`
	KickParticipant   bool `json:"kick_participant,required"`
	// Media permissions
	Media          PresetNewResponseDataPermissionsMedia `json:"media,required"`
	PinParticipant bool                                  `json:"pin_participant,required"`
	// Plugin permissions
	Plugins PresetNewResponseDataPermissionsPlugins `json:"plugins,required"`
	// Poll permissions
	Polls PresetNewResponseDataPermissionsPolls `json:"polls,required"`
	// Type of the recording peer
	RecorderType        PresetNewResponseDataPermissionsRecorderType `json:"recorder_type,required"`
	ShowParticipantList bool                                         `json:"show_participant_list,required"`
	// Waiting room type
	WaitingRoomType PresetNewResponseDataPermissionsWaitingRoomType `json:"waiting_room_type,required"`
	IsRecorder      bool                                            `json:"is_recorder"`
	JSON            presetNewResponseDataPermissionsJSON            `json:"-"`
}

func (*PresetNewResponseDataPermissions) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissions) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsChat added in v6.6.0

type PresetNewResponseDataPermissionsChat struct {
	Private PresetNewResponseDataPermissionsChatPrivate `json:"private,required"`
	Public  PresetNewResponseDataPermissionsChatPublic  `json:"public,required"`
	JSON    presetNewResponseDataPermissionsChatJSON    `json:"-"`
}

Chat permissions

func (*PresetNewResponseDataPermissionsChat) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsChatPrivate added in v6.6.0

type PresetNewResponseDataPermissionsChatPrivate struct {
	CanReceive bool                                            `json:"can_receive,required"`
	CanSend    bool                                            `json:"can_send,required"`
	Files      bool                                            `json:"files,required"`
	Text       bool                                            `json:"text,required"`
	JSON       presetNewResponseDataPermissionsChatPrivateJSON `json:"-"`
}

func (*PresetNewResponseDataPermissionsChatPrivate) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsChatPublic added in v6.6.0

type PresetNewResponseDataPermissionsChatPublic struct {
	// Can send messages in general
	CanSend bool `json:"can_send,required"`
	// Can send file messages
	Files bool `json:"files,required"`
	// Can send text messages
	Text bool                                           `json:"text,required"`
	JSON presetNewResponseDataPermissionsChatPublicJSON `json:"-"`
}

func (*PresetNewResponseDataPermissionsChatPublic) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsConnectedMeetings added in v6.6.0

type PresetNewResponseDataPermissionsConnectedMeetings struct {
	CanAlterConnectedMeetings  bool                                                  `json:"can_alter_connected_meetings,required"`
	CanSwitchConnectedMeetings bool                                                  `json:"can_switch_connected_meetings,required"`
	CanSwitchToParentMeeting   bool                                                  `json:"can_switch_to_parent_meeting,required"`
	JSON                       presetNewResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}

func (*PresetNewResponseDataPermissionsConnectedMeetings) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsMedia added in v6.6.0

type PresetNewResponseDataPermissionsMedia struct {
	// Audio permissions
	Audio PresetNewResponseDataPermissionsMediaAudio `json:"audio,required"`
	// Screenshare permissions
	Screenshare PresetNewResponseDataPermissionsMediaScreenshare `json:"screenshare,required"`
	// Video permissions
	Video PresetNewResponseDataPermissionsMediaVideo `json:"video,required"`
	JSON  presetNewResponseDataPermissionsMediaJSON  `json:"-"`
}

Media permissions

func (*PresetNewResponseDataPermissionsMedia) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsMediaAudio added in v6.6.0

type PresetNewResponseDataPermissionsMediaAudio struct {
	// Can produce audio
	CanProduce PresetNewResponseDataPermissionsMediaAudioCanProduce `json:"can_produce,required"`
	JSON       presetNewResponseDataPermissionsMediaAudioJSON       `json:"-"`
}

Audio permissions

func (*PresetNewResponseDataPermissionsMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsMediaAudioCanProduce added in v6.6.0

type PresetNewResponseDataPermissionsMediaAudioCanProduce string

Can produce audio

const (
	PresetNewResponseDataPermissionsMediaAudioCanProduceAllowed    PresetNewResponseDataPermissionsMediaAudioCanProduce = "ALLOWED"
	PresetNewResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetNewResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED"
	PresetNewResponseDataPermissionsMediaAudioCanProduceCanRequest PresetNewResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST"
)

func (PresetNewResponseDataPermissionsMediaAudioCanProduce) IsKnown added in v6.6.0

type PresetNewResponseDataPermissionsMediaScreenshare added in v6.6.0

type PresetNewResponseDataPermissionsMediaScreenshare struct {
	// Can produce screen share video
	CanProduce PresetNewResponseDataPermissionsMediaScreenshareCanProduce `json:"can_produce,required"`
	JSON       presetNewResponseDataPermissionsMediaScreenshareJSON       `json:"-"`
}

Screenshare permissions

func (*PresetNewResponseDataPermissionsMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsMediaScreenshareCanProduce added in v6.6.0

type PresetNewResponseDataPermissionsMediaScreenshareCanProduce string

Can produce screen share video

const (
	PresetNewResponseDataPermissionsMediaScreenshareCanProduceAllowed    PresetNewResponseDataPermissionsMediaScreenshareCanProduce = "ALLOWED"
	PresetNewResponseDataPermissionsMediaScreenshareCanProduceNotAllowed PresetNewResponseDataPermissionsMediaScreenshareCanProduce = "NOT_ALLOWED"
	PresetNewResponseDataPermissionsMediaScreenshareCanProduceCanRequest PresetNewResponseDataPermissionsMediaScreenshareCanProduce = "CAN_REQUEST"
)

func (PresetNewResponseDataPermissionsMediaScreenshareCanProduce) IsKnown added in v6.6.0

type PresetNewResponseDataPermissionsMediaVideo added in v6.6.0

type PresetNewResponseDataPermissionsMediaVideo struct {
	// Can produce video
	CanProduce PresetNewResponseDataPermissionsMediaVideoCanProduce `json:"can_produce,required"`
	JSON       presetNewResponseDataPermissionsMediaVideoJSON       `json:"-"`
}

Video permissions

func (*PresetNewResponseDataPermissionsMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsMediaVideoCanProduce added in v6.6.0

type PresetNewResponseDataPermissionsMediaVideoCanProduce string

Can produce video

const (
	PresetNewResponseDataPermissionsMediaVideoCanProduceAllowed    PresetNewResponseDataPermissionsMediaVideoCanProduce = "ALLOWED"
	PresetNewResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetNewResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED"
	PresetNewResponseDataPermissionsMediaVideoCanProduceCanRequest PresetNewResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST"
)

func (PresetNewResponseDataPermissionsMediaVideoCanProduce) IsKnown added in v6.6.0

type PresetNewResponseDataPermissionsPlugins added in v6.6.0

type PresetNewResponseDataPermissionsPlugins struct {
	// Can close plugins that are already open
	CanClose bool `json:"can_close,required"`
	// Can edit plugin config
	CanEditConfig bool `json:"can_edit_config,required"`
	// Can start plugins
	CanStart bool                                               `json:"can_start,required"`
	Config   PresetNewResponseDataPermissionsPluginsConfigUnion `json:"config,required" format:"uuid"`
	JSON     presetNewResponseDataPermissionsPluginsJSON        `json:"-"`
}

Plugin permissions

func (*PresetNewResponseDataPermissionsPlugins) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsPluginsConfigObject added in v6.6.0

type PresetNewResponseDataPermissionsPluginsConfigObject struct {
	AccessControl   PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control,required"`
	HandlesViewOnly bool                                                             `json:"handles_view_only,required"`
	JSON            presetNewResponseDataPermissionsPluginsConfigObjectJSON          `json:"-"`
}

func (PresetNewResponseDataPermissionsPluginsConfigObject) ImplementsPresetNewResponseDataPermissionsPluginsConfigUnion added in v6.6.0

func (r PresetNewResponseDataPermissionsPluginsConfigObject) ImplementsPresetNewResponseDataPermissionsPluginsConfigUnion()

func (*PresetNewResponseDataPermissionsPluginsConfigObject) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl added in v6.6.0

type PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl string
const (
	PresetNewResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS"
	PresetNewResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly   PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY"
)

func (PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown added in v6.6.0

type PresetNewResponseDataPermissionsPluginsConfigUnion added in v6.6.0

type PresetNewResponseDataPermissionsPluginsConfigUnion interface {
	ImplementsPresetNewResponseDataPermissionsPluginsConfigUnion()
}

Union satisfied by shared.UnionString or PresetNewResponseDataPermissionsPluginsConfigObject.

type PresetNewResponseDataPermissionsPolls added in v6.6.0

type PresetNewResponseDataPermissionsPolls struct {
	// Can create polls
	CanCreate bool `json:"can_create,required"`
	// Can view polls
	CanView bool `json:"can_view,required"`
	// Can vote on polls
	CanVote bool                                      `json:"can_vote,required"`
	JSON    presetNewResponseDataPermissionsPollsJSON `json:"-"`
}

Poll permissions

func (*PresetNewResponseDataPermissionsPolls) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataPermissionsRecorderType added in v6.6.0

type PresetNewResponseDataPermissionsRecorderType string

Type of the recording peer

const (
	PresetNewResponseDataPermissionsRecorderTypeRecorder     PresetNewResponseDataPermissionsRecorderType = "RECORDER"
	PresetNewResponseDataPermissionsRecorderTypeLivestreamer PresetNewResponseDataPermissionsRecorderType = "LIVESTREAMER"
	PresetNewResponseDataPermissionsRecorderTypeNone         PresetNewResponseDataPermissionsRecorderType = "NONE"
)

func (PresetNewResponseDataPermissionsRecorderType) IsKnown added in v6.6.0

type PresetNewResponseDataPermissionsWaitingRoomType added in v6.6.0

type PresetNewResponseDataPermissionsWaitingRoomType string

Waiting room type

const (
	PresetNewResponseDataPermissionsWaitingRoomTypeSkip                  PresetNewResponseDataPermissionsWaitingRoomType = "SKIP"
	PresetNewResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetNewResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY"
	PresetNewResponseDataPermissionsWaitingRoomTypeSkipOnAccept          PresetNewResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT"
)

func (PresetNewResponseDataPermissionsWaitingRoomType) IsKnown added in v6.6.0

type PresetNewResponseDataUI added in v6.6.0

type PresetNewResponseDataUI struct {
	DesignTokens PresetNewResponseDataUIDesignTokens `json:"design_tokens,required"`
	ConfigDiff   interface{}                         `json:"config_diff"`
	JSON         presetNewResponseDataUIJSON         `json:"-"`
}

func (*PresetNewResponseDataUI) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataUI) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataUIDesignTokens added in v6.6.0

type PresetNewResponseDataUIDesignTokens struct {
	BorderRadius PresetNewResponseDataUIDesignTokensBorderRadius `json:"border_radius,required"`
	BorderWidth  PresetNewResponseDataUIDesignTokensBorderWidth  `json:"border_width,required"`
	Colors       PresetNewResponseDataUIDesignTokensColors       `json:"colors,required"`
	SpacingBase  float64                                         `json:"spacing_base,required"`
	Theme        PresetNewResponseDataUIDesignTokensTheme        `json:"theme,required"`
	JSON         presetNewResponseDataUIDesignTokensJSON         `json:"-"`
}

func (*PresetNewResponseDataUIDesignTokens) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataUIDesignTokensBorderRadius added in v6.6.0

type PresetNewResponseDataUIDesignTokensBorderRadius string
const (
	PresetNewResponseDataUIDesignTokensBorderRadiusRounded PresetNewResponseDataUIDesignTokensBorderRadius = "rounded"
)

func (PresetNewResponseDataUIDesignTokensBorderRadius) IsKnown added in v6.6.0

type PresetNewResponseDataUIDesignTokensBorderWidth added in v6.6.0

type PresetNewResponseDataUIDesignTokensBorderWidth string
const (
	PresetNewResponseDataUIDesignTokensBorderWidthThin PresetNewResponseDataUIDesignTokensBorderWidth = "thin"
)

func (PresetNewResponseDataUIDesignTokensBorderWidth) IsKnown added in v6.6.0

type PresetNewResponseDataUIDesignTokensColors added in v6.6.0

type PresetNewResponseDataUIDesignTokensColors struct {
	Background  PresetNewResponseDataUIDesignTokensColorsBackground `json:"background,required"`
	Brand       PresetNewResponseDataUIDesignTokensColorsBrand      `json:"brand,required"`
	Danger      string                                              `json:"danger,required"`
	Success     string                                              `json:"success,required"`
	Text        string                                              `json:"text,required"`
	TextOnBrand string                                              `json:"text_on_brand,required"`
	VideoBg     string                                              `json:"video_bg,required"`
	Warning     string                                              `json:"warning,required"`
	JSON        presetNewResponseDataUIDesignTokensColorsJSON       `json:"-"`
}

func (*PresetNewResponseDataUIDesignTokensColors) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataUIDesignTokensColorsBackground added in v6.6.0

type PresetNewResponseDataUIDesignTokensColorsBackground struct {
	Number1000 string                                                  `json:"1000,required"`
	Number600  string                                                  `json:"600,required"`
	Number700  string                                                  `json:"700,required"`
	Number800  string                                                  `json:"800,required"`
	Number900  string                                                  `json:"900,required"`
	JSON       presetNewResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}

func (*PresetNewResponseDataUIDesignTokensColorsBackground) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataUIDesignTokensColorsBrand added in v6.6.0

type PresetNewResponseDataUIDesignTokensColorsBrand struct {
	Number300 string                                             `json:"300,required"`
	Number400 string                                             `json:"400,required"`
	Number500 string                                             `json:"500,required"`
	Number600 string                                             `json:"600,required"`
	Number700 string                                             `json:"700,required"`
	JSON      presetNewResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}

func (*PresetNewResponseDataUIDesignTokensColorsBrand) UnmarshalJSON added in v6.6.0

func (r *PresetNewResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)

type PresetNewResponseDataUIDesignTokensTheme added in v6.6.0

type PresetNewResponseDataUIDesignTokensTheme string
const (
	PresetNewResponseDataUIDesignTokensThemeDark PresetNewResponseDataUIDesignTokensTheme = "dark"
)

func (PresetNewResponseDataUIDesignTokensTheme) IsKnown added in v6.6.0

type PresetService added in v6.6.0

type PresetService struct {
	Options []option.RequestOption
}

PresetService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPresetService method instead.

func NewPresetService added in v6.6.0

func NewPresetService(opts ...option.RequestOption) (r *PresetService)

NewPresetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PresetService) Delete added in v6.6.0

func (r *PresetService) Delete(ctx context.Context, appID string, presetID string, body PresetDeleteParams, opts ...option.RequestOption) (res *PresetDeleteResponse, err error)

Deletes a preset using the provided preset ID

func (*PresetService) Get added in v6.6.0

func (r *PresetService) Get(ctx context.Context, appID string, params PresetGetParams, opts ...option.RequestOption) (res *PresetGetResponse, err error)

Fetches all the presets belonging to an App.

func (*PresetService) GetPresetByID added in v6.6.0

func (r *PresetService) GetPresetByID(ctx context.Context, appID string, presetID string, query PresetGetPresetByIDParams, opts ...option.RequestOption) (res *PresetGetPresetByIDResponse, err error)

Fetches details of a preset using the provided preset ID

func (*PresetService) New added in v6.6.0

func (r *PresetService) New(ctx context.Context, appID string, params PresetNewParams, opts ...option.RequestOption) (res *PresetNewResponse, err error)

Creates a preset belonging to the current App

func (*PresetService) Update added in v6.6.0

func (r *PresetService) Update(ctx context.Context, appID string, presetID string, params PresetUpdateParams, opts ...option.RequestOption) (res *PresetUpdateResponse, err error)

Update a preset by the provided preset ID

type PresetUpdateParams added in v6.6.0

type PresetUpdateParams struct {
	// The account identifier tag.
	AccountID param.Field[string]                   `path:"account_id,required"`
	Config    param.Field[PresetUpdateParamsConfig] `json:"config"`
	// Name of the preset
	Name        param.Field[string]                        `json:"name"`
	Permissions param.Field[PresetUpdateParamsPermissions] `json:"permissions"`
	UI          param.Field[PresetUpdateParamsUI]          `json:"ui"`
}

func (PresetUpdateParams) MarshalJSON added in v6.6.0

func (r PresetUpdateParams) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsConfig added in v6.6.0

type PresetUpdateParamsConfig struct {
	// Maximum number of screen shares that can be active at a given time
	MaxScreenshareCount param.Field[int64] `json:"max_screenshare_count"`
	// Maximum number of streams that are visible on a device
	MaxVideoStreams param.Field[PresetUpdateParamsConfigMaxVideoStreams] `json:"max_video_streams"`
	// Media configuration options. eg: Video quality
	Media param.Field[PresetUpdateParamsConfigMedia] `json:"media"`
	// Type of the meeting
	ViewType param.Field[PresetUpdateParamsConfigViewType] `json:"view_type"`
}

func (PresetUpdateParamsConfig) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsConfig) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsConfigMaxVideoStreams added in v6.6.0

type PresetUpdateParamsConfigMaxVideoStreams struct {
	// Maximum number of video streams visible on desktop devices
	Desktop param.Field[int64] `json:"desktop"`
	// Maximum number of streams visible on mobile devices
	Mobile param.Field[int64] `json:"mobile"`
}

Maximum number of streams that are visible on a device

func (PresetUpdateParamsConfigMaxVideoStreams) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsConfigMaxVideoStreams) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsConfigMedia added in v6.6.0

type PresetUpdateParamsConfigMedia struct {
	// Configuration options for participant screen shares
	Screenshare param.Field[PresetUpdateParamsConfigMediaScreenshare] `json:"screenshare"`
	// Configuration options for participant videos
	Video param.Field[PresetUpdateParamsConfigMediaVideo] `json:"video"`
}

Media configuration options. eg: Video quality

func (PresetUpdateParamsConfigMedia) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsConfigMedia) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsConfigMediaScreenshare added in v6.6.0

type PresetUpdateParamsConfigMediaScreenshare struct {
	// Frame rate of screen share
	FrameRate param.Field[int64] `json:"frame_rate"`
	// Quality of screen share
	Quality param.Field[PresetUpdateParamsConfigMediaScreenshareQuality] `json:"quality"`
}

Configuration options for participant screen shares

func (PresetUpdateParamsConfigMediaScreenshare) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsConfigMediaScreenshare) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsConfigMediaScreenshareQuality added in v6.6.0

type PresetUpdateParamsConfigMediaScreenshareQuality string

Quality of screen share

const (
	PresetUpdateParamsConfigMediaScreenshareQualityHD   PresetUpdateParamsConfigMediaScreenshareQuality = "hd"
	PresetUpdateParamsConfigMediaScreenshareQualityVga  PresetUpdateParamsConfigMediaScreenshareQuality = "vga"
	PresetUpdateParamsConfigMediaScreenshareQualityQvga PresetUpdateParamsConfigMediaScreenshareQuality = "qvga"
)

func (PresetUpdateParamsConfigMediaScreenshareQuality) IsKnown added in v6.6.0

type PresetUpdateParamsConfigMediaVideo added in v6.6.0

type PresetUpdateParamsConfigMediaVideo struct {
	// Frame rate of participants' video
	FrameRate param.Field[int64] `json:"frame_rate"`
	// Video quality of participants
	Quality param.Field[PresetUpdateParamsConfigMediaVideoQuality] `json:"quality"`
}

Configuration options for participant videos

func (PresetUpdateParamsConfigMediaVideo) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsConfigMediaVideo) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsConfigMediaVideoQuality added in v6.6.0

type PresetUpdateParamsConfigMediaVideoQuality string

Video quality of participants

const (
	PresetUpdateParamsConfigMediaVideoQualityHD   PresetUpdateParamsConfigMediaVideoQuality = "hd"
	PresetUpdateParamsConfigMediaVideoQualityVga  PresetUpdateParamsConfigMediaVideoQuality = "vga"
	PresetUpdateParamsConfigMediaVideoQualityQvga PresetUpdateParamsConfigMediaVideoQuality = "qvga"
)

func (PresetUpdateParamsConfigMediaVideoQuality) IsKnown added in v6.6.0

type PresetUpdateParamsConfigViewType added in v6.6.0

type PresetUpdateParamsConfigViewType string

Type of the meeting

const (
	PresetUpdateParamsConfigViewTypeGroupCall PresetUpdateParamsConfigViewType = "GROUP_CALL"
	PresetUpdateParamsConfigViewTypeWebinar   PresetUpdateParamsConfigViewType = "WEBINAR"
	PresetUpdateParamsConfigViewTypeAudioRoom PresetUpdateParamsConfigViewType = "AUDIO_ROOM"
)

func (PresetUpdateParamsConfigViewType) IsKnown added in v6.6.0

type PresetUpdateParamsPermissions added in v6.6.0

type PresetUpdateParamsPermissions struct {
	// Whether this participant can accept waiting requests
	AcceptWaitingRequests           param.Field[bool] `json:"accept_waiting_requests"`
	CanAcceptProductionRequests     param.Field[bool] `json:"can_accept_production_requests"`
	CanChangeParticipantPermissions param.Field[bool] `json:"can_change_participant_permissions"`
	CanEditDisplayName              param.Field[bool] `json:"can_edit_display_name"`
	CanLivestream                   param.Field[bool] `json:"can_livestream"`
	CanRecord                       param.Field[bool] `json:"can_record"`
	CanSpotlight                    param.Field[bool] `json:"can_spotlight"`
	// Chat permissions
	Chat                            param.Field[PresetUpdateParamsPermissionsChat]              `json:"chat"`
	ConnectedMeetings               param.Field[PresetUpdateParamsPermissionsConnectedMeetings] `json:"connected_meetings"`
	DisableParticipantAudio         param.Field[bool]                                           `json:"disable_participant_audio"`
	DisableParticipantScreensharing param.Field[bool]                                           `json:"disable_participant_screensharing"`
	DisableParticipantVideo         param.Field[bool]                                           `json:"disable_participant_video"`
	// Whether this participant is visible to others or not
	HiddenParticipant param.Field[bool] `json:"hidden_participant"`
	IsRecorder        param.Field[bool] `json:"is_recorder"`
	KickParticipant   param.Field[bool] `json:"kick_participant"`
	// Media permissions
	Media          param.Field[PresetUpdateParamsPermissionsMedia] `json:"media"`
	PinParticipant param.Field[bool]                               `json:"pin_participant"`
	// Plugin permissions
	Plugins param.Field[PresetUpdateParamsPermissionsPlugins] `json:"plugins"`
	// Poll permissions
	Polls param.Field[PresetUpdateParamsPermissionsPolls] `json:"polls"`
	// Type of the recording peer
	RecorderType        param.Field[PresetUpdateParamsPermissionsRecorderType] `json:"recorder_type"`
	ShowParticipantList param.Field[bool]                                      `json:"show_participant_list"`
	// Waiting room type
	WaitingRoomType param.Field[PresetUpdateParamsPermissionsWaitingRoomType] `json:"waiting_room_type"`
}

func (PresetUpdateParamsPermissions) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissions) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsChat added in v6.6.0

type PresetUpdateParamsPermissionsChat struct {
	Private param.Field[PresetUpdateParamsPermissionsChatPrivate] `json:"private"`
	Public  param.Field[PresetUpdateParamsPermissionsChatPublic]  `json:"public"`
}

Chat permissions

func (PresetUpdateParamsPermissionsChat) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsChat) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsChatPrivate added in v6.6.0

type PresetUpdateParamsPermissionsChatPrivate struct {
	CanReceive param.Field[bool] `json:"can_receive"`
	CanSend    param.Field[bool] `json:"can_send"`
	Files      param.Field[bool] `json:"files"`
	Text       param.Field[bool] `json:"text"`
}

func (PresetUpdateParamsPermissionsChatPrivate) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsChatPrivate) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsChatPublic added in v6.6.0

type PresetUpdateParamsPermissionsChatPublic struct {
	// Can send messages in general
	CanSend param.Field[bool] `json:"can_send"`
	// Can send file messages
	Files param.Field[bool] `json:"files"`
	// Can send text messages
	Text param.Field[bool] `json:"text"`
}

func (PresetUpdateParamsPermissionsChatPublic) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsChatPublic) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsConnectedMeetings added in v6.6.0

type PresetUpdateParamsPermissionsConnectedMeetings struct {
	CanAlterConnectedMeetings  param.Field[bool] `json:"can_alter_connected_meetings"`
	CanSwitchConnectedMeetings param.Field[bool] `json:"can_switch_connected_meetings"`
	CanSwitchToParentMeeting   param.Field[bool] `json:"can_switch_to_parent_meeting"`
}

func (PresetUpdateParamsPermissionsConnectedMeetings) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsConnectedMeetings) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsMedia added in v6.6.0

type PresetUpdateParamsPermissionsMedia struct {
	// Audio permissions
	Audio param.Field[PresetUpdateParamsPermissionsMediaAudio] `json:"audio"`
	// Screenshare permissions
	Screenshare param.Field[PresetUpdateParamsPermissionsMediaScreenshare] `json:"screenshare"`
	// Video permissions
	Video param.Field[PresetUpdateParamsPermissionsMediaVideo] `json:"video"`
}

Media permissions

func (PresetUpdateParamsPermissionsMedia) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsMedia) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsMediaAudio added in v6.6.0

type PresetUpdateParamsPermissionsMediaAudio struct {
	// Can produce audio
	CanProduce param.Field[PresetUpdateParamsPermissionsMediaAudioCanProduce] `json:"can_produce"`
}

Audio permissions

func (PresetUpdateParamsPermissionsMediaAudio) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsMediaAudio) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsMediaAudioCanProduce added in v6.6.0

type PresetUpdateParamsPermissionsMediaAudioCanProduce string

Can produce audio

const (
	PresetUpdateParamsPermissionsMediaAudioCanProduceAllowed    PresetUpdateParamsPermissionsMediaAudioCanProduce = "ALLOWED"
	PresetUpdateParamsPermissionsMediaAudioCanProduceNotAllowed PresetUpdateParamsPermissionsMediaAudioCanProduce = "NOT_ALLOWED"
	PresetUpdateParamsPermissionsMediaAudioCanProduceCanRequest PresetUpdateParamsPermissionsMediaAudioCanProduce = "CAN_REQUEST"
)

func (PresetUpdateParamsPermissionsMediaAudioCanProduce) IsKnown added in v6.6.0

type PresetUpdateParamsPermissionsMediaScreenshare added in v6.6.0

type PresetUpdateParamsPermissionsMediaScreenshare struct {
	// Can produce screen share video
	CanProduce param.Field[PresetUpdateParamsPermissionsMediaScreenshareCanProduce] `json:"can_produce"`
}

Screenshare permissions

func (PresetUpdateParamsPermissionsMediaScreenshare) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsMediaScreenshare) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsMediaScreenshareCanProduce added in v6.6.0

type PresetUpdateParamsPermissionsMediaScreenshareCanProduce string

Can produce screen share video

const (
	PresetUpdateParamsPermissionsMediaScreenshareCanProduceAllowed    PresetUpdateParamsPermissionsMediaScreenshareCanProduce = "ALLOWED"
	PresetUpdateParamsPermissionsMediaScreenshareCanProduceNotAllowed PresetUpdateParamsPermissionsMediaScreenshareCanProduce = "NOT_ALLOWED"
	PresetUpdateParamsPermissionsMediaScreenshareCanProduceCanRequest PresetUpdateParamsPermissionsMediaScreenshareCanProduce = "CAN_REQUEST"
)

func (PresetUpdateParamsPermissionsMediaScreenshareCanProduce) IsKnown added in v6.6.0

type PresetUpdateParamsPermissionsMediaVideo added in v6.6.0

type PresetUpdateParamsPermissionsMediaVideo struct {
	// Can produce video
	CanProduce param.Field[PresetUpdateParamsPermissionsMediaVideoCanProduce] `json:"can_produce"`
}

Video permissions

func (PresetUpdateParamsPermissionsMediaVideo) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsMediaVideo) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsMediaVideoCanProduce added in v6.6.0

type PresetUpdateParamsPermissionsMediaVideoCanProduce string

Can produce video

const (
	PresetUpdateParamsPermissionsMediaVideoCanProduceAllowed    PresetUpdateParamsPermissionsMediaVideoCanProduce = "ALLOWED"
	PresetUpdateParamsPermissionsMediaVideoCanProduceNotAllowed PresetUpdateParamsPermissionsMediaVideoCanProduce = "NOT_ALLOWED"
	PresetUpdateParamsPermissionsMediaVideoCanProduceCanRequest PresetUpdateParamsPermissionsMediaVideoCanProduce = "CAN_REQUEST"
)

func (PresetUpdateParamsPermissionsMediaVideoCanProduce) IsKnown added in v6.6.0

type PresetUpdateParamsPermissionsPlugins added in v6.6.0

type PresetUpdateParamsPermissionsPlugins struct {
	// Can close plugins that are already open
	CanClose param.Field[bool] `json:"can_close"`
	// Can edit plugin config
	CanEditConfig param.Field[bool] `json:"can_edit_config"`
	// Can start plugins
	CanStart param.Field[bool]                                            `json:"can_start"`
	Config   param.Field[PresetUpdateParamsPermissionsPluginsConfigUnion] `json:"config" format:"uuid"`
}

Plugin permissions

func (PresetUpdateParamsPermissionsPlugins) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsPlugins) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsPluginsConfigObject added in v6.6.0

type PresetUpdateParamsPermissionsPluginsConfigObject struct {
	AccessControl   param.Field[PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl] `json:"access_control"`
	HandlesViewOnly param.Field[bool]                                                          `json:"handles_view_only"`
}

func (PresetUpdateParamsPermissionsPluginsConfigObject) ImplementsPresetUpdateParamsPermissionsPluginsConfigUnion added in v6.6.0

func (r PresetUpdateParamsPermissionsPluginsConfigObject) ImplementsPresetUpdateParamsPermissionsPluginsConfigUnion()

func (PresetUpdateParamsPermissionsPluginsConfigObject) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsPluginsConfigObject) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl added in v6.6.0

type PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl string
const (
	PresetUpdateParamsPermissionsPluginsConfigObjectAccessControlFullAccess PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS"
	PresetUpdateParamsPermissionsPluginsConfigObjectAccessControlViewOnly   PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY"
)

func (PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl) IsKnown added in v6.6.0

type PresetUpdateParamsPermissionsPluginsConfigUnion added in v6.6.0

type PresetUpdateParamsPermissionsPluginsConfigUnion interface {
	ImplementsPresetUpdateParamsPermissionsPluginsConfigUnion()
}

Satisfied by shared.UnionString, realtime_kit.PresetUpdateParamsPermissionsPluginsConfigObject.

type PresetUpdateParamsPermissionsPolls added in v6.6.0

type PresetUpdateParamsPermissionsPolls struct {
	// Can create polls
	CanCreate param.Field[bool] `json:"can_create"`
	// Can view polls
	CanView param.Field[bool] `json:"can_view"`
	// Can vote on polls
	CanVote param.Field[bool] `json:"can_vote"`
}

Poll permissions

func (PresetUpdateParamsPermissionsPolls) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsPermissionsPolls) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsPermissionsRecorderType added in v6.6.0

type PresetUpdateParamsPermissionsRecorderType string

Type of the recording peer

const (
	PresetUpdateParamsPermissionsRecorderTypeRecorder     PresetUpdateParamsPermissionsRecorderType = "RECORDER"
	PresetUpdateParamsPermissionsRecorderTypeLivestreamer PresetUpdateParamsPermissionsRecorderType = "LIVESTREAMER"
	PresetUpdateParamsPermissionsRecorderTypeNone         PresetUpdateParamsPermissionsRecorderType = "NONE"
)

func (PresetUpdateParamsPermissionsRecorderType) IsKnown added in v6.6.0

type PresetUpdateParamsPermissionsWaitingRoomType added in v6.6.0

type PresetUpdateParamsPermissionsWaitingRoomType string

Waiting room type

const (
	PresetUpdateParamsPermissionsWaitingRoomTypeSkip                  PresetUpdateParamsPermissionsWaitingRoomType = "SKIP"
	PresetUpdateParamsPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetUpdateParamsPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY"
	PresetUpdateParamsPermissionsWaitingRoomTypeSkipOnAccept          PresetUpdateParamsPermissionsWaitingRoomType = "SKIP_ON_ACCEPT"
)

func (PresetUpdateParamsPermissionsWaitingRoomType) IsKnown added in v6.6.0

type PresetUpdateParamsUI added in v6.6.0

type PresetUpdateParamsUI struct {
	ConfigDiff   param.Field[interface{}]                      `json:"config_diff"`
	DesignTokens param.Field[PresetUpdateParamsUIDesignTokens] `json:"design_tokens"`
}

func (PresetUpdateParamsUI) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsUI) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsUIDesignTokens added in v6.6.0

type PresetUpdateParamsUIDesignTokens struct {
	BorderRadius param.Field[PresetUpdateParamsUIDesignTokensBorderRadius] `json:"border_radius"`
	BorderWidth  param.Field[PresetUpdateParamsUIDesignTokensBorderWidth]  `json:"border_width"`
	Colors       param.Field[PresetUpdateParamsUIDesignTokensColors]       `json:"colors"`
	SpacingBase  param.Field[float64]                                      `json:"spacing_base"`
	Theme        param.Field[PresetUpdateParamsUIDesignTokensTheme]        `json:"theme"`
}

func (PresetUpdateParamsUIDesignTokens) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsUIDesignTokens) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsUIDesignTokensBorderRadius added in v6.6.0

type PresetUpdateParamsUIDesignTokensBorderRadius string
const (
	PresetUpdateParamsUIDesignTokensBorderRadiusRounded PresetUpdateParamsUIDesignTokensBorderRadius = "rounded"
)

func (PresetUpdateParamsUIDesignTokensBorderRadius) IsKnown added in v6.6.0

type PresetUpdateParamsUIDesignTokensBorderWidth added in v6.6.0

type PresetUpdateParamsUIDesignTokensBorderWidth string
const (
	PresetUpdateParamsUIDesignTokensBorderWidthThin PresetUpdateParamsUIDesignTokensBorderWidth = "thin"
)

func (PresetUpdateParamsUIDesignTokensBorderWidth) IsKnown added in v6.6.0

type PresetUpdateParamsUIDesignTokensColors added in v6.6.0

type PresetUpdateParamsUIDesignTokensColors struct {
	Background  param.Field[PresetUpdateParamsUIDesignTokensColorsBackground] `json:"background"`
	Brand       param.Field[PresetUpdateParamsUIDesignTokensColorsBrand]      `json:"brand"`
	Danger      param.Field[string]                                           `json:"danger"`
	Success     param.Field[string]                                           `json:"success"`
	Text        param.Field[string]                                           `json:"text"`
	TextOnBrand param.Field[string]                                           `json:"text_on_brand"`
	VideoBg     param.Field[string]                                           `json:"video_bg"`
	Warning     param.Field[string]                                           `json:"warning"`
}

func (PresetUpdateParamsUIDesignTokensColors) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsUIDesignTokensColors) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsUIDesignTokensColorsBackground added in v6.6.0

type PresetUpdateParamsUIDesignTokensColorsBackground struct {
	Number1000 param.Field[string] `json:"1000"`
	Number600  param.Field[string] `json:"600"`
	Number700  param.Field[string] `json:"700"`
	Number800  param.Field[string] `json:"800"`
	Number900  param.Field[string] `json:"900"`
}

func (PresetUpdateParamsUIDesignTokensColorsBackground) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsUIDesignTokensColorsBackground) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsUIDesignTokensColorsBrand added in v6.6.0

type PresetUpdateParamsUIDesignTokensColorsBrand struct {
	Number300 param.Field[string] `json:"300"`
	Number400 param.Field[string] `json:"400"`
	Number500 param.Field[string] `json:"500"`
	Number600 param.Field[string] `json:"600"`
	Number700 param.Field[string] `json:"700"`
}

func (PresetUpdateParamsUIDesignTokensColorsBrand) MarshalJSON added in v6.6.0

func (r PresetUpdateParamsUIDesignTokensColorsBrand) MarshalJSON() (data []byte, err error)

type PresetUpdateParamsUIDesignTokensTheme added in v6.6.0

type PresetUpdateParamsUIDesignTokensTheme string
const (
	PresetUpdateParamsUIDesignTokensThemeDark PresetUpdateParamsUIDesignTokensTheme = "dark"
)

func (PresetUpdateParamsUIDesignTokensTheme) IsKnown added in v6.6.0

type PresetUpdateResponse added in v6.6.0

type PresetUpdateResponse struct {
	// Data returned by the operation
	Data PresetUpdateResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                     `json:"success,required"`
	JSON    presetUpdateResponseJSON `json:"-"`
}

func (*PresetUpdateResponse) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponse) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseData added in v6.6.0

type PresetUpdateResponseData struct {
	// ID of the preset
	ID     string                         `json:"id,required" format:"uuid"`
	Config PresetUpdateResponseDataConfig `json:"config,required"`
	// Name of the preset
	Name        string                              `json:"name,required"`
	UI          PresetUpdateResponseDataUI          `json:"ui,required"`
	Permissions PresetUpdateResponseDataPermissions `json:"permissions"`
	JSON        presetUpdateResponseDataJSON        `json:"-"`
}

Data returned by the operation

func (*PresetUpdateResponseData) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseData) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfig added in v6.6.0

type PresetUpdateResponseDataConfig struct {
	// Maximum number of screen shares that can be active at a given time
	MaxScreenshareCount int64 `json:"max_screenshare_count,required"`
	// Maximum number of streams that are visible on a device
	MaxVideoStreams PresetUpdateResponseDataConfigMaxVideoStreams `json:"max_video_streams,required"`
	// Media configuration options. eg: Video quality
	Media PresetUpdateResponseDataConfigMedia `json:"media,required"`
	// Type of the meeting
	ViewType PresetUpdateResponseDataConfigViewType `json:"view_type,required"`
	JSON     presetUpdateResponseDataConfigJSON     `json:"-"`
}

func (*PresetUpdateResponseDataConfig) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataConfig) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfigMaxVideoStreams added in v6.6.0

type PresetUpdateResponseDataConfigMaxVideoStreams struct {
	// Maximum number of video streams visible on desktop devices
	Desktop int64 `json:"desktop,required"`
	// Maximum number of streams visible on mobile devices
	Mobile int64                                             `json:"mobile,required"`
	JSON   presetUpdateResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}

Maximum number of streams that are visible on a device

func (*PresetUpdateResponseDataConfigMaxVideoStreams) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfigMedia added in v6.6.0

type PresetUpdateResponseDataConfigMedia struct {
	// Configuration options for participant screen shares
	Screenshare PresetUpdateResponseDataConfigMediaScreenshare `json:"screenshare,required"`
	// Configuration options for participant videos
	Video PresetUpdateResponseDataConfigMediaVideo `json:"video,required"`
	// Control options for Audio quality.
	Audio PresetUpdateResponseDataConfigMediaAudio `json:"audio"`
	JSON  presetUpdateResponseDataConfigMediaJSON  `json:"-"`
}

Media configuration options. eg: Video quality

func (*PresetUpdateResponseDataConfigMedia) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfigMediaAudio added in v6.6.0

type PresetUpdateResponseDataConfigMediaAudio struct {
	// Enable High Quality Audio for your meetings
	EnableHighBitrate bool `json:"enable_high_bitrate"`
	// Enable Stereo for your meetings
	EnableStereo bool                                         `json:"enable_stereo"`
	JSON         presetUpdateResponseDataConfigMediaAudioJSON `json:"-"`
}

Control options for Audio quality.

func (*PresetUpdateResponseDataConfigMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfigMediaScreenshare added in v6.6.0

type PresetUpdateResponseDataConfigMediaScreenshare struct {
	// Frame rate of screen share
	FrameRate int64 `json:"frame_rate,required"`
	// Quality of screen share
	Quality PresetUpdateResponseDataConfigMediaScreenshareQuality `json:"quality,required"`
	JSON    presetUpdateResponseDataConfigMediaScreenshareJSON    `json:"-"`
}

Configuration options for participant screen shares

func (*PresetUpdateResponseDataConfigMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfigMediaScreenshareQuality added in v6.6.0

type PresetUpdateResponseDataConfigMediaScreenshareQuality string

Quality of screen share

const (
	PresetUpdateResponseDataConfigMediaScreenshareQualityHD   PresetUpdateResponseDataConfigMediaScreenshareQuality = "hd"
	PresetUpdateResponseDataConfigMediaScreenshareQualityVga  PresetUpdateResponseDataConfigMediaScreenshareQuality = "vga"
	PresetUpdateResponseDataConfigMediaScreenshareQualityQvga PresetUpdateResponseDataConfigMediaScreenshareQuality = "qvga"
)

func (PresetUpdateResponseDataConfigMediaScreenshareQuality) IsKnown added in v6.6.0

type PresetUpdateResponseDataConfigMediaVideo added in v6.6.0

type PresetUpdateResponseDataConfigMediaVideo struct {
	// Frame rate of participants' video
	FrameRate int64 `json:"frame_rate,required"`
	// Video quality of participants
	Quality PresetUpdateResponseDataConfigMediaVideoQuality `json:"quality,required"`
	JSON    presetUpdateResponseDataConfigMediaVideoJSON    `json:"-"`
}

Configuration options for participant videos

func (*PresetUpdateResponseDataConfigMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataConfigMediaVideoQuality added in v6.6.0

type PresetUpdateResponseDataConfigMediaVideoQuality string

Video quality of participants

const (
	PresetUpdateResponseDataConfigMediaVideoQualityHD   PresetUpdateResponseDataConfigMediaVideoQuality = "hd"
	PresetUpdateResponseDataConfigMediaVideoQualityVga  PresetUpdateResponseDataConfigMediaVideoQuality = "vga"
	PresetUpdateResponseDataConfigMediaVideoQualityQvga PresetUpdateResponseDataConfigMediaVideoQuality = "qvga"
)

func (PresetUpdateResponseDataConfigMediaVideoQuality) IsKnown added in v6.6.0

type PresetUpdateResponseDataConfigViewType added in v6.6.0

type PresetUpdateResponseDataConfigViewType string

Type of the meeting

const (
	PresetUpdateResponseDataConfigViewTypeGroupCall PresetUpdateResponseDataConfigViewType = "GROUP_CALL"
	PresetUpdateResponseDataConfigViewTypeWebinar   PresetUpdateResponseDataConfigViewType = "WEBINAR"
	PresetUpdateResponseDataConfigViewTypeAudioRoom PresetUpdateResponseDataConfigViewType = "AUDIO_ROOM"
)

func (PresetUpdateResponseDataConfigViewType) IsKnown added in v6.6.0

type PresetUpdateResponseDataPermissions added in v6.6.0

type PresetUpdateResponseDataPermissions struct {
	// Whether this participant can accept waiting requests
	AcceptWaitingRequests           bool `json:"accept_waiting_requests,required"`
	CanAcceptProductionRequests     bool `json:"can_accept_production_requests,required"`
	CanChangeParticipantPermissions bool `json:"can_change_participant_permissions,required"`
	CanEditDisplayName              bool `json:"can_edit_display_name,required"`
	CanLivestream                   bool `json:"can_livestream,required"`
	CanRecord                       bool `json:"can_record,required"`
	CanSpotlight                    bool `json:"can_spotlight,required"`
	// Chat permissions
	Chat                            PresetUpdateResponseDataPermissionsChat              `json:"chat,required"`
	ConnectedMeetings               PresetUpdateResponseDataPermissionsConnectedMeetings `json:"connected_meetings,required"`
	DisableParticipantAudio         bool                                                 `json:"disable_participant_audio,required"`
	DisableParticipantScreensharing bool                                                 `json:"disable_participant_screensharing,required"`
	DisableParticipantVideo         bool                                                 `json:"disable_participant_video,required"`
	// Whether this participant is visible to others or not
	HiddenParticipant bool `json:"hidden_participant,required"`
	KickParticipant   bool `json:"kick_participant,required"`
	// Media permissions
	Media          PresetUpdateResponseDataPermissionsMedia `json:"media,required"`
	PinParticipant bool                                     `json:"pin_participant,required"`
	// Plugin permissions
	Plugins PresetUpdateResponseDataPermissionsPlugins `json:"plugins,required"`
	// Poll permissions
	Polls PresetUpdateResponseDataPermissionsPolls `json:"polls,required"`
	// Type of the recording peer
	RecorderType        PresetUpdateResponseDataPermissionsRecorderType `json:"recorder_type,required"`
	ShowParticipantList bool                                            `json:"show_participant_list,required"`
	// Waiting room type
	WaitingRoomType PresetUpdateResponseDataPermissionsWaitingRoomType `json:"waiting_room_type,required"`
	IsRecorder      bool                                               `json:"is_recorder"`
	JSON            presetUpdateResponseDataPermissionsJSON            `json:"-"`
}

func (*PresetUpdateResponseDataPermissions) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissions) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsChat added in v6.6.0

type PresetUpdateResponseDataPermissionsChat struct {
	Private PresetUpdateResponseDataPermissionsChatPrivate `json:"private,required"`
	Public  PresetUpdateResponseDataPermissionsChatPublic  `json:"public,required"`
	JSON    presetUpdateResponseDataPermissionsChatJSON    `json:"-"`
}

Chat permissions

func (*PresetUpdateResponseDataPermissionsChat) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsChatPrivate added in v6.6.0

type PresetUpdateResponseDataPermissionsChatPrivate struct {
	CanReceive bool                                               `json:"can_receive,required"`
	CanSend    bool                                               `json:"can_send,required"`
	Files      bool                                               `json:"files,required"`
	Text       bool                                               `json:"text,required"`
	JSON       presetUpdateResponseDataPermissionsChatPrivateJSON `json:"-"`
}

func (*PresetUpdateResponseDataPermissionsChatPrivate) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsChatPublic added in v6.6.0

type PresetUpdateResponseDataPermissionsChatPublic struct {
	// Can send messages in general
	CanSend bool `json:"can_send,required"`
	// Can send file messages
	Files bool `json:"files,required"`
	// Can send text messages
	Text bool                                              `json:"text,required"`
	JSON presetUpdateResponseDataPermissionsChatPublicJSON `json:"-"`
}

func (*PresetUpdateResponseDataPermissionsChatPublic) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsConnectedMeetings added in v6.6.0

type PresetUpdateResponseDataPermissionsConnectedMeetings struct {
	CanAlterConnectedMeetings  bool                                                     `json:"can_alter_connected_meetings,required"`
	CanSwitchConnectedMeetings bool                                                     `json:"can_switch_connected_meetings,required"`
	CanSwitchToParentMeeting   bool                                                     `json:"can_switch_to_parent_meeting,required"`
	JSON                       presetUpdateResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}

func (*PresetUpdateResponseDataPermissionsConnectedMeetings) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsMedia added in v6.6.0

type PresetUpdateResponseDataPermissionsMedia struct {
	// Audio permissions
	Audio PresetUpdateResponseDataPermissionsMediaAudio `json:"audio,required"`
	// Screenshare permissions
	Screenshare PresetUpdateResponseDataPermissionsMediaScreenshare `json:"screenshare,required"`
	// Video permissions
	Video PresetUpdateResponseDataPermissionsMediaVideo `json:"video,required"`
	JSON  presetUpdateResponseDataPermissionsMediaJSON  `json:"-"`
}

Media permissions

func (*PresetUpdateResponseDataPermissionsMedia) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsMediaAudio added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaAudio struct {
	// Can produce audio
	CanProduce PresetUpdateResponseDataPermissionsMediaAudioCanProduce `json:"can_produce,required"`
	JSON       presetUpdateResponseDataPermissionsMediaAudioJSON       `json:"-"`
}

Audio permissions

func (*PresetUpdateResponseDataPermissionsMediaAudio) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsMediaAudioCanProduce added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaAudioCanProduce string

Can produce audio

const (
	PresetUpdateResponseDataPermissionsMediaAudioCanProduceAllowed    PresetUpdateResponseDataPermissionsMediaAudioCanProduce = "ALLOWED"
	PresetUpdateResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetUpdateResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED"
	PresetUpdateResponseDataPermissionsMediaAudioCanProduceCanRequest PresetUpdateResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST"
)

func (PresetUpdateResponseDataPermissionsMediaAudioCanProduce) IsKnown added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaScreenshare added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaScreenshare struct {
	// Can produce screen share video
	CanProduce PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce `json:"can_produce,required"`
	JSON       presetUpdateResponseDataPermissionsMediaScreenshareJSON       `json:"-"`
}

Screenshare permissions

func (*PresetUpdateResponseDataPermissionsMediaScreenshare) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce string

Can produce screen share video

const (
	PresetUpdateResponseDataPermissionsMediaScreenshareCanProduceAllowed    PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce = "ALLOWED"
	PresetUpdateResponseDataPermissionsMediaScreenshareCanProduceNotAllowed PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce = "NOT_ALLOWED"
	PresetUpdateResponseDataPermissionsMediaScreenshareCanProduceCanRequest PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce = "CAN_REQUEST"
)

func (PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce) IsKnown added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaVideo added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaVideo struct {
	// Can produce video
	CanProduce PresetUpdateResponseDataPermissionsMediaVideoCanProduce `json:"can_produce,required"`
	JSON       presetUpdateResponseDataPermissionsMediaVideoJSON       `json:"-"`
}

Video permissions

func (*PresetUpdateResponseDataPermissionsMediaVideo) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsMediaVideoCanProduce added in v6.6.0

type PresetUpdateResponseDataPermissionsMediaVideoCanProduce string

Can produce video

const (
	PresetUpdateResponseDataPermissionsMediaVideoCanProduceAllowed    PresetUpdateResponseDataPermissionsMediaVideoCanProduce = "ALLOWED"
	PresetUpdateResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetUpdateResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED"
	PresetUpdateResponseDataPermissionsMediaVideoCanProduceCanRequest PresetUpdateResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST"
)

func (PresetUpdateResponseDataPermissionsMediaVideoCanProduce) IsKnown added in v6.6.0

type PresetUpdateResponseDataPermissionsPlugins added in v6.6.0

type PresetUpdateResponseDataPermissionsPlugins struct {
	// Can close plugins that are already open
	CanClose bool `json:"can_close,required"`
	// Can edit plugin config
	CanEditConfig bool `json:"can_edit_config,required"`
	// Can start plugins
	CanStart bool                                                  `json:"can_start,required"`
	Config   PresetUpdateResponseDataPermissionsPluginsConfigUnion `json:"config,required" format:"uuid"`
	JSON     presetUpdateResponseDataPermissionsPluginsJSON        `json:"-"`
}

Plugin permissions

func (*PresetUpdateResponseDataPermissionsPlugins) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsPluginsConfigObject added in v6.6.0

type PresetUpdateResponseDataPermissionsPluginsConfigObject struct {
	AccessControl   PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control,required"`
	HandlesViewOnly bool                                                                `json:"handles_view_only,required"`
	JSON            presetUpdateResponseDataPermissionsPluginsConfigObjectJSON          `json:"-"`
}

func (PresetUpdateResponseDataPermissionsPluginsConfigObject) ImplementsPresetUpdateResponseDataPermissionsPluginsConfigUnion added in v6.6.0

func (r PresetUpdateResponseDataPermissionsPluginsConfigObject) ImplementsPresetUpdateResponseDataPermissionsPluginsConfigUnion()

func (*PresetUpdateResponseDataPermissionsPluginsConfigObject) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl added in v6.6.0

type PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl string
const (
	PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS"
	PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly   PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY"
)

func (PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown added in v6.6.0

type PresetUpdateResponseDataPermissionsPluginsConfigUnion added in v6.6.0

type PresetUpdateResponseDataPermissionsPluginsConfigUnion interface {
	ImplementsPresetUpdateResponseDataPermissionsPluginsConfigUnion()
}

Union satisfied by shared.UnionString or PresetUpdateResponseDataPermissionsPluginsConfigObject.

type PresetUpdateResponseDataPermissionsPolls added in v6.6.0

type PresetUpdateResponseDataPermissionsPolls struct {
	// Can create polls
	CanCreate bool `json:"can_create,required"`
	// Can view polls
	CanView bool `json:"can_view,required"`
	// Can vote on polls
	CanVote bool                                         `json:"can_vote,required"`
	JSON    presetUpdateResponseDataPermissionsPollsJSON `json:"-"`
}

Poll permissions

func (*PresetUpdateResponseDataPermissionsPolls) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataPermissionsRecorderType added in v6.6.0

type PresetUpdateResponseDataPermissionsRecorderType string

Type of the recording peer

const (
	PresetUpdateResponseDataPermissionsRecorderTypeRecorder     PresetUpdateResponseDataPermissionsRecorderType = "RECORDER"
	PresetUpdateResponseDataPermissionsRecorderTypeLivestreamer PresetUpdateResponseDataPermissionsRecorderType = "LIVESTREAMER"
	PresetUpdateResponseDataPermissionsRecorderTypeNone         PresetUpdateResponseDataPermissionsRecorderType = "NONE"
)

func (PresetUpdateResponseDataPermissionsRecorderType) IsKnown added in v6.6.0

type PresetUpdateResponseDataPermissionsWaitingRoomType added in v6.6.0

type PresetUpdateResponseDataPermissionsWaitingRoomType string

Waiting room type

const (
	PresetUpdateResponseDataPermissionsWaitingRoomTypeSkip                  PresetUpdateResponseDataPermissionsWaitingRoomType = "SKIP"
	PresetUpdateResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetUpdateResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY"
	PresetUpdateResponseDataPermissionsWaitingRoomTypeSkipOnAccept          PresetUpdateResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT"
)

func (PresetUpdateResponseDataPermissionsWaitingRoomType) IsKnown added in v6.6.0

type PresetUpdateResponseDataUI added in v6.6.0

type PresetUpdateResponseDataUI struct {
	DesignTokens PresetUpdateResponseDataUIDesignTokens `json:"design_tokens,required"`
	ConfigDiff   interface{}                            `json:"config_diff"`
	JSON         presetUpdateResponseDataUIJSON         `json:"-"`
}

func (*PresetUpdateResponseDataUI) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataUI) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataUIDesignTokens added in v6.6.0

type PresetUpdateResponseDataUIDesignTokens struct {
	BorderRadius PresetUpdateResponseDataUIDesignTokensBorderRadius `json:"border_radius,required"`
	BorderWidth  PresetUpdateResponseDataUIDesignTokensBorderWidth  `json:"border_width,required"`
	Colors       PresetUpdateResponseDataUIDesignTokensColors       `json:"colors,required"`
	SpacingBase  float64                                            `json:"spacing_base,required"`
	Theme        PresetUpdateResponseDataUIDesignTokensTheme        `json:"theme,required"`
	JSON         presetUpdateResponseDataUIDesignTokensJSON         `json:"-"`
}

func (*PresetUpdateResponseDataUIDesignTokens) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataUIDesignTokensBorderRadius added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensBorderRadius string
const (
	PresetUpdateResponseDataUIDesignTokensBorderRadiusRounded PresetUpdateResponseDataUIDesignTokensBorderRadius = "rounded"
)

func (PresetUpdateResponseDataUIDesignTokensBorderRadius) IsKnown added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensBorderWidth added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensBorderWidth string
const (
	PresetUpdateResponseDataUIDesignTokensBorderWidthThin PresetUpdateResponseDataUIDesignTokensBorderWidth = "thin"
)

func (PresetUpdateResponseDataUIDesignTokensBorderWidth) IsKnown added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensColors added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensColors struct {
	Background  PresetUpdateResponseDataUIDesignTokensColorsBackground `json:"background,required"`
	Brand       PresetUpdateResponseDataUIDesignTokensColorsBrand      `json:"brand,required"`
	Danger      string                                                 `json:"danger,required"`
	Success     string                                                 `json:"success,required"`
	Text        string                                                 `json:"text,required"`
	TextOnBrand string                                                 `json:"text_on_brand,required"`
	VideoBg     string                                                 `json:"video_bg,required"`
	Warning     string                                                 `json:"warning,required"`
	JSON        presetUpdateResponseDataUIDesignTokensColorsJSON       `json:"-"`
}

func (*PresetUpdateResponseDataUIDesignTokensColors) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataUIDesignTokensColorsBackground added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensColorsBackground struct {
	Number1000 string                                                     `json:"1000,required"`
	Number600  string                                                     `json:"600,required"`
	Number700  string                                                     `json:"700,required"`
	Number800  string                                                     `json:"800,required"`
	Number900  string                                                     `json:"900,required"`
	JSON       presetUpdateResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}

func (*PresetUpdateResponseDataUIDesignTokensColorsBackground) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataUIDesignTokensColorsBrand added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensColorsBrand struct {
	Number300 string                                                `json:"300,required"`
	Number400 string                                                `json:"400,required"`
	Number500 string                                                `json:"500,required"`
	Number600 string                                                `json:"600,required"`
	Number700 string                                                `json:"700,required"`
	JSON      presetUpdateResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}

func (*PresetUpdateResponseDataUIDesignTokensColorsBrand) UnmarshalJSON added in v6.6.0

func (r *PresetUpdateResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)

type PresetUpdateResponseDataUIDesignTokensTheme added in v6.6.0

type PresetUpdateResponseDataUIDesignTokensTheme string
const (
	PresetUpdateResponseDataUIDesignTokensThemeDark PresetUpdateResponseDataUIDesignTokensTheme = "dark"
)

func (PresetUpdateResponseDataUIDesignTokensTheme) IsKnown added in v6.6.0

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type RealtimeKitService

type RealtimeKitService struct {
	Options       []option.RequestOption
	Apps          *AppService
	Meetings      *MeetingService
	Presets       *PresetService
	Sessions      *SessionService
	Recordings    *RecordingService
	Webhooks      *WebhookService
	ActiveSession *ActiveSessionService
	Livestreams   *LivestreamService
	Analytics     *AnalyticsService
}

RealtimeKitService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRealtimeKitService method instead.

func NewRealtimeKitService

func NewRealtimeKitService(opts ...option.RequestOption) (r *RealtimeKitService)

NewRealtimeKitService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type RecordingGetActiveRecordingsParams added in v6.6.0

type RecordingGetActiveRecordingsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type RecordingGetActiveRecordingsResponse added in v6.6.0

type RecordingGetActiveRecordingsResponse struct {
	// Data returned by the operation
	Data RecordingGetActiveRecordingsResponseData `json:"data,required"`
	// Success status of the operation
	Success bool                                     `json:"success,required"`
	JSON    recordingGetActiveRecordingsResponseJSON `json:"-"`
}

func (*RecordingGetActiveRecordingsResponse) UnmarshalJSON added in v6.6.0

func (r *RecordingGetActiveRecordingsResponse) UnmarshalJSON(data []byte) (err error)

type RecordingGetActiveRecordingsResponseData added in v6.6.0

type RecordingGetActiveRecordingsResponseData struct {
	// ID of the recording
	ID string `json:"id,required" format:"uuid"`
	// If the audio_config is passed, the URL for downloading the audio recording is
	// returned.
	AudioDownloadURL string `json:"audio_download_url,required,nullable" format:"uri"`
	// URL where the recording can be downloaded.
	DownloadURL string `json:"download_url,required,nullable" format:"uri"`
	// Timestamp when the download URL expires.
	DownloadURLExpiry time.Time `json:"download_url_expiry,required,nullable" format:"date-time"`
	// File size of the recording, in bytes.
	FileSize float64 `json:"file_size,required,nullable"`
	// Timestamp when this recording was invoked.
	InvokedTime time.Time `json:"invoked_time,required" format:"date-time"`
	// File name of the recording.
	OutputFileName string `json:"output_file_name,required"`
	// ID of the meeting session this recording is for.
	SessionID string `json:"session_id,required,nullable" format:"uuid"`
	// Timestamp when this recording actually started after being invoked. Usually a
	// few seconds after `invoked_time`.
	StartedTime time.Time `json:"started_time,required,nullable" format:"date-time"`
	// Current status of the recording.
	Status RecordingGetActiveRecordingsResponseDataStatus `json:"status,required"`
	// Timestamp when this recording was stopped. Optional; is present only when the
	// recording has actually been stopped.
	StoppedTime time.Time `json:"stopped_time,required,nullable" format:"date-time"`
	// Total recording time in seconds.
	RecordingDuration int64                                        `json:"recording_duration"`
	JSON              recordingGetActiveRecordingsResponseDataJSON `json:"-"`
}

Data returned by the operation

func (*RecordingGetActiveRecordingsResponseData) UnmarshalJSON added in v6.6.0

func (r *RecordingGetActiveRecordingsResponseData) UnmarshalJSON(data []byte) (err error)

type RecordingGetActiveRecordingsResponseDataStatus added in v6.6.0

type RecordingGetActiveRecordingsResponseDataStatus string

Current status of the recording.

const (
	RecordingGetActiveRecordingsResponseDataStatusInvoked   RecordingGetActiveRecordingsResponseDataStatus = "INVOKED"
	RecordingGetActiveRecordingsResponseDataStatusRecording RecordingGetActiveRecordingsResponseDataStatus = "RECORDING"
	RecordingGetActiveRecordingsResponseDataStatusUploading RecordingGetActiveRecordingsResponseDataStatus = "UPLOADING"
	RecordingGetActiveRecordingsResponseDataStatusUploaded  RecordingGetActiveRecordingsResponseDataStatus = "UPLOADED"
	RecordingGetActiveRecordingsResponseDataStatusErrored   RecordingGetActiveRecordingsResponseDataStatus = "ERRORED"
	RecordingGetActiveRecordingsResponseDataStatusPaused    RecordingGetActiveRecordingsResponseDataStatus = "PAUSED"
)

func (RecordingGetActiveRecordingsResponseDataStatus) IsKnown added in v6.6.0

type RecordingGetOneRecordingParams added in v6.6.0

type RecordingGetOneRecordingParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type RecordingGetOneRecordingResponse added in v6.6.0

type RecordingGetOneRecordingResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data RecordingGetOneRecordingResponseData `json:"data"`
	JSON recordingGetOneRecordingResponseJSON `json:"-"`
}

func (*RecordingGetOneRecordingResponse) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponse) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseData added in v6.6.0

type RecordingGetOneRecordingResponseData struct {
	// ID of the recording
	ID string `json:"id,required" format:"uuid"`
	// If the audio_config is passed, the URL for downloading the audio recording is
	// returned.
	AudioDownloadURL string `json:"audio_download_url,required,nullable" format:"uri"`
	// URL where the recording can be downloaded.
	DownloadURL string `json:"download_url,required,nullable" format:"uri"`
	// Timestamp when the download URL expires.
	DownloadURLExpiry time.Time `json:"download_url_expiry,required,nullable" format:"date-time"`
	// File size of the recording, in bytes.
	FileSize float64 `json:"file_size,required,nullable"`
	// Timestamp when this recording was invoked.
	InvokedTime time.Time `json:"invoked_time,required" format:"date-time"`
	// File name of the recording.
	OutputFileName string `json:"output_file_name,required"`
	// ID of the meeting session this recording is for.
	SessionID string `json:"session_id,required,nullable" format:"uuid"`
	// Timestamp when this recording actually started after being invoked. Usually a
	// few seconds after `invoked_time`.
	StartedTime time.Time `json:"started_time,required,nullable" format:"date-time"`
	// Current status of the recording.
	Status RecordingGetOneRecordingResponseDataStatus `json:"status,required"`
	// Timestamp when this recording was stopped. Optional; is present only when the
	// recording has actually been stopped.
	StoppedTime time.Time `json:"stopped_time,required,nullable" format:"date-time"`
	// Total recording time in seconds.
	RecordingDuration int64                                             `json:"recording_duration"`
	StartReason       RecordingGetOneRecordingResponseDataStartReason   `json:"start_reason"`
	StopReason        RecordingGetOneRecordingResponseDataStopReason    `json:"stop_reason"`
	StorageConfig     RecordingGetOneRecordingResponseDataStorageConfig `json:"storage_config,nullable"`
	JSON              recordingGetOneRecordingResponseDataJSON          `json:"-"`
}

Data returned by the operation

func (*RecordingGetOneRecordingResponseData) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponseData) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseDataStartReason added in v6.6.0

type RecordingGetOneRecordingResponseDataStartReason struct {
	Caller RecordingGetOneRecordingResponseDataStartReasonCaller `json:"caller"`
	// Specifies if the recording was started using the "Start a Recording"API or using
	// the parameter RECORD_ON_START in the "Create a meeting" API.
	//
	// If the recording is initiated using the "RECORD_ON_START" parameter, the user
	// details will not be populated.
	Reason RecordingGetOneRecordingResponseDataStartReasonReason `json:"reason"`
	JSON   recordingGetOneRecordingResponseDataStartReasonJSON   `json:"-"`
}

func (*RecordingGetOneRecordingResponseDataStartReason) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponseDataStartReason) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseDataStartReasonCaller added in v6.6.0

type RecordingGetOneRecordingResponseDataStartReasonCaller struct {
	// Name of the user who started the recording.
	Name string `json:"name"`
	// The type can be an App or a user. If the type is `user`, then only the `user_Id`
	// and `name` are returned.
	Type RecordingGetOneRecordingResponseDataStartReasonCallerType `json:"type"`
	// The user ID of the person who started the recording.
	UserID string                                                    `json:"user_Id" format:"uuid"`
	JSON   recordingGetOneRecordingResponseDataStartReasonCallerJSON `json:"-"`
}

func (*RecordingGetOneRecordingResponseDataStartReasonCaller) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponseDataStartReasonCaller) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseDataStartReasonCallerType added in v6.6.0

type RecordingGetOneRecordingResponseDataStartReasonCallerType string

The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.

const (
	RecordingGetOneRecordingResponseDataStartReasonCallerTypeOrganization RecordingGetOneRecordingResponseDataStartReasonCallerType = "ORGANIZATION"
	RecordingGetOneRecordingResponseDataStartReasonCallerTypeUser         RecordingGetOneRecordingResponseDataStartReasonCallerType = "USER"
)

func (RecordingGetOneRecordingResponseDataStartReasonCallerType) IsKnown added in v6.6.0

type RecordingGetOneRecordingResponseDataStartReasonReason added in v6.6.0

type RecordingGetOneRecordingResponseDataStartReasonReason string

Specifies if the recording was started using the "Start a Recording"API or using the parameter RECORD_ON_START in the "Create a meeting" API.

If the recording is initiated using the "RECORD_ON_START" parameter, the user details will not be populated.

const (
	RecordingGetOneRecordingResponseDataStartReasonReasonAPICall       RecordingGetOneRecordingResponseDataStartReasonReason = "API_CALL"
	RecordingGetOneRecordingResponseDataStartReasonReasonRecordOnStart RecordingGetOneRecordingResponseDataStartReasonReason = "RECORD_ON_START"
)

func (RecordingGetOneRecordingResponseDataStartReasonReason) IsKnown added in v6.6.0

type RecordingGetOneRecordingResponseDataStatus added in v6.6.0

type RecordingGetOneRecordingResponseDataStatus string

Current status of the recording.

const (
	RecordingGetOneRecordingResponseDataStatusInvoked   RecordingGetOneRecordingResponseDataStatus = "INVOKED"
	RecordingGetOneRecordingResponseDataStatusRecording RecordingGetOneRecordingResponseDataStatus = "RECORDING"
	RecordingGetOneRecordingResponseDataStatusUploading RecordingGetOneRecordingResponseDataStatus = "UPLOADING"
	RecordingGetOneRecordingResponseDataStatusUploaded  RecordingGetOneRecordingResponseDataStatus = "UPLOADED"
	RecordingGetOneRecordingResponseDataStatusErrored   RecordingGetOneRecordingResponseDataStatus = "ERRORED"
	RecordingGetOneRecordingResponseDataStatusPaused    RecordingGetOneRecordingResponseDataStatus = "PAUSED"
)

func (RecordingGetOneRecordingResponseDataStatus) IsKnown added in v6.6.0

type RecordingGetOneRecordingResponseDataStopReason added in v6.6.0

type RecordingGetOneRecordingResponseDataStopReason struct {
	Caller RecordingGetOneRecordingResponseDataStopReasonCaller `json:"caller"`
	// Specifies the reason why the recording stopped.
	Reason RecordingGetOneRecordingResponseDataStopReasonReason `json:"reason"`
	JSON   recordingGetOneRecordingResponseDataStopReasonJSON   `json:"-"`
}

func (*RecordingGetOneRecordingResponseDataStopReason) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponseDataStopReason) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseDataStopReasonCaller added in v6.6.0

type RecordingGetOneRecordingResponseDataStopReasonCaller struct {
	// Name of the user who stopped the recording.
	Name string `json:"name"`
	// The type can be an App or a user. If the type is `user`, then only the `user_Id`
	// and `name` are returned.
	Type RecordingGetOneRecordingResponseDataStopReasonCallerType `json:"type"`
	// The user ID of the person who stopped the recording.
	UserID string                                                   `json:"user_Id" format:"uuid"`
	JSON   recordingGetOneRecordingResponseDataStopReasonCallerJSON `json:"-"`
}

func (*RecordingGetOneRecordingResponseDataStopReasonCaller) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponseDataStopReasonCaller) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseDataStopReasonCallerType added in v6.6.0

type RecordingGetOneRecordingResponseDataStopReasonCallerType string

The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.

const (
	RecordingGetOneRecordingResponseDataStopReasonCallerTypeOrganization RecordingGetOneRecordingResponseDataStopReasonCallerType = "ORGANIZATION"
	RecordingGetOneRecordingResponseDataStopReasonCallerTypeUser         RecordingGetOneRecordingResponseDataStopReasonCallerType = "USER"
)

func (RecordingGetOneRecordingResponseDataStopReasonCallerType) IsKnown added in v6.6.0

type RecordingGetOneRecordingResponseDataStopReasonReason added in v6.6.0

type RecordingGetOneRecordingResponseDataStopReasonReason string

Specifies the reason why the recording stopped.

const (
	RecordingGetOneRecordingResponseDataStopReasonReasonAPICall       RecordingGetOneRecordingResponseDataStopReasonReason = "API_CALL"
	RecordingGetOneRecordingResponseDataStopReasonReasonInternalError RecordingGetOneRecordingResponseDataStopReasonReason = "INTERNAL_ERROR"
	RecordingGetOneRecordingResponseDataStopReasonReasonAllPeersLeft  RecordingGetOneRecordingResponseDataStopReasonReason = "ALL_PEERS_LEFT"
)

func (RecordingGetOneRecordingResponseDataStopReasonReason) IsKnown added in v6.6.0

type RecordingGetOneRecordingResponseDataStorageConfig added in v6.6.0

type RecordingGetOneRecordingResponseDataStorageConfig struct {
	// Type of storage media.
	Type RecordingGetOneRecordingResponseDataStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod RecordingGetOneRecordingResponseDataStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                `json:"username"`
	JSON     recordingGetOneRecordingResponseDataStorageConfigJSON `json:"-"`
}

func (*RecordingGetOneRecordingResponseDataStorageConfig) UnmarshalJSON added in v6.6.0

func (r *RecordingGetOneRecordingResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)

type RecordingGetOneRecordingResponseDataStorageConfigAuthMethod added in v6.6.0

type RecordingGetOneRecordingResponseDataStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	RecordingGetOneRecordingResponseDataStorageConfigAuthMethodKey      RecordingGetOneRecordingResponseDataStorageConfigAuthMethod = "KEY"
	RecordingGetOneRecordingResponseDataStorageConfigAuthMethodPassword RecordingGetOneRecordingResponseDataStorageConfigAuthMethod = "PASSWORD"
)

func (RecordingGetOneRecordingResponseDataStorageConfigAuthMethod) IsKnown added in v6.6.0

type RecordingGetOneRecordingResponseDataStorageConfigType added in v6.6.0

type RecordingGetOneRecordingResponseDataStorageConfigType string

Type of storage media.

const (
	RecordingGetOneRecordingResponseDataStorageConfigTypeAws          RecordingGetOneRecordingResponseDataStorageConfigType = "aws"
	RecordingGetOneRecordingResponseDataStorageConfigTypeAzure        RecordingGetOneRecordingResponseDataStorageConfigType = "azure"
	RecordingGetOneRecordingResponseDataStorageConfigTypeDigitalocean RecordingGetOneRecordingResponseDataStorageConfigType = "digitalocean"
	RecordingGetOneRecordingResponseDataStorageConfigTypeGcs          RecordingGetOneRecordingResponseDataStorageConfigType = "gcs"
	RecordingGetOneRecordingResponseDataStorageConfigTypeSftp         RecordingGetOneRecordingResponseDataStorageConfigType = "sftp"
)

func (RecordingGetOneRecordingResponseDataStorageConfigType) IsKnown added in v6.6.0

type RecordingGetRecordingsParams added in v6.6.0

type RecordingGetRecordingsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The end time range for which you want to retrieve the meetings. The time must be
	// specified in ISO format.
	EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
	// If passed, only shows expired/non-expired recordings on RealtimeKit's bucket
	Expired param.Field[bool] `query:"expired"`
	// ID of a meeting. Optional. Will limit results to only this meeting if passed.
	MeetingID param.Field[string] `query:"meeting_id" format:"uuid"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[float64] `query:"page_no"`
	// Number of results per page
	PerPage param.Field[float64] `query:"per_page"`
	// The search query string. You can search using the meeting ID or title.
	Search    param.Field[string]                                `query:"search"`
	SortBy    param.Field[RecordingGetRecordingsParamsSortBy]    `query:"sort_by"`
	SortOrder param.Field[RecordingGetRecordingsParamsSortOrder] `query:"sort_order"`
	// The start time range for which you want to retrieve the meetings. The time must
	// be specified in ISO format.
	StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
	// Filter by one or more recording status
	Status param.Field[[]RecordingGetRecordingsParamsStatus] `query:"status"`
}

func (RecordingGetRecordingsParams) URLQuery added in v6.6.0

func (r RecordingGetRecordingsParams) URLQuery() (v url.Values)

URLQuery serializes RecordingGetRecordingsParams's query parameters as `url.Values`.

type RecordingGetRecordingsParamsSortBy added in v6.6.0

type RecordingGetRecordingsParamsSortBy string
const (
	RecordingGetRecordingsParamsSortByInvokedTime RecordingGetRecordingsParamsSortBy = "invokedTime"
)

func (RecordingGetRecordingsParamsSortBy) IsKnown added in v6.6.0

type RecordingGetRecordingsParamsSortOrder added in v6.6.0

type RecordingGetRecordingsParamsSortOrder string
const (
	RecordingGetRecordingsParamsSortOrderAsc  RecordingGetRecordingsParamsSortOrder = "ASC"
	RecordingGetRecordingsParamsSortOrderDesc RecordingGetRecordingsParamsSortOrder = "DESC"
)

func (RecordingGetRecordingsParamsSortOrder) IsKnown added in v6.6.0

type RecordingGetRecordingsParamsStatus added in v6.6.0

type RecordingGetRecordingsParamsStatus string
const (
	RecordingGetRecordingsParamsStatusInvoked   RecordingGetRecordingsParamsStatus = "INVOKED"
	RecordingGetRecordingsParamsStatusRecording RecordingGetRecordingsParamsStatus = "RECORDING"
	RecordingGetRecordingsParamsStatusUploading RecordingGetRecordingsParamsStatus = "UPLOADING"
	RecordingGetRecordingsParamsStatusUploaded  RecordingGetRecordingsParamsStatus = "UPLOADED"
)

func (RecordingGetRecordingsParamsStatus) IsKnown added in v6.6.0

type RecordingGetRecordingsResponse added in v6.6.0

type RecordingGetRecordingsResponse struct {
	Data    []RecordingGetRecordingsResponseData `json:"data,required"`
	Paging  RecordingGetRecordingsResponsePaging `json:"paging,required"`
	Success bool                                 `json:"success,required"`
	JSON    recordingGetRecordingsResponseJSON   `json:"-"`
}

func (*RecordingGetRecordingsResponse) UnmarshalJSON added in v6.6.0

func (r *RecordingGetRecordingsResponse) UnmarshalJSON(data []byte) (err error)

type RecordingGetRecordingsResponseData added in v6.6.0

type RecordingGetRecordingsResponseData struct {
	// ID of the recording
	ID string `json:"id,required" format:"uuid"`
	// If the audio_config is passed, the URL for downloading the audio recording is
	// returned.
	AudioDownloadURL string `json:"audio_download_url,required,nullable" format:"uri"`
	// URL where the recording can be downloaded.
	DownloadURL string `json:"download_url,required,nullable" format:"uri"`
	// Timestamp when the download URL expires.
	DownloadURLExpiry time.Time `json:"download_url_expiry,required,nullable" format:"date-time"`
	// File size of the recording, in bytes.
	FileSize float64 `json:"file_size,required,nullable"`
	// Timestamp when this recording was invoked.
	InvokedTime time.Time `json:"invoked_time,required" format:"date-time"`
	// File name of the recording.
	OutputFileName string `json:"output_file_name,required"`
	// ID of the meeting session this recording is for.
	SessionID string `json:"session_id,required,nullable" format:"uuid"`
	// Timestamp when this recording actually started after being invoked. Usually a
	// few seconds after `invoked_time`.
	StartedTime time.Time `json:"started_time,required,nullable" format:"date-time"`
	// Current status of the recording.
	Status RecordingGetRecordingsResponseDataStatus `json:"status,required"`
	// Timestamp when this recording was stopped. Optional; is present only when the
	// recording has actually been stopped.
	StoppedTime time.Time                                 `json:"stopped_time,required,nullable" format:"date-time"`
	Meeting     RecordingGetRecordingsResponseDataMeeting `json:"meeting"`
	// Total recording time in seconds.
	RecordingDuration int64                                           `json:"recording_duration"`
	StorageConfig     RecordingGetRecordingsResponseDataStorageConfig `json:"storage_config,nullable"`
	JSON              recordingGetRecordingsResponseDataJSON          `json:"-"`
}

func (*RecordingGetRecordingsResponseData) UnmarshalJSON added in v6.6.0

func (r *RecordingGetRecordingsResponseData) UnmarshalJSON(data []byte) (err error)

type RecordingGetRecordingsResponseDataMeeting added in v6.6.0

type RecordingGetRecordingsResponseDataMeeting struct {
	// ID of the meeting.
	ID string `json:"id,required" format:"uuid"`
	// Timestamp the object was created at. The time is returned in ISO format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Timestamp the object was updated at. The time is returned in ISO format.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Specifies if the meeting should start getting livestreamed on start.
	LiveStreamOnStart bool `json:"live_stream_on_start"`
	// Specifies if Chat within a meeting should persist for a week.
	PersistChat bool `json:"persist_chat"`
	// Specifies if the meeting should start getting recorded as soon as someone joins
	// the meeting.
	RecordOnStart bool `json:"record_on_start"`
	// Time in seconds, for which a session remains active, after the last participant
	// has left the meeting.
	SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
	// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
	// `INACTIVE` meeting.
	Status RecordingGetRecordingsResponseDataMeetingStatus `json:"status"`
	// Automatically generate summary of meetings using transcripts. Requires
	// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
	SummarizeOnEnd bool `json:"summarize_on_end"`
	// Title of the meeting.
	Title string                                        `json:"title"`
	JSON  recordingGetRecordingsResponseDataMeetingJSON `json:"-"`
}

func (*RecordingGetRecordingsResponseDataMeeting) UnmarshalJSON added in v6.6.0

func (r *RecordingGetRecordingsResponseDataMeeting) UnmarshalJSON(data []byte) (err error)

type RecordingGetRecordingsResponseDataMeetingStatus added in v6.6.0

type RecordingGetRecordingsResponseDataMeetingStatus string

Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.

const (
	RecordingGetRecordingsResponseDataMeetingStatusActive   RecordingGetRecordingsResponseDataMeetingStatus = "ACTIVE"
	RecordingGetRecordingsResponseDataMeetingStatusInactive RecordingGetRecordingsResponseDataMeetingStatus = "INACTIVE"
)

func (RecordingGetRecordingsResponseDataMeetingStatus) IsKnown added in v6.6.0

type RecordingGetRecordingsResponseDataStatus added in v6.6.0

type RecordingGetRecordingsResponseDataStatus string

Current status of the recording.

const (
	RecordingGetRecordingsResponseDataStatusInvoked   RecordingGetRecordingsResponseDataStatus = "INVOKED"
	RecordingGetRecordingsResponseDataStatusRecording RecordingGetRecordingsResponseDataStatus = "RECORDING"
	RecordingGetRecordingsResponseDataStatusUploading RecordingGetRecordingsResponseDataStatus = "UPLOADING"
	RecordingGetRecordingsResponseDataStatusUploaded  RecordingGetRecordingsResponseDataStatus = "UPLOADED"
	RecordingGetRecordingsResponseDataStatusErrored   RecordingGetRecordingsResponseDataStatus = "ERRORED"
	RecordingGetRecordingsResponseDataStatusPaused    RecordingGetRecordingsResponseDataStatus = "PAUSED"
)

func (RecordingGetRecordingsResponseDataStatus) IsKnown added in v6.6.0

type RecordingGetRecordingsResponseDataStorageConfig added in v6.6.0

type RecordingGetRecordingsResponseDataStorageConfig struct {
	// Type of storage media.
	Type RecordingGetRecordingsResponseDataStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod RecordingGetRecordingsResponseDataStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                              `json:"username"`
	JSON     recordingGetRecordingsResponseDataStorageConfigJSON `json:"-"`
}

func (*RecordingGetRecordingsResponseDataStorageConfig) UnmarshalJSON added in v6.6.0

func (r *RecordingGetRecordingsResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)

type RecordingGetRecordingsResponseDataStorageConfigAuthMethod added in v6.6.0

type RecordingGetRecordingsResponseDataStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	RecordingGetRecordingsResponseDataStorageConfigAuthMethodKey      RecordingGetRecordingsResponseDataStorageConfigAuthMethod = "KEY"
	RecordingGetRecordingsResponseDataStorageConfigAuthMethodPassword RecordingGetRecordingsResponseDataStorageConfigAuthMethod = "PASSWORD"
)

func (RecordingGetRecordingsResponseDataStorageConfigAuthMethod) IsKnown added in v6.6.0

type RecordingGetRecordingsResponseDataStorageConfigType added in v6.6.0

type RecordingGetRecordingsResponseDataStorageConfigType string

Type of storage media.

const (
	RecordingGetRecordingsResponseDataStorageConfigTypeAws          RecordingGetRecordingsResponseDataStorageConfigType = "aws"
	RecordingGetRecordingsResponseDataStorageConfigTypeAzure        RecordingGetRecordingsResponseDataStorageConfigType = "azure"
	RecordingGetRecordingsResponseDataStorageConfigTypeDigitalocean RecordingGetRecordingsResponseDataStorageConfigType = "digitalocean"
	RecordingGetRecordingsResponseDataStorageConfigTypeGcs          RecordingGetRecordingsResponseDataStorageConfigType = "gcs"
	RecordingGetRecordingsResponseDataStorageConfigTypeSftp         RecordingGetRecordingsResponseDataStorageConfigType = "sftp"
)

func (RecordingGetRecordingsResponseDataStorageConfigType) IsKnown added in v6.6.0

type RecordingGetRecordingsResponsePaging added in v6.6.0

type RecordingGetRecordingsResponsePaging struct {
	EndOffset   float64                                  `json:"end_offset,required"`
	StartOffset float64                                  `json:"start_offset,required"`
	TotalCount  float64                                  `json:"total_count,required"`
	JSON        recordingGetRecordingsResponsePagingJSON `json:"-"`
}

func (*RecordingGetRecordingsResponsePaging) UnmarshalJSON added in v6.6.0

func (r *RecordingGetRecordingsResponsePaging) UnmarshalJSON(data []byte) (err error)

type RecordingPauseResumeStopRecordingParams added in v6.6.0

type RecordingPauseResumeStopRecordingParams struct {
	// The account identifier tag.
	AccountID param.Field[string]                                        `path:"account_id,required"`
	Action    param.Field[RecordingPauseResumeStopRecordingParamsAction] `json:"action,required"`
}

func (RecordingPauseResumeStopRecordingParams) MarshalJSON added in v6.6.0

func (r RecordingPauseResumeStopRecordingParams) MarshalJSON() (data []byte, err error)

type RecordingPauseResumeStopRecordingParamsAction added in v6.6.0

type RecordingPauseResumeStopRecordingParamsAction string
const (
	RecordingPauseResumeStopRecordingParamsActionStop   RecordingPauseResumeStopRecordingParamsAction = "stop"
	RecordingPauseResumeStopRecordingParamsActionPause  RecordingPauseResumeStopRecordingParamsAction = "pause"
	RecordingPauseResumeStopRecordingParamsActionResume RecordingPauseResumeStopRecordingParamsAction = "resume"
)

func (RecordingPauseResumeStopRecordingParamsAction) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponse added in v6.6.0

type RecordingPauseResumeStopRecordingResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data RecordingPauseResumeStopRecordingResponseData `json:"data"`
	JSON recordingPauseResumeStopRecordingResponseJSON `json:"-"`
}

func (*RecordingPauseResumeStopRecordingResponse) UnmarshalJSON added in v6.6.0

func (r *RecordingPauseResumeStopRecordingResponse) UnmarshalJSON(data []byte) (err error)

type RecordingPauseResumeStopRecordingResponseData added in v6.6.0

type RecordingPauseResumeStopRecordingResponseData struct {
	// ID of the recording
	ID string `json:"id,required" format:"uuid"`
	// If the audio_config is passed, the URL for downloading the audio recording is
	// returned.
	AudioDownloadURL string `json:"audio_download_url,required,nullable" format:"uri"`
	// URL where the recording can be downloaded.
	DownloadURL string `json:"download_url,required,nullable" format:"uri"`
	// Timestamp when the download URL expires.
	DownloadURLExpiry time.Time `json:"download_url_expiry,required,nullable" format:"date-time"`
	// File size of the recording, in bytes.
	FileSize float64 `json:"file_size,required,nullable"`
	// Timestamp when this recording was invoked.
	InvokedTime time.Time `json:"invoked_time,required" format:"date-time"`
	// File name of the recording.
	OutputFileName string `json:"output_file_name,required"`
	// ID of the meeting session this recording is for.
	SessionID string `json:"session_id,required,nullable" format:"uuid"`
	// Timestamp when this recording actually started after being invoked. Usually a
	// few seconds after `invoked_time`.
	StartedTime time.Time `json:"started_time,required,nullable" format:"date-time"`
	// Current status of the recording.
	Status RecordingPauseResumeStopRecordingResponseDataStatus `json:"status,required"`
	// Timestamp when this recording was stopped. Optional; is present only when the
	// recording has actually been stopped.
	StoppedTime time.Time `json:"stopped_time,required,nullable" format:"date-time"`
	// Total recording time in seconds.
	RecordingDuration int64                                                      `json:"recording_duration"`
	StartReason       RecordingPauseResumeStopRecordingResponseDataStartReason   `json:"start_reason"`
	StopReason        RecordingPauseResumeStopRecordingResponseDataStopReason    `json:"stop_reason"`
	StorageConfig     RecordingPauseResumeStopRecordingResponseDataStorageConfig `json:"storage_config,nullable"`
	JSON              recordingPauseResumeStopRecordingResponseDataJSON          `json:"-"`
}

Data returned by the operation

func (*RecordingPauseResumeStopRecordingResponseData) UnmarshalJSON added in v6.6.0

func (r *RecordingPauseResumeStopRecordingResponseData) UnmarshalJSON(data []byte) (err error)

type RecordingPauseResumeStopRecordingResponseDataStartReason added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReason struct {
	Caller RecordingPauseResumeStopRecordingResponseDataStartReasonCaller `json:"caller"`
	// Specifies if the recording was started using the "Start a Recording"API or using
	// the parameter RECORD_ON_START in the "Create a meeting" API.
	//
	// If the recording is initiated using the "RECORD_ON_START" parameter, the user
	// details will not be populated.
	Reason RecordingPauseResumeStopRecordingResponseDataStartReasonReason `json:"reason"`
	JSON   recordingPauseResumeStopRecordingResponseDataStartReasonJSON   `json:"-"`
}

func (*RecordingPauseResumeStopRecordingResponseDataStartReason) UnmarshalJSON added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReasonCaller added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReasonCaller struct {
	// Name of the user who started the recording.
	Name string `json:"name"`
	// The type can be an App or a user. If the type is `user`, then only the `user_Id`
	// and `name` are returned.
	Type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType `json:"type"`
	// The user ID of the person who started the recording.
	UserID string                                                             `json:"user_Id" format:"uuid"`
	JSON   recordingPauseResumeStopRecordingResponseDataStartReasonCallerJSON `json:"-"`
}

func (*RecordingPauseResumeStopRecordingResponseDataStartReasonCaller) UnmarshalJSON added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType string

The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.

const (
	RecordingPauseResumeStopRecordingResponseDataStartReasonCallerTypeOrganization RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType = "ORGANIZATION"
	RecordingPauseResumeStopRecordingResponseDataStartReasonCallerTypeUser         RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType = "USER"
)

func (RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReasonReason added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStartReasonReason string

Specifies if the recording was started using the "Start a Recording"API or using the parameter RECORD_ON_START in the "Create a meeting" API.

If the recording is initiated using the "RECORD_ON_START" parameter, the user details will not be populated.

const (
	RecordingPauseResumeStopRecordingResponseDataStartReasonReasonAPICall       RecordingPauseResumeStopRecordingResponseDataStartReasonReason = "API_CALL"
	RecordingPauseResumeStopRecordingResponseDataStartReasonReasonRecordOnStart RecordingPauseResumeStopRecordingResponseDataStartReasonReason = "RECORD_ON_START"
)

func (RecordingPauseResumeStopRecordingResponseDataStartReasonReason) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStatus added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStatus string

Current status of the recording.

const (
	RecordingPauseResumeStopRecordingResponseDataStatusInvoked   RecordingPauseResumeStopRecordingResponseDataStatus = "INVOKED"
	RecordingPauseResumeStopRecordingResponseDataStatusRecording RecordingPauseResumeStopRecordingResponseDataStatus = "RECORDING"
	RecordingPauseResumeStopRecordingResponseDataStatusUploading RecordingPauseResumeStopRecordingResponseDataStatus = "UPLOADING"
	RecordingPauseResumeStopRecordingResponseDataStatusUploaded  RecordingPauseResumeStopRecordingResponseDataStatus = "UPLOADED"
	RecordingPauseResumeStopRecordingResponseDataStatusErrored   RecordingPauseResumeStopRecordingResponseDataStatus = "ERRORED"
	RecordingPauseResumeStopRecordingResponseDataStatusPaused    RecordingPauseResumeStopRecordingResponseDataStatus = "PAUSED"
)

func (RecordingPauseResumeStopRecordingResponseDataStatus) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReason added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReason struct {
	Caller RecordingPauseResumeStopRecordingResponseDataStopReasonCaller `json:"caller"`
	// Specifies the reason why the recording stopped.
	Reason RecordingPauseResumeStopRecordingResponseDataStopReasonReason `json:"reason"`
	JSON   recordingPauseResumeStopRecordingResponseDataStopReasonJSON   `json:"-"`
}

func (*RecordingPauseResumeStopRecordingResponseDataStopReason) UnmarshalJSON added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReasonCaller added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReasonCaller struct {
	// Name of the user who stopped the recording.
	Name string `json:"name"`
	// The type can be an App or a user. If the type is `user`, then only the `user_Id`
	// and `name` are returned.
	Type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType `json:"type"`
	// The user ID of the person who stopped the recording.
	UserID string                                                            `json:"user_Id" format:"uuid"`
	JSON   recordingPauseResumeStopRecordingResponseDataStopReasonCallerJSON `json:"-"`
}

func (*RecordingPauseResumeStopRecordingResponseDataStopReasonCaller) UnmarshalJSON added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType string

The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.

const (
	RecordingPauseResumeStopRecordingResponseDataStopReasonCallerTypeOrganization RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType = "ORGANIZATION"
	RecordingPauseResumeStopRecordingResponseDataStopReasonCallerTypeUser         RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType = "USER"
)

func (RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReasonReason added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStopReasonReason string

Specifies the reason why the recording stopped.

const (
	RecordingPauseResumeStopRecordingResponseDataStopReasonReasonAPICall       RecordingPauseResumeStopRecordingResponseDataStopReasonReason = "API_CALL"
	RecordingPauseResumeStopRecordingResponseDataStopReasonReasonInternalError RecordingPauseResumeStopRecordingResponseDataStopReasonReason = "INTERNAL_ERROR"
	RecordingPauseResumeStopRecordingResponseDataStopReasonReasonAllPeersLeft  RecordingPauseResumeStopRecordingResponseDataStopReasonReason = "ALL_PEERS_LEFT"
)

func (RecordingPauseResumeStopRecordingResponseDataStopReasonReason) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStorageConfig added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStorageConfig struct {
	// Type of storage media.
	Type RecordingPauseResumeStopRecordingResponseDataStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                         `json:"username"`
	JSON     recordingPauseResumeStopRecordingResponseDataStorageConfigJSON `json:"-"`
}

func (*RecordingPauseResumeStopRecordingResponseDataStorageConfig) UnmarshalJSON added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethodKey      RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod = "KEY"
	RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethodPassword RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod = "PASSWORD"
)

func (RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod) IsKnown added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStorageConfigType added in v6.6.0

type RecordingPauseResumeStopRecordingResponseDataStorageConfigType string

Type of storage media.

const (
	RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeAws          RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "aws"
	RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeAzure        RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "azure"
	RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeDigitalocean RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "digitalocean"
	RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeGcs          RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "gcs"
	RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeSftp         RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "sftp"
)

func (RecordingPauseResumeStopRecordingResponseDataStorageConfigType) IsKnown added in v6.6.0

type RecordingService added in v6.6.0

type RecordingService struct {
	Options []option.RequestOption
}

RecordingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRecordingService method instead.

func NewRecordingService added in v6.6.0

func NewRecordingService(opts ...option.RequestOption) (r *RecordingService)

NewRecordingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*RecordingService) GetActiveRecordings added in v6.6.0

func (r *RecordingService) GetActiveRecordings(ctx context.Context, appID string, meetingID string, query RecordingGetActiveRecordingsParams, opts ...option.RequestOption) (res *RecordingGetActiveRecordingsResponse, err error)

Returns the active recording details for the given meeting ID.

func (*RecordingService) GetOneRecording added in v6.6.0

func (r *RecordingService) GetOneRecording(ctx context.Context, appID string, recordingID string, query RecordingGetOneRecordingParams, opts ...option.RequestOption) (res *RecordingGetOneRecordingResponse, err error)

Returns details of a recording for the given recording ID.

func (*RecordingService) GetRecordings added in v6.6.0

Returns all recordings for an App. If the `meeting_id` parameter is passed, returns all recordings for the given meeting ID.

func (*RecordingService) PauseResumeStopRecording added in v6.6.0

func (r *RecordingService) PauseResumeStopRecording(ctx context.Context, appID string, recordingID string, params RecordingPauseResumeStopRecordingParams, opts ...option.RequestOption) (res *RecordingPauseResumeStopRecordingResponse, err error)

Pause/Resume/Stop a given recording ID.

func (*RecordingService) StartRecordings added in v6.6.0

Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

func (*RecordingService) StartTrackRecording added in v6.6.0

func (r *RecordingService) StartTrackRecording(ctx context.Context, appID string, params RecordingStartTrackRecordingParams, opts ...option.RequestOption) (err error)

Starts a track recording in a meeting. Track recordings consist of "layers". Layers are used to map audio/video tracks in a meeting to output destinations. More information about track recordings is available in the [Track Recordings Guide Page](https://docs.realtime.cloudflare.com/guides/capabilities/recording/recording-overview).

type RecordingStartRecordingsParams added in v6.6.0

type RecordingStartRecordingsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// By default, a meeting allows only one recording to run at a time. Enabling the
	// `allow_multiple_recordings` parameter to true allows you to initiate multiple
	// recordings concurrently in the same meeting. This allows you to record separate
	// videos of the same meeting with different configurations, such as portrait mode
	// or landscape mode.
	AllowMultipleRecordings param.Field[bool] `json:"allow_multiple_recordings"`
	// Object containing configuration regarding the audio that is being recorded.
	AudioConfig param.Field[RecordingStartRecordingsParamsAudioConfig] `json:"audio_config"`
	// Update the recording file name.
	FileNamePrefix param.Field[string] `json:"file_name_prefix"`
	// Allows you to add timed metadata to your recordings, which are digital markers
	// inserted into a video file to provide contextual information at specific points
	// in the content range. The ID3 tags containing this information are available to
	// clients on the playback timeline in HLS format. The output files are generated
	// in a compressed .tar format.
	InteractiveConfig param.Field[RecordingStartRecordingsParamsInteractiveConfig] `json:"interactive_config"`
	// Specifies the maximum duration for recording in seconds, ranging from a minimum
	// of 60 seconds to a maximum of 24 hours.
	MaxSeconds param.Field[int64] `json:"max_seconds"`
	// ID of the meeting to record.
	MeetingID               param.Field[string]                                                `json:"meeting_id" format:"uuid"`
	RealtimekitBucketConfig param.Field[RecordingStartRecordingsParamsRealtimekitBucketConfig] `json:"realtimekit_bucket_config"`
	RtmpOutConfig           param.Field[RecordingStartRecordingsParamsRtmpOutConfig]           `json:"rtmp_out_config"`
	StorageConfig           param.Field[RecordingStartRecordingsParamsStorageConfig]           `json:"storage_config"`
	// Pass a custom url to record arbitary screen
	URL         param.Field[string]                                    `json:"url" format:"uri"`
	VideoConfig param.Field[RecordingStartRecordingsParamsVideoConfig] `json:"video_config"`
}

func (RecordingStartRecordingsParams) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParams) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsAudioConfig added in v6.6.0

type RecordingStartRecordingsParamsAudioConfig struct {
	// Audio signal pathway within an audio file that carries a specific sound source.
	Channel param.Field[RecordingStartRecordingsParamsAudioConfigChannel] `json:"channel"`
	// Codec using which the recording will be encoded. If VP8/VP9 is selected for
	// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
	// audioConfig is automatically set to vorbis.
	Codec param.Field[RecordingStartRecordingsParamsAudioConfigCodec] `json:"codec"`
	// Controls whether to export audio file seperately
	ExportFile param.Field[bool] `json:"export_file"`
}

Object containing configuration regarding the audio that is being recorded.

func (RecordingStartRecordingsParamsAudioConfig) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParamsAudioConfig) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsAudioConfigChannel added in v6.6.0

type RecordingStartRecordingsParamsAudioConfigChannel string

Audio signal pathway within an audio file that carries a specific sound source.

const (
	RecordingStartRecordingsParamsAudioConfigChannelMono   RecordingStartRecordingsParamsAudioConfigChannel = "mono"
	RecordingStartRecordingsParamsAudioConfigChannelStereo RecordingStartRecordingsParamsAudioConfigChannel = "stereo"
)

func (RecordingStartRecordingsParamsAudioConfigChannel) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsAudioConfigCodec added in v6.6.0

type RecordingStartRecordingsParamsAudioConfigCodec string

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

const (
	RecordingStartRecordingsParamsAudioConfigCodecMP3 RecordingStartRecordingsParamsAudioConfigCodec = "MP3"
	RecordingStartRecordingsParamsAudioConfigCodecAac RecordingStartRecordingsParamsAudioConfigCodec = "AAC"
)

func (RecordingStartRecordingsParamsAudioConfigCodec) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsInteractiveConfig added in v6.6.0

type RecordingStartRecordingsParamsInteractiveConfig struct {
	// The metadata is presented in the form of ID3 tags.
	Type param.Field[RecordingStartRecordingsParamsInteractiveConfigType] `json:"type"`
}

Allows you to add timed metadata to your recordings, which are digital markers inserted into a video file to provide contextual information at specific points in the content range. The ID3 tags containing this information are available to clients on the playback timeline in HLS format. The output files are generated in a compressed .tar format.

func (RecordingStartRecordingsParamsInteractiveConfig) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParamsInteractiveConfig) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsInteractiveConfigType added in v6.6.0

type RecordingStartRecordingsParamsInteractiveConfigType string

The metadata is presented in the form of ID3 tags.

const (
	RecordingStartRecordingsParamsInteractiveConfigTypeId3 RecordingStartRecordingsParamsInteractiveConfigType = "ID3"
)

func (RecordingStartRecordingsParamsInteractiveConfigType) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsRealtimekitBucketConfig added in v6.6.0

type RecordingStartRecordingsParamsRealtimekitBucketConfig struct {
	// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
	// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
	// generated for a recording.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (RecordingStartRecordingsParamsRealtimekitBucketConfig) MarshalJSON added in v6.6.0

type RecordingStartRecordingsParamsRtmpOutConfig added in v6.6.0

type RecordingStartRecordingsParamsRtmpOutConfig struct {
	// RTMP URL to stream to
	RtmpURL param.Field[string] `json:"rtmp_url" format:"uri"`
}

func (RecordingStartRecordingsParamsRtmpOutConfig) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParamsRtmpOutConfig) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsStorageConfig added in v6.6.0

type RecordingStartRecordingsParamsStorageConfig struct {
	// Type of storage media.
	Type param.Field[RecordingStartRecordingsParamsStorageConfigType] `json:"type,required"`
	// Access key of the storage medium. Access key is not required for the `gcs`
	// storage media type.
	//
	// Note that this field is not readable by clients, only writeable.
	AccessKey param.Field[string] `json:"access_key"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod param.Field[RecordingStartRecordingsParamsStorageConfigAuthMethod] `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket param.Field[string] `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host param.Field[string] `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password param.Field[string] `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path param.Field[string] `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port param.Field[float64] `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey param.Field[string] `json:"private_key"`
	// Region of the storage medium.
	Region param.Field[string] `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret param.Field[string] `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username param.Field[string] `json:"username"`
}

func (RecordingStartRecordingsParamsStorageConfig) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParamsStorageConfig) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsStorageConfigAuthMethod added in v6.6.0

type RecordingStartRecordingsParamsStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	RecordingStartRecordingsParamsStorageConfigAuthMethodKey      RecordingStartRecordingsParamsStorageConfigAuthMethod = "KEY"
	RecordingStartRecordingsParamsStorageConfigAuthMethodPassword RecordingStartRecordingsParamsStorageConfigAuthMethod = "PASSWORD"
)

func (RecordingStartRecordingsParamsStorageConfigAuthMethod) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsStorageConfigType added in v6.6.0

type RecordingStartRecordingsParamsStorageConfigType string

Type of storage media.

const (
	RecordingStartRecordingsParamsStorageConfigTypeAws          RecordingStartRecordingsParamsStorageConfigType = "aws"
	RecordingStartRecordingsParamsStorageConfigTypeAzure        RecordingStartRecordingsParamsStorageConfigType = "azure"
	RecordingStartRecordingsParamsStorageConfigTypeDigitalocean RecordingStartRecordingsParamsStorageConfigType = "digitalocean"
	RecordingStartRecordingsParamsStorageConfigTypeGcs          RecordingStartRecordingsParamsStorageConfigType = "gcs"
	RecordingStartRecordingsParamsStorageConfigTypeSftp         RecordingStartRecordingsParamsStorageConfigType = "sftp"
)

func (RecordingStartRecordingsParamsStorageConfigType) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsVideoConfig added in v6.6.0

type RecordingStartRecordingsParamsVideoConfig struct {
	// Codec using which the recording will be encoded.
	Codec param.Field[RecordingStartRecordingsParamsVideoConfigCodec] `json:"codec"`
	// Controls whether to export video file seperately
	ExportFile param.Field[bool] `json:"export_file"`
	// Height of the recording video in pixels
	Height param.Field[int64] `json:"height"`
	// Watermark to be added to the recording
	Watermark param.Field[RecordingStartRecordingsParamsVideoConfigWatermark] `json:"watermark"`
	// Width of the recording video in pixels
	Width param.Field[int64] `json:"width"`
}

func (RecordingStartRecordingsParamsVideoConfig) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParamsVideoConfig) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsVideoConfigCodec added in v6.6.0

type RecordingStartRecordingsParamsVideoConfigCodec string

Codec using which the recording will be encoded.

const (
	RecordingStartRecordingsParamsVideoConfigCodecH264 RecordingStartRecordingsParamsVideoConfigCodec = "H264"
	RecordingStartRecordingsParamsVideoConfigCodecVp8  RecordingStartRecordingsParamsVideoConfigCodec = "VP8"
)

func (RecordingStartRecordingsParamsVideoConfigCodec) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsVideoConfigWatermark added in v6.6.0

type RecordingStartRecordingsParamsVideoConfigWatermark struct {
	// Position of the watermark
	Position param.Field[RecordingStartRecordingsParamsVideoConfigWatermarkPosition] `json:"position"`
	// Size of the watermark
	Size param.Field[RecordingStartRecordingsParamsVideoConfigWatermarkSize] `json:"size"`
	// URL of the watermark image
	URL param.Field[string] `json:"url" format:"uri"`
}

Watermark to be added to the recording

func (RecordingStartRecordingsParamsVideoConfigWatermark) MarshalJSON added in v6.6.0

func (r RecordingStartRecordingsParamsVideoConfigWatermark) MarshalJSON() (data []byte, err error)

type RecordingStartRecordingsParamsVideoConfigWatermarkPosition added in v6.6.0

type RecordingStartRecordingsParamsVideoConfigWatermarkPosition string

Position of the watermark

const (
	RecordingStartRecordingsParamsVideoConfigWatermarkPositionLeftTop     RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "left top"
	RecordingStartRecordingsParamsVideoConfigWatermarkPositionRightTop    RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "right top"
	RecordingStartRecordingsParamsVideoConfigWatermarkPositionLeftBottom  RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "left bottom"
	RecordingStartRecordingsParamsVideoConfigWatermarkPositionRightBottom RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "right bottom"
)

func (RecordingStartRecordingsParamsVideoConfigWatermarkPosition) IsKnown added in v6.6.0

type RecordingStartRecordingsParamsVideoConfigWatermarkSize added in v6.6.0

type RecordingStartRecordingsParamsVideoConfigWatermarkSize struct {
	// Height of the watermark in px
	Height param.Field[int64] `json:"height"`
	// Width of the watermark in px
	Width param.Field[int64] `json:"width"`
}

Size of the watermark

func (RecordingStartRecordingsParamsVideoConfigWatermarkSize) MarshalJSON added in v6.6.0

type RecordingStartRecordingsResponse added in v6.6.0

type RecordingStartRecordingsResponse struct {
	// Success status of the operation
	Success bool `json:"success,required"`
	// Data returned by the operation
	Data RecordingStartRecordingsResponseData `json:"data"`
	JSON recordingStartRecordingsResponseJSON `json:"-"`
}

func (*RecordingStartRecordingsResponse) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponse) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseData added in v6.6.0

type RecordingStartRecordingsResponseData struct {
	// ID of the recording
	ID string `json:"id,required" format:"uuid"`
	// If the audio_config is passed, the URL for downloading the audio recording is
	// returned.
	AudioDownloadURL string `json:"audio_download_url,required,nullable" format:"uri"`
	// URL where the recording can be downloaded.
	DownloadURL string `json:"download_url,required,nullable" format:"uri"`
	// Timestamp when the download URL expires.
	DownloadURLExpiry time.Time `json:"download_url_expiry,required,nullable" format:"date-time"`
	// File size of the recording, in bytes.
	FileSize float64 `json:"file_size,required,nullable"`
	// Timestamp when this recording was invoked.
	InvokedTime time.Time `json:"invoked_time,required" format:"date-time"`
	// File name of the recording.
	OutputFileName string `json:"output_file_name,required"`
	// ID of the meeting session this recording is for.
	SessionID string `json:"session_id,required,nullable" format:"uuid"`
	// Timestamp when this recording actually started after being invoked. Usually a
	// few seconds after `invoked_time`.
	StartedTime time.Time `json:"started_time,required,nullable" format:"date-time"`
	// Current status of the recording.
	Status RecordingStartRecordingsResponseDataStatus `json:"status,required"`
	// Timestamp when this recording was stopped. Optional; is present only when the
	// recording has actually been stopped.
	StoppedTime time.Time `json:"stopped_time,required,nullable" format:"date-time"`
	// Total recording time in seconds.
	RecordingDuration int64                                             `json:"recording_duration"`
	StartReason       RecordingStartRecordingsResponseDataStartReason   `json:"start_reason"`
	StopReason        RecordingStartRecordingsResponseDataStopReason    `json:"stop_reason"`
	StorageConfig     RecordingStartRecordingsResponseDataStorageConfig `json:"storage_config,nullable"`
	JSON              recordingStartRecordingsResponseDataJSON          `json:"-"`
}

Data returned by the operation

func (*RecordingStartRecordingsResponseData) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponseData) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseDataStartReason added in v6.6.0

type RecordingStartRecordingsResponseDataStartReason struct {
	Caller RecordingStartRecordingsResponseDataStartReasonCaller `json:"caller"`
	// Specifies if the recording was started using the "Start a Recording"API or using
	// the parameter RECORD_ON_START in the "Create a meeting" API.
	//
	// If the recording is initiated using the "RECORD_ON_START" parameter, the user
	// details will not be populated.
	Reason RecordingStartRecordingsResponseDataStartReasonReason `json:"reason"`
	JSON   recordingStartRecordingsResponseDataStartReasonJSON   `json:"-"`
}

func (*RecordingStartRecordingsResponseDataStartReason) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponseDataStartReason) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseDataStartReasonCaller added in v6.6.0

type RecordingStartRecordingsResponseDataStartReasonCaller struct {
	// Name of the user who started the recording.
	Name string `json:"name"`
	// The type can be an App or a user. If the type is `user`, then only the `user_Id`
	// and `name` are returned.
	Type RecordingStartRecordingsResponseDataStartReasonCallerType `json:"type"`
	// The user ID of the person who started the recording.
	UserID string                                                    `json:"user_Id" format:"uuid"`
	JSON   recordingStartRecordingsResponseDataStartReasonCallerJSON `json:"-"`
}

func (*RecordingStartRecordingsResponseDataStartReasonCaller) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponseDataStartReasonCaller) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseDataStartReasonCallerType added in v6.6.0

type RecordingStartRecordingsResponseDataStartReasonCallerType string

The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.

const (
	RecordingStartRecordingsResponseDataStartReasonCallerTypeOrganization RecordingStartRecordingsResponseDataStartReasonCallerType = "ORGANIZATION"
	RecordingStartRecordingsResponseDataStartReasonCallerTypeUser         RecordingStartRecordingsResponseDataStartReasonCallerType = "USER"
)

func (RecordingStartRecordingsResponseDataStartReasonCallerType) IsKnown added in v6.6.0

type RecordingStartRecordingsResponseDataStartReasonReason added in v6.6.0

type RecordingStartRecordingsResponseDataStartReasonReason string

Specifies if the recording was started using the "Start a Recording"API or using the parameter RECORD_ON_START in the "Create a meeting" API.

If the recording is initiated using the "RECORD_ON_START" parameter, the user details will not be populated.

const (
	RecordingStartRecordingsResponseDataStartReasonReasonAPICall       RecordingStartRecordingsResponseDataStartReasonReason = "API_CALL"
	RecordingStartRecordingsResponseDataStartReasonReasonRecordOnStart RecordingStartRecordingsResponseDataStartReasonReason = "RECORD_ON_START"
)

func (RecordingStartRecordingsResponseDataStartReasonReason) IsKnown added in v6.6.0

type RecordingStartRecordingsResponseDataStatus added in v6.6.0

type RecordingStartRecordingsResponseDataStatus string

Current status of the recording.

const (
	RecordingStartRecordingsResponseDataStatusInvoked   RecordingStartRecordingsResponseDataStatus = "INVOKED"
	RecordingStartRecordingsResponseDataStatusRecording RecordingStartRecordingsResponseDataStatus = "RECORDING"
	RecordingStartRecordingsResponseDataStatusUploading RecordingStartRecordingsResponseDataStatus = "UPLOADING"
	RecordingStartRecordingsResponseDataStatusUploaded  RecordingStartRecordingsResponseDataStatus = "UPLOADED"
	RecordingStartRecordingsResponseDataStatusErrored   RecordingStartRecordingsResponseDataStatus = "ERRORED"
	RecordingStartRecordingsResponseDataStatusPaused    RecordingStartRecordingsResponseDataStatus = "PAUSED"
)

func (RecordingStartRecordingsResponseDataStatus) IsKnown added in v6.6.0

type RecordingStartRecordingsResponseDataStopReason added in v6.6.0

type RecordingStartRecordingsResponseDataStopReason struct {
	Caller RecordingStartRecordingsResponseDataStopReasonCaller `json:"caller"`
	// Specifies the reason why the recording stopped.
	Reason RecordingStartRecordingsResponseDataStopReasonReason `json:"reason"`
	JSON   recordingStartRecordingsResponseDataStopReasonJSON   `json:"-"`
}

func (*RecordingStartRecordingsResponseDataStopReason) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponseDataStopReason) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseDataStopReasonCaller added in v6.6.0

type RecordingStartRecordingsResponseDataStopReasonCaller struct {
	// Name of the user who stopped the recording.
	Name string `json:"name"`
	// The type can be an App or a user. If the type is `user`, then only the `user_Id`
	// and `name` are returned.
	Type RecordingStartRecordingsResponseDataStopReasonCallerType `json:"type"`
	// The user ID of the person who stopped the recording.
	UserID string                                                   `json:"user_Id" format:"uuid"`
	JSON   recordingStartRecordingsResponseDataStopReasonCallerJSON `json:"-"`
}

func (*RecordingStartRecordingsResponseDataStopReasonCaller) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponseDataStopReasonCaller) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseDataStopReasonCallerType added in v6.6.0

type RecordingStartRecordingsResponseDataStopReasonCallerType string

The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.

const (
	RecordingStartRecordingsResponseDataStopReasonCallerTypeOrganization RecordingStartRecordingsResponseDataStopReasonCallerType = "ORGANIZATION"
	RecordingStartRecordingsResponseDataStopReasonCallerTypeUser         RecordingStartRecordingsResponseDataStopReasonCallerType = "USER"
)

func (RecordingStartRecordingsResponseDataStopReasonCallerType) IsKnown added in v6.6.0

type RecordingStartRecordingsResponseDataStopReasonReason added in v6.6.0

type RecordingStartRecordingsResponseDataStopReasonReason string

Specifies the reason why the recording stopped.

const (
	RecordingStartRecordingsResponseDataStopReasonReasonAPICall       RecordingStartRecordingsResponseDataStopReasonReason = "API_CALL"
	RecordingStartRecordingsResponseDataStopReasonReasonInternalError RecordingStartRecordingsResponseDataStopReasonReason = "INTERNAL_ERROR"
	RecordingStartRecordingsResponseDataStopReasonReasonAllPeersLeft  RecordingStartRecordingsResponseDataStopReasonReason = "ALL_PEERS_LEFT"
)

func (RecordingStartRecordingsResponseDataStopReasonReason) IsKnown added in v6.6.0

type RecordingStartRecordingsResponseDataStorageConfig added in v6.6.0

type RecordingStartRecordingsResponseDataStorageConfig struct {
	// Type of storage media.
	Type RecordingStartRecordingsResponseDataStorageConfigType `json:"type,required"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod RecordingStartRecordingsResponseDataStorageConfigAuthMethod `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket string `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host string `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password string `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path string `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port float64 `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey string `json:"private_key"`
	// Region of the storage medium.
	Region string `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret string `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username string                                                `json:"username"`
	JSON     recordingStartRecordingsResponseDataStorageConfigJSON `json:"-"`
}

func (*RecordingStartRecordingsResponseDataStorageConfig) UnmarshalJSON added in v6.6.0

func (r *RecordingStartRecordingsResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)

type RecordingStartRecordingsResponseDataStorageConfigAuthMethod added in v6.6.0

type RecordingStartRecordingsResponseDataStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	RecordingStartRecordingsResponseDataStorageConfigAuthMethodKey      RecordingStartRecordingsResponseDataStorageConfigAuthMethod = "KEY"
	RecordingStartRecordingsResponseDataStorageConfigAuthMethodPassword RecordingStartRecordingsResponseDataStorageConfigAuthMethod = "PASSWORD"
)

func (RecordingStartRecordingsResponseDataStorageConfigAuthMethod) IsKnown added in v6.6.0

type RecordingStartRecordingsResponseDataStorageConfigType added in v6.6.0

type RecordingStartRecordingsResponseDataStorageConfigType string

Type of storage media.

const (
	RecordingStartRecordingsResponseDataStorageConfigTypeAws          RecordingStartRecordingsResponseDataStorageConfigType = "aws"
	RecordingStartRecordingsResponseDataStorageConfigTypeAzure        RecordingStartRecordingsResponseDataStorageConfigType = "azure"
	RecordingStartRecordingsResponseDataStorageConfigTypeDigitalocean RecordingStartRecordingsResponseDataStorageConfigType = "digitalocean"
	RecordingStartRecordingsResponseDataStorageConfigTypeGcs          RecordingStartRecordingsResponseDataStorageConfigType = "gcs"
	RecordingStartRecordingsResponseDataStorageConfigTypeSftp         RecordingStartRecordingsResponseDataStorageConfigType = "sftp"
)

func (RecordingStartRecordingsResponseDataStorageConfigType) IsKnown added in v6.6.0

type RecordingStartTrackRecordingParams added in v6.6.0

type RecordingStartTrackRecordingParams struct {
	// The account identifier tag.
	AccountID param.Field[string]                                              `path:"account_id,required"`
	Layers    param.Field[map[string]RecordingStartTrackRecordingParamsLayers] `json:"layers,required"`
	// ID of the meeting to record.
	MeetingID param.Field[string] `json:"meeting_id,required"`
	// Maximum seconds this recording should be active for (beta)
	MaxSeconds param.Field[float64] `json:"max_seconds"`
}

func (RecordingStartTrackRecordingParams) MarshalJSON added in v6.6.0

func (r RecordingStartTrackRecordingParams) MarshalJSON() (data []byte, err error)

type RecordingStartTrackRecordingParamsLayers added in v6.6.0

type RecordingStartTrackRecordingParamsLayers struct {
	// A file name prefix to apply for files generated from this layer
	FileNamePrefix param.Field[string]                                           `json:"file_name_prefix"`
	Outputs        param.Field[[]RecordingStartTrackRecordingParamsLayersOutput] `json:"outputs"`
}

func (RecordingStartTrackRecordingParamsLayers) MarshalJSON added in v6.6.0

func (r RecordingStartTrackRecordingParamsLayers) MarshalJSON() (data []byte, err error)

type RecordingStartTrackRecordingParamsLayersOutput added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutput struct {
	StorageConfig param.Field[RecordingStartTrackRecordingParamsLayersOutputsStorageConfig] `json:"storage_config"`
	// The type of output destination this layer is being exported to.
	Type param.Field[RecordingStartTrackRecordingParamsLayersOutputsType] `json:"type"`
}

func (RecordingStartTrackRecordingParamsLayersOutput) MarshalJSON added in v6.6.0

func (r RecordingStartTrackRecordingParamsLayersOutput) MarshalJSON() (data []byte, err error)

type RecordingStartTrackRecordingParamsLayersOutputsStorageConfig added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsStorageConfig struct {
	// Type of storage media.
	Type param.Field[RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType] `json:"type,required"`
	// Access key of the storage medium. Access key is not required for the `gcs`
	// storage media type.
	//
	// Note that this field is not readable by clients, only writeable.
	AccessKey param.Field[string] `json:"access_key"`
	// Authentication method used for "sftp" type storage medium
	AuthMethod param.Field[RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod] `json:"auth_method"`
	// Name of the storage medium's bucket.
	Bucket param.Field[string] `json:"bucket"`
	// SSH destination server host for SFTP type storage medium
	Host param.Field[string] `json:"host"`
	// SSH destination server password for SFTP type storage medium when auth_method is
	// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
	// private key.
	Password param.Field[string] `json:"password"`
	// Path relative to the bucket root at which the recording will be placed.
	Path param.Field[string] `json:"path"`
	// SSH destination server port for SFTP type storage medium
	Port param.Field[float64] `json:"port"`
	// Private key used to login to destination SSH server for SFTP type storage
	// medium, when auth_method used is "KEY"
	PrivateKey param.Field[string] `json:"private_key"`
	// Region of the storage medium.
	Region param.Field[string] `json:"region"`
	// Secret key of the storage medium. Similar to `access_key`, it is only writeable
	// by clients, not readable.
	Secret param.Field[string] `json:"secret"`
	// SSH destination server username for SFTP type storage medium
	Username param.Field[string] `json:"username"`
}

func (RecordingStartTrackRecordingParamsLayersOutputsStorageConfig) MarshalJSON added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod string

Authentication method used for "sftp" type storage medium

const (
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethodKey      RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod = "KEY"
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethodPassword RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod = "PASSWORD"
)

func (RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod) IsKnown added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType string

Type of storage media.

const (
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeAws          RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "aws"
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeAzure        RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "azure"
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeDigitalocean RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "digitalocean"
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeGcs          RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "gcs"
	RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeSftp         RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "sftp"
)

func (RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType) IsKnown added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsType added in v6.6.0

type RecordingStartTrackRecordingParamsLayersOutputsType string

The type of output destination this layer is being exported to.

const (
	RecordingStartTrackRecordingParamsLayersOutputsTypeRealtimekitBucket RecordingStartTrackRecordingParamsLayersOutputsType = "REALTIMEKIT_BUCKET"
	RecordingStartTrackRecordingParamsLayersOutputsTypeStorageConfig     RecordingStartTrackRecordingParamsLayersOutputsType = "STORAGE_CONFIG"
)

func (RecordingStartTrackRecordingParamsLayersOutputsType) IsKnown added in v6.6.0

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SessionGenerateSummaryOfTranscriptsParams added in v6.6.0

type SessionGenerateSummaryOfTranscriptsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SessionGetParticipantDataFromPeerIDParams added in v6.6.0

type SessionGetParticipantDataFromPeerIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Comma separated list of filters to apply. Note that there must be no spaces
	// between the filters.
	Filters param.Field[SessionGetParticipantDataFromPeerIDParamsFilters] `query:"filters"`
}

func (SessionGetParticipantDataFromPeerIDParams) URLQuery added in v6.6.0

URLQuery serializes SessionGetParticipantDataFromPeerIDParams's query parameters as `url.Values`.

type SessionGetParticipantDataFromPeerIDParamsFilters added in v6.6.0

type SessionGetParticipantDataFromPeerIDParamsFilters string

Comma separated list of filters to apply. Note that there must be no spaces between the filters.

const (
	SessionGetParticipantDataFromPeerIDParamsFiltersDeviceInfo                SessionGetParticipantDataFromPeerIDParamsFilters = "device_info"
	SessionGetParticipantDataFromPeerIDParamsFiltersIPInformation             SessionGetParticipantDataFromPeerIDParamsFilters = "ip_information"
	SessionGetParticipantDataFromPeerIDParamsFiltersPrecallNetworkInformation SessionGetParticipantDataFromPeerIDParamsFilters = "precall_network_information"
	SessionGetParticipantDataFromPeerIDParamsFiltersEvents                    SessionGetParticipantDataFromPeerIDParamsFilters = "events"
	SessionGetParticipantDataFromPeerIDParamsFiltersQualityStats              SessionGetParticipantDataFromPeerIDParamsFilters = "quality_stats"
)

func (SessionGetParticipantDataFromPeerIDParamsFilters) IsKnown added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponse added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponse struct {
	Data    SessionGetParticipantDataFromPeerIDResponseData `json:"data"`
	Success bool                                            `json:"success"`
	JSON    sessionGetParticipantDataFromPeerIDResponseJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetParticipantDataFromPeerIDResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetParticipantDataFromPeerIDResponseData added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseData struct {
	Participant SessionGetParticipantDataFromPeerIDResponseDataParticipant `json:"participant"`
	JSON        sessionGetParticipantDataFromPeerIDResponseDataJSON        `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetParticipantDataFromPeerIDResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetParticipantDataFromPeerIDResponseDataParticipant added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipant struct {
	ID                  string                                                                 `json:"id"`
	CreatedAt           string                                                                 `json:"created_at"`
	CustomParticipantID string                                                                 `json:"custom_participant_id"`
	DisplayName         string                                                                 `json:"display_name"`
	Duration            float64                                                                `json:"duration"`
	JoinedAt            string                                                                 `json:"joined_at"`
	LeftAt              string                                                                 `json:"left_at"`
	PeerReport          SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport   `json:"peer_report"`
	PeerStats           SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats    `json:"peer_stats"`
	QualityStats        SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats `json:"quality_stats"`
	Role                string                                                                 `json:"role"`
	UpdatedAt           string                                                                 `json:"updated_at"`
	UserID              string                                                                 `json:"user_id"`
	JSON                sessionGetParticipantDataFromPeerIDResponseDataParticipantJSON         `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipant) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport struct {
	Metadata SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata `json:"metadata"`
	Quality  SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality  `json:"quality"`
	JSON     sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportJSON     `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata struct {
	AudioDevicesUpdates   []interface{}                                                                               `json:"audio_devices_updates"`
	BrowserMetadata       SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata `json:"browser_metadata"`
	CandidatePairs        SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs  `json:"candidate_pairs"`
	DeviceInfo            SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo      `json:"device_info"`
	Events                []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent         `json:"events"`
	IPInformation         SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation   `json:"ip_information"`
	PcMetadata            []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata    `json:"pc_metadata"`
	RoomViewType          string                                                                                      `json:"room_view_type"`
	SDKName               string                                                                                      `json:"sdk_name"`
	SDKVersion            string                                                                                      `json:"sdk_version"`
	SelectedDeviceUpdates []interface{}                                                                               `json:"selected_device_updates"`
	SpeakerDevicesUpdates []interface{}                                                                               `json:"speaker_devices_updates"`
	VideoDevicesUpdates   []interface{}                                                                               `json:"video_devices_updates"`
	JSON                  sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataJSON            `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata struct {
	Browser        string                                                                                          `json:"browser"`
	BrowserVersion string                                                                                          `json:"browser_version"`
	Engine         string                                                                                          `json:"engine"`
	UserAgent      string                                                                                          `json:"user_agent"`
	WebglSupport   string                                                                                          `json:"webgl_support"`
	JSON           sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadataJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs struct {
	ConsumingTransport []interface{}                                                                                                  `json:"consuming_transport"`
	ProducingTransport []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport `json:"producing_transport"`
	JSON               sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsJSON                 `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport struct {
	AvailableOutgoingBitrate     int64                                                                                                            `json:"available_outgoing_bitrate"`
	BytesDiscardedOnSend         int64                                                                                                            `json:"bytes_discarded_on_send"`
	BytesReceived                int64                                                                                                            `json:"bytes_received"`
	BytesSent                    int64                                                                                                            `json:"bytes_sent"`
	CurrentRoundTripTime         float64                                                                                                          `json:"current_round_trip_time"`
	LastPacketReceivedTimestamp  int64                                                                                                            `json:"last_packet_received_timestamp"`
	LastPacketSentTimestamp      int64                                                                                                            `json:"last_packet_sent_timestamp"`
	LocalCandidateAddress        string                                                                                                           `json:"local_candidate_address"`
	LocalCandidateID             string                                                                                                           `json:"local_candidate_id"`
	LocalCandidateNetworkType    string                                                                                                           `json:"local_candidate_network_type"`
	LocalCandidatePort           int64                                                                                                            `json:"local_candidate_port"`
	LocalCandidateProtocol       string                                                                                                           `json:"local_candidate_protocol"`
	LocalCandidateRelatedAddress string                                                                                                           `json:"local_candidate_related_address"`
	LocalCandidateRelatedPort    int64                                                                                                            `json:"local_candidate_related_port"`
	LocalCandidateType           string                                                                                                           `json:"local_candidate_type"`
	Nominated                    bool                                                                                                             `json:"nominated"`
	PacketsDiscardedOnSend       int64                                                                                                            `json:"packets_discarded_on_send"`
	PacketsReceived              int64                                                                                                            `json:"packets_received"`
	PacketsSent                  int64                                                                                                            `json:"packets_sent"`
	RemoteCandidateAddress       string                                                                                                           `json:"remote_candidate_address"`
	RemoteCandidateID            string                                                                                                           `json:"remote_candidate_id"`
	RemoteCandidatePort          int64                                                                                                            `json:"remote_candidate_port"`
	RemoteCandidateProtocol      string                                                                                                           `json:"remote_candidate_protocol"`
	RemoteCandidateType          string                                                                                                           `json:"remote_candidate_type"`
	TotalRoundTripTime           float64                                                                                                          `json:"total_round_trip_time"`
	JSON                         sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransportJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo struct {
	CPUs      int64                                                                                      `json:"cpus"`
	IsMobile  bool                                                                                       `json:"is_mobile"`
	OS        string                                                                                     `json:"os"`
	OSVersion string                                                                                     `json:"os_version"`
	JSON      sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfoJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent struct {
	Name      string                                                                                `json:"name"`
	Timestamp string                                                                                `json:"timestamp"`
	JSON      sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEventJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation struct {
	ASN      SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN  `json:"asn"`
	City     string                                                                                        `json:"city"`
	Country  string                                                                                        `json:"country"`
	IPV4     string                                                                                        `json:"ipv4"`
	Region   string                                                                                        `json:"region"`
	Timezone string                                                                                        `json:"timezone"`
	JSON     sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN struct {
	ASN  string                                                                                           `json:"asn"`
	JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASNJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata struct {
	EffectiveNetworkType  string                                                                                     `json:"effective_network_type"`
	ReflexiveConnectivity bool                                                                                       `json:"reflexive_connectivity"`
	RelayConnectivity     bool                                                                                       `json:"relay_connectivity"`
	Timestamp             string                                                                                     `json:"timestamp"`
	TURNConnectivity      bool                                                                                       `json:"turn_connectivity"`
	JSON                  sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadataJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality struct {
	AudioConsumer                      []interface{}                                                                                      `json:"audio_consumer"`
	AudioConsumerCumulative            interface{}                                                                                        `json:"audio_consumer_cumulative"`
	AudioProducer                      []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer         `json:"audio_producer"`
	AudioProducerCumulative            SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative `json:"audio_producer_cumulative"`
	ScreenshareAudioConsumer           []interface{}                                                                                      `json:"screenshare_audio_consumer"`
	ScreenshareAudioConsumerCumulative interface{}                                                                                        `json:"screenshare_audio_consumer_cumulative"`
	ScreenshareAudioProducer           []interface{}                                                                                      `json:"screenshare_audio_producer"`
	ScreenshareAudioProducerCumulative interface{}                                                                                        `json:"screenshare_audio_producer_cumulative"`
	ScreenshareVideoConsumer           []interface{}                                                                                      `json:"screenshare_video_consumer"`
	ScreenshareVideoConsumerCumulative interface{}                                                                                        `json:"screenshare_video_consumer_cumulative"`
	ScreenshareVideoProducer           []interface{}                                                                                      `json:"screenshare_video_producer"`
	ScreenshareVideoProducerCumulative interface{}                                                                                        `json:"screenshare_video_producer_cumulative"`
	VideoConsumer                      []interface{}                                                                                      `json:"video_consumer"`
	VideoConsumerCumulative            interface{}                                                                                        `json:"video_consumer_cumulative"`
	VideoProducer                      []interface{}                                                                                      `json:"video_producer"`
	VideoProducerCumulative            interface{}                                                                                        `json:"video_producer_cumulative"`
	JSON                               sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityJSON                    `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer struct {
	BytesSent   int64                                                                                        `json:"bytes_sent"`
	Jitter      int64                                                                                        `json:"jitter"`
	Mid         string                                                                                       `json:"mid"`
	MosQuality  int64                                                                                        `json:"mos_quality"`
	PacketsLost int64                                                                                        `json:"packets_lost"`
	PacketsSent int64                                                                                        `json:"packets_sent"`
	ProducerID  string                                                                                       `json:"producer_id"`
	RTT         float64                                                                                      `json:"rtt"`
	Ssrc        int64                                                                                        `json:"ssrc"`
	Timestamp   string                                                                                       `json:"timestamp"`
	JSON        sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative struct {
	PacketLoss SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss `json:"packet_loss"`
	QualityMos SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos `json:"quality_mos"`
	RTT        SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT        `json:"rtt"`
	JSON       sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeJSON       `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss struct {
	Number10OrGreaterEventFraction int64                                                                                                            `json:"10_or_greater_event_fraction"`
	Number25OrGreaterEventFraction int64                                                                                                            `json:"25_or_greater_event_fraction"`
	Number5OrGreaterEventFraction  int64                                                                                                            `json:"5_or_greater_event_fraction"`
	Number50OrGreaterEventFraction int64                                                                                                            `json:"50_or_greater_event_fraction"`
	Avg                            int64                                                                                                            `json:"avg"`
	JSON                           sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLossJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos struct {
	Avg  int64                                                                                                            `json:"avg"`
	P50  int64                                                                                                            `json:"p50"`
	P75  int64                                                                                                            `json:"p75"`
	P90  int64                                                                                                            `json:"p90"`
	JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMosJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT struct {
	Number100msOrGreaterEventFraction float64                                                                                                   `json:"100ms_or_greater_event_fraction"`
	Number250msOrGreaterEventFraction float64                                                                                                   `json:"250ms_or_greater_event_fraction"`
	Number500msOrGreaterEventFraction float64                                                                                                   `json:"500ms_or_greater_event_fraction"`
	Avg                               float64                                                                                                   `json:"avg"`
	JSON                              sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTTJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats struct {
	DeviceInfo                SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo                `json:"device_info"`
	Events                    []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent                   `json:"events"`
	IPInformation             SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation             `json:"ip_information"`
	PrecallNetworkInformation SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation `json:"precall_network_information"`
	JSON                      sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsJSON                      `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo struct {
	Browser        string                                                                            `json:"browser"`
	BrowserVersion string                                                                            `json:"browser_version"`
	CPUs           int64                                                                             `json:"cpus"`
	Engine         string                                                                            `json:"engine"`
	IsMobile       bool                                                                              `json:"is_mobile"`
	OS             string                                                                            `json:"os"`
	OSVersion      string                                                                            `json:"os_version"`
	SDKName        string                                                                            `json:"sdk_name"`
	SDKVersion     string                                                                            `json:"sdk_version"`
	UserAgent      string                                                                            `json:"user_agent"`
	WebglSupport   string                                                                            `json:"webgl_support"`
	JSON           sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfoJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent struct {
	Metadata  SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata `json:"metadata"`
	Timestamp string                                                                            `json:"timestamp"`
	Type      string                                                                            `json:"type"`
	JSON      sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventJSON      `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata struct {
	ConnectionInfo SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo `json:"connection_info"`
	JSON           sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataJSON           `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo struct {
	BackendRTT           float64                                                                                                     `json:"backend_r_t_t"`
	Connectivity         SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity `json:"connectivity"`
	EffectiveNetworkType string                                                                                                      `json:"effective_network_type"`
	FractionalLoss       int64                                                                                                       `json:"fractional_loss"`
	IPDetails            SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails    `json:"ip_details"`
	Jitter               int64                                                                                                       `json:"jitter"`
	Location             SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation     `json:"location"`
	RTT                  float64                                                                                                     `json:"r_t_t"`
	Throughput           int64                                                                                                       `json:"throughput"`
	TURNConnectivity     bool                                                                                                        `json:"turn_connectivity"`
	JSON                 sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoJSON         `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity struct {
	Host      bool                                                                                                            `json:"host"`
	Reflexive bool                                                                                                            `json:"reflexive"`
	Relay     bool                                                                                                            `json:"relay"`
	JSON      sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivityJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails struct {
	ASN      SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN  `json:"asn"`
	City     string                                                                                                       `json:"city"`
	Country  string                                                                                                       `json:"country"`
	IP       string                                                                                                       `json:"ip"`
	LOC      string                                                                                                       `json:"loc"`
	Postal   string                                                                                                       `json:"postal"`
	Region   string                                                                                                       `json:"region"`
	Timezone string                                                                                                       `json:"timezone"`
	JSON     sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN struct {
	ASN  string                                                                                                          `json:"asn"`
	JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASNJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation struct {
	Coords SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords `json:"coords"`
	JSON   sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationJSON   `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords struct {
	Latitude  float64                                                                                                           `json:"latitude"`
	Longitude float64                                                                                                           `json:"longitude"`
	JSON      sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoordsJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation struct {
	ASN        SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN  `json:"asn"`
	City       string                                                                               `json:"city"`
	Country    string                                                                               `json:"country"`
	IPLocation string                                                                               `json:"ip_location"`
	IPV4       string                                                                               `json:"ipv4"`
	Org        string                                                                               `json:"org"`
	Region     string                                                                               `json:"region"`
	Timezone   string                                                                               `json:"timezone"`
	JSON       sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN struct {
	ASN  string                                                                                  `json:"asn"`
	JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASNJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation struct {
	BackendRTT            float64                                                                                          `json:"backend_rtt"`
	EffectiveNetworktype  string                                                                                           `json:"effective_networktype"`
	FractionalLoss        int64                                                                                            `json:"fractional_loss"`
	Jitter                int64                                                                                            `json:"jitter"`
	ReflexiveConnectivity bool                                                                                             `json:"reflexive_connectivity"`
	RelayConnectivity     bool                                                                                             `json:"relay_connectivity"`
	RTT                   float64                                                                                          `json:"rtt"`
	Throughput            int64                                                                                            `json:"throughput"`
	TURNConnectivity      bool                                                                                             `json:"turn_connectivity"`
	JSON                  sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformationJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation) UnmarshalJSON added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats added in v6.6.0

type SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats struct {
	AudioBandwidth           int64                                                                      `json:"audio_bandwidth"`
	AudioStats               []interface{}                                                              `json:"audio_stats"`
	AverageQuality           int64                                                                      `json:"average_quality"`
	End                      string                                                                     `json:"end,nullable"`
	FirstAudioPacketReceived string                                                                     `json:"first_audio_packet_received"`
	FirstVideoPacketReceived string                                                                     `json:"first_video_packet_received"`
	LastAudioPacketReceived  string                                                                     `json:"last_audio_packet_received"`
	LastVideoPacketReceived  string                                                                     `json:"last_video_packet_received"`
	PeerIDs                  []string                                                                   `json:"peer_ids"`
	Start                    string                                                                     `json:"start,nullable"`
	TotalAudioPackets        int64                                                                      `json:"total_audio_packets"`
	TotalAudioPacketsLost    int64                                                                      `json:"total_audio_packets_lost"`
	TotalVideoPackets        int64                                                                      `json:"total_video_packets"`
	TotalVideoPacketsLost    int64                                                                      `json:"total_video_packets_lost"`
	VideoBandwidth           int64                                                                      `json:"video_bandwidth"`
	VideoStats               []interface{}                                                              `json:"video_stats"`
	JSON                     sessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStatsJSON `json:"-"`
}

func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats) UnmarshalJSON added in v6.6.0

type SessionGetSessionChatParams added in v6.6.0

type SessionGetSessionChatParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SessionGetSessionChatResponse added in v6.6.0

type SessionGetSessionChatResponse struct {
	Data    SessionGetSessionChatResponseData `json:"data"`
	Success bool                              `json:"success"`
	JSON    sessionGetSessionChatResponseJSON `json:"-"`
}

func (*SessionGetSessionChatResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionChatResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionChatResponseData added in v6.6.0

type SessionGetSessionChatResponseData struct {
	// URL where the chat logs can be downloaded
	ChatDownloadURL string `json:"chat_download_url,required"`
	// Time when the download URL will expire
	ChatDownloadURLExpiry string                                `json:"chat_download_url_expiry,required"`
	JSON                  sessionGetSessionChatResponseDataJSON `json:"-"`
}

func (*SessionGetSessionChatResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionChatResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionDetailsParams added in v6.6.0

type SessionGetSessionDetailsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// List all breakout rooms
	IncludeBreakoutRooms param.Field[bool] `query:"include_breakout_rooms"`
}

func (SessionGetSessionDetailsParams) URLQuery added in v6.6.0

func (r SessionGetSessionDetailsParams) URLQuery() (v url.Values)

URLQuery serializes SessionGetSessionDetailsParams's query parameters as `url.Values`.

type SessionGetSessionDetailsResponse added in v6.6.0

type SessionGetSessionDetailsResponse struct {
	Data    SessionGetSessionDetailsResponseData `json:"data"`
	Success bool                                 `json:"success"`
	JSON    sessionGetSessionDetailsResponseJSON `json:"-"`
}

func (*SessionGetSessionDetailsResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionDetailsResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionDetailsResponseData added in v6.6.0

type SessionGetSessionDetailsResponseData struct {
	Session SessionGetSessionDetailsResponseDataSession `json:"session"`
	JSON    sessionGetSessionDetailsResponseDataJSON    `json:"-"`
}

func (*SessionGetSessionDetailsResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionDetailsResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionDetailsResponseDataSession added in v6.6.0

type SessionGetSessionDetailsResponseDataSession struct {
	// ID of the session
	ID string `json:"id,required"`
	// ID of the meeting this session is associated with. In the case of V2 meetings,
	// it is always a UUID. In V1 meetings, it is a room name of the form
	// `abcdef-ghijkl`
	AssociatedID string `json:"associated_id,required"`
	// timestamp when session created
	CreatedAt string `json:"created_at,required"`
	// number of participants currently in the session
	LiveParticipants float64 `json:"live_participants,required"`
	// number of maximum participants that were in the session
	MaxConcurrentParticipants float64 `json:"max_concurrent_participants,required"`
	// Title of the meeting this session belongs to
	MeetingDisplayName string `json:"meeting_display_name,required"`
	// number of minutes consumed since the session started
	MinutesConsumed float64 `json:"minutes_consumed,required"`
	// App id that hosted this session
	OrganizationID string `json:"organization_id,required"`
	// timestamp when session started
	StartedAt string `json:"started_at,required"`
	// current status of session
	Status SessionGetSessionDetailsResponseDataSessionStatus `json:"status,required"`
	// type of session
	Type SessionGetSessionDetailsResponseDataSessionType `json:"type,required"`
	// timestamp when session was last updated
	UpdatedAt     string        `json:"updated_at,required"`
	BreakoutRooms []interface{} `json:"breakout_rooms"`
	// timestamp when session ended
	EndedAt string `json:"ended_at"`
	// Any meta data about session.
	Meta interface{}                                     `json:"meta"`
	JSON sessionGetSessionDetailsResponseDataSessionJSON `json:"-"`
}

func (*SessionGetSessionDetailsResponseDataSession) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionDetailsResponseDataSession) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionDetailsResponseDataSessionStatus added in v6.6.0

type SessionGetSessionDetailsResponseDataSessionStatus string

current status of session

const (
	SessionGetSessionDetailsResponseDataSessionStatusLive  SessionGetSessionDetailsResponseDataSessionStatus = "LIVE"
	SessionGetSessionDetailsResponseDataSessionStatusEnded SessionGetSessionDetailsResponseDataSessionStatus = "ENDED"
)

func (SessionGetSessionDetailsResponseDataSessionStatus) IsKnown added in v6.6.0

type SessionGetSessionDetailsResponseDataSessionType added in v6.6.0

type SessionGetSessionDetailsResponseDataSessionType string

type of session

const (
	SessionGetSessionDetailsResponseDataSessionTypeMeeting     SessionGetSessionDetailsResponseDataSessionType = "meeting"
	SessionGetSessionDetailsResponseDataSessionTypeLivestream  SessionGetSessionDetailsResponseDataSessionType = "livestream"
	SessionGetSessionDetailsResponseDataSessionTypeParticipant SessionGetSessionDetailsResponseDataSessionType = "participant"
)

func (SessionGetSessionDetailsResponseDataSessionType) IsKnown added in v6.6.0

type SessionGetSessionParticipantDetailsParams added in v6.6.0

type SessionGetSessionParticipantDetailsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Comma separated list of filters to apply. Note that there must be no spaces
	// between the filters.
	Filters param.Field[SessionGetSessionParticipantDetailsParamsFilters] `query:"filters"`
	// if true, response includes all the peer events of participant.
	IncludePeerEvents param.Field[bool] `query:"include_peer_events"`
}

func (SessionGetSessionParticipantDetailsParams) URLQuery added in v6.6.0

URLQuery serializes SessionGetSessionParticipantDetailsParams's query parameters as `url.Values`.

type SessionGetSessionParticipantDetailsParamsFilters added in v6.6.0

type SessionGetSessionParticipantDetailsParamsFilters string

Comma separated list of filters to apply. Note that there must be no spaces between the filters.

const (
	SessionGetSessionParticipantDetailsParamsFiltersDeviceInfo                SessionGetSessionParticipantDetailsParamsFilters = "device_info"
	SessionGetSessionParticipantDetailsParamsFiltersIPInformation             SessionGetSessionParticipantDetailsParamsFilters = "ip_information"
	SessionGetSessionParticipantDetailsParamsFiltersPrecallNetworkInformation SessionGetSessionParticipantDetailsParamsFilters = "precall_network_information"
	SessionGetSessionParticipantDetailsParamsFiltersEvents                    SessionGetSessionParticipantDetailsParamsFilters = "events"
	SessionGetSessionParticipantDetailsParamsFiltersQualityStats              SessionGetSessionParticipantDetailsParamsFilters = "quality_stats"
)

func (SessionGetSessionParticipantDetailsParamsFilters) IsKnown added in v6.6.0

type SessionGetSessionParticipantDetailsResponse added in v6.6.0

type SessionGetSessionParticipantDetailsResponse struct {
	Data    SessionGetSessionParticipantDetailsResponseData `json:"data"`
	Success bool                                            `json:"success"`
	JSON    sessionGetSessionParticipantDetailsResponseJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionParticipantDetailsResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionParticipantDetailsResponseData added in v6.6.0

type SessionGetSessionParticipantDetailsResponseData struct {
	Participant SessionGetSessionParticipantDetailsResponseDataParticipant `json:"participant"`
	JSON        sessionGetSessionParticipantDetailsResponseDataJSON        `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionParticipantDetailsResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionParticipantDetailsResponseDataParticipant added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipant struct {
	// Participant ID. This maps to the corresponding peerId.
	ID string `json:"id"`
	// timestamp when this participant was created.
	CreatedAt string `json:"created_at"`
	// ID passed by client to create this participant.
	CustomParticipantID string `json:"custom_participant_id"`
	// Display name of participant when joining the session.
	DisplayName string `json:"display_name"`
	// number of minutes for which the participant was in the session.
	Duration float64 `json:"duration"`
	// timestamp at which participant joined the session.
	JoinedAt string `json:"joined_at"`
	// timestamp at which participant left the session.
	LeftAt    string                                                              `json:"left_at"`
	PeerStats SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats `json:"peer_stats"`
	// Name of the preset associated with the participant.
	PresetName   string                                                                  `json:"preset_name"`
	QualityStats []SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat `json:"quality_stats"`
	// timestamp when this participant's data was last updated.
	UpdatedAt string `json:"updated_at"`
	// User id for this participant.
	UserID string                                                         `json:"user_id"`
	JSON   sessionGetSessionParticipantDetailsResponseDataParticipantJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipant) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats struct {
	Config                    string                                                                                       `json:"config"`
	DeviceInfo                SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo                `json:"device_info"`
	Events                    []SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent                   `json:"events"`
	IPInformation             SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation             `json:"ip_information"`
	PrecallNetworkInformation SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation `json:"precall_network_information"`
	Status                    string                                                                                       `json:"status"`
	JSON                      sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsJSON                      `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo struct {
	Browser        string                                                                            `json:"browser"`
	BrowserVersion string                                                                            `json:"browser_version"`
	CPUs           float64                                                                           `json:"cpus"`
	Engine         string                                                                            `json:"engine"`
	IsMobile       bool                                                                              `json:"is_mobile"`
	Memory         float64                                                                           `json:"memory"`
	OS             string                                                                            `json:"os"`
	OSVersion      string                                                                            `json:"os_version"`
	SDKName        string                                                                            `json:"sdk_name"`
	SDKVersion     string                                                                            `json:"sdk_version"`
	UserAgent      string                                                                            `json:"user_agent"`
	WebglSupport   string                                                                            `json:"webgl_support"`
	JSON           sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfoJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent struct {
	Timestamp string                                                                       `json:"timestamp"`
	Type      string                                                                       `json:"type"`
	JSON      sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEventJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation struct {
	City       string                                                                               `json:"city"`
	Country    string                                                                               `json:"country"`
	IPLocation string                                                                               `json:"ip_location"`
	IPV4       string                                                                               `json:"ipv4"`
	Org        string                                                                               `json:"org"`
	Portal     string                                                                               `json:"portal"`
	Region     string                                                                               `json:"region"`
	Timezone   string                                                                               `json:"timezone"`
	JSON       sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformationJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation struct {
	BackendRTT            float64                                                                                          `json:"backend_rtt"`
	EffectiveNetworktype  string                                                                                           `json:"effective_networktype"`
	FractionalLoss        float64                                                                                          `json:"fractional_loss"`
	Jitter                float64                                                                                          `json:"jitter"`
	ReflexiveConnectivity bool                                                                                             `json:"reflexive_connectivity"`
	RelayConnectivity     bool                                                                                             `json:"relay_connectivity"`
	RTT                   float64                                                                                          `json:"rtt"`
	Throughtput           float64                                                                                          `json:"throughtput"`
	TURNConnectivity      bool                                                                                             `json:"turn_connectivity"`
	JSON                  sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformationJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat struct {
	AudioBandwidth  float64                                                                           `json:"audio_bandwidth"`
	AudioPacketLoss float64                                                                           `json:"audio_packet_loss"`
	AudioStats      []SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat `json:"audio_stats"`
	AverageQuality  float64                                                                           `json:"average_quality"`
	End             string                                                                            `json:"end"`
	PeerID          string                                                                            `json:"peer_id"`
	Start           string                                                                            `json:"start"`
	VideoBandwidth  float64                                                                           `json:"video_bandwidth"`
	VideoPacketLoss float64                                                                           `json:"video_packet_loss"`
	VideoStats      []SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat `json:"video_stats"`
	JSON            sessionGetSessionParticipantDetailsResponseDataParticipantQualityStatJSON         `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat struct {
	ConcealmentEvents float64                                                                             `json:"concealment_events"`
	Jitter            float64                                                                             `json:"jitter"`
	PacketsLost       float64                                                                             `json:"packets_lost"`
	Quality           float64                                                                             `json:"quality"`
	Timestamp         string                                                                              `json:"timestamp"`
	JSON              sessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStatJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat added in v6.6.0

type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat struct {
	FrameHeight     float64                                                                             `json:"frame_height"`
	FrameWidth      float64                                                                             `json:"frame_width"`
	FramesDropped   float64                                                                             `json:"frames_dropped"`
	FramesPerSecond float64                                                                             `json:"frames_per_second"`
	Jitter          float64                                                                             `json:"jitter"`
	PacketsLost     float64                                                                             `json:"packets_lost"`
	Quality         float64                                                                             `json:"quality"`
	Timestamp       string                                                                              `json:"timestamp"`
	JSON            sessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStatJSON `json:"-"`
}

func (*SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat) UnmarshalJSON added in v6.6.0

type SessionGetSessionParticipantsParams added in v6.6.0

type SessionGetSessionParticipantsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// if true, response includes all the peer events of participants.
	IncludePeerEvents param.Field[bool] `query:"include_peer_events"`
	// The page number from which you want your page search results to be displayed.
	PageNo param.Field[float64] `query:"page_no"`
	// Number of results per page
	PerPage param.Field[float64] `query:"per_page"`
	// The search query string. You can search using the meeting ID or title.
	Search    param.Field[string]                                       `query:"search"`
	SortBy    param.Field[SessionGetSessionParticipantsParamsSortBy]    `query:"sort_by"`
	SortOrder param.Field[SessionGetSessionParticipantsParamsSortOrder] `query:"sort_order"`
	// In breakout room sessions, the view parameter can be set to `raw` for session
	// specific duration for participants or `consolidated` to accumulate breakout room
	// durations.
	View param.Field[SessionGetSessionParticipantsParamsView] `query:"view"`
}

func (SessionGetSessionParticipantsParams) URLQuery added in v6.6.0

URLQuery serializes SessionGetSessionParticipantsParams's query parameters as `url.Values`.

type SessionGetSessionParticipantsParamsSortBy added in v6.6.0

type SessionGetSessionParticipantsParamsSortBy string
const (
	SessionGetSessionParticipantsParamsSortByJoinedAt SessionGetSessionParticipantsParamsSortBy = "joinedAt"
	SessionGetSessionParticipantsParamsSortByDuration SessionGetSessionParticipantsParamsSortBy = "duration"
)

func (SessionGetSessionParticipantsParamsSortBy) IsKnown added in v6.6.0

type SessionGetSessionParticipantsParamsSortOrder added in v6.6.0

type SessionGetSessionParticipantsParamsSortOrder string
const (
	SessionGetSessionParticipantsParamsSortOrderAsc  SessionGetSessionParticipantsParamsSortOrder = "ASC"
	SessionGetSessionParticipantsParamsSortOrderDesc SessionGetSessionParticipantsParamsSortOrder = "DESC"
)

func (SessionGetSessionParticipantsParamsSortOrder) IsKnown added in v6.6.0

type SessionGetSessionParticipantsParamsView added in v6.6.0

type SessionGetSessionParticipantsParamsView string

In breakout room sessions, the view parameter can be set to `raw` for session specific duration for participants or `consolidated` to accumulate breakout room durations.

const (
	SessionGetSessionParticipantsParamsViewRaw          SessionGetSessionParticipantsParamsView = "raw"
	SessionGetSessionParticipantsParamsViewConsolidated SessionGetSessionParticipantsParamsView = "consolidated"
)

func (SessionGetSessionParticipantsParamsView) IsKnown added in v6.6.0

type SessionGetSessionParticipantsResponse added in v6.6.0

type SessionGetSessionParticipantsResponse struct {
	Data    SessionGetSessionParticipantsResponseData `json:"data"`
	Success bool                                      `json:"success"`
	JSON    sessionGetSessionParticipantsResponseJSON `json:"-"`
}

func (*SessionGetSessionParticipantsResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionParticipantsResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionParticipantsResponseData added in v6.6.0

type SessionGetSessionParticipantsResponseData struct {
	Participants []SessionGetSessionParticipantsResponseDataParticipant `json:"participants"`
	JSON         sessionGetSessionParticipantsResponseDataJSON          `json:"-"`
}

func (*SessionGetSessionParticipantsResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionParticipantsResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionParticipantsResponseDataParticipant added in v6.6.0

type SessionGetSessionParticipantsResponseDataParticipant struct {
	// Participant ID. This maps to the corresponding peerId.
	ID string `json:"id"`
	// timestamp when this participant was created.
	CreatedAt string `json:"created_at"`
	// ID passed by client to create this participant.
	CustomParticipantID string `json:"custom_participant_id"`
	// Display name of participant when joining the session.
	DisplayName string `json:"display_name"`
	// number of minutes for which the participant was in the session.
	Duration float64 `json:"duration"`
	// timestamp at which participant joined the session.
	JoinedAt string `json:"joined_at"`
	// timestamp at which participant left the session.
	LeftAt string `json:"left_at"`
	// Name of the preset associated with the participant.
	PresetName string `json:"preset_name"`
	// timestamp when this participant's data was last updated.
	UpdatedAt string `json:"updated_at"`
	// User id for this participant.
	UserID string                                                   `json:"user_id"`
	JSON   sessionGetSessionParticipantsResponseDataParticipantJSON `json:"-"`
}

func (*SessionGetSessionParticipantsResponseDataParticipant) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionParticipantsResponseDataParticipant) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionSummaryParams added in v6.6.0

type SessionGetSessionSummaryParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SessionGetSessionSummaryResponse added in v6.6.0

type SessionGetSessionSummaryResponse struct {
	Data    SessionGetSessionSummaryResponseData `json:"data"`
	Success bool                                 `json:"success"`
	JSON    sessionGetSessionSummaryResponseJSON `json:"-"`
}

func (*SessionGetSessionSummaryResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionSummaryResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionSummaryResponseData added in v6.6.0

type SessionGetSessionSummaryResponseData struct {
	SessionID string `json:"sessionId,required"`
	// URL where the summary of transcripts can be downloaded
	SummaryDownloadURL string `json:"summaryDownloadUrl,required"`
	// Time of Expiry before when you need to download the csv file.
	SummaryDownloadURLExpiry string                                   `json:"summaryDownloadUrlExpiry,required"`
	JSON                     sessionGetSessionSummaryResponseDataJSON `json:"-"`
}

func (*SessionGetSessionSummaryResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionSummaryResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionTranscriptsParams added in v6.6.0

type SessionGetSessionTranscriptsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SessionGetSessionTranscriptsResponse added in v6.6.0

type SessionGetSessionTranscriptsResponse struct {
	Data    SessionGetSessionTranscriptsResponseData `json:"data"`
	Success bool                                     `json:"success"`
	JSON    sessionGetSessionTranscriptsResponseJSON `json:"-"`
}

func (*SessionGetSessionTranscriptsResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionTranscriptsResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionTranscriptsResponseData added in v6.6.0

type SessionGetSessionTranscriptsResponseData struct {
	SessionID string `json:"sessionId,required"`
	// URL where the transcript can be downloaded
	TranscriptDownloadURL string `json:"transcript_download_url,required"`
	// Time when the download URL will expire
	TranscriptDownloadURLExpiry string                                       `json:"transcript_download_url_expiry,required"`
	JSON                        sessionGetSessionTranscriptsResponseDataJSON `json:"-"`
}

func (*SessionGetSessionTranscriptsResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionTranscriptsResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionsParams added in v6.6.0

type SessionGetSessionsParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// ID of the meeting that sessions should be associated with
	AssociatedID param.Field[string] `query:"associated_id"`
	// The end time range for which you want to retrieve the meetings. The time must be
	// specified in ISO format.
	EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
	// The page number from which you want your page search results to be displayed.
	PageNo       param.Field[float64] `query:"page_no"`
	Participants param.Field[string]  `query:"participants"`
	// Number of results per page
	PerPage param.Field[float64] `query:"per_page"`
	// Search string that matches sessions based on meeting title, meeting ID, and
	// session ID
	Search    param.Field[string]                            `query:"search"`
	SortBy    param.Field[SessionGetSessionsParamsSortBy]    `query:"sort_by"`
	SortOrder param.Field[SessionGetSessionsParamsSortOrder] `query:"sort_order"`
	// The start time range for which you want to retrieve the meetings. The time must
	// be specified in ISO format.
	StartTime param.Field[time.Time]                      `query:"start_time" format:"date-time"`
	Status    param.Field[SessionGetSessionsParamsStatus] `query:"status"`
}

func (SessionGetSessionsParams) URLQuery added in v6.6.0

func (r SessionGetSessionsParams) URLQuery() (v url.Values)

URLQuery serializes SessionGetSessionsParams's query parameters as `url.Values`.

type SessionGetSessionsParamsSortBy added in v6.6.0

type SessionGetSessionsParamsSortBy string
const (
	SessionGetSessionsParamsSortByMinutesConsumed SessionGetSessionsParamsSortBy = "minutesConsumed"
	SessionGetSessionsParamsSortByCreatedAt       SessionGetSessionsParamsSortBy = "createdAt"
)

func (SessionGetSessionsParamsSortBy) IsKnown added in v6.6.0

type SessionGetSessionsParamsSortOrder added in v6.6.0

type SessionGetSessionsParamsSortOrder string
const (
	SessionGetSessionsParamsSortOrderAsc  SessionGetSessionsParamsSortOrder = "ASC"
	SessionGetSessionsParamsSortOrderDesc SessionGetSessionsParamsSortOrder = "DESC"
)

func (SessionGetSessionsParamsSortOrder) IsKnown added in v6.6.0

type SessionGetSessionsParamsStatus added in v6.6.0

type SessionGetSessionsParamsStatus string
const (
	SessionGetSessionsParamsStatusLive  SessionGetSessionsParamsStatus = "LIVE"
	SessionGetSessionsParamsStatusEnded SessionGetSessionsParamsStatus = "ENDED"
)

func (SessionGetSessionsParamsStatus) IsKnown added in v6.6.0

type SessionGetSessionsResponse added in v6.6.0

type SessionGetSessionsResponse struct {
	Data    SessionGetSessionsResponseData `json:"data"`
	Success bool                           `json:"success"`
	JSON    sessionGetSessionsResponseJSON `json:"-"`
}

func (*SessionGetSessionsResponse) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionsResponse) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionsResponseData added in v6.6.0

type SessionGetSessionsResponseData struct {
	Sessions []SessionGetSessionsResponseDataSession `json:"sessions"`
	JSON     sessionGetSessionsResponseDataJSON      `json:"-"`
}

func (*SessionGetSessionsResponseData) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionsResponseData) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionsResponseDataSession added in v6.6.0

type SessionGetSessionsResponseDataSession struct {
	// ID of the session
	ID string `json:"id,required"`
	// ID of the meeting this session is associated with. In the case of V2 meetings,
	// it is always a UUID. In V1 meetings, it is a room name of the form
	// `abcdef-ghijkl`
	AssociatedID string `json:"associated_id,required"`
	// timestamp when session created
	CreatedAt string `json:"created_at,required"`
	// number of participants currently in the session
	LiveParticipants float64 `json:"live_participants,required"`
	// number of maximum participants that were in the session
	MaxConcurrentParticipants float64 `json:"max_concurrent_participants,required"`
	// Title of the meeting this session belongs to
	MeetingDisplayName string `json:"meeting_display_name,required"`
	// number of minutes consumed since the session started
	MinutesConsumed float64 `json:"minutes_consumed,required"`
	// App id that hosted this session
	OrganizationID string `json:"organization_id,required"`
	// timestamp when session started
	StartedAt string `json:"started_at,required"`
	// current status of session
	Status SessionGetSessionsResponseDataSessionsStatus `json:"status,required"`
	// type of session
	Type SessionGetSessionsResponseDataSessionsType `json:"type,required"`
	// timestamp when session was last updated
	UpdatedAt     string        `json:"updated_at,required"`
	BreakoutRooms []interface{} `json:"breakout_rooms"`
	// timestamp when session ended
	EndedAt string `json:"ended_at"`
	// Any meta data about session.
	Meta interface{}                               `json:"meta"`
	JSON sessionGetSessionsResponseDataSessionJSON `json:"-"`
}

func (*SessionGetSessionsResponseDataSession) UnmarshalJSON added in v6.6.0

func (r *SessionGetSessionsResponseDataSession) UnmarshalJSON(data []byte) (err error)

type SessionGetSessionsResponseDataSessionsStatus added in v6.6.0

type SessionGetSessionsResponseDataSessionsStatus string

current status of session

const (
	SessionGetSessionsResponseDataSessionsStatusLive  SessionGetSessionsResponseDataSessionsStatus = "LIVE"
	SessionGetSessionsResponseDataSessionsStatusEnded SessionGetSessionsResponseDataSessionsStatus = "ENDED"
)

func (SessionGetSessionsResponseDataSessionsStatus) IsKnown added in v6.6.0

type SessionGetSessionsResponseDataSessionsType added in v6.6.0

type SessionGetSessionsResponseDataSessionsType string

type of session

const (
	SessionGetSessionsResponseDataSessionsTypeMeeting     SessionGetSessionsResponseDataSessionsType = "meeting"
	SessionGetSessionsResponseDataSessionsTypeLivestream  SessionGetSessionsResponseDataSessionsType = "livestream"
	SessionGetSessionsResponseDataSessionsTypeParticipant SessionGetSessionsResponseDataSessionsType = "participant"
)

func (SessionGetSessionsResponseDataSessionsType) IsKnown added in v6.6.0

type SessionService added in v6.6.0

type SessionService struct {
	Options []option.RequestOption
}

SessionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSessionService method instead.

func NewSessionService added in v6.6.0

func NewSessionService(opts ...option.RequestOption) (r *SessionService)

NewSessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SessionService) GenerateSummaryOfTranscripts added in v6.6.0

func (r *SessionService) GenerateSummaryOfTranscripts(ctx context.Context, appID string, sessionID string, body SessionGenerateSummaryOfTranscriptsParams, opts ...option.RequestOption) (err error)

Trigger Summary generation of Transcripts for the session ID.

func (*SessionService) GetParticipantDataFromPeerID added in v6.6.0

func (r *SessionService) GetParticipantDataFromPeerID(ctx context.Context, appID string, peerID string, params SessionGetParticipantDataFromPeerIDParams, opts ...option.RequestOption) (res *SessionGetParticipantDataFromPeerIDResponse, err error)

Returns details of the given peer ID along with call statistics for the given session ID.

func (*SessionService) GetSessionChat added in v6.6.0

func (r *SessionService) GetSessionChat(ctx context.Context, appID string, sessionID string, query SessionGetSessionChatParams, opts ...option.RequestOption) (res *SessionGetSessionChatResponse, err error)

Returns a URL to download all chat messages of the session ID in CSV format.

func (*SessionService) GetSessionDetails added in v6.6.0

func (r *SessionService) GetSessionDetails(ctx context.Context, appID string, sessionID string, params SessionGetSessionDetailsParams, opts ...option.RequestOption) (res *SessionGetSessionDetailsResponse, err error)

Returns data of the given session ID including recording details.

func (*SessionService) GetSessionParticipantDetails added in v6.6.0

func (r *SessionService) GetSessionParticipantDetails(ctx context.Context, appID string, sessionID string, participantID string, params SessionGetSessionParticipantDetailsParams, opts ...option.RequestOption) (res *SessionGetSessionParticipantDetailsResponse, err error)

Returns details of the given participant ID along with call statistics for the given session ID.

func (*SessionService) GetSessionParticipants added in v6.6.0

func (r *SessionService) GetSessionParticipants(ctx context.Context, appID string, sessionID string, params SessionGetSessionParticipantsParams, opts ...option.RequestOption) (res *SessionGetSessionParticipantsResponse, err error)

Returns a list of participants for the given session ID.

func (*SessionService) GetSessionSummary added in v6.6.0

func (r *SessionService) GetSessionSummary(ctx context.Context, appID string, sessionID string, query SessionGetSessionSummaryParams, opts ...option.RequestOption) (res *SessionGetSessionSummaryResponse, err error)

Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.

func (*SessionService) GetSessionTranscripts added in v6.6.0

func (r *SessionService) GetSessionTranscripts(ctx context.Context, appID string, sessionID string, query SessionGetSessionTranscriptsParams, opts ...option.RequestOption) (res *SessionGetSessionTranscriptsResponse, err error)

Returns a URL to download the transcript for the session ID in CSV format.

func (*SessionService) GetSessions added in v6.6.0

func (r *SessionService) GetSessions(ctx context.Context, appID string, params SessionGetSessionsParams, opts ...option.RequestOption) (res *SessionGetSessionsResponse, err error)

Returns details of all sessions of an App.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

type WebhookDeleteWebhookParams added in v6.6.0

type WebhookDeleteWebhookParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type WebhookDeleteWebhookResponse added in v6.6.0

type WebhookDeleteWebhookResponse struct {
	Data    WebhookDeleteWebhookResponseData `json:"data,required"`
	Success bool                             `json:"success,required"`
	JSON    webhookDeleteWebhookResponseJSON `json:"-"`
}

func (*WebhookDeleteWebhookResponse) UnmarshalJSON added in v6.6.0

func (r *WebhookDeleteWebhookResponse) UnmarshalJSON(data []byte) (err error)

type WebhookDeleteWebhookResponseData added in v6.6.0

type WebhookDeleteWebhookResponseData struct {
	// ID of the webhook
	ID string `json:"id,required" format:"uuid"`
	// Timestamp when this webhook was created
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Set to true if the webhook is active
	Enabled bool `json:"enabled,required"`
	// Events this webhook will send updates for
	Events []WebhookDeleteWebhookResponseDataEvent `json:"events,required"`
	// Name of the webhook
	Name string `json:"name,required"`
	// Timestamp when this webhook was updated
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// URL the webhook will send events to
	URL  string                               `json:"url,required" format:"uri"`
	JSON webhookDeleteWebhookResponseDataJSON `json:"-"`
}

func (*WebhookDeleteWebhookResponseData) UnmarshalJSON added in v6.6.0

func (r *WebhookDeleteWebhookResponseData) UnmarshalJSON(data []byte) (err error)

type WebhookDeleteWebhookResponseDataEvent added in v6.6.0

type WebhookDeleteWebhookResponseDataEvent string
const (
	WebhookDeleteWebhookResponseDataEventMeetingStarted            WebhookDeleteWebhookResponseDataEvent = "meeting.started"
	WebhookDeleteWebhookResponseDataEventMeetingEnded              WebhookDeleteWebhookResponseDataEvent = "meeting.ended"
	WebhookDeleteWebhookResponseDataEventMeetingParticipantJoined  WebhookDeleteWebhookResponseDataEvent = "meeting.participantJoined"
	WebhookDeleteWebhookResponseDataEventMeetingParticipantLeft    WebhookDeleteWebhookResponseDataEvent = "meeting.participantLeft"
	WebhookDeleteWebhookResponseDataEventMeetingChatSynced         WebhookDeleteWebhookResponseDataEvent = "meeting.chatSynced"
	WebhookDeleteWebhookResponseDataEventRecordingStatusUpdate     WebhookDeleteWebhookResponseDataEvent = "recording.statusUpdate"
	WebhookDeleteWebhookResponseDataEventLivestreamingStatusUpdate WebhookDeleteWebhookResponseDataEvent = "livestreaming.statusUpdate"
	WebhookDeleteWebhookResponseDataEventMeetingTranscript         WebhookDeleteWebhookResponseDataEvent = "meeting.transcript"
	WebhookDeleteWebhookResponseDataEventMeetingSummary            WebhookDeleteWebhookResponseDataEvent = "meeting.summary"
)

func (WebhookDeleteWebhookResponseDataEvent) IsKnown added in v6.6.0

type WebhookEditWebhookParams added in v6.6.0

type WebhookEditWebhookParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	Enabled   param.Field[bool]   `json:"enabled"`
	// Events that the webhook will get triggered by
	Events param.Field[[]WebhookEditWebhookParamsEvent] `json:"events"`
	// Name of the webhook
	Name param.Field[string] `json:"name"`
	// URL the webhook will send events to
	URL param.Field[string] `json:"url" format:"uri"`
}

func (WebhookEditWebhookParams) MarshalJSON added in v6.6.0

func (r WebhookEditWebhookParams) MarshalJSON() (data []byte, err error)

type WebhookEditWebhookParamsEvent added in v6.6.0

type WebhookEditWebhookParamsEvent string
const (
	WebhookEditWebhookParamsEventMeetingStarted            WebhookEditWebhookParamsEvent = "meeting.started"
	WebhookEditWebhookParamsEventMeetingEnded              WebhookEditWebhookParamsEvent = "meeting.ended"
	WebhookEditWebhookParamsEventMeetingParticipantJoined  WebhookEditWebhookParamsEvent = "meeting.participantJoined"
	WebhookEditWebhookParamsEventMeetingParticipantLeft    WebhookEditWebhookParamsEvent = "meeting.participantLeft"
	WebhookEditWebhookParamsEventRecordingStatusUpdate     WebhookEditWebhookParamsEvent = "recording.statusUpdate"
	WebhookEditWebhookParamsEventLivestreamingStatusUpdate WebhookEditWebhookParamsEvent = "livestreaming.statusUpdate"
	WebhookEditWebhookParamsEventMeetingChatSynced         WebhookEditWebhookParamsEvent = "meeting.chatSynced"
	WebhookEditWebhookParamsEventMeetingTranscript         WebhookEditWebhookParamsEvent = "meeting.transcript"
	WebhookEditWebhookParamsEventMeetingSummary            WebhookEditWebhookParamsEvent = "meeting.summary"
)

func (WebhookEditWebhookParamsEvent) IsKnown added in v6.6.0

func (r WebhookEditWebhookParamsEvent) IsKnown() bool

type WebhookEditWebhookResponse added in v6.6.0

type WebhookEditWebhookResponse struct {
	Data    WebhookEditWebhookResponseData `json:"data,required"`
	Success bool                           `json:"success,required"`
	JSON    webhookEditWebhookResponseJSON `json:"-"`
}

func (*WebhookEditWebhookResponse) UnmarshalJSON added in v6.6.0

func (r *WebhookEditWebhookResponse) UnmarshalJSON(data []byte) (err error)

type WebhookEditWebhookResponseData added in v6.6.0

type WebhookEditWebhookResponseData struct {
	// ID of the webhook
	ID string `json:"id,required" format:"uuid"`
	// Timestamp when this webhook was created
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Set to true if the webhook is active
	Enabled bool `json:"enabled,required"`
	// Events this webhook will send updates for
	Events []WebhookEditWebhookResponseDataEvent `json:"events,required"`
	// Name of the webhook
	Name string `json:"name,required"`
	// Timestamp when this webhook was updated
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// URL the webhook will send events to
	URL  string                             `json:"url,required" format:"uri"`
	JSON webhookEditWebhookResponseDataJSON `json:"-"`
}

func (*WebhookEditWebhookResponseData) UnmarshalJSON added in v6.6.0

func (r *WebhookEditWebhookResponseData) UnmarshalJSON(data []byte) (err error)

type WebhookEditWebhookResponseDataEvent added in v6.6.0

type WebhookEditWebhookResponseDataEvent string
const (
	WebhookEditWebhookResponseDataEventMeetingStarted            WebhookEditWebhookResponseDataEvent = "meeting.started"
	WebhookEditWebhookResponseDataEventMeetingEnded              WebhookEditWebhookResponseDataEvent = "meeting.ended"
	WebhookEditWebhookResponseDataEventMeetingParticipantJoined  WebhookEditWebhookResponseDataEvent = "meeting.participantJoined"
	WebhookEditWebhookResponseDataEventMeetingParticipantLeft    WebhookEditWebhookResponseDataEvent = "meeting.participantLeft"
	WebhookEditWebhookResponseDataEventMeetingChatSynced         WebhookEditWebhookResponseDataEvent = "meeting.chatSynced"
	WebhookEditWebhookResponseDataEventRecordingStatusUpdate     WebhookEditWebhookResponseDataEvent = "recording.statusUpdate"
	WebhookEditWebhookResponseDataEventLivestreamingStatusUpdate WebhookEditWebhookResponseDataEvent = "livestreaming.statusUpdate"
	WebhookEditWebhookResponseDataEventMeetingTranscript         WebhookEditWebhookResponseDataEvent = "meeting.transcript"
	WebhookEditWebhookResponseDataEventMeetingSummary            WebhookEditWebhookResponseDataEvent = "meeting.summary"
)

func (WebhookEditWebhookResponseDataEvent) IsKnown added in v6.6.0

type WebhookGetWebhookByIDParams added in v6.6.0

type WebhookGetWebhookByIDParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type WebhookGetWebhookByIDResponse added in v6.6.0

type WebhookGetWebhookByIDResponse struct {
	Data    WebhookGetWebhookByIDResponseData `json:"data,required"`
	Success bool                              `json:"success,required"`
	JSON    webhookGetWebhookByIDResponseJSON `json:"-"`
}

func (*WebhookGetWebhookByIDResponse) UnmarshalJSON added in v6.6.0

func (r *WebhookGetWebhookByIDResponse) UnmarshalJSON(data []byte) (err error)

type WebhookGetWebhookByIDResponseData added in v6.6.0

type WebhookGetWebhookByIDResponseData struct {
	// ID of the webhook
	ID string `json:"id,required" format:"uuid"`
	// Timestamp when this webhook was created
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Set to true if the webhook is active
	Enabled bool `json:"enabled,required"`
	// Events this webhook will send updates for
	Events []WebhookGetWebhookByIDResponseDataEvent `json:"events,required"`
	// Name of the webhook
	Name string `json:"name,required"`
	// Timestamp when this webhook was updated
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// URL the webhook will send events to
	URL  string                                `json:"url,required" format:"uri"`
	JSON webhookGetWebhookByIDResponseDataJSON `json:"-"`
}

func (*WebhookGetWebhookByIDResponseData) UnmarshalJSON added in v6.6.0

func (r *WebhookGetWebhookByIDResponseData) UnmarshalJSON(data []byte) (err error)

type WebhookGetWebhookByIDResponseDataEvent added in v6.6.0

type WebhookGetWebhookByIDResponseDataEvent string
const (
	WebhookGetWebhookByIDResponseDataEventMeetingStarted            WebhookGetWebhookByIDResponseDataEvent = "meeting.started"
	WebhookGetWebhookByIDResponseDataEventMeetingEnded              WebhookGetWebhookByIDResponseDataEvent = "meeting.ended"
	WebhookGetWebhookByIDResponseDataEventMeetingParticipantJoined  WebhookGetWebhookByIDResponseDataEvent = "meeting.participantJoined"
	WebhookGetWebhookByIDResponseDataEventMeetingParticipantLeft    WebhookGetWebhookByIDResponseDataEvent = "meeting.participantLeft"
	WebhookGetWebhookByIDResponseDataEventMeetingChatSynced         WebhookGetWebhookByIDResponseDataEvent = "meeting.chatSynced"
	WebhookGetWebhookByIDResponseDataEventRecordingStatusUpdate     WebhookGetWebhookByIDResponseDataEvent = "recording.statusUpdate"
	WebhookGetWebhookByIDResponseDataEventLivestreamingStatusUpdate WebhookGetWebhookByIDResponseDataEvent = "livestreaming.statusUpdate"
	WebhookGetWebhookByIDResponseDataEventMeetingTranscript         WebhookGetWebhookByIDResponseDataEvent = "meeting.transcript"
	WebhookGetWebhookByIDResponseDataEventMeetingSummary            WebhookGetWebhookByIDResponseDataEvent = "meeting.summary"
)

func (WebhookGetWebhookByIDResponseDataEvent) IsKnown added in v6.6.0

type WebhookGetWebhooksParams added in v6.6.0

type WebhookGetWebhooksParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type WebhookGetWebhooksResponse added in v6.6.0

type WebhookGetWebhooksResponse struct {
	Data    []WebhookGetWebhooksResponseData `json:"data,required"`
	Success bool                             `json:"success,required"`
	JSON    webhookGetWebhooksResponseJSON   `json:"-"`
}

func (*WebhookGetWebhooksResponse) UnmarshalJSON added in v6.6.0

func (r *WebhookGetWebhooksResponse) UnmarshalJSON(data []byte) (err error)

type WebhookGetWebhooksResponseData added in v6.6.0

type WebhookGetWebhooksResponseData struct {
	// ID of the webhook
	ID string `json:"id,required" format:"uuid"`
	// Timestamp when this webhook was created
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Set to true if the webhook is active
	Enabled bool `json:"enabled,required"`
	// Events this webhook will send updates for
	Events []WebhookGetWebhooksResponseDataEvent `json:"events,required"`
	// Name of the webhook
	Name string `json:"name,required"`
	// Timestamp when this webhook was updated
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// URL the webhook will send events to
	URL  string                             `json:"url,required" format:"uri"`
	JSON webhookGetWebhooksResponseDataJSON `json:"-"`
}

func (*WebhookGetWebhooksResponseData) UnmarshalJSON added in v6.6.0

func (r *WebhookGetWebhooksResponseData) UnmarshalJSON(data []byte) (err error)

type WebhookGetWebhooksResponseDataEvent added in v6.6.0

type WebhookGetWebhooksResponseDataEvent string
const (
	WebhookGetWebhooksResponseDataEventMeetingStarted            WebhookGetWebhooksResponseDataEvent = "meeting.started"
	WebhookGetWebhooksResponseDataEventMeetingEnded              WebhookGetWebhooksResponseDataEvent = "meeting.ended"
	WebhookGetWebhooksResponseDataEventMeetingParticipantJoined  WebhookGetWebhooksResponseDataEvent = "meeting.participantJoined"
	WebhookGetWebhooksResponseDataEventMeetingParticipantLeft    WebhookGetWebhooksResponseDataEvent = "meeting.participantLeft"
	WebhookGetWebhooksResponseDataEventMeetingChatSynced         WebhookGetWebhooksResponseDataEvent = "meeting.chatSynced"
	WebhookGetWebhooksResponseDataEventRecordingStatusUpdate     WebhookGetWebhooksResponseDataEvent = "recording.statusUpdate"
	WebhookGetWebhooksResponseDataEventLivestreamingStatusUpdate WebhookGetWebhooksResponseDataEvent = "livestreaming.statusUpdate"
	WebhookGetWebhooksResponseDataEventMeetingTranscript         WebhookGetWebhooksResponseDataEvent = "meeting.transcript"
	WebhookGetWebhooksResponseDataEventMeetingSummary            WebhookGetWebhooksResponseDataEvent = "meeting.summary"
)

func (WebhookGetWebhooksResponseDataEvent) IsKnown added in v6.6.0

type WebhookNewWebhookParams added in v6.6.0

type WebhookNewWebhookParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Events that this webhook will get triggered by
	Events param.Field[[]WebhookNewWebhookParamsEvent] `json:"events,required"`
	// Name of the webhook
	Name param.Field[string] `json:"name,required"`
	// URL this webhook will send events to
	URL param.Field[string] `json:"url,required" format:"uri"`
	// Set whether or not the webhook should be active when created
	Enabled param.Field[bool] `json:"enabled"`
}

func (WebhookNewWebhookParams) MarshalJSON added in v6.6.0

func (r WebhookNewWebhookParams) MarshalJSON() (data []byte, err error)

type WebhookNewWebhookParamsEvent added in v6.6.0

type WebhookNewWebhookParamsEvent string
const (
	WebhookNewWebhookParamsEventMeetingStarted            WebhookNewWebhookParamsEvent = "meeting.started"
	WebhookNewWebhookParamsEventMeetingEnded              WebhookNewWebhookParamsEvent = "meeting.ended"
	WebhookNewWebhookParamsEventMeetingParticipantJoined  WebhookNewWebhookParamsEvent = "meeting.participantJoined"
	WebhookNewWebhookParamsEventMeetingParticipantLeft    WebhookNewWebhookParamsEvent = "meeting.participantLeft"
	WebhookNewWebhookParamsEventMeetingChatSynced         WebhookNewWebhookParamsEvent = "meeting.chatSynced"
	WebhookNewWebhookParamsEventRecordingStatusUpdate     WebhookNewWebhookParamsEvent = "recording.statusUpdate"
	WebhookNewWebhookParamsEventLivestreamingStatusUpdate WebhookNewWebhookParamsEvent = "livestreaming.statusUpdate"
	WebhookNewWebhookParamsEventMeetingTranscript         WebhookNewWebhookParamsEvent = "meeting.transcript"
	WebhookNewWebhookParamsEventMeetingSummary            WebhookNewWebhookParamsEvent = "meeting.summary"
)

func (WebhookNewWebhookParamsEvent) IsKnown added in v6.6.0

func (r WebhookNewWebhookParamsEvent) IsKnown() bool

type WebhookNewWebhookResponse added in v6.6.0

type WebhookNewWebhookResponse struct {
	Data    WebhookNewWebhookResponseData `json:"data,required"`
	Success bool                          `json:"success,required"`
	JSON    webhookNewWebhookResponseJSON `json:"-"`
}

func (*WebhookNewWebhookResponse) UnmarshalJSON added in v6.6.0

func (r *WebhookNewWebhookResponse) UnmarshalJSON(data []byte) (err error)

type WebhookNewWebhookResponseData added in v6.6.0

type WebhookNewWebhookResponseData struct {
	// ID of the webhook
	ID string `json:"id,required" format:"uuid"`
	// Timestamp when this webhook was created
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Set to true if the webhook is active
	Enabled bool `json:"enabled,required"`
	// Events this webhook will send updates for
	Events []WebhookNewWebhookResponseDataEvent `json:"events,required"`
	// Name of the webhook
	Name string `json:"name,required"`
	// Timestamp when this webhook was updated
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// URL the webhook will send events to
	URL  string                            `json:"url,required" format:"uri"`
	JSON webhookNewWebhookResponseDataJSON `json:"-"`
}

func (*WebhookNewWebhookResponseData) UnmarshalJSON added in v6.6.0

func (r *WebhookNewWebhookResponseData) UnmarshalJSON(data []byte) (err error)

type WebhookNewWebhookResponseDataEvent added in v6.6.0

type WebhookNewWebhookResponseDataEvent string
const (
	WebhookNewWebhookResponseDataEventMeetingStarted            WebhookNewWebhookResponseDataEvent = "meeting.started"
	WebhookNewWebhookResponseDataEventMeetingEnded              WebhookNewWebhookResponseDataEvent = "meeting.ended"
	WebhookNewWebhookResponseDataEventMeetingParticipantJoined  WebhookNewWebhookResponseDataEvent = "meeting.participantJoined"
	WebhookNewWebhookResponseDataEventMeetingParticipantLeft    WebhookNewWebhookResponseDataEvent = "meeting.participantLeft"
	WebhookNewWebhookResponseDataEventMeetingChatSynced         WebhookNewWebhookResponseDataEvent = "meeting.chatSynced"
	WebhookNewWebhookResponseDataEventRecordingStatusUpdate     WebhookNewWebhookResponseDataEvent = "recording.statusUpdate"
	WebhookNewWebhookResponseDataEventLivestreamingStatusUpdate WebhookNewWebhookResponseDataEvent = "livestreaming.statusUpdate"
	WebhookNewWebhookResponseDataEventMeetingTranscript         WebhookNewWebhookResponseDataEvent = "meeting.transcript"
	WebhookNewWebhookResponseDataEventMeetingSummary            WebhookNewWebhookResponseDataEvent = "meeting.summary"
)

func (WebhookNewWebhookResponseDataEvent) IsKnown added in v6.6.0

type WebhookReplaceWebhookParams added in v6.6.0

type WebhookReplaceWebhookParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Events that this webhook will get triggered by
	Events param.Field[[]WebhookReplaceWebhookParamsEvent] `json:"events,required"`
	// Name of the webhook
	Name param.Field[string] `json:"name,required"`
	// URL this webhook will send events to
	URL param.Field[string] `json:"url,required" format:"uri"`
	// Set whether or not the webhook should be active when created
	Enabled param.Field[bool] `json:"enabled"`
}

func (WebhookReplaceWebhookParams) MarshalJSON added in v6.6.0

func (r WebhookReplaceWebhookParams) MarshalJSON() (data []byte, err error)

type WebhookReplaceWebhookParamsEvent added in v6.6.0

type WebhookReplaceWebhookParamsEvent string
const (
	WebhookReplaceWebhookParamsEventMeetingStarted            WebhookReplaceWebhookParamsEvent = "meeting.started"
	WebhookReplaceWebhookParamsEventMeetingEnded              WebhookReplaceWebhookParamsEvent = "meeting.ended"
	WebhookReplaceWebhookParamsEventMeetingParticipantJoined  WebhookReplaceWebhookParamsEvent = "meeting.participantJoined"
	WebhookReplaceWebhookParamsEventMeetingParticipantLeft    WebhookReplaceWebhookParamsEvent = "meeting.participantLeft"
	WebhookReplaceWebhookParamsEventMeetingChatSynced         WebhookReplaceWebhookParamsEvent = "meeting.chatSynced"
	WebhookReplaceWebhookParamsEventRecordingStatusUpdate     WebhookReplaceWebhookParamsEvent = "recording.statusUpdate"
	WebhookReplaceWebhookParamsEventLivestreamingStatusUpdate WebhookReplaceWebhookParamsEvent = "livestreaming.statusUpdate"
	WebhookReplaceWebhookParamsEventMeetingTranscript         WebhookReplaceWebhookParamsEvent = "meeting.transcript"
	WebhookReplaceWebhookParamsEventMeetingSummary            WebhookReplaceWebhookParamsEvent = "meeting.summary"
)

func (WebhookReplaceWebhookParamsEvent) IsKnown added in v6.6.0

type WebhookReplaceWebhookResponse added in v6.6.0

type WebhookReplaceWebhookResponse struct {
	Data    WebhookReplaceWebhookResponseData `json:"data,required"`
	Success bool                              `json:"success,required"`
	JSON    webhookReplaceWebhookResponseJSON `json:"-"`
}

func (*WebhookReplaceWebhookResponse) UnmarshalJSON added in v6.6.0

func (r *WebhookReplaceWebhookResponse) UnmarshalJSON(data []byte) (err error)

type WebhookReplaceWebhookResponseData added in v6.6.0

type WebhookReplaceWebhookResponseData struct {
	// ID of the webhook
	ID string `json:"id,required" format:"uuid"`
	// Timestamp when this webhook was created
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Set to true if the webhook is active
	Enabled bool `json:"enabled,required"`
	// Events this webhook will send updates for
	Events []WebhookReplaceWebhookResponseDataEvent `json:"events,required"`
	// Name of the webhook
	Name string `json:"name,required"`
	// Timestamp when this webhook was updated
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// URL the webhook will send events to
	URL  string                                `json:"url,required" format:"uri"`
	JSON webhookReplaceWebhookResponseDataJSON `json:"-"`
}

func (*WebhookReplaceWebhookResponseData) UnmarshalJSON added in v6.6.0

func (r *WebhookReplaceWebhookResponseData) UnmarshalJSON(data []byte) (err error)

type WebhookReplaceWebhookResponseDataEvent added in v6.6.0

type WebhookReplaceWebhookResponseDataEvent string
const (
	WebhookReplaceWebhookResponseDataEventMeetingStarted            WebhookReplaceWebhookResponseDataEvent = "meeting.started"
	WebhookReplaceWebhookResponseDataEventMeetingEnded              WebhookReplaceWebhookResponseDataEvent = "meeting.ended"
	WebhookReplaceWebhookResponseDataEventMeetingParticipantJoined  WebhookReplaceWebhookResponseDataEvent = "meeting.participantJoined"
	WebhookReplaceWebhookResponseDataEventMeetingParticipantLeft    WebhookReplaceWebhookResponseDataEvent = "meeting.participantLeft"
	WebhookReplaceWebhookResponseDataEventMeetingChatSynced         WebhookReplaceWebhookResponseDataEvent = "meeting.chatSynced"
	WebhookReplaceWebhookResponseDataEventRecordingStatusUpdate     WebhookReplaceWebhookResponseDataEvent = "recording.statusUpdate"
	WebhookReplaceWebhookResponseDataEventLivestreamingStatusUpdate WebhookReplaceWebhookResponseDataEvent = "livestreaming.statusUpdate"
	WebhookReplaceWebhookResponseDataEventMeetingTranscript         WebhookReplaceWebhookResponseDataEvent = "meeting.transcript"
	WebhookReplaceWebhookResponseDataEventMeetingSummary            WebhookReplaceWebhookResponseDataEvent = "meeting.summary"
)

func (WebhookReplaceWebhookResponseDataEvent) IsKnown added in v6.6.0

type WebhookService added in v6.6.0

type WebhookService struct {
	Options []option.RequestOption
}

WebhookService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWebhookService method instead.

func NewWebhookService added in v6.6.0

func NewWebhookService(opts ...option.RequestOption) (r *WebhookService)

NewWebhookService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*WebhookService) DeleteWebhook added in v6.6.0

func (r *WebhookService) DeleteWebhook(ctx context.Context, appID string, webhookID string, body WebhookDeleteWebhookParams, opts ...option.RequestOption) (res *WebhookDeleteWebhookResponse, err error)

Removes a webhook for the given webhook ID.

func (*WebhookService) EditWebhook added in v6.6.0

func (r *WebhookService) EditWebhook(ctx context.Context, appID string, webhookID string, params WebhookEditWebhookParams, opts ...option.RequestOption) (res *WebhookEditWebhookResponse, err error)

Edits the webhook details for the given webhook ID.

func (*WebhookService) GetWebhookByID added in v6.6.0

func (r *WebhookService) GetWebhookByID(ctx context.Context, appID string, webhookID string, query WebhookGetWebhookByIDParams, opts ...option.RequestOption) (res *WebhookGetWebhookByIDResponse, err error)

Returns webhook details for the given webhook ID.

func (*WebhookService) GetWebhooks added in v6.6.0

func (r *WebhookService) GetWebhooks(ctx context.Context, appID string, query WebhookGetWebhooksParams, opts ...option.RequestOption) (res *WebhookGetWebhooksResponse, err error)

Returns details of all webhooks for an App.

func (*WebhookService) NewWebhook added in v6.6.0

func (r *WebhookService) NewWebhook(ctx context.Context, appID string, params WebhookNewWebhookParams, opts ...option.RequestOption) (res *WebhookNewWebhookResponse, err error)

Adds a new webhook to an App.

func (*WebhookService) ReplaceWebhook added in v6.6.0

func (r *WebhookService) ReplaceWebhook(ctx context.Context, appID string, webhookID string, params WebhookReplaceWebhookParams, opts ...option.RequestOption) (res *WebhookReplaceWebhookResponse, err error)

Replace all details for the given webhook ID.

Jump to

Keyboard shortcuts

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