Class: HubSpotSDK::Resources::Cms::Pages

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/cms/pages.rb,
lib/hubspot_sdk/resources/cms/pages/batch.rb,
lib/hubspot_sdk/resources/cms/pages/folders.rb,
lib/hubspot_sdk/resources/cms/pages/a_b_tests.rb,
lib/hubspot_sdk/resources/cms/pages/landing_pages.rb,
lib/hubspot_sdk/resources/cms/pages/website_pages.rb,
lib/hubspot_sdk/resources/cms/pages/multi_language.rb

Defined Under Namespace

Classes: ABTests, Batch, Folders, LandingPages, MultiLanguage, WebsitePages

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Pages

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

Parameters:



277
278
279
280
281
282
283
284
285
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 277

def initialize(client:)
  @client = client
  @a_b_tests = HubSpotSDK::Resources::Cms::Pages::ABTests.new(client: client)
  @batch = HubSpotSDK::Resources::Cms::Pages::Batch.new(client: client)
  @folders = HubSpotSDK::Resources::Cms::Pages::Folders.new(client: client)
  @landing_pages = HubSpotSDK::Resources::Cms::Pages::LandingPages.new(client: client)
  @multi_language = HubSpotSDK::Resources::Cms::Pages::MultiLanguage.new(client: client)
  @website_pages = HubSpotSDK::Resources::Cms::Pages::WebsitePages.new(client: client)
end

Instance Attribute Details

#a_b_tests ⇒ HubSpotSDK::Resources::Cms::Pages::ABTests (readonly)

Returns:



8
9
10
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 8

def a_b_tests
  @a_b_tests
end

#batch ⇒ HubSpotSDK::Resources::Cms::Pages::Batch (readonly)

Returns:



11
12
13
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 11

def batch
  @batch
end

#folders ⇒ HubSpotSDK::Resources::Cms::Pages::Folders (readonly)

Returns:



14
15
16
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 14

def folders
  @folders
end

#landing_pages ⇒ HubSpotSDK::Resources::Cms::Pages::LandingPages (readonly)

Returns:



17
18
19
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 17

def landing_pages
  @landing_pages
end

#multi_language ⇒ HubSpotSDK::Resources::Cms::Pages::MultiLanguage (readonly)

Returns:



20
21
22
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 20

def multi_language
  @multi_language
end

#website_pages ⇒ HubSpotSDK::Resources::Cms::Pages::WebsitePages (readonly)

Returns:



23
24
25
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 23

def website_pages
  @website_pages
end

Instance Method Details

#get_landing_page_revision(revision_id, object_id_:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageVersion

Retrieve a previous version of a landing page, specified by page ID and revision ID.

Parameters:

Returns:

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 37

def get_landing_page_revision(revision_id, params)
  parsed, options = HubSpotSDK::Cms::PageGetLandingPageRevisionParams.dump_request(params)
  object_id_ =
    parsed.delete(:object_id_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["cms/pages/2026-03/landing-pages/%1$s/revisions/%2$s", object_id_, revision_id],
    model: HubSpotSDK::Cms::PageVersion,
    options: options
  )
end

#get_site_page_revision(revision_id, object_id_:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageVersion

Retrieve a previous version of a website page by the revision ID.

Parameters:

  • revision_id (String) —

    The unique identifier of the specific revision to retrieve.

  • object_id_ (String) —

    The unique identifier of the site page.

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

Returns:

See Also:



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 64

def get_site_page_revision(revision_id, params)
  parsed, options = HubSpotSDK::Cms::PageGetSitePageRevisionParams.dump_request(params)
  object_id_ =
    parsed.delete(:object_id_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["cms/pages/2026-03/site-pages/%1$s/revisions/%2$s", object_id_, revision_id],
    model: HubSpotSDK::Cms::PageVersion,
    options: options
  )
end

#list_landing_page_revisions(object_id_, after: nil, before: nil, limit: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Cms::PageVersion>

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

