Class: Sentdm::Models::ProfileRetrieveResponse::Data

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Sentdm::Models::ProfileRetrieveResponse::Data

Defined in:

lib/sentdm/models/profile_retrieve_response.rb

Overview

See Also:

• #data

Defined Under Namespace

Classes: BillingContact, Brand

Instance Attribute Summary

• #allow_contact_sharing ⇒ Boolean^?

  Whether contacts are shared across profiles in the organization.

• #allow_number_change_during_onboarding ⇒ Boolean^?

  Whether number changes are allowed during onboarding.

• #allow_template_sharing ⇒ Boolean^?

  Whether templates are shared across profiles in the organization.

• #billing_contact ⇒ Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact^?

  Billing contact info returned in profile responses.

• #billing_model ⇒ String^?

  Billing model: profile, organization, or profile_and_organization.

• #brand ⇒ Sentdm::Models::ProfileRetrieveResponse::Data::Brand^?

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

• #created_at ⇒ Time^?

  When the profile was created.

• #description ⇒ String^?

  Profile description.

• #email ⇒ String^?

  Profile email (inherited from organization).

• #icon ⇒ String^?

  Profile icon URL.

• #id ⇒ String^?

  Profile unique identifier.

• #inherit_contacts ⇒ Boolean^?

  Whether this profile inherits contacts from the organization.

• #inherit_tcr_brand ⇒ Boolean^?

  Whether this profile inherits TCR brand from the organization.

• #inherit_tcr_campaign ⇒ Boolean^?

  Whether this profile inherits TCR campaign from the organization.

• #inherit_templates ⇒ Boolean^?

  Whether this profile inherits templates from the organization.

• #name ⇒ String^?

  Profile name.

• #organization_id ⇒ String^?

  Parent organization ID.

• #sending_phone_number ⇒ String^?

  Direct SMS phone number.

• #sending_phone_number_profile_id ⇒ String^?

  Reference to another profile for SMS/Telnyx configuration.

• #sending_whatsapp_number_profile_id ⇒ String^?

  Reference to another profile for WhatsApp configuration.

• #short_name ⇒ String^?

  Profile short name/abbreviation.

• #status ⇒ String^?

  Profile setup status: incomplete, pending_review, approved, rejected.

• #updated_at ⇒ Time^?

  When the profile was last updated.

• #waba_id ⇒ String^?

  WhatsApp Business Account ID associated with this profile.

• #whatsapp_phone_number ⇒ String^?

  Direct WhatsApp phone number.

Instance Method Summary

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

  Billing contact info returned in profile responses.

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_retrieve_response.rb', line 199

Instance Attribute Details

#allow_contact_sharing ⇒ Boolean^?

Whether contacts are shared across profiles in the organization

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 54

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

#allow_number_change_during_onboarding ⇒ Boolean^?

Whether number changes are allowed during onboarding

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 60

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)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 66

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

#billing_contact ⇒ Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact^?

Billing contact info returned in profile responses

Returns:

• (Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 72

optional :billing_contact,
-> { Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact },
nil?: true

#billing_model ⇒ String^?

Billing model: profile, organization, or profile_and_organization

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 80

optional :billing_model, String

#brand ⇒ Sentdm::Models::ProfileRetrieveResponse::Data::Brand^?

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

Returns:

• (Sentdm::Models::ProfileRetrieveResponse::Data::Brand, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 87

optional :brand, -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand }, nil?: true

#created_at ⇒ Time^?

When the profile was created

Returns:

• (Time, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 93

optional :created_at, Time

#description ⇒ String^?

Profile description

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 99

optional :description, String, nil?: true

#email ⇒ String^?

Profile email (inherited from organization)

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 105

optional :email, String, nil?: true

#icon ⇒ String^?

Profile icon URL

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 111

optional :icon, String, nil?: true

#id ⇒ String^?

Profile unique identifier

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 48

optional :id, String

#inherit_contacts ⇒ Boolean^?

Whether this profile inherits contacts from the organization

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 117

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

#inherit_tcr_brand ⇒ Boolean^?

Whether this profile inherits TCR brand from the organization

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 123

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

#inherit_tcr_campaign ⇒ Boolean^?

Whether this profile inherits TCR campaign from the organization

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 129

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

#inherit_templates ⇒ Boolean^?

Whether this profile inherits templates from the organization

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 135

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

#name ⇒ String^?

Profile name

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 141

optional :name, String

#organization_id ⇒ String^?

Parent organization ID

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 147

optional :organization_id, String, nil?: true

#sending_phone_number ⇒ String^?

Direct SMS phone number

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 153

optional :sending_phone_number, String, nil?: true

#sending_phone_number_profile_id ⇒ String^?

Reference to another profile for SMS/Telnyx configuration

Returns:

• (String, nil)

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

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)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 165

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)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 172

optional :short_name, String, nil?: true

#status ⇒ String^?

Profile setup status: incomplete, pending_review, approved, rejected

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 178

optional :status, String

#updated_at ⇒ Time^?

When the profile was last updated

Returns:

• (Time, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 184

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)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 191

optional :waba_id, String, nil?: true

#whatsapp_phone_number ⇒ String^?

Direct WhatsApp phone number

Returns:

• (String, nil)

# File 'lib/sentdm/models/profile_retrieve_response.rb', line 197

optional :whatsapp_phone_number, String, nil?: true