merchi_sdk_ts 1.7.6 → 1.7.7

package/dist/entities/product_review.js

@@ -0,0 +1,230 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Entity } from '../entity.js';
+/**
+ * Post-purchase product review. List/create are nested under ``/products/:id/reviews/``;
+ * updates use ``/product-reviews/:id/``. Do not use :meth:`Entity.create` / :meth:`Entity.list`
+ * for this resource.
+ *
+ * API responses use ``jobId``, ``productId``, and ``domainId``; this entity maps those onto
+ * ``job``, ``product``, and ``domain`` (minimal ``{ id }`` objects unless the API nests more).
+ */
+var ProductReview = /** @class */ (function (_super) {
+    __extends(ProductReview, _super);
+    function ProductReview() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Map flat API fields (``jobId``, ``productId``, ``domainId``) to nested
+     * ``job`` / ``product`` / ``domain`` objects before :meth:`Entity.fromJson`.
+     */
+    ProductReview.normalizeApiJson = function (json) {
+        if (json === null || json === undefined || typeof json !== 'object') {
+            return json;
+        }
+        var row = __assign({}, json);
+        if (row.jobId !== undefined && row.job === undefined) {
+            if (row.jobId != null) {
+                row.job = { id: row.jobId };
+            }
+            delete row.jobId;
+        }
+        if (row.productId !== undefined && row.product === undefined) {
+            if (row.productId != null) {
+                row.product = { id: row.productId };
+            }
+            delete row.productId;
+        }
+        if (row.domainId !== undefined && row.domain === undefined) {
+            if (row.domainId != null) {
+                row.domain = { id: row.domainId };
+            }
+            delete row.domainId;
+        }
+        return row;
+    };
+    /**
+     * Domain managers/admins: list reviews for a product.
+     */
+    ProductReview.listForProduct = function (productId, options) {
+        var Constructor = this;
+        var resource = "/products/".concat(productId, "/reviews/");
+        var fetchOptions = { method: 'GET' };
+        fetchOptions.query = [];
+        if (!(options && options.withRights)) {
+            fetchOptions.query.push(['skip_rights', 'y']);
+        }
+        return Constructor.merchi.authenticatedFetch(resource, fetchOptions).then(function (data) {
+            var _a;
+            var raw = (_a = data.productReviews) !== null && _a !== void 0 ? _a : [];
+            return raw.map(function (row) {
+                var e = new Constructor();
+                e.fromJson(ProductReview.normalizeApiJson(row));
+                return e;
+            });
+        });
+    };
+    /**
+     * Buyer: create a review for the catalog ``productId`` (master product).
+     * ``body.job.id`` must be a completed job whose line item resolves to this product.
+     */
+    ProductReview.createForProduct = function (productId, body, options) {
+        var Constructor = this;
+        var resource = "/products/".concat(productId, "/reviews/");
+        var wire = {
+            jobId: body.job.id,
+            rating: body.rating,
+        };
+        if (body.title !== undefined) {
+            wire.title = body.title;
+        }
+        if (body.content !== undefined) {
+            wire.content = body.content;
+        }
+        var fetchOptions = {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(wire),
+        };
+        fetchOptions.query = [];
+        if (!(options && options.withRights)) {
+            fetchOptions.query.push(['skip_rights', 'y']);
+        }
+        return Constructor.merchi.authenticatedFetch(resource, fetchOptions).then(function (data) {
+            var e = new Constructor();
+            e.fromJson(ProductReview.normalizeApiJson(data.productReview));
+            return e;
+        });
+    };
+    /**
+     * Partial update (moderation or author edit). Uses ``multipart/form-data`` fields
+     * matching the Merchi API.
+     */
+    ProductReview.prototype.patch = function (payload, options) {
+        var _this = this;
+        var _a, _b, _c;
+        var id = this.id;
+        if (id === undefined) {
+            throw new Error('ProductReview.id is required to patch');
+        }
+        var resource = "/product-reviews/".concat(String(id), "/");
+        var form = new FormData();
+        if (payload.status !== undefined) {
+            form.set('status', payload.status);
+        }
+        if (payload.rejectionReason !== undefined) {
+            form.set('rejectionReason', (_a = payload.rejectionReason) !== null && _a !== void 0 ? _a : '');
+        }
+        if (payload.rating !== undefined) {
+            form.set('rating', String(payload.rating));
+        }
+        if (payload.title !== undefined) {
+            form.set('title', (_b = payload.title) !== null && _b !== void 0 ? _b : '');
+        }
+        if (payload.content !== undefined) {
+            form.set('content', (_c = payload.content) !== null && _c !== void 0 ? _c : '');
+        }
+        var fetchOptions = { method: 'PATCH', body: form };
+        fetchOptions.query = [];
+        if (!(options && options.withRights)) {
+            fetchOptions.query.push(['skip_rights', 'y']);
+        }
+        var singularName = this.constructor
+            .singularName;
+        return this.merchi.authenticatedFetch(resource, fetchOptions).then(function (data) {
+            _this.fromJson(ProductReview.normalizeApiJson(data[singularName]));
+            _this.cleanDirty();
+            return _this;
+        });
+    };
+    ProductReview.resourceName = 'product-reviews';
+    ProductReview.singularName = 'productReview';
+    ProductReview.pluralName = 'productReviews';
+    __decorate([
+        ProductReview.property(),
+        __metadata("design:type", Number)
+    ], ProductReview.prototype, "id", void 0);
+    __decorate([
+        ProductReview.property({ type: 'Product' }),
+        __metadata("design:type", Function)
+    ], ProductReview.prototype, "product", void 0);
+    __decorate([
+        ProductReview.property({ type: 'Domain' }),
+        __metadata("design:type", Function)
+    ], ProductReview.prototype, "domain", void 0);
+    __decorate([
+        ProductReview.property({ type: Number }),
+        __metadata("design:type", Number)
+    ], ProductReview.prototype, "authorUserId", void 0);
+    __decorate([
+        ProductReview.property({ type: 'Job' }),
+        __metadata("design:type", Function)
+    ], ProductReview.prototype, "job", void 0);
+    __decorate([
+        ProductReview.property({ type: Number }),
+        __metadata("design:type", Number)
+    ], ProductReview.prototype, "rating", void 0);
+    __decorate([
+        ProductReview.property({ type: String }),
+        __metadata("design:type", Object)
+    ], ProductReview.prototype, "title", void 0);
+    __decorate([
+        ProductReview.property({ type: String }),
+        __metadata("design:type", Object)
+    ], ProductReview.prototype, "content", void 0);
+    __decorate([
+        ProductReview.property({ type: String }),
+        __metadata("design:type", String)
+    ], ProductReview.prototype, "status", void 0);
+    __decorate([
+        ProductReview.property({ type: Number }),
+        __metadata("design:type", Object)
+    ], ProductReview.prototype, "purchaseInvoiceId", void 0);
+    __decorate([
+        ProductReview.property({ type: String }),
+        __metadata("design:type", Object)
+    ], ProductReview.prototype, "submittedAt", void 0);
+    __decorate([
+        ProductReview.property({ type: String }),
+        __metadata("design:type", Object)
+    ], ProductReview.prototype, "updatedAt", void 0);
+    __decorate([
+        ProductReview.property({ type: String }),
+        __metadata("design:type", Object)
+    ], ProductReview.prototype, "rejectionReason", void 0);
+    return ProductReview;
+}(Entity));
+export { ProductReview };

