ari

type AddChannelRequest struct {
	ChannelID string `json:"channel"`
	Role      string `json:"role,omitempty"`
}

type Application struct {
	BridgeIDs   []string `json:"bridge_ids"`   // Subscribed BridgeIds
	ChannelIDs  []string `json:"channel_ids"`  // Subscribed ChannelIds
	DeviceNames []string `json:"device_names"` // Subscribed Device names
	EndpointIDs []string `json:"endpoint_ids"` // Subscribed Endpoints (tech/resource format)
	Name        string   `json:"name"`         // Name of the application
}

type ApplicationReplaced Event

type AsteriskDate time.Time

type AsteriskInfo struct {
	BuildInfo  BuildInfo  `json:"build"`
	ConfigInfo ConfigInfo `json:"config"`
	StatusInfo StatusInfo `json:"status"`
	SystemInfo SystemInfo `json:"system"`
}

type Bridge struct {
	ID         string   `json:"id"`          // Unique Id for this bridge
	Class      string   `json:"bridge"`      // Class of the bridge (TODO: huh?)
	Type       string   `json:"bridge_type"` // Type of bridge (mixing, holding, dtmf_events, proxy_media)
	ChannelIDs []string `json:"channels"`    // List of pariticipating channel ids
	Creator    string   `json:"creator"`     // Creating entity of the bridge
	Name       string   `json:"name"`        // The name of the bridge
	Technology string   `json:"technology"`  // Name of the bridging technology
	// contains filtered or unexported fields
}

type BridgeAttendedTransfer struct {
	Event
	DestinationApplication     string  `json:"destination_application,omitempty"`
	DestinationBridge          string  `json:"desination_bridge,omitempty"`
	DestinationLinkFirstLeg    Channel `json:"destination_link_first_leg,omitempty"`
	DestinationLinkSecondLeg   Channel `json:"destination_link_second_leg,omitempty"`
	DestinationThreewayBridge  Bridge  `json:"destination_threeway_bridge,omitempty"`
	DestinationThreewayChannel Channel `json:"destination_threeway_channel,omitempty"`
	DestinationType            string  `json:"destination_type"`
	External                   bool    `json:"is_external"`
	Result                     string  `json:"result"`
	Transferee                 Channel `json:"transferee,omitempty"`
	TransferTarget             Channel `json:"transfer_target,omitempty"`
	TransfererFirstLeg         Channel `json:"transferer_first_leg"`
	TransfererFirstLegBridge   Bridge  `json:"transferer_first_leg_bridge,omitempty"`
	TransfererSecondLeg        Channel `json:"transferer_second_leg"`
	TransfererSecondLegBridge  Bridge  `json:"transferer_second_leg_bridge,omitempty"`
}

type BridgeBlindTransfer struct {
	Event
	Bridge         Bridge  `json:"bridge,omitempty"`
	Channel        Channel `json:"channel"`
	Context        string  `json:"context"`
	Extension      string  `json:"exten"`
	External       bool    `json:"external"`
	ReplaceChannel Channel `json:"external,omitempty"`
	Result         string  `json:"result"`
	Transferee     Channel `json:"transferee,omitempty"`
}

type BridgeCreated struct {
	Event
	Bridge Bridge `json:"bridge"`
}

type BridgeDestroyed struct {
	Event
	Bridge Bridge `json:"bridge"`
}

type BridgeEvent struct {
	Event
	Bridge Bridge `json:"bridge,omitempty"` // Affected bridge
}

type BridgeMerged struct {
	Event
	Bridge      Bridge `json:"bridge"`      // New bridge
	Bridge_from Bridge `json:"bridge_from"` // Old (independant) bridge -- TODO: verify this assumption
}

type BuildInfo struct {
	Date    string `json:"date"`
	Kernel  string `json:"kernel"`
	Machine string `json:"machine"`
	Options string `json:"options"`
	Os      string `json:"os"`
	User    string `json:"user"`
}

type Bus struct {
	// contains filtered or unexported fields
}

type CallerId struct {
	Name   string `json:"name"`
	Number string `json:"number"`
}

