Class: Twilio::REST::Preview::Understand::AssistantContext::TaskContext::TaskStatisticsInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_sid: nil, task_sid: nil) ⇒ TaskStatisticsInstance

Initialize the TaskStatisticsInstance

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

  • sid (String)

    The SID of the Call resource to fetch.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 131

def initialize(version, payload , assistant_sid: nil, task_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'assistant_sid' => payload['assistant_sid'],
        'task_sid' => payload['task_sid'],
        'samples_count' => payload['samples_count'] == nil ? payload['samples_count'] : payload['samples_count'].to_i,
        'fields_count' => payload['fields_count'] == nil ? payload['fields_count'] : payload['fields_count'].to_i,
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sidString

Returns The unique ID of the Account that created this Field.

Returns:

  • (String)

    The unique ID of the Account that created this Field.



162
163
164
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 162

def 
    @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the parent Assistant.

Returns:

  • (String)

    The unique ID of the parent Assistant.



168
169
170
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 168

def assistant_sid
    @properties['assistant_sid']
end

#contextTaskStatisticsContext

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

Returns:



153
154
155
156
157
158
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 153

def context
    unless @instance_context
        @instance_context = TaskStatisticsContext.new(@version , @params['assistant_sid'], @params['task_sid'])
    end
    @instance_context
end

#fetchTaskStatisticsInstance

Fetch the TaskStatisticsInstance

Returns:



199
200
201
202
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 199

def fetch

    context.fetch
end

#fields_countString

Returns The total number of Fields associated with this Task.

Returns:

  • (String)

    The total number of Fields associated with this Task.



186
187
188
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 186

def fields_count
    @properties['fields_count']
end

#inspectObject

Provide a detailed, user friendly representation



213
214
215
216
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 213

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

#samples_countString

Returns The total number of Samples associated with this Task.

Returns:

  • (String)

    The total number of Samples associated with this Task.



180
181
182
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 180

def samples_count
    @properties['samples_count']
end

#task_sidString

Returns The unique ID of the Task associated with this Field.

Returns:

  • (String)

    The unique ID of the Task associated with this Field.



174
175
176
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 174

def task_sid
    @properties['task_sid']
end

#to_sObject

Provide a user friendly representation



206
207
208
209
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 206

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

#urlString

Returns:

  • (String)


192
193
194
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 192

def url
    @properties['url']
end