Class: Twilio::REST::Numbers::V2::AuthorizationDocumentList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AuthorizationDocumentList

Initialize the AuthorizationDocumentList

Parameters:

  • version (Version) —

    Version that contains the resource



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

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/HostedNumber/AuthorizationDocuments"
    
end

Instance Method Details

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

Create the AuthorizationDocumentInstance

Parameters:

  • 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_phone_number (String) (defaults to: nil) —

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

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

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

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

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

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

Returns:



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
72
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 43

def create(
    address_sid: nil, 
    email: nil, 
    contact_phone_number: nil, 
    hosted_number_order_sids: nil, 
    contact_title: :unset, 
    cc_emails: :unset
)

    data = Twilio::Values.of({
        'AddressSid' => address_sid,
        'Email' => email,
        'ContactPhoneNumber' => contact_phone_number,
        'HostedNumberOrderSids' => Twilio.serialize_list(hosted_number_order_sids) { |e| e },
        'ContactTitle' => contact_title,
        '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

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

Create the AuthorizationDocumentInstanceMetadata

Parameters:

  • 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_phone_number (String) (defaults to: nil) —

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

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

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

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

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

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

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 83

def create_with_metadata(
  address_sid: nil, 
  email: nil, 
  contact_phone_number: nil, 
  hosted_number_order_sids: nil, 
  contact_title: :unset, 
  cc_emails: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    authorization_document_instance = AuthorizationDocumentInstance.new(
        @version,
        response.body,
    )
    AuthorizationDocumentInstanceMetadata.new(
        @version,
        authorization_document_instance,
        response.headers,
        response.status_code
    )
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.



197
198
199
200
201
202
203
204
205
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 197

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



238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 238

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 (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](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#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



134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 134

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

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

Returns Array of up to limit results.

Parameters:

  • 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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 178

def list_with_metadata(email: :unset, status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Email' => email,
        'Status' => status,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    AuthorizationDocumentPageMetadata.new(@version, response, @solution, limits[:limit])
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 (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](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 216

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.

Parameters:

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

    Email that this AuthorizationDocument will be sent to for signing.

  • status (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](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#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



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 156

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



249
250
251
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document.rb', line 249

def to_s
    '#<Twilio.Numbers.V2.AuthorizationDocumentList>'
end