agentphone 1.0.9 → 1.0.10

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 (100) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +3 -0
  3. package/dist/cjs/Client.js +17 -12
  4. package/dist/cjs/api/resources/agentSignup/client/Client.d.ts +1 -1
  5. package/dist/cjs/api/resources/agentSignup/client/Client.js +1 -1
  6. package/dist/cjs/api/resources/agents/client/Client.d.ts +1 -1
  7. package/dist/cjs/api/resources/agents/client/Client.js +1 -1
  8. package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +2 -0
  9. package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +2 -0
  10. package/dist/cjs/api/resources/calls/client/Client.d.ts +20 -0
  11. package/dist/cjs/api/resources/calls/client/Client.js +56 -0
  12. package/dist/cjs/api/resources/calls/client/requests/EndCallV1CallsCallIdEndPostRequest.d.ts +9 -0
  13. package/dist/cjs/api/resources/calls/client/requests/EndCallV1CallsCallIdEndPostRequest.js +3 -0
  14. package/dist/cjs/api/resources/calls/client/requests/index.d.ts +1 -0
  15. package/dist/cjs/api/resources/contactCards/client/Client.d.ts +61 -0
  16. package/dist/cjs/api/resources/contactCards/client/Client.js +229 -0
  17. package/dist/cjs/api/resources/contactCards/client/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/contactCards/client/index.js +17 -0
  19. package/dist/cjs/api/resources/contactCards/client/requests/ContactCardWriteRequest.d.ts +16 -0
  20. package/dist/cjs/api/resources/contactCards/client/requests/ContactCardWriteRequest.js +3 -0
  21. package/dist/cjs/api/resources/contactCards/client/requests/DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest.d.ts +9 -0
  22. package/dist/cjs/api/resources/contactCards/client/requests/DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest.js +3 -0
  23. package/dist/cjs/api/resources/contactCards/client/requests/GetContactCardV1NumbersNumberIdContactCardGetRequest.d.ts +9 -0
  24. package/dist/cjs/api/resources/contactCards/client/requests/GetContactCardV1NumbersNumberIdContactCardGetRequest.js +3 -0
  25. package/dist/cjs/api/resources/contactCards/client/requests/index.d.ts +3 -0
  26. package/dist/cjs/api/resources/contactCards/client/requests/index.js +2 -0
  27. package/dist/cjs/api/resources/contactCards/index.d.ts +1 -0
  28. package/dist/cjs/api/resources/contactCards/index.js +17 -0
  29. package/dist/cjs/api/resources/conversations/client/Client.d.ts +1 -0
  30. package/dist/cjs/api/resources/conversations/client/Client.js +1 -0
  31. package/dist/cjs/api/resources/index.d.ts +2 -0
  32. package/dist/cjs/api/resources/index.js +3 -1
  33. package/dist/cjs/api/resources/messages/client/Client.d.ts +10 -11
  34. package/dist/cjs/api/resources/messages/client/Client.js +10 -11
  35. package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.d.ts +20 -0
  36. package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.js +19 -0
  37. package/dist/cjs/api/resources/messages/client/requests/SendReactionRequest.d.ts +15 -2
  38. package/dist/cjs/api/resources/messages/client/requests/SendReactionRequest.js +13 -0
  39. package/dist/cjs/api/resources/messages/client/requests/index.d.ts +2 -2
  40. package/dist/cjs/api/resources/messages/client/requests/index.js +5 -0
  41. package/dist/cjs/api/resources/numbers/client/Client.d.ts +4 -4
  42. package/dist/cjs/api/resources/numbers/client/Client.js +4 -4
  43. package/dist/cjs/api/types/AgentResponse.d.ts +1 -0
  44. package/dist/cjs/api/types/ContactCardResponse.d.ts +6 -0
  45. package/dist/cjs/api/types/ContactCardResponse.js +3 -0
  46. package/dist/cjs/api/types/index.d.ts +1 -0
  47. package/dist/cjs/api/types/index.js +1 -0
  48. package/dist/cjs/version.d.ts +1 -1
  49. package/dist/cjs/version.js +1 -1
  50. package/dist/esm/BaseClient.mjs +2 -2
  51. package/dist/esm/Client.d.mts +3 -0
  52. package/dist/esm/Client.mjs +5 -0
  53. package/dist/esm/api/resources/agentSignup/client/Client.d.mts +1 -1
  54. package/dist/esm/api/resources/agentSignup/client/Client.mjs +1 -1
  55. package/dist/esm/api/resources/agents/client/Client.d.mts +1 -1
  56. package/dist/esm/api/resources/agents/client/Client.mjs +1 -1
  57. package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +2 -0
  58. package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +2 -0
  59. package/dist/esm/api/resources/calls/client/Client.d.mts +20 -0
  60. package/dist/esm/api/resources/calls/client/Client.mjs +56 -0
  61. package/dist/esm/api/resources/calls/client/requests/EndCallV1CallsCallIdEndPostRequest.d.mts +9 -0
  62. package/dist/esm/api/resources/calls/client/requests/EndCallV1CallsCallIdEndPostRequest.mjs +2 -0
  63. package/dist/esm/api/resources/calls/client/requests/index.d.mts +1 -0
  64. package/dist/esm/api/resources/contactCards/client/Client.d.mts +61 -0
  65. package/dist/esm/api/resources/contactCards/client/Client.mjs +192 -0
  66. package/dist/esm/api/resources/contactCards/client/index.d.mts +1 -0
  67. package/dist/esm/api/resources/contactCards/client/index.mjs +1 -0
  68. package/dist/esm/api/resources/contactCards/client/requests/ContactCardWriteRequest.d.mts +16 -0
  69. package/dist/esm/api/resources/contactCards/client/requests/ContactCardWriteRequest.mjs +2 -0
  70. package/dist/esm/api/resources/contactCards/client/requests/DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest.d.mts +9 -0
  71. package/dist/esm/api/resources/contactCards/client/requests/DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest.mjs +2 -0
  72. package/dist/esm/api/resources/contactCards/client/requests/GetContactCardV1NumbersNumberIdContactCardGetRequest.d.mts +9 -0
  73. package/dist/esm/api/resources/contactCards/client/requests/GetContactCardV1NumbersNumberIdContactCardGetRequest.mjs +2 -0
  74. package/dist/esm/api/resources/contactCards/client/requests/index.d.mts +3 -0
  75. package/dist/esm/api/resources/contactCards/client/requests/index.mjs +1 -0
  76. package/dist/esm/api/resources/contactCards/index.d.mts +1 -0
  77. package/dist/esm/api/resources/contactCards/index.mjs +1 -0
  78. package/dist/esm/api/resources/conversations/client/Client.d.mts +1 -0
  79. package/dist/esm/api/resources/conversations/client/Client.mjs +1 -0
  80. package/dist/esm/api/resources/index.d.mts +2 -0
  81. package/dist/esm/api/resources/index.mjs +2 -0
  82. package/dist/esm/api/resources/messages/client/Client.d.mts +10 -11
  83. package/dist/esm/api/resources/messages/client/Client.mjs +10 -11
  84. package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.d.mts +20 -0
  85. package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.mjs +18 -1
  86. package/dist/esm/api/resources/messages/client/requests/SendReactionRequest.d.mts +15 -2
  87. package/dist/esm/api/resources/messages/client/requests/SendReactionRequest.mjs +12 -1
  88. package/dist/esm/api/resources/messages/client/requests/index.d.mts +2 -2
  89. package/dist/esm/api/resources/messages/client/requests/index.mjs +2 -1
  90. package/dist/esm/api/resources/numbers/client/Client.d.mts +4 -4
  91. package/dist/esm/api/resources/numbers/client/Client.mjs +4 -4
  92. package/dist/esm/api/types/AgentResponse.d.mts +1 -0
  93. package/dist/esm/api/types/ContactCardResponse.d.mts +6 -0
  94. package/dist/esm/api/types/ContactCardResponse.mjs +2 -0
  95. package/dist/esm/api/types/index.d.mts +1 -0
  96. package/dist/esm/api/types/index.mjs +1 -0
  97. package/dist/esm/version.d.mts +1 -1
  98. package/dist/esm/version.mjs +1 -1
  99. package/package.json +1 -1
  100. package/reference.md +286 -17
