CustomizationApi (Okta Java SDK 10.0.0 API)

java.lang.Object
- org.openapitools.client.api.CustomizationApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-10-28T09:54:00.189-05:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.CustomizationApi")
public class CustomizationApi
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

CustomizationApi()

CustomizationApi(ApiClient apiClient)

Constructors
Constructor and Description
`CustomizationApi()`
`CustomizationApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`createBrand(java.lang.Class<?> T, CreateBrandRequest createBrandRequest)` Create a Brand Creates new brand in your org
`Brand`	`createBrand(CreateBrandRequest createBrandRequest)` Create a Brand Creates new brand in your org
`PagedList`	`createBrandWithPaginationInfo(CreateBrandRequest createBrandRequest)` Create a Brand Creates new brand in your org
`<T> T`	`createEmailCustomization(java.lang.Class<?> T, java.lang.String brandId, java.lang.String templateName, EmailCustomization instance)` Create an Email Customization Creates a new email customization
`EmailCustomization`	`createEmailCustomization(java.lang.String brandId, java.lang.String templateName, EmailCustomization instance)` Create an Email Customization Creates a new email customization
`PagedList`	`createEmailCustomizationWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, EmailCustomization instance)` Create an Email Customization Creates a new email customization
`void`	`deleteAllCustomizations(java.lang.String brandId, java.lang.String templateName)` Delete all Email Customizations Deletes all customizations for an email template
`void`	`deleteBrand(java.lang.String brandId)` Delete a brand Deletes a brand by its unique identifier
`void`	`deleteBrandThemeBackgroundImage(java.lang.String brandId, java.lang.String themeId)` Delete the Background Image Deletes a Theme background image
`void`	`deleteBrandThemeFavicon(java.lang.String brandId, java.lang.String themeId)` Delete the Favicon Deletes a Theme favicon.
`void`	`deleteBrandThemeLogo(java.lang.String brandId, java.lang.String themeId)` Delete the Logo Deletes a Theme logo.
`void`	`deleteEmailCustomization(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId)` Delete an Email Customization Deletes an email customization by its unique identifier
`ApiClient`	`getApiClient()`
`Brand`	`getBrand(java.lang.String brandId)` Retrieve a Brand Retrieves a brand by `brandId`
`ThemeResponse`	`getBrandTheme(java.lang.String brandId, java.lang.String themeId)` Retrieve a Theme Retrieves a theme for a brand
`PagedList`	`getBrandThemeWithPaginationInfo(java.lang.String brandId, java.lang.String themeId)` Retrieve a Theme Retrieves a theme for a brand
`PagedList`	`getBrandWithPaginationInfo(java.lang.String brandId)` Retrieve a Brand Retrieves a brand by `brandId`
`EmailPreview`	`getCustomizationPreview(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId)` Retrieve a Preview of an Email Customization Generates a preview of an email customization.
`PagedList`	`getCustomizationPreviewWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId)` Retrieve a Preview of an Email Customization Generates a preview of an email customization.
`CustomizablePage`	`getCustomizedErrorPage(java.lang.String brandId)` Retrieve the Customized Error Page Retrieves the customized error page
`PagedList`	`getCustomizedErrorPageWithPaginationInfo(java.lang.String brandId)` Retrieve the Customized Error Page Retrieves the customized error page
`SignInPage`	`getCustomizedSignInPage(java.lang.String brandId)` Retrieve the Customized Sign-in Page Retrieves the customized sign-in page
`PagedList`	`getCustomizedSignInPageWithPaginationInfo(java.lang.String brandId)` Retrieve the Customized Sign-in Page Retrieves the customized sign-in page
`CustomizablePage`	`getDefaultErrorPage(java.lang.String brandId)` Retrieve the Default Error Page Retrieves the default error page
`PagedList`	`getDefaultErrorPageWithPaginationInfo(java.lang.String brandId)` Retrieve the Default Error Page Retrieves the default error page
`SignInPage`	`getDefaultSignInPage(java.lang.String brandId)` Retrieve the Default Sign-in Page Retrieves the default sign-in page
`PagedList`	`getDefaultSignInPageWithPaginationInfo(java.lang.String brandId)` Retrieve the Default Sign-in Page Retrieves the default sign-in page
`EmailCustomization`	`getEmailCustomization(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId)` Retrieve an Email Customization Retrieves an email customization by its unique identifier
`PagedList`	`getEmailCustomizationWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId)` Retrieve an Email Customization Retrieves an email customization by its unique identifier
`EmailDefaultContent`	`getEmailDefaultContent(java.lang.String brandId, java.lang.String templateName, java.lang.String language)` Retrieve an Email Template Default Content Retrieves an email template's default content
`PagedList`	`getEmailDefaultContentWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.lang.String language)` Retrieve an Email Template Default Content Retrieves an email template's default content
`EmailPreview`	`getEmailDefaultPreview(java.lang.String brandId, java.lang.String templateName, java.lang.String language)` Retrieve a Preview of the Email Template Default Content Generates a preview of an email template's default content.
`PagedList`	`getEmailDefaultPreviewWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.lang.String language)` Retrieve a Preview of the Email Template Default Content Generates a preview of an email template's default content.
`EmailSettings`	`getEmailSettings(java.lang.String brandId, java.lang.String templateName)` Retrieve the Email Template Settings Retrieves an email template's settings
`PagedList`	`getEmailSettingsWithPaginationInfo(java.lang.String brandId, java.lang.String templateName)` Retrieve the Email Template Settings Retrieves an email template's settings
`EmailTemplate`	`getEmailTemplate(java.lang.String brandId, java.lang.String templateName, java.util.List<java.lang.String> expand)` Retrieve an Email Template Retrieves the details of an email template by name
`PagedList`	`getEmailTemplateWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.util.List<java.lang.String> expand)` Retrieve an Email Template Retrieves the details of an email template by name
`PageRoot`	`getErrorPage(java.lang.String brandId, java.util.List<java.lang.String> expand)` Retrieve the Error Page Retrieves the error page
`PagedList`	`getErrorPageWithPaginationInfo(java.lang.String brandId, java.util.List<java.lang.String> expand)` Retrieve the Error Page Retrieves the error page
`CustomizablePage`	`getPreviewErrorPage(java.lang.String brandId)` Retrieve the Preview Error Page Preview Retrieves the preview error page
`PagedList`	`getPreviewErrorPageWithPaginationInfo(java.lang.String brandId)` Retrieve the Preview Error Page Preview Retrieves the preview error page
`SignInPage`	`getPreviewSignInPage(java.lang.String brandId)` Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page
`PagedList`	`getPreviewSignInPageWithPaginationInfo(java.lang.String brandId)` Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page
`PageRoot`	`getSignInPage(java.lang.String brandId, java.util.List<java.lang.String> expand)` Retrieve the Sign-in Page Retrieves the sign-in page
`PagedList`	`getSignInPageWithPaginationInfo(java.lang.String brandId, java.util.List<java.lang.String> expand)` Retrieve the Sign-in Page Retrieves the sign-in page
`HostedPage`	`getSignOutPageSettings(java.lang.String brandId)` Retrieve the Sign-out Page Settings Retrieves the sign-out page settings
`PagedList`	`getSignOutPageSettingsWithPaginationInfo(java.lang.String brandId)` Retrieve the Sign-out Page Settings Retrieves the sign-out page settings
`<T> T`	`linkBrandDomain(java.lang.Class<?> T, java.lang.String brandId, CreateBrandDomainRequest createBrandDomainRequest)` Link a Brand to a Domain Link a Brand to a Domain by `domainId`
`BrandDomain`	`linkBrandDomain(java.lang.String brandId, CreateBrandDomainRequest createBrandDomainRequest)` Link a Brand to a Domain Link a Brand to a Domain by `domainId`
`PagedList`	`linkBrandDomainWithPaginationInfo(java.lang.String brandId, CreateBrandDomainRequest createBrandDomainRequest)` Link a Brand to a Domain Link a Brand to a Domain by `domainId`
`java.util.List<java.lang.String>`	`listAllSignInWidgetVersions(java.lang.String brandId)` List all Sign-in Widget Versions Lists all sign-in widget versions
`PagedList`	`listAllSignInWidgetVersionsWithPaginationInfo(java.lang.String brandId)` List all Sign-in Widget Versions Lists all sign-in widget versions
`java.util.List<DomainResponse>`	`listBrandDomains(java.lang.String brandId)` List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
`PagedList`	`listBrandDomainsWithPaginationInfo(java.lang.String brandId)` List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
`java.util.List<Brand>`	`listBrands()` List all Brands Lists all the brands in your org
`PagedList`	`listBrandsWithPaginationInfo()` List all Brands Lists all the brands in your org
`java.util.List<ThemeResponse>`	`listBrandThemes(java.lang.String brandId)` List all Themes Lists all the themes in your brand
`PagedList`	`listBrandThemesWithPaginationInfo(java.lang.String brandId)` List all Themes Lists all the themes in your brand
`java.util.List<EmailCustomization>`	`listEmailCustomizations(java.lang.String brandId, java.lang.String templateName, java.lang.String after, java.lang.Integer limit)` List all Email Customizations Lists all customizations of an email template
`PagedList`	`listEmailCustomizationsWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.lang.String after, java.lang.Integer limit)` List all Email Customizations Lists all customizations of an email template
`java.util.List<EmailTemplate>`	`listEmailTemplates(java.lang.String brandId, java.lang.String after, java.lang.Integer limit, java.util.List<java.lang.String> expand)` List all Email Templates Lists all email templates
`PagedList`	`listEmailTemplatesWithPaginationInfo(java.lang.String brandId, java.lang.String after, java.lang.Integer limit, java.util.List<java.lang.String> expand)` List all Email Templates Lists all email templates
`<T> T`	`replaceBrand(java.lang.Class<?> T, java.lang.String brandId, BrandRequest brand)` Replace a Brand Replaces a brand by `brandId`
`Brand`	`replaceBrand(java.lang.String brandId, BrandRequest brand)` Replace a Brand Replaces a brand by `brandId`
`<T> T`	`replaceBrandTheme(java.lang.Class<?> T, java.lang.String brandId, java.lang.String themeId, Theme theme)` Replace a Theme Replaces a theme for a brand
`ThemeResponse`	`replaceBrandTheme(java.lang.String brandId, java.lang.String themeId, Theme theme)` Replace a Theme Replaces a theme for a brand
`PagedList`	`replaceBrandThemeWithPaginationInfo(java.lang.String brandId, java.lang.String themeId, Theme theme)` Replace a Theme Replaces a theme for a brand
`PagedList`	`replaceBrandWithPaginationInfo(java.lang.String brandId, BrandRequest brand)` Replace a Brand Replaces a brand by `brandId`
`<T> T`	`replaceCustomizedErrorPage(java.lang.Class<?> T, java.lang.String brandId, CustomizablePage customizablePage)` Replace the Customized Error Page Replaces the customized error page
`CustomizablePage`	`replaceCustomizedErrorPage(java.lang.String brandId, CustomizablePage customizablePage)` Replace the Customized Error Page Replaces the customized error page
`PagedList`	`replaceCustomizedErrorPageWithPaginationInfo(java.lang.String brandId, CustomizablePage customizablePage)` Replace the Customized Error Page Replaces the customized error page
`<T> T`	`replaceCustomizedSignInPage(java.lang.Class<?> T, java.lang.String brandId, SignInPage signInPage)` Replace the Customized Sign-in Page Replaces the customized sign-in page
`SignInPage`	`replaceCustomizedSignInPage(java.lang.String brandId, SignInPage signInPage)` Replace the Customized Sign-in Page Replaces the customized sign-in page
`PagedList`	`replaceCustomizedSignInPageWithPaginationInfo(java.lang.String brandId, SignInPage signInPage)` Replace the Customized Sign-in Page Replaces the customized sign-in page
`<T> T`	`replaceEmailCustomization(java.lang.Class<?> T, java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId, EmailCustomization instance)` Replace an Email Customization Replaces an existing email customization using the property values provided
`EmailCustomization`	`replaceEmailCustomization(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId, EmailCustomization instance)` Replace an Email Customization Replaces an existing email customization using the property values provided
`PagedList`	`replaceEmailCustomizationWithPaginationInfo(java.lang.String brandId, java.lang.String templateName, java.lang.String customizationId, EmailCustomization instance)` Replace an Email Customization Replaces an existing email customization using the property values provided
`void`	`replaceEmailSettings(java.lang.Class<?> T, java.lang.String brandId, java.lang.String templateName, EmailSettings emailSettings)` Replace the Email Template Settings Replaces an email template's settings
`void`	`replaceEmailSettings(java.lang.String brandId, java.lang.String templateName, EmailSettings emailSettings)` Replace the Email Template Settings Replaces an email template's settings
`<T> T`	`replacePreviewErrorPage(java.lang.Class<?> T, java.lang.String brandId, CustomizablePage customizablePage)` Replace the Preview Error Page Replace the preview error page
`CustomizablePage`	`replacePreviewErrorPage(java.lang.String brandId, CustomizablePage customizablePage)` Replace the Preview Error Page Replace the preview error page
`PagedList`	`replacePreviewErrorPageWithPaginationInfo(java.lang.String brandId, CustomizablePage customizablePage)` Replace the Preview Error Page Replace the preview error page
`<T> T`	`replacePreviewSignInPage(java.lang.Class<?> T, java.lang.String brandId, SignInPage signInPage)` Replace the Preview Sign-in Page Replace the preview sign-in page
`SignInPage`	`replacePreviewSignInPage(java.lang.String brandId, SignInPage signInPage)` Replace the Preview Sign-in Page Replace the preview sign-in page
`PagedList`	`replacePreviewSignInPageWithPaginationInfo(java.lang.String brandId, SignInPage signInPage)` Replace the Preview Sign-in Page Replace the preview sign-in page
`<T> T`	`replaceSignOutPageSettings(java.lang.Class<?> T, java.lang.String brandId, HostedPage hostedPage)` Replace the Sign-out Page Settings Replaces the sign-out page settings
`HostedPage`	`replaceSignOutPageSettings(java.lang.String brandId, HostedPage hostedPage)` Replace the Sign-out Page Settings Replaces the sign-out page settings
`PagedList`	`replaceSignOutPageSettingsWithPaginationInfo(java.lang.String brandId, HostedPage hostedPage)` Replace the Sign-out Page Settings Replaces the sign-out page settings
`void`	`resetCustomizedErrorPage(java.lang.String brandId)` Reset the Customized Error Page Resets the customized error page
`void`	`resetCustomizedSignInPage(java.lang.String brandId)` Reset the Customized Sign-in Page Reset the customized sign-in page
`void`	`resetPreviewErrorPage(java.lang.String brandId)` Reset the Preview Error Page Reset the preview error page
`void`	`resetPreviewSignInPage(java.lang.String brandId)` Reset the Preview Sign-in Page Reset the preview sign-in page
`void`	`sendTestEmail(java.lang.String brandId, java.lang.String templateName, java.lang.String language)` Send a Test Email Sends a test email to the current user’s primary and secondary email addresses.
`void`	`setApiClient(ApiClient apiClient)`
`void`	`unlinkBrandDomain(java.lang.String brandId, java.lang.String domainId)` Unlink a Brand from a Domain Unlink brand and domain by its unique identifier
`ImageUploadResponse`	`uploadBrandThemeBackgroundImage(java.lang.String brandId, java.lang.String themeId, java.io.File _file)` Upload the Background Image Updates the background image for your Theme
`PagedList`	`uploadBrandThemeBackgroundImageWithPaginationInfo(java.lang.String brandId, java.lang.String themeId, java.io.File _file)` Upload the Background Image Updates the background image for your Theme
`ImageUploadResponse`	`uploadBrandThemeFavicon(java.lang.String brandId, java.lang.String themeId, java.io.File _file)` Upload the Favicon Updates the favicon for your theme
`PagedList`	`uploadBrandThemeFaviconWithPaginationInfo(java.lang.String brandId, java.lang.String themeId, java.io.File _file)` Upload the Favicon Updates the favicon for your theme
`ImageUploadResponse`	`uploadBrandThemeLogo(java.lang.String brandId, java.lang.String themeId, java.io.File _file)` Upload the Logo Updates the logo for your Theme
`PagedList`	`uploadBrandThemeLogoWithPaginationInfo(java.lang.String brandId, java.lang.String themeId, java.io.File _file)` Upload the Logo Updates the logo for your Theme

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CustomizationApi
```
public CustomizationApi()
```
  - CustomizationApi
```
@Autowired
public CustomizationApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - createBrand
```
public Brand createBrand(CreateBrandRequest createBrandRequest)
                  throws org.springframework.web.client.RestClientException
```
    Create a Brand Creates new brand in your org
    201 - Created
    400 - Bad Request
    403 - Forbidden
    429 - Too Many Requests
    
    Parameters:
    
    createBrandRequest - (optional)
    
    Returns:
    
    Brand
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - createBrand
```
public <T> T createBrand(java.lang.Class<?> T,
                         CreateBrandRequest createBrandRequest)
                  throws org.springframework.web.client.RestClientException
```
    Create a Brand Creates new brand in your org
    201 - Created
    400 - Bad Request
    403 - Forbidden
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    createBrandRequest - (optional)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - createBrandWithPaginationInfo
```
public PagedList createBrandWithPaginationInfo(CreateBrandRequest createBrandRequest)
                                        throws org.springframework.web.client.RestClientException
```
    Create a Brand Creates new brand in your org
    201 - Created
    400 - Bad Request
    403 - Forbidden
    429 - Too Many Requests
    
    Parameters:
    
    createBrandRequest - (optional)
    
    Returns:
    
    ResponseEntity<Brand>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - createEmailCustomization
