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

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 28

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

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 (RoleType) (defaults to: nil)
  • 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:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 41

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



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

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



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 147

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



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

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 127

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

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

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

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



97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 97

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



158
159
160
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 158

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