Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext
- Inherits:
-
Twilio::REST::InstanceContext
- Object
- Twilio::REST::InstanceContext
- Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb,
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb
Defined Under Namespace
Classes: InviteContext, InviteInstance, InviteList, InvitePage, MemberContext, MemberInstance, MemberList, MemberPage, MessageContext, MessageInstance, MessageList, MessagePage, WebhookContext, WebhookInstance, WebhookList, WebhookPage
Instance Method Summary collapse
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ChannelInstance.
-
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance.
-
#initialize(version, service_sid, sid) ⇒ ChannelContext
constructor
Initialize the ChannelContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#invites(sid = :unset) ⇒ InviteList, InviteContext
Access the invites.
-
#members(sid = :unset) ⇒ MemberList, MemberContext
Access the members.
-
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance
Update the ChannelInstance.
-
#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext
Access the webhooks.
Constructor Details
#initialize(version, service_sid, sid) ⇒ ChannelContext
Initialize the ChannelContext
184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 184 def initialize(version, service_sid, sid) super(version) # Path Solution @solution = { service_sid: service_sid, sid: sid, } @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}" # Dependents @webhooks = nil @members = nil @messages = nil @invites = nil end |
Instance Method Details
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ChannelInstance
201 202 203 204 205 206 207 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 201 def delete( x_twilio_webhook_enabled: :unset ) headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) @version.delete('DELETE', @uri, headers: headers) end |
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance
212 213 214 215 216 217 218 219 220 221 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 212 def fetch payload = @version.fetch('GET', @uri) ChannelInstance.new( @version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
348 349 350 351 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 348 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.IpMessaging.V2.ChannelContext #{context}>" end |
#invites(sid = :unset) ⇒ InviteList, InviteContext
Access the invites
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 323 def invites(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return InviteContext.new(@version, @solution[:service_sid], @solution[:sid],sid ) end unless @invites @invites = InviteList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @invites end |
#members(sid = :unset) ⇒ MemberList, MemberContext
Access the members
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 285 def members(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return MemberContext.new(@version, @solution[:service_sid], @solution[:sid],sid ) end unless @members @members = MemberList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @members end |
#messages(sid = :unset) ⇒ MessageList, MessageContext
Access the messages
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 304 def (sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return MessageContext.new(@version, @solution[:service_sid], @solution[:sid],sid ) end unless @messages @messages = MessageList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @messages end |
#to_s ⇒ Object
Provide a user friendly representation
341 342 343 344 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 341 def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.IpMessaging.V2.ChannelContext #{context}>" end |
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance
Update the ChannelInstance
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 233 def update( friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset, x_twilio_webhook_enabled: :unset ) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'UniqueName' => unique_name, 'Attributes' => attributes, 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 'CreatedBy' => created_by, }) headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.update('POST', @uri, data: data, headers: headers) ChannelInstance.new( @version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], ) end |
#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext
Access the webhooks
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 266 def webhooks(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return WebhookContext.new(@version, @solution[:service_sid], @solution[:sid],sid ) end unless @webhooks @webhooks = WebhookList.new( @version, service_sid: @solution[:service_sid], channel_sid: @solution[:sid], ) end @webhooks end |