type Channel struct {
	Accountcode  string       `json:"accountcode"`
	Caller       CallerId     `json:"caller"`    // CallerId of the calling endpoint
	Connected    CallerId     `json:"connected"` // CallerId of the connected line
	Creationtime AsteriskDate `json:"creationtime"`
	Dialplan     DialplanCEP  `json:"dialplan"` // Current location in the dialplan
	Id           string       `json:"id"`       // Unique id for this channel (same as for AMI)
	Name         string       `json:"name"`     // Name of this channel (tech/name-id format)
	State        string       `json:"state"`    // State of the channel
	// contains filtered or unexported fields
}

type ChannelCallerId struct {
	Event
	Caller_presentation     int     `json:"caller_presentation"`     // The numeric portion
	Caller_presentation_txt string  `json:"caller_presentation_txt"` // The textual portion
	Channel                 Channel `json:"channel"`
}

type ChannelConnectedLine struct {
	Event
	Channel Channel `json:"channel"`
}

type ChannelCreated struct {
	Event
	Channel Channel `json:"channel"`
}

type ChannelDestroyed struct {
	Event
	Cause     int     `json:"cause"`
	Cause_txt string  `json:"cause_txt"`
	Channel   Channel `json:"channel"`
}

type ChannelDialplan struct {
	Event
	Channel           Channel `json:"channel"`
	Dialplan_app      string  `json:"dialplan_app"`      // The application which is to be executed
	Dialplan_app_data string  `json:"dialplan_app_data"` // The data to be passed to the application
}

type ChannelDtmfReceived struct {
	Event
	Channel     Channel `json:"channel"`
	Digit       string  `json:"digit"`       // The DTMF digit which was received (0-9A-E*#)
	Duration_ms int     `json:"duration_ms"` // The duration of the DTMF tone, in milliseconds
}

type ChannelEnteredBridge struct {
	Event
	Bridge  Bridge  `json:"bridge"`
	Channel Channel `json:"channel"`
}

type ChannelEvent struct {
	Event
	Channel Channel `json:"channel,omitempty"` // Affected channel
}

type ChannelHangupRequest struct {
	Event
	Cause   int     `json:"cause,omitempty"` // Integer cause code
	Channel Channel `json:"channel"`
	Soft    bool    `json:"soft,omitempty"` // Whether the request was "soft"
}

type ChannelHold struct {
	Event
	Channel    Channel `json:"channel"`
	MusicClass string  `json:"musicclass"` // The music class being played to the held channel
}

type ChannelLeftBridge struct {
	Event
	Bridge  Bridge  `json:"bridge"`
	Channel Channel `json:"channel"`
}

type ChannelStateChange struct {
	Event
	Channel Channel `json:"channel"`
}

type ChannelTalkingFinished struct {
	Event
	Channel  Channel `json:"channel"`
	Duration int     `json:"duration"` // Duration (in milliseconds) of the talking
}

type ChannelTalkingStarted struct {
	Event
	Channel Channel `json:"channel"`
}

type ChannelUnhold struct {
	Event
	Channel Channel `json:"channel"`
}

type ChannelUserevent struct {
	Event
	Bridge    Bridge      `json:"bridge,omitempty"`
	Channel   Channel     `json:"channel,omitempty"`
	Endpoint  Endpoint    `json:"endpoint,omitempty"`
	Eventname string      `json:"eventname"` // Name of the user event
	Userevent interface{} `json:"userevent"` // Custome data sent with the user event
}

type ChannelVarset struct {
	Event
	Channel  Channel `json:"channel,omitempty"` // If not present, variable is global
	Value    string  `json:"value"`             // New value
	Variable string  `json:"variable"`          // Variable name
}

type Client struct {
	Options *Options // client options

	WSConfig *websocket.Config // websocket connection configuration

	ReadyChan chan struct{}

	Bus *Bus // event bus

	TestMode bool // Client is in test mode: no actual HTTP requests will be made
	// contains filtered or unexported fields
}

type ConfigInfo struct {
	DefaultLanguage string  `json:"default_language"`
	MaxChannels     int     `json:"max_channels,omitempty"` //omitempty denotes an optional field, meaning the field may not be present if no value is assigned.
	MaxLoad         float64 `json:"max_load,omitempty"`
	MaxOpenFiles    int     `json:"max_open_files,omitempty"`
	Name            string  `json:"name"`  // Asterisk system name
	SetID           SetID   `json:"setid"` // Effective user/group id under which Asterisk is running
}

