@happyvertical/smrt-messages 0.55.12 → 0.55.14

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.
Files changed (28) hide show
  1. package/dist/chunks/{AccountCollection-KshNIkPE.js → AccountCollection-DRadKdOz.js} +10 -3
  2. package/dist/chunks/AccountCollection-DRadKdOz.js.map +1 -0
  3. package/dist/chunks/{Email-CEJQKkpN.js → Email-QBNrKVox.js} +20 -4
  4. package/dist/chunks/Email-QBNrKVox.js.map +1 -0
  5. package/dist/chunks/{EmailFolder-BhNYKU2I.js → EmailFolder-B41qCdBD.js} +2 -2
  6. package/dist/chunks/{EmailFolder-BhNYKU2I.js.map → EmailFolder-B41qCdBD.js.map} +1 -1
  7. package/dist/chunks/{Message-BMtbSExY.js → Message-CL1o3ODP.js} +30 -9
  8. package/dist/chunks/Message-CL1o3ODP.js.map +1 -0
  9. package/dist/chunks/{MessageCollection-4sOQ4srR.js → MessageCollection-DCAgQP4A.js} +2 -2
  10. package/dist/chunks/{MessageCollection-4sOQ4srR.js.map → MessageCollection-DCAgQP4A.js.map} +1 -1
  11. package/dist/chunks/__smrt-register__-BeAm6N7x.js +6 -0
  12. package/dist/chunks/__smrt-register__-BeAm6N7x.js.map +1 -0
  13. package/dist/index.js +21 -9
  14. package/dist/index.js.map +1 -1
  15. package/dist/manifest.json +837 -159
  16. package/dist/models/Account.d.ts.map +1 -1
  17. package/dist/models/Email.d.ts.map +1 -1
  18. package/dist/models/EmailAccount.d.ts.map +1 -1
  19. package/dist/models/Message.d.ts.map +1 -1
  20. package/dist/recipes.d.ts +22 -0
  21. package/dist/recipes.d.ts.map +1 -1
  22. package/dist/smrt-knowledge.json +357 -169
  23. package/package.json +15 -15
  24. package/dist/chunks/AccountCollection-KshNIkPE.js.map +0 -1
  25. package/dist/chunks/Email-CEJQKkpN.js.map +0 -1
  26. package/dist/chunks/Message-BMtbSExY.js.map +0 -1
  27. package/dist/chunks/__smrt-register__-BLIm0oQ4.js +0 -6
  28. package/dist/chunks/__smrt-register__-BLIm0oQ4.js.map +0 -1
package/dist/manifest.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "version": "1.0.0",
3
3
  "timestamp": 0,
4
4
  "packageName": "@happyvertical/smrt-messages",
