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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AuthorizationDocumentList

Initialize the AuthorizationDocumentList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 26

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 42

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



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

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.



165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 165

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.



87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 87

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.



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

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

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

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



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 109

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



176
177
178
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb', line 176

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