@whop/sdk 0.0.25 → 0.0.27

package/src/resources/course-lessons.ts

@@ -178,7 +178,7 @@ export type EmbedType = 'youtube' | 'loom';
  */
 export interface Lesson {
   /**
-   * The ID of the lesson
+   * The unique identifier for the lesson.
    */
   id: string;
 
@@ -198,7 +198,7 @@ export interface Lesson {
   content: string | null;
 
   /**
-   * The timestamp of when the lesson was created
+   * The datetime the lesson was created.
    */
   created_at: string;
 
@@ -260,7 +260,7 @@ export namespace Lesson {
    */
   export interface AssessmentQuestion {
     /**
-     * The ID of the assessment question
+     * The unique identifier for the assessment question.
      */
     id: string;
 
@@ -271,7 +271,7 @@ export namespace Lesson {
     correct_answer: string | null;
 
     /**
-     * When the question was created
+     * The datetime the assessment question was created.
      */
     created_at: string;
 
@@ -333,7 +333,7 @@ export namespace Lesson {
      */
     export interface Option {
       /**
-       * The ID of the assessment question option
+       * The unique identifier for the assessment question option.
        */
       id: string;
 
@@ -423,7 +423,7 @@ export namespace Lesson {
    */
   export interface VideoAsset {
     /**
-     * The ID of the Mux asset
+     * The unique identifier for the mux asset.
      */
     id: string;
 
@@ -438,7 +438,7 @@ export namespace Lesson {
     audio_only: boolean;
 
     /**
-     * The time at which the Mux asset was created
+     * The datetime the mux asset was created.
      */
     created_at: string;
 
@@ -483,7 +483,7 @@ export namespace Lesson {
     status: 'uploading' | 'created' | 'ready';
 
     /**
-     * The time at which the Mux asset was last updated
+     * The datetime the mux asset was last updated.
      */
     updated_at: string;
   }
@@ -505,7 +505,7 @@ export type LessonVisibilities = 'visible' | 'hidden';
  */
 export interface CourseLessonListResponse {
   /**
-   * The ID of the lesson
+   * The unique identifier for the lesson.
    */
   id: string;
 
@@ -515,7 +515,7 @@ export interface CourseLessonListResponse {
   content: string | null;
 
   /**
-   * The timestamp of when the lesson was created
+   * The datetime the lesson was created.
    */
   created_at: string;
 
@@ -594,12 +594,12 @@ export type CourseLessonStartResponse = boolean;
  */
 export interface CourseLessonSubmitAssessmentResponse {
   /**
-   * The ID of the assessment result
+   * The unique identifier for the assessment result.
    */
   id: string;
 
   /**
-   * When the assessment was taken
+   * The datetime the assessment result was created.
    */
   created_at: string;
 
@@ -639,7 +639,7 @@ export interface CourseLessonSubmitAssessmentResponse {
   score_percent: number;
 
   /**
-   * When the assessment result was last updated
+   * The datetime the assessment result was last updated.
    */
   updated_at: string;
 
@@ -655,7 +655,7 @@ export namespace CourseLessonSubmitAssessmentResponse {
    */
   export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
 
@@ -670,7 +670,7 @@ export namespace CourseLessonSubmitAssessmentResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/course-students.ts

@@ -45,7 +45,7 @@ export type CourseStudentListResponsesCursorPage = CursorPage<CourseStudentListR
  */
 export interface CourseStudentRetrieveResponse {
   /**
-   * The ID of the course student. Looks like crsi_XXX
+   * The unique identifier for the course student type.
    */
   id: string;
 
@@ -91,7 +91,7 @@ export namespace CourseStudentRetrieveResponse {
    */
   export interface Course {
     /**
-     * The ID of the course. Looks like cors_XXX
+     * The unique identifier for the course.
      */
     id: string;
 
@@ -112,7 +112,7 @@ export namespace CourseStudentRetrieveResponse {
      */
     export interface Experience {
       /**
-       * The unique ID representing this experience
+       * The unique identifier for the experience.
        */
       id: string;
     }
@@ -123,7 +123,7 @@ export namespace CourseStudentRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -144,7 +144,7 @@ export namespace CourseStudentRetrieveResponse {
  */
 export interface CourseStudentListResponse {
   /**
-   * The ID of the course student. Looks like crsi_XXX
+   * The unique identifier for the course student type.
    */
   id: string;
 
@@ -185,7 +185,7 @@ export namespace CourseStudentListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/courses.ts

@@ -115,7 +115,7 @@ export type CourseListResponsesCursorPage = CursorPage<CourseListResponse>;
  */
 export interface Course {
   /**
-   * The ID of the course. Looks like cors_XXX
+   * The unique identifier for the course.
    */
   id: string;
 
@@ -136,7 +136,7 @@ export interface Course {
   cover_image: string | null;
 
   /**
-   * The timestamp of when the course was created
+   * The datetime the course was created.
    */
   created_at: string;
 
@@ -178,7 +178,7 @@ export interface Course {
   title: string | null;
 
   /**
-   * The timestamp of when the course was last updated
+   * The datetime the course was last updated.
    */
   updated_at: string;
 
@@ -195,7 +195,7 @@ export namespace Course {
    */
   export interface Chapter {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
 
@@ -221,7 +221,7 @@ export namespace Course {
      */
     export interface Lesson {
       /**
-       * The ID of the lesson
+       * The unique identifier for the lesson.
        */
       id: string;
 
@@ -356,7 +356,7 @@ export type Languages =
  */
 export interface CourseListResponse {
   /**
-   * The ID of the course. Looks like cors_XXX
+   * The unique identifier for the course.
    */
   id: string;
 
@@ -372,7 +372,7 @@ export interface CourseListResponse {
   cover_image: string | null;
 
   /**
-   * The timestamp of when the course was created
+   * The datetime the course was created.
    */
   created_at: string;
 
@@ -414,7 +414,7 @@ export interface CourseListResponse {
   title: string | null;
 
   /**
-   * The timestamp of when the course was last updated
+   * The datetime the course was last updated.
    */
   updated_at: string;
 

package/src/resources/disputes.ts

@@ -90,11 +90,12 @@ export class Disputes extends APIResource {
 export type DisputeListResponsesCursorPage = CursorPage<DisputeListResponse>;
 
 /**
- * An object representing a dispute against a company.
+ * A dispute is a chargeback or payment challenge filed against a company,
+ * including evidence and response status.
  */
 export interface Dispute {
   /**
-   * The internal ID of the dispute.
+   * The unique identifier for the dispute.
    */
   id: string;
 
@@ -129,7 +130,7 @@ export interface Dispute {
   company: Dispute.Company | null;
 
   /**
-   * When it was made.
+   * The datetime the dispute was created.
    */
   created_at: string | null;
 
@@ -265,7 +266,7 @@ export namespace Dispute {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -306,7 +307,7 @@ export namespace Dispute {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
 
@@ -326,7 +327,7 @@ export namespace Dispute {
     card_last4: string | null;
 
     /**
-     * The datetime the payment was created
+     * The datetime the payment was created.
      */
     created_at: string;
 
@@ -387,7 +388,7 @@ export namespace Dispute {
      */
     export interface Member {
       /**
-       * The ID of the member
+       * The unique identifier for the company member.
        */
       id: string;
 
@@ -402,7 +403,7 @@ export namespace Dispute {
      */
     export interface Membership {
       /**
-       * The internal ID of the membership.
+       * The unique identifier for the membership.
        */
       id: string;
 
@@ -417,7 +418,7 @@ export namespace Dispute {
      */
     export interface User {
       /**
-       * The internal ID of the user.
+       * The unique identifier for the user.
        */
       id: string;
 
@@ -443,7 +444,7 @@ export namespace Dispute {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -453,7 +454,7 @@ export namespace Dispute {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -531,11 +532,12 @@ export type DisputeStatuses =
   | 'other';
 
 /**
- * An object representing a dispute against a company.
+ * A dispute is a chargeback or payment challenge filed against a company,
+ * including evidence and response status.
  */
 export interface DisputeListResponse {
   /**
-   * The internal ID of the dispute.
+   * The unique identifier for the dispute.
    */
   id: string;
 
@@ -550,7 +552,7 @@ export interface DisputeListResponse {
   company: DisputeListResponse.Company | null;
 
   /**
-   * When it was made.
+   * The datetime the dispute was created.
    */
   created_at: string | null;
 
@@ -606,7 +608,7 @@ export namespace DisputeListResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -621,7 +623,7 @@ export namespace DisputeListResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
   }
@@ -631,7 +633,7 @@ export namespace DisputeListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -641,7 +643,7 @@ export namespace DisputeListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 

package/src/resources/dm-channels.ts

@@ -0,0 +1,212 @@
+// 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 { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class DmChannels extends APIResource {
+  /**
+   * Creates a DM channel
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.create({
+   *   with_user_ids: ['string'],
+   * });
+   * ```
+   */
+  create(body: DmChannelCreateParams, options?: RequestOptions): APIPromise<DmChannel> {
+    return this._client.post('/dm_channels', { body, ...options });
+  }
+
+  /**
+   * Retrieves a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:read`
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DmChannel> {
+    return this._client.get(path`/dm_channels/${id}`, options);
+  }
+
+  /**
+   * Updates a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.update('id');
+   * ```
+   */
+  update(
+    id: string,
+    body: DmChannelUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DmChannel> {
+    return this._client.patch(path`/dm_channels/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists DM channels for the current user
+   *
+   * Required permissions:
+   *
+   * - `dms:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const dmChannelListResponse of client.dmChannels.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: DmChannelListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DmChannelListResponsesCursorPage, DmChannelListResponse> {
+    return this._client.getAPIList('/dm_channels', CursorPage<DmChannelListResponse>, { query, ...options });
+  }
+
+  /**
+   * Deletes a DM channel
+   *
+   * Required permissions:
+   *
+   * - `dms:channel:manage`
+   *
+   * @example
+   * ```ts
+   * const dmChannel = await client.dmChannels.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<DmChannelDeleteResponse> {
+    return this._client.delete(path`/dm_channels/${id}`, options);
+  }
+}
+
+export type DmChannelListResponsesCursorPage = CursorPage<DmChannelListResponse>;
+
+/**
+ * Represents a DM channel
+ */
+export interface DmChannel {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The time the entity was created (in milliseconds since Unix epoch)
+   */
+  created_at: string;
+
+  /**
+   * When the last message was sent
+   */
+  last_message_at: string | null;
+
+  /**
+   * The custom name of the DM channel, if any
+   */
+  name: string | null;
+}
+
+/**
+ * Represents a DM channel
+ */
+export interface DmChannelListResponse {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * The time the entity was created (in milliseconds since Unix epoch)
+   */
+  created_at: string;
+
+  /**
+   * When the last message was sent
+   */
+  last_message_at: string | null;
+
+  /**
+   * The custom name of the DM channel, if any
+   */
+  name: string | null;
+}
+
+/**
+ * Represents `true` or `false` values.
+ */
+export type DmChannelDeleteResponse = boolean;
+
+export interface DmChannelCreateParams {
+  /**
+   * The user ids to create a DM with. Can be email, username or user_id (tag)
+   */
+  with_user_ids: Array<string>;
+
+  /**
+   * The ID of the company to scope this DM channel to.
+   */
+  company_id?: string | null;
+
+  /**
+   * The custom name for the DM channel
+   */
+  custom_name?: string | null;
+}
+
+export interface DmChannelUpdateParams {
+  /**
+   * The custom name for the DM channel
+   */
+  custom_name?: string | null;
+}
+
+export interface DmChannelListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Filter DM channels scoped to a specific company
+   */
+  company_id?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+}
+
+export declare namespace DmChannels {
+  export {
+    type DmChannel as DmChannel,
+    type DmChannelListResponse as DmChannelListResponse,
+    type DmChannelDeleteResponse as DmChannelDeleteResponse,
+    type DmChannelListResponsesCursorPage as DmChannelListResponsesCursorPage,
+    type DmChannelCreateParams as DmChannelCreateParams,
+    type DmChannelUpdateParams as DmChannelUpdateParams,
+    type DmChannelListParams as DmChannelListParams,
+  };
+}