Class: Twilio::REST::Voice::V1::IpRecordContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/voice/v1/ip_record.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ IpRecordContext

Initialize the IpRecordContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The Twilio-provided string that uniquely identifies the IP Record resource to update.



158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 158

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/IpRecords/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the IpRecordInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



170
171
172
173
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 170

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ IpRecordInstance

Fetch the IpRecordInstance

Returns:



178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 178

def fetch

    payload = @version.fetch('GET', @uri)
    IpRecordInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



218
219
220
221
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 218

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Voice.V1.IpRecordContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



211
212
213
214
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 211

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Voice.V1.IpRecordContext #{context}>"
end

#update(friendly_name: :unset) ⇒ IpRecordInstance

Update the IpRecordInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 192

def update(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    payload = @version.update('POST', @uri, data: data)
    IpRecordInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end