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 subscribed to the User Defined Messages.

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

    The SID of the Call the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages.

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

    The SID that uniquely identifies this User Defined Message Subscription.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 162

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns Account SID.

Returns:

  • (String) —

    Account SID.



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

def 
  @properties['account_sid']
end

#call_sid ⇒ String

Returns Call SID.

Returns:

  • (String) —

    Call SID.



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

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:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 183

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 this User Defined Message Subscription was created.

Returns:

  • (Time) —

    The date this User Defined Message Subscription was created.



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

def date_created
  @properties['date_created']
end

#delete ⇒ Boolean

Delete the UserDefinedMessageSubscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



241
242
243
244
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 241

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

#sid ⇒ String

Returns User Defined Message Subscription SID.

Returns:

  • (String) —

    User Defined Message Subscription SID.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



234
235
236
237
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 234

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`.



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

def uri
  @properties['uri']
end