@whop/sdk 0.0.26 → 0.0.28

package/resources/reviews.d.ts

@@ -4,11 +4,12 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Reviews extends APIResource {
     /**
-     * Retrieve a review by its ID
+     * Retrieves the details of an existing review.
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<ReviewRetrieveResponse>;
     /**
-     * List all reviews
+     * Returns a paginated list of customer reviews for a specific product, with
+     * optional filtering by star rating and creation date.
      */
     list(query: ReviewListParams, options?: RequestOptions): PagePromise<ReviewListResponsesCursorPage, ReviewListResponse>;
 }
@@ -18,64 +19,67 @@ export type ReviewListResponsesCursorPage = CursorPage<ReviewListResponse>;
  */
 export type ReviewStatus = 'pending' | 'published' | 'removed';
 /**
- * An object representing a user review of a company.
+ * A user-submitted review of a company, including a star rating and optional text
+ * feedback.
  */
 export interface ReviewRetrieveResponse {
     /**
-     * The internal ID of the review.
+     * The unique identifier for the review.
      */
     id: string;
     /**
-     * The attachments attached to the review.
+     * A list of files and media attached to the review.
      */
     attachments: Array<ReviewRetrieveResponse.Attachment>;
     /**
-     * The company the review is for.
+     * The company that this review was written for.
      */
     company: ReviewRetrieveResponse.Company;
     /**
-     * The timestamp of when the review was created.
+     * The datetime the review was created.
      */
     created_at: string;
     /**
-     * The description of the review.
+     * The body text of the review containing the user's detailed feedback. Returns an
+     * empty string if no description was provided.
      */
     description: string | null;
     /**
-     * The timestamp of when the user joined the product.
+     * The timestamp of when the reviewer first joined the product. Null if unknown.
      */
     joined_at: string | null;
     /**
-     * Whether or not the user paid for the product. If null, the payment status is
+     * Whether the reviewer paid for the product. Null if the payment status is
      * unknown.
      */
     paid_for_product: boolean | null;
     /**
-     * The product the review is for.
+     * The product that this review was written for.
      */
     product: ReviewRetrieveResponse.Product;
     /**
-     * The timestamp of when the review was published.
+     * The timestamp of when the review was published. Null if the review has not been
+     * published yet.
      */
     published_at: string | null;
     /**
-     * The number of stars the user gave the product.
+     * The star rating given by the reviewer, from 1 to 5.
      */
     stars: number;
     /**
-     * The status of the review.
+     * The current moderation status of the review.
      */
     status: ReviewStatus;
     /**
-     * The title of the review.
+     * A short summary title for the review. Null if the reviewer did not provide one.
      */
     title: string | null;
     /**
-     * The timestamp of when the review was last updated.
+     * The datetime the review was last updated.
      */
     updated_at: string;
     /**
-     * The user account that performed the action.
+     * The user account of the person who wrote this review.
      */
     user: ReviewRetrieveResponse.User;
 }
@@ -85,122 +89,130 @@ export declare namespace ReviewRetrieveResponse {
      */
     interface Attachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * 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;
     }
     /**
-     * The company the review is for.
+     * The company that this review was written for.
      */
     interface Company {
         /**
-         * The ID (tag) of the company.
+         * The unique identifier for the company.
          */
         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 product the review is for.
+     * The product that this review was written for.
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
     /**
-     * The user account that performed the action.
+     * The user account of the person who wrote this review.
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
-         * The name of the user from their Whop account.
+         * The user's display name shown on their public profile.
          */
         name: string | null;
         /**
-         * The username of the user from their Whop account.
+         * The user's unique username shown on their public profile.
          */
         username: string;
     }
 }
 /**
- * An object representing a user review of a company.
+ * A user-submitted review of a company, including a star rating and optional text
+ * feedback.
  */
 export interface ReviewListResponse {
     /**
-     * The internal ID of the review.
+     * The unique identifier for the review.
      */
     id: string;
     /**
-     * The attachments attached to the review.
+     * A list of files and media attached to the review.
      */
     attachments: Array<ReviewListResponse.Attachment>;
     /**
-     * The timestamp of when the review was created.
+     * The datetime the review was created.
      */
     created_at: string;
     /**
-     * The description of the review.
+     * The body text of the review containing the user's detailed feedback. Returns an
+     * empty string if no description was provided.
      */
     description: string | null;
     /**
-     * The timestamp of when the user joined the product.
+     * The timestamp of when the reviewer first joined the product. Null if unknown.
      */
     joined_at: string | null;
     /**
-     * Whether or not the user paid for the product. If null, the payment status is
+     * Whether the reviewer paid for the product. Null if the payment status is
      * unknown.
      */
     paid_for_product: boolean | null;
     /**
-     * The timestamp of when the review was published.
+     * The timestamp of when the review was published. Null if the review has not been
+     * published yet.
      */
     published_at: string | null;
     /**
-     * The number of stars the user gave the product.
+     * The star rating given by the reviewer, from 1 to 5.
      */
     stars: number;
     /**
-     * The status of the review.
+     * The current moderation status of the review.
      */
     status: ReviewStatus;
     /**
-     * The title of the review.
+     * A short summary title for the review. Null if the reviewer did not provide one.
      */
     title: string | null;
     /**
-     * The timestamp of when the review was last updated.
+     * The datetime the review was last updated.
      */
     updated_at: string;
     /**
-     * The user account that performed the action.
+     * The user account of the person who wrote this review.
      */
     user: ReviewListResponse.User;
 }