package/dist/index.js

@@ -51,6 +51,7 @@ import { Payment } from './entities/payment.js';
 import { PaymentDevice } from './entities/payment_device.js';
 import { PhoneNumber } from './entities/phone_number.js';
 import { Product } from './entities/product.js';
+import { ProductReview } from './entities/product_review.js';
 import { ProductionComment } from './entities/production_comment.js';
 import { Quote } from './entities/quote.js';
 import { QuoteItem } from './entities/quote_item.js';
@@ -82,4 +83,4 @@ import * as constants from './constants/index.js';
 import * as request from './request.js';
 import * as util from './util/index.js';
 import { toastNotifications } from './toasts.js';
-export { constants, request, util, toastNotifications, Address, AgentConversation, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, Component, ComponentTag, ComponentVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, MatchingInventory, Menu, MenuItem, Merchi, MerchiFile, Notification, Page, Payment, PaymentDevice, PhoneNumber, Product, ProductionComment, Quote, QuoteItem, Reminder, apiFetch, apiFetchWithProgress, Session, Shipment, ShipmentLog, ShipmentItem, ShipmentItemFulfillment, ShipmentMethod, ShipmentMethodVariation, ShortUrl, SubscriptionPlan, SupplyDomain, SystemRole, Theme, ThemeCssSetting, User, UserCompany, Variation, VariationField, VariationFieldsOption, VariationOption, VariationsGroup, generateUUID, getCookie };
+export { constants, request, util, toastNotifications, Address, AgentConversation, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, Component, ComponentTag, ComponentVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, MatchingInventory, Menu, MenuItem, Merchi, MerchiFile, Notification, Page, Payment, PaymentDevice, PhoneNumber, Product, ProductReview, ProductionComment, Quote, QuoteItem, Reminder, apiFetch, apiFetchWithProgress, Session, Shipment, ShipmentLog, ShipmentItem, ShipmentItemFulfillment, ShipmentMethod, ShipmentMethodVariation, ShortUrl, SubscriptionPlan, SupplyDomain, SystemRole, Theme, ThemeCssSetting, User, UserCompany, Variation, VariationField, VariationFieldsOption, VariationOption, VariationsGroup, generateUUID, getCookie };

