Class: Sentdm::Models::ProfileCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/sentdm/models/profile_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: WhatsappBusinessAccount

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Sentdm::Internal::Type::BaseModel

Instance Attribute Details

#allow_contact_sharing ⇒ Boolean?

Whether contacts are shared across profiles (default: false)

Returns:

  • (Boolean, nil) 


14
 
# File 'lib/sentdm/models/profile_create_params.rb', line 14

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

#allow_template_sharing ⇒ Boolean?

Whether templates are shared across profiles (default: false)

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/sentdm/models/profile_create_params.rb', line 20

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

#billing_contact ⇒ Sentdm::Models::BillingContactInfo?

Billing contact information for a profile. Required when billing_model is “profile” or “profile_and_organization”.

Returns:



27
 
# File 'lib/sentdm/models/profile_create_params.rb', line 27

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

#billing_model ⇒ String?

Billing model: profile, organization, or profile_and_organization (default: profile).

  • “organization”: the organization’s billing details are used; no profile-level billing info needed.

  • “profile”: the profile is billed independently; billing_contact is required.

  • “profile_and_organization”: the profile is billed first with the organization as fallback; billing_contact is required.

Returns:

  • (String, nil) 


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

optional :billing_model, String, nil?: true

#brand ⇒ Sentdm::Models::BrandsBrandData?

Brand and KYC data grouped into contact, business, and compliance sections

Returns:



46
 
# File 'lib/sentdm/models/profile_create_params.rb', line 46

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

#description ⇒ String?

Profile description (optional)

Returns:

  • (String, nil) 


52
 
# File 'lib/sentdm/models/profile_create_params.rb', line 52

optional :description, String, nil?: true

#icon ⇒ String?

Profile icon URL (optional)

Returns:

  • (String, nil) 


58
 
# File 'lib/sentdm/models/profile_create_params.rb', line 58

optional :icon, String, nil?: true

#idempotency_key ⇒ String?

Returns:

  • (String, nil) 


128
 
# File 'lib/sentdm/models/profile_create_params.rb', line 128

optional :idempotency_key, String

#inherit_contacts ⇒ Boolean?

Whether this profile inherits contacts from organization (default: true)

Returns:

  • (Boolean, nil) 


64
 
# File 'lib/sentdm/models/profile_create_params.rb', line 64

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

#inherit_tcr_brand ⇒ Boolean?

Whether this profile inherits TCR brand from organization (default: true)

Returns:

  • (Boolean, nil) 


70
 
# File 'lib/sentdm/models/profile_create_params.rb', line 70

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

#inherit_tcr_campaign ⇒ Boolean?

Whether this profile inherits TCR campaign from organization (default: true)

Returns:

  • (Boolean, nil) 


76
 
# File 'lib/sentdm/models/profile_create_params.rb', line 76

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

#inherit_templates ⇒ Boolean?

Whether this profile inherits templates from organization (default: true)

Returns:

  • (Boolean, nil) 


82
 
# File 'lib/sentdm/models/profile_create_params.rb', line 82

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

#name ⇒ String?

Profile name (required)

Returns:

  • (String, nil) 


88
 
# File 'lib/sentdm/models/profile_create_params.rb', line 88

optional :name, String

#payment_details ⇒ Sentdm::Models::PaymentDetails?

Payment card details for a profile. Accepted when billing_model is “profile” or “profile_and_organization”. These details are not stored on our servers and will be forwarded to the payment processor.

Returns:



96
 
# File 'lib/sentdm/models/profile_create_params.rb', line 96

optional :payment_details, -> { Sentdm::PaymentDetails }, nil?: true

#sandbox ⇒ Boolean?

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Returns:

  • (Boolean, nil) 


103
 
# File 'lib/sentdm/models/profile_create_params.rb', line 103

optional :sandbox, Sentdm::Internal::Type::Boolean

#short_name ⇒ String?

Profile short name/abbreviation (optional). Must be 3–11 characters, contain only letters, numbers, and spaces, and include at least one letter. Example: “SALES”, “Mkt 2”, “Support1”.

Returns:

  • (String, nil) 


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

optional :short_name, String, nil?: true

#whatsapp_business_account ⇒ Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount?

Direct WhatsApp Business Account credentials for a profile. Use this when the profile should have its own WhatsApp Business Account instead of inheriting from the organization. Credentials must be obtained from Meta Business Manager by creating a System User with whatsapp_business_messaging and whatsapp_business_management scopes.

Returns:



121
122
123
 
# File 'lib/sentdm/models/profile_create_params.rb', line 121

optional :whatsapp_business_account,
-> { Sentdm::ProfileCreateParams::WhatsappBusinessAccount },
nil?: true

#x_profile_id ⇒ String?

Returns:

  • (String, nil) 


133
 
# File 'lib/sentdm/models/profile_create_params.rb', line 133

optional :x_profile_id, String