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

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ MultiLanguage

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

Parameters:



145
146
147
 
# File 'lib/hubspot_sdk/resources/cms/pages/multi_language.rb', line 145

def initialize(client:)
  @client = client
end

Instance Method Details

#attach_to_lang_group(id:, language:, primary_id:, primary_language: nil, request_options: {}) ⇒ StringIO

Attach a site page to a multi-language group.

Parameters:

Returns:

  • (StringIO)

See Also:



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

def attach_to_lang_group(params)
  parsed, options = HubSpotSDK::Cms::Pages::MultiLanguageAttachToLangGroupParams.dump_request(params)
  @client.request(
    method: :post,
    path: "cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group",
    headers: {"content-type" => "*/*", "accept" => "*/*"},
    body: parsed,
    model: StringIO,
    options: options
  )
end

#create_language_variation(id:, language: nil, primary_language: nil, request_options: {}) ⇒ HubSpotSDK::Models::Cms::PageData

Create a new language variation from an existing website page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source website page](/api-reference/latest/cms/pages/website-pages/drafts/get-website-page-draft).

Parameters:

  • id (String) —

    ID of content to clone.

  • language (String) —

    Target language of new variant.

  • primary_language (String) —

    Language of primary content to clone.

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

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/hubspot_sdk/resources/cms/pages/multi_language.rb', line 55

def create_language_variation(params)
  parsed, options = HubSpotSDK::Cms::Pages::MultiLanguageCreateLanguageVariationParams.dump_request(params)
  @client.request(
    method: :post,
    path: "cms/pages/2026-03/site-pages/multi-language/create-language-variation",
    headers: {"content-type" => "*/*"},
    body: parsed,
    model: HubSpotSDK::Cms::PageData,
    options: options
  )
end

#detach_from_lang_group(id:, request_options: {}) ⇒ StringIO

Detach a website page from a multi-language group.

Parameters:

  • id (String) —

    ID of the object to remove from a multi-language group.

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

Returns:

  • (StringIO)

See Also:



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/hubspot_sdk/resources/cms/pages/multi_language.rb', line 78

def detach_from_lang_group(params)
  parsed, options = HubSpotSDK::Cms::Pages::MultiLanguageDetachFromLangGroupParams.dump_request(params)
  @client.request(
    method: :post,
    path: "cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group",
    headers: {"content-type" => "*/*", "accept" => "*/*"},
    body: parsed,
    model: StringIO,
    options: options
  )
end

#set_new_lang_primary(id:, request_options: {}) ⇒ nil

Set a site page as the primary language of a multi-language group.

Parameters:

  • id (String) —

    ID of object to set as primary in multi-language group.

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

Returns:

  • (nil)

See Also:



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/hubspot_sdk/resources/cms/pages/multi_language.rb', line 101

def set_new_lang_primary(params)
  parsed, options = HubSpotSDK::Cms::Pages::MultiLanguageSetNewLangPrimaryParams.dump_request(params)
  @client.request(
    method: :put,
    path: "cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary",
    headers: {"content-type" => "*/*"},
    body: parsed,
    model: NilClass,
    options: options
  )
end

#update_languages(languages:, primary_id:, request_options: {}) ⇒ StringIO

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

Explicitly set new languages for each site page in a multi-language group.

Parameters:

Returns:

  • (StringIO)

See Also:



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

def update_languages(params)
  parsed, options = HubSpotSDK::Cms::Pages::MultiLanguageUpdateLanguagesParams.dump_request(params)
  @client.request(
    method: :post,
    path: "cms/pages/2026-03/site-pages/multi-language/update-languages",
    headers: {"content-type" => "*/*", "accept" => "*/*"},
    body: parsed,
    model: StringIO,
    options: options
  )
end