Class: Twilio::REST::Conversations::V2

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v2.rb,
lib/twilio-ruby/rest/conversations/v2/action.rb,
lib/twilio-ruby/rest/conversations/v2/operation.rb,
lib/twilio-ruby/rest/conversations/v2/participant.rb,
lib/twilio-ruby/rest/conversations/v2/conversation.rb,
lib/twilio-ruby/rest/conversations/v2/communication.rb,
lib/twilio-ruby/rest/conversations/v2/configuration.rb

Defined Under Namespace

Classes: ActionContext, ActionInstance, ActionInstanceMetadata, ActionList, ActionListResponse, ActionPage, ActionPageMetadata, CommunicationContext, CommunicationInstance, CommunicationInstanceMetadata, CommunicationList, CommunicationListResponse, CommunicationPage, CommunicationPageMetadata, ConfigurationContext, ConfigurationInstance, ConfigurationInstanceMetadata, ConfigurationList, ConfigurationListResponse, ConfigurationPage, ConfigurationPageMetadata, ConversationContext, ConversationInstance, ConversationInstanceMetadata, ConversationList, ConversationListResponse, ConversationPage, ConversationPageMetadata, OperationContext, OperationInstance, OperationInstanceMetadata, OperationList, OperationListResponse, OperationPage, OperationPageMetadata, ParticipantContext, ParticipantInstance, ParticipantInstanceMetadata, ParticipantList, ParticipantListResponse, ParticipantPage, ParticipantPageMetadata

Instance Attribute Summary

Attributes inherited from Version

#domain, #version

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #create_with_metadata, #delete, #delete_with_metadata, #exception, #fetch, #fetch_with_metadata, #page, #patch, #read_limits, #relative_uri, #request, #stream, #stream_with_metadata, #update, #update_with_metadata

Constructor Details

#initialize(domain) ⇒ V2

Initialize the V2 version of Conversations



21
22
23
24
25
26
27
28
29
30
# File 'lib/twilio-ruby/rest/conversations/v2.rb', line 21

def initialize(domain)
    super
    @version = 'v2'
    @actions = nil
    @communications = nil
    @configurations = nil
    @conversations = nil
    @operations = nil
    @participants = nil
end

Instance Method Details

#actions(conversation_id = :unset) ⇒ Twilio::REST::Conversations::V2::ActionContext, Twilio::REST::Conversations::V2::ActionList

Parameters:

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

Returns:



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

def actions(conversation_id=:unset)
    if conversation_id.nil?
        raise ArgumentError, 'conversation_id cannot be nil'
    end

    if conversation_id == :unset
        @actions ||= ActionList.new self
    else
        ActionContext.new(self, conversation_id)
    end
end

#communications(conversation_sid = :unset, sid = :unset) ⇒ Twilio::REST::Conversations::V2::CommunicationContext, Twilio::REST::Conversations::V2::CommunicationList

Parameters:

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

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/twilio-ruby/rest/conversations/v2.rb', line 52

def communications(conversation_sid=:unset, sid=:unset)
    if conversation_sid.nil?
        raise ArgumentError, 'conversation_sid cannot be nil'
    end
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if conversation_sid == :unset && sid == :unset
        @communications ||= CommunicationList.new self
    elsif conversation_sid != :unset && sid == :unset
        CommunicationList.new(self, conversation_sid: conversation_sid)
    else
        CommunicationContext.new(self, conversation_sid, sid)
    end
end

#configurations(sid = :unset) ⇒ Twilio::REST::Conversations::V2::ConfigurationContext, Twilio::REST::Conversations::V2::ConfigurationList

Parameters:

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

Returns:



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

def configurations(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @configurations ||= ConfigurationList.new self
    else
        ConfigurationContext.new(self, sid)
    end
end

#conversations(sid = :unset) ⇒ Twilio::REST::Conversations::V2::ConversationContext, Twilio::REST::Conversations::V2::ConversationList

Parameters:

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

Returns:



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

def conversations(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @conversations ||= ConversationList.new self
    else
        ConversationContext.new(self, sid)
    end
end

#operations(sid = :unset) ⇒ Twilio::REST::Conversations::V2::OperationContext, Twilio::REST::Conversations::V2::OperationList

Parameters:

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

Returns:



102
103
104
105
106
107
108
109
110
111
112
# File 'lib/twilio-ruby/rest/conversations/v2.rb', line 102

def operations(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @operations ||= OperationList.new self
    else
        OperationContext.new(self, sid)
    end
end

#participants(conversation_sid = :unset, sid = :unset) ⇒ Twilio::REST::Conversations::V2::ParticipantContext, Twilio::REST::Conversations::V2::ParticipantList

Parameters:

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

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/twilio-ruby/rest/conversations/v2.rb', line 118

def participants(conversation_sid=:unset, sid=:unset)
    if conversation_sid.nil?
        raise ArgumentError, 'conversation_sid cannot be nil'
    end
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if conversation_sid == :unset && sid == :unset
        @participants ||= ParticipantList.new self
    elsif conversation_sid != :unset && sid == :unset
        ParticipantList.new(self, conversation_sid: conversation_sid)
    else
        ParticipantContext.new(self, conversation_sid, sid)
    end
end

#to_sObject

Provide a user friendly representation



136
137
138
# File 'lib/twilio-ruby/rest/conversations/v2.rb', line 136

def to_s
    '<Twilio::REST::Conversations::V2>';
end