@whop/sdk 0.0.2 → 0.0.4

package/resources/course-chapters.d.ts

@@ -0,0 +1,185 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class CourseChapters extends APIResource {
+    /**
+     * Creates a new course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.create({
+     *   course_id: 'cors_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body: CourseChapterCreateParams, options?: RequestOptions): APIPromise<CourseChapter>;
+    /**
+     * Retrieves a course chapter by ID
+     *
+     * Required permissions:
+     *
+     * - `courses:read`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.retrieve(
+     *   'chap_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<CourseChapter>;
+    /**
+     * Updates a course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.update(
+     *   'chap_xxxxxxxxxxxxx',
+     *   { title: 'title' },
+     * );
+     * ```
+     */
+    update(id: string, body: CourseChapterUpdateParams, options?: RequestOptions): APIPromise<CourseChapter>;
+    /**
+     * Lists chapters for a course
+     *
+     * Required permissions:
+     *
+     * - `courses:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const courseChapterListResponse of client.courseChapters.list(
+     *   { course_id: 'cors_xxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: CourseChapterListParams, options?: RequestOptions): PagePromise<CourseChapterListResponsesCursorPage, CourseChapterListResponse>;
+    /**
+     * Deletes a course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.delete(
+     *   'chap_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<CourseChapterDeleteResponse>;
+}
+export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListResponse>;
+/**
+ * A chapter from the courses app
+ */
+export interface CourseChapter {
+    /**
+     * The ID of the chapter. Looks like chap_XXX
+     */
+    id: string;
+    /**
+     * The lessons in this chapter
+     */
+    lessons: Array<CourseChapter.Lesson>;
+    /**
+     * The order of the chapter within its course
+     */
+    order: number;
+    /**
+     * The title of the chapter
+     */
+    title: string;
+}
+export declare namespace CourseChapter {
+    /**
+     * A lesson from the courses app
+     */
+    interface Lesson {
+        /**
+         * The ID of the lesson
+         */
+        id: string;
+        /**
+         * The order of the lesson within its chapter
+         */
+        order: number;
+        /**
+         * The title of the lesson
+         */
+        title: string;
+    }
+}
+/**
+ * A chapter from the courses app
+ */
+export interface CourseChapterListResponse {
+    /**
+     * The ID of the chapter. Looks like chap_XXX
+     */
+    id: string;
+    /**
+     * The order of the chapter within its course
+     */
+    order: number;
+    /**
+     * The title of the chapter
+     */
+    title: string;
+}
+/**
+ * Represents `true` or `false` values.
+ */
+export type CourseChapterDeleteResponse = boolean;
+export interface CourseChapterCreateParams {
+    /**
+     * The ID of the course to create the chapter in
+     */
+    course_id: string;
+    /**
+     * The title of the chapter
+     */
+    title?: string | null;
+}
+export interface CourseChapterUpdateParams {
+    /**
+     * The title of the chapter
+     */
+    title: string;
+}
+export interface CourseChapterListParams extends CursorPageParams {
+    /**
+     * The ID of the course
+     */
+    course_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;
+}
+export declare namespace CourseChapters {
+    export { type CourseChapter as CourseChapter, type CourseChapterListResponse as CourseChapterListResponse, type CourseChapterDeleteResponse as CourseChapterDeleteResponse, type CourseChapterListResponsesCursorPage as CourseChapterListResponsesCursorPage, type CourseChapterCreateParams as CourseChapterCreateParams, type CourseChapterUpdateParams as CourseChapterUpdateParams, type CourseChapterListParams as CourseChapterListParams, };
+}
+//# sourceMappingURL=course-chapters.d.ts.map

package/resources/course-chapters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"course-chapters.d.ts","sourceRoot":"","sources":["../src/resources/course-chapters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IAO/E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGtF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/course-chapters.js

@@ -0,0 +1,103 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourseChapters = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class CourseChapters extends resource_1.APIResource {
+    /**
+     * Creates a new course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.create({
+     *   course_id: 'cors_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/course_chapters', { body, ...options });
+    }
+    /**
+     * Retrieves a course chapter by ID
+     *
+     * Required permissions:
+     *
+     * - `courses:read`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.retrieve(
+     *   'chap_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/course_chapters/${id}`, options);
+    }
+    /**
+     * Updates a course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.update(
+     *   'chap_xxxxxxxxxxxxx',
+     *   { title: 'title' },
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch((0, path_1.path) `/course_chapters/${id}`, { body, ...options });
+    }
+    /**
+     * Lists chapters for a course
+     *
+     * Required permissions:
+     *
+     * - `courses:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const courseChapterListResponse of client.courseChapters.list(
+     *   { course_id: 'cors_xxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query, options) {
+        return this._client.getAPIList('/course_chapters', (pagination_1.CursorPage), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Deletes a course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.delete(
+     *   'chap_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/course_chapters/${id}`, options);
+    }
+}
+exports.CourseChapters = CourseChapters;
+//# sourceMappingURL=course-chapters.js.map

package/resources/course-chapters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"course-chapters.js","sourceRoot":"","sources":["../src/resources/course-chapters.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA+B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,IAA+B,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,uBAAqC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AApGD,wCAoGC"}

package/resources/course-chapters.mjs

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorPage } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class CourseChapters extends APIResource {
+    /**
+     * Creates a new course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.create({
+     *   course_id: 'cors_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/course_chapters', { body, ...options });
+    }
+    /**
+     * Retrieves a course chapter by ID
+     *
+     * Required permissions:
+     *
+     * - `courses:read`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.retrieve(
+     *   'chap_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/course_chapters/${id}`, options);
+    }
+    /**
+     * Updates a course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.update(
+     *   'chap_xxxxxxxxxxxxx',
+     *   { title: 'title' },
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch(path `/course_chapters/${id}`, { body, ...options });
+    }
+    /**
+     * Lists chapters for a course
+     *
+     * Required permissions:
+     *
+     * - `courses:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const courseChapterListResponse of client.courseChapters.list(
+     *   { course_id: 'cors_xxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query, options) {
+        return this._client.getAPIList('/course_chapters', (CursorPage), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Deletes a course chapter
+     *
+     * Required permissions:
+     *
+     * - `courses:update`
+     *
+     * @example
+     * ```ts
+     * const courseChapter = await client.courseChapters.delete(
+     *   'chap_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/course_chapters/${id}`, options);
+    }
+}
+//# sourceMappingURL=course-chapters.mjs.map

package/resources/course-chapters.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"course-chapters.mjs","sourceRoot":"","sources":["../src/resources/course-chapters.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA+B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,IAA+B,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,UAAqC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF"}

package/resources/course-lesson-interactions.d.mts

@@ -10,8 +10,8 @@ export declare class CourseLessonInteractions extends APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction>;
     /**
@@ -19,8 +19,8 @@ export declare class CourseLessonInteractions extends APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     list(query?: CourseLessonInteractionListParams | null | undefined, options?: RequestOptions): PagePromise<CourseLessonInteractionListItemsCursorPage, Shared.CourseLessonInteractionListItem>;
 }

package/resources/course-lesson-interactions.d.ts

@@ -10,8 +10,8 @@ export declare class CourseLessonInteractions extends APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction>;
     /**
@@ -19,8 +19,8 @@ export declare class CourseLessonInteractions extends APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     list(query?: CourseLessonInteractionListParams | null | undefined, options?: RequestOptions): PagePromise<CourseLessonInteractionListItemsCursorPage, Shared.CourseLessonInteractionListItem>;
 }

package/resources/course-lesson-interactions.js

@@ -11,8 +11,8 @@ class CourseLessonInteractions extends resource_1.APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/course_lesson_interactions/${id}`, options);
@@ -22,8 +22,8 @@ class CourseLessonInteractions extends resource_1.APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     list(query = {}, options) {
         return this._client.getAPIList('/course_lesson_interactions', (pagination_1.CursorPage), { query, ...options });

package/resources/course-lesson-interactions.mjs

@@ -8,8 +8,8 @@ export class CourseLessonInteractions extends APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     retrieve(id, options) {
         return this._client.get(path `/course_lesson_interactions/${id}`, options);
@@ -19,8 +19,8 @@ export class CourseLessonInteractions extends APIResource {
      *
      * Required permissions:
      *
-     * - `course_lesson_interaction:read`
      * - `courses:read`
+     * - `course_analytics:read`
      */
     list(query = {}, options) {
         return this._client.getAPIList('/course_lesson_interactions', (CursorPage), { query, ...options });