@merchi/sdk 1.42.15 → 1.42.17

package/dist/entities/variation.d.ts

@@ -0,0 +1,29 @@
+import { CartItem } from './cart_item.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Job } from './job.js';
+import { VariationField } from './variation_field.js';
+import { VariationOption } from './variation_option.js';
+import { VariationsGroup } from './variations_group.js';
+export declare class Variation extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    value?: string | null;
+    currency?: string;
+    cost?: number;
+    quantity?: number;
+    onceOffCost?: number;
+    unitCost?: number;
+    unitCostTotal?: number;
+    isVisible?: boolean;
+    variationField?: VariationField;
+    variationsGroup?: VariationsGroup | null;
+    job?: Job | null;
+    cartItem?: CartItem | null;
+    variationFiles?: MerchiFile[];
+    selectedOptions?: VariationOption[];
+    selectableOptions?: VariationOption[];
+}

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

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

package/dist/entities/variation_field.d.ts

@@ -0,0 +1,87 @@
+import { DiscountGroup } from './discount_group.js';
+import { Entity } from '../entity.js';
+import { InventoryGroup } from './inventory_group.js';
+import { Product } from './product.js';
+import { Variation } from './variation.js';
+import { VariationFieldsOption } from './variation_fields_option.js';
+import { FieldType } from '../constants/field_types.js';
+export declare class VariationField extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    position?: number;
+    /** Columns this field spans. Null is the full width of its list. */
+    layoutSpan?: number | null;
+    required?: boolean;
+    independent?: boolean;
+    name?: string;
+    instructions?: string;
+    placeholder?: string | null;
+    defaultValue?: string;
+    currency?: string;
+    fieldType?: FieldType;
+    margin?: number;
+    variationCost?: number;
+    variationCostDiscountGroup?: DiscountGroup | null;
+    variationUnitCost?: number;
+    buyUnitCost?: number;
+    buyCost?: number;
+    variationUnitCostDiscountGroup?: DiscountGroup | null;
+    rows?: number;
+    fieldMin?: number | null;
+    fieldMax?: number | null;
+    allowDecimal?: boolean;
+    allowAllPantones?: boolean;
+    isHtml?: boolean;
+    considerBusinessHours?: boolean;
+    shippingTimeIncluded?: boolean;
+    sellerProductEditable?: boolean;
+    multipleSelect?: boolean;
+    showFilePreview?: boolean;
+    allowFileMultiple?: boolean;
+    allowFileJpeg?: boolean;
+    allowFileGif?: boolean;
+    allowFilePdf?: boolean;
+    allowFilePng?: boolean;
+    allowFileAi?: boolean;
+    maxColours?: number;
+    simplifyColours?: boolean;
+    colourVariationCost?: number;
+    colourVariationCostDiscountGroup?: DiscountGroup | null;
+    colourVariationUnitCost?: number;
+    colourVariationUnitCostDiscountGroup?: DiscountGroup | null;
+    heightVariationCost?: number;
+    heightVariationCostDiscountGroup?: DiscountGroup | null;
+    heightVariationUnitCost?: number;
+    heightVariationUnitCostDiscountGroup?: DiscountGroup | null;
+    widthVariationCost?: number;
+    widthVariationCostDiscountGroup?: DiscountGroup | null;
+    widthVariationUnitCost?: number;
+    widthVariationUnitCostDiscountGroup?: DiscountGroup | null;
+    heightFieldMin?: number | null;
+    heightFieldMax?: number | null;
+    widthFieldMin?: number | null;
+    widthFieldMax?: number | null;
+    areaUnit?: string;
+    areaInputType?: string;
+    areaStep?: number | null;
+    aspectRatioLock?: boolean;
+    aspectRatio?: number | null;
+    embroideryInputMode?: string;
+    stitchDensity?: number;
+    averageStitchLengthMm?: number;
+    stitchVariationCost?: number;
+    stitchVariationCostDiscountGroup?: DiscountGroup | null;
+    stitchVariationUnitCost?: number;
+    stitchVariationUnitCostDiscountGroup?: DiscountGroup | null;
+    product?: Product;
+    selectedBy?: VariationFieldsOption[];
+    inventoryGroup?: InventoryGroup;
+    linkedInventoryGroup?: InventoryGroup;
+    variations?: Variation[];
+    options?: VariationFieldsOption[];
+    isSelectable: () => boolean;
+    buildEmptyVariation: () => Variation;
+}