type ContactInfo struct {
	AOR       string `json:"aor"`                      // Address of Record for this contact
	Status    string `json:"contact_status"`           // Current status of the contact
	Roundtrip string `json:"roundtrip_usec,omitempty"` // Current round trip time, in microseconds
	URI       string `json:"uri"`                      // The location URI of the contact
}

type ContactStatusChanged struct {
	Event
	Endpoint    Endpoint    `json:"endpoint"`
	ContactInfo ContactInfo `json:"contact_info"`
}

type ContinueChannelRequest struct {
	Context   string `json:"context,omitempty"`
	Extension string `json:"extension,omitempty"`
	Priority  int64  `json:"priority,omitempty"`
}

type CreateBridgeRequest struct {
	ID   string `json:"bridgeId,omitempty"`
	Type string `json:"type,omitempty"`
	Name string `json:"name,omitempty"`
}

type CreateUserEventRequest struct {
	Application string `json:"application"`
	Source      string `json:"source,omitempty"`
	Variables   string `json:"variables,omitempty"`
}

type DeviceState struct {
	Name  string `json:"name"`
	State string `json:"state"`
}

type DeviceStateChanged struct {
	Event
	Device_state DeviceState `json:"device_state"`
}

type Dial struct {
	Event
	Caller     Channel `json:"caller,omitempty"`     // Dialing channel (if not system-originated)
	Dialstatus string  `json:"dialstatus"`           // Present status of the dial attempt
	Dialstring string  `json:"dialstring,omitempty"` // The string describing the dial
	Forward    string  `json:"forward,omitempty"`    // If present, indicates the forwarding target TODO: what is the format of this?
	Forwarded  Channel `json:"forwarded,omitempty"`  // If present, channel of forwarding target
	Peer       Channel `json:"peer"`                 // Dialed channel
}

type DialplanCEP struct {
	Context  string `json:"context"`
	Exten    string `json:"exten"`
	Priority int64  `json:"priority"` //int64 derived from Java's 'long'
}

type Endpoint struct {
	ChannelIds []string `json:"channel_ids"`     // List of channel Ids which are associated with this endpoint
	Resource   string   `json:"resource"`        // The endpoint's resource name
	State      string   `json:"state,omitempty"` // The state of the endpoint
	Technology string   `json:"technology"`      // The technology of the endpoint (e.g. SIP, PJSIP, DAHDI, etc)
}

type EndpointStateChange struct {
	Event
	Endpoint Endpoint `json:"endpoint"`
}

type Event struct {
	Message
	Application string       `json:"application"`
	Timestamp   AsteriskDate `json:"timestamp,omitempty"`
}

type Eventer interface {
	MessageRawer
	GetApplication() string
	GetType() string
}

type FormatLangPair struct {
	Format   string `json:"format"`
	Language string `json:"language"`
}

type LiveRecording struct {
	Cause       string `json:"cause,omitempty"`            // If failed, the cause of the failure
	DurationSec int    `json:"duration,omitempty"`         // Length of recording in seconds
	Format      string `json:"format"`                     // Format of recording (wav, gsm, etc)
	Name        string `json:"name"`                       // (base) name for the recording
	SilenceSec  int    `json:"silence_duration,omitempty"` // If silence was detected in the recording, the duration in seconds of that silence (requires that maxSilenceSeconds be non-zero)
	State       string `json:"state"`                      // Current state of the recording
	TalkingSec  int    `json:"talking_duration,omitempty"` // Duration of talking, in seconds, that has been detected in the recording (requires that maxSilenceSeconds be non-zero)
	TargetURI   string `json:"target_uri"`                 // URI for the channel or bridge which is being recorded (TODO: figure out format for this)
	// contains filtered or unexported fields
}

type Mailbox struct {
	Name         string `json:"name"`
	New_messages int    `json:"new_messages"` // Number of new (unread) messages
	Old_messages int    `json:"old_messages"` // Number of old (read) messages
}

type Message struct {
	RawMessage
	Type string `json:"type"`
}

type MessageRawer interface {
	SetRaw(*[]byte)
	GetRaw() *[]byte
}

type MissingParams struct {
	Message
	Params []string `json:"params"` // List of missing parameters which are required
}

