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



380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 380

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:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 392

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:



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 412

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.



505
506
507
508
509
510
511
512
513
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 505

def each
    limits = @version.read_limits

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

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).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



544
545
546
547
548
549
550
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 544

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



447
448
449
450
451
452
453
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 447

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



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

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



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

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



467
468
469
470
471
472
473
474
475
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 467

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], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



555
556
557
 
# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 555

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