Class: Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ OutgoingCallerIdContext

Initialize the OutgoingCallerIdContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to update.

  • sid (String) —

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



151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 151

def initialize(version, , sid)
    super(version)

    # Path Solution
    @solution = { account_sid: , sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/OutgoingCallerIds/#{@solution[:sid]}.json"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the OutgoingCallerIdInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



163
164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 163

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ OutgoingCallerIdInstance

Fetch the OutgoingCallerIdInstance

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 175

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    OutgoingCallerIdInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(friendly_name: :unset) ⇒ OutgoingCallerIdInstance

Update the OutgoingCallerIdInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 196

def update(
    friendly_name: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    OutgoingCallerIdInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end