Class: Twilio::REST::Messaging::V1::BrandRegistrationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Messaging::V1::BrandRegistrationInstance
- Defined in:
- lib/twilio-ruby/rest/messaging/v1/brand_registration.rb
Instance Method Summary collapse
-
#a2p_profile_bundle_sid ⇒ String
A2P Messaging Profile Bundle BundleSid.
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Brand Registration resource.
-
#brand_feedback ⇒ Array<BrandFeedback>
Feedback on how to improve brand score.
-
#brand_registration_otps ⇒ brand_registration_otps
Access the brand_registration_otps.
-
#brand_score ⇒ String
The secondary vetting score if it was done.
-
#brand_type ⇒ String
Type of brand.
-
#brand_vettings ⇒ brand_vettings
Access the brand_vettings.
-
#context ⇒ BrandRegistrationContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#customer_profile_bundle_sid ⇒ String
A2P Messaging Profile Bundle BundleSid.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#failure_reason ⇒ String
A reason why brand registration has failed.
-
#fetch ⇒ BrandRegistrationInstance
Fetch the BrandRegistrationInstance.
-
#government_entity ⇒ Boolean
Identified as a government entity.
- #identity_status ⇒ IdentityStatus
-
#initialize(version, payload, sid: nil) ⇒ BrandRegistrationInstance
constructor
Initialize the BrandRegistrationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
- #links ⇒ Hash
-
#mock ⇒ Boolean
A boolean that specifies whether brand should be a mock or not.
-
#russell_3000 ⇒ Boolean
Publicly traded company identified in the Russell 3000 Index.
-
#sid ⇒ String
The unique string to identify Brand Registration.
-
#skip_automatic_sec_vet ⇒ Boolean
A flag to disable automatic secondary vetting for brands which it would otherwise be done.
- #status ⇒ Status
-
#tax_exempt_status ⇒ String
Nonprofit organization tax-exempt status per section 501 of the U.S.
-
#tcr_id ⇒ String
Campaign Registry (TCR) Brand ID.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update ⇒ BrandRegistrationInstance
Update the BrandRegistrationInstance.
-
#url ⇒ String
The absolute URL of the Brand Registration resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ BrandRegistrationInstance
Initialize the BrandRegistrationInstance
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 286 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.
349 350 351 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 349 def a2p_profile_bundle_sid @properties['a2p_profile_bundle_sid'] end |
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Brand Registration resource.
337 338 339 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 337 def account_sid @properties['account_sid'] end |
#brand_feedback ⇒ Array<BrandFeedback>
Returns Feedback on how to improve brand score.
403 404 405 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 403 def brand_feedback @properties['brand_feedback'] end |
#brand_registration_otps ⇒ brand_registration_otps
Access the brand_registration_otps
468 469 470 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 468 def brand_registration_otps context.brand_registration_otps end |
#brand_score ⇒ String
Returns The secondary vetting score if it was done. Otherwise, it will be the brand score if it’s returned from TCR. It may be null if no score is available.
397 398 399 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 397 def brand_score @properties['brand_score'] end |
#brand_type ⇒ String
Returns Type of brand. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for the low volume, SOLE_PROPRIETOR campaign use case. There can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR brand. STANDARD is for all other campaign use cases. Multiple campaign use cases can be created per STANDARD brand.
367 368 369 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 367 def brand_type @properties['brand_type'] end |
#brand_vettings ⇒ brand_vettings
Access the brand_vettings
475 476 477 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 475 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
322 323 324 325 326 327 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 322 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.
343 344 345 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 343 def customer_profile_bundle_sid @properties['customer_profile_bundle_sid'] end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
355 356 357 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 355 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
361 362 363 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 361 def date_updated @properties['date_updated'] end |
#failure_reason ⇒ String
Returns A reason why brand registration has failed. Only applicable when status is FAILED.
385 386 387 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 385 def failure_reason @properties['failure_reason'] end |
#fetch ⇒ BrandRegistrationInstance
Fetch the BrandRegistrationInstance
452 453 454 455 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 452 def fetch context.fetch end |
#government_entity ⇒ Boolean
Returns Identified as a government entity.
421 422 423 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 421 def government_entity @properties['government_entity'] end |
#identity_status ⇒ IdentityStatus
409 410 411 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 409 def identity_status @properties['identity_status'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
488 489 490 491 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 488 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>" end |
#links ⇒ Hash
445 446 447 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 445 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.
439 440 441 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 439 def mock @properties['mock'] end |
#russell_3000 ⇒ Boolean
Returns Publicly traded company identified in the Russell 3000 Index.
415 416 417 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 415 def russell_3000 @properties['russell_3000'] end |
#sid ⇒ String
Returns The unique string to identify Brand Registration.
331 332 333 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 331 def sid @properties['sid'] end |
#skip_automatic_sec_vet ⇒ Boolean
Returns A flag to disable automatic secondary vetting for brands which it would otherwise be done.
433 434 435 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 433 def skip_automatic_sec_vet @properties['skip_automatic_sec_vet'] end |
#status ⇒ Status
373 374 375 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 373 def status @properties['status'] end |
#tax_exempt_status ⇒ String
Returns Nonprofit organization tax-exempt status per section 501 of the U.S. tax code.
427 428 429 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 427 def tax_exempt_status @properties['tax_exempt_status'] end |
#tcr_id ⇒ String
Returns Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration.
379 380 381 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 379 def tcr_id @properties['tcr_id'] end |
#to_s ⇒ Object
Provide a user friendly representation
481 482 483 484 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 481 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>" end |
#update ⇒ BrandRegistrationInstance
Update the BrandRegistrationInstance
460 461 462 463 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 460 def update context.update end |
#url ⇒ String
Returns The absolute URL of the Brand Registration resource.
391 392 393 |
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 391 def url @properties['url'] end |