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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

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

  • assistant_sid (String) (defaults to: nil)

    The unique ID of the parent Assistant.

  • task_sid (String) (defaults to: nil)

    The unique ID of the Task associated with this Field.


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

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'].to_i,
      'fields_count' => payload['fields_count'].to_i,
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'assistant_sid' => assistant_sid, 'task_sid' => 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.


165
166
167
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 165

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the parent Assistant.

Returns:

  • (String)

    The unique ID of the parent Assistant.


171
172
173
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 171

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:


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

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:


202
203
204
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 202

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.


189
190
191
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 189

def fields_count
  @properties['fields_count']
end

#inspectObject

Provide a detailed, user friendly representation


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

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.


183
184
185
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 183

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.


177
178
179
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 177

def task_sid
  @properties['task_sid']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url


195
196
197
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/task_statistics.rb', line 195

def url
  @properties['url']
end