```
public EmailCustomization createEmailCustomization(java.lang.String brandId,
                                                   java.lang.String templateName,
                                                   EmailCustomization instance)
                                            throws org.springframework.web.client.RestClientException
```
    Create an Email Customization Creates a new email customization
    201 - Successfully created the email customization.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Could not create the email customization because it conflicts with an existing email customization.
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    instance - (optional)
    
    Returns:
    
    EmailCustomization
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - createEmailCustomization
```
public <T> T createEmailCustomization(java.lang.Class<?> T,
                                      java.lang.String brandId,
                                      java.lang.String templateName,
                                      EmailCustomization instance)
                               throws org.springframework.web.client.RestClientException
```
    Create an Email Customization Creates a new email customization
    201 - Successfully created the email customization.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Could not create the email customization because it conflicts with an existing email customization.
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    instance - (optional)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - createEmailCustomizationWithPaginationInfo
```
public PagedList createEmailCustomizationWithPaginationInfo(java.lang.String brandId,
                                                            java.lang.String templateName,
                                                            EmailCustomization instance)
                                                     throws org.springframework.web.client.RestClientException
```
    Create an Email Customization Creates a new email customization
    201 - Successfully created the email customization.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Could not create the email customization because it conflicts with an existing email customization.
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    instance - (optional)
    
    Returns:
    
    ResponseEntity<EmailCustomization>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - deleteAllCustomizations
