Class: Twilio::REST::Trunking::V1::TrunkContext::OriginationUrlContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, trunk_sid, sid) ⇒ OriginationUrlContext

Initialize the OriginationUrlContext

Parameters:

  • Version that contains the resource

  • The SID of the Trunk from which to update the OriginationUrl.

  • The unique string that we created to identify the OriginationUrl resource to update.



177
178
179
180
181
182
183
184
185
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 177

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the OriginationUrlInstance

Returns:

  • True if delete succeeds, false otherwise



189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 189

def delete

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

#fetch ⇒ OriginationUrlInstance

Fetch the OriginationUrlInstance

Returns:

  • Fetched OriginationUrlInstance



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 201

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



267
268
269
270
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 267

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

#to_s ⇒ Object

Provide a user friendly representation



260
261
262
263
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 260

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

#update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset) ⇒ OriginationUrlInstance

Update the OriginationUrlInstance

Parameters:

  • (defaults to: :unset)

    The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.

  • (defaults to: :unset)

    The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.

  • (defaults to: :unset)

    Whether the URL is enabled. The default is ‘true`.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    The SIP address you want Twilio to route your Origination calls to. This must be a ‘sip:` schema. `sips` is NOT supported.

Returns:

  • Updated OriginationUrlInstance



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 226

def update(
    weight: :unset, 
    priority: :unset, 
    enabled: :unset, 
    friendly_name: :unset, 
    sip_url: :unset
)

    data = Twilio::Values.of({
        'Weight' => weight,
        'Priority' => priority,
        'Enabled' => enabled,
        'FriendlyName' => friendly_name,
        'SipUrl' => sip_url,
    })

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