Class: Twilio::REST::Trusthub::V1::CustomerProfilesContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb,
lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_evaluations.rb,
lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb,
lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb

Defined Under Namespace

Classes: CustomerProfilesChannelEndpointAssignmentContext, CustomerProfilesChannelEndpointAssignmentInstance, CustomerProfilesChannelEndpointAssignmentList, CustomerProfilesChannelEndpointAssignmentPage, CustomerProfilesEntityAssignmentsContext, CustomerProfilesEntityAssignmentsInstance, CustomerProfilesEntityAssignmentsList, CustomerProfilesEntityAssignmentsPage, CustomerProfilesEvaluationsContext, CustomerProfilesEvaluationsInstance, CustomerProfilesEvaluationsList, CustomerProfilesEvaluationsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ CustomerProfilesContext

Initialize the CustomerProfilesContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    The unique string that we created to identify the Customer-Profile resource.


205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 205

def initialize(version, sid)
  super(version)

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

  # Dependents
  @customer_profiles_entity_assignments = nil
  @customer_profiles_evaluations = nil
  @customer_profiles_channel_endpoint_assignment = nil
end

Instance Method Details

#customer_profiles_channel_endpoint_assignment(sid = :unset) ⇒ CustomerProfilesChannelEndpointAssignmentList, CustomerProfilesChannelEndpointAssignmentContext

Access the customer_profiles_channel_endpoint_assignment

Returns:

Raises:

  • (ArgumentError)

304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 304

def customer_profiles_channel_endpoint_assignment(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return CustomerProfilesChannelEndpointAssignmentContext.new(@version, @solution[:sid], sid, )
  end

  unless @customer_profiles_channel_endpoint_assignment
    @customer_profiles_channel_endpoint_assignment = CustomerProfilesChannelEndpointAssignmentList.new(
        @version,
        customer_profile_sid: @solution[:sid],
    )
  end

  @customer_profiles_channel_endpoint_assignment
end

#customer_profiles_entity_assignments(sid = :unset) ⇒ CustomerProfilesEntityAssignmentsList, CustomerProfilesEntityAssignmentsContext

Access the customer_profiles_entity_assignments

Returns:

Raises:

  • (ArgumentError)

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 262

def customer_profiles_entity_assignments(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return CustomerProfilesEntityAssignmentsContext.new(@version, @solution[:sid], sid, )
  end

  unless @customer_profiles_entity_assignments
    @customer_profiles_entity_assignments = CustomerProfilesEntityAssignmentsList.new(
        @version,
        customer_profile_sid: @solution[:sid],
    )
  end

  @customer_profiles_entity_assignments
end

#customer_profiles_evaluations(sid = :unset) ⇒ CustomerProfilesEvaluationsList, CustomerProfilesEvaluationsContext

Access the customer_profiles_evaluations

Returns:

Raises:

  • (ArgumentError)

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 283

def customer_profiles_evaluations(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return CustomerProfilesEvaluationsContext.new(@version, @solution[:sid], sid, )
  end

  unless @customer_profiles_evaluations
    @customer_profiles_evaluations = CustomerProfilesEvaluationsList.new(
        @version,
        customer_profile_sid: @solution[:sid],
    )
  end

  @customer_profiles_evaluations
end

#deleteBoolean

Delete the CustomerProfilesInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


254
255
256
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 254

def delete
   @version.delete('DELETE', @uri)
end

#fetchCustomerProfilesInstance

Fetch the CustomerProfilesInstance

Returns:


221
222
223
224
225
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 221

def fetch
  payload = @version.fetch('GET', @uri)

  CustomerProfilesInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


330
331
332
333
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 330

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

#to_sObject

Provide a user friendly representation


323
324
325
326
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 323

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

#update(status: :unset, status_callback: :unset, friendly_name: :unset, email: :unset) ⇒ CustomerProfilesInstance

Update the CustomerProfilesInstance

Parameters:

  • status (customer_profiles.Status) (defaults to: :unset)

    The verification status of the Customer-Profile resource.

  • status_callback (String) (defaults to: :unset)

    The URL we call to inform your application of status changes.

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

    The string that you assigned to describe the resource.

  • email (String) (defaults to: :unset)

    The email address that will receive updates when the Customer-Profile resource changes status.

Returns:


238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 238

def update(status: :unset, status_callback: :unset, friendly_name: :unset, email: :unset)
  data = Twilio::Values.of({
      'Status' => status,
      'StatusCallback' => status_callback,
      'FriendlyName' => friendly_name,
      'Email' => email,
  })

  payload = @version.update('POST', @uri, data: data)

  CustomerProfilesInstance.new(@version, payload, sid: @solution[:sid], )
end