```
public void deleteAllCustomizations(java.lang.String brandId,
                                    java.lang.String templateName)
                             throws org.springframework.web.client.RestClientException
```
    Delete all Email Customizations Deletes all customizations for an email template
    204 - Successfully deleted all customizations for the email template.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - deleteBrand
```
public void deleteBrand(java.lang.String brandId)
                 throws org.springframework.web.client.RestClientException
```
    Delete a brand Deletes a brand by its unique identifier
    204 - Successfully deleted the brand.
    403 - Forbidden
    404 - Not Found
    409 - Conflict
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - deleteBrandThemeBackgroundImage
```
public void deleteBrandThemeBackgroundImage(java.lang.String brandId,
                                            java.lang.String themeId)
                                     throws org.springframework.web.client.RestClientException
```
    Delete the Background Image Deletes a Theme background image
    204 - No Content
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - deleteBrandThemeFavicon
```
public void deleteBrandThemeFavicon(java.lang.String brandId,
                                    java.lang.String themeId)
                             throws org.springframework.web.client.RestClientException
```
    Delete the Favicon Deletes a Theme favicon. The theme will use the default Okta favicon.
    204 - No Content
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - deleteBrandThemeLogo
```
public void deleteBrandThemeLogo(java.lang.String brandId,
                                 java.lang.String themeId)
                          throws org.springframework.web.client.RestClientException
```
    Delete the Logo Deletes a Theme logo. The theme will use the default Okta logo.
    204 - No Content
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - deleteEmailCustomization
```
public void deleteEmailCustomization(java.lang.String brandId,
                                     java.lang.String templateName,
                                     java.lang.String customizationId)
                              throws org.springframework.web.client.RestClientException
```
    Delete an Email Customization Deletes an email customization by its unique identifier
    204 - Successfully deleted the email customization.
    403 - Forbidden
    404 - Not Found
    409 - Could not delete the email customization deleted because it is the default email customization.
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getBrand
```
public Brand getBrand(java.lang.String brandId)
               throws org.springframework.web.client.RestClientException
```
    Retrieve a Brand Retrieves a brand by `brandId`
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    Brand
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getBrandWithPaginationInfo
```
public PagedList getBrandWithPaginationInfo(java.lang.String brandId)
                                     throws org.springframework.web.client.RestClientException
```
    Retrieve a Brand Retrieves a brand by `brandId`
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<Brand>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getBrandTheme
```
public ThemeResponse getBrandTheme(java.lang.String brandId,
                                   java.lang.String themeId)
                            throws org.springframework.web.client.RestClientException
```
    Retrieve a Theme Retrieves a theme for a brand
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    Returns:
    
    ThemeResponse
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getBrandThemeWithPaginationInfo
```
public PagedList getBrandThemeWithPaginationInfo(java.lang.String brandId,
                                                 java.lang.String themeId)
                                          throws org.springframework.web.client.RestClientException
```
    Retrieve a Theme Retrieves a theme for a brand
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    Returns:
    
    ResponseEntity<ThemeResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getCustomizationPreview
