Class: Twilio::REST::FlexApi::V2::FlexUserInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v2/flex_user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, instance_sid: nil, flex_user_sid: nil) ⇒ FlexUserInstance

Initialize the FlexUserInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this FlexUser resource.

  • sid (String) —

    The SID of the Call resource to fetch.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 129

def initialize(version, payload , instance_sid: nil, flex_user_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'instance_sid' => payload['instance_sid'],
        'user_sid' => payload['user_sid'],
        'flex_user_sid' => payload['flex_user_sid'],
        'worker_sid' => payload['worker_sid'],
        'workspace_sid' => payload['workspace_sid'],
        'flex_team_sid' => payload['flex_team_sid'],
        'first_name' => payload['first_name'],
        'last_name' => payload['last_name'],
        'username' => payload['username'],
        'email' => payload['email'],
        'friendly_name' => payload['friendly_name'],
        'created_date' => Twilio.deserialize_iso8601_datetime(payload['created_date']),
        'updated_date' => Twilio.deserialize_iso8601_datetime(payload['updated_date']),
        'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'instance_sid' => instance_sid  || @properties['instance_sid']  ,'flex_user_sid' => flex_user_sid  || @properties['flex_user_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID of the account that created the resource.

Returns:

  • (String) —

    The unique SID of the account that created the resource.



170
171
172
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 170

def 
    @properties['account_sid']
end

#context ⇒ FlexUserContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 161

def context
    unless @instance_context
        @instance_context = FlexUserContext.new(@version , @params['instance_sid'], @params['flex_user_sid'])
    end
    @instance_context
end

#created_date ⇒ Time

Returns The date that this user was created, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this user was created, given in ISO 8601 format.



242
243
244
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 242

def created_date
    @properties['created_date']
end

#email ⇒ String

Returns Email of the User.

Returns:

  • (String) —

    Email of the User.



230
231
232
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 230

def email
    @properties['email']
end

#fetch ⇒ FlexUserInstance

Fetch the FlexUserInstance

Returns:



267
268
269
270
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 267

def fetch

    context.fetch
end

#first_name ⇒ String

Returns First name of the User.

Returns:

  • (String) —

    First name of the User.



212
213
214
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 212

def first_name
    @properties['first_name']
end

#flex_team_sid ⇒ String

Returns The unique SID identifier of the Flex Team.

Returns:

  • (String) —

    The unique SID identifier of the Flex Team.



206
207
208
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 206

def flex_team_sid
    @properties['flex_team_sid']
end

#flex_user_sid ⇒ String

Returns The unique SID identifier of the Flex User.

Returns:

  • (String) —

    The unique SID identifier of the Flex User.



188
189
190
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 188

def flex_user_sid
    @properties['flex_user_sid']
end

#friendly_name ⇒ String

Returns Friendly name of the User.

Returns:

  • (String) —

    Friendly name of the User.



236
237
238
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 236

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



281
282
283
284
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 281

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.FlexApi.V2.FlexUserInstance #{values}>"
end

#instance_sid ⇒ String

Returns The unique ID created by Twilio to identify a Flex instance.

Returns:

  • (String) —

    The unique ID created by Twilio to identify a Flex instance.



176
177
178
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 176

def instance_sid
    @properties['instance_sid']
end

#last_name ⇒ String

Returns Last name of the User.

Returns:

  • (String) —

    Last name of the User.



218
219
220
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 218

def last_name
    @properties['last_name']
end

#to_s ⇒ Object

Provide a user friendly representation



274
275
276
277
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 274

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.FlexApi.V2.FlexUserInstance #{values}>"
end

#updated_date ⇒ Time

Returns The date that this user was updated, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this user was updated, given in ISO 8601 format.



248
249
250
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 248

def updated_date
    @properties['updated_date']
end

#url ⇒ String

Returns:

  • (String) 


260
261
262
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 260

def url
    @properties['url']
end

#user_sid ⇒ String

Returns The unique SID identifier of the Twilio Unified User.

Returns:

  • (String) —

    The unique SID identifier of the Twilio Unified User.



182
183
184
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 182

def user_sid
    @properties['user_sid']
end

#username ⇒ String

Returns Username of the User.

Returns:

  • (String) —

    Username of the User.



224
225
226
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 224

def username
    @properties['username']
end

#version ⇒ String

Returns The current version of the user.

Returns:

  • (String) —

    The current version of the user.



254
255
256
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 254

def version
    @properties['version']
end

#worker_sid ⇒ String

Returns The unique SID identifier of the worker.

Returns:

  • (String) —

    The unique SID identifier of the worker.



194
195
196
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 194

def worker_sid
    @properties['worker_sid']
end

#workspace_sid ⇒ String

Returns The unique SID identifier of the workspace.

Returns:

  • (String) —

    The unique SID identifier of the workspace.



200
201
202
 
# File 'lib/twilio-ruby/rest/flex_api/v2/flex_user.rb', line 200

def workspace_sid
    @properties['workspace_sid']
end