Class: Twilio::REST::Fax::V1::FaxList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/fax/v1/fax.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) ⇒ FaxList

Initialize the FaxList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Faxes"
end

Instance Method Details

#create(to: nil, media_url: nil, quality: :unset, status_callback: :unset, from: :unset, sip_auth_username: :unset, sip_auth_password: :unset, store_media: :unset, ttl: :unset) ⇒ FaxInstance

Create the FaxInstance



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 188

def create(to: nil, media_url: nil, quality: :unset, status_callback: :unset, from: :unset, sip_auth_username: :unset, sip_auth_password: :unset, store_media: :unset, ttl: :unset)
  data = Twilio::Values.of({
      'To' => to,
      'MediaUrl' => media_url,
      'Quality' => quality,
      'StatusCallback' => status_callback,
      'From' => from,
      'SipAuthUsername' => sip_auth_username,
      'SipAuthPassword' => sip_auth_password,
      'StoreMedia' => store_media,
      'Ttl' => ttl,
  })

  payload = @version.create('POST', @uri, data: data)

  FaxInstance.new(@version, payload, )
end

#each ⇒ Object

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



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

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



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 147

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

#list(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, limit: nil, page_size: nil) ⇒ Array

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



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 49

def list(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, limit: nil, page_size: nil)
  self.stream(
      from: from,
      to: to,
      date_created_on_or_before: date_created_on_or_before,
      date_created_after: date_created_after,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 126

def page(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'From' => from,
      'To' => to,
      'DateCreatedOnOrBefore' => Twilio.serialize_iso8601_datetime(date_created_on_or_before),
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  FaxPage.new(@version, response, @solution)
end

#stream(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 81

def stream(from: :unset, to: :unset, date_created_on_or_before: :unset, date_created_after: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      from: from,
      to: to,
      date_created_on_or_before: date_created_on_or_before,
      date_created_after: date_created_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



208
209
210
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 208

def to_s
  '#<Twilio.Fax.V1.FaxList>'
end