@whop/sdk 0.0.26 → 0.0.28

package/resources/notifications.d.mts

@@ -3,7 +3,8 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Notifications extends APIResource {
     /**
-     * Queues a notification to be sent to users in an experience or company team
+     * Send a push notification to users in an experience or company team. The
+     * notification is processed asynchronously and supports targeting specific users.
      *
      * Required permissions:
      *
@@ -33,72 +34,79 @@ export type NotificationCreateParams = NotificationCreateParams.SendNotification
 export declare namespace NotificationCreateParams {
     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.
+         * The unique identifier of the company to target. Only team members of this
+         * company will receive the notification. Clicking the notification opens your
+         * dashboard app view.
          */
         company_id: string;
         /**
-         * The content of the notification
+         * The main body text of the notification displayed to the user.
          */
         content: string;
         /**
-         * The title of the notification
+         * The headline text of the notification, displayed prominently to the user.
          */
         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.
+         * The unique identifier of a user whose profile picture will be used as the
+         * notification icon. Defaults to the experience or company avatar when not
+         * provided.
          */
         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.
+         * A path segment appended to the generated deep link that opens your app. Use
+         * [restPath] in your app path configuration to read this parameter. For example,
+         * '/settings/billing'.
          */
         rest_path?: string | null;
         /**
-         * The subtitle of the notification
+         * An optional secondary line of text displayed below the title in 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)
+         * An optional list of user IDs to narrow the audience. When provided, only these
+         * users receive the notification, provided they are in the targeted experience or
+         * company.
          */
         user_ids?: Array<string> | null;
     }
     interface SendNotificationV2InputWithExperienceID {
         /**
-         * The content of the notification
+         * The main body text of the notification displayed to the user.
          */
         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
+         * The unique identifier of the experience to target. All users with access to this
+         * experience will receive the notification. Clicking the notification opens the
          * experience view.
          */
         experience_id: string;
         /**
-         * The title of the notification
+         * The headline text of the notification, displayed prominently to the user.
          */
         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.
+         * The unique identifier of a user whose profile picture will be used as the
+         * notification icon. Defaults to the experience or company avatar when not
+         * provided.
          */
         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.
+         * A path segment appended to the generated deep link that opens your app. Use
+         * [restPath] in your app path configuration to read this parameter. For example,
+         * '/settings/billing'.
          */
         rest_path?: string | null;
         /**
-         * The subtitle of the notification
+         * An optional secondary line of text displayed below the title in 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)
+         * An optional list of user IDs to narrow the audience. When provided, only these
+         * users receive the notification, provided they are in the targeted experience or
+         * company.
          */
         user_ids?: Array<string> | null;
     }

package/resources/notifications.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.mts","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGzG;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,wBAAwB,GAChC,wBAAwB,CAAC,oCAAoC,GAC7D,wBAAwB,CAAC,uCAAuC,CAAC;AAErE,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,UAAiB,oCAAoC;QACnD;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,uCAAuC;QACtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"notifications.d.mts","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGzG;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,wBAAwB,GAChC,wBAAwB,CAAC,oCAAoC,GAC7D,wBAAwB,CAAC,uCAAuC,CAAC;AAErE,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,UAAiB,oCAAoC;QACnD;;;;WAIG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,uCAAuC;QACtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/notifications.d.ts

@@ -3,7 +3,8 @@ import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Notifications extends APIResource {
     /**
-     * Queues a notification to be sent to users in an experience or company team
+     * Send a push notification to users in an experience or company team. The
+     * notification is processed asynchronously and supports targeting specific users.
      *
      * Required permissions:
      *
@@ -33,72 +34,79 @@ export type NotificationCreateParams = NotificationCreateParams.SendNotification
 export declare namespace NotificationCreateParams {
     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.
+         * The unique identifier of the company to target. Only team members of this
+         * company will receive the notification. Clicking the notification opens your
+         * dashboard app view.
          */
         company_id: string;
         /**
-         * The content of the notification
+         * The main body text of the notification displayed to the user.
          */
         content: string;
         /**
-         * The title of the notification
+         * The headline text of the notification, displayed prominently to the user.
          */
         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.
+         * The unique identifier of a user whose profile picture will be used as the
+         * notification icon. Defaults to the experience or company avatar when not
+         * provided.
          */
         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.
+         * A path segment appended to the generated deep link that opens your app. Use
+         * [restPath] in your app path configuration to read this parameter. For example,
+         * '/settings/billing'.
          */
         rest_path?: string | null;
         /**
-         * The subtitle of the notification
+         * An optional secondary line of text displayed below the title in 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)
+         * An optional list of user IDs to narrow the audience. When provided, only these
+         * users receive the notification, provided they are in the targeted experience or
+         * company.
          */
         user_ids?: Array<string> | null;
     }
     interface SendNotificationV2InputWithExperienceID {
         /**
-         * The content of the notification
+         * The main body text of the notification displayed to the user.
          */
         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
+         * The unique identifier of the experience to target. All users with access to this
+         * experience will receive the notification. Clicking the notification opens the
          * experience view.
          */
         experience_id: string;
         /**
-         * The title of the notification
+         * The headline text of the notification, displayed prominently to the user.
          */
         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.
+         * The unique identifier of a user whose profile picture will be used as the
+         * notification icon. Defaults to the experience or company avatar when not
+         * provided.
          */
         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.
+         * A path segment appended to the generated deep link that opens your app. Use
+         * [restPath] in your app path configuration to read this parameter. For example,
+         * '/settings/billing'.
          */
         rest_path?: string | null;
         /**
-         * The subtitle of the notification
+         * An optional secondary line of text displayed below the title in 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)
+         * An optional list of user IDs to narrow the audience. When provided, only these
+         * users receive the notification, provided they are in the targeted experience or
+         * company.
          */
         user_ids?: Array<string> | null;
     }

package/resources/notifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGzG;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,wBAAwB,GAChC,wBAAwB,CAAC,oCAAoC,GAC7D,wBAAwB,CAAC,uCAAuC,CAAC;AAErE,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,UAAiB,oCAAoC;QACnD;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,uCAAuC;QACtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGzG;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,wBAAwB,GAChC,wBAAwB,CAAC,oCAAoC,GAC7D,wBAAwB,CAAC,uCAAuC,CAAC;AAErE,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,UAAiB,oCAAoC;QACnD;;;;WAIG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;IAED,UAAiB,uCAAuC;QACtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACjC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/notifications.js

@@ -5,7 +5,8 @@ exports.Notifications = void 0;
 const resource_1 = require("../core/resource.js");
 class Notifications extends resource_1.APIResource {
     /**
-     * Queues a notification to be sent to users in an experience or company team
+     * Send a push notification to users in an experience or company team. The
+     * notification is processed asynchronously and supports targeting specific users.
      *
      * Required permissions:
      *

package/resources/notifications.js.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AApBD,sCAoBC"}
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AArBD,sCAqBC"}

package/resources/notifications.mjs

@@ -2,7 +2,8 @@
 import { APIResource } from "../core/resource.mjs";
 export class Notifications extends APIResource {
     /**
-     * Queues a notification to be sent to users in an experience or company team
+     * Send a push notification to users in an experience or company team. The
+     * notification is processed asynchronously and supports targeting specific users.
      *
      * Required permissions:
      *

package/resources/notifications.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}
+{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}