agentphone 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +18 -0
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.js +12 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +18 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.js +12 -0
- package/dist/cjs/api/resources/calls/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/calls/client/Client.js +61 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateOutboundCallRequest.d.ts +2 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateWebCallRequest.d.ts +2 -0
- package/dist/cjs/api/resources/calls/client/requests/GetCallRecordingV1CallsCallIdRecordingGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/calls/client/requests/GetCallRecordingV1CallsCallIdRecordingGetRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +19 -0
- package/dist/cjs/api/resources/conversations/client/Client.js +55 -0
- package/dist/cjs/api/resources/conversations/client/requests/SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest.d.ts +9 -0
- package/dist/cjs/api/resources/conversations/client/requests/SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest.js +3 -0
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/usage/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/usage/client/Client.js +40 -0
- package/dist/cjs/api/types/AgentResponse.d.ts +18 -0
- package/dist/cjs/api/types/AgentResponse.js +12 -0
- package/dist/cjs/api/types/NumberUsageItem.d.ts +10 -0
- package/dist/cjs/api/types/NumberUsageItem.js +3 -0
- package/dist/cjs/api/types/NumberUsageResponse.d.ts +4 -0
- package/dist/cjs/api/types/NumberUsageResponse.js +3 -0
- package/dist/cjs/api/types/SendTypingResponse.d.ts +5 -0
- package/dist/cjs/api/types/SendTypingResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +18 -0
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.mjs +12 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +18 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.mjs +12 -0
- package/dist/esm/api/resources/calls/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/calls/client/Client.mjs +61 -0
- package/dist/esm/api/resources/calls/client/requests/CreateOutboundCallRequest.d.mts +2 -0
- package/dist/esm/api/resources/calls/client/requests/CreateWebCallRequest.d.mts +2 -0
- package/dist/esm/api/resources/calls/client/requests/GetCallRecordingV1CallsCallIdRecordingGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/calls/client/requests/GetCallRecordingV1CallsCallIdRecordingGetRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/client/Client.d.mts +19 -0
- package/dist/esm/api/resources/conversations/client/Client.mjs +55 -0
- package/dist/esm/api/resources/conversations/client/requests/SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest.d.mts +9 -0
- package/dist/esm/api/resources/conversations/client/requests/SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest.mjs +2 -0
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/usage/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/usage/client/Client.mjs +40 -0
- package/dist/esm/api/types/AgentResponse.d.mts +18 -0
- package/dist/esm/api/types/AgentResponse.mjs +12 -0
- package/dist/esm/api/types/NumberUsageItem.d.mts +10 -0
- package/dist/esm/api/types/NumberUsageItem.mjs +2 -0
- package/dist/esm/api/types/NumberUsageResponse.d.mts +4 -0
- package/dist/esm/api/types/NumberUsageResponse.mjs +2 -0
- package/dist/esm/api/types/SendTypingResponse.d.mts +5 -0
- package/dist/esm/api/types/SendTypingResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +200 -0
package/reference.md
CHANGED
|
@@ -2425,6 +2425,75 @@ await client.conversations.getConversationMessages({
|
|
|
2425
2425
|
</dl>
|
|
2426
2426
|
|
|
2427
2427
|
|
|
2428
|
+
</dd>
|
|
2429
|
+
</dl>
|
|
2430
|
+
</details>
|
|
2431
|
+
|
|
2432
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">sendTypingIndicator</a>({ ...params }) -> AgentPhone.SendTypingResponse</code></summary>
|
|
2433
|
+
<dl>
|
|
2434
|
+
<dd>
|
|
2435
|
+
|
|
2436
|
+
#### 📝 Description
|
|
2437
|
+
|
|
2438
|
+
<dl>
|
|
2439
|
+
<dd>
|
|
2440
|
+
|
|
2441
|
+
<dl>
|
|
2442
|
+
<dd>
|
|
2443
|
+
|
|
2444
|
+
Show a typing indicator in the conversation (iMessage only).
|
|
2445
|
+
|
|
2446
|
+
Best-effort: providers may silently drop the indicator if the chat hasn't
|
|
2447
|
+
had recent activity, the recipient isn't on iMessage, or it's a group chat.
|
|
2448
|
+
Indicators auto-expire after a few seconds — no "stop typing" call needed.
|
|
2449
|
+
</dd>
|
|
2450
|
+
</dl>
|
|
2451
|
+
</dd>
|
|
2452
|
+
</dl>
|
|
2453
|
+
|
|
2454
|
+
#### 🔌 Usage
|
|
2455
|
+
|
|
2456
|
+
<dl>
|
|
2457
|
+
<dd>
|
|
2458
|
+
|
|
2459
|
+
<dl>
|
|
2460
|
+
<dd>
|
|
2461
|
+
|
|
2462
|
+
```typescript
|
|
2463
|
+
await client.conversations.sendTypingIndicator({
|
|
2464
|
+
conversation_id: "conversation_id"
|
|
2465
|
+
});
|
|
2466
|
+
|
|
2467
|
+
```
|
|
2468
|
+
</dd>
|
|
2469
|
+
</dl>
|
|
2470
|
+
</dd>
|
|
2471
|
+
</dl>
|
|
2472
|
+
|
|
2473
|
+
#### ⚙️ Parameters
|
|
2474
|
+
|
|
2475
|
+
<dl>
|
|
2476
|
+
<dd>
|
|
2477
|
+
|
|
2478
|
+
<dl>
|
|
2479
|
+
<dd>
|
|
2480
|
+
|
|
2481
|
+
**request:** `AgentPhone.SendTypingIndicatorV1ConversationsConversationIdTypingPostRequest`
|
|
2482
|
+
|
|
2483
|
+
</dd>
|
|
2484
|
+
</dl>
|
|
2485
|
+
|
|
2486
|
+
<dl>
|
|
2487
|
+
<dd>
|
|
2488
|
+
|
|
2489
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2490
|
+
|
|
2491
|
+
</dd>
|
|
2492
|
+
</dl>
|
|
2493
|
+
</dd>
|
|
2494
|
+
</dl>
|
|
2495
|
+
|
|
2496
|
+
|
|
2428
2497
|
</dd>
|
|
2429
2498
|
</dl>
|
|
2430
2499
|
</details>
|
|
@@ -2706,6 +2775,82 @@ await client.calls.getCall({
|
|
|
2706
2775
|
</dl>
|
|
2707
2776
|
|
|
2708
2777
|
|
|
2778
|
+
</dd>
|
|
2779
|
+
</dl>
|
|
2780
|
+
</details>
|
|
2781
|
+
|
|
2782
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">getCallRecording</a>({ ...params }) -> unknown</code></summary>
|
|
2783
|
+
<dl>
|
|
2784
|
+
<dd>
|
|
2785
|
+
|
|
2786
|
+
#### 📝 Description
|
|
2787
|
+
|
|
2788
|
+
<dl>
|
|
2789
|
+
<dd>
|
|
2790
|
+
|
|
2791
|
+
<dl>
|
|
2792
|
+
<dd>
|
|
2793
|
+
|
|
2794
|
+
Returns the audio file (WAV format) for a completed call.
|
|
2795
|
+
|
|
2796
|
+
This is a public endpoint -- no authentication is required. The call ID acts as the access token. The `recordingUrl` field in the call response already contains this URL when recording is enabled.
|
|
2797
|
+
|
|
2798
|
+
Recording must be enabled on your account via `POST /credits/recording/enable` ($5/mo add-on). Returns `404` if the call doesn't exist or has no recording.
|
|
2799
|
+
|
|
2800
|
+
**Response:** Binary audio file (`audio/wav`), auto-downloads with filename `recording-{call_id}.wav`.
|
|
2801
|
+
|
|
2802
|
+
**Notes:**
|
|
2803
|
+
- Recording is available shortly after a call completes
|
|
2804
|
+
- Check `recordingAvailable: true` in the call response before fetching
|
|
2805
|
+
- The URL can be shared or embedded directly since it requires no authentication
|
|
2806
|
+
</dd>
|
|
2807
|
+
</dl>
|
|
2808
|
+
</dd>
|
|
2809
|
+
</dl>
|
|
2810
|
+
|
|
2811
|
+
#### 🔌 Usage
|
|
2812
|
+
|
|
2813
|
+
<dl>
|
|
2814
|
+
<dd>
|
|
2815
|
+
|
|
2816
|
+
<dl>
|
|
2817
|
+
<dd>
|
|
2818
|
+
|
|
2819
|
+
```typescript
|
|
2820
|
+
await client.calls.getCallRecording({
|
|
2821
|
+
call_id: "call_id"
|
|
2822
|
+
});
|
|
2823
|
+
|
|
2824
|
+
```
|
|
2825
|
+
</dd>
|
|
2826
|
+
</dl>
|
|
2827
|
+
</dd>
|
|
2828
|
+
</dl>
|
|
2829
|
+
|
|
2830
|
+
#### ⚙️ Parameters
|
|
2831
|
+
|
|
2832
|
+
<dl>
|
|
2833
|
+
<dd>
|
|
2834
|
+
|
|
2835
|
+
<dl>
|
|
2836
|
+
<dd>
|
|
2837
|
+
|
|
2838
|
+
**request:** `AgentPhone.GetCallRecordingV1CallsCallIdRecordingGetRequest`
|
|
2839
|
+
|
|
2840
|
+
</dd>
|
|
2841
|
+
</dl>
|
|
2842
|
+
|
|
2843
|
+
<dl>
|
|
2844
|
+
<dd>
|
|
2845
|
+
|
|
2846
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2847
|
+
|
|
2848
|
+
</dd>
|
|
2849
|
+
</dl>
|
|
2850
|
+
</dd>
|
|
2851
|
+
</dl>
|
|
2852
|
+
|
|
2853
|
+
|
|
2709
2854
|
</dd>
|
|
2710
2855
|
</dl>
|
|
2711
2856
|
</details>
|
|
@@ -3104,6 +3249,61 @@ await client.usage.getMonthlyUsage();
|
|
|
3104
3249
|
</dl>
|
|
3105
3250
|
|
|
3106
3251
|
|
|
3252
|
+
</dd>
|
|
3253
|
+
</dl>
|
|
3254
|
+
</details>
|
|
3255
|
+
|
|
3256
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getUsageByNumber</a>() -> AgentPhone.NumberUsageResponse</code></summary>
|
|
3257
|
+
<dl>
|
|
3258
|
+
<dd>
|
|
3259
|
+
|
|
3260
|
+
#### 📝 Description
|
|
3261
|
+
|
|
3262
|
+
<dl>
|
|
3263
|
+
<dd>
|
|
3264
|
+
|
|
3265
|
+
<dl>
|
|
3266
|
+
<dd>
|
|
3267
|
+
|
|
3268
|
+
Get usage statistics broken down by phone number, with linked agent info.
|
|
3269
|
+
</dd>
|
|
3270
|
+
</dl>
|
|
3271
|
+
</dd>
|
|
3272
|
+
</dl>
|
|
3273
|
+
|
|
3274
|
+
#### 🔌 Usage
|
|
3275
|
+
|
|
3276
|
+
<dl>
|
|
3277
|
+
<dd>
|
|
3278
|
+
|
|
3279
|
+
<dl>
|
|
3280
|
+
<dd>
|
|
3281
|
+
|
|
3282
|
+
```typescript
|
|
3283
|
+
await client.usage.getUsageByNumber();
|
|
3284
|
+
|
|
3285
|
+
```
|
|
3286
|
+
</dd>
|
|
3287
|
+
</dl>
|
|
3288
|
+
</dd>
|
|
3289
|
+
</dl>
|
|
3290
|
+
|
|
3291
|
+
#### ⚙️ Parameters
|
|
3292
|
+
|
|
3293
|
+
<dl>
|
|
3294
|
+
<dd>
|
|
3295
|
+
|
|
3296
|
+
<dl>
|
|
3297
|
+
<dd>
|
|
3298
|
+
|
|
3299
|
+
**requestOptions:** `UsageClient.RequestOptions`
|
|
3300
|
+
|
|
3301
|
+
</dd>
|
|
3302
|
+
</dl>
|
|
3303
|
+
</dd>
|
|
3304
|
+
</dl>
|
|
3305
|
+
|
|
3306
|
+
|
|
3107
3307
|
</dd>
|
|
3108
3308
|
</dl>
|
|
3109
3309
|
</details>
|