@merchi/sdk 1.42.14 → 1.42.16

package/dist/entities/quote.d.ts

@@ -0,0 +1,29 @@
+import { Assignment } from './assignment.js';
+import { QuoteItem } from './quote_item.js';
+import { Shipment } from './shipment.js';
+import { Invoice } from './invoice.js';
+import { Entity } from '../entity.js';
+interface CalculateOptions {
+    strictEmbed?: boolean;
+}
+export declare class Quote extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    currency?: string;
+    id?: number;
+    agreedDeadline?: Date | null;
+    shipments?: Shipment[];
+    quoteItems?: QuoteItem[];
+    assignments?: Assignment[];
+    invoice?: Invoice | null;
+    quoteTotal: (options?: CalculateOptions) => string;
+    calculateTotal: (options?: CalculateOptions) => string;
+    calculateSubTotal: (options?: CalculateOptions) => string;
+    calculateTaxAmount: (options?: CalculateOptions) => string;
+    findQuoteItemIndex: (quoteItemId: number) => number;
+    removeQuoteItem: (quoteItem: QuoteItem) => void;
+    deadlineTimeDifference: () => number | null;
+}
+export {};

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

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

package/dist/entities/quote_item.d.ts

@@ -0,0 +1,24 @@
+import { CountryTax } from './country_tax.js';
+import { Entity } from '../entity.js';
+import { Quote } from './quote.js';
+interface CalculateOptions {
+    strictEmbed?: boolean;
+}
+export declare class QuoteItem extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    type?: number;
+    quantity?: number;
+    description?: string | null;
+    unitPrice?: number | null;
+    taxAmount?: number | null;
+    taxType?: CountryTax;
+    quote?: Quote;
+    calculateSubTotal: (options?: CalculateOptions) => string;
+    calculateTaxAmount: (options?: CalculateOptions) => string;
+    calculateTotal: (options?: CalculateOptions) => string;
+}
+export {};

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

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

package/dist/entities/reminder.d.ts

@@ -0,0 +1,35 @@
+import { Assignment } from './assignment.js';
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { Entity } from '../entity.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { Notification } from './notification.js';
+import { Product } from './product.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+export declare class Reminder extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    user?: User;
+    userProfile?: User;
+    sendEmail?: boolean;
+    sendSms?: boolean;
+    created?: Date;
+    updated?: Date;
+    remindDate?: Date;
+    message?: string;
+    domainTags?: DomainTag[];
+    remindUsers?: User[];
+    job?: Job;
+    product?: Product;
+    invoice?: Invoice;
+    domain?: Domain;
+    company?: Company;
+    shipment?: Shipment;
+    assignment?: Assignment;
+    notifications?: Notification[];
+}

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

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

package/dist/entities/session.d.ts

@@ -0,0 +1,15 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class Session extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    protected static primaryKey: string;
+    archived?: Date | null;
+    ip?: string | null;
+    token?: string;
+    remember?: boolean | null;
+    user?: User;
+    domain?: Domain | null;
+}

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

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

package/dist/entities/shipment.d.ts

@@ -0,0 +1,76 @@
+import { Address } from './address.js';
+import { Assignment } from './assignment.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { DomainTag } from './domain_tag.js';
+import { Entity } from '../entity.js';
+import { InternalTag } from './internal_tag.js';
+import { Invoice } from './invoice.js';
+import { Quote } from './quote.js';
+import { Reminder } from './reminder.js';
+import { Job } from './job.js';
+import { MerchiFile } from './file.js';
+import { User } from './user.js';
+import { ShipmentItem } from './shipment_item.js';
+import { ShipmentLog } from './shipment_log.js';
+import { ShipmentMethod } from './shipment_method.js';
+interface CalculateOptions {
+    strictEmbed?: boolean;
+}
+export declare class Shipment extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    name?: string;
+    shipmentServiceBookingInfo?: string;
+    shipmentServiceQuote?: string;
+    pickUp?: boolean;
+    internalTags?: InternalTag[];
+    shipmentLabel?: MerchiFile | null;
+    creationDate?: Date | null;
+    dispatchedDate?: Date | null;
+    dispatchDate?: Date | null;
+    expectedReceiveDate?: Date | null;
+    receivedDate?: Date | null;
+    senderResponsible?: boolean;
+    senderNotes?: string | null;
+    receiverNotes?: string | null;
+    transportCompany?: number | null;
+    transportCompanyName?: string | null;
+    trackingNumber?: string | null;
+    buyCost?: number | null;
+    buyCurrency?: string | null;
+    cost?: number | null;
+    taxAmount?: number | null;
+    maxWeight?: number | null;
+    maxVolume?: number | null;
+    sendSms?: boolean;
+    sendEmail?: boolean;
+    sendWhatsapp?: boolean;
+    taxType?: CountryTax | null;
+    isOnBehalfOf?: boolean;
+    onBehalfOf?: User | null;
+    onBehalfOfCompany?: Company | null;
+    sender?: User | null;
+    senderCompany?: Company | null;
+    senderAddress?: Address | null;
+    blindShipTo?: string | null;
+    receiver?: User | null;
+    receiverCompany?: Company | null;
+    receiverAddress?: Address | null;
+    invoices?: Invoice[];
+    quote?: Quote | null;
+    shipmentMethod?: ShipmentMethod | null;
+    tags?: DomainTag[];
+    assignments?: Assignment[];
+    items?: ShipmentItem[];
+    jobs?: Job[];
+    reminders?: Reminder[];
+    logs?: ShipmentLog[];
+    calculateSubTotal: (options?: CalculateOptions) => string;
+    calculateTaxAmount: (options?: CalculateOptions) => string;
+    calculateTotal: (options?: CalculateOptions) => string;
+}
+export {};

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

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

