@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-01-18T04:14:02.238-06:00[America/Chicago]") @Component(value="org.openapitools.client.api.CustomizationApi") public class CustomizationApi extends Object
Constructor and Description |
---|
CustomizationApi() |
CustomizationApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
<T> T |
createBrand(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(Class<?> T,
String brandId,
String templateName,
EmailCustomization instance)
Create an Email Customization
Creates a new email customization
|
EmailCustomization |
createEmailCustomization(String brandId,
String templateName,
EmailCustomization instance)
Create an Email Customization
Creates a new email customization
|
PagedList |
createEmailCustomizationWithPaginationInfo(String brandId,
String templateName,
EmailCustomization instance)
Create an Email Customization
Creates a new email customization
|
void |
deleteAllCustomizations(String brandId,
String templateName)
Delete all Email Customizations
Deletes all customizations for an email template
|
void |
deleteBrand(String brandId)
Delete a brand
Deletes a brand by its unique identifier
|
void |
deleteBrandThemeBackgroundImage(String brandId,
String themeId)
Delete the Background Image
Deletes a Theme background image
|
void |
deleteBrandThemeFavicon(String brandId,
String themeId)
Delete the Favicon
Deletes a Theme favicon.
|
void |
deleteBrandThemeLogo(String brandId,
String themeId)
Delete the Logo
Deletes a Theme logo.
|
void |
deleteEmailCustomization(String brandId,
String templateName,
String customizationId)
Delete an Email Customization
Deletes an email customization by its unique identifier
|
ApiClient |
getApiClient() |
Brand |
getBrand(String brandId)
Retrieve a Brand
Retrieves a brand by `brandId`
|
ThemeResponse |
getBrandTheme(String brandId,
String themeId)
Retrieve a Theme
Retrieves a theme for a brand
|
PagedList |
getBrandThemeWithPaginationInfo(String brandId,
String themeId)
Retrieve a Theme
Retrieves a theme for a brand
|
PagedList |
getBrandWithPaginationInfo(String brandId)
Retrieve a Brand
Retrieves a brand by `brandId`
|
EmailPreview |
getCustomizationPreview(String brandId,
String templateName,
String customizationId)
Retrieve a Preview of an Email Customization
Generates a preview of an email customization.
|
PagedList |
getCustomizationPreviewWithPaginationInfo(String brandId,
String templateName,
String customizationId)
Retrieve a Preview of an Email Customization
Generates a preview of an email customization.
|
CustomizablePage |
getCustomizedErrorPage(String brandId)
Retrieve the Customized Error Page
Retrieves the customized error page
|
PagedList |
getCustomizedErrorPageWithPaginationInfo(String brandId)
Retrieve the Customized Error Page
Retrieves the customized error page
|
SignInPage |
getCustomizedSignInPage(String brandId)
Retrieve the Customized Sign-in Page
Retrieves the customized sign-in page
|
PagedList |
getCustomizedSignInPageWithPaginationInfo(String brandId)
Retrieve the Customized Sign-in Page
Retrieves the customized sign-in page
|
CustomizablePage |
getDefaultErrorPage(String brandId)
Retrieve the Default Error Page
Retrieves the default error page
|
PagedList |
getDefaultErrorPageWithPaginationInfo(String brandId)
Retrieve the Default Error Page
Retrieves the default error page
|
SignInPage |
getDefaultSignInPage(String brandId)
Retrieve the Default Sign-in Page
Retrieves the default sign-in page
|
PagedList |
getDefaultSignInPageWithPaginationInfo(String brandId)
Retrieve the Default Sign-in Page
Retrieves the default sign-in page
|
EmailCustomization |
getEmailCustomization(String brandId,
String templateName,
String customizationId)
Retrieve an Email Customization
Retrieves an email customization by its unique identifier
|
PagedList |
getEmailCustomizationWithPaginationInfo(String brandId,
String templateName,
String customizationId)
Retrieve an Email Customization
Retrieves an email customization by its unique identifier
|
EmailDefaultContent |
getEmailDefaultContent(String brandId,
String templateName,
String language)
Retrieve an Email Template Default Content
Retrieves an email template's default content
|
PagedList |
getEmailDefaultContentWithPaginationInfo(String brandId,
String templateName,
String language)
Retrieve an Email Template Default Content
Retrieves an email template's default content
|
EmailPreview |
getEmailDefaultPreview(String brandId,
String templateName,
String language)
Retrieve a Preview of the Email Template Default Content
Generates a preview of an email template's default content.
|
PagedList |
getEmailDefaultPreviewWithPaginationInfo(String brandId,
String templateName,
String language)
Retrieve a Preview of the Email Template Default Content
Generates a preview of an email template's default content.
|
EmailSettings |
getEmailSettings(String brandId,
String templateName)
Retrieve the Email Template Settings
Retrieves an email template's settings
|
PagedList |
getEmailSettingsWithPaginationInfo(String brandId,
String templateName)
Retrieve the Email Template Settings
Retrieves an email template's settings
|
EmailTemplate |
getEmailTemplate(String brandId,
String templateName,
List<String> expand)
Retrieve an Email Template
Retrieves the details of an email template by name
|
PagedList |
getEmailTemplateWithPaginationInfo(String brandId,
String templateName,
List<String> expand)
Retrieve an Email Template
Retrieves the details of an email template by name
|
PageRoot |
getErrorPage(String brandId,
List<String> expand)
Retrieve the Error Page
Retrieves the error page
|
PagedList |
getErrorPageWithPaginationInfo(String brandId,
List<String> expand)
Retrieve the Error Page
Retrieves the error page
|
CustomizablePage |
getPreviewErrorPage(String brandId)
Retrieve the Preview Error Page Preview
Retrieves the preview error page
|
PagedList |
getPreviewErrorPageWithPaginationInfo(String brandId)
Retrieve the Preview Error Page Preview
Retrieves the preview error page
|
SignInPage |
getPreviewSignInPage(String brandId)
Retrieve the Preview Sign-in Page Preview
Retrieves the preview sign-in page
|
PagedList |
getPreviewSignInPageWithPaginationInfo(String brandId)
Retrieve the Preview Sign-in Page Preview
Retrieves the preview sign-in page
|
PageRoot |
getSignInPage(String brandId,
List<String> expand)
Retrieve the Sign-in Page
Retrieves the sign-in page
|
PagedList |
getSignInPageWithPaginationInfo(String brandId,
List<String> expand)
Retrieve the Sign-in Page
Retrieves the sign-in page
|
HostedPage |
getSignOutPageSettings(String brandId)
Retrieve the Sign-out Page Settings
Retrieves the sign-out page settings
|
PagedList |
getSignOutPageSettingsWithPaginationInfo(String brandId)
Retrieve the Sign-out Page Settings
Retrieves the sign-out page settings
|
<T> T |
linkBrandDomain(Class<?> T,
String brandId,
CreateBrandDomainRequest createBrandDomainRequest)
Link a Brand to a Domain
Link a Brand to a Domain by `domainId`
|
BrandDomain |
linkBrandDomain(String brandId,
CreateBrandDomainRequest createBrandDomainRequest)
Link a Brand to a Domain
Link a Brand to a Domain by `domainId`
|
PagedList |
linkBrandDomainWithPaginationInfo(String brandId,
CreateBrandDomainRequest createBrandDomainRequest)
Link a Brand to a Domain
Link a Brand to a Domain by `domainId`
|
List<String> |
listAllSignInWidgetVersions(String brandId)
List all Sign-in Widget Versions
Lists all sign-in widget versions
|
PagedList |
listAllSignInWidgetVersionsWithPaginationInfo(String brandId)
List all Sign-in Widget Versions
Lists all sign-in widget versions
|
List<DomainResponse> |
listBrandDomains(String brandId)
List all Domains associated with a Brand
Lists all domains associated with a brand by `brandId`
|
PagedList |
listBrandDomainsWithPaginationInfo(String brandId)
List all Domains associated with a Brand
Lists all domains associated with a brand by `brandId`
|
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
|
List<ThemeResponse> |
listBrandThemes(String brandId)
List all Themes
Lists all the themes in your brand
|
PagedList |
listBrandThemesWithPaginationInfo(String brandId)
List all Themes
Lists all the themes in your brand
|
List<EmailCustomization> |
listEmailCustomizations(String brandId,
String templateName,
String after,
Integer limit)
List all Email Customizations
Lists all customizations of an email template
|
PagedList |
listEmailCustomizationsWithPaginationInfo(String brandId,
String templateName,
String after,
Integer limit)
List all Email Customizations
Lists all customizations of an email template
|
List<EmailTemplate> |
listEmailTemplates(String brandId,
String after,
Integer limit,
List<String> expand)
List all Email Templates
Lists all email templates
|
PagedList |
listEmailTemplatesWithPaginationInfo(String brandId,
String after,
Integer limit,
List<String> expand)
List all Email Templates
Lists all email templates
|
<T> T |
replaceBrand(Class<?> T,
String brandId,
BrandRequest brand)
Replace a Brand
Replaces a brand by `brandId`
|
Brand |
replaceBrand(String brandId,
BrandRequest brand)
Replace a Brand
Replaces a brand by `brandId`
|
<T> T |
replaceBrandTheme(Class<?> T,
String brandId,
String themeId,
Theme theme)
Replace a Theme
Replaces a theme for a brand
|
ThemeResponse |
replaceBrandTheme(String brandId,
String themeId,
Theme theme)
Replace a Theme
Replaces a theme for a brand
|
PagedList |
replaceBrandThemeWithPaginationInfo(String brandId,
String themeId,
Theme theme)
Replace a Theme
Replaces a theme for a brand
|
PagedList |
replaceBrandWithPaginationInfo(String brandId,
BrandRequest brand)
Replace a Brand
Replaces a brand by `brandId`
|
<T> T |
replaceCustomizedErrorPage(Class<?> T,
String brandId,
CustomizablePage customizablePage)
Replace the Customized Error Page
Replaces the customized error page
|
CustomizablePage |
replaceCustomizedErrorPage(String brandId,
CustomizablePage customizablePage)
Replace the Customized Error Page
Replaces the customized error page
|
PagedList |
replaceCustomizedErrorPageWithPaginationInfo(String brandId,
CustomizablePage customizablePage)
Replace the Customized Error Page
Replaces the customized error page
|
<T> T |
replaceCustomizedSignInPage(Class<?> T,
String brandId,
SignInPage signInPage)
Replace the Customized Sign-in Page
Replaces the customized sign-in page
|
SignInPage |
replaceCustomizedSignInPage(String brandId,
SignInPage signInPage)
Replace the Customized Sign-in Page
Replaces the customized sign-in page
|
PagedList |
replaceCustomizedSignInPageWithPaginationInfo(String brandId,
SignInPage signInPage)
Replace the Customized Sign-in Page
Replaces the customized sign-in page
|
<T> T |
replaceEmailCustomization(Class<?> T,
String brandId,
String templateName,
String customizationId,
EmailCustomization instance)
Replace an Email Customization
Replaces an existing email customization using the property values provided
|
EmailCustomization |
replaceEmailCustomization(String brandId,
String templateName,
String customizationId,
EmailCustomization instance)
Replace an Email Customization
Replaces an existing email customization using the property values provided
|
PagedList |
replaceEmailCustomizationWithPaginationInfo(String brandId,
String templateName,
String customizationId,
EmailCustomization instance)
Replace an Email Customization
Replaces an existing email customization using the property values provided
|
void |
replaceEmailSettings(Class<?> T,
String brandId,
String templateName,
EmailSettings emailSettings)
Replace the Email Template Settings
Replaces an email template's settings
|
void |
replaceEmailSettings(String brandId,
String templateName,
EmailSettings emailSettings)
Replace the Email Template Settings
Replaces an email template's settings
|
<T> T |
replacePreviewErrorPage(Class<?> T,
String brandId,
CustomizablePage customizablePage)
Replace the Preview Error Page
Replace the preview error page
|
CustomizablePage |
replacePreviewErrorPage(String brandId,
CustomizablePage customizablePage)
Replace the Preview Error Page
Replace the preview error page
|
PagedList |
replacePreviewErrorPageWithPaginationInfo(String brandId,
CustomizablePage customizablePage)
Replace the Preview Error Page
Replace the preview error page
|
<T> T |
replacePreviewSignInPage(Class<?> T,
String brandId,
SignInPage signInPage)
Replace the Preview Sign-in Page
Replace the preview sign-in page
|
SignInPage |
replacePreviewSignInPage(String brandId,
SignInPage signInPage)
Replace the Preview Sign-in Page
Replace the preview sign-in page
|
PagedList |
replacePreviewSignInPageWithPaginationInfo(String brandId,
SignInPage signInPage)
Replace the Preview Sign-in Page
Replace the preview sign-in page
|
<T> T |
replaceSignOutPageSettings(Class<?> T,
String brandId,
HostedPage hostedPage)
Replace the Sign-out Page Settings
Replaces the sign-out page settings
|
HostedPage |
replaceSignOutPageSettings(String brandId,
HostedPage hostedPage)
Replace the Sign-out Page Settings
Replaces the sign-out page settings
|
PagedList |
replaceSignOutPageSettingsWithPaginationInfo(String brandId,
HostedPage hostedPage)
Replace the Sign-out Page Settings
Replaces the sign-out page settings
|
void |
resetCustomizedErrorPage(String brandId)
Reset the Customized Error Page
Resets the customized error page
|
void |
resetCustomizedSignInPage(String brandId)
Reset the Customized Sign-in Page
Reset the customized sign-in page
|
void |
resetPreviewErrorPage(String brandId)
Reset the Preview Error Page
Reset the preview error page
|
void |
resetPreviewSignInPage(String brandId)
Reset the Preview Sign-in Page
Reset the preview sign-in page
|
void |
sendTestEmail(String brandId,
String templateName,
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(String brandId,
String domainId)
Unlink a Brand from a Domain
Unlink brand and domain by its unique identifier
|
ImageUploadResponse |
uploadBrandThemeBackgroundImage(String brandId,
String themeId,
File _file)
Upload the Background Image
Updates the background image for your Theme
|
PagedList |
uploadBrandThemeBackgroundImageWithPaginationInfo(String brandId,
String themeId,
File _file)
Upload the Background Image
Updates the background image for your Theme
|
ImageUploadResponse |
uploadBrandThemeFavicon(String brandId,
String themeId,
File _file)
Upload the Favicon
Updates the favicon for your theme
|
PagedList |
uploadBrandThemeFaviconWithPaginationInfo(String brandId,
String themeId,
File _file)
Upload the Favicon
Updates the favicon for your theme
|
ImageUploadResponse |
uploadBrandThemeLogo(String brandId,
String themeId,
File _file)
Upload the Logo
Updates the logo for your Theme
|
PagedList |
uploadBrandThemeLogoWithPaginationInfo(String brandId,
String themeId,
File _file)
Upload the Logo
Updates the logo for your Theme
|
public CustomizationApi()
@Autowired public CustomizationApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public Brand createBrand(CreateBrandRequest createBrandRequest) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
createBrandRequest
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T createBrand(Class<?> T, CreateBrandRequest createBrandRequest) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
T
- (required) - the assignable return typecreateBrandRequest
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList createBrandWithPaginationInfo(CreateBrandRequest createBrandRequest) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
429 - Too Many Requests
createBrandRequest
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailCustomization createEmailCustomization(String brandId, String templateName, EmailCustomization instance) throws org.springframework.web.client.RestClientException
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
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)instance
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T createEmailCustomization(Class<?> T, String brandId, String templateName, EmailCustomization instance) throws org.springframework.web.client.RestClientException
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
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)instance
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList createEmailCustomizationWithPaginationInfo(String brandId, String templateName, EmailCustomization instance) throws org.springframework.web.client.RestClientException
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
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)instance
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteAllCustomizations(String brandId, String templateName) throws org.springframework.web.client.RestClientException
204 - Successfully deleted all customizations for the email template.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteBrand(String brandId) throws org.springframework.web.client.RestClientException
204 - Successfully deleted the brand.
403 - Forbidden
404 - Not Found
409 - Conflict
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteBrandThemeBackgroundImage(String brandId, String themeId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteBrandThemeFavicon(String brandId, String themeId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteBrandThemeLogo(String brandId, String themeId) throws org.springframework.web.client.RestClientException
204 - No Content
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void deleteEmailCustomization(String brandId, String templateName, String customizationId) throws org.springframework.web.client.RestClientException
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
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)customizationId
- The ID of the email customization. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Brand getBrand(String brandId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getBrandWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ThemeResponse getBrandTheme(String brandId, String themeId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getBrandThemeWithPaginationInfo(String brandId, String themeId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailPreview getCustomizationPreview(String brandId, String templateName, String customizationId) throws org.springframework.web.client.RestClientException
200 - Successfully generated a preview of the email customization.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)customizationId
- The ID of the email customization. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getCustomizationPreviewWithPaginationInfo(String brandId, String templateName, String customizationId) throws org.springframework.web.client.RestClientException
200 - Successfully generated a preview of the email customization.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)customizationId
- The ID of the email customization. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic CustomizablePage getCustomizedErrorPage(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the customized error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getCustomizedErrorPageWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the customized error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic SignInPage getCustomizedSignInPage(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the customized sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getCustomizedSignInPageWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the customized sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic CustomizablePage getDefaultErrorPage(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the default error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getDefaultErrorPageWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the default error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic SignInPage getDefaultSignInPage(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the default sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getDefaultSignInPageWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the default sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailCustomization getEmailCustomization(String brandId, String templateName, String customizationId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email customization.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)customizationId
- The ID of the email customization. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getEmailCustomizationWithPaginationInfo(String brandId, String templateName, String customizationId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email customization.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)customizationId
- The ID of the email customization. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailDefaultContent getEmailDefaultContent(String brandId, String templateName, String language) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email template's default content.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getEmailDefaultContentWithPaginationInfo(String brandId, String templateName, String language) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email template's default content.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailPreview getEmailDefaultPreview(String brandId, String templateName, String language) throws org.springframework.web.client.RestClientException
200 - Successfully generated a preview of the email template's default content.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getEmailDefaultPreviewWithPaginationInfo(String brandId, String templateName, String language) throws org.springframework.web.client.RestClientException
200 - Successfully generated a preview of the email template's default content.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailSettings getEmailSettings(String brandId, String templateName) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email template's settings.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getEmailSettingsWithPaginationInfo(String brandId, String templateName) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email template's settings.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailTemplate getEmailTemplate(String brandId, String templateName, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email template.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getEmailTemplateWithPaginationInfo(String brandId, String templateName, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the email template.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PageRoot getErrorPage(String brandId, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)expand
- Specifies additional metadata to be included in the response. (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getErrorPageWithPaginationInfo(String brandId, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)expand
- Specifies additional metadata to be included in the response. (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic CustomizablePage getPreviewErrorPage(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the preview error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getPreviewErrorPageWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the preview error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic SignInPage getPreviewSignInPage(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the preview sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getPreviewSignInPageWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the preview sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PageRoot getSignInPage(String brandId, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)expand
- Specifies additional metadata to be included in the response. (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getSignInPageWithPaginationInfo(String brandId, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)expand
- Specifies additional metadata to be included in the response. (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic HostedPage getSignOutPageSettings(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the sign-out page settings.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList getSignOutPageSettingsWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved the sign-out page settings.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic BrandDomain linkBrandDomain(String brandId, CreateBrandDomainRequest createBrandDomainRequest) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
409 - Conflict
429 - Too Many Requests
brandId
- The ID of the brand. (required)createBrandDomainRequest
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T linkBrandDomain(Class<?> T, String brandId, CreateBrandDomainRequest createBrandDomainRequest) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
409 - Conflict
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)createBrandDomainRequest
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList linkBrandDomainWithPaginationInfo(String brandId, CreateBrandDomainRequest createBrandDomainRequest) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
409 - Conflict
429 - Too Many Requests
brandId
- The ID of the brand. (required)createBrandDomainRequest
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<String> listAllSignInWidgetVersions(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully listed the sign-in widget versions.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listAllSignInWidgetVersionsWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - Successfully listed the sign-in widget versions.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<DomainResponse> listBrandDomains(String brandId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listBrandDomainsWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<ThemeResponse> listBrandThemes(String brandId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listBrandThemesWithPaginationInfo(String brandId) throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<Brand> listBrands() throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
429 - Too Many Requests
org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listBrandsWithPaginationInfo() throws org.springframework.web.client.RestClientException
200 - OK
403 - Forbidden
429 - Too Many Requests
org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<EmailCustomization> listEmailCustomizations(String brandId, String templateName, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved all email customizations for the specified email template.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listEmailCustomizationsWithPaginationInfo(String brandId, String templateName, String after, Integer limit) throws org.springframework.web.client.RestClientException
200 - Successfully retrieved all email customizations for the specified email template.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic List<EmailTemplate> listEmailTemplates(String brandId, String after, Integer limit, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully returned the list of email templates.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList listEmailTemplatesWithPaginationInfo(String brandId, String after, Integer limit, List<String> expand) throws org.springframework.web.client.RestClientException
200 - Successfully returned the list of email templates.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic Brand replaceBrand(String brandId, BrandRequest brand) throws org.springframework.web.client.RestClientException
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)brand
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceBrand(Class<?> T, String brandId, BrandRequest brand) throws org.springframework.web.client.RestClientException
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)brand
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceBrandWithPaginationInfo(String brandId, BrandRequest brand) throws org.springframework.web.client.RestClientException
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)brand
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ThemeResponse replaceBrandTheme(String brandId, String themeId, Theme theme) throws org.springframework.web.client.RestClientException
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)theme
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceBrandTheme(Class<?> T, String brandId, String themeId, Theme theme) throws org.springframework.web.client.RestClientException
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)theme
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceBrandThemeWithPaginationInfo(String brandId, String themeId, Theme theme) throws org.springframework.web.client.RestClientException
200 - OK
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)theme
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic CustomizablePage replaceCustomizedErrorPage(String brandId, CustomizablePage customizablePage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the customized error page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)customizablePage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceCustomizedErrorPage(Class<?> T, String brandId, CustomizablePage customizablePage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the customized error page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)customizablePage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceCustomizedErrorPageWithPaginationInfo(String brandId, CustomizablePage customizablePage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the customized error page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)customizablePage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic SignInPage replaceCustomizedSignInPage(String brandId, SignInPage signInPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the customized sign-in page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)signInPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceCustomizedSignInPage(Class<?> T, String brandId, SignInPage signInPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the customized sign-in page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)signInPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceCustomizedSignInPageWithPaginationInfo(String brandId, SignInPage signInPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the customized sign-in page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)signInPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic EmailCustomization replaceEmailCustomization(String brandId, String templateName, String customizationId, EmailCustomization instance) throws org.springframework.web.client.RestClientException
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
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceEmailCustomization(Class<?> T, String brandId, String templateName, String customizationId, EmailCustomization instance) throws org.springframework.web.client.RestClientException
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
T
- (required) - the assignable return typebrandId
- 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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceEmailCustomizationWithPaginationInfo(String brandId, String templateName, String customizationId, EmailCustomization instance) throws org.springframework.web.client.RestClientException
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
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void replaceEmailSettings(String brandId, String templateName, EmailSettings emailSettings) throws org.springframework.web.client.RestClientException
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
brandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)emailSettings
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void replaceEmailSettings(Class<?> T, String brandId, String templateName, EmailSettings emailSettings) throws org.springframework.web.client.RestClientException
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
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)templateName
- The name of the email template. (required)emailSettings
- (optional)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic CustomizablePage replacePreviewErrorPage(String brandId, CustomizablePage customizablePage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the preview error page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)customizablePage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replacePreviewErrorPage(Class<?> T, String brandId, CustomizablePage customizablePage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the preview error page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)customizablePage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replacePreviewErrorPageWithPaginationInfo(String brandId, CustomizablePage customizablePage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the preview error page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)customizablePage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic SignInPage replacePreviewSignInPage(String brandId, SignInPage signInPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the preview sign-in page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)signInPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replacePreviewSignInPage(Class<?> T, String brandId, SignInPage signInPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the preview sign-in page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)signInPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replacePreviewSignInPageWithPaginationInfo(String brandId, SignInPage signInPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the preview sign-in page.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)signInPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic HostedPage replaceSignOutPageSettings(String brandId, HostedPage hostedPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the sign-out page settings.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)hostedPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic <T> T replaceSignOutPageSettings(Class<?> T, String brandId, HostedPage hostedPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the sign-out page settings.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
T
- (required) - the assignable return typebrandId
- The ID of the brand. (required)hostedPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList replaceSignOutPageSettingsWithPaginationInfo(String brandId, HostedPage hostedPage) throws org.springframework.web.client.RestClientException
200 - Successfully replaced the sign-out page settings.
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)hostedPage
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void resetCustomizedErrorPage(String brandId) throws org.springframework.web.client.RestClientException
204 - Successfully reset the customized error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void resetCustomizedSignInPage(String brandId) throws org.springframework.web.client.RestClientException
204 - Successfully reset the sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void resetPreviewErrorPage(String brandId) throws org.springframework.web.client.RestClientException
204 - Successfully reset the preview error page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void resetPreviewSignInPage(String brandId) throws org.springframework.web.client.RestClientException
204 - Successfully reset the preview sign-in page.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void sendTestEmail(String brandId, String templateName, String language) throws org.springframework.web.client.RestClientException
204 - Successfully sent a test email.
403 - Forbidden
404 - Not Found
429 - Too Many Requests
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)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic void unlinkBrandDomain(String brandId, String domainId) throws org.springframework.web.client.RestClientException
204 - Successfully unlinked the domain from the brand
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)domainId
- The ID of the domain. (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ImageUploadResponse uploadBrandThemeBackgroundImage(String brandId, String themeId, File _file) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList uploadBrandThemeBackgroundImageWithPaginationInfo(String brandId, String themeId, File _file) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ImageUploadResponse uploadBrandThemeFavicon(String brandId, String themeId, File _file) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList uploadBrandThemeFaviconWithPaginationInfo(String brandId, String themeId, File _file) throws org.springframework.web.client.RestClientException
201 - Created
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic ImageUploadResponse uploadBrandThemeLogo(String brandId, String themeId, File _file) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APIpublic PagedList uploadBrandThemeLogoWithPaginationInfo(String brandId, String themeId, File _file) throws org.springframework.web.client.RestClientException
200 - Success
400 - Bad Request
403 - Forbidden
404 - Not Found
429 - Too Many Requests
brandId
- The ID of the brand. (required)themeId
- The ID of the theme. (required)_file
- (required)org.springframework.web.client.RestClientException
- if an error occurs while attempting to invoke the APICopyright © 2017–2023 Okta. All rights reserved.