Add support for the detect provider endpoint

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### Unreleased
+* Add support for the detect provider endpoint
+
 ### 6.11.1 / 2024-02-09
 * Fix issue where Graph events were returning 400 on update
 * Make comment param in rsvp optional

src/models/detect-provider-response.ts

@@ -0,0 +1,44 @@
+import Model from './model';
+import Attributes, { Attribute } from './attributes';
+
+export type DetectProviderResponseProperties = {
+ authName: string;
+ emailAddress: string;
+ detected: boolean;
+ providerName?: string;
+ isImap?: boolean;
+};
+
+export default class DetectProviderResponse extends Model
+ implements DetectProviderResponseProperties {
+ authName = '';
+ emailAddress = '';
+ detected = false;
+ provider?: string;
+ isImap?: boolean;
+ static attributes: Record<string, Attribute> = {
+ authName: Attributes.String({
+ modelKey: 'authName',
+ jsonKey: 'auth_name',
+ }),
+ emailAddress: Attributes.String({
+ modelKey: 'emailAddress',
+ jsonKey: 'email_address',
+ }),
+ detected: Attributes.Boolean({
+ modelKey: 'detected',
+ }),
+ provider: Attributes.String({
+ modelKey: 'provider',
+ }),
+ isImap: Attributes.Boolean({
+ modelKey: 'isImap',
+ jsonKey: 'is_imap',
+ }),
+ };
+
+ constructor(props?: DetectProviderResponseProperties) {
+ super();
+ this.initAttributes(props);
+ }
+}

src/nylas.ts

@@ -15,6 +15,7 @@
  ApplicationDetailsProperties,
 } from './models/application-details';
 import LoggingInterface from './models/LoggingInterface';
+import DetectProviderResponse from './models/detect-provider-response';
 
 class Nylas {
  static clientId = '';
@@ -212,6 +213,30 @@
  return url;
  }
 
+ /**
+ * Detect the provider for a given email address
+ * @param email The email address you want to check
+ * @return The response from the API containing the provider, if found
+ */
+ static detectProvider(email: string): Promise<DetectProviderResponse> {
+ const connection = new NylasConnection(null, { clientId: this.clientId });
+
+ return connection
+ .request({
+ method: 'POST',
+ path: '/connect/detect-provider',
+ body: {
+ client_id: this.clientId,
+ client_secret: this.clientSecret,
+ email_address: email,
+ },
+ })
+ .then(res => {
+ return new DetectProviderResponse().fromJSON(res);
+ })
+ .catch(err => Promise.reject(err));
+ }
+
  /**
  * Revoke a single access token
  * @param accessToken The access token to revoke