Class: Twilio::REST::Trusthub::V1::ComplianceRegistrationInquiriesInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, registration_id: nil) ⇒ ComplianceRegistrationInquiriesInstance

Initialize the ComplianceRegistrationInquiriesInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 270

def initialize(version, payload , registration_id: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'inquiry_id' => payload['inquiry_id'],
        'inquiry_session_token' => payload['inquiry_session_token'],
        'registration_id' => payload['registration_id'],
        'url' => payload['url'],
    }

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

Instance Method Details

#context ⇒ ComplianceRegistrationInquiriesContext

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

Returns:



290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 290

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

#inquiry_id ⇒ String

Returns The unique ID used to start an embedded compliance registration session.

Returns:

  • (String) —

    The unique ID used to start an embedded compliance registration session.



299
300
301
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 299

def inquiry_id
    @properties['inquiry_id']
end

#inquiry_session_token ⇒ String

Returns The session token used to start an embedded compliance registration session.

Returns:

  • (String) —

    The session token used to start an embedded compliance registration session.



305
306
307
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 305

def inquiry_session_token
    @properties['inquiry_session_token']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



346
347
348
349
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 346

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

#registration_id ⇒ String

Returns The RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing.

Returns:

  • (String) —

    The RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing.



311
312
313
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 311

def registration_id
    @properties['registration_id']
end

#to_s ⇒ Object

Provide a user friendly representation



339
340
341
342
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 339

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

#update(is_isv_embed: :unset, theme_set_id: :unset) ⇒ ComplianceRegistrationInquiriesInstance

Update the ComplianceRegistrationInquiriesInstance

Parameters:

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

    Indicates if the inquiry is being started from an ISV embedded component.

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

    Theme id for styling the inquiry form.

Returns:



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 326

def update(
    is_isv_embed: :unset, 
    theme_set_id: :unset
)

    context.update(
        is_isv_embed: is_isv_embed, 
        theme_set_id: theme_set_id, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



317
318
319
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 317

def url
    @properties['url']
end