agentmail 0.5.18 → 0.5.19

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 (58) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/inboxes/resources/webhooks/client/Client.d.ts +32 -0
  3. package/dist/cjs/api/resources/inboxes/resources/webhooks/client/Client.js +139 -0
  4. package/dist/cjs/api/resources/pods/resources/webhooks/client/Client.d.ts +32 -0
  5. package/dist/cjs/api/resources/pods/resources/webhooks/client/Client.js +139 -0
  6. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +30 -0
  7. package/dist/cjs/api/resources/webhooks/client/Client.js +137 -0
  8. package/dist/cjs/api/resources/webhooks/types/CreateInboxWebhookRequest.d.ts +1 -0
  9. package/dist/cjs/api/resources/webhooks/types/UpdateWebhookHeadersRequest.d.ts +10 -0
  10. package/dist/cjs/api/resources/webhooks/types/UpdateWebhookHeadersRequest.js +3 -0
  11. package/dist/cjs/api/resources/webhooks/types/WebhookHeaderNamesResponse.d.ts +4 -0
  12. package/dist/cjs/api/resources/webhooks/types/WebhookHeaderNamesResponse.js +3 -0
  13. package/dist/cjs/api/resources/webhooks/types/WebhookHeaders.d.ts +6 -0
  14. package/dist/cjs/api/resources/webhooks/types/WebhookHeaders.js +3 -0
  15. package/dist/cjs/api/resources/webhooks/types/index.d.ts +3 -0
  16. package/dist/cjs/api/resources/webhooks/types/index.js +3 -0
  17. package/dist/cjs/serialization/resources/webhooks/types/CreateInboxWebhookRequest.d.ts +2 -0
  18. package/dist/cjs/serialization/resources/webhooks/types/CreateInboxWebhookRequest.js +2 -0
  19. package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookHeadersRequest.d.ts +11 -0
  20. package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookHeadersRequest.js +43 -0
  21. package/dist/cjs/serialization/resources/webhooks/types/WebhookHeaderNamesResponse.d.ts +9 -0
  22. package/dist/cjs/serialization/resources/webhooks/types/WebhookHeaderNamesResponse.js +41 -0
  23. package/dist/cjs/serialization/resources/webhooks/types/WebhookHeaders.d.ts +7 -0
  24. package/dist/cjs/serialization/resources/webhooks/types/WebhookHeaders.js +39 -0
  25. package/dist/cjs/serialization/resources/webhooks/types/index.d.ts +3 -0
  26. package/dist/cjs/serialization/resources/webhooks/types/index.js +3 -0
  27. package/dist/cjs/version.d.ts +1 -1
  28. package/dist/cjs/version.js +1 -1
  29. package/dist/esm/BaseClient.mjs +2 -2
  30. package/dist/esm/api/resources/inboxes/resources/webhooks/client/Client.d.mts +32 -0
  31. package/dist/esm/api/resources/inboxes/resources/webhooks/client/Client.mjs +139 -0
  32. package/dist/esm/api/resources/pods/resources/webhooks/client/Client.d.mts +32 -0
  33. package/dist/esm/api/resources/pods/resources/webhooks/client/Client.mjs +139 -0
  34. package/dist/esm/api/resources/webhooks/client/Client.d.mts +30 -0
  35. package/dist/esm/api/resources/webhooks/client/Client.mjs +137 -0
  36. package/dist/esm/api/resources/webhooks/types/CreateInboxWebhookRequest.d.mts +1 -0
  37. package/dist/esm/api/resources/webhooks/types/UpdateWebhookHeadersRequest.d.mts +10 -0
  38. package/dist/esm/api/resources/webhooks/types/UpdateWebhookHeadersRequest.mjs +2 -0
  39. package/dist/esm/api/resources/webhooks/types/WebhookHeaderNamesResponse.d.mts +4 -0
  40. package/dist/esm/api/resources/webhooks/types/WebhookHeaderNamesResponse.mjs +2 -0
  41. package/dist/esm/api/resources/webhooks/types/WebhookHeaders.d.mts +6 -0
  42. package/dist/esm/api/resources/webhooks/types/WebhookHeaders.mjs +2 -0
  43. package/dist/esm/api/resources/webhooks/types/index.d.mts +3 -0
  44. package/dist/esm/api/resources/webhooks/types/index.mjs +3 -0
  45. package/dist/esm/serialization/resources/webhooks/types/CreateInboxWebhookRequest.d.mts +2 -0
  46. package/dist/esm/serialization/resources/webhooks/types/CreateInboxWebhookRequest.mjs +2 -0
  47. package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookHeadersRequest.d.mts +11 -0
  48. package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookHeadersRequest.mjs +7 -0
  49. package/dist/esm/serialization/resources/webhooks/types/WebhookHeaderNamesResponse.d.mts +9 -0
  50. package/dist/esm/serialization/resources/webhooks/types/WebhookHeaderNamesResponse.mjs +5 -0
  51. package/dist/esm/serialization/resources/webhooks/types/WebhookHeaders.d.mts +7 -0
  52. package/dist/esm/serialization/resources/webhooks/types/WebhookHeaders.mjs +3 -0
  53. package/dist/esm/serialization/resources/webhooks/types/index.d.mts +3 -0
  54. package/dist/esm/serialization/resources/webhooks/types/index.mjs +3 -0
  55. package/dist/esm/version.d.mts +1 -1
  56. package/dist/esm/version.mjs +1 -1
  57. package/package.json +1 -1
  58. package/reference.md +440 -0
