@mitumba/sdk 2.1.0 → 3.0.0

package/dist/index.d.mts

@@ -2077,7 +2077,9 @@ interface Review {
 interface CreateReviewInput {
     rating: number;
     comment?: string;
-    order_id?: string;
+    /** The delivered/completed order being reviewed. Required: the server rejects a review without it,
+     * and each order may be reviewed at most once. */
+    order_id: string;
 }
 interface ReviewableOrder {
     order_id: string;
@@ -2995,7 +2997,11 @@ declare class ReviewsModule {
         page: number;
     }>;
     /**
-     * Create a review for a store (authenticated).
+     * Create a review for a store (authenticated). `input.order_id` is required.
+     *
+     * @throws {APIError} `review_not_allowed` when the order is not the caller's delivered/completed
+     *   purchase from this store, and `already_reviewed` when the order already has a review (one
+     *   review per order, enforced atomically server-side).
      */
     create(storeId: string, input: CreateReviewInput, options?: RequestOptions): Promise<{
         id: string;

package/dist/index.d.ts

@@ -2077,7 +2077,9 @@ interface Review {
 interface CreateReviewInput {
     rating: number;
     comment?: string;
-    order_id?: string;
+    /** The delivered/completed order being reviewed. Required: the server rejects a review without it,
+     * and each order may be reviewed at most once. */
+    order_id: string;
 }
 interface ReviewableOrder {
     order_id: string;
@@ -2995,7 +2997,11 @@ declare class ReviewsModule {
         page: number;
     }>;
     /**
-     * Create a review for a store (authenticated).
+     * Create a review for a store (authenticated). `input.order_id` is required.
+     *
+     * @throws {APIError} `review_not_allowed` when the order is not the caller's delivered/completed
+     *   purchase from this store, and `already_reviewed` when the order already has a review (one
+     *   review per order, enforced atomically server-side).
      */
     create(storeId: string, input: CreateReviewInput, options?: RequestOptions): Promise<{
         id: string;

package/dist/index.js

@@ -1737,7 +1737,11 @@ var ReviewsModule = class {
     );
   }
   /**
-   * Create a review for a store (authenticated).
+   * Create a review for a store (authenticated). `input.order_id` is required.
+   *
+   * @throws {APIError} `review_not_allowed` when the order is not the caller's delivered/completed
+   *   purchase from this store, and `already_reviewed` when the order already has a review (one
+   *   review per order, enforced atomically server-side).
    */
   async create(storeId, input, options) {
     return this.client.post(`/listings/stores/${storeId}/reviews`, input, options);