Class: Twilio::REST::Voice::V1::ConnectionPolicyContext

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

Defined Under Namespace

Classes: ConnectionPolicyTargetContext, ConnectionPolicyTargetInstance, ConnectionPolicyTargetList, ConnectionPolicyTargetPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ConnectionPolicyContext

Initialize the ConnectionPolicyContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique string that we created to identify the Connection Policy resource to update.



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 154

def initialize(version, sid)
    super(version)

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

    # Dependents
    @targets = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the ConnectionPolicyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 167

def delete

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

#fetch ⇒ ConnectionPolicyInstance

Fetch the ConnectionPolicyInstance

Returns:



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

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



240
241
242
243
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 240

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

#targets(sid = :unset) ⇒ ConnectionPolicyTargetList, ConnectionPolicyTargetContext

Access the targets

Returns:

Raises:

  • (ArgumentError) 


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 215

def targets(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return ConnectionPolicyTargetContext.new(@version, @solution[:sid],sid )
    end

    unless @targets
        @targets = ConnectionPolicyTargetList.new(
            @version, connection_policy_sid: @solution[:sid], )
    end

 @targets
end

#to_s ⇒ Object

Provide a user friendly representation



233
234
235
236
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy.rb', line 233

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

#update(friendly_name: :unset) ⇒ ConnectionPolicyInstance

Update the ConnectionPolicyInstance

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:



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

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)
    ConnectionPolicyInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end