Class: Twilio::REST::Notify::V1::ServiceList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ServiceList

Initialize the ServiceList

Parameters:

  • version (Version) —

    Version that contains the resource



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 18

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) ⇒ ServiceInstance

Retrieve a single page of ServiceInstance records from the API. Request is executed immediately.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • apn_credential_sid (String) (defaults to: :unset) —

    The apn_credential_sid

  • gcm_credential_sid (String) (defaults to: :unset) —

    The gcm_credential_sid

  • messaging_service_sid (String) (defaults to: :unset) —

    The messaging_service_sid

  • facebook_messenger_page_id (String) (defaults to: :unset) —

    The facebook_messenger_page_id

  • default_apn_notification_protocol_version (String) (defaults to: :unset) —

    The default_apn_notification_protocol_version

  • default_gcm_notification_protocol_version (String) (defaults to: :unset) —

    The default_gcm_notification_protocol_version

  • fcm_credential_sid (String) (defaults to: :unset) —

    The fcm_credential_sid

  • default_fcm_notification_protocol_version (String) (defaults to: :unset) —

    The default_fcm_notification_protocol_version

  • log_enabled (Boolean) (defaults to: :unset) —

    The log_enabled

  • alexa_skill_id (String) (defaults to: :unset) —

    The alexa_skill_id

  • default_alexa_notification_protocol_version (String) (defaults to: :unset) —

    The default_alexa_notification_protocol_version

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 46

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)
  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,
  })

  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.



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 111

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ServiceInstance



149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 149

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.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



83
84
85
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 83

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.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of ServiceInstance



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 129

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
  )
  ServicePage.new(@version, response, @solution)
end

#stream(friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams ServiceInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 99

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



159
160
161
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 159

def to_s
  '#<Twilio.Notify.V1.ServiceList>'
end