@merchi/sdk 1.42.15 → 1.42.16

package/dist/constants/white_label_accessibilities.d.ts

@@ -0,0 +1,5 @@
+export declare enum WhiteLabelAccessibility {
+    UNREACHABLE = 0,
+    NO_CERTIFICATE = 1,
+    REACHABLE = 2
+}

package/dist/constants/white_label_accessibilities.test.d.ts

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

package/dist/cookie.d.ts

@@ -0,0 +1 @@
+export declare function getCookie(name: string): string | undefined;

package/dist/cookie.test.d.ts

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

package/dist/entities/address.d.ts

@@ -0,0 +1,30 @@
+import { Bank } from './bank.js';
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { Inventory } from './inventory.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+export declare class Address extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    lineOne?: string | null;
+    lineTwo?: string | null;
+    city?: string | null;
+    state?: string | null;
+    country?: string | null;
+    postcode?: string | null;
+    shipmentAsSenderAddress?: Shipment[];
+    shipmentsAsReceiverAddress?: Shipment[];
+    banks?: Bank[];
+    users?: User[];
+    inventories?: Inventory[];
+    jobs?: Job[];
+    productedJobs?: Job[];
+    shippingTo?: Invoice[];
+    companies?: Company[];
+}

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

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

package/dist/entities/agent_conversation.d.ts

@@ -0,0 +1,18 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class AgentConversation extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    conversationId?: string;
+    initialPrompt?: string;
+    creationDate?: Date | null;
+    entityType?: string | null;
+    entityId?: number | null;
+    serviceProvider?: number;
+    user?: User;
+    domain?: Domain;
+}

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

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

package/dist/entities/agent_skill.d.ts

@@ -0,0 +1,33 @@
+import { Entity } from '../entity.js';
+import { AgentSkillVersion } from './agent_skill_version.js';
+import { Category } from './category.js';
+import { Domain } from './domain.js';
+import { Product } from './product.js';
+interface CreateDraftOptions {
+    contentMd?: string;
+}
+export declare class AgentSkill extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    protected static primaryKey: string;
+    id?: string;
+    slug?: string;
+    title?: string;
+    scope?: 'global' | 'domain' | 'domain_category' | 'domain_product';
+    domain?: Domain | null;
+    category?: Category | null;
+    product?: Product | null;
+    description?: string | null;
+    priority?: number;
+    createdAt?: Date | null;
+    disabledAt?: Date | null;
+    currentDraftVersionId?: string | null;
+    currentPublishedVersionId?: string | null;
+    versions?: AgentSkillVersion[];
+    createDraftVersion: (options?: CreateDraftOptions) => Promise<AgentSkillVersion>;
+    disable: () => Promise<this>;
+    enable: () => Promise<this>;
+    getVersionDiff: (versionId: string) => Promise<any>;
+}
+export {};

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

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

package/dist/entities/agent_skill_approval.d.ts

@@ -0,0 +1,13 @@
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class AgentSkillApproval extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: string;
+    skillVersionId?: string;
+    superUser?: User | null;
+    decision?: 'approved' | 'rejected';
+    comment?: string | null;
+    createdAt?: Date | null;
+}

package/dist/entities/agent_skill_version.d.ts

@@ -0,0 +1,18 @@
+import { Entity } from '../entity.js';
+export declare class AgentSkillVersion extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: string;
+    skillId?: string;
+    versionNumber?: number;
+    contentMd?: string;
+    contentHash?: string;
+    status?: string;
+    requestedAt?: Date | null;
+    publishedAt?: Date | null;
+    disabledAt?: Date | null;
+    submit: (skillId: string) => Promise<this>;
+    approve: (skillId: string, comment: string) => Promise<this>;
+    reject: (skillId: string, comment: string) => Promise<this>;
+}

package/dist/entities/agent_token_analytics.d.ts

@@ -0,0 +1,50 @@
+export interface AgentTokenAnalyticsSummary {
+    percentageDifference?: number | null;
+    totals?: number;
+    previousTotals?: number;
+}
+export interface AgentTokenAnalyticsTimeseries {
+    dates?: string[];
+    totalTokens?: number[];
+    promptTokens?: number[];
+    completionTokens?: number[];
+}
+export interface ProfileAnalyticsSummaryMetric {
+    percentageDifference?: number | null;
+    totals?: number | {
+        total?: number;
+        currency?: string;
+    };
+    previousTotals?: number | {
+        total?: number;
+        currency?: string;
+    };
+}
+export interface CompanyAnalyticsResponse {
+    totalJobs?: ProfileAnalyticsSummaryMetric;
+    completedJobs?: ProfileAnalyticsSummaryMetric;
+    totalInvoices?: ProfileAnalyticsSummaryMetric;
+    paymentsReceived?: ProfileAnalyticsSummaryMetric;
+    agentTokenUsage?: AgentTokenAnalyticsSummary;
+}
+export interface DomainAnalyticsResponse extends CompanyAnalyticsResponse {
+}
+export interface AgentTokenUsageRecordPayload {
+    companyId?: number;
+    domainId?: number;
+    promptTokens?: number;
+    completionTokens?: number;
+    totalTokens?: number;
+    sourceType?: string;
+    modelName?: string;
+    agentConversationId?: number;
+    supportConversationId?: number;
+}
+export interface AgentTokenUsageRecordResponse {
+    agentTokenUsage?: {
+        id?: number;
+        companyId?: number;
+        domainId?: number;
+        totalTokens?: number;
+    };
+}