package/dist/merchi.js

@@ -20,6 +20,7 @@ import { VariationField } from './entities/variation_field.js';
 import { VariationOption } from './entities/variation_option.js';
 import { ProductionComment } from './entities/production_comment.js';
 import { Product } from './entities/product.js';
+import { ProductReview } from './entities/product_review.js';
 import { InternalTag } from './entities/internal_tag.js';
 import { Inventory } from './entities/inventory.js';
 import { InventoryGroup } from './entities/inventory_group.js';
@@ -254,6 +255,7 @@ var Merchi = /** @class */ (function () {
         this.CountryTax = this.setupClass(CountryTax);
         this.ShortUrl = this.setupClass(ShortUrl);
         this.Product = this.setupClass(Product);
+        this.ProductReview = this.setupClass(ProductReview);
         this.SystemRole = this.setupClass(SystemRole);
         this.CartItem = this.setupClass(CartItem);
         this.UserCompany = this.setupClass(UserCompany);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_sdk_ts",
-  "version": "1.7.6",
+  "version": "1.7.7",
   "main": "dist/index.js",
   "type": "module",
   "repository": "git@github.com:merchisdk/merchi_sdk_ts.git",

package/src/entities/product_review.ts

@@ -0,0 +1,218 @@
+import { Entity } from '../entity.js';
+import type { RequestOptions } from '../request.js';
+import type { Domain } from './domain.js';
+import type { Job } from './job.js';
+import type { Product } from './product.js';
+
+/** Create payload; the API expects ``jobId`` — pass ``job`` with at least ``id``. */
+export interface ProductReviewCreateInput {
+  job: { id: number };
+  rating: number;
+  title?: string | null;
+  content?: string | null;
+}
+
+export interface ProductReviewPatchInput {
+  status?: string;
+  rejectionReason?: string | null;
+  rating?: number;
+  title?: string | null;
+  content?: string | null;
+}
+
+/**
+ * Post-purchase product review. List/create are nested under ``/products/:id/reviews/``;
+ * updates use ``/product-reviews/:id/``. Do not use :meth:`Entity.create` / :meth:`Entity.list`
+ * for this resource.
+ *
+ * API responses use ``jobId``, ``productId``, and ``domainId``; this entity maps those onto
+ * ``job``, ``product``, and ``domain`` (minimal ``{ id }`` objects unless the API nests more).
+ */
+export class ProductReview extends Entity {
+  protected static resourceName = 'product-reviews';
+  protected static singularName = 'productReview';
+  protected static pluralName = 'productReviews';
+
+  @ProductReview.property()
+  public id?: number;
+
+  @ProductReview.property({ type: 'Product' })
+  public product?: Product;
+
+  @ProductReview.property({ type: 'Domain' })
+  public domain?: Domain;
+
+  @ProductReview.property({ type: Number })
+  public authorUserId?: number;
+
+  @ProductReview.property({ type: 'Job' })
+  public job?: Job;
+
+  @ProductReview.property({ type: Number })
+  public rating?: number;
+
+  @ProductReview.property({ type: String })
+  public title?: string | null;
+
+  @ProductReview.property({ type: String })
+  public content?: string | null;
+
+  @ProductReview.property({ type: String })
+  public status?: string;
+
+  @ProductReview.property({ type: Number })
+  public purchaseInvoiceId?: number | null;
+
+  /** ISO 8601 string from the API. */
+  @ProductReview.property({ type: String })
+  public submittedAt?: string | null;
+
+  /** ISO 8601 string from the API. */
+  @ProductReview.property({ type: String })
+  public updatedAt?: string | null;
+
+  @ProductReview.property({ type: String })
+  public rejectionReason?: string | null;
+
+  /**
+   * Map flat API fields (``jobId``, ``productId``, ``domainId``) to nested
+   * ``job`` / ``product`` / ``domain`` objects before :meth:`Entity.fromJson`.
+   */
+  public static normalizeApiJson(json: any): any {
+    if (json === null || json === undefined || typeof json !== 'object') {
+      return json;
+    }
+    const row: any = { ...json };
+    if (row.jobId !== undefined && row.job === undefined) {
+      if (row.jobId != null) {
+        row.job = { id: row.jobId };
+      }
+      delete row.jobId;
+    }
+    if (row.productId !== undefined && row.product === undefined) {
+      if (row.productId != null) {
+        row.product = { id: row.productId };
+      }
+      delete row.productId;
+    }
+    if (row.domainId !== undefined && row.domain === undefined) {
+      if (row.domainId != null) {
+        row.domain = { id: row.domainId };
+      }
+      delete row.domainId;
+    }
+    return row;
+  }
+
+  /**
+   * Domain managers/admins: list reviews for a product.
+   */
+  public static listForProduct(
+    this: typeof ProductReview,
+    productId: number,
+    options?: { withRights?: boolean }
+  ): Promise<ProductReview[]> {
+    const Constructor = this;
+    const resource = `/products/${productId}/reviews/`;
+    const fetchOptions: RequestOptions = { method: 'GET' };
+    fetchOptions.query = [];
+    if (!(options && options.withRights)) {
+      fetchOptions.query.push(['skip_rights', 'y']);
+    }
+    return Constructor.merchi.authenticatedFetch(resource, fetchOptions).then(
+      (data: any) => {
+        const raw = data.productReviews ?? [];
+        return raw.map((row: any) => {
+          const e: ProductReview = new Constructor() as ProductReview;
+          e.fromJson(ProductReview.normalizeApiJson(row));
+          return e;
+        });
+      }
+    );
+  }
+
+  /**
+   * Buyer: create a review for the catalog ``productId`` (master product).
+   * ``body.job.id`` must be a completed job whose line item resolves to this product.
+   */
+  public static createForProduct(
+    this: typeof ProductReview,
+    productId: number,
+    body: ProductReviewCreateInput,
+    options?: { withRights?: boolean }
+  ): Promise<ProductReview> {
+    const Constructor = this;
+    const resource = `/products/${productId}/reviews/`;
+    const wire: Record<string, unknown> = {
+      jobId: body.job.id,
+      rating: body.rating,
+    };
+    if (body.title !== undefined) {
+      wire.title = body.title;
+    }
+    if (body.content !== undefined) {
+      wire.content = body.content;
+    }
+    const fetchOptions: RequestOptions = {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(wire),
+    };
+    fetchOptions.query = [];
+    if (!(options && options.withRights)) {
+      fetchOptions.query.push(['skip_rights', 'y']);
+    }
+    return Constructor.merchi.authenticatedFetch(resource, fetchOptions).then(
+      (data: any) => {
+        const e: ProductReview = new Constructor() as ProductReview;
+        e.fromJson(ProductReview.normalizeApiJson(data.productReview));
+        return e;
+      }
+    );
+  }
+
+  /**
+   * Partial update (moderation or author edit). Uses ``multipart/form-data`` fields
+   * matching the Merchi API.
+   */
+  public patch(
+    payload: ProductReviewPatchInput,
+    options?: { withRights?: boolean }
+  ): Promise<this> {
+    const id = this.id;
+    if (id === undefined) {
+      throw new Error('ProductReview.id is required to patch');
+    }
+    const resource = `/product-reviews/${String(id)}/`;
+    const form = new FormData();
+    if (payload.status !== undefined) {
+      form.set('status', payload.status);
+    }
+    if (payload.rejectionReason !== undefined) {
+      form.set('rejectionReason', payload.rejectionReason ?? '');
+    }
+    if (payload.rating !== undefined) {
+      form.set('rating', String(payload.rating));
+    }
+    if (payload.title !== undefined) {
+      form.set('title', payload.title ?? '');
+    }
+    if (payload.content !== undefined) {
+      form.set('content', payload.content ?? '');
+    }
+    const fetchOptions: RequestOptions = { method: 'PATCH', body: form };
+    fetchOptions.query = [];
+    if (!(options && options.withRights)) {
+      fetchOptions.query.push(['skip_rights', 'y']);
+    }
+    const singularName = (this.constructor as typeof ProductReview)
+      .singularName;
+    return this.merchi.authenticatedFetch(resource, fetchOptions).then(
+      (data: any) => {
+        this.fromJson(ProductReview.normalizeApiJson(data[singularName]));
+        this.cleanDirty();
+        return this;
+      }
+    );
+  }
+}

package/src/index.ts

@@ -51,6 +51,11 @@ import { Payment } from './entities/payment.js';
 import { PaymentDevice } from './entities/payment_device.js';
 import { PhoneNumber } from './entities/phone_number.js';
 import { Product } from './entities/product.js';
+import { ProductReview } from './entities/product_review.js';
+export type {
+  ProductReviewCreateInput,
+  ProductReviewPatchInput,
+} from './entities/product_review.js';
 import { ProductionComment } from './entities/production_comment.js';
 import { Quote } from './entities/quote.js';
 import { QuoteItem } from './entities/quote_item.js';
@@ -142,6 +147,7 @@ export {
   PaymentDevice,
   PhoneNumber,
   Product,
+  ProductReview,
   ProductionComment,
   Quote,
   QuoteItem,

package/src/merchi.ts

@@ -14,6 +14,7 @@ import { VariationField } from './entities/variation_field.js';
 import { VariationOption } from './entities/variation_option.js';
 import { ProductionComment } from './entities/production_comment.js';
 import { Product } from './entities/product.js';
+import { ProductReview } from './entities/product_review.js';
 import { InternalTag } from './entities/internal_tag.js';
 import { Inventory } from './entities/inventory.js';
 import { InventoryGroup } from './entities/inventory_group.js';
@@ -155,6 +156,7 @@ export class Merchi {
   public Job: typeof Job;
   public DomainInvitation: typeof DomainInvitation;
   public Product: typeof Product;
+  public ProductReview: typeof ProductReview;
   public DomainTag: typeof DomainTag;
   public EmailAddress: typeof EmailAddress;
   public PhoneNumber: typeof PhoneNumber;
@@ -330,6 +332,9 @@ export class Merchi {
     this.CountryTax = this.setupClass(CountryTax) as typeof CountryTax;
     this.ShortUrl = this.setupClass(ShortUrl) as typeof ShortUrl;
     this.Product = this.setupClass(Product) as typeof Product;
+    this.ProductReview = this.setupClass(
+      ProductReview
+    ) as typeof ProductReview;
     this.SystemRole = this.setupClass(SystemRole) as typeof SystemRole;
     this.CartItem = this.setupClass(CartItem) as typeof CartItem;
     this.UserCompany = this.setupClass(UserCompany) as typeof UserCompany;