package/reference.md CHANGED
@@ -732,6 +732,70 @@ await client.webhooks.get("webhook_id");
732
732
  </dl>
733
733
 
734
734
 
735
+ </dd>
736
+ </dl>
737
+ </details>
738
+
739
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getHeaders</a>(webhook_id) -> AgentMail.WebhookHeaderNamesResponse</code></summary>
740
+ <dl>
741
+ <dd>
742
+
743
+ #### 📝 Description
744
+
745
+ <dl>
746
+ <dd>
747
+
748
+ <dl>
749
+ <dd>
750
+
751
+ List the names of custom HTTP headers included with deliveries to this webhook. Header values are
752
+ write-only and are never returned.
753
+ </dd>
754
+ </dl>
755
+ </dd>
756
+ </dl>
757
+
758
+ #### 🔌 Usage
759
+
760
+ <dl>
761
+ <dd>
762
+
763
+ <dl>
764
+ <dd>
765
+
766
+ ```typescript
767
+ await client.webhooks.getHeaders("webhook_id");
768
+
769
+ ```
770
+ </dd>
771
+ </dl>
772
+ </dd>
773
+ </dl>
774
+
775
+ #### ⚙️ Parameters
776
+
777
+ <dl>
778
+ <dd>
779
+
780
+ <dl>
781
+ <dd>
782
+
783
+ **webhook_id:** `AgentMail.WebhookId`
784
+
785
+ </dd>
786
+ </dl>
787
+
788
+ <dl>
789
+ <dd>
790
+
791
+ **requestOptions:** `WebhooksClient.RequestOptions`
792
+
793
+ </dd>
794
+ </dl>
795
+ </dd>
796
+ </dl>
797
+
798
+
735
799
  </dd>
736
800
  </dl>
737
801
  </details>
@@ -878,6 +942,78 @@ await client.webhooks.update("webhook_id", {});
878
942
  </dl>
879
943
 
880
944
 
945
+ </dd>
946
+ </dl>
947
+ </details>
948
+
949
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">updateHeaders</a>(webhook_id, { ...params }) -> void</code></summary>
950
+ <dl>
951
+ <dd>
952
+
953
+ #### 📝 Description
954
+
955
+ <dl>
956
+ <dd>
957
+
958
+ <dl>
959
+ <dd>
960
+
961
+ Atomically set, replace, or remove custom HTTP headers included with deliveries to this webhook.
962
+ Header values remain write-only.
963
+ </dd>
964
+ </dl>
965
+ </dd>
966
+ </dl>
967
+
968
+ #### 🔌 Usage
969
+
970
+ <dl>
971
+ <dd>
972
+
973
+ <dl>
974
+ <dd>
975
+
976
+ ```typescript
977
+ await client.webhooks.updateHeaders("webhook_id", {});
978
+
979
+ ```
980
+ </dd>
981
+ </dl>
982
+ </dd>
983
+ </dl>
984
+
985
+ #### ⚙️ Parameters
986
+
987
+ <dl>
988
+ <dd>
989
+
990
+ <dl>
991
+ <dd>
992
+
993
+ **webhook_id:** `AgentMail.WebhookId`
994
+
995
+ </dd>
996
+ </dl>
997
+
998
+ <dl>
999
+ <dd>
1000
+
1001
+ **request:** `AgentMail.UpdateWebhookHeadersRequest`
1002
+
1003
+ </dd>
1004
+ </dl>
1005
+
1006
+ <dl>
1007
+ <dd>
1008
+
1009
+ **requestOptions:** `WebhooksClient.RequestOptions`
1010
+
1011
+ </dd>
1012
+ </dl>
1013
+ </dd>
1014
+ </dl>
1015
+
1016
+
881
1017
  </dd>
882
1018
  </dl>
883
1019
  </details>
@@ -5404,6 +5540,78 @@ await client.inboxes.webhooks.get("inbox_id", "webhook_id");
5404
5540
  </dl>
5405
5541
 
