Class: HubSpotSDK::Models::CommunicationPreferences::PartialPublicStatusRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/communication_preferences/partial_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:, subscription_id:, legal_basis: nil, legal_basis_explanation: nil) ⇒ Object

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

Parameters:




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

Instance Attribute Details

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

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

Returns:



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

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

#legal_basis ⇒ Symbol, ...

The legal basis for communication, with options including ‘LEGITIMATE_INTEREST_PQL’, ‘LEGITIMATE_INTEREST_CLIENT’, ‘PERFORMANCE_OF_CONTRACT’, ‘CONSENT_WITH_NOTICE’, ‘NON_GDPR’, ‘PROCESS_AND_STORE’, and ‘LEGITIMATE_INTEREST_OTHER’.

Returns:



35
36
37
 
# File 'lib/hubspot_sdk/models/communication_preferences/partial_public_status_request.rb', line 35

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

#legal_basis_explanation ⇒ String?

An explanation for the legal basis used for communication.

Returns:

  • (String, nil) 


43
 
# File 'lib/hubspot_sdk/models/communication_preferences/partial_public_status_request.rb', line 43

optional :legal_basis_explanation, String, api_name: :legalBasisExplanation

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

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

Returns:



18
19
20
 
# File 'lib/hubspot_sdk/models/communication_preferences/partial_public_status_request.rb', line 18

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

#subscription_id ⇒ Integer

The unique identifier of the subscription to be updated.

Returns:

  • (Integer) 


26
 
# File 'lib/hubspot_sdk/models/communication_preferences/partial_public_status_request.rb', line 26

required :subscription_id, Integer, api_name: :subscriptionId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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