Class: Twilio::REST::Messaging::V2::ChannelsSenderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v2/channels_sender.rb

Defined Under Namespace

Classes: MessagingV2ChannelsSenderProfile, MessagingV2ChannelsSenderProfileGenericResponseEmails, MessagingV2ChannelsSenderProfileGenericResponsePhoneNumbers, MessagingV2ChannelsSenderProfileGenericResponseWebsites, MessagingV2ChannelsSenderRequestsCreate, MessagingV2ChannelsSenderRequestsUpdate, MessagingV2RcsCarrier, MessagingV2RcsComplianceCountryResponse

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ChannelsSenderList

Initialize the ChannelsSenderList

Parameters:

  • version (Version) —

    Version that contains the resource



398
399
400
401
402
403
404
405
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 398

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Channels/Senders"
    
end

Instance Method Details

#create(messaging_v2_channels_sender_requests_create: nil) ⇒ ChannelsSenderInstance

Create the ChannelsSenderInstance

Parameters:

Returns:



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 410

def create(messaging_v2_channels_sender_requests_create: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.create('POST', @uri, headers: headers, data: messaging_v2_channels_sender_requests_create.to_json)
    ChannelsSenderInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(messaging_v2_channels_sender_requests_create: nil) ⇒ ChannelsSenderInstance

Create the ChannelsSenderInstanceMetadata

Parameters:

Returns:



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 430

def create_with_metadata(messaging_v2_channels_sender_requests_create: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: messaging_v2_channels_sender_requests_create.to_json)
    channels_sender_instance = ChannelsSenderInstance.new(
        @version,
        response.body,
    )
    ChannelsSenderInstanceMetadata.new(
        @version,
        channels_sender_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields ChannelsSenderInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 527

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of ChannelsSenderInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ChannelsSenderInstance



570
571
572
573
574
575
576
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 570

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
ChannelsSenderPage.new(@version, response, @solution)
end

#list(channel: nil, limit: nil, page_size: nil) ⇒ Array

Lists ChannelsSenderInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:

  • channel (String) (defaults to: nil)
  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



465
466
467
468
469
470
471
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 465

def list(channel: nil, limit: nil, page_size: nil)
    self.stream(
        channel: channel,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(channel: nil, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 509

def list_with_metadata(channel: nil, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Channel' => channel,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    ChannelsSenderPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(channel: nil, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of ChannelsSenderInstance records from the API. Request is executed immediately.

Parameters:

  • channel (String) (defaults to: nil)
  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of ChannelsSenderInstance



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 549

def page(channel: nil, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Channel' => channel,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    ChannelsSenderPage.new(@version, response, @solution)
end

#stream(channel: nil, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • channel (String) (defaults to: nil)
  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 485

def stream(channel: nil, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        channel: channel,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



581
582
583
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 581

def to_s
    '#<Twilio.Messaging.V2.ChannelsSenderList>'
end