@whop/sdk 0.0.5 → 0.0.6

package/src/client.ts

@@ -170,6 +170,11 @@ import {
   MessageUpdateParams,
   Messages,
 } from './resources/messages';
+import {
+  NotificationCreateParams,
+  NotificationCreateResponse,
+  Notifications,
+} from './resources/notifications';
 import {
   BillingReasons,
   CardBrands,
@@ -293,9 +298,9 @@ export interface ClientOptions {
   webhookKey?: string | null | undefined;
 
   /**
-   * Defaults to process.env['WHOP_APP_ID'].
+   * When using the SDK in app mode pass this parameter to allow verifying user tokens
    */
-  appID?: string | undefined;
+  appID?: string | null | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -372,7 +377,7 @@ export interface ClientOptions {
 export class Whop {
   apiKey: string;
   webhookKey: string | null;
-  appID: string;
+  appID: string | null;
 
   baseURL: string;
   maxRetries: number;
@@ -391,7 +396,7 @@ export class Whop {
    *
    * @param {string | undefined} [opts.apiKey=process.env['WHOP_API_KEY'] ?? undefined]
    * @param {string | null | undefined} [opts.webhookKey=process.env['WHOP_WEBHOOK_SECRET'] ?? null]
-   * @param {string | undefined} [opts.appID=process.env['WHOP_APP_ID'] ?? undefined]
+   * @param {string | null | undefined} [opts.appID=process.env['WHOP_APP_ID'] ?? null]
    * @param {string} [opts.baseURL=process.env['WHOP_BASE_URL'] ?? https://api.whop.com/api/v1] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -404,7 +409,7 @@ export class Whop {
     baseURL = readEnv('WHOP_BASE_URL'),
     apiKey = readEnv('WHOP_API_KEY'),
     webhookKey = readEnv('WHOP_WEBHOOK_SECRET') ?? null,
-    appID = readEnv('WHOP_APP_ID'),
+    appID = readEnv('WHOP_APP_ID') ?? null,
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
@@ -412,11 +417,6 @@ export class Whop {
         "The WHOP_API_KEY environment variable is missing or empty; either provide it, or instantiate the Whop client with an apiKey option, like new Whop({ apiKey: 'My API Key' }).",
       );
     }
-    if (appID === undefined) {
-      throw new Errors.WhopError(
-        "The WHOP_APP_ID environment variable is missing or empty; either provide it, or instantiate the Whop client with an appID option, like new Whop({ appID: 'app_xxxxxxxxxxxxxx' }).",
-      );
-    }
 
     const options: ClientOptions = {
       apiKey,
@@ -1030,6 +1030,7 @@ export class Whop {
   reviews: API.Reviews = new API.Reviews(this);
   courseStudents: API.CourseStudents = new API.CourseStudents(this);
   accessTokens: API.AccessTokens = new API.AccessTokens(this);
+  notifications: API.Notifications = new API.Notifications(this);
 }
 
 Whop.Apps = Apps;
@@ -1064,6 +1065,7 @@ Whop.CourseLessons = CourseLessons;
 Whop.Reviews = Reviews;
 Whop.CourseStudents = CourseStudents;
 Whop.AccessTokens = AccessTokens;
+Whop.Notifications = Notifications;
 
 export declare namespace Whop {
   export type RequestOptions = Opts.RequestOptions;
@@ -1363,6 +1365,12 @@ export declare namespace Whop {
     type AccessTokenCreateParams as AccessTokenCreateParams,
   };
 
+  export {
+    Notifications as Notifications,
+    type NotificationCreateResponse as NotificationCreateResponse,
+    type NotificationCreateParams as NotificationCreateParams,
+  };
+
   export type AccessLevel = API.AccessLevel;
   export type AccessPassType = API.AccessPassType;
   export type App = API.App;

package/src/lib/verify-user-token.ts

@@ -55,13 +55,16 @@ export interface VerifyUserTokenOptions<DontThrow extends boolean = false> {
 }
 
 export function makeUserTokenVerifierFromSdk(client: Whop) {
-  const baseOptions: VerifyUserTokenOptions<false> = {
-    appId: client.appID,
-  };
   return async function verifyUserToken<DT extends boolean = false>(
     tokenOrHeadersOrRequest: string | Headers | Request | null | undefined,
     options?: Partial<VerifyUserTokenOptions<DT>>,
   ) {
+    if (!client.appID) {
+      throw Error('You must set appID in the Whop client constructor if you want to verify user tokens.');
+    }
+    const baseOptions: VerifyUserTokenOptions<false> = {
+      appId: client.appID,
+    };
     return await internalVerifyUserToken<DT>(tokenOrHeadersOrRequest, {
       ...baseOptions,
       ...options,

package/src/resources/index.ts

@@ -157,6 +157,11 @@ export {
   type MessageListParams,
   type MessageListResponsesCursorPage,
 } from './messages';
+export {
+  Notifications,
+  type NotificationCreateResponse,
+  type NotificationCreateParams,
+} from './notifications';
 export {
   Payments,
   type BillingReasons,

package/src/resources/notifications.ts

@@ -0,0 +1,131 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Notifications extends APIResource {
+  /**
+   * Queues a notification to be sent to users in an experience or company team
+   *
+   * @example
+   * ```ts
+   * const notification = await client.notifications.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   content: 'content',
+   *   title: 'title',
+   * });
+   * ```
+   */
+  create(body: NotificationCreateParams, options?: RequestOptions): APIPromise<NotificationCreateResponse> {
+    return this._client.post('/notifications', { body, ...options });
+  }
+}
+
+/**
+ * Response from queuing a notification
+ */
+export interface NotificationCreateResponse {
+  /**
+   * Whether the notification was successfully queued for delivery
+   */
+  success: boolean;
+}
+
+export type NotificationCreateParams =
+  | NotificationCreateParams.SendNotificationV2InputWithCompanyID
+  | NotificationCreateParams.SendNotificationV2InputWithExperienceID;
+
+export declare namespace NotificationCreateParams {
+  export interface SendNotificationV2InputWithCompanyID {
+    /**
+     * The id of the company to target. Only team members of this company will receive
+     * the notification. When clicked will take the user to your dashboard app view.
+     */
+    company_id: string;
+
+    /**
+     * The content of the notification
+     */
+    content: string;
+
+    /**
+     * The title of the notification
+     */
+    title: string;
+
+    /**
+     * Optional: ID of a Whop user whose profile picture will be used as the
+     * notification icon. If not provided, defaults to the experience or company
+     * avatar.
+     */
+    icon_user_id?: string | null;
+
+    /**
+     * The rest path to append to the generated deep link that opens your app. Use
+     * [restPath] in your app path in the dashboard to read this parameter.
+     */
+    rest_path?: string | null;
+
+    /**
+     * The subtitle of the notification
+     */
+    subtitle?: string | null;
+
+    /**
+     * If provided, this will only send to these users if they are also in the main
+     * scope (experience or company)
+     */
+    user_ids?: Array<string> | null;
+  }
+
+  export interface SendNotificationV2InputWithExperienceID {
+    /**
+     * The content of the notification
+     */
+    content: string;
+
+    /**
+     * The id of the experience to target. All users with access to this experience
+     * (customers and admins) will receive the notification. When clicked, open your
+     * experience view.
+     */
+    experience_id: string;
+
+    /**
+     * The title of the notification
+     */
+    title: string;
+
+    /**
+     * Optional: ID of a Whop user whose profile picture will be used as the
+     * notification icon. If not provided, defaults to the experience or company
+     * avatar.
+     */
+    icon_user_id?: string | null;
+
+    /**
+     * The rest path to append to the generated deep link that opens your app. Use
+     * [restPath] in your app path in the dashboard to read this parameter.
+     */
+    rest_path?: string | null;
+
+    /**
+     * The subtitle of the notification
+     */
+    subtitle?: string | null;
+
+    /**
+     * If provided, this will only send to these users if they are also in the main
+     * scope (experience or company)
+     */
+    user_ids?: Array<string> | null;
+  }
+}
+
+export declare namespace Notifications {
+  export {
+    type NotificationCreateResponse as NotificationCreateResponse,
+    type NotificationCreateParams as NotificationCreateParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.5'; // x-release-please-version
+export const VERSION = '0.0.6'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.5";
+export declare const VERSION = "0.0.6";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.5";
+export declare const VERSION = "0.0.6";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.5'; // x-release-please-version
+exports.VERSION = '0.0.6'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.5'; // x-release-please-version
+export const VERSION = '0.0.6'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map