Class: Twilio::REST::Messaging::V1::BrandRegistrationInstance

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ BrandRegistrationInstance

Initialize the BrandRegistrationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The SID of the Brand Registration resource to fetch.



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
279
280
281
282
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 252

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'customer_profile_bundle_sid' => payload['customer_profile_bundle_sid'],
      'a2p_profile_bundle_sid' => payload['a2p_profile_bundle_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'brand_type' => payload['brand_type'],
      'status' => payload['status'],
      'tcr_id' => payload['tcr_id'],
      'failure_reason' => payload['failure_reason'],
      'url' => payload['url'],
      'brand_score' => payload['brand_score'] == nil ? payload['brand_score'] : payload['brand_score'].to_i,
      'brand_feedback' => payload['brand_feedback'],
      'identity_status' => payload['identity_status'],
      'russell_3000' => payload['russell_3000'],
      'government_entity' => payload['government_entity'],
      'tax_exempt_status' => payload['tax_exempt_status'],
      'skip_automatic_sec_vet' => payload['skip_automatic_sec_vet'],
      'mock' => payload['mock'],
      'links' => payload['links'],
  }

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

Instance Method Details

#a2p_profile_bundle_sid ⇒ String

Returns A2P Messaging Profile Bundle BundleSid.

Returns:

  • (String) —

    A2P Messaging Profile Bundle BundleSid



315
316
317
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 315

def a2p_profile_bundle_sid
  @properties['a2p_profile_bundle_sid']
end

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



303
304
305
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 303

def 
  @properties['account_sid']
end

#brand_feedback ⇒ Array[brand_registration.BrandFeedback]

Returns Brand feedback.

Returns:

  • (Array[brand_registration.BrandFeedback]) —

    Brand feedback



369
370
371
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 369

def brand_feedback
  @properties['brand_feedback']
end

#brand_score ⇒ String

Returns Brand score.

Returns:

  • (String) —

    Brand score



363
364
365
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 363

def brand_score
  @properties['brand_score']
end

#brand_type ⇒ String

Returns Type of brand. One of: “STANDARD”, “STARTER”.

Returns:

  • (String) —

    Type of brand. One of: “STANDARD”, “STARTER”.



333
334
335
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 333

def brand_type
  @properties['brand_type']
end

#brand_vettings ⇒ brand_vettings

Access the brand_vettings

Returns:



432
433
434
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 432

def brand_vettings
  context.brand_vettings
end

#context ⇒ BrandRegistrationContext

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

Returns:



288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 288

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

#customer_profile_bundle_sid ⇒ String

Returns A2P Messaging Profile Bundle BundleSid.

Returns:

  • (String) —

    A2P Messaging Profile Bundle BundleSid



309
310
311
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 309

def customer_profile_bundle_sid
  @properties['customer_profile_bundle_sid']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



321
322
323
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 321

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



327
328
329
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 327

def date_updated
  @properties['date_updated']
end

#failure_reason ⇒ String

Returns A reason why brand registration has failed.

Returns:

  • (String) —

    A reason why brand registration has failed



351
352
353
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 351

def failure_reason
  @properties['failure_reason']
end

#fetch ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstance

Returns:



418
419
420
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 418

def fetch
  context.fetch
end

#government_entity ⇒ Boolean

Returns Government Entity.

Returns:

  • (Boolean) —

    Government Entity



387
388
389
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 387

def government_entity
  @properties['government_entity']
end

#identity_status ⇒ brand_registration.IdentityStatus

Returns Identity Status.

Returns:

  • (brand_registration.IdentityStatus) —

    Identity Status



375
376
377
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 375

def identity_status
  @properties['identity_status']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



445
446
447
448
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 445

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



411
412
413
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 411

def links
  @properties['links']
end

#mock ⇒ Boolean

Returns A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.

Returns:

  • (Boolean) —

    A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.



405
406
407
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 405

def mock
  @properties['mock']
end

#russell_3000 ⇒ Boolean

Returns Russell 3000.

Returns:

  • (Boolean) —

    Russell 3000



381
382
383
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 381

def russell_3000
  @properties['russell_3000']
end

#sid ⇒ String

Returns A2P BrandRegistration Sid.

Returns:

  • (String) —

    A2P BrandRegistration Sid



297
298
299
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 297

def sid
  @properties['sid']
end

#skip_automatic_sec_vet ⇒ Boolean

Returns Skip Automatic Secondary Vetting.

Returns:

  • (Boolean) —

    Skip Automatic Secondary Vetting



399
400
401
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 399

def skip_automatic_sec_vet
  @properties['skip_automatic_sec_vet']
end

#status ⇒ brand_registration.Status

Returns Brand Registration status.

Returns:

  • (brand_registration.Status) —

    Brand Registration status.



339
340
341
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 339

def status
  @properties['status']
end

#tax_exempt_status ⇒ String

Returns Tax Exempt Status.

Returns:

  • (String) —

    Tax Exempt Status



393
394
395
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 393

def tax_exempt_status
  @properties['tax_exempt_status']
end

#tcr_id ⇒ String

Returns Campaign Registry (TCR) Brand ID.

Returns:

  • (String) —

    Campaign Registry (TCR) Brand ID



345
346
347
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 345

def tcr_id
  @properties['tcr_id']
end

#to_s ⇒ Object

Provide a user friendly representation



438
439
440
441
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 438

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

#update ⇒ BrandRegistrationInstance

Update the BrandRegistrationInstance

Returns:



425
426
427
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 425

def update
  context.update
end

#url ⇒ String

Returns The absolute URL of the Brand Registration.

Returns:

  • (String) —

    The absolute URL of the Brand Registration



357
358
359
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 357

def url
  @properties['url']
end