Class: Twilio::REST::Messaging::V1::ServiceContext::UsAppToPersonList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Messaging::V1::ServiceContext::UsAppToPersonList
- Defined in:
- lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Instance Method Summary collapse
-
#create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil) ⇒ UsAppToPersonInstance
Create the UsAppToPersonInstance.
-
#each ⇒ Object
When passed a block, yields UsAppToPersonInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of UsAppToPersonInstance records from the API.
-
#initialize(version, messaging_service_sid: nil) ⇒ UsAppToPersonList
constructor
Initialize the UsAppToPersonList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists UsAppToPersonInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of UsAppToPersonInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams UsAppToPersonInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, messaging_service_sid: nil) ⇒ UsAppToPersonList
Initialize the UsAppToPersonList
24 25 26 27 28 29 30 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 24 def initialize(version, messaging_service_sid: nil) super(version) # Path Solution @solution = {messaging_service_sid: messaging_service_sid} @uri = "/Services/#{@solution[:messaging_service_sid]}/Compliance/Usa2p" end |
Instance Method Details
#create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil) ⇒ UsAppToPersonInstance
Create the UsAppToPersonInstance
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 45 def create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil) data = Twilio::Values.of({ 'BrandRegistrationSid' => brand_registration_sid, 'Description' => description, 'MessageSamples' => Twilio.serialize_list() { |e| e }, 'UsAppToPersonUsecase' => us_app_to_person_usecase, 'HasEmbeddedLinks' => , 'HasEmbeddedPhone' => , }) payload = @version.create('POST', @uri, data: data) UsAppToPersonInstance.new( @version, payload, messaging_service_sid: @solution[:messaging_service_sid], ) end |
#each ⇒ Object
When passed a block, yields UsAppToPersonInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
102 103 104 105 106 107 108 109 110 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 102 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 UsAppToPersonInstance records from the API. Request is executed immediately.
136 137 138 139 140 141 142 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 136 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) UsAppToPersonPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists UsAppToPersonInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
75 76 77 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 75 def list(limit: nil, page_size: nil) self.stream(limit: limit, page_size: page_size).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of UsAppToPersonInstance records from the API. Request is executed immediately.
119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 119 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) UsAppToPersonPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams UsAppToPersonInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 90 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(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
146 147 148 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 146 def to_s '#<Twilio.Messaging.V1.UsAppToPersonList>' end |