package/dist/entities/shipment_item.d.ts

@@ -0,0 +1,10 @@
+import { Entity } from '../entity.js';
+import { Job } from './job.js';
+import { ShipmentItemFulfillment } from './shipment_item_fulfillment.js';
+export declare class ShipmentItem extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    job?: Job;
+    fulfillments?: ShipmentItemFulfillment[];
+}

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

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

package/dist/entities/shipment_item_fulfillment.d.ts

@@ -0,0 +1,10 @@
+import { Entity } from '../entity.js';
+import { Assignment } from './assignment.js';
+import { Job } from './job.js';
+export declare class ShipmentItemFulfillment extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    assignment?: Assignment;
+    job?: Job;
+}

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

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

package/dist/entities/shipment_log.d.ts

@@ -0,0 +1,15 @@
+import { Entity } from '../entity.js';
+import type { Shipment } from './shipment.js';
+import { User } from './user.js';
+export declare class ShipmentLog extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    shipment?: Shipment | null;
+    user?: User | null;
+    sourceType?: string;
+    message?: string;
+    detailJson?: Record<string, unknown> | null;
+    createdAt?: Date | null;
+}

package/dist/entities/shipment_method.d.ts

@@ -0,0 +1,28 @@
+import { ShipmentService } from '../constants/shipment_services.js';
+import { Entity } from '../entity.js';
+import { Address } from './address.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { Product } from './product.js';
+import { ShipmentMethodVariation } from './shipment_method_variation.js';
+export declare class ShipmentMethod extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    name?: string;
+    shipmentService?: ShipmentService | null;
+    originAddress?: Address | null;
+    pickUp?: boolean;
+    company?: Company | null;
+    companyDefault?: boolean;
+    defaultCost?: number;
+    currency?: string;
+    buyCost?: number;
+    buyCurrency?: string;
+    transportCompany?: number | null;
+    transportCompanyName?: string;
+    taxType?: CountryTax | null;
+    variations?: ShipmentMethodVariation[];
+    products?: Product[];
+}

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

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

package/dist/entities/shipment_method_variation.d.ts

@@ -0,0 +1,18 @@
+import { Entity } from '../entity.js';
+import { CountryTax } from './country_tax.js';
+import { ShipmentMethod } from './shipment_method.js';
+export declare class ShipmentMethodVariation extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    destinationCountry?: string | null;
+    destinationState?: string | null;
+    cost?: number | null;
+    currency?: string;
+    buyCost?: number | null;
+    buyCurrency?: string;
+    maxWeight?: number | null;
+    taxType?: CountryTax | null;
+    shipmentMethod?: ShipmentMethod;
+}

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

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

package/dist/entities/short_url.d.ts

@@ -0,0 +1,17 @@
+import { Entity } from '../entity.js';
+import { Notification } from './notification.js';
+import { User } from './user.js';
+export declare class ShortUrl extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    prefixToken?: string;
+    suffixToken?: string;
+    originalLink?: string;
+    triedTimes?: number;
+    lastLookup?: Date | null;
+    user?: User | null;
+    notification?: Notification[];
+}

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

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

package/dist/entities/subscription_plan.d.ts

@@ -0,0 +1,30 @@
+import { Entity } from '../entity.js';
+import { CountryTax } from './country_tax.js';
+import { User } from './user.js';
+import { Company } from './company.js';
+export declare class SubscriptionPlan extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    created?: Date | null;
+    updated?: Date | null;
+    createdBy?: User | null;
+    updatedBy?: User | null;
+    name?: string;
+    currency?: string;
+    tax?: CountryTax | null;
+    baseCost?: number;
+    whiteLabelDomainCost?: number;
+    perSmsCost?: number;
+    perUserCost?: number;
+    perDomainCost?: number;
+    transactionCost?: number;
+    commissionRate?: number;
+    baseUserCount?: number;
+    baseDomainCount?: number;
+    billingCycleDays?: number;
+    isPrivate?: boolean;
+    showPublic?: boolean;
+    companies?: Company[];
+}

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

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

