Class: Twilio::REST::Verify::V2::SafelistInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, phone_number: nil) ⇒ SafelistInstance

Initialize the SafelistInstance

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

  • sid (String)

    The SID of the Call resource to fetch.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 168

def initialize(version, payload , phone_number: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'phone_number' => payload['phone_number'],
        'url' => payload['url'],
    }

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

Instance Method Details

#contextSafelistContext

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

Returns:



187
188
189
190
191
192
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 187

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

#deleteBoolean

Delete the SafelistInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



215
216
217
218
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 215

def delete

    context.delete
end

#fetchSafelistInstance

Fetch the SafelistInstance

Returns:



223
224
225
226
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 223

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



237
238
239
240
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 237

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

#phone_numberString

Returns The phone number in SafeList.

Returns:

  • (String)

    The phone number in SafeList.



202
203
204
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 202

def phone_number
    @properties['phone_number']
end

#sidString

Returns The unique string that we created to identify the SafeList resource.

Returns:

  • (String)

    The unique string that we created to identify the SafeList resource.



196
197
198
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 196

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



230
231
232
233
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 230

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

#urlString

Returns The absolute URL of the SafeList resource.

Returns:

  • (String)

    The absolute URL of the SafeList resource.



208
209
210
# File 'lib/twilio-ruby/rest/verify/v2/safelist.rb', line 208

def url
    @properties['url']
end