@merchi/sdk 1.42.15 → 1.42.17

package/dist/entities/job.d.ts

@@ -0,0 +1,156 @@
+import { Address } from './address.js';
+import { Assignment } from './assignment.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { Draft } from './draft.js';
+import { DraftComment } from './draft_comment.js';
+import { EmailAddress } from './email_address.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { MatchingInventory } from './matching_inventory.js';
+import { InternalTag } from './internal_tag.js';
+import { Invoice } from './invoice.js';
+import { JobComment } from './job_comment.js';
+import { JobNote } from './job_note.js';
+import { JobOperationLog } from './job_operation_log.js';
+import { Notification } from './notification.js';
+import { PhoneNumber } from './phone_number.js';
+import { Product } from './product.js';
+import { Reminder } from './reminder.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+import { Variation } from './variation.js';
+import { VariationsGroup } from './variations_group.js';
+import { InventoryStatus } from '../constants/inventory_statuses.js';
+import { Item } from './item.js';
+export declare class Job extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    jobType?: number;
+    quantity?: number;
+    currency?: string;
+    jobNotes?: JobNote[];
+    operationLogs?: JobOperationLog[];
+    shopifyShopUrl?: string | null;
+    shopifyOrderId?: string;
+    shopifyOrderLineItemId?: string;
+    productionStatus?: number | null;
+    productionQuotingSpec?: string | null;
+    productionSpecChanged?: boolean;
+    productionQuotingReopened?: boolean;
+    designStatus?: number | null;
+    supplyChainRequestStatus?: number | null;
+    needsDrafting?: boolean;
+    assignToAgent?: boolean;
+    agentLastRunAt?: Date | null;
+    agentNextCheckAt?: Date | null;
+    needsGroupBuy?: boolean;
+    needsProduction?: boolean;
+    needsShipping?: boolean;
+    sendWhatsapp?: boolean;
+    needsInvoicing?: boolean;
+    needsInventory?: boolean;
+    needsSupplyChainRequest?: boolean;
+    showProductionFilesToClient?: boolean;
+    allowClientDraftContribution?: boolean;
+    quoteSet?: boolean;
+    jobInfoApprovedByClient?: boolean;
+    groupBuyStatus?: number | null;
+    paymentStatus?: number | null;
+    deductionDate?: Date | null;
+    shippingStatus?: number | null;
+    completed?: boolean;
+    callToActions?: string;
+    callToActionDetails?: any[];
+    priority?: number;
+    jobWeight?: number | null;
+    jobVolume?: number | null;
+    received?: Date;
+    deadline?: Date;
+    updated?: Date;
+    dateLastActioned?: Date | null;
+    dateFirstActioned?: Date | null;
+    groupBuyProductionStarted?: Date;
+    automaticPriceEnabled?: boolean;
+    dropShip?: boolean;
+    pickUp?: boolean;
+    costPerUnit?: number | null;
+    cost?: number | null;
+    taxAmount?: number | null;
+    totalCost?: number | null;
+    inventoriesStatus?: InventoryStatus;
+    unreadNotificationsCount?: number;
+    unreadJobInfoNotificationsCount?: number;
+    unreadJobDraftingNotificationsCount?: number;
+    unreadJobProductionNotificationsCount?: number;
+    unreadJobShippingNotificationsCount?: number;
+    unreadJobInvoicingNotificationsCount?: number;
+    limitedStock?: boolean;
+    inventoryCount?: number;
+    inventorySufficient?: boolean;
+    items?: Item[];
+    drafts?: Draft[];
+    sharedDrafts?: Draft[];
+    ownDrafts?: Draft[];
+    comments?: JobComment[];
+    client?: User;
+    clientBrowser?: string;
+    clientDevice?: string;
+    clientOs?: string;
+    clientIp?: string;
+    clientOrigin?: string;
+    sourceChannel?: string | null;
+    utmSource?: string | null;
+    utmMedium?: string | null;
+    utmCampaign?: string | null;
+    utmContent?: string | null;
+    utmTerm?: string | null;
+    sourceClickId?: string | null;
+    sourceLanding?: string | null;
+    sourceReferrer?: string | null;
+    checkoutType?: string | null;
+    manager?: User | null;
+    designer?: User | null;
+    clientCompany?: Company | null;
+    notificationSubscribers?: User[];
+    clientPhone?: PhoneNumber | null;
+    clientEmail?: EmailAddress | null;
+    clientCompanyPhone?: PhoneNumber | null;
+    clientCompanyEmail?: EmailAddress | null;
+    product?: Product;
+    supplyChainRequestProduct?: Product;
+    draftComments?: DraftComment[];
+    preDraftCommentsCount?: number;
+    taxType?: CountryTax | null;
+    internalTags?: InternalTag[];
+    tags?: DomainTag[];
+    createdProducts?: Product[];
+    shipping?: Address | null;
+    productionShippingAddress?: Address | null;
+    domain?: Domain;
+    invoice?: Invoice | null;
+    productionFiles?: MerchiFile[];
+    clientFiles?: MerchiFile[];
+    shipment?: Shipment | null;
+    matchingInventories?: MatchingInventory[];
+    variationsGroups?: VariationsGroup[];
+    variations?: Variation[];
+    notifications?: Notification[];
+    assignments?: Assignment[];
+    reminders?: Reminder[];
+    supplyAssignment?: Assignment;
+    supplyJob?: Job;
+    supplyQuoteTotalCost?: number;
+    hasValidVolume?: boolean;
+    hasValidWeight?: boolean;
+    isNewClient?: boolean;
+    isTest?: boolean;
+    getQuote: () => Promise<this>;
+    deduct: (matchingInventories: MatchingInventory[]) => Promise<this>;
+    bulkDeduct: () => Promise<this>;
+}

