Class: Twilio::REST::Conversations::V1::ServiceContext::RoleList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid: nil) ⇒ RoleList

Initialize the RoleList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 22

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

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

Instance Method Details

#create(friendly_name: nil, type: nil, permission: nil) ⇒ RoleInstance

Create the RoleInstance



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 43

def create(friendly_name: nil, type: nil, permission: nil)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Type' => type,
      'Permission' => Twilio.serialize_list(permission) { |e| e },
  })

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

  RoleInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
end

#each ⇒ Object

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



93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 93

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



127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 127

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

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

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



66
67
68
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.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 RoleInstance records from the API. Request is executed immediately.



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 110

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: params)

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

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

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



81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 81

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



137
138
139
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 137

def to_s
  '#<Twilio.Conversations.V1.RoleList>'
end