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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

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

Parameters:

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

    The phone number or SIP address to send the fax to, E.164-formatted.

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

    The URL that Twilio will request to obtain the fax media to send, which must be a PDF file.

  • quality (fax.Quality) (defaults to: :unset) —

    The quality setting to use for this fax. One of ‘standard`, `fine` or `superfine`.

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

    The URL that Twilio will request when the status of the fax changes.

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

    The phone number to use as the caller id, E.164-formatted. If using a phone number, it must be a Twilio number or a verified outgoing caller id for your account. If sending to a SIP address, this can be any alphanumeric string (plus the characters ‘+`, `_`, `.`, and `-`) to use in the From header of the SIP request.

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

    The username to use for authentication when sending to a SIP address.

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

    The password to use for authentication when sending to a SIP address.

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

    Whether or not to store a copy of the sent media on Twilio’s servers for later retrieval (defaults to ‘true`)

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 174

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

  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.



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 93

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of FaxInstance



143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 143

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.

Parameters:

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

    Filters the returned list to only include faxes sent from the supplied number, given in E.164 format.

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

    Filters the returned list to only include faxes sent to the supplied number, given in E.164 format.

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

    Filters the returned list to only include faxes created on or before the supplied date, given in ISO 8601 format.

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

    Filters the returned list to only include faxes created after the supplied date, given in ISO 8601 format.

  • 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



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 45

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.

Parameters:

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

    Filters the returned list to only include faxes sent from the supplied number, given in E.164 format.

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

    Filters the returned list to only include faxes sent to the supplied number, given in E.164 format.

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

    Filters the returned list to only include faxes created on or before the supplied date, given in ISO 8601 format.

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

    Filters the returned list to only include faxes created after the supplied date, given in ISO 8601 format.

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 120

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
  )
  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.

Parameters:

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

    Filters the returned list to only include faxes sent from the supplied number, given in E.164 format.

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

    Filters the returned list to only include faxes sent to the supplied number, given in E.164 format.

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

    Filters the returned list to only include faxes created on or before the supplied date, given in ISO 8601 format.

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

    Filters the returned list to only include faxes created after the supplied date, given in ISO 8601 format.

  • 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



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 75

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



200
201
202
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 200

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