Class: Twilio::REST::Preview::Sync::ServiceContext::DocumentContext::DocumentPermissionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/document/document_permission.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

Constructor Details

#initialize(version, service_sid: nil, document_sid: nil) ⇒ DocumentPermissionList

Initialize the DocumentPermissionList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique SID identifier of the Sync Service Instance.

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

    The unique SID identifier of the Sync Document to which the Permission applies.



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 24

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

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

Instance Method Details

#each ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 78

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of DocumentPermissionInstance



116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 116

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

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

Lists DocumentPermissionInstance 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



46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 46

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 DocumentPermissionInstance 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 DocumentPermissionInstance



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

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
  )
  DocumentPermissionPage.new(@version, response, @solution)
end

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

Streams DocumentPermissionInstance 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



64
65
66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 64

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



126
127
128
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 126

def to_s
  '#<Twilio.Preview.Sync.DocumentPermissionList>'
end