Class: Twilio::REST::Chat::V2::ServiceContext::UserList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ UserList

Initialize the UserList

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String) (defaults to: nil)

    The SID of the Service the User resource is associated with.


22
23
24
25
26
27
28
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 22

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

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

Instance Method Details

#create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance

Create the UserInstance

Parameters:

  • identity (String) (defaults to: nil)

    The `identity` value that uniquely identifies the new resource's User within the Service. This value is often a username or email address. See the Identity documentation for more info.

  • role_sid (String) (defaults to: :unset)

    The SID of the Role to assign to the new User.

  • attributes (String) (defaults to: :unset)

    A valid JSON string that contains application-specific data.

  • friendly_name (String) (defaults to: :unset)

    A descriptive string that you create to describe the new resource. This value is often used for display purposes.

  • x_twilio_webhook_enabled (user.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 47

def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({
      'Identity' => identity,
      'RoleSid' => role_sid,
      'Attributes' => attributes,
      'FriendlyName' => friendly_name,
  })
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

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

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

#eachObject

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


99
100
101
102
103
104
105
106
107
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 99

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

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of UserInstance


133
134
135
136
137
138
139
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 133

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

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

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


72
73
74
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 72

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


116
117
118
119
120
121
122
123
124
125
126
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 116

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)

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

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

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


87
88
89
90
91
92
93
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 87

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_sObject

Provide a user friendly representation


143
144
145
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 143

def to_s
  '#<Twilio.Chat.V2.UserList>'
end