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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ RoleList

Initialize the RoleList

Parameters:

  • version (Version) —

    Version that contains the resource


18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Roles"
end

Instance Method Details

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

Create the RoleInstance

Parameters:

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

    A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

  • type (role.RoleType) (defaults to: nil) —

    The type of role. Can be: `conversation` for Conversation roles or `service` for Conversation Service roles.

  • permission (Array[String]) (defaults to: nil) —

    A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.

Returns:


39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 39

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, )
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.


89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 89

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of RoleInstance


123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 123

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.

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


62
63
64
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 62

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.

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 RoleInstance


106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 106

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.

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


77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 77

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


133
134
135
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 133

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