Class: HubSpotSDK::Models::CommunicationPreferences::PublicStatusRequest

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

Defined Under Namespace

Modules: Channel, LegalBasis, StatusState

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_state:, subscriber_id_string:, subscription_id:, legal_basis: nil, legal_basis_explanation: nil) ⇒ Object

Parameters:




# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 47

Instance Attribute Details

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

The type of communication channel. Currently, only ‘EMAIL` is supported.

Returns:



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

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

#legal_basis ⇒ Symbol, ...

The legal basis for communication.

Returns:



37
38
39
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 37

optional :legal_basis,
enum: -> { HubSpotSDK::CommunicationPreferences::PublicStatusRequest::LegalBasis },
api_name: :legalBasis

#legal_basis_explanation ⇒ String?

The explanation for the legal basis.

Returns:

  • (String, nil) 


45
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 45

optional :legal_basis_explanation, String, api_name: :legalBasisExplanation

#status_state ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::PublicStatusRequest::StatusState

The status of the contact’s subscription.

Returns:



17
18
19
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 17

required :status_state,
enum: -> { HubSpotSDK::CommunicationPreferences::PublicStatusRequest::StatusState },
api_name: :statusState

#subscriber_id_string ⇒ String

The contact’s email address.

Returns:

  • (String) 


25
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 25

required :subscriber_id_string, String, api_name: :subscriberIdString

#subscription_id ⇒ Integer

The ID of the subscription to update.

Returns:

  • (Integer) 


31
 
# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 31

required :subscription_id, Integer, api_name: :subscriptionId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/hubspot_sdk/models/communication_preferences/public_status_request.rb', line 68