package/dist/entities/variation_field.js

@@ -86,6 +86,11 @@ var VariationField = /** @class */ (function (_super) {
                 result.value = _this.defaultValue;
                 result.onceOffCost = 0;
             }
+            else if (_this.fieldType === FieldType.EMBROIDERY) {
+                result.value = '';
+                result.onceOffCost = 0;
+                result.variationFiles = [];
+            }
             else if (_this.isSelectable()) {
                 var onceOffCost = 0;
                 var value = [];
@@ -369,6 +374,34 @@ var VariationField = /** @class */ (function (_super) {
         VariationField.property({ type: Number }),
         __metadata("design:type", Object)
     ], VariationField.prototype, "aspectRatio", void 0);
+    __decorate([
+        VariationField.property(),
+        __metadata("design:type", String)
+    ], VariationField.prototype, "embroideryInputMode", void 0);
+    __decorate([
+        VariationField.property({ type: Number }),
+        __metadata("design:type", Number)
+    ], VariationField.prototype, "stitchDensity", void 0);
+    __decorate([
+        VariationField.property({ type: Number }),
+        __metadata("design:type", Number)
+    ], VariationField.prototype, "averageStitchLengthMm", void 0);
+    __decorate([
+        VariationField.property(),
+        __metadata("design:type", Number)
+    ], VariationField.prototype, "stitchVariationCost", void 0);
+    __decorate([
+        VariationField.property({ type: 'DiscountGroup' }),
+        __metadata("design:type", Object)
+    ], VariationField.prototype, "stitchVariationCostDiscountGroup", void 0);
+    __decorate([
+        VariationField.property(),
+        __metadata("design:type", Number)
+    ], VariationField.prototype, "stitchVariationUnitCost", void 0);
+    __decorate([
+        VariationField.property({ type: 'DiscountGroup' }),
+        __metadata("design:type", Object)
+    ], VariationField.prototype, "stitchVariationUnitCostDiscountGroup", void 0);
     __decorate([
         VariationField.property(),
         __metadata("design:type", Product)

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

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

package/dist/entities/variation_fields_option.d.ts

@@ -0,0 +1,36 @@
+import { DiscountGroup } from './discount_group.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { InventoryUnitVariation } from './inventory_unit_variation.js';
+import { Variation } from './variation.js';
+import { VariationField } from './variation_field.js';
+export declare class VariationFieldsOption extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    value?: string | null;
+    colour?: string | null;
+    isExtracted?: boolean;
+    currency?: string;
+    default?: boolean;
+    include?: boolean;
+    noInventory?: boolean;
+    position?: number;
+    deliveryDays?: number;
+    variationCost?: number;
+    variationCostDiscountGroup?: DiscountGroup | null;
+    variationUnitCost?: number;
+    buyUnitCost?: number;
+    buyCost?: number;
+    variationUnitCostDiscountGroup?: DiscountGroup | null;
+    variationField?: VariationField | null;
+    linkedFile?: MerchiFile | null;
+    linkedProductImage?: MerchiFile | null;
+    selectedByVariations?: Variation[];
+    inventoryUnitVariations?: InventoryUnitVariation[];
+    selectedBy?: VariationFieldsOption[];
+    totalCost: (quantity: number) => number;
+    buildVariationOption: () => import("./variation_option.js").VariationOption;
+}

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

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

package/dist/entities/variation_option.d.ts

@@ -0,0 +1,23 @@
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+export declare class VariationOption extends Entity {
+    protected static singularName: string;
+    protected static pluralName: string;
+    optionId?: number;
+    value?: string | null;
+    colour?: string | null;
+    position?: number;
+    available?: boolean;
+    default?: boolean;
+    include?: boolean;
+    isVisible?: boolean;
+    linkedFile?: MerchiFile | null;
+    fieldName?: string;
+    userDeadline?: Date;
+    quantity?: number;
+    currency?: string;
+    onceOffCost?: number;
+    unitCost?: number;
+    unitCostTotal?: number;
+    totalCost?: number;
+}

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

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

package/dist/entities/variations_group.d.ts

@@ -0,0 +1,20 @@
+import { CartItem } from './cart_item.js';
+import { Entity } from '../entity.js';
+import { Job } from './job.js';
+import { Variation } from './variation.js';
+import { MatchingInventory } from './matching_inventory.js';
+export declare class VariationsGroup extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    quantity?: number;
+    groupCost?: number | null;
+    job?: Job | null;
+    cartItem?: CartItem | null;
+    matchingInventory?: MatchingInventory | null;
+    variations?: Variation[];
+    inventoryCount?: number;
+    inventorySufficient?: boolean;
+}

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

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

package/dist/entity.d.ts

@@ -0,0 +1,208 @@
+import 'reflect-metadata';
+import { Merchi } from './merchi.js';
+import { NotificationType } from './constants/notification_types.js';
+import { NotificationSection } from './constants/notification_sections.js';
+import { Role } from './constants/roles.js';
+import { DomainType } from './constants/domain_types.js';
+import { ProductType } from './constants/product_types.js';
+interface Counter {
+    value: number;
+}
+interface PropertyOptions {
+    embeddedByDefault?: boolean;
+    jsonName?: string;
+    type?: any;
+    arrayType?: string;
+}
+export interface EmbedDescriptor {
+    [property: string]: {} | EmbedDescriptor;
+}
+export interface NestedIncludeArchivedDescriptor {
+    [property: string]: {} | boolean | NestedIncludeArchivedDescriptor;
+}
+export type IncludeArchivedDescriptor = boolean | NestedIncludeArchivedDescriptor;
+interface FromJsonOptions {
+    arrayValueStrict?: boolean;
+    makeDirty?: boolean;
+}
+export interface CreateOptions {
+    withRights?: boolean;
+    embed?: EmbedDescriptor;
+}
+interface SaveOptions {
+    withRights?: boolean;
+    embed?: EmbedDescriptor;
+}
+interface DeleteOptions {
+    withRights?: boolean;
+}
+interface GetOptions {
+    embed?: EmbedDescriptor;
+    includeArchived?: IncludeArchivedDescriptor;
+    withRights?: boolean;
+}
+export declare enum SerialiseMethod {
+    TO_DICT = "to_dict",
+    ONLY_ID = "only_id"
+}
+interface ListOptions {
+    as?: string;
+    asRole?: Role;
+    businessDomainsOnly?: boolean;
+    categoryId?: number;
+    clientId?: number;
+    clientCompanyId?: number;
+    categories?: string[];
+    clientOnly?: boolean;
+    companyCustomerId?: number;
+    companyId?: number;
+    companySupplierId?: number;
+    conversationId?: number;
+    dateFrom?: Date;
+    dateTo?: Date;
+    domainRoles?: Role[];
+    domainTypes?: DomainType[];
+    doesNotHaveAdminDomain?: boolean;
+    embed?: EmbedDescriptor;
+    entityTypes?: number[];
+    exclude?: number[];
+    excludeDomains?: number[];
+    excludeJobs?: number[];
+    googleMerchantCenterExported?: boolean;
+    groupBuyForJobId?: number;
+    groupBuyOnly?: boolean;
+    inbound?: boolean;
+    includeOnly?: number[];
+    inDomain?: number;
+    inDomainName?: string;
+    inDomainRoles?: number[];
+    isJobManager?: boolean;
+    isMaster?: boolean;
+    isOrder?: boolean;
+    isPrivate?: boolean;
+    jobNotifiable?: number;
+    descendants?: number;
+    limit?: number;
+    managedDomainsOnly?: boolean;
+    managedOnly?: boolean;
+    managerId?: number;
+    masterProduct?: number;
+    memberOnly?: boolean;
+    merchiOnly?: boolean;
+    notificationSender?: number;
+    notificationJob?: number;
+    notificationRecipient?: number;
+    notificationType?: NotificationType;
+    offset?: number;
+    orClientId?: number;
+    orClientCompanyId?: number | number[];
+    order?: string;
+    originalOf?: number;
+    platformCategoryId?: number;
+    priceRange?: number[];
+    productTypes?: ProductType[];
+    publicOnly?: boolean;
+    isDraft?: boolean;
+    isTest?: boolean;
+    /** true = invoice fully paid, false = invoice issued but not fully paid */
+    invoicePaid?: boolean;
+    sourceChannel?: string;
+    q?: string;
+    receiverId?: number;
+    userAsReceiver?: number;
+    relatedAssignment?: number;
+    relatedDraft?: number;
+    relatedJob?: number;
+    relatedJobs?: number[];
+    relatedShipment?: number;
+    relatedProduct?: number;
+    relatedUser?: number;
+    savedByUser?: number;
+    section?: NotificationSection;
+    senderCompanyId?: number;
+    senderRole?: Role;
+    serialiseMethod?: SerialiseMethod;
+    shopifyOnly?: boolean;
+    sort?: string;
+    state?: string;
+    supplierResellOnly?: boolean;
+    tab?: string;
+    tags?: number[];
+    trackingNumber?: string;
+    tagsInternal?: number[];
+    excludeTags?: number[];
+    excludeTagsInternal?: number[];
+    tagNames?: string[];
+    teamOnly?: boolean;
+    turnaroundTimeDays?: number;
+    withRights?: boolean;
+    skipCount?: boolean;
+}
+export interface ListMetadata {
+    canCreate?: boolean;
+    available: number | null;
+    count: number;
+    limit: number;
+    offset: number;
+}
+export interface ListResponse<T> {
+    items: T[];
+    metadata: ListMetadata;
+}
+interface SerialiseOptions {
+    existing?: FormData;
+    excludeOld?: boolean;
+    _prefix?: string;
+}
+interface PropertyInfo {
+    property: string;
+    attribute: string;
+    type: Function;
+    arrayType?: Entity;
+    dirty: boolean;
+    currentValue?: any;
+    updatingOrder: boolean;
+    embeddedByDefault: boolean;
+}
+export declare class Entity {
+    private static jsonNameKey;
+    private static arrayTypeKey;
+    private static extraOptionsKey;
+    private static propertiesSetKey;
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    protected static primaryKey: string;
+    merchi: Merchi;
+    static merchi: Merchi;
+    isDirty: boolean;
+    propertiesMap: Map<string, PropertyInfo>;
+    readonly backObjects: Set<Entity>;
+    key: string;
+    protected isSingleEntityProperty(info: PropertyInfo): boolean;
+    protected static property(options?: PropertyOptions): (target: Entity, propertyKey: string) => void;
+    protected makePropertiesMap(): Map<any, any>;
+    constructor(merchi?: Merchi);
+    getPrimaryKeyValue: () => any;
+    private setupProperties;
+    static get<T extends typeof Entity>(this: T, key: number | string, options?: GetOptions): Promise<InstanceType<T>>;
+    static list<T extends typeof Entity>(this: T, options?: ListOptions): Promise<ListResponse<InstanceType<T>>>;
+    save: (options?: SaveOptions) => Promise<this>;
+    createFactory: ({ resourceName }: {
+        resourceName?: string | undefined;
+    }) => (options?: CreateOptions) => Promise<this>;
+    create: (options?: CreateOptions) => Promise<this>;
+    private getEntityClass;
+    cleanDirty: () => void;
+    fromJson: (json: any, options?: FromJsonOptions) => this;
+    toJson: () => any;
+    protected forEachProperty: (fn: (i: PropertyInfo) => void) => void;
+    toFormData: (options?: SerialiseOptions, fileIndex?: Counter) => FormData;
+    protected addBackObject: (remote?: Entity) => void;
+    protected addBackObjectList: (remotes?: Entity[]) => void;
+    updateOrder: (property: string) => void;
+    protected markDirty: (property: string, newValue: any) => void;
+    delete: (options?: DeleteOptions) => Promise<this>;
+    recover: (options?: SaveOptions) => Promise<this>;
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { Address } from './entities/address.js';
+import { AgentConversation } from './entities/agent_conversation.js';
+import { AgentTokenUsage } from './entities/agent_token_usage.js';
+export type { AgentTokenAnalyticsSummary, AgentTokenAnalyticsTimeseries, AgentTokenUsageRecordPayload, AgentTokenUsageRecordResponse, CompanyAnalyticsResponse, DomainAnalyticsResponse, ProfileAnalyticsSummaryMetric, } from './entities/agent_token_analytics.js';
+import { AgentSkill } from './entities/agent_skill.js';
+import { AgentSkillVersion } from './entities/agent_skill_version.js';
+import { AgentSkillApproval } from './entities/agent_skill_approval.js';
+import { DomainChatSettings } from './entities/domain_chat_settings.js';
+import { SupportConversation } from './entities/support_conversation.js';
+import { SupportMessage } from './entities/support_message.js';
+import { Assignment } from './entities/assignment.js';
+import { AutomaticPaymentRelationship } from './entities/automatic_payment_relationship.js';
+import { Bank } from './entities/bank.js';
+import { Cart } from './entities/cart.js';
+import { CartItem } from './entities/cart_item.js';
+import { CartShipmentGroup } from './entities/cart_shipment_group.js';
+import { CartShipmentQuote } from './entities/cart_shipment_quote.js';
+import { Category } from './entities/category.js';
+import { Company } from './entities/company.js';
+import { CompanyInvitation } from './entities/company_invitation.js';
+import { ProductForm } from './entities/product_form.js';
+import { ProductFormVersion } from './entities/product_form_version.js';
+import { CountryTax } from './entities/country_tax.js';
+import { Discount } from './entities/discount.js';
+import { DiscountGroup } from './entities/discount_group.js';
+import { Domain } from './entities/domain.js';
+import { DomainInvitation } from './entities/domain_invitation.js';
+import { DomainTag } from './entities/domain_tag.js';
+import { Draft } from './entities/draft.js';
+import { DraftComment } from './entities/draft_comment.js';
+import { DraftTemplate } from './entities/draft_template.js';
+import { EmailAddress } from './entities/email_address.js';
+import { EmailCounter } from './entities/email_counter.js';
+import { EnrolledDomain } from './entities/enrolled_domain.js';
+import { Entity, EmbedDescriptor } from './entity.js';
+import { ExchangeRate } from './entities/exchange_rate.js';
+import { InternalTag } from './entities/internal_tag.js';
+import { Inventory } from './entities/inventory.js';
+import { InventoryUnitVariation } from './entities/inventory_unit_variation.js';
+import { Invoice } from './entities/invoice.js';
+import { Item } from './entities/item.js';
+import { Job } from './entities/job.js';
+import { JobComment } from './entities/job_comment.js';
+import { JobNote } from './entities/job_note.js';
+import { JobOperationLog } from './entities/job_operation_log.js';
+import { MatchingInventory } from './entities/matching_inventory.js';
+import { Merchi } from './merchi.js';
+import { MerchiFile } from './entities/file.js';
+import { Notification } from './entities/notification.js';
+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';
+import { Reminder } from './entities/reminder.js';
+import { RequestOptions, apiFetch, apiFetchWithProgress } from './request.js';
+import { Session } from './entities/session.js';
+import { Shipment } from './entities/shipment.js';
+import { ShipmentLog } from './entities/shipment_log.js';
+import { ShipmentItem } from './entities/shipment_item.js';
+import { ShipmentItemFulfillment } from './entities/shipment_item_fulfillment.js';
+import { ShipmentMethod } from './entities/shipment_method.js';
+import { ShipmentMethodVariation } from './entities/shipment_method_variation.js';
+import { ShortUrl } from './entities/short_url.js';
+import { SubscriptionPlan } from './entities/subscription_plan.js';
+import { SupplyDomain } from './entities/supply_domain.js';
+import { SystemRole } from './entities/system_role.js';
+import { Theme } from './entities/theme.js';
+import { ThemeCssSetting } from './entities/theme_css_setting.js';
+import { User } from './entities/user.js';
+import { UserCompany } from './entities/user_company.js';
+import { Variation } from './entities/variation.js';
+import { VariationField } from './entities/variation_field.js';
+import { VariationFieldsOption } from './entities/variation_fields_option.js';
+import { VariationOption } from './entities/variation_option.js';
+import { VariationsGroup } from './entities/variations_group.js';
+import { generateUUID } from './uuid.js';
+import { getCookie } from './cookie.js';
+import * as constants from './constants/index.js';
+import * as request from './request.js';
+import * as util from './util/index.js';
+import * as pricing from './pricing/index.js';
+import { toastNotifications } from './toasts.js';
+export { constants, request, util, pricing, toastNotifications, Address, AgentConversation, AgentTokenUsage, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, ProductForm, ProductFormVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, EmbedDescriptor, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, JobNote, JobOperationLog, MatchingInventory, Merchi, MerchiFile, Notification, Payment, PaymentDevice, PhoneNumber, Product, ProductReview, ProductionComment, Quote, QuoteItem, Reminder, RequestOptions, apiFetch, apiFetchWithProgress, Session, Shipment, ShipmentLog, ShipmentItem, ShipmentItemFulfillment, ShipmentMethod, ShipmentMethodVariation, ShortUrl, SubscriptionPlan, SupplyDomain, SystemRole, Theme, ThemeCssSetting, User, UserCompany, Variation, VariationField, VariationFieldsOption, VariationOption, VariationsGroup, generateUUID, getCookie };