Class: Twilio::REST::Messaging::V2::ChannelsSenderContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v2/channels_sender.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ChannelsSenderContext

Initialize the ChannelsSenderContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the sender.



581
582
583
584
585
586
587
588
589
590
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 581

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Channels/Senders/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ChannelsSenderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



594
595
596
597
598
599
600
601
602
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 594

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the ChannelsSenderInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 607

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      channelsSender_instance = ChannelsSenderInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      ChannelsSenderInstanceMetadata.new(@version, channelsSender_instance, response.headers, response.status_code)
end

#fetch ⇒ ChannelsSenderInstance

Fetch the ChannelsSenderInstance

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 626

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ChannelsSenderInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ ChannelsSenderInstance

Fetch the ChannelsSenderInstanceMetadata

Returns:



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 645

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    channels_sender_instance = ChannelsSenderInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    ChannelsSenderInstanceMetadata.new(
        @version,
        channels_sender_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



725
726
727
728
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 725

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

#to_s ⇒ Object

Provide a user friendly representation



718
719
720
721
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 718

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

#update(messaging_v2_channels_sender_requests_update: :unset) ⇒ ChannelsSenderInstance

Update the ChannelsSenderInstance

Parameters:

  • messaging_v2_channels_sender_requests_update (MessagingV2ChannelsSenderRequestsUpdate) (defaults to: :unset)

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 671

def update(messaging_v2_channels_sender_requests_update: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.update('POST', @uri, headers: headers, data: messaging_v2_channels_sender_requests_update.to_json)
    ChannelsSenderInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata(messaging_v2_channels_sender_requests_update: :unset) ⇒ ChannelsSenderInstance

Update the ChannelsSenderInstanceMetadata

Parameters:

  • messaging_v2_channels_sender_requests_update (MessagingV2ChannelsSenderRequestsUpdate) (defaults to: :unset)

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 692

def update_with_metadata(messaging_v2_channels_sender_requests_update: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, headers: headers, data: messaging_v2_channels_sender_requests_update.to_json)
    channels_sender_instance = ChannelsSenderInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    ChannelsSenderInstanceMetadata.new(
        @version,
        channels_sender_instance,
        response.headers,
        response.status_code
    )
end