Class: HubSpotSDK::Resources::Cms::Blogs::Settings

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/cms/blogs/settings.rb,
lib/hubspot_sdk/resources/cms/blogs/settings/multi_language.rb

Defined Under Namespace

Classes: MultiLanguage

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Settings

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

Parameters:



145
146
147
148
 
# File 'lib/hubspot_sdk/resources/cms/blogs/settings.rb', line 145

def initialize(client:)
  @client = client
  @multi_language = HubSpotSDK::Resources::Cms::Blogs::Settings::MultiLanguage.new(client: client)
end

Instance Attribute Details

#multi_language ⇒ HubSpotSDK::Resources::Cms::Blogs::Settings::MultiLanguage (readonly)

Returns:



9
10
11
 
# File 'lib/hubspot_sdk/resources/cms/blogs/settings.rb', line 9

def multi_language
  @multi_language
end

Instance Method Details

#get(blog_id, request_options: {}) ⇒ HubSpotSDK::Models::Cms::Blogs::Blog

Retrieve a specific blog by its ID.

Parameters:

Returns:

See Also:



74
75
76
77
78
79
80
81
 
# File 'lib/hubspot_sdk/resources/cms/blogs/settings.rb', line 74

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

#get_revision(revision_id, blog_id:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::Blogs::BlogVersion

Get a specific blog revision.

Parameters:

Returns:

See Also:



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/hubspot_sdk/resources/cms/blogs/settings.rb', line 94

def get_revision(revision_id, params)
  parsed, options = HubSpotSDK::Cms::Blogs::SettingGetRevisionParams.dump_request(params)
  blog_id =
    parsed.delete(:blog_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["cms/blog-settings/2026-03/settings/%1$s/revisions/%2$s", blog_id, revision_id],
    model: HubSpotSDK::Cms::Blogs::BlogVersion,
    options: 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::Blogs::Blog>

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

Get the list of blogs. Results can be limited and filtered by creation or updated date.

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:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/hubspot_sdk/resources/cms/blogs/settings.rb', line 44

def list(params = {})
  parsed, options = HubSpotSDK::Cms::Blogs::SettingListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/blog-settings/2026-03/settings",
    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::Blogs::Blog,
    options: options
  )
end

#list_revisions(blog_id, after: nil, before: nil, limit: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Cms::Blogs::VersionBlog>

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

Get the list of blog revisions. Results can be limited and filtered by creation or updated date.

Parameters:

  • blog_id (String)
  • after (String) —

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

  • before (String)
  • limit (Integer) —

    The maximum number of results to display per page.

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

Returns:

See Also:



129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/hubspot_sdk/resources/cms/blogs/settings.rb', line 129

def list_revisions(blog_id, params = {})
  parsed, options = HubSpotSDK::Cms::Blogs::SettingListRevisionsParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["cms/blog-settings/2026-03/settings/%1$s/revisions", blog_id],
    query: query,
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Cms::Blogs::VersionBlog,
    options: options
  )
end