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


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

Parameters:

  • to (String) (defaults to: nil)

    The phone number to receive the fax in E.164 format or the recipient's SIP URI.

  • media_url (String) (defaults to: nil)

    The URL of the PDF that contains the fax. See our security page for information on how to ensure the request for your media comes from Twilio.

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

    The Fax Quality value that describes the fax quality. Can be: `standard`, `fine`, or `superfine` and defaults to `fine`.

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

    The URL we should call using the `POST` method to send status information to your application when the status of the fax changes.

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

    The number the fax was sent from. Can be the phone number in E.164 format or the SIP `from` value. The caller ID displayed to the recipient uses this value. If this is a phone number, it must be a Twilio number or a verified outgoing caller id from your account. If `to` is a SIP address, this can be any alphanumeric string (and also the characters `+`, `_`, `.`, and `-`), which will be used in the `from` header of the SIP request.

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

    The username to use with the `sip_auth_password` to authenticate faxes sent to a SIP address.

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

    The password to use with `sip_auth_username` to authenticate faxes sent to a SIP address.

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

    Whether to store a copy of the sent media on our servers for later retrieval. Can be: `true` or `false` and the default is `true`.

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

    How long in minutes from when the fax is initiated that we should try to send the fax.

Returns:


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

#eachObject

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.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of FaxInstance


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.

Parameters:

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

    Retrieve only those faxes sent from this phone number, specified in E.164 format.

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

    Retrieve only those faxes sent to this phone number, specified in E.164 format.

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

    Retrieve only those faxes with a `date_created` that is before or equal to this value, specified in ISO 8601 format.

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

    Retrieve only those faxes with a `date_created` that is later than this value, specified 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


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.

Parameters:

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

    Retrieve only those faxes sent from this phone number, specified in E.164 format.

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

    Retrieve only those faxes sent to this phone number, specified in E.164 format.

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

    Retrieve only those faxes with a `date_created` that is before or equal to this value, specified in ISO 8601 format.

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

    Retrieve only those faxes with a `date_created` that is later than this value, specified 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


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.

Parameters:

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

    Retrieve only those faxes sent from this phone number, specified in E.164 format.

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

    Retrieve only those faxes sent to this phone number, specified in E.164 format.

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

    Retrieve only those faxes with a `date_created` that is before or equal to this value, specified in ISO 8601 format.

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

    Retrieve only those faxes with a `date_created` that is later than this value, specified 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


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_sObject

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