package/dist/entities/agent_token_usage.d.ts

@@ -0,0 +1,31 @@
+import { Entity } from '../entity.js';
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { User } from './user.js';
+import { AgentConversation } from './agent_conversation.js';
+import { SupportConversation } from './support_conversation.js';
+import type { AgentTokenUsageRecordPayload, AgentTokenUsageRecordResponse } from './agent_token_analytics.js';
+import type { RequestOptions } from '../request.js';
+export declare class AgentTokenUsage extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    createdAt?: Date | null;
+    companyId?: number;
+    domainId?: number;
+    userId?: number;
+    company?: Company | null;
+    domain?: Domain | null;
+    user?: User | null;
+    agentConversation?: AgentConversation | null;
+    supportConversation?: SupportConversation | null;
+    agentConversationId?: number;
+    supportConversationId?: number;
+    sourceType?: string;
+    modelName?: string;
+    promptTokens?: number;
+    completionTokens?: number;
+    totalTokens?: number;
+    static record: (payload: AgentTokenUsageRecordPayload, fetchOptions?: RequestOptions) => Promise<AgentTokenUsageRecordResponse>;
+}

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

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

package/dist/entities/assignment.d.ts

@@ -0,0 +1,40 @@
+import { Entity } from '../entity.js';
+import { Quote } from './quote.js';
+import { MerchiFile } from './file.js';
+import { Job } from './job.js';
+import { Notification } from './notification.js';
+import { ProductionComment } from './production_comment.js';
+import { Reminder } from './reminder.js';
+import { Shipment } from './shipment.js';
+import { SupplyDomain } from './supply_domain.js';
+import { User } from './user.js';
+interface GenerateInvoiceProps {
+    addToInvoice?: number;
+}
+export declare class Assignment extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    managerAccepts?: Date | null;
+    supplierRefused?: Date | null;
+    needsDrafting?: boolean;
+    needsShipping?: boolean;
+    productionDeadline?: Date;
+    assignmentDeadline?: Date;
+    notes?: string | null;
+    job?: Job | null;
+    supplyJob?: Job | null;
+    supplier?: User | null;
+    quote?: Quote | null;
+    quoteTotalCost?: number;
+    comments?: ProductionComment[];
+    shipment?: Shipment | null;
+    supplyDomain?: SupplyDomain | null;
+    notifications?: Notification[];
+    reminders?: Reminder[];
+    productionFiles?: MerchiFile[];
+    generateInvoice: (props?: GenerateInvoiceProps) => Promise<import("./invoice.js").Invoice>;
+}
+export {};

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

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

package/dist/entities/automatic_payment_relationship.d.ts

@@ -0,0 +1,14 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+export declare class AutomaticPaymentRelationship extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    creationDate?: Date;
+    allowPostPayment?: boolean;
+    companyCustomer?: Company;
+    companySupplier?: Company;
+    stripeCustomerId?: string;
+}

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

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

package/dist/entities/bank.d.ts

@@ -0,0 +1,20 @@
+import { Address } from './address.js';
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+export declare class Bank extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    default?: boolean;
+    bankName?: string;
+    accountNumber?: string;
+    accountName?: string;
+    bsb?: string | null;
+    swiftCode?: string | null;
+    iban?: string | null;
+    bankCode?: string | null;
+    bankAddress?: Address | null;
+    company?: Company;
+}

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

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

package/dist/entities/cart.d.ts