package/dist/entities/job.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/job_comment.d.ts

@@ -0,0 +1,24 @@
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Job } from './job.js';
+import { Notification } from './notification.js';
+import { User } from './user.js';
+export declare class JobComment extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    date?: Date | null;
+    text?: string;
+    sendSms?: boolean;
+    sendEmail?: boolean;
+    sendWhatsapp?: boolean;
+    openToClient?: boolean;
+    urgency?: number;
+    files?: MerchiFile[];
+    forwards?: User[];
+    notifications?: Notification[];
+    job?: Job;
+    user?: User;
+}

package/dist/entities/job_comment.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/job_note.d.ts

@@ -0,0 +1,19 @@
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Job } from './job.js';
+import { User } from './user.js';
+export declare class JobNote extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    noteType?: number;
+    richText?: string;
+    creationDate?: Date | null;
+    lastEditedTime?: Date | null;
+    files?: MerchiFile[];
+    job?: Job;
+    createdBy?: User;
+    lastEditedBy?: User;
+}

package/dist/entities/job_operation_log.d.ts

@@ -0,0 +1,18 @@
+import { Entity } from '../entity.js';
+import type { Job } from './job.js';
+import { User } from './user.js';
+export declare class JobOperationLog extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: string;
+    job?: Job | null;
+    user?: User | null;
+    sourceType?: string;
+    aiInvolved?: boolean;
+    action?: string;
+    payloadJson?: Record<string, unknown> | null;
+    changesJson?: Record<string, unknown> | null;
+    operationJson?: Record<string, unknown> | null;
+    createdAt?: Date | null;
+}

package/dist/entities/job_operation_log.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/matching_inventory.d.ts

@@ -0,0 +1,16 @@
+import { Entity } from '../entity.js';
+import { Job } from './job.js';
+import { Inventory } from './inventory.js';
+import { VariationsGroup } from './variations_group.js';
+import { InventoryStatus } from '../constants/inventory_statuses.js';
+export declare class MatchingInventory extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    deductionDate?: Date | null;
+    job?: Job;
+    group?: VariationsGroup | null;
+    inventory?: Inventory | null;
+    status?: InventoryStatus;
+}

package/dist/entities/notification.d.ts

