@whop/sdk 0.0.27 → 0.0.29

package/resources/experiences.d.ts

@@ -19,7 +19,7 @@ export declare class Experiences extends APIResource {
      */
     create(body: ExperienceCreateParams, options?: RequestOptions): APIPromise<Shared.Experience>;
     /**
-     * Retrieves an experience by ID
+     * Retrieves the details of an existing experience.
      *
      * @example
      * ```ts
@@ -43,11 +43,8 @@ export declare class Experiences extends APIResource {
      */
     update(id: string, body?: ExperienceUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Experience>;
     /**
-     * Lists experiences for a company
-     *
-     * Required permissions:
-     *
-     * - `experience:hidden_experience:read`
+     * Returns a paginated list of experiences belonging to a company, with optional
+     * filtering by product and app.
      *
      * @example
      * ```ts
@@ -74,7 +71,7 @@ export declare class Experiences extends APIResource {
      */
     delete(id: string, options?: RequestOptions): APIPromise<ExperienceDeleteResponse>;
     /**
-     * Adds an experience to an product, making it accessible to the product's
+     * Attach an experience to a product, making it accessible to the product's
      * customers.
      *
      * Required permissions:
@@ -91,8 +88,8 @@ export declare class Experiences extends APIResource {
      */
     attach(id: string, body: ExperienceAttachParams, options?: RequestOptions): APIPromise<Shared.Experience>;
     /**
-     * Removes an experience from an product, making it inaccessible to the product's
-     * customers.
+     * Detach an experience from a product, removing customer access to it through that
+     * product.
      *
      * Required permissions:
      *
@@ -131,7 +128,7 @@ export declare class Experiences extends APIResource {
 export type ExperienceListResponsesCursorPage = CursorPage<ExperienceListResponse>;
 /**
  * An experience is a feature or content module within a product, such as a chat,
- * course, or app.
+ * course, or custom app.
  */
 export interface ExperienceListResponse {
     /**
@@ -139,7 +136,7 @@ export interface ExperienceListResponse {
      */
     id: string;
     /**
-     * The experience interface for this experience.
+     * The app that powers this experience, defining its interface and behavior.
      */
     app: ExperienceListResponse.App;
     /**
@@ -151,25 +148,29 @@ export interface ExperienceListResponse {
      */
     created_at: string;
     /**
-     * The logo for the experience.
+     * The custom logo image for this experience. Null if no custom logo has been
+     * uploaded.
      */
     image: ExperienceListResponse.Image | null;
     /**
-     * Whether the experience is visible to the public
+     * Whether this experience is publicly visible to all users, including those
+     * without a membership.
      */
     is_public: boolean;
     /**
-     * The written name of the description.
+     * The display name of this experience shown to users in the product navigation.
+     * Maximum 255 characters.
      */
     name: string;
     /**
-     * The order of the experience in the section
+     * The sort position of this experience within its section. Lower values appear
+     * first. Null if no position has been set.
      */
     order: string | null;
 }
 export declare namespace ExperienceListResponse {
     /**
-     * The experience interface for this experience.
+     * The app that powers this experience, defining its interface and behavior.
      */
     interface App {
         /**
@@ -177,24 +178,25 @@ export declare namespace ExperienceListResponse {
          */
         id: string;
         /**
-         * The icon for the app. This icon is shown on discovery, on the product page, on
-         * checkout, and as a default icon for the experiences.
+         * The icon image for this app, displayed on the app store, product pages,
+         * checkout, and as the default icon for experiences using this app.
          */
         icon: App.Icon | null;
         /**
-         * The name of the app
+         * The display name of this app shown on the app store and in experience
+         * navigation. Maximum 30 characters.
          */
         name: string;
     }
     namespace App {
         /**
-         * The icon for the app. This icon is shown on discovery, on the product page, on
-         * checkout, and as a default icon for the experiences.
+         * The icon image for this app, displayed on the app store, product pages,
+         * checkout, and as the default icon for experiences using this app.
          */
         interface Icon {
             /**
-             * This is the URL you use to render optimized attachments on the client. This
-             * should be used for apps.
+             * A pre-optimized URL for rendering this attachment on the client. This should be
+             * used for displaying attachments in apps.
              */
             url: string | null;
         }
@@ -208,21 +210,22 @@ export declare namespace ExperienceListResponse {
          */
         id: string;
         /**
-         * The slug/route of the company on the Whop site.
+         * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
          */
         route: string;
         /**
-         * The title of the company.
+         * The display name of the company shown to customers.
          */
         title: string;
     }
     /**
-     * The logo for the experience.
+     * The custom logo image for this experience. Null if no custom logo has been
+     * uploaded.
      */
     interface Image {
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
@@ -233,33 +236,33 @@ export declare namespace ExperienceListResponse {
 export type ExperienceDeleteResponse = boolean;
 export interface ExperienceCreateParams {
     /**
-     * The ID of the app to create the experience for
+     * The unique identifier of the app that powers this experience.
      */
     app_id: string;
     /**
-     * The ID of the company to create the experience for
+     * The unique identifier of the company to create this experience for.
      */
     company_id: string;
     /**
-     * Whether the experience is publicly accessible
+     * Whether the experience is publicly accessible without a membership.
      */
     is_public?: boolean | null;
     /**
-     * The logo for the experience
+     * A logo image displayed alongside the experience name.
      */
     logo?: ExperienceCreateParams.Logo | null;
     /**
-     * The name of the experience
+     * The display name of the experience. Defaults to the app's name if not provided.
      */
     name?: string | null;
     /**
-     * The ID of the section to create the experience in
+     * The unique identifier of the section to place the experience in.
      */
     section_id?: string | null;
 }
 export declare namespace ExperienceCreateParams {
     /**
-     * The logo for the experience
+     * A logo image displayed alongside the experience name.
      */
     interface Logo {
         /**
@@ -274,29 +277,29 @@ export interface ExperienceUpdateParams {
      */
     access_level?: 'public' | 'private' | null;
     /**
-     * Whether the experience is publicly accessible.
+     * Whether the experience is publicly accessible without a membership.
      */
     is_public?: boolean | null;
     /**
-     * The logo for the experience
+     * A logo image displayed alongside the experience name.
      */
     logo?: ExperienceUpdateParams.Logo | null;
     /**
-     * The name of the experience.
+     * The display name of the experience.
      */
     name?: string | null;
     /**
-     * The order of the experience in the section.
+     * The position of the experience within its section for display ordering.
      */
     order?: string | null;
     /**
-     * The ID of the section to update.
+     * The unique identifier of the section to move the experience into.
      */
     section_id?: string | null;
 }
 export declare namespace ExperienceUpdateParams {
     /**
-     * The logo for the experience
+     * A logo image displayed alongside the experience name.
      */
     interface Logo {
         /**
@@ -307,11 +310,11 @@ export declare namespace ExperienceUpdateParams {
 }
 export interface ExperienceListParams extends CursorPageParams {
     /**
-     * The ID of the company to filter experiences by
+     * The unique identifier of the company to list experiences for.
      */
     company_id: string;
     /**
-     * The ID of the app to filter experiences by
+     * Filter to only experiences powered by this app identifier.
      */
     app_id?: string | null;
     /**
@@ -319,11 +322,11 @@ export interface ExperienceListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return experiences created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return experiences created before this timestamp.
      */
     created_before?: string | null;
     /**
@@ -335,25 +338,26 @@ export interface ExperienceListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * The ID of the product to filter experiences by
+     * Filter to only experiences attached to this product identifier.
      */
     product_id?: string | null;
 }
 export interface ExperienceAttachParams {
     /**
-     * The ID of the Access Pass to add the Experience to.
+     * The unique identifier of the product to attach the experience to.
      */
     product_id: string;
 }
 export interface ExperienceDetachParams {
     /**
-     * The ID of the Access Pass to add the Experience to.
+     * The unique identifier of the product to detach the experience from.
      */
     product_id: string;
 }
 export interface ExperienceDuplicateParams {
     /**
-     * The name of the new experience
+     * The display name for the duplicated experience. Defaults to the original
+     * experience's name.
      */
     name?: string | null;
 }

package/resources/experiences.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"experiences.d.ts","sourceRoot":"","sources":["../src/resources/experiences.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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;OAWG;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,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIlF;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIzG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIzG;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGjC;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,sBAAsB,CAAC,GAAG,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,sBAAsB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,GAAG,CAAC;QACnB;;;WAGG;QACH,UAAiB,IAAI;YACnB;;;eAGG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;SACpB;KACF;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"experiences.d.ts","sourceRoot":"","sources":["../src/resources/experiences.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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAI7E;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAIzE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIlF;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIzG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIzG;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;CAGjC;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,sBAAsB,CAAC,GAAG,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,sBAAsB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE3C;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,GAAG,CAAC;QACnB;;;WAGG;QACH,UAAiB,IAAI;YACnB;;;eAGG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;SACpB;KACF;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/experiences.js

@@ -23,7 +23,7 @@ class Experiences extends resource_1.APIResource {
         return this._client.post('/experiences', { body, ...options });
     }
     /**
-     * Retrieves an experience by ID
+     * Retrieves the details of an existing experience.
      *
      * @example
      * ```ts
@@ -51,11 +51,8 @@ class Experiences extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/experiences/${id}`, { body, ...options });
     }
     /**
-     * Lists experiences for a company
-     *
-     * Required permissions:
-     *
-     * - `experience:hidden_experience:read`
+     * Returns a paginated list of experiences belonging to a company, with optional
+     * filtering by product and app.
      *
      * @example
      * ```ts
@@ -86,7 +83,7 @@ class Experiences extends resource_1.APIResource {
         return this._client.delete((0, path_1.path) `/experiences/${id}`, options);
     }
     /**
-     * Adds an experience to an product, making it accessible to the product's
+     * Attach an experience to a product, making it accessible to the product's
      * customers.
      *
      * Required permissions:
@@ -105,8 +102,8 @@ class Experiences extends resource_1.APIResource {
         return this._client.post((0, path_1.path) `/experiences/${id}/attach`, { body, ...options });
     }
     /**
-     * Removes an experience from an product, making it inaccessible to the product's
-     * customers.
+     * Detach an experience from a product, removing customer access to it through that
+     * product.
      *
      * Required permissions:
      *

package/resources/experiences.js.map

@@ -1 +1 @@
-{"version":3,"file":"experiences.js","sourceRoot":"","sources":["../src/resources/experiences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;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;;;;;;;;;;;OAWG;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,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,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;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,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;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAU,EACV,OAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AA9JD,kCA8JC"}
+{"version":3,"file":"experiences.js","sourceRoot":"","sources":["../src/resources/experiences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,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;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,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;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAU,EACV,OAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AA3JD,kCA2JC"}

package/resources/experiences.mjs

@@ -20,7 +20,7 @@ export class Experiences extends APIResource {
         return this._client.post('/experiences', { body, ...options });
     }
     /**
-     * Retrieves an experience by ID
+     * Retrieves the details of an existing experience.
      *
      * @example
      * ```ts
@@ -48,11 +48,8 @@ export class Experiences extends APIResource {
         return this._client.patch(path `/experiences/${id}`, { body, ...options });
     }
     /**
-     * Lists experiences for a company
-     *
-     * Required permissions:
-     *
-     * - `experience:hidden_experience:read`
+     * Returns a paginated list of experiences belonging to a company, with optional
+     * filtering by product and app.
      *
      * @example
      * ```ts
@@ -83,7 +80,7 @@ export class Experiences extends APIResource {
         return this._client.delete(path `/experiences/${id}`, options);
     }
     /**
-     * Adds an experience to an product, making it accessible to the product's
+     * Attach an experience to a product, making it accessible to the product's
      * customers.
      *
      * Required permissions:
@@ -102,8 +99,8 @@ export class Experiences extends APIResource {
         return this._client.post(path `/experiences/${id}/attach`, { body, ...options });
     }
     /**
-     * Removes an experience from an product, making it inaccessible to the product's
-     * customers.
+     * Detach an experience from a product, removing customer access to it through that
+     * product.
      *
      * Required permissions:
      *

package/resources/experiences.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"experiences.mjs","sourceRoot":"","sources":["../src/resources/experiences.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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;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;;;;;;;;;;;OAWG;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,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAU,EACV,OAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}
+{"version":3,"file":"experiences.mjs","sourceRoot":"","sources":["../src/resources/experiences.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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,IAA4B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,EAAU,EACV,OAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}

package/resources/fee-markups.d.mts

@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class FeeMarkups extends APIResource {
     /**
-     * Creates or updates a fee markup for a company.
+     * Create or update a fee markup for a company. If a markup for the specified fee
+     * type already exists, it will be updated with the new values.
      *
      * Required permissions:
      *
@@ -20,7 +21,8 @@ export declare class FeeMarkups extends APIResource {
      */
     create(body: FeeMarkupCreateParams, options?: RequestOptions): APIPromise<FeeMarkupCreateResponse>;
     /**
-     * Lists fee markups for a company.
+     * Returns a paginated list of fee markups configured for a company. If the company
+     * is a platform account, returns the platform default markups.
      *
      * Required permissions:
      *
@@ -38,7 +40,8 @@ export declare class FeeMarkups extends APIResource {
      */
     list(query: FeeMarkupListParams, options?: RequestOptions): PagePromise<FeeMarkupListResponsesCursorPage, FeeMarkupListResponse>;
     /**
-     * Deletes a fee markup for a company.
+     * Delete a fee markup configuration for a company. This removes the custom fee
+     * override and reverts to the parent company's default fees.
      *
      * Required permissions:
      *
@@ -57,7 +60,8 @@ export type FeeMarkupListResponsesCursorPage = CursorPage<FeeMarkupListResponse>
  */
 export type FeeMarkupType = 'crypto_withdrawal_markup' | 'rtp_withdrawal_markup' | 'next_day_bank_withdrawal_markup' | 'bank_wire_withdrawal_markup' | 'digital_wallet_withdrawal_markup';
 /**
- * Represents a fee markup configuration for a company
+ * A fee markup configuration that defines additional charges applied to
+ * transactions for a platform's connected accounts.
  */
 export interface FeeMarkupCreateResponse {
     /**
@@ -69,19 +73,22 @@ export interface FeeMarkupCreateResponse {
      */
     created_at: string;
     /**
-     * The type of fee this markup applies to.
+     * The category of fee this markup applies to.
      */
     fee_type: FeeMarkupType;
     /**
-     * The fixed fee in USD to charge (0-50).
+     * A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no
+     * fixed fee is configured.
      */
     fixed_fee_usd: number | null;
     /**
-     * Internal notes about this fee markup.
+     * Internal notes about this fee markup, visible only to administrators. Null if no
+     * notes have been added.
      */
     notes: string | null;
     /**
-     * The percentage fee to charge (0-25).
+     * A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no
+     * percentage fee is configured.
      */
     percentage_fee: number | null;
     /**
@@ -90,7 +97,8 @@ export interface FeeMarkupCreateResponse {
     updated_at: string;
 }
 /**
- * Represents a fee markup configuration for a company
+ * A fee markup configuration that defines additional charges applied to
+ * transactions for a platform's connected accounts.
  */
 export interface FeeMarkupListResponse {
     /**
@@ -102,19 +110,22 @@ export interface FeeMarkupListResponse {
      */
     created_at: string;
     /**
-     * The type of fee this markup applies to.
+     * The category of fee this markup applies to.
      */
     fee_type: FeeMarkupType;
     /**
-     * The fixed fee in USD to charge (0-50).
+     * A flat fee charged per transaction, in USD. Ranges from 0 to 50. Null if no
+     * fixed fee is configured.
      */
     fixed_fee_usd: number | null;
     /**
-     * Internal notes about this fee markup.
+     * Internal notes about this fee markup, visible only to administrators. Null if no
+     * notes have been added.
      */
     notes: string | null;
     /**
-     * The percentage fee to charge (0-25).
+     * A percentage-based fee charged per transaction. Ranges from 0 to 25. Null if no
+     * percentage fee is configured.
      */
     percentage_fee: number | null;
     /**
@@ -128,36 +139,36 @@ export interface FeeMarkupListResponse {
 export type FeeMarkupDeleteResponse = boolean;
 export interface FeeMarkupCreateParams {
     /**
-     * The ID (tag) of the company you want to update the fee markup for.
+     * The unique identifier of the company to create or update the fee markup for.
      */
     company_id: string;
     /**
-     * The type of fee this markup applies to.
+     * The type of fee this markup applies to, such as processing or platform fees.
      */
     fee_type: FeeMarkupType;
     /**
-     * The fixed fee in USD to charge (0-50).
+     * The fixed fee amount in USD to charge per transaction. Must be between 0 and 50.
      */
     fixed_fee_usd?: number | null;
     /**
-     * Custom metadata to attach to this fee markup.
+     * Custom key-value metadata to attach to this fee markup.
      */
     metadata?: {
         [key: string]: unknown;
     } | null;
     /**
-     * Internal notes about this fee markup.
+     * Internal notes about this fee markup for record-keeping purposes.
      */
     notes?: string | null;
     /**
-     * The percentage fee to charge (0-25).
+     * The percentage fee to charge per transaction. Must be between 0 and 25.
      */
     percentage_fee?: number | null;
 }
 export interface FeeMarkupListParams extends CursorPageParams {
     /**
-     * The ID (tag) of the company you want to list the fee markups for. If you pass
-     * your platform account, you will get the platform default markups.
+     * The unique identifier of the company to list fee markups for. Pass a platform
+     * account identifier to retrieve platform default markups.
      */
     company_id: string;
     /**

package/resources/fee-markups.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"fee-markups.d.mts","sourceRoot":"","sources":["../src/resources/fee-markups.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIlG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,iCAAiC,GACjC,6BAA6B,GAC7B,kCAAkC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"fee-markups.d.mts","sourceRoot":"","sources":["../src/resources/fee-markups.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIlG;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,iCAAiC,GACjC,6BAA6B,GAC7B,kCAAkC,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}