Class: Twilio::REST::Studio::V2::FlowContext::FlowTestUserInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ FlowTestUserInstance

Initialize the FlowTestUserInstance

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 FlowTestUser resource.

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

    The SID of the Call resource to fetch.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 159

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'test_users' => payload['test_users'],
        'url' => payload['url'],
    }

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

Instance Method Details

#context ⇒ FlowTestUserContext

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

Returns:



178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 178

def context
    unless @instance_context
        @instance_context = FlowTestUserContext.new(@version , @params['sid'])
    end
    @instance_context
end

#fetch ⇒ FlowTestUserInstance

Fetch the FlowTestUserInstance

Returns:



206
207
208
209
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 206

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



233
234
235
236
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 233

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

#sid ⇒ String

Returns Unique identifier of the flow.

Returns:

  • (String) —

    Unique identifier of the flow.



187
188
189
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 187

def sid
    @properties['sid']
end

#test_users ⇒ Array<String>

Returns List of test user identities that can test draft versions of the flow.

Returns:

  • (Array<String>) —

    List of test user identities that can test draft versions of the flow.



193
194
195
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 193

def test_users
    @properties['test_users']
end

#to_s ⇒ Object

Provide a user friendly representation



226
227
228
229
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 226

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

#update(test_users: nil) ⇒ FlowTestUserInstance

Update the FlowTestUserInstance

Parameters:

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

    List of test user identities that can test draft versions of the flow.

Returns:



215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 215

def update(
    test_users: nil
)

    context.update(
        test_users: test_users, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



199
200
201
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_test_user.rb', line 199

def url
    @properties['url']
end