Class: HubSpotSDK::Models::CommunicationPreferences::PublicWideStatus

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb

Defined Under Namespace

Modules: Channel, Status, WideStatusType

Instance Attribute Summary collapse

Class Method 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(channel:, status:, subscriber_id_string:, timestamp:, wide_status_type:, business_unit_id: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::CommunicationPreferences::PublicWideStatus for more details.

Parameters:




# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 46

Instance Attribute Details

#business_unit_id ⇒ Integer?

The ID of the business unit associated with the status.

Returns:

  • (Integer, nil) 


44
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 44

optional :business_unit_id, Integer, api_name: :businessUnitId

#channel ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::PublicWideStatus::Channel

The type of communication channel, with ‘EMAIL’ as the only supported option.

Returns:



11
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 11

required :channel, enum: -> { HubSpotSDK::CommunicationPreferences::PublicWideStatus::Channel }

#status ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::PublicWideStatus::Status

The subscription status of the contact, which can be ‘SUBSCRIBED’, ‘UNSUBSCRIBED’, or ‘NOT_SPECIFIED’.

Returns:



18
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 18

required :status, enum: -> { HubSpotSDK::CommunicationPreferences::PublicWideStatus::Status }

#subscriber_id_string ⇒ String

The email address of the contact.

Returns:

  • (String) 


24
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 24

required :subscriber_id_string, String, api_name: :subscriberIdString

#timestamp ⇒ Time

The date and time when the status was recorded.

Returns:

  • (Time) 


30
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 30

required :timestamp, Time

#wide_status_type ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::PublicWideStatus::WideStatusType

The type of wide status, which can be ‘PORTAL_WIDE’ or ‘BUSINESS_UNIT_WIDE’.

Returns:



36
37
38
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 36

required :wide_status_type,
enum: -> { HubSpotSDK::CommunicationPreferences::PublicWideStatus::WideStatusType },
api_name: :wideStatusType

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/hubspot_sdk/models/communication_preferences/public_wide_status.rb', line 71