Class: Reach::REST::Api::Messaging::MessagingItemContext

Inherits:
InstanceContext show all
Defined in:
lib/reach-ruby/rest/api/messaging/messaging_item.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, message_id) ⇒ MessagingItemContext

Initialize the MessagingItemContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • message_id (String) —

    The identifier of the message to be updated.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 223

def initialize(version, message_id)
    super(version)

    # Path Solution
    @solution = { message_id: message_id,  }
    @uri = { 
          "fetch" => "/messaging/v1/fetch",   
          "update" => "/messaging/v1/update",   
          "delete" => "/messaging/v1/delete",   
          "unschedule" => "/messaging/v1/unschedule"  
    }

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the MessagingItemInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 240

def delete(
)

    baseParams = {
       'messageId' => @solution[:message_id],
    }
    
    params = Reach::Values.of(baseParams)
    
    @version.delete('DELETE', @uri["delete"], data: params)
end

#fetch ⇒ MessagingItemInstance

Fetch the MessagingItemInstance

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 255

def fetch(
)

    baseParams = {
       'messageId' => @solution[:message_id],
    }
    
    params = Reach::Values.of(baseParams)
    
    payload = @version.fetch('GET', @uri["fetch"], params: params)
    MessagingItemInstance.new(
        @version,
        payload,
        message_id: @solution[:message_id],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



327
328
329
330
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 327

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Reach.Api.Messaging.MessagingItemContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



320
321
322
323
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 320

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Reach.Api.Messaging.MessagingItemContext #{context}>"
end

#unschedule ⇒ MessagingItemInstance

Unschedule the MessagingItemInstance

Returns:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 275

def unschedule(
)

    baseParams = {
       'messageId' => @solution[:message_id],
    }
    
    params = Reach::Values.of(baseParams)
    
    payload = @version.unschedule('POST', @uri["unschedule"], data: params)
    MessagingItemInstance.new(
        @version,
        payload,
        message_id: @solution[:message_id],
    )
end

#update(body: nil) ⇒ MessagingItemInstance

Update the MessagingItemInstance

Parameters:

  • body (String) (defaults to: nil) —

    The text to be newly associated with the message.

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/reach-ruby/rest/api/messaging/messaging_item.rb', line 296

def update(
    body: nil
)

    baseParams = {
       'messageId' => @solution[:message_id],
    }
    data = Reach::Values.of(baseParams.merge({                        
        'body' => body,
    }))

    
    
    payload = @version.update('POST', @uri["update"], data: data)
    MessagingItemInstance.new(
        @version,
        payload,
        message_id: @solution[:message_id],
    )
end