@@ -0,0 +1,50 @@
+import { Address } from './address.js';
+import { CartItem } from './cart_item.js';
+import { CartShipmentGroup } from './cart_shipment_group.js';
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { Invoice } from './invoice.js';
+import { User } from './user.js';
+import { Item } from './item.js';
+export declare class Cart extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    stripePaymentEngine?: string;
+    creationDate?: Date;
+    updated?: Date;
+    ip?: string | null;
+    token?: string | null;
+    receiverNotes?: string | null;
+    currency?: string;
+    cartItemsSubtotalCost?: number;
+    cartItemsTaxAmount?: number;
+    cartItemsTotalCost?: number;
+    shipmentTotalCost?: number;
+    subtotalCost?: number;
+    taxAmount?: number;
+    totalCost?: number;
+    sendWhatsapp?: boolean;
+    isTest?: boolean;
+    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;
+    client?: User | null;
+    clientCompany?: Company | null;
+    domain?: Domain;
+    invoice?: Invoice | null;
+    receiverAddress?: Address | null;
+    discountItems?: Item[];
+    cartItems?: CartItem[];
+    shipmentGroups?: CartShipmentGroup[];
+    requiresShipment: () => boolean;
+}

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

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

package/dist/entities/cart_item.d.ts

@@ -0,0 +1,33 @@
+import { Cart } from './cart.js';
+import { CountryTax } from './country_tax.js';
+import { Entity } from '../entity.js';
+import { Product } from './product.js';
+import { Variation } from './variation.js';
+import { VariationsGroup } from './variations_group.js';
+import { DomainTag } from './domain_tag.js';
+import { Draft } from './draft.js';
+import { MerchiFile } from './file.js';
+export declare class CartItem extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    quantity?: number;
+    notes?: string | null;
+    creationDate?: Date;
+    currency?: string;
+    subtotalCost?: number;
+    taxAmount?: number;
+    totalCost?: number;
+    product?: Product;
+    cart?: Cart;
+    taxType?: CountryTax;
+    variationsGroups?: VariationsGroup[];
+    variations?: Variation[];
+    tags?: DomainTag[];
+    ownDrafts?: Draft[];
+    clientFiles?: MerchiFile[];
+    requiresShipment: () => boolean;
+    calculate: () => Promise<this>;
+}

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

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

package/dist/entities/cart_shipment_group.d.ts

@@ -0,0 +1,12 @@
+import { CartItem } from './cart_item.js';
+import { CartShipmentQuote } from './cart_shipment_quote.js';
+import { Entity } from '../entity.js';
+export declare class CartShipmentGroup extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    cartItems?: CartItem[];
+    quotes?: CartShipmentQuote[];
+    selectedQuote?: CartShipmentQuote;
+}

package/dist/entities/cart_shipment_quote.d.ts

@@ -0,0 +1,16 @@
+import { ShipmentMethod } from './shipment_method.js';
+import { Entity } from '../entity.js';
+import { ShipmentService } from '../constants/shipment_services.js';
+export declare class CartShipmentQuote extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    name?: string;
+    subtotalCost?: number;
+    taxAmount?: number;
+    totalCost?: number;
+    shipmentService?: ShipmentService | null;
+    shipmentServiceQuote?: string;
+    shipmentMethod?: ShipmentMethod;
+}

package/dist/entities/category.d.ts

@@ -0,0 +1,26 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Product } from './product.js';
+import { User } from './user.js';
+export declare class Category extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    name?: string;
+    position?: number;
+    description?: string | null;
+    descriptionShort?: string | null;
+    showDashboard?: boolean;
+    showPublic?: boolean;
+    showPublicSupplierResell?: boolean;
+    descendant?: number;
+    domain?: Domain;
+    products?: Product[];
+    users?: User[];
+    subcategories?: Category[];
+    parent?: Category;
+    image?: MerchiFile | null;
+}

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

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

package/dist/entities/company.d.ts

