Class: Twilio::REST::Messaging::V1::ServiceContext::ChannelSenderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, messaging_service_sid: nil) ⇒ ChannelSenderList

Initialize the ChannelSenderList

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 28

def initialize(version, messaging_service_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { messaging_service_sid: messaging_service_sid }
    @uri = "/Services/#{@solution[:messaging_service_sid]}/ChannelSenders"
    
end

Instance Method Details

#create(sid: nil) ⇒ ChannelSenderInstance

Create the ChannelSenderInstance

Parameters:

  • sid (String) (defaults to: nil) —

    The SID of the Channel Sender being added to the Service.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 40

def create(
  sid: nil
)

    data = Twilio::Values.of({
        'Sid' => sid,
    })

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

#create_with_metadata(sid: nil) ⇒ ChannelSenderInstance

Create the ChannelSenderInstanceMetadata

Parameters:

  • sid (String) (defaults to: nil) —

    The SID of the Channel Sender being added to the Service.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 66

def create_with_metadata(
  sid: nil
)

    data = Twilio::Values.of({
        'Sid' => sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    channel_sender_instance = ChannelSenderInstance.new(
        @version,
        response.body,
        messaging_service_sid: @solution[:messaging_service_sid],
    )
    ChannelSenderInstanceMetadata.new(
        @version,
        channel_sender_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 163

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 ChannelSenderInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ChannelSenderInstance



204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 204

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

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

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

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



106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 106

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

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

Lists ChannelSenderPageMetadata records from the API as a list.

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



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 146

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

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

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

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

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

Parameters:

  • 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 ChannelSenderInstance



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 184

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

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

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

#stream(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:

  • 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



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 124

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

    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
end

#to_s ⇒ Object

Provide a user friendly representation



215
216
217
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb', line 215

def to_s
    '#<Twilio.Messaging.V1.ChannelSenderList>'
end