```
public EmailPreview getCustomizationPreview(java.lang.String brandId,
                                            java.lang.String templateName,
                                            java.lang.String customizationId)
                                     throws org.springframework.web.client.RestClientException
```
    Retrieve a Preview of an Email Customization Generates a preview of an email customization. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
    200 - Successfully generated a preview of the email customization.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    Returns:
    
    EmailPreview
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getCustomizationPreviewWithPaginationInfo
```
public PagedList getCustomizationPreviewWithPaginationInfo(java.lang.String brandId,
                                                           java.lang.String templateName,
                                                           java.lang.String customizationId)
                                                    throws org.springframework.web.client.RestClientException
```
    Retrieve a Preview of an Email Customization Generates a preview of an email customization. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
    200 - Successfully generated a preview of the email customization.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    Returns:
    
    ResponseEntity<EmailPreview>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getCustomizedErrorPage
```
public CustomizablePage getCustomizedErrorPage(java.lang.String brandId)
                                        throws org.springframework.web.client.RestClientException
```
    Retrieve the Customized Error Page Retrieves the customized error page
    200 - Successfully retrieved the customized error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    CustomizablePage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getCustomizedErrorPageWithPaginationInfo
```
public PagedList getCustomizedErrorPageWithPaginationInfo(java.lang.String brandId)
                                                   throws org.springframework.web.client.RestClientException
```
    Retrieve the Customized Error Page Retrieves the customized error page
    200 - Successfully retrieved the customized error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<CustomizablePage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getCustomizedSignInPage
```
public SignInPage getCustomizedSignInPage(java.lang.String brandId)
                                   throws org.springframework.web.client.RestClientException
```
    Retrieve the Customized Sign-in Page Retrieves the customized sign-in page
    200 - Successfully retrieved the customized sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    SignInPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getCustomizedSignInPageWithPaginationInfo
```
public PagedList getCustomizedSignInPageWithPaginationInfo(java.lang.String brandId)
                                                    throws org.springframework.web.client.RestClientException
```
    Retrieve the Customized Sign-in Page Retrieves the customized sign-in page
    200 - Successfully retrieved the customized sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<SignInPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getDefaultErrorPage
```
public CustomizablePage getDefaultErrorPage(java.lang.String brandId)
                                     throws org.springframework.web.client.RestClientException
```
    Retrieve the Default Error Page Retrieves the default error page
    200 - Successfully retrieved the default error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    CustomizablePage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getDefaultErrorPageWithPaginationInfo
```
public PagedList getDefaultErrorPageWithPaginationInfo(java.lang.String brandId)
                                                throws org.springframework.web.client.RestClientException
```
    Retrieve the Default Error Page Retrieves the default error page
    200 - Successfully retrieved the default error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<CustomizablePage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getDefaultSignInPage
```
public SignInPage getDefaultSignInPage(java.lang.String brandId)
                                throws org.springframework.web.client.RestClientException
```
    Retrieve the Default Sign-in Page Retrieves the default sign-in page
    200 - Successfully retrieved the default sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    SignInPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getDefaultSignInPageWithPaginationInfo
```
public PagedList getDefaultSignInPageWithPaginationInfo(java.lang.String brandId)
                                                 throws org.springframework.web.client.RestClientException
```
    Retrieve the Default Sign-in Page Retrieves the default sign-in page
    200 - Successfully retrieved the default sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<SignInPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailCustomization
```
public EmailCustomization getEmailCustomization(java.lang.String brandId,
                                                java.lang.String templateName,
                                                java.lang.String customizationId)
                                         throws org.springframework.web.client.RestClientException
```
    Retrieve an Email Customization Retrieves an email customization by its unique identifier
    200 - Successfully retrieved the email customization.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    Returns:
    
    EmailCustomization
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailCustomizationWithPaginationInfo
```
public PagedList getEmailCustomizationWithPaginationInfo(java.lang.String brandId,
                                                         java.lang.String templateName,
                                                         java.lang.String customizationId)
                                                  throws org.springframework.web.client.RestClientException
```
    Retrieve an Email Customization Retrieves an email customization by its unique identifier
    200 - Successfully retrieved the email customization.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    Returns:
    
    ResponseEntity<EmailCustomization>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailDefaultContent
```
public EmailDefaultContent getEmailDefaultContent(java.lang.String brandId,
                                                  java.lang.String templateName,
                                                  java.lang.String language)
                                           throws org.springframework.web.client.RestClientException
```
    Retrieve an Email Template Default Content Retrieves an email template's default content
    200 - Successfully retrieved the email template's default content.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
    
    Returns:
    
    EmailDefaultContent
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailDefaultContentWithPaginationInfo
```
public PagedList getEmailDefaultContentWithPaginationInfo(java.lang.String brandId,
                                                          java.lang.String templateName,
                                                          java.lang.String language)
                                                   throws org.springframework.web.client.RestClientException
```
    Retrieve an Email Template Default Content Retrieves an email template's default content
    200 - Successfully retrieved the email template's default content.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
    
    Returns:
    
    ResponseEntity<EmailDefaultContent>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailDefaultPreview
```
public EmailPreview getEmailDefaultPreview(java.lang.String brandId,
                                           java.lang.String templateName,
                                           java.lang.String language)
                                    throws org.springframework.web.client.RestClientException
```
    Retrieve a Preview of the Email Template Default Content Generates a preview of an email template's default content. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
    200 - Successfully generated a preview of the email template's default content.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
    
    Returns:
    
    EmailPreview
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailDefaultPreviewWithPaginationInfo
```
public PagedList getEmailDefaultPreviewWithPaginationInfo(java.lang.String brandId,
                                                          java.lang.String templateName,
                                                          java.lang.String language)
                                                   throws org.springframework.web.client.RestClientException
```
    Retrieve a Preview of the Email Template Default Content Generates a preview of an email template's default content. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
    200 - Successfully generated a preview of the email template's default content.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
    
    Returns:
    
    ResponseEntity<EmailPreview>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailSettings
