Class CustomizationApi

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-04-19T09:13:44.263607-05:00[America/Chicago]") @Component("org.openapitools.client.api.CustomizationApi") public class CustomizationApi extends Object
  • Constructor Details

    • CustomizationApi

      public CustomizationApi()
    • CustomizationApi

      @Autowired public CustomizationApi(ApiClient apiClient)
  • Method Details

    • 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(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
    • createBrandWithHttpInfo

      public org.springframework.http.ResponseEntity<Brand> createBrandWithHttpInfo(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
    • 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(String brandId, 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(Class<?> T, String brandId, 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
    • createEmailCustomizationWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailCustomization> createEmailCustomizationWithHttpInfo(String brandId, 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
    • createEmailCustomizationWithPaginationInfo

      public PagedList createEmailCustomizationWithPaginationInfo(String brandId, 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(String brandId, 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
    • deleteAllCustomizationsWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteAllCustomizationsWithHttpInfo(String brandId, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deleteBrand

      public void deleteBrand(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
    • deleteBrandWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteBrandWithHttpInfo(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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deleteBrandThemeBackgroundImage

      public void deleteBrandThemeBackgroundImage(String brandId, 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
    • deleteBrandThemeBackgroundImageWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteBrandThemeBackgroundImageWithHttpInfo(String brandId, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deleteBrandThemeFavicon

      public void deleteBrandThemeFavicon(String brandId, 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
    • deleteBrandThemeFaviconWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteBrandThemeFaviconWithHttpInfo(String brandId, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deleteBrandThemeLogo

      public void deleteBrandThemeLogo(String brandId, 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
    • deleteBrandThemeLogoWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteBrandThemeLogoWithHttpInfo(String brandId, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • deleteEmailCustomization

      public void deleteEmailCustomization(String brandId, String templateName, 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
    • deleteEmailCustomizationWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteEmailCustomizationWithHttpInfo(String brandId, String templateName, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • getBrand

      public Brand getBrand(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
    • getBrandWithHttpInfo

      public org.springframework.http.ResponseEntity<Brand> getBrandWithHttpInfo(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
    • getBrandWithPaginationInfo

      public PagedList getBrandWithPaginationInfo(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(String brandId, 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
    • getBrandThemeWithHttpInfo

      public org.springframework.http.ResponseEntity<ThemeResponse> getBrandThemeWithHttpInfo(String brandId, 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
    • getBrandThemeWithPaginationInfo

      public PagedList getBrandThemeWithPaginationInfo(String brandId, 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(String brandId, String templateName, 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
    • getCustomizationPreviewWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailPreview> getCustomizationPreviewWithHttpInfo(String brandId, String templateName, 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
    • getCustomizationPreviewWithPaginationInfo

      public PagedList getCustomizationPreviewWithPaginationInfo(String brandId, String templateName, 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(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
    • getCustomizedErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<CustomizablePage> getCustomizedErrorPageWithHttpInfo(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
    • getCustomizedErrorPageWithPaginationInfo

      public PagedList getCustomizedErrorPageWithPaginationInfo(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(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
    • getCustomizedSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<SignInPage> getCustomizedSignInPageWithHttpInfo(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
    • getCustomizedSignInPageWithPaginationInfo

      public PagedList getCustomizedSignInPageWithPaginationInfo(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(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
    • getDefaultErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<CustomizablePage> getDefaultErrorPageWithHttpInfo(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
    • getDefaultErrorPageWithPaginationInfo

      public PagedList getDefaultErrorPageWithPaginationInfo(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(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
    • getDefaultSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<SignInPage> getDefaultSignInPageWithHttpInfo(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
    • getDefaultSignInPageWithPaginationInfo

      public PagedList getDefaultSignInPageWithPaginationInfo(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(String brandId, String templateName, 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
    • getEmailCustomizationWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailCustomization> getEmailCustomizationWithHttpInfo(String brandId, String templateName, 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
    • getEmailCustomizationWithPaginationInfo

      public PagedList getEmailCustomizationWithPaginationInfo(String brandId, String templateName, 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(String brandId, String templateName, 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
    • getEmailDefaultContentWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailDefaultContent> getEmailDefaultContentWithHttpInfo(String brandId, String templateName, 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
    • getEmailDefaultContentWithPaginationInfo

      public PagedList getEmailDefaultContentWithPaginationInfo(String brandId, String templateName, 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(String brandId, String templateName, 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
    • getEmailDefaultPreviewWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailPreview> getEmailDefaultPreviewWithHttpInfo(String brandId, String templateName, 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
    • getEmailDefaultPreviewWithPaginationInfo

      public PagedList getEmailDefaultPreviewWithPaginationInfo(String brandId, String templateName, 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(String brandId, 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
    • getEmailSettingsWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailSettings> getEmailSettingsWithHttpInfo(String brandId, 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
    • getEmailSettingsWithPaginationInfo

      public PagedList getEmailSettingsWithPaginationInfo(String brandId, 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(String brandId, String templateName, List<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
    • getEmailTemplateWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailTemplate> getEmailTemplateWithHttpInfo(String brandId, String templateName, List<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
    • getEmailTemplateWithPaginationInfo

      public PagedList getEmailTemplateWithPaginationInfo(String brandId, String templateName, List<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(String brandId, List<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
    • getErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<PageRoot> getErrorPageWithHttpInfo(String brandId, List<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
    • getErrorPageWithPaginationInfo

      public PagedList getErrorPageWithPaginationInfo(String brandId, List<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(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
    • getPreviewErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<CustomizablePage> getPreviewErrorPageWithHttpInfo(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
    • getPreviewErrorPageWithPaginationInfo

      public PagedList getPreviewErrorPageWithPaginationInfo(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(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
    • getPreviewSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<SignInPage> getPreviewSignInPageWithHttpInfo(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
    • getPreviewSignInPageWithPaginationInfo

      public PagedList getPreviewSignInPageWithPaginationInfo(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(String brandId, List<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
    • getSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<PageRoot> getSignInPageWithHttpInfo(String brandId, List<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
    • getSignInPageWithPaginationInfo

      public PagedList getSignInPageWithPaginationInfo(String brandId, List<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(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
    • getSignOutPageSettingsWithHttpInfo

      public org.springframework.http.ResponseEntity<HostedPage> getSignOutPageSettingsWithHttpInfo(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
    • getSignOutPageSettingsWithPaginationInfo

      public PagedList getSignOutPageSettingsWithPaginationInfo(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(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(Class<?> T, 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
    • linkBrandDomainWithHttpInfo

      public org.springframework.http.ResponseEntity<BrandDomain> linkBrandDomainWithHttpInfo(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
    • linkBrandDomainWithPaginationInfo

      public PagedList linkBrandDomainWithPaginationInfo(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 List<String> listAllSignInWidgetVersions(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
    • listAllSignInWidgetVersionsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<String>> listAllSignInWidgetVersionsWithHttpInfo(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
    • listAllSignInWidgetVersionsWithPaginationInfo

      public PagedList listAllSignInWidgetVersionsWithPaginationInfo(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 List<DomainResponse> listBrandDomains(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
    • listBrandDomainsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<DomainResponse>> listBrandDomainsWithHttpInfo(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
    • listBrandDomainsWithPaginationInfo

      public PagedList listBrandDomainsWithPaginationInfo(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 List<ThemeResponse> listBrandThemes(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
    • listBrandThemesWithHttpInfo

      public org.springframework.http.ResponseEntity<List<ThemeResponse>> listBrandThemesWithHttpInfo(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
    • listBrandThemesWithPaginationInfo

      public PagedList listBrandThemesWithPaginationInfo(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 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
    • listBrandsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<Brand>> listBrandsWithHttpInfo() 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
    • 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 List<EmailCustomization> listEmailCustomizations(String brandId, String templateName, String after, 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
    • listEmailCustomizationsWithHttpInfo

      public org.springframework.http.ResponseEntity<List<EmailCustomization>> listEmailCustomizationsWithHttpInfo(String brandId, String templateName, String after, 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
    • listEmailCustomizationsWithPaginationInfo

      public PagedList listEmailCustomizationsWithPaginationInfo(String brandId, String templateName, String after, 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 List<EmailTemplate> listEmailTemplates(String brandId, String after, Integer limit, List<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
    • listEmailTemplatesWithHttpInfo

      public org.springframework.http.ResponseEntity<List<EmailTemplate>> listEmailTemplatesWithHttpInfo(String brandId, String after, Integer limit, List<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
    • listEmailTemplatesWithPaginationInfo

      public PagedList listEmailTemplatesWithPaginationInfo(String brandId, String after, Integer limit, List<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(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(Class<?> T, 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
    • replaceBrandWithHttpInfo

      public org.springframework.http.ResponseEntity<Brand> replaceBrandWithHttpInfo(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
    • replaceBrandWithPaginationInfo

      public PagedList replaceBrandWithPaginationInfo(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(String brandId, 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(Class<?> T, String brandId, 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
    • replaceBrandThemeWithHttpInfo

      public org.springframework.http.ResponseEntity<ThemeResponse> replaceBrandThemeWithHttpInfo(String brandId, 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
    • replaceBrandThemeWithPaginationInfo

      public PagedList replaceBrandThemeWithPaginationInfo(String brandId, 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(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(Class<?> T, 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
    • replaceCustomizedErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<CustomizablePage> replaceCustomizedErrorPageWithHttpInfo(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
    • replaceCustomizedErrorPageWithPaginationInfo

      public PagedList replaceCustomizedErrorPageWithPaginationInfo(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(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(Class<?> T, 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
    • replaceCustomizedSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<SignInPage> replaceCustomizedSignInPageWithHttpInfo(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
    • replaceCustomizedSignInPageWithPaginationInfo

      public PagedList replaceCustomizedSignInPageWithPaginationInfo(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(String brandId, String templateName, 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(Class<?> T, String brandId, String templateName, 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
    • replaceEmailCustomizationWithHttpInfo

      public org.springframework.http.ResponseEntity<EmailCustomization> replaceEmailCustomizationWithHttpInfo(String brandId, String templateName, 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
    • replaceEmailCustomizationWithPaginationInfo

      public PagedList replaceEmailCustomizationWithPaginationInfo(String brandId, String templateName, 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(String brandId, 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(Class<?> T, String brandId, 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
    • replaceEmailSettingsWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> replaceEmailSettingsWithHttpInfo(String brandId, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • replacePreviewErrorPage

      public CustomizablePage replacePreviewErrorPage(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(Class<?> T, 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
    • replacePreviewErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<CustomizablePage> replacePreviewErrorPageWithHttpInfo(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
    • replacePreviewErrorPageWithPaginationInfo

      public PagedList replacePreviewErrorPageWithPaginationInfo(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(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(Class<?> T, 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
    • replacePreviewSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<SignInPage> replacePreviewSignInPageWithHttpInfo(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
    • replacePreviewSignInPageWithPaginationInfo

      public PagedList replacePreviewSignInPageWithPaginationInfo(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(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(Class<?> T, 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
    • replaceSignOutPageSettingsWithHttpInfo

      public org.springframework.http.ResponseEntity<HostedPage> replaceSignOutPageSettingsWithHttpInfo(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
    • replaceSignOutPageSettingsWithPaginationInfo

      public PagedList replaceSignOutPageSettingsWithPaginationInfo(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(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
    • resetCustomizedErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> resetCustomizedErrorPageWithHttpInfo(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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • resetCustomizedSignInPage

      public void resetCustomizedSignInPage(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
    • resetCustomizedSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> resetCustomizedSignInPageWithHttpInfo(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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • resetPreviewErrorPage

      public void resetPreviewErrorPage(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
    • resetPreviewErrorPageWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> resetPreviewErrorPageWithHttpInfo(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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • resetPreviewSignInPage

      public void resetPreviewSignInPage(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
    • resetPreviewSignInPageWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> resetPreviewSignInPageWithHttpInfo(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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • sendTestEmail

      public void sendTestEmail(String brandId, String templateName, 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
    • sendTestEmailWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> sendTestEmailWithHttpInfo(String brandId, String templateName, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • unlinkBrandDomain

      public void unlinkBrandDomain(String brandId, 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
    • unlinkBrandDomainWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> unlinkBrandDomainWithHttpInfo(String brandId, 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)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
    • uploadBrandThemeBackgroundImage

      public ImageUploadResponse uploadBrandThemeBackgroundImage(String brandId, String themeId, 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
    • uploadBrandThemeBackgroundImageWithHttpInfo

      public org.springframework.http.ResponseEntity<ImageUploadResponse> uploadBrandThemeBackgroundImageWithHttpInfo(String brandId, String themeId, 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
    • uploadBrandThemeBackgroundImageWithPaginationInfo

      public PagedList uploadBrandThemeBackgroundImageWithPaginationInfo(String brandId, String themeId, 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(String brandId, String themeId, 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
    • uploadBrandThemeFaviconWithHttpInfo

      public org.springframework.http.ResponseEntity<ImageUploadResponse> uploadBrandThemeFaviconWithHttpInfo(String brandId, String themeId, 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
    • uploadBrandThemeFaviconWithPaginationInfo

      public PagedList uploadBrandThemeFaviconWithPaginationInfo(String brandId, String themeId, 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(String brandId, String themeId, 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
    • uploadBrandThemeLogoWithHttpInfo

      public org.springframework.http.ResponseEntity<ImageUploadResponse> uploadBrandThemeLogoWithHttpInfo(String brandId, String themeId, 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
    • uploadBrandThemeLogoWithPaginationInfo

      public PagedList uploadBrandThemeLogoWithPaginationInfo(String brandId, String themeId, 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