Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::MemberContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, channel_sid, sid) ⇒ MemberContext

Initialize the MemberContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String)
  • channel_sid (String)
  • sid (String) 


188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 188

def initialize(version, service_sid, channel_sid, sid)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}"

    
end

Instance Method Details

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MemberInstance

Parameters:

  • x_twilio_webhook_enabled (MemberEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.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 ⇒ MemberInstance

Fetch the MemberInstance

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 213

def fetch

    
    payload = @version.fetch('GET', @uri)
    MemberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



277
278
279
280
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 277

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V2.MemberContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



270
271
272
273
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 270

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V2.MemberContext #{context}>"
end

#update(role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) ⇒ MemberInstance

Update the MemberInstance

Parameters:

  • role_sid (String) (defaults to: :unset)
  • last_consumed_message_index (String) (defaults to: :unset)
  • last_consumption_timestamp (Time) (defaults to: :unset)
  • date_created (Time) (defaults to: :unset)
  • date_updated (Time) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (MemberEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



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
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb', line 236

def update(
    role_sid: :unset, 
    last_consumed_message_index: :unset, 
    last_consumption_timestamp: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'RoleSid' => role_sid,
        'LastConsumedMessageIndex' => last_consumed_message_index,
        'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
    })

    
    headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    payload = @version.update('POST', @uri, data: data, headers: headers)
    MemberInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
        sid: @solution[:sid],
    )
end