@@ -210,44 +222,48 @@ export declare namespace ReviewListResponse {
      */
     interface Attachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * 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;
     }
     /**
-     * The user account that performed the action.
+     * The user account of the person who wrote this review.
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
-         * The name of the user from their Whop account.
+         * The user's display name shown on their public profile.
          */
         name: string | null;
         /**
-         * The username of the user from their Whop account.
+         * The user's unique username shown on their public profile.
          */
         username: string;
     }
 }
 export interface ReviewListParams extends CursorPageParams {
     /**
-     * The ID of the product
+     * The unique identifier of the product to list reviews for.
      */
     product_id: string;
     /**
@@ -255,11 +271,11 @@ export interface ReviewListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return reviews created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return reviews created before this timestamp.
      */
     created_before?: string | null;
     /**
@@ -271,11 +287,11 @@ export interface ReviewListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * The maximum star rating of the review (inclusive)
+     * The maximum star rating to include in results, from 1 to 5 inclusive.
      */
     max_stars?: number | null;
     /**
-     * The minimum star rating of the review (inclusive)
+     * The minimum star rating to include in results, from 1 to 5 inclusive.
      */
     min_stars?: number | null;
 }

package/resources/reviews.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../src/resources/reviews.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,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;OAEG;IACH,IAAI,CACF,KAAK,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;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,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;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;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;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,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../src/resources/reviews.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,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;;OAGG;IACH,IAAI,CACF,KAAK,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAExC;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;;;;WAMG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;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,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;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;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;;;;WAMG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;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,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/reviews.js

@@ -7,13 +7,14 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class Reviews extends resource_1.APIResource {
     /**
-     * Retrieve a review by its ID
+     * Retrieves the details of an existing review.
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/reviews/${id}`, options);
     }
     /**
-     * List all reviews
+     * Returns a paginated list of customer reviews for a specific product, with
+     * optional filtering by star rating and creation date.
      */
     list(query, options) {
         return this._client.getAPIList('/reviews', (pagination_1.CursorPage), { query, ...options });

package/resources/reviews.js.map

@@ -1 +1 @@
-{"version":3,"file":"reviews.js","sourceRoot":"","sources":["../src/resources/reviews.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;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;;OAEG;IACH,IAAI,CACF,KAAuB,EACvB,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;AAjBD,0BAiBC"}
+{"version":3,"file":"reviews.js","sourceRoot":"","sources":["../src/resources/reviews.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;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;;;OAGG;IACH,IAAI,CACF,KAAuB,EACvB,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;AAlBD,0BAkBC"}

package/resources/reviews.mjs

@@ -4,13 +4,14 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class Reviews extends APIResource {
     /**
-     * Retrieve a review by its ID
+     * Retrieves the details of an existing review.
      */
     retrieve(id, options) {
         return this._client.get(path `/reviews/${id}`, options);
     }
     /**
-     * List all reviews
+     * Returns a paginated list of customer reviews for a specific product, with
+     * optional filtering by star rating and creation date.
      */
     list(query, options) {
         return this._client.getAPIList('/reviews', (CursorPage), { query, ...options });

package/resources/reviews.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"reviews.mjs","sourceRoot":"","sources":["../src/resources/reviews.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;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;;OAEG;IACH,IAAI,CACF,KAAuB,EACvB,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":"reviews.mjs","sourceRoot":"","sources":["../src/resources/reviews.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;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;;;OAGG;IACH,IAAI,CACF,KAAuB,EACvB,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"}