Class: Twilio::REST::Trusthub::V1::TrustProductsContext::TrustProductsChannelEndpointAssignmentList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Trusthub::V1::TrustProductsContext::TrustProductsChannelEndpointAssignmentList
- Defined in:
- lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb
Instance Method Summary collapse
-
#create(channel_endpoint_type: nil, channel_endpoint_sid: nil) ⇒ TrustProductsChannelEndpointAssignmentInstance
Create the TrustProductsChannelEndpointAssignmentInstance.
-
#each ⇒ Object
When passed a block, yields TrustProductsChannelEndpointAssignmentInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of TrustProductsChannelEndpointAssignmentInstance records from the API.
-
#initialize(version, trust_product_sid: nil) ⇒ TrustProductsChannelEndpointAssignmentList
constructor
Initialize the TrustProductsChannelEndpointAssignmentList.
-
#list(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TrustProductsChannelEndpointAssignmentInstance records from the API as a list.
-
#page(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TrustProductsChannelEndpointAssignmentInstance records from the API.
-
#stream(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams TrustProductsChannelEndpointAssignmentInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, trust_product_sid: nil) ⇒ TrustProductsChannelEndpointAssignmentList
Initialize the TrustProductsChannelEndpointAssignmentList
21 22 23 24 25 26 27 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 21 def initialize(version, trust_product_sid: nil) super(version) # Path Solution @solution = {trust_product_sid: trust_product_sid} @uri = "/TrustProducts/#{@solution[:trust_product_sid]}/ChannelEndpointAssignments" end |
Instance Method Details
#create(channel_endpoint_type: nil, channel_endpoint_sid: nil) ⇒ TrustProductsChannelEndpointAssignmentInstance
Create the TrustProductsChannelEndpointAssignmentInstance
35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 35 def create(channel_endpoint_type: nil, channel_endpoint_sid: nil) data = Twilio::Values.of({ 'ChannelEndpointType' => channel_endpoint_type, 'ChannelEndpointSid' => channel_endpoint_sid, }) payload = @version.create('POST', @uri, data: data) TrustProductsChannelEndpointAssignmentInstance.new( @version, payload, trust_product_sid: @solution[:trust_product_sid], ) end |
#each ⇒ Object
When passed a block, yields TrustProductsChannelEndpointAssignmentInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
103 104 105 106 107 108 109 110 111 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 103 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 TrustProductsChannelEndpointAssignmentInstance records from the API. Request is executed immediately.
142 143 144 145 146 147 148 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 142 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TrustProductsChannelEndpointAssignmentPage.new(@version, response, @solution) end |
#list(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TrustProductsChannelEndpointAssignmentInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
64 65 66 67 68 69 70 71 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 64 def list(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) self.stream( channel_endpoint_sid: channel_endpoint_sid, channel_endpoint_sids: channel_endpoint_sids, limit: limit, page_size: page_size ).entries end |
#page(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TrustProductsChannelEndpointAssignmentInstance records from the API. Request is executed immediately.
123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 123 def page(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'ChannelEndpointSid' => channel_endpoint_sid, 'ChannelEndpointSids' => channel_endpoint_sids, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) TrustProductsChannelEndpointAssignmentPage.new(@version, response, @solution) end |
#stream(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams TrustProductsChannelEndpointAssignmentInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 87 def stream(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( channel_endpoint_sid: channel_endpoint_sid, channel_endpoint_sids: channel_endpoint_sids, 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
152 153 154 |
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products/trust_products_channel_endpoint_assignment.rb', line 152 def to_s '#<Twilio.Trusthub.V1.TrustProductsChannelEndpointAssignmentList>' end |