@@ -0,0 +1,47 @@
+import { Assignment } from './assignment.js';
+import { Domain } from './domain.js';
+import { Draft } from './draft.js';
+import { DraftComment } from './draft_comment.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { JobComment } from './job_comment.js';
+import { ProductionComment } from './production_comment.js';
+import { Reminder } from './reminder.js';
+import { ShortUrl } from './short_url.js';
+import { User } from './user.js';
+export declare class Notification extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    notificationType?: number;
+    date?: Date;
+    emailOpenedAt?: Date | null;
+    seen?: boolean;
+    sendEmail?: boolean;
+    sendSms?: boolean;
+    urgency?: number;
+    description?: string | null;
+    subject?: string | null;
+    message?: string;
+    htmlMessage?: string;
+    link?: string | null;
+    section?: number;
+    shortUrl?: ShortUrl | null;
+    recipient?: User;
+    sender?: User | null;
+    relatedJob?: Job | null;
+    relatedDraft?: Draft | null;
+    relatedAssignment?: Assignment | null;
+    relatedInvoice?: Invoice | null;
+    relatedJobComment?: JobComment | null;
+    relatedDraftComment?: DraftComment | null;
+    relatedProductionComment?: ProductionComment | null;
+    domain?: Domain;
+    avatar?: MerchiFile | null;
+    attachment?: MerchiFile | null;
+    reminders?: Reminder[];
+}

package/dist/entities/notification.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/payment.d.ts

@@ -0,0 +1,28 @@
+import { Entity } from '../entity.js';
+import { Invoice } from './invoice.js';
+import { User } from './user.js';
+import { AutomaticPaymentRelationship } from './automatic_payment_relationship.js';
+export declare class Payment extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    payDate?: Date;
+    paymentType?: number;
+    paymentProvider?: string;
+    paymentMethod?: string;
+    refundedAmount?: number;
+    refundStatus?: string | null;
+    note?: string;
+    amount?: number;
+    autoRefundable?: boolean;
+    refunded?: Date | null;
+    sendSms?: boolean;
+    sendEmail?: boolean;
+    invoice?: Invoice | null;
+    paymentRecorder?: User | null;
+    refundIssuer?: User | null;
+    chargedByPaymentRelationship?: AutomaticPaymentRelationship | null;
+    refund: () => Promise<this>;
+}

package/dist/entities/payment.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/payment_device.d.ts

@@ -0,0 +1,14 @@
+import { Entity } from '../entity.js';
+import { Company } from './company.js';
+export declare class PaymentDevice extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    code?: string;
+    deviceId?: string;
+    squareId?: string;
+    deviceData?: string;
+    company?: Company | null;
+}

package/dist/entities/payment_device.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/phone_number.d.ts

@@ -0,0 +1,17 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class PhoneNumber extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    number?: string;
+    code?: string;
+    users?: User[];
+    companies?: Company[];
+    paymentCompanies?: Company[];
+    localFormatNumber?: string;
+    internationalFormatNumber?: string;
+}

package/dist/entities/phone_number.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/product.d.ts