5
- "packageVersion": "0.55.12",
5
+ "packageVersion": "0.55.14",
6
6
  "objects": {
7
7
  "@happyvertical/smrt-messages:AccountCollection": {
8
8
  "name": "accountcollection",
@@ -3747,15 +3747,27 @@
3747
3747
  },
3748
3748
  "name": {
3749
3749
  "type": "text",
3750
- "required": false
3750
+ "required": false,
3751
+ "description": "The display name for this connected messaging account.",
3752
+ "_meta": {
3753
+ "description": "The display name for this connected messaging account."
3754
+ }
3751
3755
  },
3752
3756
  "providerType": {
3753
3757
  "type": "text",
3754
- "required": false
3758
+ "required": false,
3759
+ "description": "The service that connects this account to your application.",
3760
+ "_meta": {
3761
+ "description": "The service that connects this account to your application."
3762
+ }
3755
3763
  },
3756
3764
  "channelType": {
3757
3765
  "type": "text",
3758
- "required": false
3766
+ "required": false,
3767
+ "description": "The kind of messaging this account supports, such as email or chat.",
3768
+ "_meta": {
3769
+ "description": "The kind of messaging this account supports, such as email or chat."
3770
+ }
3759
3771
  },
3760
3772
  "credentialSecretId": {
3761
3773
  "type": "text",
@@ -3770,11 +3782,19 @@
3770
3782
  "isActive": {
3771
3783
  "type": "boolean",
3772
3784
  "required": true,
3773
- "default": true
3785
+ "default": true,
3786
+ "description": "Whether this account is enabled for messaging.",
3787
+ "_meta": {
3788
+ "description": "Whether this account is enabled for messaging."
3789
+ }
3774
3790
  },
3775
3791
  "lastSyncAt": {
3776
3792
  "type": "datetime",
3777
- "required": false
3793
+ "required": false,
3794
+ "description": "When this account last checked for new messages.",
3795
+ "_meta": {
3796
+ "description": "When this account last checked for new messages."
3797
+ }
3778
3798
  },
3779
3799
  "settings": {
3780
3800
  "type": "text",
@@ -3788,15 +3808,27 @@
3788
3808
  },
3789
3809
  "configuration": {
3790
3810
  "type": "text",
3791
- "required": false
3811
+ "required": false,
3812
+ "description": "The public connection settings for this account; credentials are stored separately.",
3813
+ "_meta": {
3814
+ "description": "The public connection settings for this account; credentials are stored separately."
3815
+ }
3792
3816
  },
3793
3817
  "createdAt": {
3794
3818
  "type": "text",
3795
- "required": false
3819
+ "required": false,
3820
+ "description": "When this account was added.",
3821
+ "_meta": {
3822
+ "description": "When this account was added."
3823
+ }
3796
3824
  },
3797
3825
  "updatedAt": {
3798
3826
  "type": "text",
3799
- "required": false
3827
+ "required": false,
3828
+ "description": "When this account was last changed.",
3829
+ "_meta": {
3830
+ "description": "When this account was last changed."
3831
+ }
3800
3832
  }
3801
3833
  },
3802
3834
  "methods": {
@@ -4570,81 +4602,147 @@
4570
4602
  "accountId": {
4571
4603
  "type": "foreignKey",
4572
4604
  "required": false,
4573
- "related": "Account"
4605
+ "related": "Account",
4606
+ "description": "The connected account used to receive or send this message.",
4607
+ "_meta": {
4608
+ "description": "The connected account used to receive or send this message."
4609
+ }
4574
4610
  },
4575
4611
  "personaId": {
4576
4612
  "type": "crossPackageRef",
4577
4613
  "required": false,
4578
4614
  "related": "@happyvertical/smrt-personas:AgentPersona",
4615
+ "description": "The assistant identity associated with this message, when one was used.",
4579
4616
  "_meta": {
4617
+ "description": "The assistant identity associated with this message, when one was used.",
4580
4618
  "nullable": true
4581
4619
  }
4582
4620
  },
4583
4621
  "endpointId": {
4584
4622
  "type": "foreignKey",
4585
4623
  "required": false,
4586
- "related": "MessagingEndpoint"
4624
+ "related": "MessagingEndpoint",
4625
+ "description": "The saved destination used to deliver this message.",
4626
+ "_meta": {
4627
+ "description": "The saved destination used to deliver this message."
4628
+ }
4587
4629
  },
4588
4630
  "correlationId": {
4589
4631
  "type": "text",
4590
- "required": false
4632
+ "required": false,
4633
+ "description": "A tracking reference that connects this message to related activity.",
4634
+ "_meta": {
4635
+ "description": "A tracking reference that connects this message to related activity."
4636
+ }
4591
4637
  },
4592
4638
  "threadId": {
4593
4639
  "type": "text",
4594
- "required": false
4640
+ "required": false,
4641
+ "description": "The conversation this message belongs to.",
4642
+ "_meta": {
4643
+ "description": "The conversation this message belongs to."
4644
+ }
4595
4645
  },
4596
4646
  "subject": {
4597
4647
  "type": "text",
4598
- "required": false
4648
+ "required": false,
4649
+ "description": "The subject shown in the message list.",
4650
+ "_meta": {
4651
+ "description": "The subject shown in the message list."
4652
+ }
4599
4653
  },
4600
4654
  "body": {
4601
4655
  "type": "text",
4602
- "required": false
4656
+ "required": false,
4657
+ "description": "The message content in plain text.",
4658
+ "_meta": {
4659
+ "description": "The message content in plain text."
4660
+ }
4603
4661
  },
4604
4662
  "fromAddress": {
4605
4663
  "type": "text",
4606
- "required": false
4664
+ "required": false,
4665
+ "description": "The address the message was sent from.",
4666
+ "_meta": {
4667
+ "description": "The address the message was sent from."
4668
+ }
4607
4669
  },
4608
4670
  "fromName": {
4609
4671
  "type": "text",
4610
- "required": false
4672
+ "required": false,
4673
+ "description": "The sender name shown beside their address.",
4674
+ "_meta": {
4675
+ "description": "The sender name shown beside their address."
4676
+ }
4611
4677
  },
4612
4678
  "toAddresses": {
4613
4679
  "type": "text",
4614
- "required": false
4680
+ "required": false,
4681
+ "description": "The people or addresses receiving this message.",
4682
+ "_meta": {
4683
+ "description": "The people or addresses receiving this message."
4684
+ }
4615
4685
  },
4616
4686
  "date": {
4617
4687
  "type": "datetime",
4618
- "required": false
4688
+ "required": false,
4689
+ "description": "When the message was sent or received.",
4690
+ "_meta": {
4691
+ "description": "When the message was sent or received."
4692
+ }
4619
4693
  },
4620
4694
  "isRead": {
4621
4695
  "type": "boolean",
4622
4696
  "required": true,
4623
- "default": false
4697
+ "default": false,
4698
+ "description": "Whether this message has been marked as read.",
4699
+ "_meta": {
4700
+ "description": "Whether this message has been marked as read."
4701
+ }
4624
4702
  },
4625
4703
  "isFlagged": {
4626
4704
  "type": "boolean",
4627
4705
  "required": true,
4628
- "default": false
4706
+ "default": false,
4707
+ "description": "Whether this message is flagged for follow-up.",
4708
+ "_meta": {
4709
+ "description": "Whether this message is flagged for follow-up."
4710
+ }
4629
4711
  },
4630
4712
  "hasAttachments": {
4631
4713
  "type": "boolean",
4632
4714
  "required": true,
4633
- "default": false
4715
+ "default": false,
4716
+ "description": "Whether files are attached to this message.",
4717
+ "_meta": {
4718
+ "description": "Whether files are attached to this message."
4719
+ }
4634
4720
  },
4635
4721
  "size": {
4636
4722
  "type": "integer",
4637
4723
  "required": true,
4638
- "default": 0
4724
+ "default": 0,
4725
+ "description": "The size of the message in bytes.",
4726
+ "_meta": {
4727
+ "description": "The size of the message in bytes."
4728
+ }
4639
4729
  },
4640
4730
  "metadata": {
4641
4731
  "type": "text",
4642
- "required": false
4732
+ "required": false,
4733
+ "description": "Additional details supplied by the messaging connection.",
4734
+ "_meta": {
4735
+ "description": "Additional details supplied by the messaging connection."
4736
+ }
4643
4737
  },
4644
4738
  "sendStatus": {
4645
4739
  "type": "text",
4646
4740
  "required": false,
4647
4741
  "default": "draft",
4742
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here.",
4743
+ "_meta": {
4744
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here."
4745
+ },
4648
4746
  "enum": [
4649
4747
  "draft",
4650
4748
  "pending",
@@ -4656,104 +4754,200 @@
4656
4754
  },
4657
4755
  "sentAt": {
4658
4756
  "type": "datetime",
4659
- "required": false
4757
+ "required": false,
4758
+ "description": "When the message was successfully sent.",
4759
+ "_meta": {
4760
+ "description": "When the message was successfully sent."
4761
+ }
4660
4762
  },
4661
4763
  "sendError": {
4662
4764
  "type": "text",
4663
- "required": false
4765
+ "required": false,
4766
+ "description": "The reason the latest send attempt failed.",
4767
+ "_meta": {
4768
+ "description": "The reason the latest send attempt failed."
4769
+ }
4664
4770
  },
4665
4771
  "retryCount": {
4666
4772
  "type": "integer",
4667
4773
  "required": true,
4668
- "default": 0
4774
+ "default": 0,
4775
+ "description": "How many times delivery has been retried.",
4776
+ "_meta": {
4777
+ "description": "How many times delivery has been retried."
4778
+ }
4669
4779
  },
4670
4780
  "maxRetries": {
4671
4781
  "type": "integer",
4672
4782
  "required": true,
4673
- "default": 3
4783
+ "default": 3,
4784
+ "description": "The maximum number of delivery retries allowed.",
4785
+ "_meta": {
4786
+ "description": "The maximum number of delivery retries allowed."
4787
+ }
4674
4788
  },
4675
4789
  "scheduledSendAt": {
4676
4790
  "type": "datetime",
4677
- "required": false
4791
+ "required": false,
4792
+ "description": "When this message is scheduled to be sent.",
4793
+ "_meta": {
4794
+ "description": "When this message is scheduled to be sent."
4795
+ }
4678
4796
  },
4679
4797
  "inReplyToMessageId": {
4680
4798
  "type": "foreignKey",
4681
4799
  "required": false,
4682
- "related": "Message"
4800
+ "related": "Message",
4801
+ "description": "The earlier message this one replies to.",
4802
+ "_meta": {
4803
+ "description": "The earlier message this one replies to."
4804
+ }
4683
4805
  },
4684
4806
  "createdAt": {
4685
4807
  "type": "text",
4686
- "required": false
4808
+ "required": false,
4809
+ "description": "When this message was recorded.",
4810
+ "_meta": {
4811
+ "description": "When this message was recorded."
4812
+ }
4687
4813
  },
4688
4814
  "updatedAt": {
4689
4815
  "type": "text",
4690
- "required": false
4816
+ "required": false,
4817
+ "description": "When this message was last changed.",
4818
+ "_meta": {
4819
+ "description": "When this message was last changed."
4820
+ }
4691
4821
  },
4692
4822
  "messageId": {
4693
4823
  "type": "text",
4694
- "required": false
4824
+ "required": false,
4825
+ "description": "The email reference assigned by the sender for tracking replies.",
4826
+ "_meta": {
4827
+ "description": "The email reference assigned by the sender for tracking replies."
4828
+ }
4695
4829
  },
4696
4830
  "inReplyTo": {
4697
4831
  "type": "text",
4698
- "required": false
4832
+ "required": false,
4833
+ "description": "The sender-assigned reference of the email being replied to.",
4834
+ "_meta": {
4835
+ "description": "The sender-assigned reference of the email being replied to."
4836
+ }
4699
4837
  },
4700
4838
  "ccAddresses": {
4701
4839
  "type": "text",
4702
- "required": false
4840
+ "required": false,
4841
+ "description": "Recipients receiving a visible copy of this email.",
4842
+ "_meta": {
4843
+ "description": "Recipients receiving a visible copy of this email."
4844
+ }
4703
4845
  },
4704
4846
  "bccAddresses": {
4705
4847
  "type": "text",
4706
- "required": false
4848
+ "required": false,
4849
+ "description": "Recipients receiving a copy without appearing in the visible recipient list.",
4850
+ "_meta": {
4851
+ "description": "Recipients receiving a copy without appearing in the visible recipient list."
4852
+ }
4707
4853
  },
4708
4854
  "replyToAddress": {
4709
4855
  "type": "text",
4710
- "required": false
4856
+ "required": false,
4857
+ "description": "The address replies should be sent to.",
4858
+ "_meta": {
4859
+ "description": "The address replies should be sent to."
4860
+ }
4711
4861
  },
4712
4862
  "replyToName": {
4713
4863
  "type": "text",
4714
- "required": false
4864
+ "required": false,
4865
+ "description": "The name associated with the reply address.",
4866
+ "_meta": {
4867
+ "description": "The name associated with the reply address."
4868
+ }
4715
4869
  },
4716
4870
  "textBody": {
4717
4871
  "type": "text",
4718
- "required": false
4872
+ "required": false,
4873
+ "description": "The plain-text version of the email.",
4874
+ "_meta": {
4875
+ "description": "The plain-text version of the email."
4876
+ }
4719
4877
  },
4720
4878
  "htmlBody": {
4721
4879
  "type": "text",
4722
- "required": false
4880
+ "required": false,
4881
+ "description": "The formatted version of the email.",
4882
+ "_meta": {
4883
+ "description": "The formatted version of the email."
4884
+ }
4723
4885
  },
4724
4886
  "folderId": {
4725
4887
  "type": "text",
4726
- "required": false
4888
+ "required": false,
4889
+ "description": "The mailbox folder reference supplied by the email connection.",
4890
+ "_meta": {
4891
+ "description": "The mailbox folder reference supplied by the email connection."
4892
+ }
4727
4893
  },
4728
4894
  "folderPath": {
4729
4895
  "type": "text",
4730
- "required": false
4896
+ "required": false,
4897
+ "description": "The location of this email within the mailbox folders.",
4898
+ "_meta": {
4899
+ "description": "The location of this email within the mailbox folders."
4900
+ }
4731
4901
  },
4732
4902
  "labels": {
4733
4903
  "type": "text",
4734
- "required": false
4904
+ "required": false,
4905
+ "description": "Labels applied to this email by the mailbox provider.",
4906
+ "_meta": {
4907
+ "description": "Labels applied to this email by the mailbox provider."
4908
+ }
4735
4909
  },
4736
4910
  "flags": {
4737
4911
  "type": "text",
4738
- "required": false
4912
+ "required": false,
4913
+ "description": "Mailbox markers such as read, answered, or flagged.",
4914
+ "_meta": {
4915
+ "description": "Mailbox markers such as read, answered, or flagged."
4916
+ }
4739
4917
  },
4740
4918
  "isAnswered": {
4741
4919
  "type": "boolean",
4742
4920
  "required": true,
4743
- "default": false
4921
+ "default": false,
4922
+ "description": "Whether this email has been replied to.",
4923
+ "_meta": {
4924
+ "description": "Whether this email has been replied to."
4925
+ }
4744
4926
  },
4745
4927
  "isDraft": {
4746
4928
  "type": "boolean",
4747
4929
  "required": true,
4748
- "default": false
4930
+ "default": false,
4931
+ "description": "Whether this email is saved as an unfinished draft.",
4932
+ "_meta": {
4933
+ "description": "Whether this email is saved as an unfinished draft."
4934
+ }
4749
4935
  },
4750
4936
  "rawMessage": {
4751
4937
  "type": "text",
4752
- "required": false
4938
+ "required": false,
4939
+ "description": "The original email content as received from the mail server.",
4940
+ "_meta": {
4941
+ "description": "The original email content as received from the mail server."
4942
+ }
4753
4943
  },
4754
4944
  "headers": {
4755
4945
  "type": "text",
4756
- "required": false
4946
+ "required": false,
4947
+ "description": "Delivery and routing details included with the email.",
4948
+ "_meta": {
4949
+ "description": "Delivery and routing details included with the email."
4950
+ }
4757
4951
  }
4758
4952
  },
4759
4953
  "methods": {
@@ -5500,15 +5694,27 @@
5500
5694
  },
5501
5695
  "name": {
5502
5696
  "type": "text",
5503
- "required": false
5697
+ "required": false,
5698
+ "description": "The display name for this connected messaging account.",
5699
+ "_meta": {
5700
+ "description": "The display name for this connected messaging account."
5701
+ }
5504
5702
  },
5505
5703
  "providerType": {
5506
5704
  "type": "text",
5507
- "required": false
5705
+ "required": false,
5706
+ "description": "The service that connects this account to your application.",
5707
+ "_meta": {
5708
+ "description": "The service that connects this account to your application."
5709
+ }
5508
5710
  },
5509
5711
  "channelType": {
5510
5712
  "type": "text",
5511
- "required": false
5713
+ "required": false,
5714
+ "description": "The kind of messaging this account supports, such as email or chat.",
5715
+ "_meta": {
5716
+ "description": "The kind of messaging this account supports, such as email or chat."
5717
+ }
5512
5718
  },
5513
5719
  "credentialSecretId": {
5514
5720
  "type": "text",
@@ -5523,11 +5729,19 @@
5523
5729
  "isActive": {
5524
5730
  "type": "boolean",
5525
5731
  "required": true,
5526
- "default": true
5732
+ "default": true,
5733
+ "description": "Whether this account is enabled for messaging.",
5734
+ "_meta": {
5735
+ "description": "Whether this account is enabled for messaging."
5736
+ }
5527
5737
  },
5528
5738
  "lastSyncAt": {
5529
5739
  "type": "datetime",
5530
- "required": false
5740
+ "required": false,
5741
+ "description": "When this account last checked for new messages.",
5742
+ "_meta": {
5743
+ "description": "When this account last checked for new messages."
5744
+ }
5531
5745
  },
5532
5746
  "settings": {
5533
5747
  "type": "text",
@@ -5541,24 +5755,44 @@
5541
5755
  },
5542
5756
  "configuration": {
5543
5757
  "type": "text",
5544
- "required": false
5758
+ "required": false,
5759
+ "description": "The public connection settings for this account; credentials are stored separately.",
5760
+ "_meta": {
5761
+ "description": "The public connection settings for this account; credentials are stored separately."
5762
+ }
5545
5763
  },
5546
5764
  "createdAt": {
5547
5765
  "type": "text",
5548
- "required": false
5766
+ "required": false,
5767
+ "description": "When this account was added.",
5768
+ "_meta": {
5769
+ "description": "When this account was added."
5770
+ }
5549
5771
  },
5550
5772
  "updatedAt": {
5551
5773
  "type": "text",
5552
- "required": false
5774
+ "required": false,
5775
+ "description": "When this account was last changed.",
5776
+ "_meta": {
5777
+ "description": "When this account was last changed."
5778
+ }
5553
5779
  },
5554
5780
  "email": {
5555
5781
  "type": "text",
5556
- "required": false
5782
+ "required": false,
5783
+ "description": "The email address associated with this mailbox.",
5784
+ "_meta": {
5785
+ "description": "The email address associated with this mailbox."
5786
+ }
5557
5787
  },
5558
5788
  "syncIntervalMinutes": {
5559
5789
  "type": "integer",
5560
5790
  "required": true,
5561
- "default": 60
5791
+ "default": 60,
5792
+ "description": "The time in minutes between scheduled mailbox checks.",
5793
+ "_meta": {
5794
+ "description": "The time in minutes between scheduled mailbox checks."
5795
+ }
5562
5796
  }
5563
5797
  },
5564
5798
  "methods": {
@@ -6454,81 +6688,147 @@
6454
6688
  "accountId": {
6455
6689
  "type": "foreignKey",
6456
6690
  "required": false,
6457
- "related": "Account"
6691
+ "related": "Account",
6692
+ "description": "The connected account used to receive or send this message.",
6693
+ "_meta": {
6694
+ "description": "The connected account used to receive or send this message."
6695
+ }
6458
6696
  },
6459
6697
  "personaId": {
6460
6698
  "type": "crossPackageRef",
6461
6699
  "required": false,
6462
6700
  "related": "@happyvertical/smrt-personas:AgentPersona",
6701
+ "description": "The assistant identity associated with this message, when one was used.",
6463
6702
  "_meta": {
6703
+ "description": "The assistant identity associated with this message, when one was used.",
6464
6704
  "nullable": true
6465
6705
  }
6466
6706
  },
6467
6707
  "endpointId": {
6468
6708
  "type": "foreignKey",
6469
6709
  "required": false,
6470
- "related": "MessagingEndpoint"
6710
+ "related": "MessagingEndpoint",
6711
+ "description": "The saved destination used to deliver this message.",
6712
+ "_meta": {
6713
+ "description": "The saved destination used to deliver this message."
6714
+ }
6471
6715
  },
6472
6716
  "correlationId": {
6473
6717
  "type": "text",
6474
- "required": false
6718
+ "required": false,
6719
+ "description": "A tracking reference that connects this message to related activity.",
6720
+ "_meta": {
6721
+ "description": "A tracking reference that connects this message to related activity."
6722
+ }
6475
6723
  },
6476
6724
  "threadId": {
6477
6725
  "type": "text",
6478
- "required": false
6726
+ "required": false,
6727
+ "description": "The conversation this message belongs to.",
6728
+ "_meta": {
6729
+ "description": "The conversation this message belongs to."
6730
+ }
6479
6731
  },
6480
6732
  "subject": {
6481
6733
  "type": "text",
6482
- "required": false
6734
+ "required": false,
6735
+ "description": "The subject shown in the message list.",
6736
+ "_meta": {
6737
+ "description": "The subject shown in the message list."
6738
+ }
6483
6739
  },
6484
6740
  "body": {
6485
6741
  "type": "text",
6486
- "required": false
6742
+ "required": false,
6743
+ "description": "The message content in plain text.",
6744
+ "_meta": {
6745
+ "description": "The message content in plain text."
6746
+ }
6487
6747
  },
6488
6748
  "fromAddress": {
6489
6749
  "type": "text",
6490
- "required": false
6750
+ "required": false,
6751
+ "description": "The address the message was sent from.",
6752
+ "_meta": {
6753
+ "description": "The address the message was sent from."
6754
+ }
6491
6755
  },
6492
6756
  "fromName": {
6493
6757
  "type": "text",
6494
- "required": false
6758
+ "required": false,
6759
+ "description": "The sender name shown beside their address.",
6760
+ "_meta": {
6761
+ "description": "The sender name shown beside their address."
6762
+ }
6495
6763
  },
6496
6764
  "toAddresses": {
6497
6765
  "type": "text",
6498
- "required": false
6766
+ "required": false,
6767
+ "description": "The people or addresses receiving this message.",
6768
+ "_meta": {
6769
+ "description": "The people or addresses receiving this message."
6770
+ }
6499
6771
  },
6500
6772
  "date": {
6501
6773
  "type": "datetime",
6502
- "required": false
6774
+ "required": false,
6775
+ "description": "When the message was sent or received.",
6776
+ "_meta": {
6777
+ "description": "When the message was sent or received."
6778
+ }
6503
6779
  },
6504
6780
  "isRead": {
6505
6781
  "type": "boolean",
6506
6782
  "required": true,
6507
- "default": false
6783
+ "default": false,
6784
+ "description": "Whether this message has been marked as read.",
6785
+ "_meta": {
6786
+ "description": "Whether this message has been marked as read."
6787
+ }
6508
6788
  },
6509
6789
  "isFlagged": {
6510
6790
  "type": "boolean",
6511
6791
  "required": true,
6512
- "default": false
6792
+ "default": false,
6793
+ "description": "Whether this message is flagged for follow-up.",
6794
+ "_meta": {
6795
+ "description": "Whether this message is flagged for follow-up."
6796
+ }
6513
6797
  },
6514
6798
  "hasAttachments": {
6515
6799
  "type": "boolean",
6516
6800
  "required": true,
6517
- "default": false
6801
+ "default": false,
6802
+ "description": "Whether files are attached to this message.",
6803
+ "_meta": {
6804
+ "description": "Whether files are attached to this message."
6805
+ }
6518
6806
  },
6519
6807
  "size": {
6520
6808
  "type": "integer",
6521
6809
  "required": true,
6522
- "default": 0
6810
+ "default": 0,
6811
+ "description": "The size of the message in bytes.",
6812
+ "_meta": {
6813
+ "description": "The size of the message in bytes."
6814
+ }
6523
6815
  },
6524
6816
  "metadata": {
6525
6817
  "type": "text",
6526
- "required": false
6818
+ "required": false,
6819
+ "description": "Additional details supplied by the messaging connection.",
6820
+ "_meta": {
6821
+ "description": "Additional details supplied by the messaging connection."
6822
+ }
6527
6823
  },
6528
6824
  "sendStatus": {
6529
6825
  "type": "text",
6530
6826
  "required": false,
6531
6827
  "default": "draft",
6828
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here.",
6829
+ "_meta": {
6830
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here."
6831
+ },
6532
6832
  "enum": [
6533
6833
  "draft",
6534
6834
  "pending",
@@ -6540,38 +6840,70 @@
6540
6840
  },
6541
6841
  "sentAt": {
6542
6842
  "type": "datetime",
6543
- "required": false
6843
+ "required": false,
6844
+ "description": "When the message was successfully sent.",
6845
+ "_meta": {
6846
+ "description": "When the message was successfully sent."
6847
+ }
6544
6848
  },
6545
6849
  "sendError": {
6546
6850
  "type": "text",
6547
- "required": false
6851
+ "required": false,
6852
+ "description": "The reason the latest send attempt failed.",
6853
+ "_meta": {
6854
+ "description": "The reason the latest send attempt failed."
6855
+ }
6548
6856
  },
6549
6857
  "retryCount": {
6550
6858
  "type": "integer",
6551
6859
  "required": true,
6552
- "default": 0
6860
+ "default": 0,
6861
+ "description": "How many times delivery has been retried.",
6862
+ "_meta": {
6863
+ "description": "How many times delivery has been retried."
6864
+ }
6553
6865
  },
6554
6866
  "maxRetries": {
6555
6867
  "type": "integer",
6556
6868
  "required": true,
6557
- "default": 3
6869
+ "default": 3,
6870
+ "description": "The maximum number of delivery retries allowed.",
6871
+ "_meta": {
6872
+ "description": "The maximum number of delivery retries allowed."
6873
+ }
6558
6874
  },
6559
6875
  "scheduledSendAt": {
6560
6876
  "type": "datetime",
6561
- "required": false
6877
+ "required": false,
6878
+ "description": "When this message is scheduled to be sent.",
6879
+ "_meta": {
6880
+ "description": "When this message is scheduled to be sent."
6881
+ }
6562
6882
  },
6563
6883
  "inReplyToMessageId": {
6564
6884
  "type": "foreignKey",
6565
6885
  "required": false,
6566
- "related": "Message"
6886
+ "related": "Message",
6887
+ "description": "The earlier message this one replies to.",
6888
+ "_meta": {
6889
+ "description": "The earlier message this one replies to."
6890
+ }
6567
6891
  },
6568
6892
  "createdAt": {
6569
6893
  "type": "text",
6570
- "required": false
6894
+ "required": false,
6895
+ "description": "When this message was recorded.",
6896
+ "_meta": {
6897
+ "description": "When this message was recorded."
6898
+ }
6571
6899
  },
6572
6900
  "updatedAt": {
6573
6901
  "type": "text",
6574
- "required": false
6902
+ "required": false,
6903
+ "description": "When this message was last changed.",
6904
+ "_meta": {
6905
+ "description": "When this message was last changed."
6906
+ }
6575
6907
  }
6576
6908
  },
6577
6909
  "methods": {
@@ -7744,15 +8076,27 @@
7744
8076
  },
7745
8077
  "name": {
7746
8078
  "type": "text",
7747
- "required": false
8079
+ "required": false,
8080
+ "description": "The display name for this connected messaging account.",
8081
+ "_meta": {
8082
+ "description": "The display name for this connected messaging account."
8083
+ }
7748
8084
  },
7749
8085
  "providerType": {
7750
8086
  "type": "text",
7751
- "required": false
8087
+ "required": false,
8088
+ "description": "The service that connects this account to your application.",
8089
+ "_meta": {
8090
+ "description": "The service that connects this account to your application."
8091
+ }
7752
8092
  },
7753
8093
  "channelType": {
7754
8094
  "type": "text",
7755
- "required": false
8095
+ "required": false,
8096
+ "description": "The kind of messaging this account supports, such as email or chat.",
8097
+ "_meta": {
8098
+ "description": "The kind of messaging this account supports, such as email or chat."
8099
+ }
7756
8100
  },
7757
8101
  "credentialSecretId": {
7758
8102
  "type": "text",
@@ -7767,11 +8111,19 @@
7767
8111
  "isActive": {
7768
8112
  "type": "boolean",
7769
8113
  "required": true,
7770
- "default": true
8114
+ "default": true,
8115
+ "description": "Whether this account is enabled for messaging.",
8116
+ "_meta": {
8117
+ "description": "Whether this account is enabled for messaging."
8118
+ }
7771
8119
  },
7772
8120
  "lastSyncAt": {
7773
8121
  "type": "datetime",
7774
- "required": false
8122
+ "required": false,
8123
+ "description": "When this account last checked for new messages.",
8124
+ "_meta": {
8125
+ "description": "When this account last checked for new messages."
8126
+ }
7775
8127
  },
7776
8128
  "settings": {
7777
8129
  "type": "text",
@@ -7785,15 +8137,27 @@
7785
8137
  },
7786
8138
  "configuration": {
7787
8139
  "type": "text",
7788
- "required": false
8140
+ "required": false,
8141
+ "description": "The public connection settings for this account; credentials are stored separately.",
8142
+ "_meta": {
8143
+ "description": "The public connection settings for this account; credentials are stored separately."
8144
+ }
7789
8145
  },
7790
8146
  "createdAt": {
7791
8147
  "type": "text",
7792
- "required": false
8148
+ "required": false,
8149
+ "description": "When this account was added.",
8150
+ "_meta": {
8151
+ "description": "When this account was added."
8152
+ }
7793
8153
  },
7794
8154
  "updatedAt": {
7795
8155
  "type": "text",
7796
- "required": false
8156
+ "required": false,
8157
+ "description": "When this account was last changed.",
8158
+ "_meta": {
8159
+ "description": "When this account was last changed."
8160
+ }
7797
8161
  },
7798
8162
  "workspaceId": {
7799
8163
  "type": "text",
@@ -8110,81 +8474,147 @@
8110
8474
  "accountId": {
8111
8475
  "type": "foreignKey",
8112
8476
  "required": false,
8113
- "related": "Account"
8477
+ "related": "Account",
8478
+ "description": "The connected account used to receive or send this message.",
8479
+ "_meta": {
8480
+ "description": "The connected account used to receive or send this message."
8481
+ }
8114
8482
  },
8115
8483
  "personaId": {
8116
8484
  "type": "crossPackageRef",
8117
8485
  "required": false,
8118
8486
  "related": "@happyvertical/smrt-personas:AgentPersona",
8487
+ "description": "The assistant identity associated with this message, when one was used.",
8119
8488
  "_meta": {
8489
+ "description": "The assistant identity associated with this message, when one was used.",
8120
8490
  "nullable": true
8121
8491
  }
8122
8492
  },
8123
8493
  "endpointId": {
8124
8494
  "type": "foreignKey",
8125
8495
  "required": false,
8126
- "related": "MessagingEndpoint"
8496
+ "related": "MessagingEndpoint",
8497
+ "description": "The saved destination used to deliver this message.",
8498
+ "_meta": {
8499
+ "description": "The saved destination used to deliver this message."
8500
+ }
8127
8501
  },
8128
8502
  "correlationId": {
8129
8503
  "type": "text",
8130
- "required": false
8504
+ "required": false,
8505
+ "description": "A tracking reference that connects this message to related activity.",
8506
+ "_meta": {
8507
+ "description": "A tracking reference that connects this message to related activity."
8508
+ }
8131
8509
  },
8132
8510
  "threadId": {
8133
8511
  "type": "text",
8134
- "required": false
8512
+ "required": false,
8513
+ "description": "The conversation this message belongs to.",
8514
+ "_meta": {
8515
+ "description": "The conversation this message belongs to."
8516
+ }
8135
8517
  },
8136
8518
  "subject": {
8137
8519
  "type": "text",
8138
- "required": false
8520
+ "required": false,
8521
+ "description": "The subject shown in the message list.",
8522
+ "_meta": {
8523
+ "description": "The subject shown in the message list."
8524
+ }
8139
8525
  },
8140
8526
  "body": {
8141
8527
  "type": "text",
8142
- "required": false
8528
+ "required": false,
8529
+ "description": "The message content in plain text.",
8530
+ "_meta": {
8531
+ "description": "The message content in plain text."
8532
+ }
8143
8533
  },
8144
8534
  "fromAddress": {
8145
8535
  "type": "text",
8146
- "required": false
8536
+ "required": false,
8537
+ "description": "The address the message was sent from.",
8538
+ "_meta": {
8539
+ "description": "The address the message was sent from."
8540
+ }
8147
8541
  },
8148
8542
  "fromName": {
8149
8543
  "type": "text",
8150
- "required": false
8544
+ "required": false,
8545
+ "description": "The sender name shown beside their address.",
8546
+ "_meta": {
8547
+ "description": "The sender name shown beside their address."
8548
+ }
8151
8549
  },
8152
8550
  "toAddresses": {
8153
8551
  "type": "text",
8154
- "required": false
8552
+ "required": false,
8553
+ "description": "The people or addresses receiving this message.",
8554
+ "_meta": {
8555
+ "description": "The people or addresses receiving this message."
8556
+ }
8155
8557
  },
8156
8558
  "date": {
8157
8559
  "type": "datetime",
8158
- "required": false
8560
+ "required": false,
8561
+ "description": "When the message was sent or received.",
8562
+ "_meta": {
8563
+ "description": "When the message was sent or received."
8564
+ }
8159
8565
  },
8160
8566
  "isRead": {
8161
8567
  "type": "boolean",
8162
8568
  "required": true,
8163
- "default": false
8569
+ "default": false,
8570
+ "description": "Whether this message has been marked as read.",
8571
+ "_meta": {
8572
+ "description": "Whether this message has been marked as read."
8573
+ }
8164
8574
  },
8165
8575
  "isFlagged": {
8166
8576
  "type": "boolean",
8167
8577
  "required": true,
8168
- "default": false
8578
+ "default": false,
8579
+ "description": "Whether this message is flagged for follow-up.",
8580
+ "_meta": {
8581
+ "description": "Whether this message is flagged for follow-up."
8582
+ }
8169
8583
  },
8170
8584
  "hasAttachments": {
8171
8585
  "type": "boolean",
8172
8586
  "required": true,
8173
- "default": false
8587
+ "default": false,
8588
+ "description": "Whether files are attached to this message.",
8589
+ "_meta": {
8590
+ "description": "Whether files are attached to this message."
8591
+ }
8174
8592
  },
8175
8593
  "size": {
8176
8594
  "type": "integer",
8177
8595
  "required": true,
8178
- "default": 0
8596
+ "default": 0,
8597
+ "description": "The size of the message in bytes.",
8598
+ "_meta": {
8599
+ "description": "The size of the message in bytes."
8600
+ }
8179
8601
  },
8180
8602
  "metadata": {
8181
8603
  "type": "text",
8182
- "required": false
8604
+ "required": false,
8605
+ "description": "Additional details supplied by the messaging connection.",
8606
+ "_meta": {
8607
+ "description": "Additional details supplied by the messaging connection."
8608
+ }
8183
8609
  },
8184
8610
  "sendStatus": {
8185
8611
  "type": "text",
8186
8612
  "required": false,
8187
8613
  "default": "draft",
8614
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here.",
8615
+ "_meta": {
8616
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here."
8617
+ },
8188
8618
  "enum": [
8189
8619
  "draft",
8190
8620
  "pending",
@@ -8196,38 +8626,70 @@
8196
8626
  },
8197
8627
  "sentAt": {
8198
8628
  "type": "datetime",
8199
- "required": false
8629
+ "required": false,
8630
+ "description": "When the message was successfully sent.",
8631
+ "_meta": {
8632
+ "description": "When the message was successfully sent."
8633
+ }
8200
8634
  },
8201
8635
  "sendError": {
8202
8636
  "type": "text",
8203
- "required": false
8637
+ "required": false,
8638
+ "description": "The reason the latest send attempt failed.",
8639
+ "_meta": {
8640
+ "description": "The reason the latest send attempt failed."
8641
+ }
8204
8642
  },
8205
8643
  "retryCount": {
8206
8644
  "type": "integer",
8207
8645
  "required": true,
8208
- "default": 0
8646
+ "default": 0,
8647
+ "description": "How many times delivery has been retried.",
8648
+ "_meta": {
8649
+ "description": "How many times delivery has been retried."
8650
+ }
8209
8651
  },
8210
8652
  "maxRetries": {
8211
8653
  "type": "integer",
8212
8654
  "required": true,
8213
- "default": 3
8655
+ "default": 3,
8656
+ "description": "The maximum number of delivery retries allowed.",
8657
+ "_meta": {
8658
+ "description": "The maximum number of delivery retries allowed."
8659
+ }
8214
8660
  },
8215
8661
  "scheduledSendAt": {
8216
8662
  "type": "datetime",
8217
- "required": false
8663
+ "required": false,
8664
+ "description": "When this message is scheduled to be sent.",
8665
+ "_meta": {
8666
+ "description": "When this message is scheduled to be sent."
8667
+ }
8218
8668
  },
8219
8669
  "inReplyToMessageId": {
8220
8670
  "type": "foreignKey",
8221
8671
  "required": false,
8222
- "related": "Message"
8672
+ "related": "Message",
8673
+ "description": "The earlier message this one replies to.",
8674
+ "_meta": {
8675
+ "description": "The earlier message this one replies to."
8676
+ }
8223
8677
  },
8224
8678
  "createdAt": {
8225
8679
  "type": "text",
8226
- "required": false
8680
+ "required": false,
8681
+ "description": "When this message was recorded.",
8682
+ "_meta": {
8683
+ "description": "When this message was recorded."
8684
+ }
8227
8685
  },
8228
8686
  "updatedAt": {
8229
8687
  "type": "text",
8230
- "required": false
8688
+ "required": false,
8689
+ "description": "When this message was last changed.",
8690
+ "_meta": {
8691
+ "description": "When this message was last changed."
8692
+ }
8231
8693
  },
8232
8694
  "channelId": {
8233
8695
  "type": "text",
@@ -8926,15 +9388,27 @@
8926
9388
  },
8927
9389
  "name": {
8928
9390
  "type": "text",
8929
- "required": false
9391
+ "required": false,
9392
+ "description": "The display name for this connected messaging account.",
9393
+ "_meta": {
9394
+ "description": "The display name for this connected messaging account."
9395
+ }
8930
9396
  },
8931
9397
  "providerType": {
8932
9398
  "type": "text",
8933
- "required": false
9399
+ "required": false,
9400
+ "description": "The service that connects this account to your application.",
9401
+ "_meta": {
9402
+ "description": "The service that connects this account to your application."
9403
+ }
8934
9404
  },
8935
9405
  "channelType": {
8936
9406
  "type": "text",
8937
- "required": false
9407
+ "required": false,
9408
+ "description": "The kind of messaging this account supports, such as email or chat.",
9409
+ "_meta": {
9410
+ "description": "The kind of messaging this account supports, such as email or chat."
9411
+ }
8938
9412
  },
8939
9413
  "credentialSecretId": {
8940
9414
  "type": "text",
@@ -8949,11 +9423,19 @@
8949
9423
  "isActive": {
8950
9424
  "type": "boolean",
8951
9425
  "required": true,
8952
- "default": true
9426
+ "default": true,
9427
+ "description": "Whether this account is enabled for messaging.",
9428
+ "_meta": {
9429
+ "description": "Whether this account is enabled for messaging."
9430
+ }
8953
9431
  },
8954
9432
  "lastSyncAt": {
8955
9433
  "type": "datetime",
8956
- "required": false
9434
+ "required": false,
9435
+ "description": "When this account last checked for new messages.",
9436
+ "_meta": {
9437
+ "description": "When this account last checked for new messages."
9438
+ }
8957
9439
  },
8958
9440
  "settings": {
8959
9441
  "type": "text",
@@ -8967,15 +9449,27 @@
8967
9449
  },
8968
9450
  "configuration": {
8969
9451
  "type": "text",
8970
- "required": false
9452
+ "required": false,
9453
+ "description": "The public connection settings for this account; credentials are stored separately.",
9454
+ "_meta": {
9455
+ "description": "The public connection settings for this account; credentials are stored separately."
9456
+ }
8971
9457
  },
8972
9458
  "createdAt": {
8973
9459
  "type": "text",
8974
- "required": false
9460
+ "required": false,
9461
+ "description": "When this account was added.",
9462
+ "_meta": {
9463
+ "description": "When this account was added."
9464
+ }
8975
9465
  },
8976
9466
  "updatedAt": {
8977
9467
  "type": "text",
8978
- "required": false
9468
+ "required": false,
9469
+ "description": "When this account was last changed.",
9470
+ "_meta": {
9471
+ "description": "When this account was last changed."
9472
+ }
8979
9473
  }
8980
9474
  },
8981
9475
  "methods": {
@@ -9280,81 +9774,147 @@
9280
9774
  "accountId": {
9281
9775
  "type": "foreignKey",
9282
9776
  "required": false,
9283
- "related": "Account"
9777
+ "related": "Account",
9778
+ "description": "The connected account used to receive or send this message.",
9779
+ "_meta": {
9780
+ "description": "The connected account used to receive or send this message."
9781
+ }
9284
9782
  },
9285
9783
  "personaId": {
9286
9784
  "type": "crossPackageRef",
9287
9785
  "required": false,
9288
9786
  "related": "@happyvertical/smrt-personas:AgentPersona",
9787
+ "description": "The assistant identity associated with this message, when one was used.",
9289
9788
  "_meta": {
9789
+ "description": "The assistant identity associated with this message, when one was used.",
9290
9790
  "nullable": true
9291
9791
  }
9292
9792
  },
9293
9793
  "endpointId": {
9294
9794
  "type": "foreignKey",
9295
9795
  "required": false,
9296
- "related": "MessagingEndpoint"
9796
+ "related": "MessagingEndpoint",
9797
+ "description": "The saved destination used to deliver this message.",
9798
+ "_meta": {
9799
+ "description": "The saved destination used to deliver this message."
9800
+ }
9297
9801
  },
9298
9802
  "correlationId": {
9299
9803
  "type": "text",
9300
- "required": false
9804
+ "required": false,
9805
+ "description": "A tracking reference that connects this message to related activity.",
9806
+ "_meta": {
9807
+ "description": "A tracking reference that connects this message to related activity."
9808
+ }
9301
9809
  },
9302
9810
  "threadId": {
9303
9811
  "type": "text",
9304
- "required": false
9812
+ "required": false,
9813
+ "description": "The conversation this message belongs to.",
9814
+ "_meta": {
9815
+ "description": "The conversation this message belongs to."
9816
+ }
9305
9817
  },
9306
9818
  "subject": {
9307
9819
  "type": "text",
9308
- "required": false
9820
+ "required": false,
9821
+ "description": "The subject shown in the message list.",
9822
+ "_meta": {
9823
+ "description": "The subject shown in the message list."
9824
+ }
9309
9825
  },
9310
9826
  "body": {
9311
9827
  "type": "text",
9312
- "required": false
9828
+ "required": false,
9829
+ "description": "The message content in plain text.",
9830
+ "_meta": {
9831
+ "description": "The message content in plain text."
9832
+ }
9313
9833
  },
9314
9834
  "fromAddress": {
9315
9835
  "type": "text",
9316
- "required": false
9836
+ "required": false,
9837
+ "description": "The address the message was sent from.",
9838
+ "_meta": {
9839
+ "description": "The address the message was sent from."
9840
+ }
9317
9841
  },
9318
9842
  "fromName": {
9319
9843
  "type": "text",
9320
- "required": false
9844
+ "required": false,
9845
+ "description": "The sender name shown beside their address.",
9846
+ "_meta": {
9847
+ "description": "The sender name shown beside their address."
9848
+ }
9321
9849
  },
9322
9850
  "toAddresses": {
9323
9851
  "type": "text",
9324
- "required": false
9852
+ "required": false,
9853
+ "description": "The people or addresses receiving this message.",
9854
+ "_meta": {
9855
+ "description": "The people or addresses receiving this message."
9856
+ }
9325
9857
  },
9326
9858
  "date": {
9327
9859
  "type": "datetime",
9328
- "required": false
9860
+ "required": false,
9861
+ "description": "When the message was sent or received.",
9862
+ "_meta": {
9863
+ "description": "When the message was sent or received."
9864
+ }
9329
9865
  },
9330
9866
  "isRead": {
9331
9867
  "type": "boolean",
9332
9868
  "required": true,
9333
- "default": false
9869
+ "default": false,
9870
+ "description": "Whether this message has been marked as read.",
9871
+ "_meta": {
9872
+ "description": "Whether this message has been marked as read."
9873
+ }
9334
9874
  },
9335
9875
  "isFlagged": {
9336
9876
  "type": "boolean",
9337
9877
  "required": true,
9338
- "default": false
9878
+ "default": false,
9879
+ "description": "Whether this message is flagged for follow-up.",
9880
+ "_meta": {
9881
+ "description": "Whether this message is flagged for follow-up."
9882
+ }
9339
9883
  },
9340
9884
  "hasAttachments": {
9341
9885
  "type": "boolean",
9342
9886
  "required": true,
9343
- "default": false
9887
+ "default": false,
9888
+ "description": "Whether files are attached to this message.",
9889
+ "_meta": {
9890
+ "description": "Whether files are attached to this message."
9891
+ }
9344
9892
  },
9345
9893
  "size": {
9346
9894
  "type": "integer",
9347
9895
  "required": true,
9348
- "default": 0
9896
+ "default": 0,
9897
+ "description": "The size of the message in bytes.",
9898
+ "_meta": {
9899
+ "description": "The size of the message in bytes."
9900
+ }
9349
9901
  },
9350
9902
  "metadata": {
9351
9903
  "type": "text",
9352
- "required": false
9904
+ "required": false,
9905
+ "description": "Additional details supplied by the messaging connection.",
9906
+ "_meta": {
9907
+ "description": "Additional details supplied by the messaging connection."
9908
+ }
9353
9909
  },
9354
9910
  "sendStatus": {
9355
9911
  "type": "text",
9356
9912
  "required": false,
9357
9913
  "default": "draft",
9914
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here.",
9915
+ "_meta": {
9916
+ "description": "The latest sending state: draft, sending, sent, or failed. Received mail may also show draft here."
9917
+ },
9358
9918
  "enum": [
9359
9919
  "draft",
9360
9920
  "pending",
@@ -9366,38 +9926,70 @@
9366
9926
  },
9367
9927
  "sentAt": {
9368
9928
  "type": "datetime",
9369
- "required": false
9929
+ "required": false,
9930
+ "description": "When the message was successfully sent.",
9931
+ "_meta": {
9932
+ "description": "When the message was successfully sent."
9933
+ }
9370
9934
  },
9371
9935
  "sendError": {
9372
9936
  "type": "text",
9373
- "required": false
9937
+ "required": false,
9938
+ "description": "The reason the latest send attempt failed.",
9939
+ "_meta": {
9940
+ "description": "The reason the latest send attempt failed."
9941
+ }
9374
9942
  },
9375
9943
  "retryCount": {
9376
9944
  "type": "integer",
9377
9945
  "required": true,
9378
- "default": 0
9946
+ "default": 0,
9947
+ "description": "How many times delivery has been retried.",
9948
+ "_meta": {
9949
+ "description": "How many times delivery has been retried."
9950
+ }
9379
9951
  },
9380
9952
  "maxRetries": {
9381
9953
  "type": "integer",
9382
9954
  "required": true,
9383
- "default": 3
9955
+ "default": 3,
9956
+ "description": "The maximum number of delivery retries allowed.",
9957
+ "_meta": {
9958
+ "description": "The maximum number of delivery retries allowed."
9959
+ }
9384
9960
  },
9385
9961
  "scheduledSendAt": {
9386
9962
  "type": "datetime",
9387
- "required": false
9963
+ "required": false,
9964
+ "description": "When this message is scheduled to be sent.",
9965
+ "_meta": {
9966
+ "description": "When this message is scheduled to be sent."
9967
+ }
9388
9968
  },
9389
9969
  "inReplyToMessageId": {
9390
9970
  "type": "foreignKey",
9391
9971
  "required": false,
9392
- "related": "Message"
9972
+ "related": "Message",
9973
+ "description": "The earlier message this one replies to.",
9974
+ "_meta": {
9975
+ "description": "The earlier message this one replies to."
9976
+ }
9393
9977
  },
9394
9978
  "createdAt": {
9395
9979
  "type": "text",
9396
- "required": false
9980
+ "required": false,
9981
+ "description": "When this message was recorded.",
9982
+ "_meta": {
9983
+ "description": "When this message was recorded."
9984
+ }
9397
9985
  },
9398
9986
  "updatedAt": {
9399
9987
  "type": "text",
9400
- "required": false
9988
+ "required": false,
9989
+ "description": "When this message was last changed.",
9990
+ "_meta": {
9991
+ "description": "When this message was last changed."
9992
+ }
9401
9993
  },
9402
9994
  "tweetId": {
9403
9995
  "type": "text",
@@ -10124,15 +10716,27 @@
10124
10716
  },
10125
10717
  "name": {
10126
10718
  "type": "text",
10127
- "required": false
10719
+ "required": false,
10720
+ "description": "The display name for this connected messaging account.",
10721
+ "_meta": {
10722
+ "description": "The display name for this connected messaging account."
10723
+ }
10128
10724
  },
10129
10725
  "providerType": {
10130
10726
  "type": "text",
10131
- "required": false
10727
+ "required": false,
10728
+ "description": "The service that connects this account to your application.",
10729
+ "_meta": {
10730
+ "description": "The service that connects this account to your application."
10731
+ }
10132
10732
  },
10133
10733
  "channelType": {
10134
10734
  "type": "text",
10135
- "required": false
10735
+ "required": false,
10736
+ "description": "The kind of messaging this account supports, such as email or chat.",
10737
+ "_meta": {
10738
+ "description": "The kind of messaging this account supports, such as email or chat."
10739
+ }
10136
10740
  },
10137
10741
  "credentialSecretId": {
10138
10742
  "type": "text",
@@ -10147,11 +10751,19 @@
10147
10751
  "isActive": {
10148
10752
  "type": "boolean",
10149
10753
  "required": true,
10150
- "default": true
10754
+ "default": true,
10755
+ "description": "Whether this account is enabled for messaging.",
10756
+ "_meta": {
10757
+ "description": "Whether this account is enabled for messaging."
10758
+ }
10151
10759
  },
10152
10760
  "lastSyncAt": {
10153
10761
  "type": "datetime",
10154
- "required": false
10762
+ "required": false,
10763
+ "description": "When this account last checked for new messages.",
10764
+ "_meta": {
10765
+ "description": "When this account last checked for new messages."
10766
+ }
10155
10767
  },
10156
10768
  "settings": {
10157
10769
  "type": "text",
@@ -10165,15 +10777,27 @@
10165
10777
  },
10166
10778
  "configuration": {
10167
10779
  "type": "text",
10168
- "required": false
10780
+ "required": false,
10781
+ "description": "The public connection settings for this account; credentials are stored separately.",
10782
+ "_meta": {
10783
+ "description": "The public connection settings for this account; credentials are stored separately."
10784
+ }
10169
10785
  },
10170
10786
  "createdAt": {
10171
10787
  "type": "text",
10172
- "required": false
10788
+ "required": false,
10789
+ "description": "When this account was added.",
10790
+ "_meta": {
10791
+ "description": "When this account was added."
10792
+ }
10173
10793
  },
10174
10794
  "updatedAt": {
10175
10795
  "type": "text",
10176
- "required": false
10796
+ "required": false,
10797
+ "description": "When this account was last changed.",
10798
+ "_meta": {
10799
+ "description": "When this account was last changed."
10800
+ }
10177
10801
  },
10178
10802
  "handle": {
10179
10803
  "type": "text",
@@ -10923,15 +11547,27 @@
10923
11547
  },
10924
11548
  "name": {
10925
11549
  "type": "text",
10926
- "required": false
11550
+ "required": false,
11551
+ "description": "The display name for this connected messaging account.",
11552
+ "_meta": {
11553
+ "description": "The display name for this connected messaging account."
11554
+ }
10927
11555
  },
10928
11556
  "providerType": {
10929
11557
  "type": "text",
10930
- "required": false
11558
+ "required": false,
11559
+ "description": "The service that connects this account to your application.",
11560
+ "_meta": {
11561
+ "description": "The service that connects this account to your application."
11562
+ }
10931
11563
  },
10932
11564
  "channelType": {
10933
11565
  "type": "text",
10934
- "required": false
11566
+ "required": false,
11567
+ "description": "The kind of messaging this account supports, such as email or chat.",
11568
+ "_meta": {
11569
+ "description": "The kind of messaging this account supports, such as email or chat."
11570
+ }
10935
11571
  },
10936
11572
  "credentialSecretId": {
10937
11573
  "type": "text",
@@ -10946,11 +11582,19 @@
10946
11582
  "isActive": {
10947
11583
  "type": "boolean",
10948
11584
  "required": true,
10949
- "default": true
11585
+ "default": true,
11586
+ "description": "Whether this account is enabled for messaging.",
11587
+ "_meta": {
11588
+ "description": "Whether this account is enabled for messaging."
11589
+ }
10950
11590
  },
10951
11591
  "lastSyncAt": {
10952
11592
  "type": "datetime",
10953
- "required": false
11593
+ "required": false,
11594
+ "description": "When this account last checked for new messages.",
11595
+ "_meta": {
11596
+ "description": "When this account last checked for new messages."
11597
+ }
10954
11598
  },
10955
11599
  "settings": {
10956
11600
  "type": "text",
@@ -10964,15 +11608,27 @@
10964
11608
  },
10965
11609
  "configuration": {
10966
11610
  "type": "text",
10967
- "required": false
11611
+ "required": false,
11612
+ "description": "The public connection settings for this account; credentials are stored separately.",
11613
+ "_meta": {
11614
+ "description": "The public connection settings for this account; credentials are stored separately."
11615
+ }
10968
11616
  },
10969
11617
  "createdAt": {
10970
11618
  "type": "text",
10971
- "required": false
11619
+ "required": false,
11620
+ "description": "When this account was added.",
11621
+ "_meta": {
11622
+ "description": "When this account was added."
11623
+ }
10972
11624
  },
10973
11625
  "updatedAt": {
10974
11626
  "type": "text",
10975
- "required": false
11627
+ "required": false,
11628
+ "description": "When this account was last changed.",
11629
+ "_meta": {
11630
+ "description": "When this account was last changed."
11631
+ }
10976
11632
  }
10977
11633
  },
10978
11634
  "methods": {
@@ -11294,6 +11950,28 @@
11294
11950
  "icon": "folder",
11295
11951
  "description": "Read email and keep up with updates addressed to you."
11296
11952
  },
11953
+ "options": {
11954
+ "@happyvertical/smrt-messages:Email": {
11955
+ "fields": {
11956
+ "created_at": {
11957
+ "help": "When this email was first recorded."
11958
+ },
11959
+ "updated_at": {
11960
+ "help": "When this email record was last changed."
11961
+ }
11962
+ }
11963
+ },
11964
+ "@happyvertical/smrt-messages:EmailAccount": {
11965
+ "fields": {
11966
+ "created_at": {
11967
+ "help": "When this mailbox connection was first recorded."
11968
+ },
11969
+ "updated_at": {
11970
+ "help": "When this mailbox connection was last changed."
11971
+ }
11972
+ }
11973
+ }
11974
+ },
11297
11975
  "help": {
11298
11976
  "markdown": "## Your mailbox\nRead messages, open a conversation, or compose an email using a connected account.\nChoose the sender account, add recipients, and check the subject and message before sending.\n\n## Failed sends\nUse Failed sends to review email whose last send attempt failed. Returning to the mailbox shows all email again.\nCheck the failure and sender connection before retrying through your application. This view does not resend email automatically.\n\n## Preview\nThe playground uses fictional messages. Sending and saving are mocked and never contact a mail server.\n\n## Connect an account\nYour application administrator connects an authorized email provider on the server. Real sending and mailbox synchronization require that connection; a preview does not verify delivery.\n",
11299
11977
  "fieldRefs": []