type Options struct {
	// Application is the the name of this ARI application
	Application string

	// URL is the root URL of the ARI server (asterisk box).
	// Default to http://localhost:8088/ari
	URL string

	// WebsocketURL is the URL for ARI Websocket events.
	// Defaults to the events directory of URL, with a protocol of ws.
	// Usually ws://localhost:8088/ari/events.
	WebsocketURL string

	// Username for ARI authentication
	Username string

	// Password for ARI authentication
	Password string
}

type OriginateRequest struct {
	Endpoint string `json:"endpoint"`           // Endpoint to use (tech/resource notation)
	Timeout  int    `json:"timeout,omitempty"`  // Dial Timeout in seconds (-1 = no limit)
	CallerId string `json:"callerId,omitempty"` // CallerId to set for outgoing call

	// One set of:
	Context   string `json:"context,omitempty"` // Drop the channel into the dialplan
	Extension string `json:"extension,omitempty"`
	Priority  int64  `json:"priority,omitempty"`
	// OR
	App     string `json:"app,omitempty"`     // Associate channel to Stasis (Ari) application
	AppArgs string `json:"appArgs,omitempty"` // Arguments to the application

	// Channel Id declarations
	ChannelId      string `json:"channelId,omitempty"`      // Optionally assign channel id
	OtherChannelId string `json:"otherChannelId,omitempty"` // Optionally assign second channel's id (only for local channels)

	Variables map[string]string `json:"variables,omitempty"` // Channel variables to set
}

type Peer struct {
	Address string       `json:"address,omitempty"` // IP Address of the peer
	Cause   string       `json:"cause,omitempty"`   // Reason associated with change in peer_status
	Status  string       `json:"peer_status"`       // The current state of the peer
	Port    string       `json:"port,omitempty"`    // The port of the peer
	Time    AsteriskDate `json:"time,omitempty"`    // The last known time the peer was contacted
}

type PeerStatusChange struct {
	Event
	Endpoint Endpoint `json:"endpoint"`
	Peer     Peer     `json:"peer"`
}

type PlayMediaRequest struct {
	Media    string `json:"media"`
	Lang     string `json:"lang,omitempty"`
	Offsetms int    `json:"offsetms,omitempty"`
	Skipms   int    `json:"skipms,omitempty"`

	//PlaybackId unnecessary if specifically naming it in query path
	PlaybackId string `json:"playbackId,omitempty"`
}

type Playback struct {
	ID        string `json:"id"` // Unique ID for this playback session
	Language  string `json:"language,omitempty"`
	MediaURI  string `json:"media_uri"`  // URI for the media which is to be played
	State     string `json:"state"`      // State of the playback operation
	TargetURI string `json:"target_uri"` // URI of the channel or bridge on which the media should be played (follows format of 'type':'name')
	// contains filtered or unexported fields
}

type PlaybackFinished struct {
	Event
	Playback Playback `json:"playback"`
}

type PlaybackOptions struct {
	// ID is an optional ID to use for the playback's ID. If one
	// is not supplied, an ID will be randomly generated internally.
	// NOTE that this ID will only be used for the FIRST playback
	// in a queue.  All subsequent playback IDs will be randomly generated.
	ID string

	// DTMF is an optional channel for received DTMF tones received during the playback.
	// This channel will NOT be closed by the playback.
	DTMF chan<- *ChannelDtmfReceived

	// ExitOnDTMF defines a list of DTMF digits on receipt of which will
	// terminate the playback of the queue.  You may set this to AllDTMF
	// in order to match any DTMF digit.
	ExitOnDTMF string

	// Done is an optional channel for receiving notification when the playback
	// is complete.  This is useful if the playback is to be executed asynchronously.
	// This channel will be closed by the playback when playback the is complete.
	Done chan<- struct{}
}

type PlaybackQueue struct {
	// contains filtered or unexported fields
}

type PlaybackStarted struct {
	Event
	Playback Playback `json:"playback"`
}

type Player interface {
	Play(string) (string, error)
	GetClient() *Client
}

type PlayerRecorder interface {
	Record(string, *RecordingOptions) (*LiveRecording, error)
	Play(string) (string, error)
	GetClient() *Client
}

type RawMessage struct {
	// contains filtered or unexported fields
}