@@ -0,0 +1,137 @@
+import { Address } from './address.js';
+import { AutomaticPaymentRelationship } from './automatic_payment_relationship.js';
+import { Bank } from './bank.js';
+import { Cart } from './cart.js';
+import { CompanyInvitation } from './company_invitation.js';
+import { CountryTax } from './country_tax.js';
+import { Domain } from './domain.js';
+import { EmailAddress } from './email_address.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { InternalTag } from './internal_tag.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.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 { UserCompany } from './user_company.js';
+import { SubscriptionPlan } from './subscription_plan.js';
+import { PaymentDevice } from './payment_device.js';
+import type { AgentTokenAnalyticsTimeseries, CompanyAnalyticsResponse } from './agent_token_analytics.js';
+export declare class Company extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    created?: Date | null;
+    id?: number;
+    name?: string;
+    callToActions?: string;
+    callToActionDetails?: any[];
+    website?: string | null;
+    ownershipUnconfirmed?: boolean;
+    taxNumber?: string | null;
+    taxNumberType?: string | null;
+    paypalAccount?: string | null;
+    paypalPassword?: string | null;
+    paypalSignature?: string | null;
+    isPaypalValid?: boolean;
+    isStripeAccountEnabled?: boolean;
+    stripeAccountId?: string;
+    stripeCustomerId?: string;
+    sendleActive?: boolean;
+    sendleApiKey?: string;
+    sendleId?: string;
+    unltdAiApiOrganizationId?: string;
+    unltdAiApiSecretKey?: string;
+    australiaPostApiKey?: string;
+    australiaPostPassword?: string;
+    startrackApiKey?: string;
+    startrackPassword?: string;
+    dhlApiKey?: string;
+    dhlApiSecret?: string;
+    dhlTrackingSandbox?: boolean;
+    dhlTrackingExpress?: boolean;
+    fedexApiKey?: string;
+    fedexApiSecret?: string;
+    upsClientId?: string;
+    upsClientSecret?: string;
+    uspsApiKey?: string;
+    tntApiKey?: string;
+    tntApiSecret?: string;
+    aramexAccountNumber?: string;
+    aramexApiKey?: string;
+    aramexApiSecret?: string;
+    nzPostApiKey?: string;
+    internalUseNotes?: string;
+    internalUseAiContext?: string;
+    aiContext?: string;
+    isNew?: boolean;
+    subscriptionOutstanding?: boolean;
+    trialEndDate?: Date | null;
+    trialEndDateUpdated?: Date | null;
+    trialEndDateSetBy?: User;
+    isBlocked?: boolean;
+    isTesting?: boolean;
+    squareAccessToken?: string | null;
+    squareRefreshToken?: string | null;
+    squareExpiresAt?: Date | null;
+    squareIsValid?: boolean;
+    squareMerchantId?: string | null;
+    squareWebLocationId?: string | null;
+    stripePublishableTestKey?: string | null;
+    stripeApiTestKey?: string | null;
+    stripePublishableKey?: string | null;
+    stripeApiKey?: string | null;
+    stripeConnectDisabled?: boolean;
+    isPayingCompany?: boolean;
+    isStripeValid?: boolean;
+    acceptSquare?: boolean;
+    acceptStripe?: boolean;
+    acceptPaypal?: boolean;
+    acceptUtrust?: boolean;
+    utrustApiKey?: string | null;
+    utrustWebhookKey?: string | null;
+    isUtrustValid?: boolean;
+    acceptBankTransfer?: boolean;
+    acceptPhonePayment?: boolean;
+    defaultCurrency?: string;
+    country?: string;
+    internalTags?: InternalTag[];
+    logo?: MerchiFile | null;
+    defaultTaxType?: CountryTax | null;
+    automaticPaymentRelationships?: AutomaticPaymentRelationship[];
+    taxTypes?: CountryTax[];
+    paymentDevices?: PaymentDevice[];
+    subscriptionPlan?: SubscriptionPlan | null;
+    _emailAddresses?: EmailAddress[];
+    _paymentPhoneNumbers?: PhoneNumber[];
+    _phoneNumbers?: PhoneNumber[];
+    _addresses?: Address[];
+    _users?: UserCompany[];
+    shipmentsAsSender?: Shipment[];
+    shipmentsAsReceiver?: Shipment[];
+    savedProducts?: Product[];
+    reminders?: Reminder[];
+    banks?: Bank[];
+    userCompanies?: UserCompany[];
+    companyInvitations?: CompanyInvitation[];
+    appliedJobs?: Job[];
+    carts?: Cart[];
+    domains?: Domain[];
+    accessibleDomainsAsClientCompany?: Domain[];
+    emailAddresses?: EmailAddress[];
+    phoneNumbers?: PhoneNumber[];
+    paymentPhoneNumbers?: PhoneNumber[];
+    invoicesHas?: Invoice[];
+    subscriptionInvoices?: Invoice[];
+    addresses?: Address[];
+    parentCompany?: Company | null;
+    childCompanies?: Company[];
+    private getCompanyId;
+    private analyticsRequest;
+    getAnalytics: () => Promise<CompanyAnalyticsResponse>;
+    getAgentTokenAnalytics: (queryParams?: Record<string, string | undefined>) => Promise<AgentTokenAnalyticsTimeseries>;
+}

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

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

package/dist/entities/company_invitation.d.ts

@@ -0,0 +1,16 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+export declare class CompanyInvitation extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    userName?: string;
+    userEmail?: string;
+    inviteAsAdmin?: boolean;
+    token?: string;
+    company?: Company;
+    sender?: User;
+}

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

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

package/dist/entities/country_tax.d.ts

@@ -0,0 +1,20 @@
+import { Company } from './company.js';
+import { Entity } from '../entity.js';
+import { Item } from './item.js';
+import { Job } from './job.js';
+import { Shipment } from './shipment.js';
+export declare class CountryTax extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    archived?: Date | null;
+    id?: number;
+    country?: string | null;
+    taxName?: string;
+    taxPercent?: number | null;
+    shipments?: Shipment[];
+    company?: Company;
+    jobs?: Job[];
+    items?: Item[];
+    static getNoTax(): CountryTax;
+}

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

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