@whop/sdk 0.0.30 → 0.0.32

package/resources/members.js

@@ -5,6 +5,9 @@ exports.Members = void 0;
 const resource_1 = require("../core/resource.js");
 const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
+/**
+ * Members
+ */
 class Members extends resource_1.APIResource {
     /**
      * Retrieves the details of an existing member.

package/resources/members.js.map

@@ -1 +1 @@
-{"version":3,"file":"members.js","sourceRoot":"","sources":["../src/resources/members.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF;AA9BD,0BA8BC"}
+{"version":3,"file":"members.js","sourceRoot":"","sources":["../src/resources/members.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF;AA9BD,0BA8BC"}

package/resources/members.mjs

@@ -2,6 +2,9 @@
 import { APIResource } from "../core/resource.mjs";
 import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
+/**
+ * Members
+ */
 export class Members extends APIResource {
     /**
      * Retrieves the details of an existing member.

package/resources/members.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"members.mjs","sourceRoot":"","sources":["../src/resources/members.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF"}
+{"version":3,"file":"members.mjs","sourceRoot":"","sources":["../src/resources/members.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF"}

package/resources/memberships.d.mts

@@ -3,6 +3,9 @@ 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";
+/**
+ * Memberships
+ */
 export declare class Memberships extends APIResource {
     /**
      * Retrieves the details of an existing membership.
@@ -11,6 +14,13 @@ export declare class Memberships extends APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.retrieve(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -21,6 +31,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.update(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     update(id: string, body?: MembershipUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -31,17 +48,51 @@ export declare class Memberships extends APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const membershipListResponse of client.memberships.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
+    /**
+     * Add free days to extend a membership's current billing period, expiration date,
+     * or Stripe trial.
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:email:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.addFreeDays(
+     *   'mem_xxxxxxxxxxxxxx',
+     *   { free_days: 42 },
+     * );
+     * ```
+     */
+    addFreeDays(id: string, body: MembershipAddFreeDaysParams, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
      * Cancel a membership either immediately or at the end of the current billing
      * period. Immediate cancellation revokes access right away.
      *
      * Required permissions:
      *
-     * - `member:manage`
+     * - `membership:cancel`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.cancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     cancel(id: string, body?: MembershipCancelParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -53,6 +104,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.pause(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     pause(id: string, body?: MembershipPauseParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -64,6 +122,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.resume(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     resume(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -75,6 +140,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.uncancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     uncancel(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
 }
@@ -342,6 +414,13 @@ export interface MembershipListParams extends CursorPageParams {
      */
     user_ids?: Array<string> | null;
 }
+export interface MembershipAddFreeDaysParams {
+    /**
+     * The number of free days to add (1-1095). Extends the billing period, expiration
+     * date, or Stripe trial depending on plan type.
+     */
+    free_days: number;
+}
 export interface MembershipCancelParams {
     /**
      * The mode of cancellation for a membership
@@ -356,6 +435,6 @@ export interface MembershipPauseParams {
     void_payments?: boolean | null;
 }
 export declare namespace Memberships {
-    export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipUpdateParams as MembershipUpdateParams, type MembershipListParams as MembershipListParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, };
+    export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipUpdateParams as MembershipUpdateParams, type MembershipListParams as MembershipListParams, type MembershipAddFreeDaysParams as MembershipAddFreeDaysParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, };
 }
 //# sourceMappingURL=memberships.d.mts.map

package/resources/memberships.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"memberships.d.mts","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;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;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;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;OASG;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;;;;;;;;;OASG;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;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG9E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,GACP,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;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,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;OAGG;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;;;OAGG;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;;;OAGG;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,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;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,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;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;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;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,aAAa,IAAI,aAAa,EACnC,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"}
+{"version":3,"file":"memberships.d.mts","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;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG9E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,GACP,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;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,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;OAGG;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;;;OAGG;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;;;OAGG;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,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;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,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;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;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;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,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/memberships.d.ts

@@ -3,6 +3,9 @@ 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";
+/**
+ * Memberships
+ */
 export declare class Memberships extends APIResource {
     /**
      * Retrieves the details of an existing membership.
@@ -11,6 +14,13 @@ export declare class Memberships extends APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.retrieve(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -21,6 +31,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.update(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     update(id: string, body?: MembershipUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -31,17 +48,51 @@ export declare class Memberships extends APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const membershipListResponse of client.memberships.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: MembershipListParams | null | undefined, options?: RequestOptions): PagePromise<MembershipListResponsesCursorPage, MembershipListResponse>;
+    /**
+     * Add free days to extend a membership's current billing period, expiration date,
+     * or Stripe trial.
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:email:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.addFreeDays(
+     *   'mem_xxxxxxxxxxxxxx',
+     *   { free_days: 42 },
+     * );
+     * ```
+     */
+    addFreeDays(id: string, body: MembershipAddFreeDaysParams, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
      * Cancel a membership either immediately or at the end of the current billing
      * period. Immediate cancellation revokes access right away.
      *
      * Required permissions:
      *
-     * - `member:manage`
+     * - `membership:cancel`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.cancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     cancel(id: string, body?: MembershipCancelParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -53,6 +104,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.pause(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     pause(id: string, body?: MembershipPauseParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -64,6 +122,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.resume(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     resume(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
     /**
@@ -75,6 +140,13 @@ export declare class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.uncancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     uncancel(id: string, options?: RequestOptions): APIPromise<Shared.Membership>;
 }
@@ -342,6 +414,13 @@ export interface MembershipListParams extends CursorPageParams {
      */
     user_ids?: Array<string> | null;
 }
+export interface MembershipAddFreeDaysParams {
+    /**
+     * The number of free days to add (1-1095). Extends the billing period, expiration
+     * date, or Stripe trial depending on plan type.
+     */
+    free_days: number;
+}
 export interface MembershipCancelParams {
     /**
      * The mode of cancellation for a membership
@@ -356,6 +435,6 @@ export interface MembershipPauseParams {
     void_payments?: boolean | null;
 }
 export declare namespace Memberships {
-    export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipUpdateParams as MembershipUpdateParams, type MembershipListParams as MembershipListParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, };
+    export { type CancelOptions as CancelOptions, type MembershipListResponse as MembershipListResponse, type MembershipListResponsesCursorPage as MembershipListResponsesCursorPage, type MembershipUpdateParams as MembershipUpdateParams, type MembershipListParams as MembershipListParams, type MembershipAddFreeDaysParams as MembershipAddFreeDaysParams, type MembershipCancelParams as MembershipCancelParams, type MembershipPauseParams as MembershipPauseParams, };
 }
 //# sourceMappingURL=memberships.d.ts.map

package/resources/memberships.d.ts.map

@@ -1 +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;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;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;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;OASG;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;;;;;;;;;OASG;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;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG9E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,GACP,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;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,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;OAGG;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;;;OAGG;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;;;OAGG;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,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;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,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;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;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;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,aAAa,IAAI,aAAa,EACnC,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"}
+{"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;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI3E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAG9E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,GACP,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;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,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;OAGG;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;;;OAGG;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;;;OAGG;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,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;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,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;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;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;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,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/memberships.js

@@ -5,6 +5,9 @@ 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");
+/**
+ * Memberships
+ */
 class Memberships extends resource_1.APIResource {
     /**
      * Retrieves the details of an existing membership.
@@ -13,6 +16,13 @@ class Memberships extends resource_1.APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.retrieve(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/memberships/${id}`, options);
@@ -25,6 +35,13 @@ class Memberships extends resource_1.APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.update(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     update(id, body = {}, options) {
         return this._client.patch((0, path_1.path) `/memberships/${id}`, { body, ...options });
@@ -37,19 +54,55 @@ class Memberships extends resource_1.APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const membershipListResponse of client.memberships.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/memberships', (pagination_1.CursorPage), { query, ...options });
     }
+    /**
+     * Add free days to extend a membership's current billing period, expiration date,
+     * or Stripe trial.
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:email:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.addFreeDays(
+     *   'mem_xxxxxxxxxxxxxx',
+     *   { free_days: 42 },
+     * );
+     * ```
+     */
+    addFreeDays(id, body, options) {
+        return this._client.post((0, path_1.path) `/memberships/${id}/add_free_days`, { body, ...options });
+    }
     /**
      * Cancel a membership either immediately or at the end of the current billing
      * period. Immediate cancellation revokes access right away.
      *
      * Required permissions:
      *
-     * - `member:manage`
+     * - `membership:cancel`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.cancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     cancel(id, body = {}, options) {
         return this._client.post((0, path_1.path) `/memberships/${id}/cancel`, { body, ...options });
@@ -63,6 +116,13 @@ class Memberships extends resource_1.APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.pause(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     pause(id, body = {}, options) {
         return this._client.post((0, path_1.path) `/memberships/${id}/pause`, { body, ...options });
@@ -76,6 +136,13 @@ class Memberships extends resource_1.APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.resume(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     resume(id, options) {
         return this._client.post((0, path_1.path) `/memberships/${id}/resume`, options);
@@ -89,6 +156,13 @@ class Memberships extends resource_1.APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.uncancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     uncancel(id, options) {
         return this._client.post((0, path_1.path) `/memberships/${id}/uncancel`, options);

package/resources/memberships.js.map

@@ -1 +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;;;;;;;OAOG;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;;;;;;;;OAQG;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;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,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;;;;;;;;;OASG;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;;;;;;;;;OASG;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;;;;;;;;;OASG;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;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AA7GD,kCA6GC"}
+{"version":3,"file":"memberships.js","sourceRoot":"","sources":["../src/resources/memberships.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;OAcG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,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;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAU,EACV,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAzLD,kCAyLC"}

package/resources/memberships.mjs

@@ -2,6 +2,9 @@
 import { APIResource } from "../core/resource.mjs";
 import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
+/**
+ * Memberships
+ */
 export class Memberships extends APIResource {
     /**
      * Retrieves the details of an existing membership.
@@ -10,6 +13,13 @@ export class Memberships extends APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.retrieve(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(path `/memberships/${id}`, options);
@@ -22,6 +32,13 @@ export class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.update(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     update(id, body = {}, options) {
         return this._client.patch(path `/memberships/${id}`, { body, ...options });
@@ -34,19 +51,55 @@ export class Memberships extends APIResource {
      *
      * - `member:basic:read`
      * - `member:email:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const membershipListResponse of client.memberships.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/memberships', (CursorPage), { query, ...options });
     }
+    /**
+     * Add free days to extend a membership's current billing period, expiration date,
+     * or Stripe trial.
+     *
+     * Required permissions:
+     *
+     * - `member:manage`
+     * - `member:email:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.addFreeDays(
+     *   'mem_xxxxxxxxxxxxxx',
+     *   { free_days: 42 },
+     * );
+     * ```
+     */
+    addFreeDays(id, body, options) {
+        return this._client.post(path `/memberships/${id}/add_free_days`, { body, ...options });
+    }
     /**
      * Cancel a membership either immediately or at the end of the current billing
      * period. Immediate cancellation revokes access right away.
      *
      * Required permissions:
      *
-     * - `member:manage`
+     * - `membership:cancel`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.cancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     cancel(id, body = {}, options) {
         return this._client.post(path `/memberships/${id}/cancel`, { body, ...options });
@@ -60,6 +113,13 @@ export class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.pause(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     pause(id, body = {}, options) {
         return this._client.post(path `/memberships/${id}/pause`, { body, ...options });
@@ -73,6 +133,13 @@ export class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.resume(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     resume(id, options) {
         return this._client.post(path `/memberships/${id}/resume`, options);
@@ -86,6 +153,13 @@ export class Memberships extends APIResource {
      * - `member:manage`
      * - `member:email:read`
      * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const membership = await client.memberships.uncancel(
+     *   'mem_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     uncancel(id, options) {
         return this._client.post(path `/memberships/${id}/uncancel`, options);

package/resources/memberships.mjs.map

@@ -1 +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;;;;;;;OAOG;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;;;;;;;;OAQG;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;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,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;;;;;;;;;OASG;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;;;;;;;;;OASG;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;;;;;;;;;OASG;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;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}
+{"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;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,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;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CACT,EAAU,EACV,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;OAgBG;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;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}