Class: Sentdm::Models::ContactUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Sentdm::Models::ContactUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/sentdm/models/contact_update_params.rb

Overview

See Also:

• Resources::Contacts#update

Instance Attribute Summary

• #channel_consent ⇒ Hash{Symbol=>String}^?

  Consent status by channel.

• #default_channel ⇒ String^?

  Default messaging channel: “sms” or “whatsapp”.

• #id ⇒ String
• #idempotency_key ⇒ String^?
• #opt_out ⇒ Boolean^?

  Whether the contact has opted out of messaging.

• #sandbox ⇒ Boolean^?

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

• #x_profile_id ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, channel_consent: nil, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ContactUpdateParams for more details.

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, 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(id:, channel_consent: nil, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::ContactUpdateParams for more details.

Parameters:

• id (String)
• channel_consent (Hash{Symbol=>String}, nil) (defaults to: nil) —

  Consent status by channel. Keys: “sms”, “whatsapp”. Values: “opted_in”, “opted_o

• default_channel (String, nil) (defaults to: nil) —

  Default messaging channel: “sms” or “whatsapp”

• opt_out (Boolean, nil) (defaults to: nil) —

  Whether the contact has opted out of messaging

• sandbox (Boolean) (defaults to: nil) —

  Sandbox flag - when true, the operation is simulated without side effects

• idempotency_key (String) (defaults to: nil)
• x_profile_id (String) (defaults to: nil)
• request_options (Sentdm::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/sentdm/models/contact_update_params.rb', line 55

Instance Attribute Details

#channel_consent ⇒ Hash{Symbol=>String}^?

Consent status by channel. Keys: “sms”, “whatsapp”. Values: “opted_in”, “opted_out”. All entries must have the same status — mixed values (e.g., sms: opted_out + whatsapp: opted_in) are rejected with 400. The provided status is applied to ALL channels regardless of which keys are specified, because consent is global across channels. When provided, takes precedence over the opt_out field.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/sentdm/models/contact_update_params.rb', line 24

optional :channel_consent, Sentdm::Internal::Type::HashOf[String], nil?: true

#default_channel ⇒ String^?

Default messaging channel: “sms” or “whatsapp”

Returns:

• (String, nil)

# File 'lib/sentdm/models/contact_update_params.rb', line 30

optional :default_channel, String, nil?: true

#id ⇒ String

Returns:

• (String)

# File 'lib/sentdm/models/contact_update_params.rb', line 13

required :id, String

#idempotency_key ⇒ String^?

Returns:

• (String, nil)

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

optional :idempotency_key, String

#opt_out ⇒ Boolean^?

Whether the contact has opted out of messaging

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/contact_update_params.rb', line 36

optional :opt_out, Sentdm::Internal::Type::Boolean, 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)

# File 'lib/sentdm/models/contact_update_params.rb', line 43

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

#x_profile_id ⇒ String^?

Returns:

• (String, nil)

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

optional :x_profile_id, String