agentphone 1.0.12 → 1.0.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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +20 -10
- package/dist/cjs/api/resources/agents/client/Client.js +11 -11
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +2 -0
- package/dist/cjs/api/resources/agents/client/requests/DeleteAgentV1AgentsAgentIdDeleteRequest.d.ts +2 -0
- package/dist/cjs/api/resources/agents/client/requests/GetAgentV1AgentsAgentIdGetRequest.d.ts +2 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentsV1AgentsGetRequest.d.ts +2 -1
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +2 -0
- package/dist/cjs/api/resources/calls/client/Client.js +16 -5
- package/dist/cjs/api/resources/calls/client/requests/CreateOutboundCallRequest.d.ts +2 -0
- package/dist/cjs/api/resources/calls/client/requests/ListCallsV1CallsGetRequest.d.ts +2 -1
- package/dist/cjs/api/resources/contactCards/client/Client.d.ts +1 -4
- package/dist/cjs/api/resources/contactCards/client/Client.js +1 -4
- package/dist/cjs/api/resources/contactCards/client/requests/ContactCardWriteRequest.d.ts +4 -7
- package/dist/cjs/api/resources/contacts/client/Client.js +2 -3
- package/dist/cjs/api/resources/contacts/client/requests/ListContactsV1ContactsGetRequest.d.ts +2 -1
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +5 -3
- package/dist/cjs/api/resources/conversations/client/Client.js +7 -6
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsV1ConversationsGetRequest.d.ts +2 -1
- package/dist/cjs/api/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/index.js +5 -1
- package/dist/cjs/api/resources/location/client/Client.d.ts +34 -0
- package/dist/cjs/api/resources/location/client/Client.js +146 -0
- package/dist/cjs/api/resources/location/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/location/client/index.js +17 -0
- package/dist/cjs/api/resources/location/client/requests/GetLocationV1LocationPhoneNumberGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/location/client/requests/GetLocationV1LocationPhoneNumberGetRequest.js +3 -0
- package/dist/cjs/api/resources/location/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/location/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/location/index.d.ts +1 -0
- package/dist/cjs/api/resources/location/index.js +17 -0
- package/dist/cjs/api/resources/messages/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/messages/client/Client.js +0 -1
- package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.d.ts +2 -2
- package/dist/cjs/api/resources/numbers/client/Client.d.ts +29 -7
- package/dist/cjs/api/resources/numbers/client/Client.js +93 -24
- package/dist/cjs/api/resources/numbers/client/requests/CreateNumberRequest.d.ts +2 -0
- package/dist/cjs/api/resources/numbers/client/requests/DeleteNumberV1NumbersNumberIdDeleteRequest.d.ts +2 -0
- package/dist/cjs/api/resources/numbers/client/requests/GetNumberV1NumbersNumberIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/numbers/client/requests/GetNumberV1NumbersNumberIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/numbers/client/requests/ListNumbersV1NumbersGetRequest.d.ts +2 -1
- package/dist/cjs/api/resources/numbers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/subAccounts/client/Client.d.ts +61 -0
- package/dist/cjs/api/resources/subAccounts/client/Client.js +261 -0
- package/dist/cjs/api/resources/subAccounts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/subAccounts/client/index.js +17 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/CreateSubAccountRequest.d.ts +9 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/CreateSubAccountRequest.js +3 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/DeleteSubAccountV1SubAccountsSubAccountIdDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/DeleteSubAccountV1SubAccountsSubAccountIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/UpdateSubAccountRequest.d.ts +11 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/UpdateSubAccountRequest.js +3 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/subAccounts/index.d.ts +1 -0
- package/dist/cjs/api/resources/subAccounts/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +7 -4
- package/dist/cjs/api/resources/webhooks/client/Client.js +14 -9
- package/dist/cjs/api/resources/webhooks/client/requests/CreateOrUpdateWebhookV1WebhooksPostRequest.d.ts +14 -0
- package/dist/cjs/api/resources/webhooks/client/requests/CreateOrUpdateWebhookV1WebhooksPostRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookV1WebhooksGetRequest.d.ts +8 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookV1WebhooksGetRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/types/AgentVerifyRequest.d.ts +1 -0
- package/dist/cjs/api/types/AppRoutesConversationsConversationSummary.d.ts +6 -0
- package/dist/cjs/api/types/ConversationDetail.d.ts +5 -0
- package/dist/cjs/api/types/GroupParticipant.d.ts +7 -0
- package/dist/cjs/api/types/GroupParticipant.js +3 -0
- package/dist/cjs/api/types/LocationRefreshResponse.d.ts +4 -0
- package/dist/cjs/api/types/LocationRefreshResponse.js +3 -0
- package/dist/cjs/api/types/LocationResponse.d.ts +7 -0
- package/dist/cjs/api/types/LocationResponse.js +3 -0
- package/dist/cjs/api/types/MessageInConversation.d.ts +1 -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/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/resources/agents/client/Client.mjs +12 -12
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +2 -0
- package/dist/esm/api/resources/agents/client/requests/DeleteAgentV1AgentsAgentIdDeleteRequest.d.mts +2 -0
- package/dist/esm/api/resources/agents/client/requests/GetAgentV1AgentsAgentIdGetRequest.d.mts +2 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentsV1AgentsGetRequest.d.mts +2 -1
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +2 -0
- package/dist/esm/api/resources/calls/client/Client.mjs +17 -6
- package/dist/esm/api/resources/calls/client/requests/CreateOutboundCallRequest.d.mts +2 -0
- package/dist/esm/api/resources/calls/client/requests/ListCallsV1CallsGetRequest.d.mts +2 -1
- package/dist/esm/api/resources/contactCards/client/Client.d.mts +1 -4
- package/dist/esm/api/resources/contactCards/client/Client.mjs +1 -4
- package/dist/esm/api/resources/contactCards/client/requests/ContactCardWriteRequest.d.mts +4 -7
- package/dist/esm/api/resources/contacts/client/Client.mjs +3 -4
- package/dist/esm/api/resources/contacts/client/requests/ListContactsV1ContactsGetRequest.d.mts +2 -1
- package/dist/esm/api/resources/conversations/client/Client.d.mts +5 -3
- package/dist/esm/api/resources/conversations/client/Client.mjs +8 -7
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsV1ConversationsGetRequest.d.mts +2 -1
- package/dist/esm/api/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/index.mjs +4 -0
- package/dist/esm/api/resources/location/client/Client.d.mts +34 -0
- package/dist/esm/api/resources/location/client/Client.mjs +109 -0
- package/dist/esm/api/resources/location/client/index.d.mts +1 -0
- package/dist/esm/api/resources/location/client/index.mjs +1 -0
- package/dist/esm/api/resources/location/client/requests/GetLocationV1LocationPhoneNumberGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/location/client/requests/GetLocationV1LocationPhoneNumberGetRequest.mjs +2 -0
- package/dist/esm/api/resources/location/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/location/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/location/index.d.mts +1 -0
- package/dist/esm/api/resources/location/index.mjs +1 -0
- package/dist/esm/api/resources/messages/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/messages/client/Client.mjs +0 -1
- package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.d.mts +2 -2
- package/dist/esm/api/resources/numbers/client/Client.d.mts +29 -7
- package/dist/esm/api/resources/numbers/client/Client.mjs +94 -25
- package/dist/esm/api/resources/numbers/client/requests/CreateNumberRequest.d.mts +2 -0
- package/dist/esm/api/resources/numbers/client/requests/DeleteNumberV1NumbersNumberIdDeleteRequest.d.mts +2 -0
- package/dist/esm/api/resources/numbers/client/requests/GetNumberV1NumbersNumberIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/numbers/client/requests/GetNumberV1NumbersNumberIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/numbers/client/requests/ListNumbersV1NumbersGetRequest.d.mts +2 -1
- package/dist/esm/api/resources/numbers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/subAccounts/client/Client.d.mts +61 -0
- package/dist/esm/api/resources/subAccounts/client/Client.mjs +224 -0
- package/dist/esm/api/resources/subAccounts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/subAccounts/client/index.mjs +1 -0
- package/dist/esm/api/resources/subAccounts/client/requests/CreateSubAccountRequest.d.mts +9 -0
- package/dist/esm/api/resources/subAccounts/client/requests/CreateSubAccountRequest.mjs +2 -0
- package/dist/esm/api/resources/subAccounts/client/requests/DeleteSubAccountV1SubAccountsSubAccountIdDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/subAccounts/client/requests/DeleteSubAccountV1SubAccountsSubAccountIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/subAccounts/client/requests/UpdateSubAccountRequest.d.mts +11 -0
- package/dist/esm/api/resources/subAccounts/client/requests/UpdateSubAccountRequest.mjs +2 -0
- package/dist/esm/api/resources/subAccounts/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/subAccounts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/subAccounts/index.d.mts +1 -0
- package/dist/esm/api/resources/subAccounts/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +7 -4
- package/dist/esm/api/resources/webhooks/client/Client.mjs +15 -10
- package/dist/esm/api/resources/webhooks/client/requests/CreateOrUpdateWebhookV1WebhooksPostRequest.d.mts +14 -0
- package/dist/esm/api/resources/webhooks/client/requests/CreateOrUpdateWebhookV1WebhooksPostRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookV1WebhooksGetRequest.d.mts +8 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookV1WebhooksGetRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +2 -0
- package/dist/esm/api/types/AgentVerifyRequest.d.mts +1 -0
- package/dist/esm/api/types/AppRoutesConversationsConversationSummary.d.mts +6 -0
- package/dist/esm/api/types/ConversationDetail.d.mts +5 -0
- package/dist/esm/api/types/GroupParticipant.d.mts +7 -0
- package/dist/esm/api/types/GroupParticipant.mjs +2 -0
- package/dist/esm/api/types/LocationRefreshResponse.d.mts +4 -0
- package/dist/esm/api/types/LocationRefreshResponse.mjs +2 -0
- package/dist/esm/api/types/LocationResponse.d.mts +7 -0
- package/dist/esm/api/types/LocationResponse.mjs +2 -0
- package/dist/esm/api/types/MessageInConversation.d.mts +1 -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 +386 -17
package/reference.md
CHANGED
|
@@ -669,7 +669,11 @@ await client.agents.listAgentCalls({
|
|
|
669
669
|
<dl>
|
|
670
670
|
<dd>
|
|
671
671
|
|
|
672
|
-
List
|
|
672
|
+
List the active phone numbers for this account.
|
|
673
|
+
|
|
674
|
+
Released (deleted) numbers are excluded so the count reflects the numbers
|
|
675
|
+
the account actually holds. Fetch a single number via GET /{number_id}
|
|
676
|
+
(which returns it regardless of status).
|
|
673
677
|
</dd>
|
|
674
678
|
</dl>
|
|
675
679
|
</dd>
|
|
@@ -789,7 +793,7 @@ await client.numbers.createNumber();
|
|
|
789
793
|
</dl>
|
|
790
794
|
</details>
|
|
791
795
|
|
|
792
|
-
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">
|
|
796
|
+
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">getNumber</a>({ ...params }) -> AgentPhone.PhoneNumberResponse</code></summary>
|
|
793
797
|
<dl>
|
|
794
798
|
<dd>
|
|
795
799
|
|
|
@@ -801,9 +805,10 @@ await client.numbers.createNumber();
|
|
|
801
805
|
<dl>
|
|
802
806
|
<dd>
|
|
803
807
|
|
|
804
|
-
Get
|
|
808
|
+
Get a single phone number owned by this account.
|
|
805
809
|
|
|
806
|
-
|
|
810
|
+
Returns the number regardless of status (including released) so detail
|
|
811
|
+
pages still load for numbers that are no longer active.
|
|
807
812
|
</dd>
|
|
808
813
|
</dl>
|
|
809
814
|
</dd>
|
|
@@ -818,7 +823,7 @@ Supports cursor-based pagination via before/after timestamps.
|
|
|
818
823
|
<dd>
|
|
819
824
|
|
|
820
825
|
```typescript
|
|
821
|
-
await client.numbers.
|
|
826
|
+
await client.numbers.getNumber({
|
|
822
827
|
number_id: "number_id"
|
|
823
828
|
});
|
|
824
829
|
|
|
@@ -836,7 +841,7 @@ await client.numbers.getMessages({
|
|
|
836
841
|
<dl>
|
|
837
842
|
<dd>
|
|
838
843
|
|
|
839
|
-
**request:** `AgentPhone.
|
|
844
|
+
**request:** `AgentPhone.GetNumberV1NumbersNumberIdGetRequest`
|
|
840
845
|
|
|
841
846
|
</dd>
|
|
842
847
|
</dl>
|
|
@@ -924,12 +929,79 @@ await client.numbers.deleteNumber({
|
|
|
924
929
|
</dl>
|
|
925
930
|
|
|
926
931
|
|
|
932
|
+
</dd>
|
|
933
|
+
</dl>
|
|
934
|
+
</details>
|
|
935
|
+
|
|
936
|
+
<details><summary><code>client.numbers.<a href="/src/api/resources/numbers/client/Client.ts">getMessages</a>({ ...params }) -> AgentPhone.MessageListResponse</code></summary>
|
|
937
|
+
<dl>
|
|
938
|
+
<dd>
|
|
939
|
+
|
|
940
|
+
#### 📝 Description
|
|
941
|
+
|
|
942
|
+
<dl>
|
|
943
|
+
<dd>
|
|
944
|
+
|
|
945
|
+
<dl>
|
|
946
|
+
<dd>
|
|
947
|
+
|
|
948
|
+
Get messages for a specific phone number.
|
|
949
|
+
|
|
950
|
+
Supports cursor-based pagination via before/after timestamps.
|
|
951
|
+
</dd>
|
|
952
|
+
</dl>
|
|
953
|
+
</dd>
|
|
954
|
+
</dl>
|
|
955
|
+
|
|
956
|
+
#### 🔌 Usage
|
|
957
|
+
|
|
958
|
+
<dl>
|
|
959
|
+
<dd>
|
|
960
|
+
|
|
961
|
+
<dl>
|
|
962
|
+
<dd>
|
|
963
|
+
|
|
964
|
+
```typescript
|
|
965
|
+
await client.numbers.getMessages({
|
|
966
|
+
number_id: "number_id"
|
|
967
|
+
});
|
|
968
|
+
|
|
969
|
+
```
|
|
970
|
+
</dd>
|
|
971
|
+
</dl>
|
|
972
|
+
</dd>
|
|
973
|
+
</dl>
|
|
974
|
+
|
|
975
|
+
#### ⚙️ Parameters
|
|
976
|
+
|
|
977
|
+
<dl>
|
|
978
|
+
<dd>
|
|
979
|
+
|
|
980
|
+
<dl>
|
|
981
|
+
<dd>
|
|
982
|
+
|
|
983
|
+
**request:** `AgentPhone.GetMessagesV1NumbersNumberIdMessagesGetRequest`
|
|
984
|
+
|
|
985
|
+
</dd>
|
|
986
|
+
</dl>
|
|
987
|
+
|
|
988
|
+
<dl>
|
|
989
|
+
<dd>
|
|
990
|
+
|
|
991
|
+
**requestOptions:** `NumbersClient.RequestOptions`
|
|
992
|
+
|
|
993
|
+
</dd>
|
|
994
|
+
</dl>
|
|
995
|
+
</dd>
|
|
996
|
+
</dl>
|
|
997
|
+
|
|
998
|
+
|
|
927
999
|
</dd>
|
|
928
1000
|
</dl>
|
|
929
1001
|
</details>
|
|
930
1002
|
|
|
931
1003
|
## Webhooks
|
|
932
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>() -> AgentPhone.WebhookResponse | null</code></summary>
|
|
1004
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>({ ...params }) -> AgentPhone.WebhookResponse | null</code></summary>
|
|
933
1005
|
<dl>
|
|
934
1006
|
<dd>
|
|
935
1007
|
|
|
@@ -972,6 +1044,14 @@ await client.webhooks.getWebhook();
|
|
|
972
1044
|
<dl>
|
|
973
1045
|
<dd>
|
|
974
1046
|
|
|
1047
|
+
**request:** `AgentPhone.GetWebhookV1WebhooksGetRequest`
|
|
1048
|
+
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
|
|
1052
|
+
<dl>
|
|
1053
|
+
<dd>
|
|
1054
|
+
|
|
975
1055
|
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
976
1056
|
|
|
977
1057
|
</dd>
|
|
@@ -1018,7 +1098,9 @@ Set to 0 to disable history in webhooks.
|
|
|
1018
1098
|
|
|
1019
1099
|
```typescript
|
|
1020
1100
|
await client.webhooks.createOrUpdateWebhook({
|
|
1021
|
-
|
|
1101
|
+
body: {
|
|
1102
|
+
url: "url"
|
|
1103
|
+
}
|
|
1022
1104
|
});
|
|
1023
1105
|
|
|
1024
1106
|
```
|
|
@@ -1035,7 +1117,7 @@ await client.webhooks.createOrUpdateWebhook({
|
|
|
1035
1117
|
<dl>
|
|
1036
1118
|
<dd>
|
|
1037
1119
|
|
|
1038
|
-
**request:** `AgentPhone.
|
|
1120
|
+
**request:** `AgentPhone.CreateOrUpdateWebhookV1WebhooksPostRequest`
|
|
1039
1121
|
|
|
1040
1122
|
</dd>
|
|
1041
1123
|
</dl>
|
|
@@ -2306,9 +2388,11 @@ await client.conversations.getConversationMessages({
|
|
|
2306
2388
|
|
|
2307
2389
|
Show a typing indicator in the conversation (iMessage only).
|
|
2308
2390
|
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
|
|
2391
|
+
Works for both 1:1 and group chats: a group id is itself a valid typing
|
|
2392
|
+
target, so every participant sees the indicator. Best-effort: the
|
|
2393
|
+
indicator may be silently dropped if the chat has no recent activity, the
|
|
2394
|
+
recipient isn't on iMessage, or it's RCS-routed (RCS carries no composing
|
|
2395
|
+
state). Auto-expires after a few seconds; no "stop typing" call needed.
|
|
2312
2396
|
</dd>
|
|
2313
2397
|
</dl>
|
|
2314
2398
|
</dd>
|
|
@@ -3491,7 +3575,6 @@ To send a carousel of images on iMessage, pass 2-20 URLs in `media_urls`. Requir
|
|
|
3491
3575
|
|
|
3492
3576
|
```typescript
|
|
3493
3577
|
await client.messages.sendMessage({
|
|
3494
|
-
agent_id: "agent_id",
|
|
3495
3578
|
to_number: "to_number",
|
|
3496
3579
|
body: "body"
|
|
3497
3580
|
});
|
|
@@ -3694,10 +3777,7 @@ Create or replace the iMessage contact card on this number.
|
|
|
3694
3777
|
|
|
3695
3778
|
```typescript
|
|
3696
3779
|
await client.contactCards.putContactCard({
|
|
3697
|
-
number_id: "number_id"
|
|
3698
|
-
firstName: "firstName",
|
|
3699
|
-
lastName: "lastName",
|
|
3700
|
-
avatarUrl: "avatarUrl"
|
|
3780
|
+
number_id: "number_id"
|
|
3701
3781
|
});
|
|
3702
3782
|
|
|
3703
3783
|
```
|
|
@@ -3894,6 +3974,295 @@ await client.registration.registerA2P({
|
|
|
3894
3974
|
</dl>
|
|
3895
3975
|
|
|
3896
3976
|
|
|
3977
|
+
</dd>
|
|
3978
|
+
</dl>
|
|
3979
|
+
</details>
|
|
3980
|
+
|
|
3981
|
+
## SubAccounts
|
|
3982
|
+
<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">listSubAccounts</a>() -> unknown</code></summary>
|
|
3983
|
+
<dl>
|
|
3984
|
+
<dd>
|
|
3985
|
+
|
|
3986
|
+
#### 🔌 Usage
|
|
3987
|
+
|
|
3988
|
+
<dl>
|
|
3989
|
+
<dd>
|
|
3990
|
+
|
|
3991
|
+
<dl>
|
|
3992
|
+
<dd>
|
|
3993
|
+
|
|
3994
|
+
```typescript
|
|
3995
|
+
await client.subAccounts.listSubAccounts();
|
|
3996
|
+
|
|
3997
|
+
```
|
|
3998
|
+
</dd>
|
|
3999
|
+
</dl>
|
|
4000
|
+
</dd>
|
|
4001
|
+
</dl>
|
|
4002
|
+
|
|
4003
|
+
#### ⚙️ Parameters
|
|
4004
|
+
|
|
4005
|
+
<dl>
|
|
4006
|
+
<dd>
|
|
4007
|
+
|
|
4008
|
+
<dl>
|
|
4009
|
+
<dd>
|
|
4010
|
+
|
|
4011
|
+
**requestOptions:** `SubAccountsClient.RequestOptions`
|
|
4012
|
+
|
|
4013
|
+
</dd>
|
|
4014
|
+
</dl>
|
|
4015
|
+
</dd>
|
|
4016
|
+
</dl>
|
|
4017
|
+
|
|
4018
|
+
|
|
4019
|
+
</dd>
|
|
4020
|
+
</dl>
|
|
4021
|
+
</details>
|
|
4022
|
+
|
|
4023
|
+
<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">createSubAccount</a>({ ...params }) -> unknown</code></summary>
|
|
4024
|
+
<dl>
|
|
4025
|
+
<dd>
|
|
4026
|
+
|
|
4027
|
+
#### 🔌 Usage
|
|
4028
|
+
|
|
4029
|
+
<dl>
|
|
4030
|
+
<dd>
|
|
4031
|
+
|
|
4032
|
+
<dl>
|
|
4033
|
+
<dd>
|
|
4034
|
+
|
|
4035
|
+
```typescript
|
|
4036
|
+
await client.subAccounts.createSubAccount({
|
|
4037
|
+
name: "name"
|
|
4038
|
+
});
|
|
4039
|
+
|
|
4040
|
+
```
|
|
4041
|
+
</dd>
|
|
4042
|
+
</dl>
|
|
4043
|
+
</dd>
|
|
4044
|
+
</dl>
|
|
4045
|
+
|
|
4046
|
+
#### ⚙️ Parameters
|
|
4047
|
+
|
|
4048
|
+
<dl>
|
|
4049
|
+
<dd>
|
|
4050
|
+
|
|
4051
|
+
<dl>
|
|
4052
|
+
<dd>
|
|
4053
|
+
|
|
4054
|
+
**request:** `AgentPhone.CreateSubAccountRequest`
|
|
4055
|
+
|
|
4056
|
+
</dd>
|
|
4057
|
+
</dl>
|
|
4058
|
+
|
|
4059
|
+
<dl>
|
|
4060
|
+
<dd>
|
|
4061
|
+
|
|
4062
|
+
**requestOptions:** `SubAccountsClient.RequestOptions`
|
|
4063
|
+
|
|
4064
|
+
</dd>
|
|
4065
|
+
</dl>
|
|
4066
|
+
</dd>
|
|
4067
|
+
</dl>
|
|
4068
|
+
|
|
4069
|
+
|
|
4070
|
+
</dd>
|
|
4071
|
+
</dl>
|
|
4072
|
+
</details>
|
|
4073
|
+
|
|
4074
|
+
<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">deleteSubAccount</a>({ ...params }) -> unknown</code></summary>
|
|
4075
|
+
<dl>
|
|
4076
|
+
<dd>
|
|
4077
|
+
|
|
4078
|
+
#### 🔌 Usage
|
|
4079
|
+
|
|
4080
|
+
<dl>
|
|
4081
|
+
<dd>
|
|
4082
|
+
|
|
4083
|
+
<dl>
|
|
4084
|
+
<dd>
|
|
4085
|
+
|
|
4086
|
+
```typescript
|
|
4087
|
+
await client.subAccounts.deleteSubAccount({
|
|
4088
|
+
sub_account_id: "sub_account_id"
|
|
4089
|
+
});
|
|
4090
|
+
|
|
4091
|
+
```
|
|
4092
|
+
</dd>
|
|
4093
|
+
</dl>
|
|
4094
|
+
</dd>
|
|
4095
|
+
</dl>
|
|
4096
|
+
|
|
4097
|
+
#### ⚙️ Parameters
|
|
4098
|
+
|
|
4099
|
+
<dl>
|
|
4100
|
+
<dd>
|
|
4101
|
+
|
|
4102
|
+
<dl>
|
|
4103
|
+
<dd>
|
|
4104
|
+
|
|
4105
|
+
**request:** `AgentPhone.DeleteSubAccountV1SubAccountsSubAccountIdDeleteRequest`
|
|
4106
|
+
|
|
4107
|
+
</dd>
|
|
4108
|
+
</dl>
|
|
4109
|
+
|
|
4110
|
+
<dl>
|
|
4111
|
+
<dd>
|
|
4112
|
+
|
|
4113
|
+
**requestOptions:** `SubAccountsClient.RequestOptions`
|
|
4114
|
+
|
|
4115
|
+
</dd>
|
|
4116
|
+
</dl>
|
|
4117
|
+
</dd>
|
|
4118
|
+
</dl>
|
|
4119
|
+
|
|
4120
|
+
|
|
4121
|
+
</dd>
|
|
4122
|
+
</dl>
|
|
4123
|
+
</details>
|
|
4124
|
+
|
|
4125
|
+
<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">updateSubAccount</a>({ ...params }) -> unknown</code></summary>
|
|
4126
|
+
<dl>
|
|
4127
|
+
<dd>
|
|
4128
|
+
|
|
4129
|
+
#### 🔌 Usage
|
|
4130
|
+
|
|
4131
|
+
<dl>
|
|
4132
|
+
<dd>
|
|
4133
|
+
|
|
4134
|
+
<dl>
|
|
4135
|
+
<dd>
|
|
4136
|
+
|
|
4137
|
+
```typescript
|
|
4138
|
+
await client.subAccounts.updateSubAccount({
|
|
4139
|
+
sub_account_id: "sub_account_id",
|
|
4140
|
+
name: "name"
|
|
4141
|
+
});
|
|
4142
|
+
|
|
4143
|
+
```
|
|
4144
|
+
</dd>
|
|
4145
|
+
</dl>
|
|
4146
|
+
</dd>
|
|
4147
|
+
</dl>
|
|
4148
|
+
|
|
4149
|
+
#### ⚙️ Parameters
|
|
4150
|
+
|
|
4151
|
+
<dl>
|
|
4152
|
+
<dd>
|
|
4153
|
+
|
|
4154
|
+
<dl>
|
|
4155
|
+
<dd>
|
|
4156
|
+
|
|
4157
|
+
**request:** `AgentPhone.UpdateSubAccountRequest`
|
|
4158
|
+
|
|
4159
|
+
</dd>
|
|
4160
|
+
</dl>
|
|
4161
|
+
|
|
4162
|
+
<dl>
|
|
4163
|
+
<dd>
|
|
4164
|
+
|
|
4165
|
+
**requestOptions:** `SubAccountsClient.RequestOptions`
|
|
4166
|
+
|
|
4167
|
+
</dd>
|
|
4168
|
+
</dl>
|
|
4169
|
+
</dd>
|
|
4170
|
+
</dl>
|
|
4171
|
+
|
|
4172
|
+
|
|
4173
|
+
</dd>
|
|
4174
|
+
</dl>
|
|
4175
|
+
</details>
|
|
4176
|
+
|
|
4177
|
+
## Location
|
|
4178
|
+
<details><summary><code>client.location.<a href="/src/api/resources/location/client/Client.ts">getLocation</a>({ ...params }) -> AgentPhone.LocationResponse</code></summary>
|
|
4179
|
+
<dl>
|
|
4180
|
+
<dd>
|
|
4181
|
+
|
|
4182
|
+
#### 🔌 Usage
|
|
4183
|
+
|
|
4184
|
+
<dl>
|
|
4185
|
+
<dd>
|
|
4186
|
+
|
|
4187
|
+
<dl>
|
|
4188
|
+
<dd>
|
|
4189
|
+
|
|
4190
|
+
```typescript
|
|
4191
|
+
await client.location.getLocation({
|
|
4192
|
+
phone_number: "phone_number"
|
|
4193
|
+
});
|
|
4194
|
+
|
|
4195
|
+
```
|
|
4196
|
+
</dd>
|
|
4197
|
+
</dl>
|
|
4198
|
+
</dd>
|
|
4199
|
+
</dl>
|
|
4200
|
+
|
|
4201
|
+
#### ⚙️ Parameters
|
|
4202
|
+
|
|
4203
|
+
<dl>
|
|
4204
|
+
<dd>
|
|
4205
|
+
|
|
4206
|
+
<dl>
|
|
4207
|
+
<dd>
|
|
4208
|
+
|
|
4209
|
+
**request:** `AgentPhone.GetLocationV1LocationPhoneNumberGetRequest`
|
|
4210
|
+
|
|
4211
|
+
</dd>
|
|
4212
|
+
</dl>
|
|
4213
|
+
|
|
4214
|
+
<dl>
|
|
4215
|
+
<dd>
|
|
4216
|
+
|
|
4217
|
+
**requestOptions:** `LocationClient.RequestOptions`
|
|
4218
|
+
|
|
4219
|
+
</dd>
|
|
4220
|
+
</dl>
|
|
4221
|
+
</dd>
|
|
4222
|
+
</dl>
|
|
4223
|
+
|
|
4224
|
+
|
|
4225
|
+
</dd>
|
|
4226
|
+
</dl>
|
|
4227
|
+
</details>
|
|
4228
|
+
|
|
4229
|
+
<details><summary><code>client.location.<a href="/src/api/resources/location/client/Client.ts">refreshLocations</a>() -> AgentPhone.LocationRefreshResponse</code></summary>
|
|
4230
|
+
<dl>
|
|
4231
|
+
<dd>
|
|
4232
|
+
|
|
4233
|
+
#### 🔌 Usage
|
|
4234
|
+
|
|
4235
|
+
<dl>
|
|
4236
|
+
<dd>
|
|
4237
|
+
|
|
4238
|
+
<dl>
|
|
4239
|
+
<dd>
|
|
4240
|
+
|
|
4241
|
+
```typescript
|
|
4242
|
+
await client.location.refreshLocations();
|
|
4243
|
+
|
|
4244
|
+
```
|
|
4245
|
+
</dd>
|
|
4246
|
+
</dl>
|
|
4247
|
+
</dd>
|
|
4248
|
+
</dl>
|
|
4249
|
+
|
|
4250
|
+
#### ⚙️ Parameters
|
|
4251
|
+
|
|
4252
|
+
<dl>
|
|
4253
|
+
<dd>
|
|
4254
|
+
|
|
4255
|
+
<dl>
|
|
4256
|
+
<dd>
|
|
4257
|
+
|
|
4258
|
+
**requestOptions:** `LocationClient.RequestOptions`
|
|
4259
|
+
|
|
4260
|
+
</dd>
|
|
4261
|
+
</dl>
|
|
4262
|
+
</dd>
|
|
4263
|
+
</dl>
|
|
4264
|
+
|
|
4265
|
+
|
|
3897
4266
|
</dd>
|
|
3898
4267
|
</dl>
|
|
3899
4268
|
</details>
|