voice

type Call struct {
	ID          string
	Status      CallStatus
	Source      string
	Destination string
	NumberID    string
	CreatedAt   time.Time
	UpdatedAt   time.Time
	EndedAt     *time.Time
}

type CallFlow struct {
	ID    string
	Title string

	// Each object in the steps array in a call flow describes an operation
	// that executes during a call, e.g. transferring a call or playing back an
	// audio file.
	Steps []CallFlowStep

	// Record instructs the Voice system to record the entire call.
	//
	// Note that this is distinct from the Record CallFlow step which records
	// only a single message from the callee.
	Record bool

	CreatedAt time.Time
	UpdatedAt time.Time
}

type CallFlowFetchStep struct {
	CallFlowStepBase

	// The URL to fetch the call flow from.
	URL string
}

type CallFlowHangupStep struct {
	CallFlowStepBase
}

type CallFlowPauseStep struct {
	CallFlowStepBase

	// The length of the pause.
	//
	// Truncated to seconds.
	Length time.Duration
}

type CallFlowPlayStep struct {
	CallFlowStepBase

	// The URL of the media file to play. The media file should be a WAV file
	// (8 kHz, 16 bit).
	Media string
}

type CallFlowRecordStep struct {
	CallFlowStepBase

	// Setting the MaxLength limits the duration of the recording.
	//
	// Optional with the default value being 0 which imposes no limit.
	//
	// Truncated to seconds.
	MaxLength time.Duration

	// The duration of a moment of silence allowed before a recording is
	// stopped.
	//
	// If you omit this parameter, silence detection is disabled.
	//
	// Truncated to seconds.
	Timeout time.Duration

	// Key DTMF input to terminate recording.
	//
	// Values allowed are: "any", "#", "*", "none" (default).
	FinishOnKey string

	//If you want to have a transcription of a recording, after the recording has finished.
	// It is used when steps[].action is record and it is optional with the default value being false.
	Transcribe bool

	// Set this to get a transcription of a recording in the specified language
	// after the recording has finished.
	//
	// Allowed values: de-DE, en-AU, en-UK, en-US, es-ES, es-LA, fr-FR, it-IT, nl-NL, pt-BR.
	TranscribeLanguage string

	// (Optional) OnFinish contains the URL to get a new CallFlow from when the recording terminates and this CallFlowRecordStep ends.
	//
	// The URL must contain a schema e.g. http://... or https://...
	// This attribute is used for chaining call flows. When the current step ends,
	// a POST request containing information about the recording is sent to the URL specified.
	// This gets a new callflow from the URL specified, but re-uses the original Call ID and Leg ID i.e. it's the same Call.
	//
	// To get at the recording information from the POST request body, you must call (instead of relying on req.Form):
	// “`go
	// body,_ := ioutil.ReadAll(req.Body)
	// recordingInfo := string(body[:])
	// “`
	OnFinish string
}

type CallFlowSayStep struct {
	CallFlowStepBase

	// The text to pronounce.
	Payload string

	// The voice to use for pronouncing text.
	//
	// Allowed values: male, female.
	Voice string

	// The language of the text that is to be pronounced in <2 letter lang>-<2
	// letter country> format.
	//
	// Allowed values: cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN,
	// en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, nb-NO, nl-NL,
	// pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR.
	//
	// Please refer to the online documentation for an up to date list.
	Language string

	// The amount of times to repeat the payload.
	//
	// Allowed values: Between 1 and 10.
	Repeat int

	// Determines what happens if a machine picks up the phone.
	//
	// Possible values are: "continue": do not check, just play the message.
	// "delay": (default) if a machine answers, wait until the machine stops
	// talking. "hangup": Hangup when a machine answers.
	IfMachine string

	// The time to analyze if a machine has picked up the phone.
	//
	// Used in combination with the delay and hangup values of the ifMachine
	// attribute. Minimum: 400ms, maximum: 10s.
	//
	// Optional. The default is 7 seconds.
	//
	// Truncated to milliseconds
	MachineTimeout time.Duration
}

type CallFlowStep interface {
	json.Marshaler
	json.Unmarshaler
}

type CallFlowStepBase struct {
	ID string `json:"id,omitempty"`

	OnKeypressGoto string `json:"onKeypressGoto,omitempty"`
	OnKeypressVar  string `json:"onKeypressVar,omitempty"`

	Conditions []struct {
		Variable string `json:"variable"`
		Operator string `json:"operator"`
		Value    string `json:"value"`
	} `json:"conditions,omitempty"`
}

type CallFlowTransferStep struct {
	CallFlowStepBase

	// The destination (E.164 formatted number or SIP URI) to transfer a call
	// to. E.g. 31612345678 or sip:foobar@example.com.
	Destination string

	// Record sets the the side of the call that should be recorded.
	//
	// Optional. Available options are "in", "out" and "both". "in" can be used
	// to record the voice of the destination, "out" records the source. "both"
	// records both source and destination individually.
	Record string
}

type CallStatus string

type Error struct {
	Code    int
	Message string
}

type ErrorResponse struct {
	Errors []Error
}

type Leg struct {
	// The unique ID of the leg.
	ID string
	// The unique ID of the call that this leg belongs to.
	CallID string
	// The number/SIP URL that is making the connection.
	Source string
	// The number/SIP URL that a connection is made to.
	Destination string
	// The status of the leg. Possible values: starting, ringing, ongoing,
	// busy, no_answer, failed and hangup.
	Status LegStatus
	// The direction of the leg, indicating if it's an incoming connection or
	// outgoing (e.g. for transferring a call). Possible values: incoming,
	// outgoing.
	Direction LegDirection
	// The cost of the leg. The amount relates to the currency parameter.
	Cost float64
	// The three-letter currency code (ISO 4217) related to the cost of the
	// leg.
	Currency string
	// The duration of the leg.
	//
	// Truncated to seconds.
	Duration time.Duration
	// The date-time the leg was created.
	CreatedAt time.Time
	// The date-time the leg was last updated.
	UpdatedAt time.Time
	// The date-time the leg was answered.
	AnsweredAt *time.Time
	// The date-time the leg ended.
	EndedAt *time.Time
}

type LegDirection string

type LegStatus string

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

type Recording struct {
	// The unique ID of the recording.
	ID string
	// The format of the recording. Supported formats are: wav.
	Format string
	// The ID of the leg that the recording belongs to.
	LegID string
	// The status of the recording. Available statuses are: initialised, recording, done and failed
	Status RecordingStatus
	// The duration of the recording.
	//
	// Truncated to seconds.
	Duration time.Duration
	// The date-time the call was created.
	CreatedAt time.Time
	// The date-time the call was last updated.
	UpdatedAt time.Time

	// A hash with HATEOAS links related to the object. This includes the file
	// link that has the URI for downloading the wave file of the recording.
	Links map[string]string
}

type RecordingStatus string

type Transcription struct {
	// The unique ID of the transcription.
	ID string
	// The ID of the recording that the transcription belongs to.
	RecordingID string
	// The status of the transcription. Possible values: created, transcribing, done, failed.
	Status string
	// The date-time the transcription was created/requested.
	CreatedAt time.Time
	// The date-time the transcription was last updated.
	UpdatedAt time.Time
	// contains filtered or unexported fields
}

type Webhook struct {
	ID        string
	URL       string
	Token     string
	CreatedAt time.Time
	UpdatedAt time.Time
}