Class: Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AuthorizationDocumentList

Initialize the AuthorizationDocumentList

Parameters:

  • version (Version) —

    Version that contains the resource


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

def initialize(version)
  super(version)

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

Instance Method Details

#create(hosted_number_order_sids: nil, address_sid: nil, email: nil, contact_title: nil, contact_phone_number: nil, cc_emails: :unset) ⇒ AuthorizationDocumentInstance

Create the AuthorizationDocumentInstance

Parameters:

  • hosted_number_order_sids (Array[String]) (defaults to: nil) —

    A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.

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

    A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

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

    Email that this AuthorizationDocument will be sent to for signing.

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

    The title of the person authorized to sign the Authorization Document for this phone number.

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

    The contact phone number of the person authorized to sign the Authorization Document.

  • cc_emails (Array[String]) (defaults to: :unset) —

    Email recipients who will be informed when an Authorization Document has been sent and signed.

Returns:


147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 147

def create(hosted_number_order_sids: nil, address_sid: nil, email: nil, contact_title: nil, contact_phone_number: nil, cc_emails: :unset)
  data = Twilio::Values.of({
      'HostedNumberOrderSids' => Twilio.serialize_list(hosted_number_order_sids) { |e| e },
      'AddressSid' => address_sid,
      'Email' => email,
      'ContactTitle' => contact_title,
      'ContactPhoneNumber' => contact_phone_number,
      'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
  })

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

  AuthorizationDocumentInstance.new(@version, payload, )
end

#each ⇒ Object

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


80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 80

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AuthorizationDocumentInstance


123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 123

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

#list(email: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    Email that this AuthorizationDocument will be sent to for signing.

  • status (authorization_document.Status) (defaults to: :unset) —

    Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

  • 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
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 46

def list(email: :unset, status: :unset, limit: nil, page_size: nil)
  self.stream(email: email, status: status, limit: limit, page_size: page_size).entries
end

#page(email: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    Email that this AuthorizationDocument will be sent to for signing.

  • status (authorization_document.Status) (defaults to: :unset) —

    Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

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


104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 104

def page(email: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Email' => email,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

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

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

Parameters:

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

    Email that this AuthorizationDocument will be sent to for signing.

  • status (authorization_document.Status) (defaults to: :unset) —

    Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

  • 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


68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 68

def stream(email: :unset, status: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(email: email, status: status, 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


164
165
166
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 164

def to_s
  '#<Twilio.Preview.HostedNumbers.AuthorizationDocumentList>'
end