@whop/sdk 0.0.4 → 0.0.6

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/resources/payments.ts

@@ -364,7 +364,7 @@ export interface PaymentListResponse {
   plan: PaymentListResponse.Plan | null;
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   product: PaymentListResponse.Product | null;
 
@@ -535,7 +535,7 @@ export namespace PaymentListResponse {
   }
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   export interface Product {
     /**

package/src/resources/plans.ts

@@ -118,7 +118,9 @@ export class Plans extends APIResource {
 export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
 
 /**
- * An object representing a (sanitized) plan of an access pass.
+ * A plan for an product. Plans define the core parameters that define a checkout
+ * and payment on whop. Use plans to create different ways to price your products
+ * (Eg renewal / one_time)
  */
 export interface PlanListResponse {
   /**
@@ -187,7 +189,7 @@ export interface PlanListResponse {
   plan_type: Shared.PlanType;
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   product: PlanListResponse.Product | null;
 
@@ -290,7 +292,7 @@ export namespace PlanListResponse {
   }
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   export interface Product {
     /**
@@ -376,7 +378,7 @@ export interface PlanCreateParams {
   payment_method_configuration?: PlanCreateParams.PaymentMethodConfiguration | null;
 
   /**
-   * The type of plan that can be attached to an access pass
+   * The type of plan that can be attached to a product
    */
   plan_type?: Shared.PlanType | null;
 

package/src/resources/products.ts

@@ -172,7 +172,7 @@ export interface ProductCreateParams {
   global_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
@@ -192,7 +192,7 @@ export interface ProductCreateParams {
   member_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
@@ -253,7 +253,7 @@ export namespace ProductCreateParams {
     initial_price?: number | null;
 
     /**
-     * The type of plan that can be attached to an access pass
+     * The type of plan that can be attached to a product
      */
     plan_type?: Shared.PlanType | null;
 
@@ -376,7 +376,7 @@ export interface ProductUpdateParams {
   global_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 
@@ -396,7 +396,7 @@ export interface ProductUpdateParams {
   member_affiliate_percentage?: number | null;
 
   /**
-   * The different statuses of the global affiliate program for an access pass.
+   * The different statuses of the global affiliate program for a product.
    */
   member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
 

package/src/resources/promo-codes.ts

@@ -164,7 +164,7 @@ export interface PromoCode {
   one_per_customer: boolean;
 
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   product: PromoCode.Product | null;
 
@@ -216,7 +216,7 @@ export namespace PromoCode {
   }
 
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   export interface Product {
     /**
@@ -302,7 +302,7 @@ export interface PromoCodeListResponse {
   one_per_customer: boolean;
 
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   product: PromoCodeListResponse.Product | null;
 
@@ -339,7 +339,7 @@ export interface PromoCodeListResponse {
 
 export namespace PromoCodeListResponse {
   /**
-   * The access pass associated with the promo code.
+   * The product this promo code applies to
    */
   export interface Product {
     /**

package/src/resources/shared.ts

@@ -5,12 +5,13 @@ import * as PaymentsAPI from './payments';
 import { CursorPage } from '../core/pagination';
 
 /**
- * The access level a given user (or company) has to an access pass or company.
+ * The access level a given user (or company) has to a product or company.
  */
 export type AccessLevel = 'no_access' | 'admin' | 'customer';
 
 /**
- * The different types an access pass can be.
+ * The different types an product can be. Only use 'regular'. The rest are for
+ * internal use
  */
 export type AccessPassType = 'regular' | 'app' | 'experience_upsell' | 'api_only';
 
@@ -970,7 +971,7 @@ export interface Entry {
   plan: Entry.Plan | null;
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   product: Entry.Product | null;
 
@@ -1017,7 +1018,7 @@ export namespace Entry {
   }
 
   /**
-   * The access pass tied to this entry, if there is one.
+   * The product tied to this entry, if there is one.
    */
   export interface Product {
     /**
@@ -1102,10 +1103,9 @@ export interface Experience {
   order: string | null;
 
   /**
-   * The access passes that are associated with this experience. This should not be
-   * used unless you are trying to list all access passes the experience has, for
-   * some reason. You probably don't want to use this though and should be using
-   * accessPass.
+   * The products that this experience is attached to. This defines which set of
+   * customers have access and can view this experience. If empty, this experience is
+   * only visible to authorized users of the company
    */
   products: Array<Experience.Product>;
 }
@@ -1178,7 +1178,7 @@ export namespace Experience {
   }
 
   /**
-   * An object representing a (sanitized) access pass.
+   * Represents a product on whop. Use products to sell anything on the platform.
    */
   export interface Product {
     /**
@@ -1250,7 +1250,7 @@ export namespace Forum {
  */
 export interface ForumPost {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -1359,7 +1359,7 @@ export type FriendlyReceiptStatus =
   | 'canceled';
 
 /**
- * The different statuses of the global affiliate program for an access pass.
+ * The different statuses of the global affiliate program for a product.
  */
 export type GlobalAffiliateStatus = 'enabled' | 'disabled';
 
@@ -1852,7 +1852,7 @@ export type MembershipStatus =
  */
 export interface Message {
   /**
-   * The unique identifier for the entity
+   * The unique identifier of the resource.
    */
   id: string;
 
@@ -2122,7 +2122,7 @@ export interface Payment {
   plan: Payment.Plan | null;
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   product: Payment.Product | null;
 
@@ -2293,7 +2293,7 @@ export namespace Payment {
   }
 
   /**
-   * The access pass attached to this payment.
+   * The product this payment was made for
    */
   export interface Product {
     /**
@@ -2374,7 +2374,9 @@ export namespace Payment {
 }
 
 /**
- * An object representing a (sanitized) plan of an access pass.
+ * A plan for an product. Plans define the core parameters that define a checkout
+ * and payment on whop. Use plans to create different ways to price your products
+ * (Eg renewal / one_time)
  */
 export interface Plan {
   /**
@@ -2453,7 +2455,7 @@ export interface Plan {
   plan_type: PlanType;
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   product: Plan.Product | null;
 
@@ -2596,7 +2598,7 @@ export namespace Plan {
   }
 
   /**
-   * The access pass for the plan.
+   * The product that this plan belongs to.
    */
   export interface Product {
     /**
@@ -2612,12 +2614,12 @@ export namespace Plan {
 }
 
 /**
- * The type of plan that can be attached to an access pass
+ * The type of plan that can be attached to a product
  */
 export type PlanType = 'renewal' | 'one_time';
 
 /**
- * An object representing a (sanitized) access pass.
+ * Represents a product on whop. Use products to sell anything on the platform.
  */
 export interface Product {
   /**
@@ -2808,7 +2810,7 @@ export namespace Product {
 }
 
 /**
- * An object representing a (sanitized) access pass.
+ * Represents a product on whop. Use products to sell anything on the platform.
  */
 export interface ProductListItem {
   /**

package/src/resources/users.ts

@@ -91,6 +91,9 @@ export interface UserCheckAccessResponse {
 }
 
 export interface UserCheckAccessParams {
+  /**
+   * The ID (user_xxx) or username of the user
+   */
   id: string;
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.4'; // 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.4";
+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.4";
+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.4'; // 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.4'; // x-release-please-version
+export const VERSION = '0.0.6'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map