Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/customEmailProvider #1070

Merged
merged 2 commits into from
Jan 16, 2025
Merged

feature/customEmailProvider #1070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fe2fb6
SDK-5186 update api for custom email provider support
acwest Jan 6, 2025
d2e3fb1
fix tests for email provider
tusharpandey13 Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 82 additions & 8 deletions src/management/__generated/managers/emails-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,46 @@ 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. 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 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 the email provider
*
Expand Down Expand Up @@ -79,10 +115,48 @@ 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. 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>
* 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>
*
* Configure the email provider
*
Expand Down
15 changes: 9 additions & 6 deletions src/management/__generated/models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3783,7 +3783,7 @@
*/
export interface EmailProvider {
/**
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
*
*/
name: string;
Expand Down Expand Up @@ -3811,7 +3811,7 @@
*/
export interface EmailProviderCreate {
/**
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
*
*/
name: EmailProviderCreateNameEnum;
Expand Down Expand Up @@ -3844,6 +3844,7 @@
smtp: 'smtp',
azure_cs: 'azure_cs',
ms365: 'ms365',
custom: 'custom',
} as const;
export type EmailProviderCreateNameEnum =
(typeof EmailProviderCreateNameEnum)[keyof typeof EmailProviderCreateNameEnum];
Expand Down Expand Up @@ -3883,7 +3884,7 @@
*/
export interface EmailProviderUpdate {
/**
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, or `ms365`.
* Name of the email provider. Can be `mailgun`, `mandrill`, `sendgrid`, `ses`, `sparkpost`, `smtp`, `azure_cs`, `ms365`, or `custom`.
*
*/
name?: EmailProviderUpdateNameEnum;
Expand Down Expand Up @@ -3916,6 +3917,7 @@
smtp: 'smtp',
azure_cs: 'azure_cs',
ms365: 'ms365',
custom: 'custom',
} as const;
export type EmailProviderUpdateNameEnum =
(typeof EmailProviderUpdateNameEnum)[keyof typeof EmailProviderUpdateNameEnum];
Expand Down Expand Up @@ -4629,7 +4631,7 @@
version: string;
}
/**
* An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, password-reset-post-challenge</code>
* An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-email-provider, password-reset-post-challenge</code>
*/
export type GetActions200ResponseActionsInnerSupportedTriggersInnerId =
GetActions200ResponseActionsInnerSupportedTriggersInnerIdAnyOf;
Expand All @@ -4648,6 +4650,7 @@
iga_certification: 'iga-certification',
iga_fulfillment_assignment: 'iga-fulfillment-assignment',
iga_fulfillment_execution: 'iga-fulfillment-execution',
custom_email_provider: 'custom-email-provider',
password_reset_post_challenge: 'password-reset-post-challenge',
} as const;
export type GetActions200ResponseActionsInnerSupportedTriggersInnerIdAnyOf =
Expand Down Expand Up @@ -11844,7 +11847,7 @@
/**
*
*/
export interface PostFormsRequestNodesInnerAnyOf2ConfigComponentsInnerAnyOf2AnyOf13Config {}

Check warning on line 11850 in src/management/__generated/models/index.ts

View workflow job for this annotation

GitHub Actions / Build and Test (18.17) 

An empty interface is equivalent to `{}`

Check warning on line 11850 in src/management/__generated/models/index.ts

View workflow job for this annotation

GitHub Actions / Build and Test (20.3) 

An empty interface is equivalent to `{}`
/**
*
*/
Expand Down Expand Up @@ -16404,7 +16407,7 @@
*/
export interface GetBindingsRequest {
/**
* An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, password-reset-post-challenge</code>
* An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-email-provider, password-reset-post-challenge</code>
*
*/
triggerId: string;
Expand Down Expand Up @@ -16444,7 +16447,7 @@
*/
export interface PatchBindingsOperationRequest {
/**
* An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, password-reset-post-challenge</code>
* An actions extensibility point. Acceptable values: <code>post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-email-provider, password-reset-post-challenge</code>
*
*/
triggerId: string;
Expand Down
81 changes: 81 additions & 0 deletions test/management/email-provider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,87 @@ describe('EmailProviderManager', () => {
});
});

describe('#configure.custom', () => {
const data: PostProviderRequest = {
name: PostProviderRequestNameEnum.custom,
enabled: true,
default_from_address: 'from@test.com',
credentials: {},
};
const response = {
name: PostProviderRequestNameEnum.custom,
enabled: true,
default_from_address: 'from@test.com',
credentials: {},
};
let request: nock.Scope;

beforeEach(() => {
request = nock(API_URL)
.post('/emails/provider', data as any)
.reply(200, response);
});

it('should return a promise if no callback is given', (done) => {
emails.configure(data).then(done.bind(null, null)).catch(done.bind(null, null));
});

it('should pass any errors to the promise catch handler', (done) => {
nock.cleanAll();

nock(API_URL).post('/emails/provider').reply(500, {});

emails.configure(data).catch((err) => {
expect(err).toBeDefined();

done();
});
});

it('should perform a POST request to /api/v2/emails/provider', (done) => {
emails.configure(data).then(() => {
expect(request.isDone()).toBe(true);

done();
});
});

it('should pass the data in the body of the request', (done) => {
emails.configure(data).then(() => {
expect(request.isDone()).toBe(true);

done();
});
});

it('should pass the body of the response to the "then" handler', (done) => {
emails.configure(data).then((provider) => {
expect(provider.data.name).toBe(response.name);
expect(provider.data.enabled).toBe(response.enabled);
expect(provider.data.default_from_address).toBe(response.default_from_address);

expect(provider.data.credentials).toStrictEqual(response.credentials);

done();
});
});

it('should include the token in the Authorization header', (done) => {
nock.cleanAll();

const request = nock(API_URL)
.post('/emails/provider')
.matchHeader('Authorization', `Bearer ${token}`)
.reply(200, response);

emails.configure(data).then(() => {
expect(request.isDone()).toBe(true);

done();
});
});
});

describe('#update', () => {
const data: PatchProviderRequest = {
name: PatchProviderRequestNameEnum.smtp,
Expand Down
Loading