Retrieve all the previous versions of a landing page, specified by page ID.

Parameters:

  • object_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:



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 98

def list_landing_page_revisions(object_id_, params = {})
  parsed, options = HubSpotSDK::Cms::PageListLandingPageRevisionsParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["cms/pages/2026-03/landing-pages/%1$s/revisions", object_id_],
    query: query,
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Cms::PageVersion,
    options: options
  )
end

#list_site_page_revisions(object_id_, after: nil, before: nil, limit: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Cms::PageVersion>

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

Retrieves all the previous versions of a website page, specified by page ID.

Parameters:

  • object_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:



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 131

def list_site_page_revisions(object_id_, params = {})
  parsed, options = HubSpotSDK::Cms::PageListSitePageRevisionsParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["cms/pages/2026-03/site-pages/%1$s/revisions", object_id_],
    query: query,
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Cms::PageVersion,
    options: options
  )
end

#reset_site_page_draft(object_id_, request_options: {}) ⇒ nil

Discards any edits and resets the draft to match the live version.

Parameters:

Returns:

  • (nil)

See Also:



154
155
156
157
158
159
160
161
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 154

def reset_site_page_draft(object_id_, params = {})
  @client.request(
    method: :post,
    path: ["cms/pages/2026-03/site-pages/%1$s/draft/reset", object_id_],
    model: NilClass,
    options: params[:request_options]
  )
end

#restore_landing_page_revision(revision_id, object_id_:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageData

Restores a previous version of a landing page, specified by page ID and revision ID.

Parameters:

Returns:

See Also:



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 175

def restore_landing_page_revision(revision_id, params)
  parsed, options = HubSpotSDK::Cms::PageRestoreLandingPageRevisionParams.dump_request(params)
  object_id_ =
    parsed.delete(:object_id_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["cms/pages/2026-03/landing-pages/%1$s/revisions/%2$s/restore", object_id_, revision_id],
    model: HubSpotSDK::Cms::PageData,
    options: options
  )
end

#restore_landing_page_revision_to_draft(revision_id, object_id_:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageData

Specify a previous version of a landing page to set as the page draft.

Parameters:

Returns:

See Also:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 200

def restore_landing_page_revision_to_draft(revision_id, params)
  parsed, options = HubSpotSDK::Cms::PageRestoreLandingPageRevisionToDraftParams.dump_request(params)
  object_id_ =
    parsed.delete(:object_id_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: [
      "cms/pages/2026-03/landing-pages/%1$s/revisions/%2$s/restore-to-draft",
      object_id_,
      revision_id
    ],
    model: HubSpotSDK::Cms::PageData,
    options: options
  )
end

#restore_site_page_revision(revision_id, object_id_:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageData

Restores a website page to a previous version, specified by page ID and version ID.

Parameters:

Returns:

See Also:



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 230

def restore_site_page_revision(revision_id, params)
  parsed, options = HubSpotSDK::Cms::PageRestoreSitePageRevisionParams.dump_request(params)
  object_id_ =
    parsed.delete(:object_id_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["cms/pages/2026-03/site-pages/%1$s/revisions/%2$s/restore", object_id_, revision_id],
    model: HubSpotSDK::Cms::PageData,
    options: options
  )
end

#restore_site_page_revision_to_draft(revision_id, object_id_:, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageData

Takes a specified version of a website page and sets it as the new draft version of the page.

Parameters:

Returns:

See Also:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 256

def restore_site_page_revision_to_draft(revision_id, params)
  parsed, options = HubSpotSDK::Cms::PageRestoreSitePageRevisionToDraftParams.dump_request(params)
  object_id_ =
    parsed.delete(:object_id_) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: [
      "cms/pages/2026-03/site-pages/%1$s/revisions/%2$s/restore-to-draft",
      object_id_,
      revision_id
    ],
    model: HubSpotSDK::Cms::PageData,
    options: options
  )
end