class Twilio::REST::Numbers::V2::RegulatoryComplianceList::SupportingDocumentList

Public Class Methods

new(version) click to toggle source

Initialize the SupportingDocumentList @param [Version] version Version that contains the resource @return [SupportingDocumentList] SupportingDocumentList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
19 def initialize(version)
20   super(version)
21 
22   # Path Solution
23   @solution = {}
24   @uri = "/RegulatoryCompliance/SupportingDocuments"
25 end

Public Instance Methods

create(friendly_name: nil, type: nil, attributes: :unset) click to toggle source

Create the SupportingDocumentInstance @param [String] friendly_name The string that you assigned to describe the

resource.

@param [String] type The type of the Supporting Document. @param [Hash] attributes The set of parameters that are the attributes of the

Supporting Documents resource which are derived Supporting Document Types.

@return [SupportingDocumentInstance] Created SupportingDocumentInstance

   # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
35 def create(friendly_name: nil, type: nil, attributes: :unset)
36   data = Twilio::Values.of({
37       'FriendlyName' => friendly_name,
38       'Type' => type,
39       'Attributes' => Twilio.serialize_object(attributes),
40   })
41 
42   payload = @version.create('POST', @uri, data: data)
43 
44   SupportingDocumentInstance.new(@version, payload, )
45 end
each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
85 def each
86   limits = @version.read_limits
87 
88   page = self.page(page_size: limits[:page_size], )
89 
90   @version.stream(page,
91                   limit: limits[:limit],
92                   page_limit: limits[:page_limit]).each {|x| yield x}
93 end
get_page(target_url) click to toggle source

Retrieve a single page of SupportingDocumentInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of SupportingDocumentInstance

    # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
119 def get_page(target_url)
120   response = @version.domain.request(
121       'GET',
122       target_url
123   )
124   SupportingDocumentPage.new(@version, response, @solution)
125 end
list(limit: nil, page_size: nil) click to toggle source

Lists SupportingDocumentInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size 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)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
58 def list(limit: nil, page_size: nil)
59   self.stream(limit: limit, page_size: page_size).entries
60 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of SupportingDocumentInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of SupportingDocumentInstance

    # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
102 def page(page_token: :unset, page_number: :unset, page_size: :unset)
103   params = Twilio::Values.of({
104       'PageToken' => page_token,
105       'Page' => page_number,
106       'PageSize' => page_size,
107   })
108 
109   response = @version.page('GET', @uri, params: params)
110 
111   SupportingDocumentPage.new(@version, response, @solution)
112 end
stream(limit: nil, page_size: nil) click to toggle source

Streams SupportingDocumentInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size 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)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
73 def stream(limit: nil, page_size: nil)
74   limits = @version.read_limits(limit, page_size)
75 
76   page = self.page(page_size: limits[:page_size], )
77 
78   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
79 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb
129 def to_s
130   '#<Twilio.Numbers.V2.SupportingDocumentList>'
131 end