Class: Twilio::REST::Messaging::V2::ChannelsSenderInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ChannelsSenderInstance

Initialize the ChannelsSenderInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ChannelsSender resource.

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

    The SID of the Call resource to fetch.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 863

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'status' => payload['status'],
        'sender_id' => payload['sender_id'],
        'configuration' => payload['configuration'],
        'webhook' => payload['webhook'],
        'profile' => payload['profile'],
        'properties' => payload['properties'],
        'offline_reasons' => payload['offline_reasons'],
        'compliance' => payload['compliance'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#compliance ⇒ MessagingV2RcsComplianceResponse

Returns:

  • (MessagingV2RcsComplianceResponse) 


947
948
949
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 947

def compliance
    @properties['compliance']
end

#configuration ⇒ MessagingV2ChannelsSenderConfiguration

Returns:

  • (MessagingV2ChannelsSenderConfiguration) 


917
918
919
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 917

def configuration
    @properties['configuration']
end

#context ⇒ ChannelsSenderContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



890
891
892
893
894
895
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 890

def context
    unless @instance_context
        @instance_context = ChannelsSenderContext.new(@version , @params['sid'])
    end
    @instance_context
end

#delete ⇒ Boolean

Delete the ChannelsSenderInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



960
961
962
963
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 960

def delete

    context.delete
end

#fetch ⇒ ChannelsSenderInstance

Fetch the ChannelsSenderInstance

Returns:



968
969
970
971
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 968

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



993
994
995
996
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 993

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V2.ChannelsSenderInstance #{values}>"
end

#offline_reasons ⇒ Array<MessagingV2ChannelsSenderOfflineReasonsItems>

Returns The reasons why the sender is offline.

Returns:

  • (Array<MessagingV2ChannelsSenderOfflineReasonsItems>) —

    The reasons why the sender is offline.



941
942
943
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 941

def offline_reasons
    @properties['offline_reasons']
end

#profile ⇒ MessagingV2ChannelsSenderProfileGenericResponse

Returns:

  • (MessagingV2ChannelsSenderProfileGenericResponse) 


929
930
931
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 929

def profile
    @properties['profile']
end

#properties ⇒ MessagingV2ChannelsSenderProperties

Returns:

  • (MessagingV2ChannelsSenderProperties) 


935
936
937
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 935

def properties
    @properties['properties']
end

#sender_id ⇒ String

Returns The ID of the sender in ‘whatsapp:<E.164_PHONE_NUMBER>` format.

Returns:

  • (String) —

    The ID of the sender in ‘whatsapp:<E.164_PHONE_NUMBER>` format.



911
912
913
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 911

def sender_id
    @properties['sender_id']
end

#sid ⇒ String

Returns The SID of the sender.

Returns:

  • (String) —

    The SID of the sender.



899
900
901
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 899

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


905
906
907
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 905

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



986
987
988
989
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 986

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V2.ChannelsSenderInstance #{values}>"
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:



977
978
979
980
981
982
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 977

def update(messaging_v2_channels_sender_requests_update: :unset
)

    context.update(
    )
end

#url ⇒ String

Returns The URL of the resource.

Returns:

  • (String) —

    The URL of the resource.



953
954
955
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 953

def url
    @properties['url']
end

#webhook ⇒ MessagingV2ChannelsSenderWebhook

Returns:

  • (MessagingV2ChannelsSenderWebhook) 


923
924
925
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 923

def webhook
    @properties['webhook']
end