Class: Twilio::REST::Api::V2010::AccountContext::CallContext::UserDefinedMessageSubscriptionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil) ⇒ UserDefinedMessageSubscriptionInstance

Initialize the UserDefinedMessageSubscriptionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this UserDefinedMessageSubscription resource.

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

    The SID of the Call resource to fetch.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 154

def initialize(version, payload , account_sid: nil, call_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'call_sid' => payload['call_sid'],
        'sid' => payload['sid'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'uri' => payload['uri'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that subscribed to the User Defined Messages.

Returns:



184
185
186
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 184

def 
    @properties['account_sid']
end

#call_sid ⇒ String

Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages.

Returns:



190
191
192
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 190

def call_sid
    @properties['call_sid']
end

#context ⇒ UserDefinedMessageSubscriptionContext

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

Returns:



175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 175

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

#date_created ⇒ Time

Returns The date that this User Defined Message Subscription was created, given in RFC 2822 format.

Returns:

  • (Time) —

    The date that this User Defined Message Subscription was created, given in RFC 2822 format.



202
203
204
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 202

def date_created
    @properties['date_created']
end

#delete ⇒ Boolean

Delete the UserDefinedMessageSubscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



215
216
217
218
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 215

def delete

    context.delete
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



229
230
231
232
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 229

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

#sid ⇒ String

Returns The SID that uniquely identifies this User Defined Message Subscription.

Returns:

  • (String) —

    The SID that uniquely identifies this User Defined Message Subscription.



196
197
198
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 196

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



222
223
224
225
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 222

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

#uri ⇒ String

Returns The URI of the User Defined Message Subscription Resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the User Defined Message Subscription Resource, relative to ‘api.twilio.com`.



208
209
210
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 208

def uri
    @properties['uri']
end