@@ -0,0 +1,148 @@
+import { CartItem } from './cart_item.js';
+import { Category } from './category.js';
+import { Company } from './company.js';
+import { ProductForm } from './product_form.js';
+import { CountryTax } from './country_tax.js';
+import { DiscountGroup } from './discount_group.js';
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { DraftPreview } from './draft_preview.js';
+import { DraftTemplate } from './draft_template.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Reminder } from './reminder.js';
+import { InternalTag } from './internal_tag.js';
+import { Inventory } from './inventory.js';
+import { InventoryGroup } from './inventory_group.js';
+import { SupplyDomain } from './supply_domain.js';
+import { User } from './user.js';
+import { VariationField } from './variation_field.js';
+import { ShipmentMethod } from './shipment_method.js';
+import { AutoAssignProductionOnAction } from '../constants/auto_assign_production_on_actions.js';
+import { Job } from './job.js';
+export declare class Product extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    position?: number;
+    created?: Date;
+    updated?: Date;
+    storefrontLastDeployed?: Date | null;
+    createdBy?: User | null;
+    designer?: User | null;
+    updatedBy?: User | null;
+    productType?: number;
+    minimum?: number;
+    defaultQuantity?: number;
+    minimumPrice?: number;
+    setupPrice?: number;
+    setupPerGroup?: boolean;
+    minimumPerGroup?: boolean;
+    groupsFirst?: boolean;
+    independentVariationColumns?: number;
+    groupVariationColumns?: number;
+    deliveryDaysNormal?: number;
+    unitPrice?: number;
+    buyUnitPrice?: number;
+    unitPriceDiscountGroup?: DiscountGroup | null;
+    shipmentMethods?: ShipmentMethod[];
+    margin?: number;
+    unitWeight?: number | null;
+    unitHeight?: number | null;
+    unitWidth?: number | null;
+    unitDepth?: number | null;
+    name?: string;
+    country?: string;
+    currency?: string;
+    description?: string | null;
+    notes?: string | null;
+    internalUseNotes?: string;
+    internalUseAiContext?: string;
+    aiContext?: string;
+    googleMerchantCenterId?: string;
+    googleMerchantCenterTitle?: string;
+    googleMerchantCenterDescription?: string;
+    googleMerchantCenterProductUrl?: string;
+    googleMerchantCenterPrice?: number;
+    shopifyProductId?: string | null;
+    spProductId?: string | null;
+    useCompanyShipmentMethods?: boolean;
+    dropShipment?: boolean;
+    needsDrafting?: boolean;
+    needsProduction?: boolean;
+    needsShipping?: boolean;
+    needsInvoicing?: boolean;
+    needsInventory?: boolean;
+    featureDeadline?: Date;
+    showFeatureDeadline?: boolean;
+    showPublic?: boolean;
+    isDraft?: boolean;
+    showGroupBuyStatus?: boolean;
+    groupBuyStatus?: number | null;
+    acceptSquare?: boolean;
+    acceptStripe?: boolean;
+    acceptPaypal?: boolean;
+    acceptUtrust?: boolean;
+    acceptBankTransfer?: boolean;
+    acceptPhonePayment?: boolean;
+    allowAddToCart?: boolean;
+    allowAutomaticPaymentSupply?: boolean;
+    allowGroupBuy?: boolean;
+    allowPaymentUpfront?: boolean;
+    allowQuotation?: boolean;
+    allowChainedInventoryCreation?: boolean;
+    allowClientDraftContribution?: boolean;
+    allowAdditionalDesignObjects?: boolean;
+    chainedInventoryHandlingUnitPrice?: number;
+    bestPrice?: number;
+    unitVolume?: number;
+    categories?: Category[];
+    platformCategories?: Category[];
+    discountGroups?: DiscountGroup[];
+    domain?: Domain;
+    taxType?: CountryTax | null;
+    originalProduct?: Product | null;
+    clonedFromProduct?: Product | null;
+    chainedSupplierProduct?: Product | null;
+    chainedSellerProducts?: Product[];
+    chainedInventorySupplierProduct?: Product | null;
+    chainedInventorySellerProducts?: Product[];
+    productForm?: ProductForm | null;
+    images?: MerchiFile[];
+    publicFiles?: MerchiFile[];
+    productionFiles?: MerchiFile[];
+    groupVariationFields?: VariationField[];
+    independentVariationFields?: VariationField[];
+    tags?: DomainTag[];
+    internalTags?: InternalTag[];
+    featureImage?: MerchiFile | null;
+    createdByJob?: Job | null;
+    defaultJob?: Job | null;
+    savedByCompanies?: Company[];
+    suppliedByDomains?: SupplyDomain[];
+    autoAssignProductionOnAction?: AutoAssignProductionOnAction;
+    supplyDomains?: SupplyDomain[];
+    inventoriesOpen?: boolean;
+    clientSideCalculation?: boolean;
+    supplyChainDisabled?: boolean;
+    inventories?: Inventory[];
+    inventoryGroups?: InventoryGroup[];
+    cartItems?: CartItem[];
+    jobs?: Job[];
+    reminders?: Reminder[];
+    supplyChainRequestJobs?: Job[];
+    savedByUsers?: User[];
+    suppliers?: User[];
+    draftTemplates?: DraftTemplate[];
+    draftPreviews?: DraftPreview[];
+    duplicate: () => Promise<Product>;
+    primaryImage: () => MerchiFile | null;
+    hasGroupVariationFields: () => boolean;
+    hasIndependentVariationFields: () => boolean;
+    allVariationFields: () => VariationField[];
+    buildEmptyVariations: () => import("./variation.js").Variation[];
+    buildEmptyVariationGroup: () => import("./variations_group.js").VariationsGroup;
+    removeVariationField: (variationField: VariationField) => VariationField[];
+}

