Class: HubSpotSDK::Resources::Cms::Domains

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/cms/domains.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Domains

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 Domains.

Parameters:



79
80
81
 
# File 'lib/hubspot_sdk/resources/cms/domains.rb', line 79

def initialize(client:)
  @client = client
end

Instance Method Details

#get(domain_id, request_options: {}) ⇒ HubSpotSDK::Models::Cms::Domain

Returns a single domains with the id specified.

Parameters:

Returns:

See Also:



67
68
69
70
71
72
73
74
 
# File 'lib/hubspot_sdk/resources/cms/domains.rb', line 67

def get(domain_id, params = {})
  @client.request(
    method: :get,
    path: ["cms/domains/2026-03/%1$s", domain_id],
    model: HubSpotSDK::Cms::Domain,
    options: params[:request_options]
  )
end

#list(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Cms::Domain>

Some parameter documentations has been truncated, see Models::Cms::DomainListParams for more details.

Parameters:

  • after (String) —

    The paging cursor token of the last successfully read resource will be returned

  • archived (Boolean) —

    Whether to return only results that have been archived.

  • created_after (Time)
  • created_at (Time)
  • created_before (Time)
  • limit (Integer) —

    The maximum number of results to display per page.

  • sort (Array<String>)
  • updated_after (Time)
  • updated_at (Time)
  • updated_before (Time)
  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/hubspot_sdk/resources/cms/domains.rb', line 37

def list(params = {})
  parsed, options = HubSpotSDK::Cms::DomainListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/domains/2026-03",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Cms::Domain,
    options: options
  )
end