@whop/sdk 0.0.1-canary.0

package/resources/memberships.d.ts

@@ -0,0 +1,287 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.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 Memberships extends APIResource {
+    /**
+     * Retrieves a membership by ID or license key
+     *
+     * Required permissions:
+     *
+     * - `member:basic:read`
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
+    /**
+     * Update a membership
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    update(id: string, body?: MembershipUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
+    /**
+     * Lists memberships
+     *
+     * Required permissions:
+     *
+     * - `member:basic:read`
+     */
+    list(query: MembershipListParams, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
+    /**
+     * Cancels a membership either immediately or at the end of the current billing
+     * period
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    cancel(id: string, body?: MembershipCancelParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
+    /**
+     * Pauses a membership's payments
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    pause(id: string, body?: MembershipPauseParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
+    /**
+     * Resumes a membership's payments
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    resume(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
+}
+export type MembershipListResponsesCursorPage = CursorPage<MembershipListResponse>;
+/**
+ * A membership represents a purchase between a User and a Company for a specific
+ * Product.
+ */
+export interface MembershipListResponse {
+    /**
+     * The ID of the membership
+     */
+    id: string;
+    /**
+     * Whether this Membership is set to cancel at the end of the current billing
+     * cycle. Only applies for memberships that have a renewal plan.
+     */
+    cancel_at_period_end: boolean;
+    /**
+     * The epoch timestamp of when the customer initiated a cancellation.
+     */
+    canceled_at: string | null;
+    /**
+     * The reason that the member canceled the membership (filled out by the member).
+     */
+    cancellation_reason: string | null;
+    /**
+     * The Company this Membership belongs to.
+     */
+    company: MembershipListResponse.Company;
+    /**
+     * The timestamp, in seconds, that this Membership was created at.
+     */
+    created_at: string;
+    /**
+     * The available currencies on the platform
+     */
+    currency: Shared.Currency | null;
+    /**
+     * The license key for this Membership. This is only present if the membership
+     * grants access to an instance of the Whop Software app.
+     */
+    license_key: string | null;
+    /**
+     * The URL for the customer to manage their membership.
+     */
+    manage_url: string | null;
+    /**
+     * The Member that this Membership belongs to.
+     */
+    member: MembershipListResponse.Member | null;
+    /**
+     * A JSON object used to store software licensing information. Ex. HWID
+     */
+    metadata: {
+        [key: string]: unknown;
+    };
+    /**
+     * Whether the membership's payments are currently paused.
+     */
+    payment_collection_paused: boolean;
+    /**
+     * The Plan this Membership is for.
+     */
+    plan: MembershipListResponse.Plan;
+    /**
+     * The Promo Code that is currently applied to this Membership.
+     */
+    promo_code: MembershipListResponse.PromoCode | null;
+    /**
+     * The timestamp in seconds at which the current billing cycle for this
+     * subscription ends. Only applies for memberships that have a renewal plan.
+     */
+    renewal_period_end: string | null;
+    /**
+     * The timestamp in seconds at which the current billing cycle for this
+     * subscription start. Only applies for memberships that have a renewal plan.
+     */
+    renewal_period_start: string | null;
+    /**
+     * The status of the membership.
+     */
+    status: Shared.MembershipStatus;
+    /**
+     * A timestamp of when the membership was last updated
+     */
+    updated_at: string;
+    /**
+     * The user this membership belongs to
+     */
+    user: MembershipListResponse.User | null;
+}
+export declare namespace MembershipListResponse {
+    /**
+     * The Company this Membership belongs to.
+     */
+    interface Company {
+        /**
+         * The ID (tag) of the company.
+         */
+        id: string;
+        /**
+         * The title of the company.
+         */
+        title: string;
+    }
+    /**
+     * The Member that this Membership belongs to.
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The Plan this Membership is for.
+     */
+    interface Plan {
+        /**
+         * The internal ID of the plan.
+         */
+        id: string;
+    }
+    /**
+     * The Promo Code that is currently applied to this Membership.
+     */
+    interface PromoCode {
+        /**
+         * The ID of the promo.
+         */
+        id: string;
+    }
+    /**
+     * The user this membership belongs to
+     */
+    interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+export interface MembershipUpdateParams {
+    /**
+     * The metadata to update the membership with.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
+}
+export interface MembershipListParams extends CursorPageParams {
+    /**
+     * The ID of the company to list memberships for
+     */
+    company_id: string;
+    /**
+     * The access pass IDs to filter the memberships by
+     */
+    access_pass_ids?: Array<string> | null;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The cancel options to filter the memberships by
+     */
+    cancel_options?: Array<'too_expensive' | 'switching' | 'missing_features' | 'technical_issues' | 'bad_experience' | 'other' | 'testing'> | null;
+    /**
+     * The minimum creation date to filter by
+     */
+    created_after?: string | null;
+    /**
+     * The maximum creation date to filter by
+     */
+    created_before?: string | null;
+    /**
+     * The direction of the sort.
+     */
+    direction?: Shared.Direction | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+    /**
+     * Which columns can be used to sort.
+     */
+    order?: 'id' | 'created_at' | 'status' | 'canceled_at' | 'date_joined' | 'total_spend' | null;
+    /**
+     * The plan IDs to filter the memberships by
+     */
+    plan_ids?: Array<string> | null;
+    /**
+     * The promo code IDs to filter the memberships by
+     */
+    promo_code_ids?: Array<string> | null;
+    /**
+     * The membership status to filter the memberships by
+     */
+    statuses?: Array<Shared.MembershipStatus> | null;
+}
+export interface MembershipCancelParams {
+    /**
+     * The mode of cancellation for a membership
+     */
+    cancellation_mode?: 'at_period_end' | 'immediate' | null;
+}
+export interface MembershipPauseParams {
+    /**
+     * Whether to void past_due payments associated with the membership to prevent
+     * future payment attempts.
+     */
+    void_payments?: boolean | null;
+}
+export declare namespace Memberships {
+    export { type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipUpdateParams as MembershipUpdateParams, type MembershipListParams as MembershipListParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, };
+}
+//# sourceMappingURL=memberships.d.ts.map

package/resources/memberships.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memberships.d.ts","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;OAOG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG5E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEhC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;CAC1C;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAClB,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,GACP,SAAS,CACZ,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,aAAa,GAAG,aAAa,GAAG,aAAa,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,iBAAiB,CAAC,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI,CAAC;CAC1D;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/memberships.js

@@ -0,0 +1,76 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Memberships = 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 Memberships extends resource_1.APIResource {
+    /**
+     * Retrieves a membership by ID or license key
+     *
+     * Required permissions:
+     *
+     * - `member:basic:read`
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/memberships/${id}`, options);
+    }
+    /**
+     * Update a membership
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    update(id, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/memberships/${id}`, { body, ...options });
+    }
+    /**
+     * Lists memberships
+     *
+     * Required permissions:
+     *
+     * - `member:basic:read`
+     */
+    list(query, options) {
+        return this._client.getAPIList('/memberships', (pagination_1.CursorPage), { query, ...options });
+    }
+    /**
+     * Cancels a membership either immediately or at the end of the current billing
+     * period
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    cancel(id, body = {}, options) {
+        return this._client.post((0, path_1.path) `/memberships/${id}/cancel`, { body, ...options });
+    }
+    /**
+     * Pauses a membership's payments
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    pause(id, body = {}, options) {
+        return this._client.post((0, path_1.path) `/memberships/${id}/pause`, { body, ...options });
+    }
+    /**
+     * Resumes a membership's payments
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    resume(id, options) {
+        return this._client.post((0, path_1.path) `/memberships/${id}/resume`, options);
+    }
+}
+exports.Memberships = Memberships;
+//# sourceMappingURL=memberships.js.map

package/resources/memberships.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memberships.js","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CACH,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAtFD,kCAsFC"}

package/resources/memberships.mjs

@@ -0,0 +1,72 @@
+// 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 Memberships extends APIResource {
+    /**
+     * Retrieves a membership by ID or license key
+     *
+     * Required permissions:
+     *
+     * - `member:basic:read`
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/memberships/${id}`, options);
+    }
+    /**
+     * Update a membership
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    update(id, body = {}, options) {
+        return this._client.patch(path `/memberships/${id}`, { body, ...options });
+    }
+    /**
+     * Lists memberships
+     *
+     * Required permissions:
+     *
+     * - `member:basic:read`
+     */
+    list(query, options) {
+        return this._client.getAPIList('/memberships', (CursorPage), { query, ...options });
+    }
+    /**
+     * Cancels a membership either immediately or at the end of the current billing
+     * period
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    cancel(id, body = {}, options) {
+        return this._client.post(path `/memberships/${id}/cancel`, { body, ...options });
+    }
+    /**
+     * Pauses a membership's payments
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    pause(id, body = {}, options) {
+        return this._client.post(path `/memberships/${id}/pause`, { body, ...options });
+    }
+    /**
+     * Resumes a membership's payments
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:basic:read`
+     */
+    resume(id, options) {
+        return this._client.post(path `/memberships/${id}/resume`, options);
+    }
+}
+//# sourceMappingURL=memberships.mjs.map

package/resources/memberships.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"memberships.mjs","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CACH,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}

package/resources/messages.d.mts

@@ -0,0 +1,245 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Messages extends APIResource {
+    /**
+     * Creates a new message
+     *
+     * Required permissions:
+     *
+     * - `chat:message:create`
+     */
+    create(body: MessageCreateParams, options?: RequestOptions): APIPromise<Shared.Message>;
+    /**
+     * Retrieves a message
+     *
+     * Required permissions:
+     *
+     * - `chat:read`
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Message>;
+    /**
+     * Lists messages inside a channel
+     *
+     * Required permissions:
+     *
+     * - `chat:read`
+     */
+    list(query: MessageListParams, options?: RequestOptions): PagePromise<MessageListResponsesCursorPage, MessageListResponse>;
+}
+export type MessageListResponsesCursorPage = CursorPage<MessageListResponse>;
+/**
+ * Represents a message in a DM channel
+ */
+export interface MessageListResponse {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+    /**
+     * The content of the message in Markdown format
+     */
+    content: string | null;
+    /**
+     * The timestamp when the post was created
+     */
+    created_at: string;
+    /**
+     * Whether the message has been edited
+     */
+    is_edited: boolean;
+    /**
+     * Whether this message is pinned
+     */
+    is_pinned: boolean;
+    /**
+     * The type of post
+     */
+    message_type: Shared.DmsPostTypes;
+    /**
+     * The poll for this message
+     */
+    poll: MessageListResponse.Poll | null;
+    /**
+     * The reaction counts for this message
+     */
+    poll_votes: Array<MessageListResponse.PollVote>;
+    /**
+     * The reaction counts for this message
+     */
+    reaction_counts: Array<MessageListResponse.ReactionCount>;
+    /**
+     * The ID of the message this is replying to, if applicable
+     */
+    replying_to_message_id: string | null;
+    /**
+     * The timestamp when the post was last updated
+     */
+    updated_at: string;
+    /**
+     * The user who sent this message
+     */
+    user: MessageListResponse.User;
+    /**
+     * The number of times this message has been viewed
+     */
+    view_count: number | null;
+}
+export declare namespace MessageListResponse {
+    /**
+     * The poll for this message
+     */
+    interface Poll {
+        /**
+         * The options for the poll
+         */
+        options: Array<Poll.Option> | null;
+    }
+    namespace Poll {
+        /**
+         * Represents a single poll option
+         */
+        interface Option {
+            /**
+             * The ID of the poll option
+             */
+            id: string;
+            /**
+             * The text of the poll option
+             */
+            text: string;
+        }
+    }
+    /**
+     * Represents a reaction count for a feed post
+     */
+    interface PollVote {
+        /**
+         * The number of users who reacted
+         */
+        count: number;
+        /**
+         * The reaction that was used
+         */
+        option_id: string | null;
+    }
+    /**
+     * Represents a reaction count for a feed post
+     */
+    interface ReactionCount {
+        /**
+         * The number of users who reacted
+         */
+        count: number;
+        /**
+         * The emoji that was used in shortcode format (:heart:)
+         */
+        emoji: string | null;
+    }
+    /**
+     * The user who sent this message
+     */
+    interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+export interface MessageCreateParams {
+    /**
+     * The ID of the channel or experience to send to.
+     */
+    channel_id: string;
+    /**
+     * The content of the message in Markdown format.
+     */
+    content: string;
+    /**
+     * The attachments for this message, such as videos or images.
+     */
+    attachments?: Array<MessageCreateParams.Attachment> | null;
+    /**
+     * The poll for this message
+     */
+    poll?: MessageCreateParams.Poll | null;
+}
+export declare namespace MessageCreateParams {
+    /**
+     * Input for an attachment
+     */
+    interface Attachment {
+        /**
+         * The ID of an existing attachment object. Use this when updating a resource and
+         * keeping a subset of the attachments. Don't use this unless you know what you're
+         * doing.
+         */
+        id?: string | null;
+        /**
+         * This ID should be used the first time you upload an attachment. It is the ID of
+         * the direct upload that was created when uploading the file to S3 via the
+         * mediaDirectUpload mutation.
+         */
+        direct_upload_id?: string | null;
+    }
+    /**
+     * The poll for this message
+     */
+    interface Poll {
+        /**
+         * The options for the poll. Must have sequential IDs starting from 1
+         */
+        options: Array<Poll.Option>;
+    }
+    namespace Poll {
+        /**
+         * Input type for a single poll option
+         */
+        interface Option {
+            /**
+             * Sequential ID for the poll option (starting from '1')
+             */
+            id: string;
+            /**
+             * The text of the poll option
+             */
+            text: string;
+        }
+    }
+}
+export interface MessageListParams extends CursorPageParams {
+    /**
+     * The ID of the channel or the experience ID to list messages for
+     */
+    channel_id: string;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The direction of the sort.
+     */
+    direction?: Shared.Direction | 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 Messages {
+    export { type MessageListResponse as MessageListResponse, type MessageListResponsesCursorPage as MessageListResponsesCursorPage, type MessageCreateParams as MessageCreateParams, type MessageListParams as MessageListParams, };
+}
+//# sourceMappingURL=messages.d.mts.map