type RecordRequest struct {
	Name               string `json:"name"`
	Format             string `json:"format"`
	MaxDurationSeconds int    `json:"maxDurationSeconds,omitempty"`
	MaxSilenceSeconds  int    `json:"maxSilenceSeconds,omitempty"`
	IfExists           string `json:"ifExists,omitempty"`
	Beep               bool   `json:"beep,omitempty"`
	TerminateOn        string `json:"terminateOn,omitempty"`
}

type Recorder interface {
	Record(string, *RecordingOptions) (*LiveRecording, error)
	GetClient() *Client
}

type RecordingFailed struct {
	Event
	Recording LiveRecording `json:"recording"`
}

type RecordingFinished struct {
	Event
	Recording LiveRecording `json:"recording"`
}

type RecordingOptions struct {
	// Format is the file format/encoding to which the recording should be stored.
	// This will usually be one of: slin, ulaw, alaw, wav, gsm.
	// If not specified, this will default to slin.
	Format string

	// MaxDuration is the maximum duration of the recording, after which the recording will
	// automatically stop.  If not set, there is no maximum.
	MaxDuration time.Duration

	// MaxSilence is the maximum duration of detected to be found before terminating the recording.
	MaxSilence time.Duration

	// Exists determines what should happen if the given recording already exists.
	// Valid values are: "fail", "overwrite", or "append".
	// If not specified, it will default to "fail"
	Exists string

	// Beep indicates whether a beep should be played to the recorded
	// party at the beginning of the recording.
	Beep bool

	// Terminate indicates whether the recording should be terminated on
	// receipt of a DTMF digit.
	// valid options are: "none", "any", "*", and "#"
	// If not specified, it will default to "none" (never terminate on DTMF).
	Terminate string
}

type RecordingStarted struct {
	Event
	Recording LiveRecording `json:"recording"`
}

type RequestError interface {
	error
	Code() int
}

type SendDTMFToChannelRequest struct {
	Dtmf     string `json:"dtmf,omitempty"`
	Before   int    `json:"before,omitempty"`
	Between  int    `json:"between,omitempty"`
	Duration int    `json:"duration,omitempty"`
	After    int    `json:"after,omitempty"`
}

type SetID struct {
	Group string `json:"group"` // group id (not name? why string?)
	User  string `json:"user"`  // user id (not name? why string?)
}

type SnoopRequest struct {
	Spy     string `json:"spy,omitempty"`     //Direction of audio to spy on, default is 'none'
	Whisper string `json:"whisper,omitempty"` //Direction of audio to whisper into, default is 'none'
	App     string `json:"app"`               //Application that the snooping channel is placed into
	AppArgs string `json:"appArgs,omitempty"` //The application arguments to pass to the Stasis application

	//Only necessary for 'StartSnoopChannel'
	SnoopId string `json:"snoopId,omitempty"` //Unique ID to assign to snooping channel
}

type Sound struct {
	Formats []FormatLangPair `json:"formats"`
	Id      string           `json:"id"`
	Text    string           `json:"text,omitempty"`
}

type StasisEnd struct {
	Event
	Args    []string `json:"args"`
	Channel Channel  `json:"channel"`
}

type StasisStart struct {
	Event
	Args           []string `json:"args"`
	Channel        Channel  `json:"channel"`
	ReplaceChannel Channel  `json:"replacechannel,omitempty"` // TODO: find out what this is
}

type StatusInfo struct {
	LastReloadTime AsteriskDate `json:"last_reload_time"`
	StartupTime    AsteriskDate `json:"startup_time"`
}

type StoredRecording struct {
	Format string `json:"format"`
	Name   string `json:"name"`
	// contains filtered or unexported fields
}

type Subscription struct {
	C chan Eventer // channel for sending events to the subscriber
	// contains filtered or unexported fields
}

type SystemInfo struct {
	EntityID string `json:"entity_id"`
	Version  string `json:"version"`
}

type TextMessage struct {
	Body      string                `json:"body"` // The body (text) of the message
	From      string                `json:"from"` // Technology-specific source URI
	To        string                `json:"to"`   // Technology-specific destination URI
	Variables []TextMessageVariable `json:"variables,omitempty"`
}

type TextMessageReceived struct {
	Event
	Endpoint Endpoint    `json:"endpoint,omitempty"`
	Message  TextMessage `json:"message"`
}

type TextMessageVariable struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Variable struct {
	Value string `json:"value"`
}