```
public EmailSettings getEmailSettings(java.lang.String brandId,
                                      java.lang.String templateName)
                               throws org.springframework.web.client.RestClientException
```
    Retrieve the Email Template Settings Retrieves an email template's settings
    200 - Successfully retrieved the email template's settings.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    Returns:
    
    EmailSettings
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailSettingsWithPaginationInfo
```
public PagedList getEmailSettingsWithPaginationInfo(java.lang.String brandId,
                                                    java.lang.String templateName)
                                             throws org.springframework.web.client.RestClientException
```
    Retrieve the Email Template Settings Retrieves an email template's settings
    200 - Successfully retrieved the email template's settings.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    Returns:
    
    ResponseEntity<EmailSettings>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailTemplate
```
public EmailTemplate getEmailTemplate(java.lang.String brandId,
                                      java.lang.String templateName,
                                      java.util.List<java.lang.String> expand)
                               throws org.springframework.web.client.RestClientException
```
    Retrieve an Email Template Retrieves the details of an email template by name
    200 - Successfully retrieved the email template.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    EmailTemplate
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getEmailTemplateWithPaginationInfo
```
public PagedList getEmailTemplateWithPaginationInfo(java.lang.String brandId,
                                                    java.lang.String templateName,
                                                    java.util.List<java.lang.String> expand)
                                             throws org.springframework.web.client.RestClientException
```
    Retrieve an Email Template Retrieves the details of an email template by name
    200 - Successfully retrieved the email template.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    ResponseEntity<EmailTemplate>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getErrorPage
```
public PageRoot getErrorPage(java.lang.String brandId,
                             java.util.List<java.lang.String> expand)
                      throws org.springframework.web.client.RestClientException
```
    Retrieve the Error Page Retrieves the error page
    200 - Successfully retrieved the error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    PageRoot
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getErrorPageWithPaginationInfo
```
public PagedList getErrorPageWithPaginationInfo(java.lang.String brandId,
                                                java.util.List<java.lang.String> expand)
                                         throws org.springframework.web.client.RestClientException
```
    Retrieve the Error Page Retrieves the error page
    200 - Successfully retrieved the error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    ResponseEntity<PageRoot>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getPreviewErrorPage
```
public CustomizablePage getPreviewErrorPage(java.lang.String brandId)
                                     throws org.springframework.web.client.RestClientException
```
    Retrieve the Preview Error Page Preview Retrieves the preview error page
    200 - Successfully retrieved the preview error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    CustomizablePage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getPreviewErrorPageWithPaginationInfo
```
public PagedList getPreviewErrorPageWithPaginationInfo(java.lang.String brandId)
                                                throws org.springframework.web.client.RestClientException
```
    Retrieve the Preview Error Page Preview Retrieves the preview error page
    200 - Successfully retrieved the preview error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<CustomizablePage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getPreviewSignInPage
```
public SignInPage getPreviewSignInPage(java.lang.String brandId)
                                throws org.springframework.web.client.RestClientException
```
    Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page
    200 - Successfully retrieved the preview sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    SignInPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getPreviewSignInPageWithPaginationInfo
```
public PagedList getPreviewSignInPageWithPaginationInfo(java.lang.String brandId)
                                                 throws org.springframework.web.client.RestClientException
```
    Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page
    200 - Successfully retrieved the preview sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<SignInPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getSignInPage
```
public PageRoot getSignInPage(java.lang.String brandId,
                              java.util.List<java.lang.String> expand)
                       throws org.springframework.web.client.RestClientException
```
    Retrieve the Sign-in Page Retrieves the sign-in page
    200 - Successfully retrieved the sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    PageRoot
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getSignInPageWithPaginationInfo
```
public PagedList getSignInPageWithPaginationInfo(java.lang.String brandId,
                                                 java.util.List<java.lang.String> expand)
                                          throws org.springframework.web.client.RestClientException
```
    Retrieve the Sign-in Page Retrieves the sign-in page
    200 - Successfully retrieved the sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    ResponseEntity<PageRoot>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getSignOutPageSettings
```
public HostedPage getSignOutPageSettings(java.lang.String brandId)
                                  throws org.springframework.web.client.RestClientException
```
    Retrieve the Sign-out Page Settings Retrieves the sign-out page settings
    200 - Successfully retrieved the sign-out page settings.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    HostedPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - getSignOutPageSettingsWithPaginationInfo
```
public PagedList getSignOutPageSettingsWithPaginationInfo(java.lang.String brandId)
                                                   throws org.springframework.web.client.RestClientException
```
    Retrieve the Sign-out Page Settings Retrieves the sign-out page settings
    200 - Successfully retrieved the sign-out page settings.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<HostedPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - linkBrandDomain
```
public BrandDomain linkBrandDomain(java.lang.String brandId,
                                   CreateBrandDomainRequest createBrandDomainRequest)
                            throws org.springframework.web.client.RestClientException
```
    Link a Brand to a Domain Link a Brand to a Domain by `domainId`
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Conflict
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    createBrandDomainRequest - (optional)
    
    Returns:
    
    BrandDomain
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - linkBrandDomain
```
public <T> T linkBrandDomain(java.lang.Class<?> T,
                             java.lang.String brandId,
                             CreateBrandDomainRequest createBrandDomainRequest)
                      throws org.springframework.web.client.RestClientException
```
    Link a Brand to a Domain Link a Brand to a Domain by `domainId`
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Conflict
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    createBrandDomainRequest - (optional)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - linkBrandDomainWithPaginationInfo
```
public PagedList linkBrandDomainWithPaginationInfo(java.lang.String brandId,
                                                   CreateBrandDomainRequest createBrandDomainRequest)
                                            throws org.springframework.web.client.RestClientException
```
    Link a Brand to a Domain Link a Brand to a Domain by `domainId`
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Conflict
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    createBrandDomainRequest - (optional)
    
    Returns:
    
    ResponseEntity<BrandDomain>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listAllSignInWidgetVersions
```
public java.util.List<java.lang.String> listAllSignInWidgetVersions(java.lang.String brandId)
                                                             throws org.springframework.web.client.RestClientException
```
    List all Sign-in Widget Versions Lists all sign-in widget versions
    200 - Successfully listed the sign-in widget versions.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    List<String>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listAllSignInWidgetVersionsWithPaginationInfo
```
public PagedList listAllSignInWidgetVersionsWithPaginationInfo(java.lang.String brandId)
                                                        throws org.springframework.web.client.RestClientException
```
    List all Sign-in Widget Versions Lists all sign-in widget versions
    200 - Successfully listed the sign-in widget versions.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<List<String>>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listBrandDomains
```
public java.util.List<DomainResponse> listBrandDomains(java.lang.String brandId)
                                                throws org.springframework.web.client.RestClientException
```
    List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    List<DomainResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listBrandDomainsWithPaginationInfo
```
public PagedList listBrandDomainsWithPaginationInfo(java.lang.String brandId)
                                             throws org.springframework.web.client.RestClientException
```
    List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<List<DomainResponse>>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listBrandThemes