package/dist/entities/supply_domain.d.ts

@@ -0,0 +1,14 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { Product } from './product.js';
+export declare class SupplyDomain extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    needsDrafting?: boolean;
+    product?: Product;
+    supplyProduct?: Product | null;
+    domain?: Domain;
+}

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

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

package/dist/entities/support_conversation.d.ts

@@ -0,0 +1,30 @@
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+import { SupportMessage } from './support_message.js';
+export declare class SupportConversation extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    creationDate?: Date | null;
+    lastMessageAt?: Date | null;
+    archivedAt?: Date | null;
+    domain?: Domain;
+    tags?: DomainTag[];
+    guestId?: string | null;
+    guestContactEmail?: string | null;
+    guestContactName?: string | null;
+    /** Opaque client fingerprint for repeat-visitor / spam correlation (max 512 chars). */
+    clientFingerprint?: string | null;
+    /** Manager-assigned display name for this conversation. */
+    name?: string | null;
+    /** Freeform internal notes written by managers (not visible to guests). */
+    notes?: string | null;
+    user?: User | null;
+    assignedUser?: User | null;
+    aiAutoReply?: boolean;
+    messages?: SupportMessage[];
+    messagesCount?: number;
+}

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

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

package/dist/entities/support_message.d.ts

@@ -0,0 +1,15 @@
+import { Entity } from '../entity.js';
+import { SupportConversation } from './support_conversation.js';
+import { User } from './user.js';
+export declare class SupportMessage extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    conversation?: SupportConversation;
+    senderType?: string;
+    user?: User | null;
+    content?: string;
+    creationDate?: Date | null;
+    isAiReply?: boolean;
+}

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

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

package/dist/entities/system_role.d.ts

@@ -0,0 +1,10 @@
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class SystemRole extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    role?: number;
+    user?: User;
+}

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

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

package/dist/entities/theme.d.ts

@@ -0,0 +1,26 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class Theme extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    mainCssStatus?: number;
+    mainCssErrorMessage?: string | null;
+    emailCssStatus?: number;
+    emailCssErrorMessage?: string | null;
+    lastUpdated?: Date;
+    mainCss?: string | null;
+    mainCssTemplateUsing?: string | null;
+    mainCssTemplateEditing?: string | null;
+    emailCss?: string | null;
+    emailCssTemplateUsing?: string | null;
+    emailCssTemplateEditing?: string | null;
+    domain?: Domain | null;
+    author?: User | null;
+    domains?: Domain[];
+    canBeActivated: () => boolean;
+    isActiveOnDomain: (domainId: number) => boolean;
+}

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

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

package/dist/entities/theme_css_setting.d.ts

@@ -0,0 +1,12 @@
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class ThemeCssSetting extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    created?: Date | null;
+    createdBy?: User | null;
+    allowedAttributes?: string;
+    notAllowedAttributes?: string;
+}

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

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

package/dist/entities/user.d.ts

