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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/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

  • sid (String) (defaults to: nil)

    Unique identifier of the flow.


121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 121

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

Instance Method Details

#contextFlowTestUserContext

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

Returns:


140
141
142
143
144
145
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 140

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

#fetchFlowTestUserInstance

Fetch the FlowTestUserInstance

Returns:


168
169
170
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 168

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


190
191
192
193
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 190

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

#sidString

Returns Unique identifier of the flow.

Returns:

  • (String)

    Unique identifier of the flow.


149
150
151
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 149

def sid
  @properties['sid']
end

#test_usersArray[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.


155
156
157
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 155

def test_users
  @properties['test_users']
end

#to_sObject

Provide a user friendly representation


183
184
185
186
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 183

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:


177
178
179
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 177

def update(test_users: nil)
  context.update(test_users: test_users, )
end

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.


161
162
163
# File 'lib/twilio-ruby/rest/studio/v2/flow/test_user.rb', line 161

def url
  @properties['url']
end