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
Instance Method Summary collapse
-
#create(brand_registration_sid: nil, description: nil, message_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset) ⇒ 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 Instance 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
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 27 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_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset) ⇒ UsAppToPersonInstance
Create the UsAppToPersonInstance
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 50 def create( brand_registration_sid: nil, description: nil, message_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset ) data = Twilio::Values.of({ 'BrandRegistrationSid' => brand_registration_sid, 'Description' => description, 'MessageFlow' => , 'MessageSamples' => Twilio.serialize_list() { |e| e }, 'UsAppToPersonUsecase' => us_app_to_person_usecase, 'HasEmbeddedLinks' => , 'HasEmbeddedPhone' => , 'OptInMessage' => , 'OptOutMessage' => , 'HelpMessage' => , 'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e }, 'OptOutKeywords' => Twilio.serialize_list(opt_out_keywords) { |e| e }, 'HelpKeywords' => Twilio.serialize_list(help_keywords) { |e| e }, }) 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.
133 134 135 136 137 138 139 140 141 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 133 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.
167 168 169 170 171 172 173 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 167 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.
102 103 104 105 106 107 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 102 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.
150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 150 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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
120 121 122 123 124 125 126 127 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 120 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
178 179 180 |
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 178 def to_s '#<Twilio.Messaging.V1.UsAppToPersonList>' end |