```
public java.util.List<ThemeResponse> listBrandThemes(java.lang.String brandId)
                                              throws org.springframework.web.client.RestClientException
```
    List all Themes Lists all the themes in your brand
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    List<ThemeResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listBrandThemesWithPaginationInfo
```
public PagedList listBrandThemesWithPaginationInfo(java.lang.String brandId)
                                            throws org.springframework.web.client.RestClientException
```
    List all Themes Lists all the themes in your brand
    200 - OK
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Returns:
    
    ResponseEntity<List<ThemeResponse>>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listBrands
```
public java.util.List<Brand> listBrands()
                                 throws org.springframework.web.client.RestClientException
```
    List all Brands Lists all the brands in your org
    200 - OK
    403 - Forbidden
    429 - Too Many Requests
    
    Returns:
    
    List<Brand>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listBrandsWithPaginationInfo
```
public PagedList listBrandsWithPaginationInfo()
                                       throws org.springframework.web.client.RestClientException
```
    List all Brands Lists all the brands in your org
    200 - OK
    403 - Forbidden
    429 - Too Many Requests
    
    Returns:
    
    ResponseEntity<List<Brand>>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listEmailCustomizations
```
public java.util.List<EmailCustomization> listEmailCustomizations(java.lang.String brandId,
                                                                  java.lang.String templateName,
                                                                  java.lang.String after,
                                                                  java.lang.Integer limit)
                                                           throws org.springframework.web.client.RestClientException
```
    List all Email Customizations Lists all customizations of an email template
    200 - Successfully retrieved all email customizations for the specified email template.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
    
    limit - A limit on the number of objects to return. (optional, default to 20)
    
    Returns:
    
    List<EmailCustomization>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listEmailCustomizationsWithPaginationInfo
```
public PagedList listEmailCustomizationsWithPaginationInfo(java.lang.String brandId,
                                                           java.lang.String templateName,
                                                           java.lang.String after,
                                                           java.lang.Integer limit)
                                                    throws org.springframework.web.client.RestClientException
```
    List all Email Customizations Lists all customizations of an email template
    200 - Successfully retrieved all email customizations for the specified email template.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
    
    limit - A limit on the number of objects to return. (optional, default to 20)
    
    Returns:
    
    ResponseEntity<List<EmailCustomization>>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listEmailTemplates
```
public java.util.List<EmailTemplate> listEmailTemplates(java.lang.String brandId,
                                                        java.lang.String after,
                                                        java.lang.Integer limit,
                                                        java.util.List<java.lang.String> expand)
                                                 throws org.springframework.web.client.RestClientException
```
    List all Email Templates Lists all email templates
    200 - Successfully returned the list of email templates.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
    
    limit - A limit on the number of objects to return. (optional, default to 20)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    List<EmailTemplate>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - listEmailTemplatesWithPaginationInfo
```
public PagedList listEmailTemplatesWithPaginationInfo(java.lang.String brandId,
                                                      java.lang.String after,
                                                      java.lang.Integer limit,
                                                      java.util.List<java.lang.String> expand)
                                               throws org.springframework.web.client.RestClientException
```
    List all Email Templates Lists all email templates
    200 - Successfully returned the list of email templates.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
    
    limit - A limit on the number of objects to return. (optional, default to 20)
    
    expand - Specifies additional metadata to be included in the response. (optional)
    
    Returns:
    
    ResponseEntity<List<EmailTemplate>>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceBrand
```
public Brand replaceBrand(java.lang.String brandId,
                          BrandRequest brand)
                   throws org.springframework.web.client.RestClientException
```
    Replace a Brand Replaces a brand by `brandId`
    200 - OK
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    brand - (required)
    
    Returns:
    
    Brand
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceBrand
```
public <T> T replaceBrand(java.lang.Class<?> T,
                          java.lang.String brandId,
                          BrandRequest brand)
                   throws org.springframework.web.client.RestClientException
```
    Replace a Brand Replaces a brand by `brandId`
    200 - OK
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    brand - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceBrandWithPaginationInfo
```
public PagedList replaceBrandWithPaginationInfo(java.lang.String brandId,
                                                BrandRequest brand)
                                         throws org.springframework.web.client.RestClientException
```
    Replace a Brand Replaces a brand by `brandId`
    200 - OK
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    brand - (required)
    
    Returns:
    
    ResponseEntity<Brand>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceBrandTheme
```
public ThemeResponse replaceBrandTheme(java.lang.String brandId,
                                       java.lang.String themeId,
                                       Theme theme)
                                throws org.springframework.web.client.RestClientException
```
    Replace a Theme Replaces a theme for a brand
    200 - OK
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    theme - (required)
    
    Returns:
    
    ThemeResponse
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceBrandTheme
```
public <T> T replaceBrandTheme(java.lang.Class<?> T,
                               java.lang.String brandId,
                               java.lang.String themeId,
                               Theme theme)
                        throws org.springframework.web.client.RestClientException
```
    Replace a Theme Replaces a theme for a brand
    200 - OK
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    theme - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceBrandThemeWithPaginationInfo
```
public PagedList replaceBrandThemeWithPaginationInfo(java.lang.String brandId,
                                                     java.lang.String themeId,
                                                     Theme theme)
                                              throws org.springframework.web.client.RestClientException
```
    Replace a Theme Replaces a theme for a brand
    200 - OK
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    theme - (required)
    
    Returns:
    
    ResponseEntity<ThemeResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceCustomizedErrorPage
```
public CustomizablePage replaceCustomizedErrorPage(java.lang.String brandId,
                                                   CustomizablePage customizablePage)
                                            throws org.springframework.web.client.RestClientException
```
    Replace the Customized Error Page Replaces the customized error page
    200 - Successfully replaced the customized error page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    customizablePage - (required)
    
    Returns:
    
    CustomizablePage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceCustomizedErrorPage
```
public <T> T replaceCustomizedErrorPage(java.lang.Class<?> T,
                                        java.lang.String brandId,
                                        CustomizablePage customizablePage)
                                 throws org.springframework.web.client.RestClientException
```
    Replace the Customized Error Page Replaces the customized error page
    200 - Successfully replaced the customized error page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    customizablePage - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceCustomizedErrorPageWithPaginationInfo
```
public PagedList replaceCustomizedErrorPageWithPaginationInfo(java.lang.String brandId,
                                                              CustomizablePage customizablePage)
                                                       throws org.springframework.web.client.RestClientException
```
    Replace the Customized Error Page Replaces the customized error page
    200 - Successfully replaced the customized error page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    customizablePage - (required)
    
    Returns:
    
    ResponseEntity<CustomizablePage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceCustomizedSignInPage
```
public SignInPage replaceCustomizedSignInPage(java.lang.String brandId,
                                              SignInPage signInPage)
                                       throws org.springframework.web.client.RestClientException
```
    Replace the Customized Sign-in Page Replaces the customized sign-in page
    200 - Successfully replaced the customized sign-in page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    signInPage - (required)
    
    Returns:
    
    SignInPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceCustomizedSignInPage
