@retaila/shared-types 1.1.20 → 1.1.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +319 -117
- package/dist/index.d.ts +319 -117
- package/dist/index.js +89 -9
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +80 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -356,6 +356,111 @@ interface CustomerUpsertDto {
|
|
|
356
356
|
phone?: Phone;
|
|
357
357
|
}
|
|
358
358
|
|
|
359
|
+
/**
|
|
360
|
+
* Entidad Product
|
|
361
|
+
* Representa un producto vendible en la tienda. Es la entidad base que puede tener múltiples variantes.
|
|
362
|
+
*/
|
|
363
|
+
interface Product {
|
|
364
|
+
id: string;
|
|
365
|
+
accountId: string;
|
|
366
|
+
code: string;
|
|
367
|
+
brandId?: string | null;
|
|
368
|
+
supplierId?: string | null;
|
|
369
|
+
productType: ProductType;
|
|
370
|
+
sku?: string | null;
|
|
371
|
+
barcode?: string | null;
|
|
372
|
+
name: string;
|
|
373
|
+
slug: string;
|
|
374
|
+
description?: string | null;
|
|
375
|
+
isFeatured: boolean;
|
|
376
|
+
allowBackorder: boolean;
|
|
377
|
+
weight?: number | null;
|
|
378
|
+
weightUnit?: string | null;
|
|
379
|
+
height?: number | null;
|
|
380
|
+
width?: number | null;
|
|
381
|
+
depth?: number | null;
|
|
382
|
+
dimensionUnit?: string | null;
|
|
383
|
+
shippingLeadTime?: string | null;
|
|
384
|
+
status: ProductStatus;
|
|
385
|
+
createdAt: Date;
|
|
386
|
+
updatedAt: Date;
|
|
387
|
+
deletedAt?: Date | null;
|
|
388
|
+
media?: Media[];
|
|
389
|
+
}
|
|
390
|
+
declare enum ProductStatus {
|
|
391
|
+
ACTIVE = "ACTIVE",// Available for sale
|
|
392
|
+
INACTIVE = "INACTIVE",// Not visible/purchasable
|
|
393
|
+
ARCHIVED = "ARCHIVED",// Not visible, kept for records
|
|
394
|
+
DRAFT = "DRAFT"
|
|
395
|
+
}
|
|
396
|
+
declare enum ProductType {
|
|
397
|
+
SIMPLE = "SIMPLE",// Product without variants (may have a default hidden variant)
|
|
398
|
+
VARIABLE = "VARIABLE",// Product with distinct variants (color, size, etc.)
|
|
399
|
+
BUNDLE = "BUNDLE",// A package of other products/variants
|
|
400
|
+
GIFT_CARD = "GIFT_CARD"
|
|
401
|
+
}
|
|
402
|
+
interface ProductVariant {
|
|
403
|
+
id: string;
|
|
404
|
+
accountId: string;
|
|
405
|
+
productId: string;
|
|
406
|
+
sku?: string | null;
|
|
407
|
+
barcode?: string | null;
|
|
408
|
+
currency: string;
|
|
409
|
+
price: number;
|
|
410
|
+
compareAtPrice?: number;
|
|
411
|
+
allowBackorder?: boolean;
|
|
412
|
+
stock: number;
|
|
413
|
+
weight?: number | null;
|
|
414
|
+
weightUnit?: string | null;
|
|
415
|
+
height?: number | null;
|
|
416
|
+
width?: number | null;
|
|
417
|
+
depth?: number | null;
|
|
418
|
+
dimensionUnit?: string | null;
|
|
419
|
+
shippingLeadTime?: string | null;
|
|
420
|
+
order: number;
|
|
421
|
+
createdAt: Date;
|
|
422
|
+
updatedAt: Date;
|
|
423
|
+
deletedAt?: Date;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
type FulfillmentItem = {
|
|
427
|
+
id: string;
|
|
428
|
+
fulfillmentId: string;
|
|
429
|
+
orderItemId: string;
|
|
430
|
+
quantity: number;
|
|
431
|
+
};
|
|
432
|
+
|
|
433
|
+
type CreateFulfillmentItemDto = {
|
|
434
|
+
orderItemId: string;
|
|
435
|
+
quantity: string;
|
|
436
|
+
};
|
|
437
|
+
|
|
438
|
+
declare enum FulfillmentStatus {
|
|
439
|
+
PENDING = "pending",
|
|
440
|
+
PACKED = "packed",
|
|
441
|
+
SHIPPED = "shipped",
|
|
442
|
+
DELIVERED = "delivered",
|
|
443
|
+
CANCELLED = "cancelled"
|
|
444
|
+
}
|
|
445
|
+
type Fulfillment = {
|
|
446
|
+
id: string;
|
|
447
|
+
accountId: string;
|
|
448
|
+
orderId: string;
|
|
449
|
+
accountBranchId: string;
|
|
450
|
+
carrier: string;
|
|
451
|
+
trackingNumber: string | null;
|
|
452
|
+
items: FulfillmentItem[];
|
|
453
|
+
status: FulfillmentStatus;
|
|
454
|
+
data: Record<string, unknown> | null;
|
|
455
|
+
packedAt: Date | null;
|
|
456
|
+
shippedAt: Date | null;
|
|
457
|
+
deliveredAt: Date | null;
|
|
458
|
+
cancelledAt: Date | null;
|
|
459
|
+
createdAt: Date;
|
|
460
|
+
updatedAt: Date;
|
|
461
|
+
deletedAt?: Date;
|
|
462
|
+
};
|
|
463
|
+
|
|
359
464
|
/**
|
|
360
465
|
* Entidad Order
|
|
361
466
|
* Define la orden de compra de un cliente en el sitio web.
|
|
@@ -385,7 +490,7 @@ interface Order {
|
|
|
385
490
|
totalRefunded: number;
|
|
386
491
|
status: OrderStatus;
|
|
387
492
|
paymentStatus: OrderPaymentStatus;
|
|
388
|
-
fulfillmentStatus:
|
|
493
|
+
fulfillmentStatus: FulfillmentStatus;
|
|
389
494
|
statusHistory?: StatusChangeHistory[];
|
|
390
495
|
customerNote?: string;
|
|
391
496
|
internalNote?: string;
|
|
@@ -423,6 +528,7 @@ interface OrderItem {
|
|
|
423
528
|
taxName?: string;
|
|
424
529
|
createdAt: Date;
|
|
425
530
|
updatedAt: Date;
|
|
531
|
+
product?: Product;
|
|
426
532
|
}
|
|
427
533
|
declare enum OrderStatus {
|
|
428
534
|
PENDING = "PENDING",// Order placed, awaiting payment confirmation
|
|
@@ -442,11 +548,6 @@ declare enum OrderPaymentStatus {
|
|
|
442
548
|
REFUNDED = "REFUNDED",
|
|
443
549
|
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED"
|
|
444
550
|
}
|
|
445
|
-
declare enum OrderFulfillmentStatus {
|
|
446
|
-
PENDING = "PENDING",
|
|
447
|
-
PARTIAL = "PARTIAL",
|
|
448
|
-
FULFILLED = "FULFILLED"
|
|
449
|
-
}
|
|
450
551
|
declare enum OrderSource {
|
|
451
552
|
WEB = "WEB",
|
|
452
553
|
POS = "POS",
|
|
@@ -586,6 +687,8 @@ interface Cart {
|
|
|
586
687
|
subtotal: number;
|
|
587
688
|
total: number;
|
|
588
689
|
deliveryType: CartDeliveryType;
|
|
690
|
+
deliveryOptionId?: string;
|
|
691
|
+
pickupBranchId?: string;
|
|
589
692
|
itemCount: number;
|
|
590
693
|
createdAt: Date;
|
|
591
694
|
updatedAt: Date;
|
|
@@ -602,8 +705,8 @@ interface Cart {
|
|
|
602
705
|
totalTax?: number;
|
|
603
706
|
totalPrice?: number;
|
|
604
707
|
taxDetails?: any;
|
|
605
|
-
customer?: Customer | null;
|
|
606
|
-
accountDomain?: AccountDomain;
|
|
708
|
+
customer?: Partial<Customer> | null;
|
|
709
|
+
accountDomain?: Partial<AccountDomain> | null;
|
|
607
710
|
}
|
|
608
711
|
interface CartItem {
|
|
609
712
|
id: string;
|
|
@@ -637,7 +740,7 @@ declare enum CartSource {
|
|
|
637
740
|
API = "API"
|
|
638
741
|
}
|
|
639
742
|
declare enum CartDeliveryType {
|
|
640
|
-
|
|
743
|
+
SHIPPING = "shipping",
|
|
641
744
|
PICKUP = "pickup"
|
|
642
745
|
}
|
|
643
746
|
|
|
@@ -649,7 +752,8 @@ declare enum PaymentStatus {
|
|
|
649
752
|
REJECTED = "REJECTED",// Pago rechazado
|
|
650
753
|
REFUND_IN_PROCESS = "REFUND_IN_PROCESS",// En proceso de reembolso con la plataforma de pagos
|
|
651
754
|
PARTIAL_REFUND = "PARTIAL_REFUND",// Pago parcialmente reembolsado
|
|
652
|
-
REFUNDED = "REFUNDED"
|
|
755
|
+
REFUNDED = "REFUNDED",// Pago reembolsado
|
|
756
|
+
ERROR = "ERROR"
|
|
653
757
|
}
|
|
654
758
|
declare enum PaymentMethodType {
|
|
655
759
|
BANK_TRANSFER = "BANK_TRANSFER",
|
|
@@ -679,125 +783,54 @@ interface Payment {
|
|
|
679
783
|
status: PaymentStatus;
|
|
680
784
|
cardBrand?: string;
|
|
681
785
|
cardLast4?: string;
|
|
786
|
+
data?: Record<string, unknown>;
|
|
682
787
|
metadata?: Record<string, any>;
|
|
683
788
|
demo: boolean;
|
|
684
789
|
createdAt: string | Date;
|
|
685
790
|
updatedAt: string | Date;
|
|
686
791
|
deletedAt?: string | Date;
|
|
687
792
|
}
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
accountId: string;
|
|
696
|
-
code: string;
|
|
697
|
-
brandId?: string | null;
|
|
698
|
-
supplierId?: string | null;
|
|
699
|
-
productType: ProductType;
|
|
700
|
-
sku?: string | null;
|
|
701
|
-
barcode?: string | null;
|
|
702
|
-
name: string;
|
|
703
|
-
slug: string;
|
|
704
|
-
description?: string | null;
|
|
705
|
-
isFeatured: boolean;
|
|
706
|
-
allowBackorder: boolean;
|
|
707
|
-
weight?: number | null;
|
|
708
|
-
weightUnit?: string | null;
|
|
709
|
-
height?: number | null;
|
|
710
|
-
width?: number | null;
|
|
711
|
-
depth?: number | null;
|
|
712
|
-
dimensionUnit?: string | null;
|
|
713
|
-
shippingLeadTime?: string | null;
|
|
714
|
-
status: ProductStatus;
|
|
715
|
-
createdAt: Date;
|
|
716
|
-
updatedAt: Date;
|
|
717
|
-
deletedAt?: Date | null;
|
|
718
|
-
}
|
|
719
|
-
declare enum ProductStatus {
|
|
720
|
-
ACTIVE = "ACTIVE",// Available for sale
|
|
721
|
-
INACTIVE = "INACTIVE",// Not visible/purchasable
|
|
722
|
-
ARCHIVED = "ARCHIVED",// Not visible, kept for records
|
|
723
|
-
DRAFT = "DRAFT"
|
|
793
|
+
type PaymentProviderKey = 'MERCADOPAGO';
|
|
794
|
+
interface PaymentProviderContext {
|
|
795
|
+
db: unknown;
|
|
796
|
+
accountIntegrationId: string;
|
|
797
|
+
providerKey: PaymentProviderKey;
|
|
798
|
+
environment: 'PRODUCTION' | 'DEVELOPMENT';
|
|
799
|
+
credentials: Record<string, any>;
|
|
724
800
|
}
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
VARIABLE = "VARIABLE",// Product with distinct variants (color, size, etc.)
|
|
728
|
-
BUNDLE = "BUNDLE",// A package of other products/variants
|
|
729
|
-
GIFT_CARD = "GIFT_CARD"
|
|
801
|
+
interface PaymentProviderInitInput {
|
|
802
|
+
data: Record<string, any>;
|
|
730
803
|
}
|
|
731
|
-
interface
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
productId: string;
|
|
735
|
-
sku?: string | null;
|
|
736
|
-
barcode?: string | null;
|
|
737
|
-
currency: string;
|
|
738
|
-
price: number;
|
|
739
|
-
compareAtPrice?: number;
|
|
740
|
-
allowBackorder?: boolean;
|
|
741
|
-
stock: number;
|
|
742
|
-
weight?: number | null;
|
|
743
|
-
weightUnit?: string | null;
|
|
744
|
-
height?: number | null;
|
|
745
|
-
width?: number | null;
|
|
746
|
-
depth?: number | null;
|
|
747
|
-
dimensionUnit?: string | null;
|
|
748
|
-
shippingLeadTime?: string | null;
|
|
749
|
-
order: number;
|
|
750
|
-
createdAt: Date;
|
|
751
|
-
updatedAt: Date;
|
|
752
|
-
deletedAt?: Date;
|
|
804
|
+
interface PaymentProviderInitOutput {
|
|
805
|
+
data: Record<string, any>;
|
|
806
|
+
status: PaymentStatus;
|
|
753
807
|
}
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
* Define los atributos disponibles que se pueden asignar a las variantes de producto (ej. Color, Talla).
|
|
758
|
-
* Especifica el nombre y tipo del atributo para ayudar en la representación y filtrado.
|
|
759
|
-
*/
|
|
760
|
-
interface ProductAttribute {
|
|
761
|
-
id: string;
|
|
762
|
-
accountId: string;
|
|
763
|
-
name: string;
|
|
764
|
-
alias: string;
|
|
765
|
-
slug: string;
|
|
766
|
-
type: ProductAttributeType;
|
|
767
|
-
isRequired: boolean;
|
|
768
|
-
suffix: string;
|
|
769
|
-
status: ProductAttributeStatus;
|
|
770
|
-
createdAt: Date;
|
|
771
|
-
updatedAt: Date;
|
|
772
|
-
deletedAt?: Date | null;
|
|
773
|
-
options: ProductAttributeOption[];
|
|
774
|
-
displayOrder: number;
|
|
808
|
+
interface PaymentProviderRefundInput {
|
|
809
|
+
amount: number;
|
|
810
|
+
data: Record<string, any>;
|
|
775
811
|
}
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
INACTIVE = "INACTIVE"
|
|
812
|
+
interface PaymentProviderRefundOutput {
|
|
813
|
+
data: Record<string, any>;
|
|
779
814
|
}
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
SELECT = "SELECT",// Dropdown list
|
|
785
|
-
BOOLEAN = "BOOLEAN"
|
|
815
|
+
interface PaymentProviderWebhookResult {
|
|
816
|
+
order_code: string | null;
|
|
817
|
+
status: PaymentStatus;
|
|
818
|
+
data: Record<string, unknown>;
|
|
786
819
|
}
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
*/
|
|
790
|
-
interface ProductAttributeOption {
|
|
791
|
-
id: string;
|
|
820
|
+
interface WebhookPayload {
|
|
821
|
+
provider: string;
|
|
792
822
|
accountId: string;
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
823
|
+
payload: {
|
|
824
|
+
query: Record<string, unknown>;
|
|
825
|
+
body: Record<string, unknown>;
|
|
826
|
+
headers: Record<string, unknown>;
|
|
827
|
+
};
|
|
828
|
+
}
|
|
829
|
+
interface PaymentProviderAdapter {
|
|
830
|
+
readonly key: PaymentProviderKey;
|
|
831
|
+
initPayment(input: PaymentProviderInitInput): Promise<PaymentProviderInitOutput>;
|
|
832
|
+
refund(input: PaymentProviderRefundInput): Promise<PaymentProviderRefundOutput>;
|
|
833
|
+
processWebhook(input: WebhookPayload['payload']): Promise<PaymentProviderWebhookResult>;
|
|
801
834
|
}
|
|
802
835
|
|
|
803
836
|
/**
|
|
@@ -862,6 +895,61 @@ declare enum ProductCategoryStatus {
|
|
|
862
895
|
INACTIVE = "INACTIVE"
|
|
863
896
|
}
|
|
864
897
|
|
|
898
|
+
/**
|
|
899
|
+
* Entidad ProductAttribute
|
|
900
|
+
* Define los atributos disponibles que se pueden asignar a las variantes de producto (ej. Color, Talla).
|
|
901
|
+
* Especifica el nombre y tipo del atributo para ayudar en la representación y filtrado.
|
|
902
|
+
*/
|
|
903
|
+
|
|
904
|
+
interface ProductAttribute {
|
|
905
|
+
id: string;
|
|
906
|
+
accountId: string;
|
|
907
|
+
name: string;
|
|
908
|
+
alias: string;
|
|
909
|
+
slug: string;
|
|
910
|
+
type: ProductAttributeType;
|
|
911
|
+
isRequired: boolean;
|
|
912
|
+
suffix: string;
|
|
913
|
+
status: ProductAttributeStatus;
|
|
914
|
+
createdAt: Date;
|
|
915
|
+
updatedAt: Date;
|
|
916
|
+
deletedAt?: Date | null;
|
|
917
|
+
productCategories: ProductCategory[];
|
|
918
|
+
productCategoryLinks: Array<{
|
|
919
|
+
categoryId: string;
|
|
920
|
+
isRequired: boolean;
|
|
921
|
+
displayOrder: number;
|
|
922
|
+
}>;
|
|
923
|
+
options: ProductAttributeOption[];
|
|
924
|
+
displayOrder: number;
|
|
925
|
+
}
|
|
926
|
+
declare enum ProductAttributeStatus {
|
|
927
|
+
ACTIVE = "ACTIVE",
|
|
928
|
+
INACTIVE = "INACTIVE"
|
|
929
|
+
}
|
|
930
|
+
declare enum ProductAttributeType {
|
|
931
|
+
TEXT = "TEXT",// text input
|
|
932
|
+
NUMBER = "NUMBER",// number input
|
|
933
|
+
COLOR = "COLOR",// Special type for color swatches
|
|
934
|
+
SELECT = "SELECT",// Dropdown list
|
|
935
|
+
BOOLEAN = "BOOLEAN"
|
|
936
|
+
}
|
|
937
|
+
/**
|
|
938
|
+
* Una opción específica para un atributo (ej. "Talle 42" para el atributo "Talle").
|
|
939
|
+
*/
|
|
940
|
+
interface ProductAttributeOption {
|
|
941
|
+
id: string;
|
|
942
|
+
accountId: string;
|
|
943
|
+
productAttributeId: string;
|
|
944
|
+
value: string;
|
|
945
|
+
imageId?: string | null;
|
|
946
|
+
order: number;
|
|
947
|
+
createdAt: Date;
|
|
948
|
+
updatedAt: Date;
|
|
949
|
+
deletedAt?: Date | null;
|
|
950
|
+
count: number;
|
|
951
|
+
}
|
|
952
|
+
|
|
865
953
|
/**
|
|
866
954
|
* Entidad StoreBanner
|
|
867
955
|
* Banners para la portada de la web de la tienda
|
|
@@ -929,7 +1017,121 @@ declare enum StorePageType {
|
|
|
929
1017
|
|
|
930
1018
|
declare enum PubSubTopics {
|
|
931
1019
|
ORDER_PLACED = "order-placed",
|
|
1020
|
+
ORDER_CONFIRMED = "order-confirmed",
|
|
1021
|
+
ORDER_PROCESSING = "order-processing",
|
|
1022
|
+
ORDER_PROCESSED = "order-processed",
|
|
1023
|
+
ORDER_COMPLETED = "order-completed",
|
|
1024
|
+
PAYMENT_PAID = "payment-paid",
|
|
932
1025
|
NOTIFICATION_CREATED = "notification-created"
|
|
933
1026
|
}
|
|
934
1027
|
|
|
935
|
-
|
|
1028
|
+
declare enum SupportConversationChannel {
|
|
1029
|
+
WEB = "WEB",
|
|
1030
|
+
EMAIL = "EMAIL",
|
|
1031
|
+
WHATSAPP = "WHATSAPP"
|
|
1032
|
+
}
|
|
1033
|
+
declare enum SupportConversationVisibility {
|
|
1034
|
+
INTERNAL = "INTERNAL",
|
|
1035
|
+
MERCHANT = "MERCHANT"
|
|
1036
|
+
}
|
|
1037
|
+
declare enum SupportConversationPriority {
|
|
1038
|
+
LOW = "LOW",
|
|
1039
|
+
MEDIUM = "MEDIUM",
|
|
1040
|
+
HIGH = "HIGH",
|
|
1041
|
+
URGENT = "URGENT"
|
|
1042
|
+
}
|
|
1043
|
+
declare enum SupportConversationStatus {
|
|
1044
|
+
OPEN = "OPEN",
|
|
1045
|
+
CLOSED = "CLOSED",
|
|
1046
|
+
PENDING = "PENDING"
|
|
1047
|
+
}
|
|
1048
|
+
declare enum SupportConversationMessageDeliveryStatus {
|
|
1049
|
+
QUEUED = "QUEUED",
|
|
1050
|
+
SENT = "SENT",
|
|
1051
|
+
DELIVERED = "DELIVERED",
|
|
1052
|
+
READ = "READ",
|
|
1053
|
+
FAILED = "FAILED"
|
|
1054
|
+
}
|
|
1055
|
+
declare enum SupportConversationMessageAiAnalysisStatus {
|
|
1056
|
+
PENDING = "PENDING",
|
|
1057
|
+
PROCESSING = "PROCESSING",
|
|
1058
|
+
COMPLETED = "COMPLETED",
|
|
1059
|
+
FAILED = "FAILED"
|
|
1060
|
+
}
|
|
1061
|
+
declare enum SupportConversationMessageDirection {
|
|
1062
|
+
INBOUND = "INBOUND",
|
|
1063
|
+
OUTBOUND = "OUTBOUND"
|
|
1064
|
+
}
|
|
1065
|
+
declare enum SupportConversationMessageSenderType {
|
|
1066
|
+
CUSTOMER = "CUSTOMER",
|
|
1067
|
+
ACCOUNT_USER = "ACCOUNT_USER",
|
|
1068
|
+
ANONYMOUS = "ANONYMOUS",
|
|
1069
|
+
SYSTEM = "SYSTEM",
|
|
1070
|
+
AI = "AI"
|
|
1071
|
+
}
|
|
1072
|
+
interface SupportConversation {
|
|
1073
|
+
id: string;
|
|
1074
|
+
accountId: string;
|
|
1075
|
+
subject?: string | null;
|
|
1076
|
+
channel: SupportConversationChannel;
|
|
1077
|
+
assigneeId?: string | null;
|
|
1078
|
+
visibility: SupportConversationVisibility;
|
|
1079
|
+
priority: SupportConversationPriority;
|
|
1080
|
+
requiresMerchantAction: boolean;
|
|
1081
|
+
requiresInternalAction: boolean;
|
|
1082
|
+
customerId?: string | null;
|
|
1083
|
+
customerName?: string | null;
|
|
1084
|
+
customerLastname?: string | null;
|
|
1085
|
+
customerEmail?: string | null;
|
|
1086
|
+
customerPhone?: string | null;
|
|
1087
|
+
status: SupportConversationStatus;
|
|
1088
|
+
lastMessageAt?: Date | null;
|
|
1089
|
+
unreadForAgent: number;
|
|
1090
|
+
unreadForCustomer: number;
|
|
1091
|
+
metadata?: Object | null;
|
|
1092
|
+
aiSuggestion?: Object | null;
|
|
1093
|
+
createdAt: Date;
|
|
1094
|
+
updatedAt: Date;
|
|
1095
|
+
deletedAt?: Date | null;
|
|
1096
|
+
account: Account;
|
|
1097
|
+
customer: Customer | null;
|
|
1098
|
+
messages: SupportConversationMessage[];
|
|
1099
|
+
}
|
|
1100
|
+
interface SupportConversationMessage {
|
|
1101
|
+
id: string;
|
|
1102
|
+
accountId: string;
|
|
1103
|
+
conversationId: string;
|
|
1104
|
+
direction: SupportConversationMessageDirection;
|
|
1105
|
+
senderType: SupportConversationMessageSenderType;
|
|
1106
|
+
senderId?: string | null;
|
|
1107
|
+
body: string;
|
|
1108
|
+
isAiGenerated: boolean;
|
|
1109
|
+
isSystem: boolean;
|
|
1110
|
+
deliveryStatus: SupportConversationMessageDeliveryStatus;
|
|
1111
|
+
requiresAiAnalysis: boolean;
|
|
1112
|
+
aiAnalysisStatus: SupportConversationMessageAiAnalysisStatus;
|
|
1113
|
+
aiAnalyzedAt?: Date | null;
|
|
1114
|
+
externalMessageId?: string | null;
|
|
1115
|
+
externalThreadId?: string | null;
|
|
1116
|
+
attachments?: Array<{
|
|
1117
|
+
url: string;
|
|
1118
|
+
type?: string;
|
|
1119
|
+
name?: string;
|
|
1120
|
+
sizeBytes?: number;
|
|
1121
|
+
}>;
|
|
1122
|
+
metadata?: Object | null;
|
|
1123
|
+
createdAt: Date;
|
|
1124
|
+
updatedAt: Date;
|
|
1125
|
+
deletedAt?: Date | null;
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
type CreateFulfillmentDto = {
|
|
1129
|
+
accountId: string;
|
|
1130
|
+
orderId: string;
|
|
1131
|
+
accountBranchId: string;
|
|
1132
|
+
carrier: string;
|
|
1133
|
+
items: CreateFulfillmentItemDto[];
|
|
1134
|
+
data?: Record<string, unknown>;
|
|
1135
|
+
};
|
|
1136
|
+
|
|
1137
|
+
export { type Account, type AccountBranch, type AccountBranchSchedule, AccountBranchScheduleDay, AccountBranchScheduleStatus, AccountBranchStatus, type AccountDeliveryOption, type AccountDeliveryOptionCalculatedCost, AccountDeliveryOptionPriceLogic, AccountDeliveryOptionStatus, type AccountDeliveryOptionZone, AccountDeliveryOptionZoneStatus, type AccountDomain, AccountDomainStatus, type AccountIntegration, type AccountIntegrationConfigDTO, AccountIntegrationConnectionStatus, AccountIntegrationEnvironment, AccountIntegrationStatus, AccountStatus, type Address, type AdminOrderStatusChangeDto, type BaseEntity, type BaseEntityWithAccount, type BaseEntityWithAccountAndUser, type BaseEntityWithUser, type Cart, type CartConfirmDto, CartDeliveryType, type CartItem, type CartItemAddDto, type CartItemAttributeDetail, CartItemErrorCode, type CartItemRemoveDto, type CartItemUpdateDto, type CartItemValidation, CartSource, CartStatus, type CartUpdateDto, type CreateFulfillmentDto, Currency, type Customer, CustomerStatus, type CustomerUpsertDto, type Fulfillment, FulfillmentStatus, type Integration, IntegrationCategory, IntegrationStatus, type MapPosition, type Media, MediaType, type Order, type OrderCreateFromCartDto, OrderDeliveryType, type OrderItem, OrderPaymentStatus, OrderSource, OrderStatus, type Payment, PaymentMethodType, type PaymentProviderAdapter, type PaymentProviderContext, type PaymentProviderInitInput, type PaymentProviderInitOutput, type PaymentProviderKey, type PaymentProviderRefundInput, type PaymentProviderRefundOutput, type PaymentProviderWebhookResult, PaymentStatus, type Phone, type Product, type ProductAttribute, type ProductAttributeOption, ProductAttributeStatus, ProductAttributeType, type ProductCategory, ProductCategoryStatus, ProductStatus, ProductType, type ProductVariant, PubSubTopics, type StandardCategory, StandardCategoryStatus, type StatusChangeHistory, type StoreBanner, StoreBannerStatus, type StorePage, StorePageStatus, StorePageType, type SupportConversation, SupportConversationChannel, type SupportConversationMessage, SupportConversationMessageAiAnalysisStatus, SupportConversationMessageDeliveryStatus, SupportConversationMessageDirection, SupportConversationMessageSenderType, SupportConversationPriority, SupportConversationStatus, SupportConversationVisibility, type ThemeConfig, type WebhookPayload, getCurrencySymbol };
|
package/dist/index.js
CHANGED
|
@@ -38,11 +38,11 @@ __export(index_exports, {
|
|
|
38
38
|
CartStatus: () => CartStatus,
|
|
39
39
|
Currency: () => Currency,
|
|
40
40
|
CustomerStatus: () => CustomerStatus,
|
|
41
|
+
FulfillmentStatus: () => FulfillmentStatus,
|
|
41
42
|
IntegrationCategory: () => IntegrationCategory,
|
|
42
43
|
IntegrationStatus: () => IntegrationStatus,
|
|
43
44
|
MediaType: () => MediaType,
|
|
44
45
|
OrderDeliveryType: () => OrderDeliveryType,
|
|
45
|
-
OrderFulfillmentStatus: () => OrderFulfillmentStatus,
|
|
46
46
|
OrderPaymentStatus: () => OrderPaymentStatus,
|
|
47
47
|
OrderSource: () => OrderSource,
|
|
48
48
|
OrderStatus: () => OrderStatus,
|
|
@@ -58,6 +58,14 @@ __export(index_exports, {
|
|
|
58
58
|
StoreBannerStatus: () => StoreBannerStatus,
|
|
59
59
|
StorePageStatus: () => StorePageStatus,
|
|
60
60
|
StorePageType: () => StorePageType,
|
|
61
|
+
SupportConversationChannel: () => SupportConversationChannel,
|
|
62
|
+
SupportConversationMessageAiAnalysisStatus: () => SupportConversationMessageAiAnalysisStatus,
|
|
63
|
+
SupportConversationMessageDeliveryStatus: () => SupportConversationMessageDeliveryStatus,
|
|
64
|
+
SupportConversationMessageDirection: () => SupportConversationMessageDirection,
|
|
65
|
+
SupportConversationMessageSenderType: () => SupportConversationMessageSenderType,
|
|
66
|
+
SupportConversationPriority: () => SupportConversationPriority,
|
|
67
|
+
SupportConversationStatus: () => SupportConversationStatus,
|
|
68
|
+
SupportConversationVisibility: () => SupportConversationVisibility,
|
|
61
69
|
getCurrencySymbol: () => getCurrencySymbol
|
|
62
70
|
});
|
|
63
71
|
module.exports = __toCommonJS(index_exports);
|
|
@@ -187,7 +195,7 @@ var CartSource = /* @__PURE__ */ ((CartSource2) => {
|
|
|
187
195
|
return CartSource2;
|
|
188
196
|
})(CartSource || {});
|
|
189
197
|
var CartDeliveryType = /* @__PURE__ */ ((CartDeliveryType2) => {
|
|
190
|
-
CartDeliveryType2["
|
|
198
|
+
CartDeliveryType2["SHIPPING"] = "shipping";
|
|
191
199
|
CartDeliveryType2["PICKUP"] = "pickup";
|
|
192
200
|
return CartDeliveryType2;
|
|
193
201
|
})(CartDeliveryType || {});
|
|
@@ -253,12 +261,6 @@ var OrderPaymentStatus = /* @__PURE__ */ ((OrderPaymentStatus2) => {
|
|
|
253
261
|
OrderPaymentStatus2["PARTIALLY_REFUNDED"] = "PARTIALLY_REFUNDED";
|
|
254
262
|
return OrderPaymentStatus2;
|
|
255
263
|
})(OrderPaymentStatus || {});
|
|
256
|
-
var OrderFulfillmentStatus = /* @__PURE__ */ ((OrderFulfillmentStatus2) => {
|
|
257
|
-
OrderFulfillmentStatus2["PENDING"] = "PENDING";
|
|
258
|
-
OrderFulfillmentStatus2["PARTIAL"] = "PARTIAL";
|
|
259
|
-
OrderFulfillmentStatus2["FULFILLED"] = "FULFILLED";
|
|
260
|
-
return OrderFulfillmentStatus2;
|
|
261
|
-
})(OrderFulfillmentStatus || {});
|
|
262
264
|
var OrderSource = /* @__PURE__ */ ((OrderSource2) => {
|
|
263
265
|
OrderSource2["WEB"] = "WEB";
|
|
264
266
|
OrderSource2["POS"] = "POS";
|
|
@@ -281,6 +283,7 @@ var PaymentStatus = /* @__PURE__ */ ((PaymentStatus2) => {
|
|
|
281
283
|
PaymentStatus2["REFUND_IN_PROCESS"] = "REFUND_IN_PROCESS";
|
|
282
284
|
PaymentStatus2["PARTIAL_REFUND"] = "PARTIAL_REFUND";
|
|
283
285
|
PaymentStatus2["REFUNDED"] = "REFUNDED";
|
|
286
|
+
PaymentStatus2["ERROR"] = "ERROR";
|
|
284
287
|
return PaymentStatus2;
|
|
285
288
|
})(PaymentStatus || {});
|
|
286
289
|
var PaymentMethodType = /* @__PURE__ */ ((PaymentMethodType2) => {
|
|
@@ -372,9 +375,78 @@ var StorePageType = /* @__PURE__ */ ((StorePageType2) => {
|
|
|
372
375
|
// src/pubsub/types.ts
|
|
373
376
|
var PubSubTopics = /* @__PURE__ */ ((PubSubTopics2) => {
|
|
374
377
|
PubSubTopics2["ORDER_PLACED"] = "order-placed";
|
|
378
|
+
PubSubTopics2["ORDER_CONFIRMED"] = "order-confirmed";
|
|
379
|
+
PubSubTopics2["ORDER_PROCESSING"] = "order-processing";
|
|
380
|
+
PubSubTopics2["ORDER_PROCESSED"] = "order-processed";
|
|
381
|
+
PubSubTopics2["ORDER_COMPLETED"] = "order-completed";
|
|
382
|
+
PubSubTopics2["PAYMENT_PAID"] = "payment-paid";
|
|
375
383
|
PubSubTopics2["NOTIFICATION_CREATED"] = "notification-created";
|
|
376
384
|
return PubSubTopics2;
|
|
377
385
|
})(PubSubTopics || {});
|
|
386
|
+
|
|
387
|
+
// src/supportConversation/types.ts
|
|
388
|
+
var SupportConversationChannel = /* @__PURE__ */ ((SupportConversationChannel2) => {
|
|
389
|
+
SupportConversationChannel2["WEB"] = "WEB";
|
|
390
|
+
SupportConversationChannel2["EMAIL"] = "EMAIL";
|
|
391
|
+
SupportConversationChannel2["WHATSAPP"] = "WHATSAPP";
|
|
392
|
+
return SupportConversationChannel2;
|
|
393
|
+
})(SupportConversationChannel || {});
|
|
394
|
+
var SupportConversationVisibility = /* @__PURE__ */ ((SupportConversationVisibility2) => {
|
|
395
|
+
SupportConversationVisibility2["INTERNAL"] = "INTERNAL";
|
|
396
|
+
SupportConversationVisibility2["MERCHANT"] = "MERCHANT";
|
|
397
|
+
return SupportConversationVisibility2;
|
|
398
|
+
})(SupportConversationVisibility || {});
|
|
399
|
+
var SupportConversationPriority = /* @__PURE__ */ ((SupportConversationPriority2) => {
|
|
400
|
+
SupportConversationPriority2["LOW"] = "LOW";
|
|
401
|
+
SupportConversationPriority2["MEDIUM"] = "MEDIUM";
|
|
402
|
+
SupportConversationPriority2["HIGH"] = "HIGH";
|
|
403
|
+
SupportConversationPriority2["URGENT"] = "URGENT";
|
|
404
|
+
return SupportConversationPriority2;
|
|
405
|
+
})(SupportConversationPriority || {});
|
|
406
|
+
var SupportConversationStatus = /* @__PURE__ */ ((SupportConversationStatus2) => {
|
|
407
|
+
SupportConversationStatus2["OPEN"] = "OPEN";
|
|
408
|
+
SupportConversationStatus2["CLOSED"] = "CLOSED";
|
|
409
|
+
SupportConversationStatus2["PENDING"] = "PENDING";
|
|
410
|
+
return SupportConversationStatus2;
|
|
411
|
+
})(SupportConversationStatus || {});
|
|
412
|
+
var SupportConversationMessageDeliveryStatus = /* @__PURE__ */ ((SupportConversationMessageDeliveryStatus2) => {
|
|
413
|
+
SupportConversationMessageDeliveryStatus2["QUEUED"] = "QUEUED";
|
|
414
|
+
SupportConversationMessageDeliveryStatus2["SENT"] = "SENT";
|
|
415
|
+
SupportConversationMessageDeliveryStatus2["DELIVERED"] = "DELIVERED";
|
|
416
|
+
SupportConversationMessageDeliveryStatus2["READ"] = "READ";
|
|
417
|
+
SupportConversationMessageDeliveryStatus2["FAILED"] = "FAILED";
|
|
418
|
+
return SupportConversationMessageDeliveryStatus2;
|
|
419
|
+
})(SupportConversationMessageDeliveryStatus || {});
|
|
420
|
+
var SupportConversationMessageAiAnalysisStatus = /* @__PURE__ */ ((SupportConversationMessageAiAnalysisStatus2) => {
|
|
421
|
+
SupportConversationMessageAiAnalysisStatus2["PENDING"] = "PENDING";
|
|
422
|
+
SupportConversationMessageAiAnalysisStatus2["PROCESSING"] = "PROCESSING";
|
|
423
|
+
SupportConversationMessageAiAnalysisStatus2["COMPLETED"] = "COMPLETED";
|
|
424
|
+
SupportConversationMessageAiAnalysisStatus2["FAILED"] = "FAILED";
|
|
425
|
+
return SupportConversationMessageAiAnalysisStatus2;
|
|
426
|
+
})(SupportConversationMessageAiAnalysisStatus || {});
|
|
427
|
+
var SupportConversationMessageDirection = /* @__PURE__ */ ((SupportConversationMessageDirection2) => {
|
|
428
|
+
SupportConversationMessageDirection2["INBOUND"] = "INBOUND";
|
|
429
|
+
SupportConversationMessageDirection2["OUTBOUND"] = "OUTBOUND";
|
|
430
|
+
return SupportConversationMessageDirection2;
|
|
431
|
+
})(SupportConversationMessageDirection || {});
|
|
432
|
+
var SupportConversationMessageSenderType = /* @__PURE__ */ ((SupportConversationMessageSenderType2) => {
|
|
433
|
+
SupportConversationMessageSenderType2["CUSTOMER"] = "CUSTOMER";
|
|
434
|
+
SupportConversationMessageSenderType2["ACCOUNT_USER"] = "ACCOUNT_USER";
|
|
435
|
+
SupportConversationMessageSenderType2["ANONYMOUS"] = "ANONYMOUS";
|
|
436
|
+
SupportConversationMessageSenderType2["SYSTEM"] = "SYSTEM";
|
|
437
|
+
SupportConversationMessageSenderType2["AI"] = "AI";
|
|
438
|
+
return SupportConversationMessageSenderType2;
|
|
439
|
+
})(SupportConversationMessageSenderType || {});
|
|
440
|
+
|
|
441
|
+
// src/fulfillment/types.ts
|
|
442
|
+
var FulfillmentStatus = /* @__PURE__ */ ((FulfillmentStatus2) => {
|
|
443
|
+
FulfillmentStatus2["PENDING"] = "pending";
|
|
444
|
+
FulfillmentStatus2["PACKED"] = "packed";
|
|
445
|
+
FulfillmentStatus2["SHIPPED"] = "shipped";
|
|
446
|
+
FulfillmentStatus2["DELIVERED"] = "delivered";
|
|
447
|
+
FulfillmentStatus2["CANCELLED"] = "cancelled";
|
|
448
|
+
return FulfillmentStatus2;
|
|
449
|
+
})(FulfillmentStatus || {});
|
|
378
450
|
// Annotate the CommonJS export names for ESM import in node:
|
|
379
451
|
0 && (module.exports = {
|
|
380
452
|
AccountBranchScheduleDay,
|
|
@@ -394,11 +466,11 @@ var PubSubTopics = /* @__PURE__ */ ((PubSubTopics2) => {
|
|
|
394
466
|
CartStatus,
|
|
395
467
|
Currency,
|
|
396
468
|
CustomerStatus,
|
|
469
|
+
FulfillmentStatus,
|
|
397
470
|
IntegrationCategory,
|
|
398
471
|
IntegrationStatus,
|
|
399
472
|
MediaType,
|
|
400
473
|
OrderDeliveryType,
|
|
401
|
-
OrderFulfillmentStatus,
|
|
402
474
|
OrderPaymentStatus,
|
|
403
475
|
OrderSource,
|
|
404
476
|
OrderStatus,
|
|
@@ -414,6 +486,14 @@ var PubSubTopics = /* @__PURE__ */ ((PubSubTopics2) => {
|
|
|
414
486
|
StoreBannerStatus,
|
|
415
487
|
StorePageStatus,
|
|
416
488
|
StorePageType,
|
|
489
|
+
SupportConversationChannel,
|
|
490
|
+
SupportConversationMessageAiAnalysisStatus,
|
|
491
|
+
SupportConversationMessageDeliveryStatus,
|
|
492
|
+
SupportConversationMessageDirection,
|
|
493
|
+
SupportConversationMessageSenderType,
|
|
494
|
+
SupportConversationPriority,
|
|
495
|
+
SupportConversationStatus,
|
|
496
|
+
SupportConversationVisibility,
|
|
417
497
|
getCurrencySymbol
|
|
418
498
|
});
|
|
419
499
|
//# sourceMappingURL=index.js.map
|