Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb,
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb,
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb,
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/replace_items.rb,
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/item_assignment.rb

Defined Under Namespace

Classes: BundleCopyInstance, BundleCopyList, BundleCopyPage, EvaluationContext, EvaluationInstance, EvaluationList, EvaluationPage, ItemAssignmentContext, ItemAssignmentInstance, ItemAssignmentList, ItemAssignmentPage, ReplaceItemsInstance, ReplaceItemsList, ReplaceItemsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ BundleContext

Initialize the BundleContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 250

def initialize(version, sid)
    super(version)

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

    # Dependents
    @replace_items = nil
    @bundle_copies = nil
    @item_assignments = nil
    @evaluations = nil
end

Instance Method Details

#bundle_copies ⇒ BundleCopyList, BundleCopyContext

Access the bundle_copies

Returns:



344
345
346
347
348
349
350
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 344

def bundle_copies
  unless @bundle_copies
    @bundle_copies = BundleCopyList.new(
            @version, bundle_sid: @solution[:sid], )
  end
  @bundle_copies
end

#delete ⇒ Boolean

Delete the BundleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



266
267
268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 266

def delete

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

#evaluations(sid = :unset) ⇒ EvaluationList, EvaluationContext

Access the evaluations

Returns:

Raises:

  • (ArgumentError) 


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 374

def evaluations(sid=:unset)

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

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

    unless @evaluations
        @evaluations = EvaluationList.new(
            @version, bundle_sid: @solution[:sid], )
    end

 @evaluations
end

#fetch ⇒ BundleInstance

Fetch the BundleInstance

Returns:



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 278

def fetch

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 399

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

#item_assignments(sid = :unset) ⇒ ItemAssignmentList, ItemAssignmentContext

Access the item_assignments

Returns:

Raises:

  • (ArgumentError) 


355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 355

def item_assignments(sid=:unset)

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

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

    unless @item_assignments
        @item_assignments = ItemAssignmentList.new(
            @version, bundle_sid: @solution[:sid], )
    end

 @item_assignments
end

#replace_items ⇒ ReplaceItemsList, ReplaceItemsContext

Access the replace_items

Returns:



333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 333

def replace_items
  unless @replace_items
    @replace_items = ReplaceItemsList.new(
            @version, bundle_sid: @solution[:sid], )
  end
  @replace_items
end

#to_s ⇒ Object

Provide a user friendly representation



392
393
394
395
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 392

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

#update(status: :unset, status_callback: :unset, friendly_name: :unset, email: :unset) ⇒ BundleInstance

Update the BundleInstance

Parameters:

  • status (Status) (defaults to: :unset)
  • status_callback (String) (defaults to: :unset) —

    The URL we call to inform your application of status changes.

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

    The string that you assigned to describe the resource.

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

    The email address that will receive updates when the Bundle resource changes status.

Returns:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 301

def update(
    status: :unset, 
    status_callback: :unset, 
    friendly_name: :unset, 
    email: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'StatusCallback' => status_callback,
        'FriendlyName' => friendly_name,
        'Email' => email,
    })

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