@@ -0,0 +1,142 @@
+import { Address } from './address.js';
+import { Assignment } from './assignment.js';
+import { Cart } from './cart.js';
+import { Category } from './category.js';
+import { CompanyInvitation } from './company_invitation.js';
+import { DomainInvitation } from './domain_invitation.js';
+import { Draft } from './draft.js';
+import { DraftComment } from './draft_comment.js';
+import { EmailAddress } from './email_address.js';
+import { EnrolledDomain } from './enrolled_domain.js';
+import { Domain } from './domain.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 { JobOperationLog } from './job_operation_log.js';
+import { Notification } from './notification.js';
+import { Payment } from './payment.js';
+import { PhoneNumber } from './phone_number.js';
+import { Product } from './product.js';
+import { Reminder } from './reminder.js';
+import { ProductionComment } from './production_comment.js';
+import { Session } from './session.js';
+import { Shipment } from './shipment.js';
+import { ShipmentLog } from './shipment_log.js';
+import { SystemRole } from './system_role.js';
+import { Theme } from './theme.js';
+import { UserCompany } from './user_company.js';
+import { Company } from './company.js';
+import { Role } from '../constants/roles.js';
+import { InternalTag } from './internal_tag.js';
+import { DomainTag } from './domain_tag.js';
+import { UserType } from '../constants/user_types.js';
+import { SystemRoles as SR } from '../constants/system_roles.js';
+import lodash from 'lodash';
+export declare class User extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    isSuperUser?: boolean;
+    userType?: UserType;
+    registeredAsGuest?: boolean;
+    isMerchiAgent?: boolean;
+    internalTags?: InternalTag[];
+    tags?: DomainTag[];
+    registeredUnderDomains?: Domain[];
+    password?: string | null;
+    salt?: string | null;
+    facebookUserId?: string | null;
+    resetToken?: string | null;
+    resetTokenDate?: Date | null;
+    smsToken?: string | null;
+    resetSmsTokenDate?: Date | null;
+    smsClientToken?: string | null;
+    smsTokenConfirmed?: boolean;
+    smsLoginThreshold?: number;
+    jobCountAsClient?: number;
+    totalInvoiceValue?: number;
+    hasStore?: boolean;
+    lastJobReceived?: boolean;
+    canEdit?: boolean;
+    enableCrashReports?: boolean;
+    enableClientEmails?: boolean;
+    clientToken?: string | null;
+    name?: string;
+    internalUseNotes?: string;
+    telegramUsername?: string;
+    wechatId?: string;
+    whatsappContactEnabled?: boolean;
+    internalUseAiContext?: string;
+    aiContext?: string;
+    callToActions?: string;
+    callToActionDetails?: any[];
+    comments?: string | null;
+    timezone?: string | null;
+    created?: Date | null;
+    preferredLanguage?: string | null;
+    enableInvoiceReminders?: boolean;
+    enableStoreNotifications?: boolean;
+    isAdminOfSubscribedCompany?: boolean;
+    jobComments?: JobComment[];
+    jobOperationLogs?: JobOperationLog[];
+    shipmentLogs?: ShipmentLog[];
+    _emailAddresses?: EmailAddress[];
+    _phoneNumbers?: PhoneNumber[];
+    _addresses?: Address[];
+    _companies?: UserCompany[];
+    companiesNeedStripe?: Company[];
+    categories?: Category[];
+    products?: Product[];
+    profilePicture?: MerchiFile | null;
+    phoneNumbers?: PhoneNumber[];
+    sessions?: Session[];
+    shipmentsAsSender?: Shipment[];
+    shipmentsAsReceiver?: Shipment[];
+    draftComments?: DraftComment[];
+    forwardedDraftComments?: DraftComment[];
+    systemRoles?: SystemRole[];
+    emailAddresses?: EmailAddress[];
+    notifications?: Notification[];
+    sentNotifications?: Notification[];
+    reminders?: Reminder[];
+    assignments?: Assignment[];
+    userCompanies?: UserCompany[];
+    drafts?: Draft[];
+    companyInvitations?: CompanyInvitation[];
+    addresses?: Address[];
+    uploadFiles?: MerchiFile[];
+    forwardedJobComments?: JobComment[];
+    appliedJobs?: Job[];
+    managedJobs?: Job[];
+    draftingJobs?: Job[];
+    saved_products?: Product[];
+    carts?: Cart[];
+    payments?: Payment[];
+    enrolledDomains?: EnrolledDomain[];
+    responsibleInvoices?: Invoice[];
+    createdInvoices?: Invoice[];
+    invoicesHas?: Invoice[];
+    sentDomainInvitations?: DomainInvitation[];
+    receivedDomainInvitations?: DomainInvitation[];
+    themes?: Theme[];
+    forwardedProductionComments?: ProductionComment[];
+    accessibleDomainsAsClient?: Domain[];
+    publicCreate: (options?: import("../entity.js").CreateOptions | undefined) => Promise<this>;
+    roleInDomain: (domain: Domain) => Role;
+    isSuper(): boolean;
+    companies(): Company[];
+    isDomainManager(domain: Domain): boolean;
+    isManagementTeam(domain: Domain): boolean;
+    isNotClient(domain: Domain): boolean;
+    domainsByRoles(roles: Role[]): Domain[];
+    hasAuthority(domain: Domain, roles: Role[]): boolean;
+    hasSystemRole(role: SR): boolean;
+    hasRoles(roles: Role[], combinationMethod?: {
+        <T>(collection: lodash.List<T> | null | undefined, predicate?: lodash.ListIterateeCustom<T, boolean> | undefined): boolean;
+        <T_1 extends object>(collection: T_1 | null | undefined, predicate?: lodash.ObjectIterateeCustom<T_1, boolean> | undefined): boolean;
+    }): boolean;
+}

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

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

package/dist/entities/user_company.d.ts

@@ -0,0 +1,14 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class UserCompany extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    main?: boolean | null;
+    isAdmin?: boolean;
+    user?: User | null;
+    company?: Company | null;
+}

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

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