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:



582
583
584
585
586
587
588
589
590
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 582

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_folders(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, property: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Models::Cms::PageGetLandingPageFoldersParams 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.

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

Returns:

  • (Object)

See Also:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 57

def get_landing_page_folders(params = {})
  parsed, options = HubSpotSDK::Cms::PageGetLandingPageFoldersParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/pages/2026-03/landing-pages/folders/cursor",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    model: HubSpotSDK::Internal::Type::Unknown,
    options: options
  )
end

#get_landing_page_folders_by_query(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, property: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Models::Cms::PageGetLandingPageFoldersByQueryParams 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.

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

Returns:

  • (Object)

See Also:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 109

def get_landing_page_folders_by_query(params = {})
  parsed, options = HubSpotSDK::Cms::PageGetLandingPageFoldersByQueryParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/pages/2026-03/landing-pages/folders/cursor/query",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    model: HubSpotSDK::Internal::Type::Unknown,
    options: options
  )
end

#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:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 140

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_landing_pages(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, property: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Models::Cms::PageGetLandingPagesParams 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.

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

Returns:

  • (Object)

See Also:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 186

def get_landing_pages(params = {})
  parsed, options = HubSpotSDK::Cms::PageGetLandingPagesParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/pages/2026-03/landing-pages/cursor",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    model: HubSpotSDK::Internal::Type::Unknown,
    options: options
  )
end

#get_landing_pages_by_query(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, property: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Models::Cms::PageGetLandingPagesByQueryParams 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.

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

Returns:

  • (Object)

See Also:



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 237

def get_landing_pages_by_query(params = {})
  parsed, options = HubSpotSDK::Cms::PageGetLandingPagesByQueryParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/pages/2026-03/landing-pages/cursor/query",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    model: HubSpotSDK::Internal::Type::Unknown,
    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:

Returns:

See Also:



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 267

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

#get_site_pages(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, property: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Models::Cms::PageGetSitePagesParams 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.

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

Returns:

  • (Object)

See Also:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 313

def get_site_pages(params = {})
  parsed, options = HubSpotSDK::Cms::PageGetSitePagesParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/pages/2026-03/site-pages/cursor",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    model: HubSpotSDK::Internal::Type::Unknown,
    options: options
  )
end

#get_site_pages_by_query(after: nil, archived: nil, created_after: nil, created_at: nil, created_before: nil, limit: nil, property: nil, sort: nil, updated_after: nil, updated_at: nil, updated_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Models::Cms::PageGetSitePagesByQueryParams 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.

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

Returns:

  • (Object)

See Also:



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 364

def get_site_pages_by_query(params = {})
  parsed, options = HubSpotSDK::Cms::PageGetSitePagesByQueryParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "cms/pages/2026-03/site-pages/cursor/query",
    query: query.transform_keys(
      created_after: "createdAfter",
      created_at: "createdAt",
      created_before: "createdBefore",
      updated_after: "updatedAfter",
      updated_at: "updatedAt",
      updated_before: "updatedBefore"
    ),
    model: HubSpotSDK::Internal::Type::Unknown,
    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:



403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 403

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:



436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 436

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:



459
460
461
462
463
464
465
466
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 459

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:



480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 480

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:



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 505

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:



535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 535

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:



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/hubspot_sdk/resources/cms/pages.rb', line 561

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