Class: Twilio::REST::Insights::V1

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/insights/v1.rb,
lib/twilio-ruby/rest/insights/v1/call.rb,
lib/twilio-ruby/rest/insights/v1/room.rb,
lib/twilio-ruby/rest/insights/v1/setting.rb,
lib/twilio-ruby/rest/insights/v1/annotation.rb,
lib/twilio-ruby/rest/insights/v1/call/event.rb,
lib/twilio-ruby/rest/insights/v1/conference.rb,
lib/twilio-ruby/rest/insights/v1/call/metric.rb,
lib/twilio-ruby/rest/insights/v1/call/summary.rb,
lib/twilio-ruby/rest/insights/v1/call_summaries.rb,
lib/twilio-ruby/rest/insights/v1/room/participant.rb,
lib/twilio-ruby/rest/insights/v1/conference/conference_participant.rb

Defined Under Namespace

Classes: AnnotationContext, AnnotationInstance, AnnotationList, AnnotationPage, CallContext, CallInstance, CallList, CallPage, CallSummariesInstance, CallSummariesList, CallSummariesPage, ConferenceContext, ConferenceInstance, ConferenceList, ConferencePage, RoomContext, RoomInstance, RoomList, RoomPage, SettingContext, SettingInstance, SettingList, SettingPage

Instance Attribute Summary

Attributes inherited from Version

#domain

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #delete, #exception, #fetch, #page, #read_limits, #relative_uri, #request, #stream, #update

Constructor Details

#initialize(domain) ⇒ V1

Initialize the V1 version of Insights


15
16
17
18
19
20
21
22
23
24
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 15

def initialize(domain)
  super
  @version = 'v1'
  @settings = nil
  @annotation = nil
  @calls = nil
  @call_summaries = nil
  @conferences = nil
  @rooms = nil
end

Instance Method Details

#annotation(call_sid = :unset) ⇒ Twilio::REST::Insights::V1::AnnotationContext, Twilio::REST::Insights::V1::AnnotationList

Parameters:

  • call_sid (String) (defaults to: :unset)

    The call_sid

Returns:


36
37
38
39
40
41
42
43
44
45
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 36

def annotation(call_sid=:unset)
  if call_sid.nil?
      raise ArgumentError, 'call_sid cannot be nil'
  end
  if call_sid == :unset
      @annotation ||= AnnotationList.new self
  else
      AnnotationContext.new(self, call_sid)
  end
end

#call_summariesTwilio::REST::Insights::V1::CallSummariesContext

Returns:

  • (Twilio::REST::Insights::V1::CallSummariesContext)

64
65
66
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 64

def call_summaries
  @call_summaries ||= CallSummariesList.new self
end

#calls(sid = :unset) ⇒ Twilio::REST::Insights::V1::CallContext, Twilio::REST::Insights::V1::CallList

Parameters:

  • sid (String) (defaults to: :unset)

    The sid

Returns:


51
52
53
54
55
56
57
58
59
60
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 51

def calls(sid=:unset)
  if sid.nil?
      raise ArgumentError, 'sid cannot be nil'
  end
  if sid == :unset
      @calls ||= CallList.new self
  else
      CallContext.new(self, sid)
  end
end

#conferences(conference_sid = :unset) ⇒ Twilio::REST::Insights::V1::ConferenceContext, Twilio::REST::Insights::V1::ConferenceList

Parameters:

  • conference_sid (String) (defaults to: :unset)

    The unique SID identifier of the Conference.

Returns:


72
73
74
75
76
77
78
79
80
81
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 72

def conferences(conference_sid=:unset)
  if conference_sid.nil?
      raise ArgumentError, 'conference_sid cannot be nil'
  end
  if conference_sid == :unset
      @conferences ||= ConferenceList.new self
  else
      ConferenceContext.new(self, conference_sid)
  end
end

#rooms(room_sid = :unset) ⇒ Twilio::REST::Insights::V1::RoomContext, Twilio::REST::Insights::V1::RoomList

Parameters:

  • room_sid (String) (defaults to: :unset)

    The SID of the Room resource.

Returns:


87
88
89
90
91
92
93
94
95
96
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 87

def rooms(room_sid=:unset)
  if room_sid.nil?
      raise ArgumentError, 'room_sid cannot be nil'
  end
  if room_sid == :unset
      @rooms ||= RoomList.new self
  else
      RoomContext.new(self, room_sid)
  end
end

#settingsTwilio::REST::Insights::V1::SettingContext


28
29
30
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 28

def settings
  @settings ||= SettingContext.new self
end

#to_sObject

Provide a user friendly representation


100
101
102
# File 'lib/twilio-ruby/rest/insights/v1.rb', line 100

def to_s
  '<Twilio::REST::Insights::V1>'
end