Class: Sentdm::Models::ProfileDetail

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/profile_detail.rb

Defined Under Namespace

Classes: BillingContact, Brand

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(address: nil, email: nil, name: nil, phone: nil) ⇒ Object

Billing contact info returned in profile responses

Parameters:

  • address (String, nil) (defaults to: nil)
  • email (String, nil) (defaults to: nil)
  • name (String, nil) (defaults to: nil)
  • phone (String, nil) (defaults to: nil) 



# File 'lib/sentdm/models/profile_detail.rb', line 159

Instance Attribute Details

#allow_contact_sharing ⇒ Boolean?

Whether contacts are shared across profiles in the organization

Returns:

  • (Boolean, nil) 


16
 
# File 'lib/sentdm/models/profile_detail.rb', line 16

optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean

#allow_number_change_during_onboarding ⇒ Boolean?

Whether number changes are allowed during onboarding

Returns:

  • (Boolean, nil) 


22
 
# File 'lib/sentdm/models/profile_detail.rb', line 22

optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true

#allow_template_sharing ⇒ Boolean?

Whether templates are shared across profiles in the organization

Returns:

  • (Boolean, nil) 


28
 
# File 'lib/sentdm/models/profile_detail.rb', line 28

optional :allow_template_sharing, Sentdm::Internal::Type::Boolean

#billing_contact ⇒ Sentdm::Models::ProfileDetail::BillingContact?

Billing contact info returned in profile responses

Returns:



34
 
# File 'lib/sentdm/models/profile_detail.rb', line 34

optional :billing_contact, -> { Sentdm::ProfileDetail::BillingContact }, nil?: true

#billing_model ⇒ String?

Billing model: profile, organization, or profile_and_organization

Returns:

  • (String, nil) 


40
 
# File 'lib/sentdm/models/profile_detail.rb', line 40

optional :billing_model, String

#brand ⇒ Sentdm::Models::ProfileDetail::Brand?

Brand response with nested contact, business, and compliance sections — mirrors the request structure.

Returns:



47
 
# File 'lib/sentdm/models/profile_detail.rb', line 47

optional :brand, -> { Sentdm::ProfileDetail::Brand }, nil?: true

#created_at ⇒ Time?

When the profile was created

Returns:

  • (Time, nil) 


53
 
# File 'lib/sentdm/models/profile_detail.rb', line 53

optional :created_at, Time

#description ⇒ String?

Profile description

Returns:

  • (String, nil) 


59
 
# File 'lib/sentdm/models/profile_detail.rb', line 59

optional :description, String, nil?: true

#email ⇒ String?

Profile email (inherited from organization)

Returns:

  • (String, nil) 


65
 
# File 'lib/sentdm/models/profile_detail.rb', line 65

optional :email, String, nil?: true

#icon ⇒ String?

Profile icon URL

Returns:

  • (String, nil) 


71
 
# File 'lib/sentdm/models/profile_detail.rb', line 71

optional :icon, String, nil?: true

#id ⇒ String?

Profile unique identifier

Returns:

  • (String, nil) 


10
 
# File 'lib/sentdm/models/profile_detail.rb', line 10

optional :id, String

#inherit_contacts ⇒ Boolean?

Whether this profile inherits contacts from the organization

Returns:

  • (Boolean, nil) 


77
 
# File 'lib/sentdm/models/profile_detail.rb', line 77

optional :inherit_contacts, Sentdm::Internal::Type::Boolean

#inherit_tcr_brand ⇒ Boolean?

Whether this profile inherits TCR brand from the organization

Returns:

  • (Boolean, nil) 


83
 
# File 'lib/sentdm/models/profile_detail.rb', line 83

optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean

#inherit_tcr_campaign ⇒ Boolean?

Whether this profile inherits TCR campaign from the organization

Returns:

  • (Boolean, nil) 


89
 
# File 'lib/sentdm/models/profile_detail.rb', line 89

optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean

#inherit_templates ⇒ Boolean?

Whether this profile inherits templates from the organization

Returns:

  • (Boolean, nil) 


95
 
# File 'lib/sentdm/models/profile_detail.rb', line 95

optional :inherit_templates, Sentdm::Internal::Type::Boolean

#name ⇒ String?

Profile name

Returns:

  • (String, nil) 


101
 
# File 'lib/sentdm/models/profile_detail.rb', line 101

optional :name, String

#organization_id ⇒ String?

Parent organization ID

Returns:

  • (String, nil) 


107
 
# File 'lib/sentdm/models/profile_detail.rb', line 107

optional :organization_id, String, nil?: true

#sending_phone_number ⇒ String?

Direct SMS phone number

Returns:

  • (String, nil) 


113
 
# File 'lib/sentdm/models/profile_detail.rb', line 113

optional :sending_phone_number, String, nil?: true

#sending_phone_number_profile_id ⇒ String?

Reference to another profile for SMS/Telnyx configuration

Returns:

  • (String, nil) 


119
 
# File 'lib/sentdm/models/profile_detail.rb', line 119

optional :sending_phone_number_profile_id, String, nil?: true

#sending_whatsapp_number_profile_id ⇒ String?

Reference to another profile for WhatsApp configuration

Returns:

  • (String, nil) 


125
 
# File 'lib/sentdm/models/profile_detail.rb', line 125

optional :sending_whatsapp_number_profile_id, String, nil?: true

#short_name ⇒ String?

Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces only, with at least one letter.

Returns:

  • (String, nil) 


132
 
# File 'lib/sentdm/models/profile_detail.rb', line 132

optional :short_name, String, nil?: true

#status ⇒ String?

Profile setup status: incomplete, pending_review, approved, rejected

Returns:

  • (String, nil) 


138
 
# File 'lib/sentdm/models/profile_detail.rb', line 138

optional :status, String

#updated_at ⇒ Time?

When the profile was last updated

Returns:

  • (Time, nil) 


144
 
# File 'lib/sentdm/models/profile_detail.rb', line 144

optional :updated_at, Time, nil?: true

#waba_id ⇒ String?

WhatsApp Business Account ID associated with this profile. Present whether the WABA is inherited from the organization or configured directly.

Returns:

  • (String, nil) 


151
 
# File 'lib/sentdm/models/profile_detail.rb', line 151

optional :waba_id, String, nil?: true

#whatsapp_phone_number ⇒ String?

Direct WhatsApp phone number

Returns:

  • (String, nil) 


157
 
# File 'lib/sentdm/models/profile_detail.rb', line 157

optional :whatsapp_phone_number, String, nil?: true