@whop/sdk 0.0.1-canary.0 → 0.0.2

package/src/resources/checkout-configurations.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class CheckoutConfigurations extends APIResource {
   /**
-   * Creates a new checkout session
+   * Creates a new checkout configuration
    *
    * Required permissions:
    *
@@ -80,48 +80,51 @@ export class CheckoutConfigurations extends APIResource {
 export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutConfigurationListResponse>;
 
 /**
- * A checkout session
+ * A checkout configuration object.
+ *         Can be used to create a reusable custom configuration for a checkout, including attaching plans, affiliates and custom metadata to the checkout.
+ *         This configuration can be re-used by multiple users.
+ *         All successful payments and memberships resulting from a checkout will contain the passed metadata.
  */
 export interface CheckoutConfigurationListResponse {
   /**
-   * The ID of the checkout session
+   * The ID of the checkout configuration
    */
   id: string;
 
   /**
-   * The affiliate code to use for the checkout session
+   * The affiliate code to use for the checkout configuration
    */
-  affiliate_code: string;
+  affiliate_code: string | null;
 
   /**
-   * The ID of the company to use for the checkout session
+   * The ID of the company to use for the checkout configuration
    */
   company_id: string;
 
   /**
-   * The metadata to use for the checkout session
+   * The metadata to use for the checkout configuration
    */
   metadata: { [key: string]: unknown };
 
   /**
-   * The plan to use for the checkout session
+   * The plan to use for the checkout configuration
    */
   plan: CheckoutConfigurationListResponse.Plan;
 
   /**
-   * The URL to redirect the user to after the checkout session is created
+   * The URL to redirect the user to after the checkout configuration is created
    */
   purchase_url: string;
 
   /**
-   * The URL to redirect the user to after the checkout session is created
+   * The URL to redirect the user to after the checkout configuration is created
    */
-  redirect_url: string;
+  redirect_url: string | null;
 }
 
 export namespace CheckoutConfigurationListResponse {
   /**
-   * The plan to use for the checkout session
+   * The plan to use for the checkout configuration
    */
   export interface Plan {
     /**
@@ -178,34 +181,34 @@ export namespace CheckoutConfigurationListResponse {
 
 export interface CheckoutConfigurationCreateParams {
   /**
-   * The affiliate code to use for the checkout session
+   * The affiliate code to use for the checkout configuration
    */
   affiliate_code?: string | null;
 
   /**
-   * The metadata to use for the checkout session
+   * The metadata to use for the checkout configuration
    */
   metadata?: { [key: string]: unknown } | null;
 
   /**
-   * Pass this object to create a new plan for this checkout session
+   * Pass this object to create a new plan for this checkout configuration
    */
   plan?: CheckoutConfigurationCreateParams.Plan | null;
 
   /**
-   * The ID of the plan to use for the checkout session
+   * The ID of the plan to use for the checkout configuration
    */
   plan_id?: string | null;
 
   /**
-   * The URL to redirect the user to after the checkout session is created
+   * The URL to redirect the user to after the checkout configuration is created
    */
   redirect_url?: string | null;
 }
 
 export namespace CheckoutConfigurationCreateParams {
   /**
-   * Pass this object to create a new plan for this checkout session
+   * Pass this object to create a new plan for this checkout configuration
    */
   export interface Plan {
     /**

package/src/resources/experiences.ts

@@ -166,6 +166,11 @@ export interface ExperienceListResponse {
    */
   created_at: string;
 
+  /**
+   * The logo for the experience.
+   */
+  image: ExperienceListResponse.Image | null;
+
   /**
    * The written name of the description.
    */
@@ -187,12 +192,32 @@ export namespace ExperienceListResponse {
      */
     id: string;
 
+    /**
+     * The icon for the app. This icon is shown on discovery, on the product page, on
+     * checkout, and as a default icon for the experiences.
+     */
+    icon: App.Icon | null;
+
     /**
      * The name of the app
      */
     name: string;
   }
 
+  export namespace App {
+    /**
+     * The icon for the app. This icon is shown on discovery, on the product page, on
+     * checkout, and as a default icon for the experiences.
+     */
+    export interface Icon {
+      /**
+       * This is the URL you use to render optimized attachments on the client. This
+       * should be used for apps.
+       */
+      url: string | null;
+    }
+  }
+
   /**
    * The company that owns this experience.
    */
@@ -212,6 +237,17 @@ export namespace ExperienceListResponse {
      */
     title: string;
   }
+
+  /**
+   * The logo for the experience.
+   */
+  export interface Image {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
 }
 
 /**

package/src/resources/forums.ts

@@ -0,0 +1,152 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Forums extends APIResource {
+  /**
+   * Retrieves a forum
+   *
+   * Required permissions:
+   *
+   * - `forum:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Forum> {
+    return this._client.get(path`/forums/${id}`, options);
+  }
+
+  /**
+   * Updates a forum
+   *
+   * Required permissions:
+   *
+   * - `forum:moderate`
+   */
+  update(
+    id: string,
+    body: ForumUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.Forum> {
+    return this._client.patch(path`/forums/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists forums inside a company
+   *
+   * Required permissions:
+   *
+   * - `forum:read`
+   */
+  list(
+    query: ForumListParams,
+    options?: RequestOptions,
+  ): PagePromise<ForumListResponsesCursorPage, ForumListResponse> {
+    return this._client.getAPIList('/forums', CursorPage<ForumListResponse>, { query, ...options });
+  }
+}
+
+export type ForumListResponsesCursorPage = CursorPage<ForumListResponse>;
+
+/**
+ * Represents a forum feed
+ */
+export interface ForumListResponse {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The email notification preference for this forum
+   */
+  email_notification_preference: Shared.EmailNotificationPreferences;
+
+  /**
+   * The experience for this forum
+   */
+  experience: ForumListResponse.Experience;
+
+  /**
+   * Who can comment on this forum
+   */
+  who_can_comment: Shared.WhoCanCommentTypes;
+
+  /**
+   * Who can post on this forum
+   */
+  who_can_post: Shared.WhoCanPostTypes;
+}
+
+export namespace ForumListResponse {
+  /**
+   * The experience for this forum
+   */
+  export interface Experience {
+    /**
+     * The unique ID representing this experience
+     */
+    id: string;
+
+    /**
+     * The written name of the description.
+     */
+    name: string;
+  }
+}
+
+export interface ForumUpdateParams {
+  /**
+   * Email notification preference option for a forum feed
+   */
+  email_notification_preference?: Shared.EmailNotificationPreferences | null;
+
+  /**
+   * Who can comment on a forum feed
+   */
+  who_can_comment?: Shared.WhoCanCommentTypes | null;
+
+  /**
+   * Who can post on a forum feed
+   */
+  who_can_post?: Shared.WhoCanPostTypes | null;
+}
+
+export interface ForumListParams extends CursorPageParams {
+  /**
+   * The ID of the company to list forums for
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * If provided, only forums connected to this product are returned
+   */
+  product_id?: string | null;
+}
+
+export declare namespace Forums {
+  export {
+    type ForumListResponse as ForumListResponse,
+    type ForumListResponsesCursorPage as ForumListResponsesCursorPage,
+    type ForumUpdateParams as ForumUpdateParams,
+    type ForumListParams as ForumListParams,
+  };
+}

package/src/resources/index.ts

@@ -67,6 +67,13 @@ export {
   type ForumPostListParams,
   type ForumPostListResponsesCursorPage,
 } from './forum-posts';
+export {
+  Forums,
+  type ForumListResponse,
+  type ForumUpdateParams,
+  type ForumListParams,
+  type ForumListResponsesCursorPage,
+} from './forums';
 export {
   Invoices,
   type InvoiceCreateResponse,
@@ -75,6 +82,13 @@ export {
   type InvoiceListParams,
 } from './invoices';
 export { LedgerAccounts, type LedgerAccountRetrieveResponse } from './ledger-accounts';
+export {
+  Members,
+  type MemberRetrieveResponse,
+  type MemberListResponse,
+  type MemberListParams,
+  type MemberListResponsesCursorPage,
+} from './members';
 export {
   Memberships,
   type MembershipListResponse,
@@ -154,5 +168,15 @@ export {
   type InvoicePaidWebhookEvent,
   type InvoicePastDueWebhookEvent,
   type InvoiceVoidedWebhookEvent,
+  type MembershipActivatedWebhookEvent,
+  type MembershipDeactivatedWebhookEvent,
+  type EntryCreatedWebhookEvent,
+  type EntryApprovedWebhookEvent,
+  type EntryDeniedWebhookEvent,
+  type EntryDeletedWebhookEvent,
+  type CourseLessonInteractionCompletedWebhookEvent,
+  type PaymentSucceededWebhookEvent,
+  type PaymentFailedWebhookEvent,
+  type PaymentPendingWebhookEvent,
   type UnwrapWebhookEvent,
 } from './webhooks';

package/src/resources/invoices.ts

@@ -206,7 +206,9 @@ export namespace InvoiceCreateParams {
     expiration_days?: number | null;
 
     /**
-     * An additional amount charged upon first purchase.
+     * An additional amount charged upon first purchase. Use only if a one time payment
+     * OR you want to charge an additional amount on top of the renewal price. Provided
+     * as a number in dollars. Eg: 10.43 for $10.43
      */
     initial_price?: number | null;
 
@@ -226,7 +228,8 @@ export namespace InvoiceCreateParams {
     release_method?: Shared.ReleaseMethod | null;
 
     /**
-     * The amount the customer is charged every billing period.
+     * The amount the customer is charged every billing period. Use only if a recurring
+     * payment. Provided as a number in dollars. Eg: 10.43 for $10.43
      */
     renewal_price?: number | null;