```
public <T> T replaceCustomizedSignInPage(java.lang.Class<?> T,
                                         java.lang.String brandId,
                                         SignInPage signInPage)
                                  throws org.springframework.web.client.RestClientException
```
    Replace the Customized Sign-in Page Replaces the customized sign-in page
    200 - Successfully replaced the customized sign-in page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    signInPage - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceCustomizedSignInPageWithPaginationInfo
```
public PagedList replaceCustomizedSignInPageWithPaginationInfo(java.lang.String brandId,
                                                               SignInPage signInPage)
                                                        throws org.springframework.web.client.RestClientException
```
    Replace the Customized Sign-in Page Replaces the customized sign-in page
    200 - Successfully replaced the customized sign-in page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    signInPage - (required)
    
    Returns:
    
    ResponseEntity<SignInPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceEmailCustomization
```
public EmailCustomization replaceEmailCustomization(java.lang.String brandId,
                                                    java.lang.String templateName,
                                                    java.lang.String customizationId,
                                                    EmailCustomization instance)
                                             throws org.springframework.web.client.RestClientException
```
    Replace an Email Customization Replaces an existing email customization using the property values provided
    200 - Successfully updated the email customization.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Could not update the email customization because the update would cause a conflict with an existing email customization.
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    instance - Request (optional)
    
    Returns:
    
    EmailCustomization
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceEmailCustomization
```
public <T> T replaceEmailCustomization(java.lang.Class<?> T,
                                       java.lang.String brandId,
                                       java.lang.String templateName,
                                       java.lang.String customizationId,
                                       EmailCustomization instance)
                                throws org.springframework.web.client.RestClientException
```
    Replace an Email Customization Replaces an existing email customization using the property values provided
    200 - Successfully updated the email customization.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Could not update the email customization because the update would cause a conflict with an existing email customization.
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    instance - Request (optional)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceEmailCustomizationWithPaginationInfo
```
public PagedList replaceEmailCustomizationWithPaginationInfo(java.lang.String brandId,
                                                             java.lang.String templateName,
                                                             java.lang.String customizationId,
                                                             EmailCustomization instance)
                                                      throws org.springframework.web.client.RestClientException
```
    Replace an Email Customization Replaces an existing email customization using the property values provided
    200 - Successfully updated the email customization.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    409 - Could not update the email customization because the update would cause a conflict with an existing email customization.
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    customizationId - The ID of the email customization. (required)
    
    instance - Request (optional)
    
    Returns:
    
    ResponseEntity<EmailCustomization>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceEmailSettings
```
public void replaceEmailSettings(java.lang.String brandId,
                                 java.lang.String templateName,
                                 EmailSettings emailSettings)
                          throws org.springframework.web.client.RestClientException
```
    Replace the Email Template Settings Replaces an email template's settings
    204 - Successfully updated the email template's settings.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    422 - Could not update the email template's settings due to an invalid setting value.
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    emailSettings - (optional)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceEmailSettings
```
public void replaceEmailSettings(java.lang.Class<?> T,
                                 java.lang.String brandId,
                                 java.lang.String templateName,
                                 EmailSettings emailSettings)
                          throws org.springframework.web.client.RestClientException
```
    Replace the Email Template Settings Replaces an email template's settings
    204 - Successfully updated the email template's settings.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    422 - Could not update the email template's settings due to an invalid setting value.
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    emailSettings - (optional)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replacePreviewErrorPage
```
public CustomizablePage replacePreviewErrorPage(java.lang.String brandId,
                                                CustomizablePage customizablePage)
                                         throws org.springframework.web.client.RestClientException
```
    Replace the Preview Error Page Replace the preview error page
    200 - Successfully replaced the preview error page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    customizablePage - (required)
    
    Returns:
    
    CustomizablePage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replacePreviewErrorPage
```
public <T> T replacePreviewErrorPage(java.lang.Class<?> T,
                                     java.lang.String brandId,
                                     CustomizablePage customizablePage)
                              throws org.springframework.web.client.RestClientException
```
    Replace the Preview Error Page Replace the preview error page
    200 - Successfully replaced the preview error page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    customizablePage - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replacePreviewErrorPageWithPaginationInfo
```
public PagedList replacePreviewErrorPageWithPaginationInfo(java.lang.String brandId,
                                                           CustomizablePage customizablePage)
                                                    throws org.springframework.web.client.RestClientException
```
    Replace the Preview Error Page Replace the preview error page
    200 - Successfully replaced the preview error page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    customizablePage - (required)
    
    Returns:
    
    ResponseEntity<CustomizablePage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replacePreviewSignInPage
```
public SignInPage replacePreviewSignInPage(java.lang.String brandId,
                                           SignInPage signInPage)
                                    throws org.springframework.web.client.RestClientException
```
    Replace the Preview Sign-in Page Replace the preview sign-in page
    200 - Successfully replaced the preview sign-in page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    signInPage - (required)
    
    Returns:
    
    SignInPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replacePreviewSignInPage
```
public <T> T replacePreviewSignInPage(java.lang.Class<?> T,
                                      java.lang.String brandId,
                                      SignInPage signInPage)
                               throws org.springframework.web.client.RestClientException
```
    Replace the Preview Sign-in Page Replace the preview sign-in page
    200 - Successfully replaced the preview sign-in page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    signInPage - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replacePreviewSignInPageWithPaginationInfo
```
public PagedList replacePreviewSignInPageWithPaginationInfo(java.lang.String brandId,
                                                            SignInPage signInPage)
                                                     throws org.springframework.web.client.RestClientException
```
    Replace the Preview Sign-in Page Replace the preview sign-in page
    200 - Successfully replaced the preview sign-in page.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    signInPage - (required)
    
    Returns:
    
    ResponseEntity<SignInPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceSignOutPageSettings
```
public HostedPage replaceSignOutPageSettings(java.lang.String brandId,
                                             HostedPage hostedPage)
                                      throws org.springframework.web.client.RestClientException
```
    Replace the Sign-out Page Settings Replaces the sign-out page settings
    200 - Successfully replaced the sign-out page settings.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    hostedPage - (required)
    
    Returns:
    
    HostedPage
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceSignOutPageSettings
```
public <T> T replaceSignOutPageSettings(java.lang.Class<?> T,
                                        java.lang.String brandId,
                                        HostedPage hostedPage)
                                 throws org.springframework.web.client.RestClientException
```
    Replace the Sign-out Page Settings Replaces the sign-out page settings
    200 - Successfully replaced the sign-out page settings.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    T - (required) - the assignable return type
    
    brandId - The ID of the brand. (required)
    
    hostedPage - (required)
    
    Returns:
    
    T instance
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - replaceSignOutPageSettingsWithPaginationInfo
```
public PagedList replaceSignOutPageSettingsWithPaginationInfo(java.lang.String brandId,
                                                              HostedPage hostedPage)
                                                       throws org.springframework.web.client.RestClientException
```
    Replace the Sign-out Page Settings Replaces the sign-out page settings
    200 - Successfully replaced the sign-out page settings.
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    hostedPage - (required)
    
    Returns:
    
    ResponseEntity<HostedPage>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - resetCustomizedErrorPage
