updated acul PATCH 200 response, updated email template manager, added reset_email_by_code to multiple places (#1071)

tusharpandey13 · web-flow · commit 9de9532618f1 · 2025-01-21T10:19:02.000+05:30
diff --git a/src/management/__generated/managers/email-templates-manager.ts b/src/management/__generated/managers/email-templates-manager.ts
@@ -17,7 +17,7 @@ const { BaseAPI } = runtime;
  */
 export class EmailTemplatesManager extends BaseAPI {
   /**
-   * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
+   * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
    * Get an email template
    *
    * @throws {RequiredError}
diff --git a/src/management/__generated/managers/emails-manager.ts b/src/management/__generated/managers/emails-manager.ts
@@ -48,46 +48,10 @@ export class EmailsManager extends BaseAPI {
   }
 
   /**
-   * Update an <a href="https://auth0.com/docs/email/providers">email provider</a>. The <code>credentials</code> object
-   * requires different properties depending on the email provider (which is specified using the <code>name</code> property):
-   * <ul>
-   *   <li><code>mandrill</code> requires <code>api_key</code></li>
-   *   <li><code>sendgrid</code> requires <code>api_key</code></li>
-   *   <li>
-   *     <code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use
-   *     the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in
-   *     North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.
-   *   </li>
-   *   <li>
-   *     <code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to
-   *     <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or
-   *     <code>null</code> are the only valid values for <code>region</code>.
-   *   </li>
-   *   <li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li>
-   *   <li>
-   *     <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
-   *     <code>smtp_pass</code>
-   *   </li>
-   * </ul>
-   * Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
-   * options, which will be used when sending an email:
-   * <ul>
-   *   <li>
-   *     <code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object.
-   *     <ul>
-   *       <li>
-   *         When using AWS SES SMTP host, you may provide a name of configuration set in
-   *         <code>X-SES-Configuration-Set</code> header. Value must be a string.
-   *       </li>
-   *       <li>
-   *         When using Sparkpost host, you may provide value for
-   *         <code>X-MSYS_API</code> header. Value must be an object.
-   *       </li>
-   *     </ul>
-   *     for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
-   *     a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
-   *   </li>
-   * </ul>
+   * Update an <a href="https://auth0.com/docs/email/providers">email provider</a>.
+   * The <code>credentials</code> object requires different properties depending on the email provider (which is specified using the <code>name</code> property):
+   * <ul><li><code>mandrill</code> requires <code>api_key</code></li><li><code>sendgrid</code> requires <code>api_key</code></li><li><code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li><li><code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and <code>smtp_pass</code></li></ul>Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration options, which will be used when sending an email:
+   * <ul><li><code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object. When using AWS SES SMTP host, you may provide a name of configuration set in <code>X-SES-Configuration-Set</code> header. Value must be a string.</li><li>for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.</li></ul>
    *
    * Update the email provider
    *
@@ -115,48 +79,10 @@ export class EmailsManager extends BaseAPI {
   }
 
   /**
-   * Create an <a href="https://auth0.com/docs/email/providers">email provider</a>. The <code>credentials</code> object
-   * requires different properties depending on the email provider (which is specified using the <code>name</code> property):
-   * <ul>
-   *   <li><code>mandrill</code> requires <code>api_key</code></li>
-   *   <li><code>sendgrid</code> requires <code>api_key</code></li>
-   *   <li>
-   *     <code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use
-   *     the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in
-   *     North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.
-   *   </li>
-   *   <li>
-   *     <code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to
-   *     <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or
-   *     <code>null</code> are the only valid values for <code>region</code>.
-   *   </li>
-   *   <li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li>
-   *   <li>
-   *     <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
-   *     <code>smtp_pass</code>
-   *   </li>
-   * </ul>
-   * Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
-   * options, which will be used when sending an email:
-   * <ul>
-   *   <li>
-   *     <code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object.
-   *     <ul>
-   *       <li>
-   *         When using AWS SES SMTP host, you may provide a name of configuration set in
-   *         <code>X-SES-Configuration-Set</code> header. Value must be a string.
-   *       </li>
-   *       <li>
-   *         When using Sparkpost host, you may provide value for
-   *         <code>X-MSYS_API</code> header. Value must be an object.
-   *       </li>
-   *     </ul>
-   *   </li>
-   *   <li>
-   *     for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
-   *     a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
-   *   </li>
-   * </ul>
+   * Create an <a href="https://auth0.com/docs/email/providers">email provider</a>.
+   * The <code>credentials</code> object requires different properties depending on the email provider (which is specified using the <code>name</code> property):
+   * <ul><li><code>mandrill</code> requires <code>api_key</code></li><li><code>sendgrid</code> requires <code>api_key</code></li><li><code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li><li><code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and <code>smtp_pass</code></li></ul>Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration options, which will be used when sending an email:
+   * <ul><li><code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object. When using AWS SES SMTP host, you may provide a name of configuration set in <code>X-SES-Configuration-Set</code> header. Value must be a string.</li><li>for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.</li></ul>
    *
    * Configure the email provider
    *
diff --git a/src/management/__generated/managers/prompts-manager.ts b/src/management/__generated/managers/prompts-manager.ts
@@ -2,6 +2,7 @@ import * as runtime from '../../../lib/runtime.js';
 import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
 import type {
   GetRendering200Response,
+  PatchRendering200Response,
   PatchRenderingRequest,
   PromptsSettings,
   PromptsSettingsUpdate,
@@ -89,8 +90,8 @@ export class PromptsManager extends BaseAPI {
   }
 
   /**
-   * View the render settings for a specific screen
-   * Get render settings for a prompt
+   * Get render settings for a screen.
+   * Get render settings for a screen
    *
    * @throws {RequiredError}
    */
@@ -141,16 +142,44 @@ export class PromptsManager extends BaseAPI {
   }
 
   /**
-   * Configure the render settings for a specific screen
-   * Configure render settings for a prompt
+   * Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.
+   *
+   * <p>
+   *   Example <code>head_tags</code> array. See our <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>documentation</a> on using Liquid variables within head tags.
+   * </p>
+   * <pre>{
+   *   "head_tags": [
+   *     {
+   *       "tag": "script",
+   *       "attributes": {
+   *         "defer": true,
+   *         "src": "URL_TO_ASSET",
+   *         "async": true,
+   *         "integrity": [
+   *           "ASSET_SHA"
+   *         ]
+   *       }
+   *     },
+   *     {
+   *       "tag": "link",
+   *       "attributes": {
+   *         "href": "URL_TO_ASSET",
+   *         "rel": "stylesheet"
+   *       }
+   *     }
+   *   ]
+   * }
+   * </pre>
+   *
+   * Update render settings for a screen
    *
    * @throws {RequiredError}
    */
   async updateRendering(
     requestParameters: PatchRenderingOperationRequest,
     bodyParameters: PatchRenderingRequest,
     initOverrides?: InitOverride
-  ): Promise<ApiResponse<void>> {
+  ): Promise<ApiResponse<PatchRendering200Response>> {
     runtime.validateRequiredRequestParams(requestParameters, ['prompt', 'screen']);
 
     const headerParameters: runtime.HTTPHeaders = {};
@@ -169,7 +198,7 @@ export class PromptsManager extends BaseAPI {
       initOverrides
     );
 
-    return runtime.VoidApiResponse.fromResponse(response);
+    return runtime.JSONApiResponse.fromResponse(response);
   }
 
   /**
diff --git a/src/management/__generated/models/index.ts b/src/management/__generated/models/index.ts

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ const { BaseAPI } = runtime;`
`17`	`17`	`*/`
`18`	`18`	`export class EmailTemplatesManager extends BaseAPI {`
`19`	`19`	`/**`
`20`		- * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
	`20`	+ * Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
`21`	`21`	`* Get an email template`
`22`	`22`	`*`
`23`	`23`	`* @throws {RequiredError}`