Class: Twilio::REST::Notify::V1::ServiceList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Notify::V1::ServiceList
- Defined in:
- lib/twilio-ruby/rest/notify/v1/service.rb
Instance Method Summary collapse
-
#create(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_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(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ServiceInstance records from the API as a list.
-
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ServiceInstance records from the API.
-
#stream(friendly_name: :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) ⇒ ServiceList
Initialize the ServiceList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Services" end |
Instance Method Details
#create(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset) ⇒ ServiceInstance
Create the ServiceInstance
49 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/notify/v1/service.rb', line 49 def create( friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset ) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'ApnCredentialSid' => apn_credential_sid, 'GcmCredentialSid' => gcm_credential_sid, 'MessagingServiceSid' => messaging_service_sid, 'FacebookMessengerPageId' => facebook_messenger_page_id, 'DefaultApnNotificationProtocolVersion' => default_apn_notification_protocol_version, 'DefaultGcmNotificationProtocolVersion' => default_gcm_notification_protocol_version, 'FcmCredentialSid' => fcm_credential_sid, 'DefaultFcmNotificationProtocolVersion' => default_fcm_notification_protocol_version, 'LogEnabled' => log_enabled, 'AlexaSkillId' => alexa_skill_id, 'DefaultAlexaNotificationProtocolVersion' => default_alexa_notification_protocol_version, 'DeliveryCallbackUrl' => delivery_callback_url, 'DeliveryCallbackEnabled' => delivery_callback_enabled, }) payload = @version.create('POST', @uri, data: data) 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.
137 138 139 140 141 142 143 144 145 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 137 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.
173 174 175 176 177 178 179 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 173 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ServicePage.new(@version, response, @solution) end |
#list(friendly_name: :unset, 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.
103 104 105 106 107 108 109 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 103 def list(friendly_name: :unset, limit: nil, page_size: nil) self.stream( friendly_name: friendly_name, limit: limit, page_size: page_size ).entries end |
#page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ServiceInstance records from the API. Request is executed immediately.
155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 155 def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ServicePage.new(@version, response, @solution) end |
#stream(friendly_name: :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.
123 124 125 126 127 128 129 130 131 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 123 def stream(friendly_name: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( friendly_name: friendly_name, 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
184 185 186 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 184 def to_s '#<Twilio.Notify.V1.ServiceList>' end |