5406
5542
 
5543
+ </dd>
5544
+ </dl>
5545
+ </details>
5546
+
5547
+ <details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">getHeaders</a>(inbox_id, webhook_id) -> AgentMail.WebhookHeaderNamesResponse</code></summary>
5548
+ <dl>
5549
+ <dd>
5550
+
5551
+ #### 📝 Description
5552
+
5553
+ <dl>
5554
+ <dd>
5555
+
5556
+ <dl>
5557
+ <dd>
5558
+
5559
+ List the names of custom HTTP headers included with deliveries to this inbox-scoped webhook.
5560
+ Header values are write-only and are never returned.
5561
+ </dd>
5562
+ </dl>
5563
+ </dd>
5564
+ </dl>
5565
+
5566
+ #### 🔌 Usage
5567
+
5568
+ <dl>
5569
+ <dd>
5570
+
5571
+ <dl>
5572
+ <dd>
5573
+
5574
+ ```typescript
5575
+ await client.inboxes.webhooks.getHeaders("inbox_id", "webhook_id");
5576
+
5577
+ ```
5578
+ </dd>
5579
+ </dl>
5580
+ </dd>
5581
+ </dl>
5582
+
5583
+ #### ⚙️ Parameters
5584
+
5585
+ <dl>
5586
+ <dd>
5587
+
5588
+ <dl>
5589
+ <dd>
5590
+
5591
+ **inbox_id:** `AgentMail.InboxId`
5592
+
5593
+ </dd>
5594
+ </dl>
5595
+
5596
+ <dl>
5597
+ <dd>
5598
+
5599
+ **webhook_id:** `AgentMail.WebhookId`
5600
+
5601
+ </dd>
5602
+ </dl>
5603
+
5604
+ <dl>
5605
+ <dd>
5606
+
5607
+ **requestOptions:** `WebhooksClient.RequestOptions`
5608
+
5609
+ </dd>
5610
+ </dl>
5611
+ </dd>
5612
+ </dl>
5613
+
5614
+
5407
5615
  </dd>
5408
5616
  </dl>
5409
5617
  </details>
@@ -5565,6 +5773,86 @@ await client.inboxes.webhooks.update("inbox_id", "webhook_id", {});
5565
5773
  </dl>
5566
5774
 
5567
5775
 
5776
+ </dd>
5777
+ </dl>
5778
+ </details>
5779
+
5780
+ <details><summary><code>client.inboxes.webhooks.<a href="/src/api/resources/inboxes/resources/webhooks/client/Client.ts">updateHeaders</a>(inbox_id, webhook_id, { ...params }) -> void</code></summary>
5781
+ <dl>
5782
+ <dd>
5783
+
5784
+ #### 📝 Description
5785
+
5786
+ <dl>
5787
+ <dd>
5788
+
5789
+ <dl>
5790
+ <dd>
5791
+
5792
+ Atomically set, replace, or remove custom HTTP headers included with deliveries to this
5793
+ inbox-scoped webhook. Header values remain write-only.
5794
+ </dd>
5795
+ </dl>
5796
+ </dd>
5797
+ </dl>
5798
+
5799
+ #### 🔌 Usage
5800
+
5801
+ <dl>
5802
+ <dd>
5803
+
5804
+ <dl>
5805
+ <dd>
5806
+
5807
+ ```typescript
5808
+ await client.inboxes.webhooks.updateHeaders("inbox_id", "webhook_id", {});
5809
+
5810
+ ```
5811
+ </dd>
5812
+ </dl>
5813
+ </dd>
5814
+ </dl>
5815
+
5816
+ #### ⚙️ Parameters
5817
+
5818
+ <dl>
5819
+ <dd>
5820
+
5821
+ <dl>
5822
+ <dd>
5823
+
5824
+ **inbox_id:** `AgentMail.InboxId`
5825
+
5826
+ </dd>
5827
+ </dl>
5828
+
5829
+ <dl>
5830
+ <dd>
5831
+
5832
+ **webhook_id:** `AgentMail.WebhookId`
5833
+
5834
+ </dd>
5835
+ </dl>
5836
+
5837
+ <dl>
5838
+ <dd>
5839
+
5840
+ **request:** `AgentMail.UpdateWebhookHeadersRequest`
5841
+
5842
+ </dd>
5843
+ </dl>
5844
+
5845
+ <dl>
5846
+ <dd>
5847
+
5848
+ **requestOptions:** `WebhooksClient.RequestOptions`
5849
+
5850
+ </dd>
5851
+ </dl>
5852
+ </dd>
5853
+ </dl>
5854
+
5855
+
5568
5856
  </dd>
5569
5857
  </dl>
5570
5858
  </details>
