Class: Twilio::REST::Messaging::V1::TollfreeVerificationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Messaging::V1::TollfreeVerificationList
- Defined in:
- lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb
Instance Method Summary collapse
-
#create(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, external_reference_id: :unset) ⇒ TollfreeVerificationInstance
Create the TollfreeVerificationInstance.
-
#each ⇒ Object
When passed a block, yields TollfreeVerificationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of TollfreeVerificationInstance records from the API.
-
#initialize(version) ⇒ TollfreeVerificationList
constructor
Initialize the TollfreeVerificationList.
-
#list(tollfree_phone_number_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TollfreeVerificationInstance records from the API as a list.
-
#page(tollfree_phone_number_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TollfreeVerificationInstance records from the API.
-
#stream(tollfree_phone_number_sid: :unset, status: :unset, 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) ⇒ TollfreeVerificationList
Initialize the TollfreeVerificationList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Tollfree/Verifications" end |
Instance Method Details
#create(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, external_reference_id: :unset) ⇒ TollfreeVerificationInstance
Create the TollfreeVerificationInstance
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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 58 def create( business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, external_reference_id: :unset ) data = Twilio::Values.of({ 'BusinessName' => business_name, 'BusinessWebsite' => business_website, 'NotificationEmail' => notification_email, 'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e }, 'UseCaseSummary' => use_case_summary, 'ProductionMessageSample' => , 'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e }, 'OptInType' => opt_in_type, 'MessageVolume' => , 'TollfreePhoneNumberSid' => tollfree_phone_number_sid, 'CustomerProfileSid' => customer_profile_sid, 'BusinessStreetAddress' => business_street_address, 'BusinessStreetAddress2' => business_street_address2, 'BusinessCity' => business_city, 'BusinessStateProvinceRegion' => business_state_province_region, 'BusinessPostalCode' => business_postal_code, 'BusinessCountry' => business_country, 'AdditionalInformation' => additional_information, 'BusinessContactFirstName' => business_contact_first_name, 'BusinessContactLastName' => business_contact_last_name, 'BusinessContactEmail' => business_contact_email, 'BusinessContactPhone' => business_contact_phone, 'ExternalReferenceId' => external_reference_id, }) payload = @version.create('POST', @uri, data: data) TollfreeVerificationInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields TollfreeVerificationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
168 169 170 171 172 173 174 175 176 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 168 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 TollfreeVerificationInstance records from the API. Request is executed immediately.
206 207 208 209 210 211 212 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 206 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TollfreeVerificationPage.new(@version, response, @solution) end |
#list(tollfree_phone_number_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TollfreeVerificationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
131 132 133 134 135 136 137 138 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 131 def list(tollfree_phone_number_sid: :unset, status: :unset, limit: nil, page_size: nil) self.stream( tollfree_phone_number_sid: tollfree_phone_number_sid, status: status, limit: limit, page_size: page_size ).entries end |
#page(tollfree_phone_number_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TollfreeVerificationInstance records from the API. Request is executed immediately.
187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 187 def page(tollfree_phone_number_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'TollfreePhoneNumberSid' => tollfree_phone_number_sid, 'Status' => status, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) TollfreeVerificationPage.new(@version, response, @solution) end |
#stream(tollfree_phone_number_sid: :unset, status: :unset, 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.
153 154 155 156 157 158 159 160 161 162 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 153 def stream(tollfree_phone_number_sid: :unset, status: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( tollfree_phone_number_sid: tollfree_phone_number_sid, status: status, 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
217 218 219 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 217 def to_s '#<Twilio.Messaging.V1.TollfreeVerificationList>' end |