docs/classes/management.SDK.ThemesClient.html
creategetDefaultgetdeleteupdate
new ThemesClient(options: BaseClientOptions): ThemesClient
create(
request: CreateBrandingThemeRequestContent,
requestOptions?: ThemesClient.RequestOptions,
): HttpResponsePromise<CreateBrandingThemeResponseContent>
Create branding theme.
OptionalrequestOptions: ThemesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.themes.create({ borders: { button_border_radius: 1.1, button_border_weight: 1.1, buttons_style: "pill", input_border_radius: 1.1, input_border_weight: 1.1, inputs_style: "pill", show_widget_shadow: true, widget_border_weight: 1.1, widget_corner_radius: 1.1 }, colors: { body_text: "body_text", error: "error", header: "header", icons: "icons", input_background: "input_background", input_border: "input_border", input_filled_text: "input_filled_text", input_labels_placeholders: "input_labels_placeholders", links_focused_components: "links_focused_components", primary_button: "primary_button", primary_button_label: "primary_button_label", secondary_button_border: "secondary_button_border", secondary_button_label: "secondary_button_label", success: "success", widget_background: "widget_background", widget_border: "widget_border" }, fonts: { body_text: { bold: true, size: 1.1 }, buttons_text: { bold: true, size: 1.1 }, font_url: "font_url", input_labels: { bold: true, size: 1.1 }, links: { bold: true, size: 1.1 }, links_style: "normal", reference_text_size: 1.1, subtitle: { bold: true, size: 1.1 }, title: { bold: true, size: 1.1 } }, page_background: { background_color: "background_color", background_image_url: "background_image_url", page_layout: "center" }, widget: { header_text_alignment: "center", logo_height: 1.1, logo_position: "center", logo_url: "logo_url", social_buttons_layout: "bottom" } })Copy
getDefault(
requestOptions?: ThemesClient.RequestOptions,
): HttpResponsePromise<GetBrandingDefaultThemeResponseContent>
Retrieve default branding theme.
OptionalrequestOptions: ThemesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.themes.getDefault()Copy
get(
themeId: string,
requestOptions?: ThemesClient.RequestOptions,
): HttpResponsePromise<GetBrandingThemeResponseContent>
Retrieve branding theme.
The ID of the theme
OptionalrequestOptions: ThemesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.themes.get("themeId")Copy
delete(
themeId: string,
requestOptions?: ThemesClient.RequestOptions,
): HttpResponsePromise<void>
Delete branding theme.
The ID of the theme
OptionalrequestOptions: ThemesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.themes.delete("themeId")Copy
update(
themeId: string,
request: UpdateBrandingThemeRequestContent,
requestOptions?: ThemesClient.RequestOptions,
): HttpResponsePromise<UpdateBrandingThemeResponseContent>
Update branding theme.
The ID of the theme
OptionalrequestOptions: ThemesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.themes.update("themeId", { borders: { button_border_radius: 1.1, button_border_weight: 1.1, buttons_style: "pill", input_border_radius: 1.1, input_border_weight: 1.1, inputs_style: "pill", show_widget_shadow: true, widget_border_weight: 1.1, widget_corner_radius: 1.1 }, colors: { body_text: "body_text", error: "error", header: "header", icons: "icons", input_background: "input_background", input_border: "input_border", input_filled_text: "input_filled_text", input_labels_placeholders: "input_labels_placeholders", links_focused_components: "links_focused_components", primary_button: "primary_button", primary_button_label: "primary_button_label", secondary_button_border: "secondary_button_border", secondary_button_label: "secondary_button_label", success: "success", widget_background: "widget_background", widget_border: "widget_border" }, fonts: { body_text: { bold: true, size: 1.1 }, buttons_text: { bold: true, size: 1.1 }, font_url: "font_url", input_labels: { bold: true, size: 1.1 }, links: { bold: true, size: 1.1 }, links_style: "normal", reference_text_size: 1.1, subtitle: { bold: true, size: 1.1 }, title: { bold: true, size: 1.1 } }, page_background: { background_color: "background_color", background_image_url: "background_image_url", page_layout: "center" }, widget: { header_text_alignment: "center", logo_height: 1.1, logo_position: "center", logo_url: "logo_url", social_buttons_layout: "bottom" } })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods creategetDefaultgetdeleteupdate Properties _options