@aglyn/shared-util-email 1.0.0-beta.232 → 1.0.0-beta.234

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.
@@ -509,6 +509,193 @@
509
509
  ],
510
510
  "footerReason": "You’re receiving this because you placed an order with {{host.businessName}}."
511
511
  },
512
+ {
513
+ "key": "order-ready-for-pickup",
514
+ "name": "Order ready for pickup",
515
+ "description": "Tells the buyer their pickup order is ready, where to collect it, the pickup hours and any arrival instructions.",
516
+ "pluginId": "commerce",
517
+ "plugin": "Commerce",
518
+ "control": "besigner",
519
+ "defaultSubject": "Your order {{order.number}} is ready for pickup",
520
+ "mergeTokens": [
521
+ {
522
+ "name": "order.number",
523
+ "description": "The order number, as the store shows it",
524
+ "sample": "#1042"
525
+ },
526
+ {
527
+ "name": "order.summary",
528
+ "description": "The ordered items, one per line",
529
+ "sample": "2× House Blend"
530
+ },
531
+ {
532
+ "name": "pickup.location",
533
+ "description": "The pickup location’s name and address",
534
+ "sample": "Main Street shop, 12 Main St, Springfield"
535
+ },
536
+ {
537
+ "name": "pickup.hours",
538
+ "description": "The location’s pickup hours; empty when it lists none",
539
+ "sample": "Pickup hours:\nMo-Fr 09:00-17:00"
540
+ },
541
+ {
542
+ "name": "pickup.instructions",
543
+ "description": "What to do on arrival, as the store wrote it; empty when it wrote none",
544
+ "sample": "Ring the bell at the side door."
545
+ },
546
+ {
547
+ "name": "order.statusUrl",
548
+ "description": "Link to the order status page: status, shipments and tracking. Private to the buyer; it needs no account",
549
+ "sample": "https://shop.example.com/order-status?o=ord_123&t=…"
550
+ }
551
+ ],
552
+ "defaultBody": [
553
+ {
554
+ "block": "text",
555
+ "text": "Your order is ready for pickup",
556
+ "variant": "heading"
557
+ },
558
+ {
559
+ "block": "text",
560
+ "text": "Order {{order.number}} is ready at {{pickup.location}}.",
561
+ "variant": "body"
562
+ },
563
+ {
564
+ "block": "text",
565
+ "text": "{{order.summary}}",
566
+ "variant": "body"
567
+ },
568
+ {
569
+ "block": "text",
570
+ "text": "{{pickup.hours}}",
571
+ "variant": "body"
572
+ },
573
+ {
574
+ "block": "text",
575
+ "text": "{{pickup.instructions}}",
576
+ "variant": "body"
577
+ },
578
+ {
579
+ "block": "text",
580
+ "text": "Bring your order number, {{order.number}}.",
581
+ "variant": "caption"
582
+ },
583
+ {
584
+ "block": "button",
585
+ "label": "View your order",
586
+ "href": "{{order.statusUrl}}"
587
+ }
588
+ ],
589
+ "footerReason": "You’re receiving this because you placed an order with {{host.businessName}}."
590
+ },
591
+ {
592
+ "key": "order-picked-up",
593
+ "name": "Order picked up",
594
+ "description": "Confirms to the buyer that their pickup order was collected.",
595
+ "pluginId": "commerce",
596
+ "plugin": "Commerce",
597
+ "control": "besigner",
598
+ "defaultSubject": "You picked up order {{order.number}}",
599
+ "mergeTokens": [
600
+ {
601
+ "name": "order.number",
602
+ "description": "The order number, as the store shows it",
603
+ "sample": "#1042"
604
+ },
605
+ {
606
+ "name": "order.summary",
607
+ "description": "The ordered items, one per line",
608
+ "sample": "2× House Blend"
609
+ },
610
+ {
611
+ "name": "pickup.location",
612
+ "description": "The pickup location’s name and address",
613
+ "sample": "Main Street shop, 12 Main St, Springfield"
614
+ },
615
+ {
616
+ "name": "order.statusUrl",
617
+ "description": "Link to the order status page: status, shipments and tracking. Private to the buyer; it needs no account",
618
+ "sample": "https://shop.example.com/order-status?o=ord_123&t=…"
619
+ }
620
+ ],
621
+ "defaultBody": [
622
+ {
623
+ "block": "text",
624
+ "text": "Thanks for picking up your order",
625
+ "variant": "heading"
626
+ },
627
+ {
628
+ "block": "text",
629
+ "text": "Order {{order.number}} was picked up from {{pickup.location}}.",
630
+ "variant": "body"
631
+ },
632
+ {
633
+ "block": "text",
634
+ "text": "{{order.summary}}",
635
+ "variant": "body"
636
+ },
637
+ {
638
+ "block": "text",
639
+ "text": "If something is missing or not right, reply to this email or contact {{host.businessName}}.",
640
+ "variant": "caption"
641
+ }
642
+ ],
643
+ "footerReason": "You’re receiving this because you placed an order with {{host.businessName}}."
644
+ },
645
+ {
646
+ "key": "order-out-for-delivery",
647
+ "name": "Order out for delivery",
648
+ "description": "Tells the buyer the store’s own driver is on the way with their local delivery, in the window they booked.",
649
+ "pluginId": "commerce",
650
+ "plugin": "Commerce",
651
+ "control": "besigner",
652
+ "defaultSubject": "Your order {{order.number}} is out for delivery",
653
+ "mergeTokens": [
654
+ {
655
+ "name": "order.number",
656
+ "description": "The order number, as the store shows it",
657
+ "sample": "#1042"
658
+ },
659
+ {
660
+ "name": "order.summary",
661
+ "description": "The ordered items, one per line",
662
+ "sample": "2× House Blend"
663
+ },
664
+ {
665
+ "name": "delivery.window",
666
+ "description": "The delivery window the buyer booked",
667
+ "sample": "Tue, Oct 14, 9:00 AM – 12:00 PM"
668
+ },
669
+ {
670
+ "name": "order.statusUrl",
671
+ "description": "Link to the order status page: status, shipments and tracking. Private to the buyer; it needs no account",
672
+ "sample": "https://shop.example.com/order-status?o=ord_123&t=…"
673
+ }
674
+ ],
675
+ "defaultBody": [
676
+ {
677
+ "block": "text",
678
+ "text": "Your order is on its way",
679
+ "variant": "heading"
680
+ },
681
+ {
682
+ "block": "text",
683
+ "text": "{{host.businessName}} is out delivering order {{order.number}}. Your window: {{delivery.window}}.",
684
+ "variant": "body"
685
+ },
686
+ {
687
+ "block": "text",
688
+ "text": "{{order.summary}}",
689
+ "variant": "body"
690
+ },
691
+ {
692
+ "block": "button",
693
+ "label": "View your order",
694
+ "href": "{{order.statusUrl}}"
695
+ }
696
+ ],
697
+ "footerReason": "You’re receiving this because you placed an order with {{host.businessName}}."
698
+ },
512
699
  {
513
700
  "key": "sale-notification",
514
701
  "name": "New sale",
@@ -1219,6 +1406,238 @@
1219
1406
  "control": "external",
1220
1407
  "authoredIn": "the workflow that sends it",
1221
1408
  "footerReason": "You’re receiving this because you’re in touch with {{host.businessName}}."
1409
+ },
1410
+ {
1411
+ "key": "loyalty-points-earned",
1412
+ "name": "Rewards points earned",
1413
+ "description": "Tells a customer the points an order earned them, their balance and their rewards code.",
1414
+ "pluginId": "loyalty",
1415
+ "plugin": "Rewards",
1416
+ "control": "besigner",
1417
+ "defaultSubject": "You earned {{loyalty.points}} points",
1418
+ "mergeTokens": [
1419
+ {
1420
+ "name": "name",
1421
+ "description": "The member's name, when the store knows it",
1422
+ "sample": "Alex"
1423
+ },
1424
+ {
1425
+ "name": "loyalty.balance",
1426
+ "description": "Points the member holds now",
1427
+ "sample": "1,250"
1428
+ },
1429
+ {
1430
+ "name": "loyalty.value",
1431
+ "description": "What those points are worth",
1432
+ "sample": "$12.50"
1433
+ },
1434
+ {
1435
+ "name": "loyalty.credit",
1436
+ "description": "Store credit the member holds",
1437
+ "sample": "$10.00"
1438
+ },
1439
+ {
1440
+ "name": "loyalty.code",
1441
+ "description": "The member’s rewards code, to spend their balance",
1442
+ "sample": "RW-7K3P-Q9XZ-2M4D"
1443
+ },
1444
+ {
1445
+ "name": "loyalty.referral",
1446
+ "description": "A sentence with the member’s referral code and what it gives; empty when referrals are off",
1447
+ "sample": "Share your referral code RF-7K3P9X: a friend gets $10.00 off their first order, and you get $10.00 in store credit."
1448
+ },
1449
+ {
1450
+ "name": "loyalty.points",
1451
+ "description": "Points this order earned",
1452
+ "sample": "45"
1453
+ }
1454
+ ],
1455
+ "defaultBody": [
1456
+ {
1457
+ "block": "text",
1458
+ "text": "You earned {{loyalty.points}} points",
1459
+ "variant": "heading"
1460
+ },
1461
+ {
1462
+ "block": "text",
1463
+ "text": "Thanks for your order with {{host.businessName}}.",
1464
+ "variant": "body"
1465
+ },
1466
+ {
1467
+ "block": "text",
1468
+ "text": "You have {{loyalty.balance}} points (worth {{loyalty.value}}) and {{loyalty.credit}} in store credit.",
1469
+ "variant": "body"
1470
+ },
1471
+ {
1472
+ "block": "text",
1473
+ "text": "Your rewards code is {{loyalty.code}}. Enter it at checkout on {{host.url}}, or give it at the register, to spend your balance.",
1474
+ "variant": "body"
1475
+ },
1476
+ {
1477
+ "block": "text",
1478
+ "text": "{{loyalty.referral}}",
1479
+ "variant": "body"
1480
+ },
1481
+ {
1482
+ "block": "button",
1483
+ "label": "Shop {{host.businessName}}",
1484
+ "href": "{{host.url}}"
1485
+ }
1486
+ ],
1487
+ "footerReason": "You’re receiving this because you earned rewards with an order from {{host.businessName}}."
1488
+ },
1489
+ {
1490
+ "key": "loyalty-store-credit",
1491
+ "name": "Store credit given",
1492
+ "description": "Tells a customer the store gave them store credit, with their rewards code to spend it.",
1493
+ "pluginId": "loyalty",
1494
+ "plugin": "Rewards",
1495
+ "control": "besigner",
1496
+ "defaultSubject": "You have {{loyalty.amount}} in store credit",
1497
+ "mergeTokens": [
1498
+ {
1499
+ "name": "name",
1500
+ "description": "The member's name, when the store knows it",
1501
+ "sample": "Alex"
1502
+ },
1503
+ {
1504
+ "name": "loyalty.balance",
1505
+ "description": "Points the member holds now",
1506
+ "sample": "1,250"
1507
+ },
1508
+ {
1509
+ "name": "loyalty.value",
1510
+ "description": "What those points are worth",
1511
+ "sample": "$12.50"
1512
+ },
1513
+ {
1514
+ "name": "loyalty.credit",
1515
+ "description": "Store credit the member holds",
1516
+ "sample": "$10.00"
1517
+ },
1518
+ {
1519
+ "name": "loyalty.code",
1520
+ "description": "The member’s rewards code, to spend their balance",
1521
+ "sample": "RW-7K3P-Q9XZ-2M4D"
1522
+ },
1523
+ {
1524
+ "name": "loyalty.referral",
1525
+ "description": "A sentence with the member’s referral code and what it gives; empty when referrals are off",
1526
+ "sample": "Share your referral code RF-7K3P9X: a friend gets $10.00 off their first order, and you get $10.00 in store credit."
1527
+ },
1528
+ {
1529
+ "name": "loyalty.amount",
1530
+ "description": "The credit given",
1531
+ "sample": "$10.00"
1532
+ },
1533
+ {
1534
+ "name": "loyalty.note",
1535
+ "description": "The note the store wrote; empty when none",
1536
+ "sample": "Sorry about the delay!"
1537
+ }
1538
+ ],
1539
+ "defaultBody": [
1540
+ {
1541
+ "block": "text",
1542
+ "text": "You have {{loyalty.amount}} in store credit",
1543
+ "variant": "heading"
1544
+ },
1545
+ {
1546
+ "block": "text",
1547
+ "text": "{{loyalty.note}}",
1548
+ "variant": "body"
1549
+ },
1550
+ {
1551
+ "block": "text",
1552
+ "text": "You have {{loyalty.balance}} points (worth {{loyalty.value}}) and {{loyalty.credit}} in store credit.",
1553
+ "variant": "body"
1554
+ },
1555
+ {
1556
+ "block": "text",
1557
+ "text": "Your rewards code is {{loyalty.code}}. Enter it at checkout on {{host.url}}, or give it at the register, to spend your balance.",
1558
+ "variant": "body"
1559
+ },
1560
+ {
1561
+ "block": "button",
1562
+ "label": "Shop {{host.businessName}}",
1563
+ "href": "{{host.url}}"
1564
+ }
1565
+ ],
1566
+ "footerReason": "You’re receiving this because {{host.businessName}} gave you store credit."
1567
+ },
1568
+ {
1569
+ "key": "loyalty-referral-reward",
1570
+ "name": "Referral reward",
1571
+ "description": "Tells a customer a friend’s first order earned them store credit.",
1572
+ "pluginId": "loyalty",
1573
+ "plugin": "Rewards",
1574
+ "control": "besigner",
1575
+ "defaultSubject": "A friend’s first order earned you {{loyalty.amount}}",
1576
+ "mergeTokens": [
1577
+ {
1578
+ "name": "name",
1579
+ "description": "The member's name, when the store knows it",
1580
+ "sample": "Alex"
1581
+ },
1582
+ {
1583
+ "name": "loyalty.balance",
1584
+ "description": "Points the member holds now",
1585
+ "sample": "1,250"
1586
+ },
1587
+ {
1588
+ "name": "loyalty.value",
1589
+ "description": "What those points are worth",
1590
+ "sample": "$12.50"
1591
+ },
1592
+ {
1593
+ "name": "loyalty.credit",
1594
+ "description": "Store credit the member holds",
1595
+ "sample": "$10.00"
1596
+ },
1597
+ {
1598
+ "name": "loyalty.code",
1599
+ "description": "The member’s rewards code, to spend their balance",
1600
+ "sample": "RW-7K3P-Q9XZ-2M4D"
1601
+ },
1602
+ {
1603
+ "name": "loyalty.referral",
1604
+ "description": "A sentence with the member’s referral code and what it gives; empty when referrals are off",
1605
+ "sample": "Share your referral code RF-7K3P9X: a friend gets $10.00 off their first order, and you get $10.00 in store credit."
1606
+ },
1607
+ {
1608
+ "name": "loyalty.amount",
1609
+ "description": "The reward",
1610
+ "sample": "$10.00"
1611
+ }
1612
+ ],
1613
+ "defaultBody": [
1614
+ {
1615
+ "block": "text",
1616
+ "text": "Your referral paid off",
1617
+ "variant": "heading"
1618
+ },
1619
+ {
1620
+ "block": "text",
1621
+ "text": "A friend used your referral code at {{host.businessName}}, so you have {{loyalty.amount}} more in store credit.",
1622
+ "variant": "body"
1623
+ },
1624
+ {
1625
+ "block": "text",
1626
+ "text": "You have {{loyalty.balance}} points (worth {{loyalty.value}}) and {{loyalty.credit}} in store credit.",
1627
+ "variant": "body"
1628
+ },
1629
+ {
1630
+ "block": "text",
1631
+ "text": "Your rewards code is {{loyalty.code}}. Enter it at checkout on {{host.url}}, or give it at the register, to spend your balance.",
1632
+ "variant": "body"
1633
+ },
1634
+ {
1635
+ "block": "button",
1636
+ "label": "Shop {{host.businessName}}",
1637
+ "href": "{{host.url}}"
1638
+ }
1639
+ ],
1640
+ "footerReason": "You’re receiving this because a friend used your referral code at {{host.businessName}}."
1222
1641
  }
1223
1642
  ];
1224
1643