@@ -8670,6 +8958,78 @@ await client.pods.webhooks.get("pod_id", "webhook_id");
8670
8958
  </dl>
8671
8959
 
8672
8960
 
8961
+ </dd>
8962
+ </dl>
8963
+ </details>
8964
+
8965
+ <details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">getHeaders</a>(pod_id, webhook_id) -> AgentMail.WebhookHeaderNamesResponse</code></summary>
8966
+ <dl>
8967
+ <dd>
8968
+
8969
+ #### 📝 Description
8970
+
8971
+ <dl>
8972
+ <dd>
8973
+
8974
+ <dl>
8975
+ <dd>
8976
+
8977
+ List the names of custom HTTP headers included with deliveries to this pod-scoped webhook.
8978
+ Header values are write-only and are never returned.
8979
+ </dd>
8980
+ </dl>
8981
+ </dd>
8982
+ </dl>
8983
+
8984
+ #### 🔌 Usage
8985
+
8986
+ <dl>
8987
+ <dd>
8988
+
8989
+ <dl>
8990
+ <dd>
8991
+
8992
+ ```typescript
8993
+ await client.pods.webhooks.getHeaders("pod_id", "webhook_id");
8994
+
8995
+ ```
8996
+ </dd>
8997
+ </dl>
8998
+ </dd>
8999
+ </dl>
9000
+
9001
+ #### ⚙️ Parameters
9002
+
9003
+ <dl>
9004
+ <dd>
9005
+
9006
+ <dl>
9007
+ <dd>
9008
+
9009
+ **pod_id:** `AgentMail.PodId`
9010
+
9011
+ </dd>
9012
+ </dl>
9013
+
9014
+ <dl>
9015
+ <dd>
9016
+
9017
+ **webhook_id:** `AgentMail.WebhookId`
9018
+
9019
+ </dd>
9020
+ </dl>
9021
+
9022
+ <dl>
9023
+ <dd>
9024
+
9025
+ **requestOptions:** `WebhooksClient.RequestOptions`
9026
+
9027
+ </dd>
9028
+ </dl>
9029
+ </dd>
9030
+ </dl>
9031
+
9032
+
8673
9033
  </dd>
8674
9034
  </dl>
8675
9035
  </details>
@@ -8831,6 +9191,86 @@ await client.pods.webhooks.update("pod_id", "webhook_id", {});
8831
9191
  </dl>
8832
9192
 
8833
9193
 
9194
+ </dd>
9195
+ </dl>
9196
+ </details>
9197
+
9198
+ <details><summary><code>client.pods.webhooks.<a href="/src/api/resources/pods/resources/webhooks/client/Client.ts">updateHeaders</a>(pod_id, webhook_id, { ...params }) -> void</code></summary>
9199
+ <dl>
9200
+ <dd>
9201
+
9202
+ #### 📝 Description
9203
+
9204
+ <dl>
9205
+ <dd>
9206
+
9207
+ <dl>
9208
+ <dd>
9209
+
9210
+ Atomically set, replace, or remove custom HTTP headers included with deliveries to this
9211
+ pod-scoped webhook. Header values remain write-only.
9212
+ </dd>
9213
+ </dl>
9214
+ </dd>
9215
+ </dl>
9216
+
9217
+ #### 🔌 Usage
9218
+
9219
+ <dl>
9220
+ <dd>
9221
+
9222
+ <dl>
9223
+ <dd>
9224
+
9225
+ ```typescript
9226
+ await client.pods.webhooks.updateHeaders("pod_id", "webhook_id", {});
9227
+
9228
+ ```
9229
+ </dd>
9230
+ </dl>
9231
+ </dd>
9232
+ </dl>
9233
+
9234
+ #### ⚙️ Parameters
9235
+
9236
+ <dl>
9237
+ <dd>
9238
+
9239
+ <dl>
9240
+ <dd>
9241
+
9242
+ **pod_id:** `AgentMail.PodId`
9243
+
9244
+ </dd>
9245
+ </dl>
9246
+
9247
+ <dl>
9248
+ <dd>
9249
+
9250
+ **webhook_id:** `AgentMail.WebhookId`
9251
+
9252
+ </dd>
9253
+ </dl>
9254
+
9255
+ <dl>
9256
+ <dd>
9257
+
9258
+ **request:** `AgentMail.UpdateWebhookHeadersRequest`
9259
+
9260
+ </dd>
9261
+ </dl>
9262
+
9263
+ <dl>
9264
+ <dd>
9265
+
9266
+ **requestOptions:** `WebhooksClient.RequestOptions`
9267
+
9268
+ </dd>
9269
+ </dl>
9270
+ </dd>
9271
+ </dl>
9272
+
9273
+
8834
9274
  </dd>
8835
9275
  </dl>
8836
9276
  </details>