Class: Twilio::REST::Verify::V2::ServiceList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Verify::V2::ServiceList
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service.rb
Instance Method Summary collapse
-
#create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset, whatsapp_msg_service_sid: :unset, whatsapp_from: :unset, passkeys_relying_party_id: :unset, passkeys_relying_party_name: :unset, passkeys_relying_party_origins: :unset, passkeys_authenticator_attachment: :unset, passkeys_discoverable_credentials: :unset, passkeys_user_verification: :unset, verify_event_subscription_enabled: :unset) ⇒ ServiceInstance
Create the ServiceInstance.
-
#each ⇒ Object
When passed a block, yields ServiceInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ServiceInstance records from the API.
-
#initialize(version) ⇒ ServiceList
constructor
Initialize the ServiceList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists ServiceInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ServiceInstance 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) ⇒ ServiceList
Initialize the ServiceList
26 27 28 29 30 31 32 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 26 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Services" end |
Instance Method Details
#create(friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset, whatsapp_msg_service_sid: :unset, whatsapp_from: :unset, passkeys_relying_party_id: :unset, passkeys_relying_party_name: :unset, passkeys_relying_party_origins: :unset, passkeys_authenticator_attachment: :unset, passkeys_discoverable_credentials: :unset, passkeys_user_verification: :unset, verify_event_subscription_enabled: :unset) ⇒ ServiceInstance
Create the ServiceInstance
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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 62 def create( friendly_name: nil, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset, whatsapp_msg_service_sid: :unset, whatsapp_from: :unset, passkeys_relying_party_id: :unset, passkeys_relying_party_name: :unset, passkeys_relying_party_origins: :unset, passkeys_authenticator_attachment: :unset, passkeys_discoverable_credentials: :unset, passkeys_user_verification: :unset, verify_event_subscription_enabled: :unset ) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'CodeLength' => code_length, 'LookupEnabled' => lookup_enabled, 'SkipSmsToLandlines' => skip_sms_to_landlines, 'DtmfInputRequired' => dtmf_input_required, 'TtsName' => tts_name, 'Psd2Enabled' => psd2_enabled, 'DoNotShareWarningEnabled' => do_not_share_warning_enabled, 'CustomCodeEnabled' => custom_code_enabled, 'Push.IncludeDate' => push_include_date, 'Push.ApnCredentialSid' => push_apn_credential_sid, 'Push.FcmCredentialSid' => push_fcm_credential_sid, 'Totp.Issuer' => totp_issuer, 'Totp.TimeStep' => totp_time_step, 'Totp.CodeLength' => totp_code_length, 'Totp.Skew' => totp_skew, 'DefaultTemplateSid' => default_template_sid, 'Whatsapp.MsgServiceSid' => whatsapp_msg_service_sid, 'Whatsapp.From' => whatsapp_from, 'Passkeys.RelyingParty.Id' => , 'Passkeys.RelyingParty.Name' => , 'Passkeys.RelyingParty.Origins' => , 'Passkeys.AuthenticatorAttachment' => , 'Passkeys.DiscoverableCredentials' => passkeys_discoverable_credentials, 'Passkeys.UserVerification' => passkeys_user_verification, 'VerifyEventSubscriptionEnabled' => verify_event_subscription_enabled, }) headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', }) payload = @version.create('POST', @uri, data: data, headers: headers) ServiceInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields ServiceInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
176 177 178 179 180 181 182 183 184 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 176 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 ServiceInstance records from the API. Request is executed immediately.
213 214 215 216 217 218 219 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 213 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ServicePage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists ServiceInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
145 146 147 148 149 150 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 145 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 ServiceInstance records from the API. Request is executed immediately.
193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 193 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) ServicePage.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.
163 164 165 166 167 168 169 170 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 163 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
224 225 226 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 224 def to_s '#<Twilio.Verify.V2.ServiceList>' end |