package/dist/entities/product.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/product_form.d.ts

@@ -0,0 +1,22 @@
+import { Entity } from '../entity.js';
+import { ProductFormVersion } from './product_form_version.js';
+import { User } from './user.js';
+export declare class ProductForm extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    created?: Date;
+    updated?: Date;
+    id?: number;
+    name?: string;
+    description?: string;
+    tags?: string[];
+    source?: string;
+    sdkVersion?: string;
+    status?: string;
+    activeVersion?: ProductFormVersion | null;
+    versions?: ProductFormVersion[];
+    createdBy?: User | null;
+    updatedBy?: User | null;
+}

package/dist/entities/product_form_version.d.ts

@@ -0,0 +1,20 @@
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class ProductFormVersion extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    created?: Date;
+    id?: number;
+    versionNumber?: number;
+    source?: string;
+    sdkVersion?: string;
+    compiledBundleUrl?: string | null;
+    bundleSha?: string | null;
+    compiledError?: string | null;
+    staticGateReport?: any;
+    status?: string;
+    approvedAt?: Date | null;
+    approvedBy?: User | null;
+    createdBy?: User | null;
+}

package/dist/entities/product_review.d.ts

@@ -0,0 +1,74 @@
+import { Entity } from '../entity.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 declare class ProductReview extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    product?: Product;
+    domain?: Domain;
+    authorUserId?: number;
+    authorName?: string | null;
+    job?: Job;
+    rating?: number;
+    title?: string | null;
+    content?: string | null;
+    status?: string;
+    purchaseInvoiceId?: number | null;
+    /** ISO 8601 string from the API. */
+    submittedAt?: string | null;
+    /** ISO 8601 string from the API. */
+    updatedAt?: string | null;
+    rejectionReason?: string | null;
+    /**
+     * Map flat API fields (``jobId``, ``productId``, ``domainId``) to nested
+     * ``job`` / ``product`` / ``domain`` objects before :meth:`Entity.fromJson`.
+     */
+    static normalizeApiJson(json: any): any;
+    /**
+     * Domain managers/admins: list reviews for a product.
+     */
+    static listForProduct(this: typeof ProductReview, productId: number, options?: {
+        withRights?: boolean;
+    }): Promise<ProductReview[]>;
+    /**
+     * 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.
+     */
+    static createForProduct(this: typeof ProductReview, productId: number, body: ProductReviewCreateInput, options?: {
+        withRights?: boolean;
+    }): Promise<ProductReview>;
+    /**
+     * Partial update (moderation or author edit). Uses ``multipart/form-data`` fields
+     * matching the Merchi API.
+     */
+    patch(payload: ProductReviewPatchInput, options?: {
+        withRights?: boolean;
+    }): Promise<this>;
+}

package/dist/entities/production_comment.d.ts

@@ -0,0 +1,24 @@
+import { Assignment } from './assignment.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Notification } from './notification.js';
+import { User } from './user.js';
+export declare class ProductionComment extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    date?: Date | null;
+    urgency?: number;
+    text?: string;
+    isUrgentQuestion?: boolean;
+    sendSms?: boolean;
+    sendEmail?: boolean;
+    sendWhatsapp?: boolean;
+    files?: MerchiFile[];
+    user?: User;
+    forwards?: User[];
+    notifications?: Notification[];
+    assignment?: Assignment;
+}

package/dist/entities/production_comment.test.d.ts

@@ -0,0 +1 @@
+export {};