Class: Twilio::REST::Intelligence::V2::ServiceContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this Service.



188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 188

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Services/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 200

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 212

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ServiceInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



290
291
292
293
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 290

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Intelligence.V2.ServiceContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



283
284
285
286
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 283

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Intelligence.V2.ServiceContext #{context}>"
end

#update(auto_transcribe: :unset, data_logging: :unset, friendly_name: :unset, unique_name: :unset, auto_redaction: :unset, media_redaction: :unset, webhook_url: :unset, webhook_http_method: :unset, encryption_credential_sid: :unset, if_match: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • auto_transcribe (Boolean) (defaults to: :unset) —

    Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.

  • data_logging (Boolean) (defaults to: :unset) —

    Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.

  • friendly_name (String) (defaults to: :unset) —

    A human readable description of this resource, up to 64 characters.

  • unique_name (String) (defaults to: :unset) —

    Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.

  • auto_redaction (Boolean) (defaults to: :unset) —

    Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.

  • media_redaction (Boolean) (defaults to: :unset) —

    Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.

  • webhook_url (String) (defaults to: :unset) —

    The URL Twilio will request when executing the Webhook.

  • webhook_http_method (HttpMethod) (defaults to: :unset)
  • encryption_credential_sid (String) (defaults to: :unset) —

    The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.

  • if_match (String) (defaults to: :unset) —

    The If-Match HTTP request header

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 241

def update(
    auto_transcribe: :unset, 
    data_logging: :unset, 
    friendly_name: :unset, 
    unique_name: :unset, 
    auto_redaction: :unset, 
    media_redaction: :unset, 
    webhook_url: :unset, 
    webhook_http_method: :unset, 
    encryption_credential_sid: :unset, 
    if_match: :unset
)

    data = Twilio::Values.of({
        'AutoTranscribe' => auto_transcribe,
        'DataLogging' => data_logging,
        'FriendlyName' => friendly_name,
        'UniqueName' => unique_name,
        'AutoRedaction' => auto_redaction,
        'MediaRedaction' => media_redaction,
        'WebhookUrl' => webhook_url,
        'WebhookHttpMethod' => webhook_http_method,
        'EncryptionCredentialSid' => encryption_credential_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ServiceInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end