glitch-javascript-sdk 3.8.5 → 3.8.6

package/dist/index.d.ts

@@ -1937,6 +1937,35 @@ interface InfluencerPayoutQuery {
     orderBy?: "created_at" | "amount";
     orderDirection?: "asc" | "desc";
 }
+/** Delivery state for the authenticated user's registered email address. */
+type EmailDeliveryState = "healthy" | "suppressed";
+/** Recovery action selected by the API for the current suppression category. */
+type EmailDeliveryRecoveryAction = "none" | "self_service" | "change_email" | "contact_support";
+/** Self-service and fallback actions available for an email-delivery state. */
+interface EmailDeliveryRecovery {
+    allowed: boolean;
+    action: EmailDeliveryRecoveryAction;
+    requires_acknowledgement: boolean;
+    account_verified?: boolean;
+    change_email_path?: string;
+    support_path?: string;
+}
+/** Current delivery state for the authenticated user's registered email. */
+interface EmailDeliveryStatus {
+    state: EmailDeliveryState;
+    action_required: boolean;
+    email: string | null;
+    category: string | null;
+    provider: string | null;
+    suppressed_at: string | null;
+    display_reason: string | null;
+    recovery: EmailDeliveryRecovery;
+    restored_now?: boolean;
+}
+/** Explicit confirmation required to remove an eligible active suppression. */
+interface RestoreEmailDeliveryRequest {
+    acknowledged: true;
+}
 declare class Users {
     /**
      * List all the users.
@@ -1967,6 +1996,16 @@ declare class Users {
      * @returns promise
      */
     static me<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Gets the delivery and suppression state for the authenticated user's
+     * current registered email address.
+     */
+    static emailDeliveryStatus(): AxiosPromise<Response<EmailDeliveryStatus>>;
+    /**
+     * Removes an eligible active suppression for the authenticated user's
+     * current verified email address.
+     */
+    static restoreEmailDelivery(data: RestoreEmailDeliveryRequest): AxiosPromise<Response<EmailDeliveryStatus>>;
     /**
      * Gets the campaigns the users has been invited too.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "3.8.5",
+  "version": "3.8.6",
   "description": "Javascript SDK for Glitch",
   "publishConfig": {
     "access": "public"
@@ -13,7 +13,7 @@
   ],
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "node scripts/test-game-advertising-routes.cjs && node scripts/test-discord-media-routes.cjs",
+    "test": "node scripts/test-game-advertising-routes.cjs && node scripts/test-discord-media-routes.cjs && node scripts/test-user-email-delivery-routes.cjs",
     "build": "rm -Rf dist && rollup -c --bundleConfigAsCjs",
     "build-docs": "rm  -rf docs && typedoc  --tsconfig tsconfig.json src/"
   },

package/src/api/Users.ts

@@ -52,6 +52,40 @@ export interface InfluencerPayoutQuery {
     orderDirection?: "asc" | "desc";
 }
 
+/** Delivery state for the authenticated user's registered email address. */
+export type EmailDeliveryState = "healthy" | "suppressed";
+
+/** Recovery action selected by the API for the current suppression category. */
+export type EmailDeliveryRecoveryAction = "none" | "self_service" | "change_email" | "contact_support";
+
+/** Self-service and fallback actions available for an email-delivery state. */
+export interface EmailDeliveryRecovery {
+    allowed: boolean;
+    action: EmailDeliveryRecoveryAction;
+    requires_acknowledgement: boolean;
+    account_verified?: boolean;
+    change_email_path?: string;
+    support_path?: string;
+}
+
+/** Current delivery state for the authenticated user's registered email. */
+export interface EmailDeliveryStatus {
+    state: EmailDeliveryState;
+    action_required: boolean;
+    email: string | null;
+    category: string | null;
+    provider: string | null;
+    suppressed_at: string | null;
+    display_reason: string | null;
+    recovery: EmailDeliveryRecovery;
+    restored_now?: boolean;
+}
+
+/** Explicit confirmation required to remove an eligible active suppression. */
+export interface RestoreEmailDeliveryRequest {
+    acknowledged: true;
+}
+
 class Users {
 
     /**
@@ -94,6 +128,22 @@ class Users {
         return Requests.processRoute(UserRoutes.routes.me, {}, undefined, params);
     }
 
+    /**
+     * Gets the delivery and suppression state for the authenticated user's
+     * current registered email address.
+     */
+    public static emailDeliveryStatus(): AxiosPromise<Response<EmailDeliveryStatus>> {
+        return Requests.processRoute(UserRoutes.routes.emailDeliveryStatus);
+    }
+
+    /**
+     * Removes an eligible active suppression for the authenticated user's
+     * current verified email address.
+     */
+    public static restoreEmailDelivery(data: RestoreEmailDeliveryRequest): AxiosPromise<Response<EmailDeliveryStatus>> {
+        return Requests.processRoute(UserRoutes.routes.restoreEmailDelivery, data);
+    }
+
     /**
      * Gets the campaigns the users has been invited too.
      * 

package/src/routes/UserRoutes.ts

@@ -9,6 +9,8 @@ class UserRoutes {
     follow: { url: '/users/{user_id}/follow', method: HTTP_METHODS.POST },
     profile: { url: '/users/{user_id}/profile', method: HTTP_METHODS.GET },
     me: { url: '/users/me', method: HTTP_METHODS.GET },
+    emailDeliveryStatus: { url: '/users/me/email-delivery', method: HTTP_METHODS.GET },
+    restoreEmailDelivery: { url: '/users/me/email-delivery/restore', method: HTTP_METHODS.POST },
     syncInfluencer: { url: '/users/syncInfluencer', method: HTTP_METHODS.POST },
     generateInfluencerProfile: { url: '/users/generateInfluencerProfile', method: HTTP_METHODS.POST },
     oneTimeToken: { url: '/users/oneTimeToken', method: HTTP_METHODS.GET },