Class: Twilio::REST::Sync::V1::ServiceContext::DocumentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/document.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ DocumentList

Initialize the DocumentList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The service_sid



20
21
22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 20

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      service_sid: service_sid
  }
  @uri = "/Services/#{@solution[:service_sid]}/Documents"
end

Instance Method Details

#create(unique_name: :unset, data: :unset) ⇒ DocumentInstance

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

Parameters:

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

    The unique_name

  • data (Hash) (defaults to: :unset) —

    The data

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 36

def create(unique_name: :unset, data: :unset)
  data = Twilio::Values.of({
      'UniqueName' => unique_name,
      'Data' => Twilio.serialize_object(data),
  })

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

  DocumentInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
  )
end

#each ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 98

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of DocumentInstance



136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 136

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

#list(limit: nil, page_size: nil) ⇒ Array

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

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



66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 66

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

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

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

Parameters:

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



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 117

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  DocumentPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

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:

  • (Enumerable) —

    Enumerable that will yield up to limit results



84
85
86
87
88
89
90
91
92
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 84

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

  page = self.page(
      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



146
147
148
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 146

def to_s
  '#<Twilio.Sync.V1.DocumentList>'
end