Class: Twilio::REST::Api::V2010::AccountContext::CallContext::NotificationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/call/notification.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, call_sid: nil) ⇒ NotificationList

Initialize the NotificationList

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) (defaults to: nil) —

    The account_sid

  • call_sid (String) (defaults to: nil) —

    The call_sid



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 20

def initialize(version, account_sid: nil, call_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      account_sid: ,
      call_sid: call_sid
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Notifications.json"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields NotificationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 90

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 NotificationInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of NotificationInstance



136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 136

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  NotificationPage.new(@version, response, @solution)
end

#list(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, limit: nil, page_size: nil) ⇒ Array

Lists NotificationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    The log

  • message_date_before (Time) (defaults to: :unset) —

    The message_date

  • message_date (Time) (defaults to: :unset) —

    The message_date

  • message_date_after (Time) (defaults to: :unset) —

    The message_date

  • 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



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 46

def list(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, limit: nil, page_size: nil)
  self.stream(
      log: log,
      message_date_before: message_date_before,
      message_date: message_date,
      message_date_after: message_date_after,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    The log

  • message_date_before (Time) (defaults to: :unset) —

    The message_date

  • message_date (Time) (defaults to: :unset) —

    The message_date

  • message_date_after (Time) (defaults to: :unset) —

    The message_date

  • 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 NotificationInstance



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 113

def page(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Log' => log,
      'MessageDate<' => Twilio.serialize_iso8601_date(message_date_before),
      'MessageDate' => Twilio.serialize_iso8601_date(message_date),
      'MessageDate>' => Twilio.serialize_iso8601_date(message_date_after),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  NotificationPage.new(@version, response, @solution)
end

#stream(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The log

  • message_date_before (Time) (defaults to: :unset) —

    The message_date

  • message_date (Time) (defaults to: :unset) —

    The message_date

  • message_date_after (Time) (defaults to: :unset) —

    The message_date

  • 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



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 72

def stream(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      log: log,
      message_date_before: message_date_before,
      message_date: message_date,
      message_date_after: message_date_after,
      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



146
147
148
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 146

def to_s
  '#<Twilio.Api.V2010.NotificationList>'
end