Class: Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentList
- 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
-
#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.
-
#each ⇒ Object
When passed a block, yields AuthorizationDocumentInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AuthorizationDocumentInstance records from the API.
-
#initialize(version) ⇒ AuthorizationDocumentList
constructor
Initialize the AuthorizationDocumentList.
-
#list(email: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists AuthorizationDocumentInstance records from the API as a list.
-
#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.
-
#stream(email: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams AuthorizationDocumentInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ AuthorizationDocumentList
Initialize the AuthorizationDocumentList
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
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.
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.
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.
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.
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 |