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



386
387
388
389
390
391
392
393
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 386

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:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 398

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:



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 418

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.



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 515

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



558
559
560
561
562
563
564
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 558

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



453
454
455
456
457
458
459
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 453

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



497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 497

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



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 537

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



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 473

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



569
570
571
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 569

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