```
public void resetCustomizedErrorPage(java.lang.String brandId)
                              throws org.springframework.web.client.RestClientException
```
    Reset the Customized Error Page Resets the customized error page
    204 - Successfully reset the customized error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - resetCustomizedSignInPage
```
public void resetCustomizedSignInPage(java.lang.String brandId)
                               throws org.springframework.web.client.RestClientException
```
    Reset the Customized Sign-in Page Reset the customized sign-in page
    204 - Successfully reset the sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - resetPreviewErrorPage
```
public void resetPreviewErrorPage(java.lang.String brandId)
                           throws org.springframework.web.client.RestClientException
```
    Reset the Preview Error Page Reset the preview error page
    204 - Successfully reset the preview error page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - resetPreviewSignInPage
```
public void resetPreviewSignInPage(java.lang.String brandId)
                            throws org.springframework.web.client.RestClientException
```
    Reset the Preview Sign-in Page Reset the preview sign-in page
    204 - Successfully reset the preview sign-in page.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - sendTestEmail
```
public void sendTestEmail(java.lang.String brandId,
                          java.lang.String templateName,
                          java.lang.String language)
                   throws org.springframework.web.client.RestClientException
```
    Send a Test Email Sends a test email to the current user’s primary and secondary email addresses. The email content is selected based on the following priority: 1. The email customization for the language specified in the `language` query parameter. 2. The email template's default customization. 3. The email template’s default content, translated to the current user's language.
    204 - Successfully sent a test email.
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    templateName - The name of the email template. (required)
    
    language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - unlinkBrandDomain
```
public void unlinkBrandDomain(java.lang.String brandId,
                              java.lang.String domainId)
                       throws org.springframework.web.client.RestClientException
```
    Unlink a Brand from a Domain Unlink brand and domain by its unique identifier
    204 - Successfully unlinked the domain from the brand
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    domainId - The ID of the domain. (required)
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - uploadBrandThemeBackgroundImage
```
public ImageUploadResponse uploadBrandThemeBackgroundImage(java.lang.String brandId,
                                                           java.lang.String themeId,
                                                           java.io.File _file)
                                                    throws org.springframework.web.client.RestClientException
```
    Upload the Background Image Updates the background image for your Theme
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    _file - (required)
    
    Returns:
    
    ImageUploadResponse
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - uploadBrandThemeBackgroundImageWithPaginationInfo
```
public PagedList uploadBrandThemeBackgroundImageWithPaginationInfo(java.lang.String brandId,
                                                                   java.lang.String themeId,
                                                                   java.io.File _file)
                                                            throws org.springframework.web.client.RestClientException
```
    Upload the Background Image Updates the background image for your Theme
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    _file - (required)
    
    Returns:
    
    ResponseEntity<ImageUploadResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - uploadBrandThemeFavicon
```
public ImageUploadResponse uploadBrandThemeFavicon(java.lang.String brandId,
                                                   java.lang.String themeId,
                                                   java.io.File _file)
                                            throws org.springframework.web.client.RestClientException
```
    Upload the Favicon Updates the favicon for your theme
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    _file - (required)
    
    Returns:
    
    ImageUploadResponse
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - uploadBrandThemeFaviconWithPaginationInfo
```
public PagedList uploadBrandThemeFaviconWithPaginationInfo(java.lang.String brandId,
                                                           java.lang.String themeId,
                                                           java.io.File _file)
                                                    throws org.springframework.web.client.RestClientException
```
    Upload the Favicon Updates the favicon for your theme
    201 - Created
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    _file - (required)
    
    Returns:
    
    ResponseEntity<ImageUploadResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - uploadBrandThemeLogo
```
public ImageUploadResponse uploadBrandThemeLogo(java.lang.String brandId,
                                                java.lang.String themeId,
                                                java.io.File _file)
                                         throws org.springframework.web.client.RestClientException
```
    Upload the Logo Updates the logo for your Theme
    200 - Success
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    _file - (required)
    
    Returns:
    
    ImageUploadResponse
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
  - uploadBrandThemeLogoWithPaginationInfo
```
public PagedList uploadBrandThemeLogoWithPaginationInfo(java.lang.String brandId,
                                                        java.lang.String themeId,
                                                        java.io.File _file)
                                                 throws org.springframework.web.client.RestClientException
```
    Upload the Logo Updates the logo for your Theme
    200 - Success
    400 - Bad Request
    403 - Forbidden
    404 - Not Found
    429 - Too Many Requests
    
    Parameters:
    
    brandId - The ID of the brand. (required)
    
    themeId - The ID of the theme. (required)
    
    _file - (required)
    
    Returns:
    
    ResponseEntity<ImageUploadResponse>
    
    Throws:
    
    org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

Class CustomizationApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomizationApi

CustomizationApi

Method Detail

getApiClient

setApiClient

createBrand

createBrand

createBrandWithPaginationInfo

createEmailCustomization

createEmailCustomization

createEmailCustomizationWithPaginationInfo

deleteAllCustomizations

deleteBrand

deleteBrandThemeBackgroundImage

deleteBrandThemeFavicon

deleteBrandThemeLogo

deleteEmailCustomization

getBrand

getBrandWithPaginationInfo

getBrandTheme

getBrandThemeWithPaginationInfo

getCustomizationPreview

getCustomizationPreviewWithPaginationInfo

getCustomizedErrorPage

getCustomizedErrorPageWithPaginationInfo

getCustomizedSignInPage

getCustomizedSignInPageWithPaginationInfo

getDefaultErrorPage

getDefaultErrorPageWithPaginationInfo

getDefaultSignInPage

getDefaultSignInPageWithPaginationInfo

getEmailCustomization

getEmailCustomizationWithPaginationInfo

getEmailDefaultContent

getEmailDefaultContentWithPaginationInfo

getEmailDefaultPreview

getEmailDefaultPreviewWithPaginationInfo

getEmailSettings

getEmailSettingsWithPaginationInfo

getEmailTemplate

getEmailTemplateWithPaginationInfo

getErrorPage

getErrorPageWithPaginationInfo

getPreviewErrorPage

getPreviewErrorPageWithPaginationInfo

getPreviewSignInPage

getPreviewSignInPageWithPaginationInfo

getSignInPage

getSignInPageWithPaginationInfo

getSignOutPageSettings

getSignOutPageSettingsWithPaginationInfo

linkBrandDomain

linkBrandDomain

linkBrandDomainWithPaginationInfo

listAllSignInWidgetVersions

listAllSignInWidgetVersionsWithPaginationInfo

listBrandDomains

listBrandDomainsWithPaginationInfo

listBrandThemes

listBrandThemesWithPaginationInfo

listBrands

listBrandsWithPaginationInfo

listEmailCustomizations

listEmailCustomizationsWithPaginationInfo

listEmailTemplates

listEmailTemplatesWithPaginationInfo

replaceBrand

replaceBrand

replaceBrandWithPaginationInfo

replaceBrandTheme

replaceBrandTheme

replaceBrandThemeWithPaginationInfo

replaceCustomizedErrorPage

replaceCustomizedErrorPage

replaceCustomizedErrorPageWithPaginationInfo