Class: HubSpotSDK::Resources::Cms::Pages::SitePages::Revisions

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/cms/pages/site_pages/revisions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Revisions

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

Parameters:



133
134
135
 
# File 'lib/hubspot_sdk/resources/cms/pages/site_pages/revisions.rb', line 133

def initialize(client:)
  @client = client
end

Instance Method Details

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/hubspot_sdk/resources/cms/pages/site_pages/revisions.rb', line 22

def get_site_page_revision(revision_id, params)
  parsed, options =
    HubSpotSDK::Cms::Pages::SitePages::RevisionGetSitePageRevisionParams.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_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::Pages::SitePages::RevisionListSitePageRevisionsParams 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:



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/hubspot_sdk/resources/cms/pages/site_pages/revisions.rb', line 58

def list_site_page_revisions(object_id_, params = {})
  parsed, options =
    HubSpotSDK::Cms::Pages::SitePages::RevisionListSitePageRevisionsParams.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

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

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

Parameters:

Returns:

See Also:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/hubspot_sdk/resources/cms/pages/site_pages/revisions.rb', line 84

def restore_site_page_revision(revision_id, params)
  parsed, options =
    HubSpotSDK::Cms::Pages::SitePages::RevisionRestoreSitePageRevisionParams.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::PagesPage,
    options: options
  )
end

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

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

Parameters:

Returns:

See Also:



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

def restore_site_page_revision_to_draft(revision_id, params)
  parsed, options =
    HubSpotSDK::Cms::Pages::SitePages::RevisionRestoreSitePageRevisionToDraftParams.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::PagesPage,
    options: options
  )
end