Class: HubSpotSDK::Resources::CommunicationPreferences::Definitions

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/communication_preferences/definitions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Definitions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Definitions.

Parameters:



36
37
38
 
# File 'lib/hubspot_sdk/resources/communication_preferences/definitions.rb', line 36

def initialize(client:)
  @client = client
end

Instance Method Details

#list(business_unit_id: nil, include_translations: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsSubscriptionDefinition

Get a list of subscription status definitions from the account.

Parameters:

  • business_unit_id (Integer)
  • include_translations (Boolean)
  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/hubspot_sdk/resources/communication_preferences/definitions.rb', line 18

def list(params = {})
  parsed, options = HubSpotSDK::CommunicationPreferences::DefinitionListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "communication-preferences/2026-03/definitions",
    query: query.transform_keys(
      business_unit_id: "businessUnitId",
      include_translations: "includeTranslations"
    ),
    model: HubSpotSDK::CommunicationPreferences::ActionResponseWithResultsSubscriptionDefinition,
    options: options
  )
end