Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance

Initialize the ChannelInstance

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 Channel resource.

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

    The SID of the Call resource to fetch.



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 700

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'attributes' => payload['attributes'],
        'type' => payload['type'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
        'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i,
        'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i,
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


746
747
748
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 746

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


770
771
772
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 770

def attributes
    @properties['attributes']
end

#context ⇒ ChannelContext

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

Returns:



731
732
733
734
735
736
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 731

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

#created_by ⇒ String

Returns:

  • (String) 


794
795
796
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 794

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns:

  • (Time) 


782
783
784
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 782

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


788
789
790
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 788

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ChannelInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



826
827
828
829
830
831
832
833
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 826

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance

Returns:



838
839
840
841
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 838

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


758
759
760
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 758

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



911
912
913
914
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 911

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

#invites ⇒ invites

Access the invites

Returns:



898
899
900
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 898

def invites
    context.invites
end

#links ⇒ Hash

Returns:

  • (Hash) 


818
819
820
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 818

def links
    @properties['links']
end

#members ⇒ members

Access the members

Returns:



884
885
886
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 884

def members
    context.members
end

#members_count ⇒ String

Returns:

  • (String) 


800
801
802
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 800

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



891
892
893
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 891

def messages
    context.messages
end

#messages_count ⇒ String

Returns:

  • (String) 


806
807
808
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 806

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String

Returns:

  • (String) 


752
753
754
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 752

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


740
741
742
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 740

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



904
905
906
907
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 904

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V2.ChannelInstance #{values}>"
end

#type ⇒ ChannelType

Returns:

  • (ChannelType) 


776
777
778
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 776

def type
    @properties['type']
end

#unique_name ⇒ String

Returns:

  • (String) 


764
765
766
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 764

def unique_name
    @properties['unique_name']
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

Parameters:

  • friendly_name (String) (defaults to: :unset)
  • unique_name (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • date_created (Time) (defaults to: :unset)
  • date_updated (Time) (defaults to: :unset)
  • created_by (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (ChannelEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 853

def update(
    friendly_name: :unset, 
    unique_name: :unset, 
    attributes: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    created_by: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        friendly_name: friendly_name, 
        unique_name: unique_name, 
        attributes: attributes, 
        date_created: date_created, 
        date_updated: date_updated, 
        created_by: created_by, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns:

  • (String) 


812
813
814
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 812

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



877
878
879
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb', line 877

def webhooks
    context.webhooks
end