@@ -11,6 +11,7 @@ export * from "./AppRoutesConversationsConversationSummary.mjs";
11
11
  export * from "./AttachNumberResponse.mjs";
12
12
  export * from "./CallListResponse.mjs";
13
13
  export * from "./CallSummary.mjs";
14
+ export * from "./ContactCardResponse.mjs";
14
15
  export * from "./ContactListResponse.mjs";
15
16
  export * from "./ContactResponse.mjs";
16
17
  export * from "./ConversationDetail.mjs";
@@ -11,6 +11,7 @@ export * from "./AppRoutesConversationsConversationSummary.mjs";
11
11
  export * from "./AttachNumberResponse.mjs";
12
12
  export * from "./CallListResponse.mjs";
13
13
  export * from "./CallSummary.mjs";
14
+ export * from "./ContactCardResponse.mjs";
14
15
  export * from "./ContactListResponse.mjs";
15
16
  export * from "./ContactResponse.mjs";
16
17
  export * from "./ConversationDetail.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.0.7";
1
+ export declare const SDK_VERSION = "1.0.10";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.0.7";
1
+ export const SDK_VERSION = "1.0.10";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentphone",
3
- "version": "1.0.9",
3
+ "version": "1.0.10",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -82,7 +82,7 @@ await client.agentSignup.agentSignUp({
82
82
 
83
83
  Verify the OTP and atomically provision everything.
84
84
 
85
- Creates: User + Project (+ mirrored Account) + starter hosted Agent + Twilio number
85
+ Creates: User + Project (+ mirrored Account) + starter hosted Agent + phone number
86
86
  + first-month charge + API key. Returns the key once — agents must save it.
87
87
  </dd>
88
88
  </dl>
@@ -150,7 +150,7 @@ await client.agentSignup.agentVerify({
150
150
  <dl>
151
151
  <dd>
152
152
 
153
- Return available voices for voice calls.
153
+ Return available voices from the call provider (Retell).
154
154
  </dd>
155
155
  </dl>
156
156
  </dd>
@@ -873,10 +873,10 @@ await client.numbers.listNumbers();
873
873
  Provision a new SMS-enabled phone number.
874
874
 
875
875
  1. Check number limit (lifetime limit)
876
- 2. Search Twilio for available numbers
876
+ 2. Search the account's configured SMS provider for available numbers
877
877
  3. Purchase the first available one
878
- 4. Configure webhook URL
879
- 5. Store in our database
878
+ 4. Configure messaging and voice routing
879
+ 5. Store the number in our database
880
880
  </dd>
881
881
  </dl>
882
882
  </dd>
@@ -1009,7 +1009,7 @@ await client.numbers.getMessages({
1009
1009
  Release (delete) a phone number.
1010
1010
 
1011
1011
  This will:
1012
- 1. Release the number from Twilio (number goes back to Twilio's pool)
1012
+ 1. Release the number from its upstream provider when supported
1013
1013
  2. Mark the number as "released" in the database
1014
1014
  3. Keep all messages and conversation history (for audit purposes)
1015
1015
 
@@ -2175,6 +2175,7 @@ await client.contacts.updateContact({
2175
2175
  List all conversations for this account.
2176
2176
 
2177
2177
  Sorted by most recent activity (lastMessageAt desc).
2178
+ Also includes conversations on shared lines owned by this account.
2178
2179
  </dd>
2179
2180
  </dl>
2180
2181
  </dd>
@@ -2775,6 +2776,76 @@ await client.calls.getCall({
2775
2776
  </dl>
2776
2777
 
2777
2778
 
2779
+ </dd>
2780
+ </dl>
2781
+ </details>
2782
+
2783
+ <details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">endCall</a>({ ...params }) -> unknown</code></summary>
2784
+ <dl>
2785
+ <dd>
2786
+
2787
+ #### 📝 Description
2788
+
2789
+ <dl>
2790
+ <dd>
2791
+
2792
+ <dl>
2793
+ <dd>
2794
+
2795
+ Terminate an ongoing call.
2796
+
2797
+ Works for both hosted-mode and webhook-mode calls. The call_ended
2798
+ webhook from Retell updates status/endedAt asynchronously, so this
2799
+ endpoint returns the current call as soon as the stop request is
2800
+ accepted by Retell.
2801
+ </dd>
2802
+ </dl>
2803
+ </dd>
2804
+ </dl>
2805
+
2806
+ #### 🔌 Usage
2807
+
2808
+ <dl>
2809
+ <dd>
2810
+
2811
+ <dl>
2812
+ <dd>
2813
+
2814
+ ```typescript
2815
+ await client.calls.endCall({
2816
+ call_id: "call_id"
2817
+ });
2818
+
2819
+ ```
2820
+ </dd>
2821
+ </dl>
2822
+ </dd>
2823
+ </dl>
2824
+
2825
+ #### ⚙️ Parameters
2826
+
2827
+ <dl>
2828
+ <dd>
2829
+
2830
+ <dl>
2831
+ <dd>
2832
+
2833
+ **request:** `AgentPhone.EndCallV1CallsCallIdEndPostRequest`
2834
+
2835
+ </dd>
2836
+ </dl>
2837
+
2838
+ <dl>
2839
+ <dd>
2840
+
2841
+ **requestOptions:** `CallsClient.RequestOptions`
2842
+
2843
+ </dd>
2844
+ </dl>
2845
+ </dd>
2846
+ </dl>
2847
+
2848
+
2778
2849
  </dd>
2779
2850
  </dl>
2780
2851
  </details>
@@ -3390,7 +3461,11 @@ await client.usage.getUsageByAgent({
3390
3461
 
3391
3462
  Send an outbound message (SMS or iMessage) via the provider assigned to the number.
3392
3463
 
3393
- Supports single attachments via `media_url` or multiple attachments via `media_urls`. You may use one or the other, but not both.
3464
+ Attach media by passing public HTTPS URLs in `media_urls`.
3465
+
3466
+ ### Single attachment
3467
+
3468
+ Pass a single-item array in `media_urls`. The URL must be publicly accessible.
3394
3469
 
3395
3470
  ### Carousel / multi-image (iMessage)
3396
3471
 
@@ -3400,13 +3475,7 @@ To send a carousel of images on iMessage, pass 2-20 URLs in `media_urls`. Requir
3400
3475
  - `body` must be omitted or empty (text cannot be sent alongside a carousel)
3401
3476
  - Only supported on iMessage-capable lines
3402
3477
 
3403
- ### Single attachment
3404
-
3405
- Pass a single URL in `media_url`. The URL must be publicly accessible. Works across all channels.
3406
-
3407
- ### Multi-attachment (iMessage)
3408
-
3409
- Some iMessage lines support multiple attachments (images and other file types) via `media_urls`. No minimum count; `body` can be included alongside attachments.
3478
+ > **Deprecation notice:** The `media_url` field (singular) is deprecated and will be removed in a future version. Use `media_urls` (array) instead — even for a single attachment, pass it as `media_urls: ["https://..."]`.
3410
3479
  </dd>
3411
3480
  </dl>
3412
3481
  </dd>
@@ -3475,8 +3544,9 @@ await client.messages.sendMessage({
3475
3544
 
3476
3545
  Send a tapback reaction to a message (iMessage only).
3477
3546
 
3478
- Reactions are an iMessage feature. Attempting to react to a message
3479
- sent via an SMS/Twilio number will return a clear error.
3547
+ Reactions are available only for iMessage messages. Attempting to react
3548
+ to an SMS message or another channel that does not support tapbacks
3549
+ returns a clear error.
3480
3550
  </dd>
3481
3551
  </dl>
3482
3552
  </dd>
@@ -3493,7 +3563,7 @@ sent via an SMS/Twilio number will return a clear error.
3493
3563
  ```typescript
3494
3564
  await client.messages.sendReaction({
3495
3565
  message_id: "message_id",
3496
- reaction: "reaction"
3566
+ reaction: "love"
3497
3567
  });
3498
3568
 
3499
3569
  ```
@@ -3526,6 +3596,205 @@ await client.messages.sendReaction({
3526
3596
  </dl>
3527
3597
 
3528
3598
 
3599
+ </dd>
3600
+ </dl>
3601
+ </details>
3602
+
3603
+ ## ContactCards
3604
+ <details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">getContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
3605
+ <dl>
3606
+ <dd>
3607
+
3608
+ #### 📝 Description
3609
+
3610
+ <dl>
3611
+ <dd>
3612
+
3613
+ <dl>
3614
+ <dd>
3615
+
3616
+ Fetch the iMessage contact card set on this number.
3617
+ </dd>
3618
+ </dl>
3619
+ </dd>
3620
+ </dl>
3621
+
3622
+ #### 🔌 Usage
3623
+
3624
+ <dl>
3625
+ <dd>
3626
+
3627
+ <dl>
3628
+ <dd>
3629
+
3630
+ ```typescript
3631
+ await client.contactCards.getContactCard({
3632
+ number_id: "number_id"
3633
+ });
3634
+
3635
+ ```
3636
+ </dd>
3637
+ </dl>
3638
+ </dd>
3639
+ </dl>
3640
+
3641
+ #### ⚙️ Parameters
3642
+
3643
+ <dl>
3644
+ <dd>
3645
+
3646
+ <dl>
3647
+ <dd>
3648
+
3649
+ **request:** `AgentPhone.GetContactCardV1NumbersNumberIdContactCardGetRequest`
3650
+
3651
+ </dd>
3652
+ </dl>
3653
+
3654
+ <dl>
3655
+ <dd>
3656
+
3657
+ **requestOptions:** `ContactCardsClient.RequestOptions`
3658
+
3659
+ </dd>
3660
+ </dl>
3661
+ </dd>
3662
+ </dl>
3663
+
3664
+
3665
+ </dd>
3666
+ </dl>
3667
+ </details>
3668
+
3669
+ <details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">putContactCard</a>({ ...params }) -> AgentPhone.ContactCardResponse</code></summary>
3670
+ <dl>
3671
+ <dd>
3672
+
3673
+ #### 📝 Description
3674
+
3675
+ <dl>
3676
+ <dd>
3677
+
3678
+ <dl>
3679
+ <dd>
3680
+
3681
+ Create or replace the iMessage contact card on this number.
3682
+ </dd>
3683
+ </dl>
3684
+ </dd>
3685
+ </dl>
3686
+
3687
+ #### 🔌 Usage
3688
+
3689
+ <dl>
3690
+ <dd>
3691
+
3692
+ <dl>
3693
+ <dd>
3694
+
3695
+ ```typescript
3696
+ await client.contactCards.putContactCard({
3697
+ number_id: "number_id",
3698
+ firstName: "firstName",
3699
+ lastName: "lastName",
3700
+ avatarUrl: "avatarUrl"
3701
+ });
3702
+
3703
+ ```
3704
+ </dd>
3705
+ </dl>
3706
+ </dd>
3707
+ </dl>
3708
+
3709
+ #### ⚙️ Parameters
3710
+
3711
+ <dl>
3712
+ <dd>
3713
+
3714
+ <dl>
3715
+ <dd>
3716
+
3717
+ **request:** `AgentPhone.ContactCardWriteRequest`
3718
+
3719
+ </dd>
3720
+ </dl>
3721
+
3722
+ <dl>
3723
+ <dd>
3724
+
3725
+ **requestOptions:** `ContactCardsClient.RequestOptions`
3726
+
3727
+ </dd>
3728
+ </dl>
3729
+ </dd>
3730
+ </dl>
3731
+
3732
+
3733
+ </dd>
3734
+ </dl>
3735
+ </details>
3736
+
3737
+ <details><summary><code>client.contactCards.<a href="/src/api/resources/contactCards/client/Client.ts">deleteContactCard</a>({ ...params }) -> void</code></summary>
3738
+ <dl>
3739
+ <dd>
3740
+
3741
+ #### 📝 Description
3742
+
3743
+ <dl>
3744
+ <dd>
3745
+
3746
+ <dl>
3747
+ <dd>
3748
+
3749
+ Remove the iMessage contact card from this number.
3750
+ </dd>
3751
+ </dl>
3752
+ </dd>
3753
+ </dl>
3754
+
3755
+ #### 🔌 Usage
3756
+
3757
+ <dl>
3758
+ <dd>
3759
+
3760
+ <dl>
3761
+ <dd>
3762
+
3763
+ ```typescript
3764
+ await client.contactCards.deleteContactCard({
3765
+ number_id: "number_id"
3766
+ });
3767
+
3768
+ ```
3769
+ </dd>
3770
+ </dl>
3771
+ </dd>
3772
+ </dl>
3773
+
3774
+ #### ⚙️ Parameters
3775
+
3776
+ <dl>
3777
+ <dd>
3778
+
3779
+ <dl>
3780
+ <dd>
3781
+
3782
+ **request:** `AgentPhone.DeleteContactCardV1NumbersNumberIdContactCardDeleteRequest`
3783
+
3784
+ </dd>
3785
+ </dl>
3786
+
3787
+ <dl>
3788
+ <dd>
3789
+
3790
+ **requestOptions:** `ContactCardsClient.RequestOptions`
3791
+
3792
+ </dd>
3793
+ </dl>
3794
+ </dd>
3795
+ </dl>
3796
+
3797
+
3529
3798
  </dd>
3530
3799
  </dl>
3531
3800
  </details>