agentphone 1.0.15 → 1.0.16

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 (96) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +5 -0
  3. package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +5 -0
  4. package/dist/cjs/api/resources/calls/client/requests/CreateOutboundCallRequest.d.ts +4 -0
  5. package/dist/cjs/api/resources/contacts/client/Client.d.ts +20 -0
  6. package/dist/cjs/api/resources/contacts/client/Client.js +62 -0
  7. package/dist/cjs/api/resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.d.ts +10 -0
  8. package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
  9. package/dist/cjs/api/resources/registration/client/Client.d.ts +36 -9
  10. package/dist/cjs/api/resources/registration/client/Client.js +67 -9
  11. package/dist/cjs/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.d.ts +8 -0
  12. package/dist/cjs/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.js +3 -0
  13. package/dist/cjs/api/resources/registration/client/requests/RegistrationRequest.d.ts +52 -30
  14. package/dist/cjs/api/resources/registration/client/requests/RegistrationRequest.js +9 -0
  15. package/dist/cjs/api/resources/registration/client/requests/index.d.ts +2 -1
  16. package/dist/cjs/api/resources/registration/client/requests/index.js +3 -0
  17. package/dist/cjs/api/resources/subAccounts/client/Client.d.ts +4 -1
  18. package/dist/cjs/api/resources/subAccounts/client/Client.js +23 -10
  19. package/dist/cjs/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.d.ts +8 -0
  20. package/dist/cjs/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.js +3 -0
  21. package/dist/cjs/api/resources/subAccounts/client/requests/index.d.ts +1 -0
  22. package/dist/cjs/api/types/AgentResponse.d.ts +3 -0
  23. package/dist/cjs/api/types/CampaignInclude.d.ts +7 -0
  24. package/dist/cjs/api/types/CampaignInclude.js +10 -0
  25. package/dist/cjs/api/types/CampaignStatusResponse.d.ts +4 -0
  26. package/dist/cjs/api/types/CampaignStatusResponse.js +3 -0
  27. package/dist/cjs/api/types/ContactCapabilitiesResponse.d.ts +6 -0
  28. package/dist/cjs/api/types/ContactCapabilitiesResponse.js +3 -0
  29. package/dist/cjs/api/types/ContactCapabilityFlags.d.ts +4 -0
  30. package/dist/cjs/api/types/ContactCapabilityFlags.js +3 -0
  31. package/dist/cjs/api/types/ContactTitle.d.ts +11 -0
  32. package/dist/cjs/api/types/ContactTitle.js +14 -0
  33. package/dist/cjs/api/types/CustomToolParam.d.ts +28 -0
  34. package/dist/cjs/api/types/CustomToolParam.js +12 -0
  35. package/dist/cjs/api/types/OrganizationType.d.ts +11 -0
  36. package/dist/cjs/api/types/OrganizationType.js +14 -0
  37. package/dist/cjs/api/types/RegistrationResponse.d.ts +2 -3
  38. package/dist/cjs/api/types/UseCase.d.ts +13 -0
  39. package/dist/cjs/api/types/UseCase.js +16 -0
  40. package/dist/cjs/api/types/Volume.d.ts +5 -0
  41. package/dist/cjs/api/types/Volume.js +8 -0
  42. package/dist/cjs/api/types/index.d.ts +9 -1
  43. package/dist/cjs/api/types/index.js +9 -1
  44. package/dist/cjs/version.d.ts +1 -1
  45. package/dist/cjs/version.js +1 -1
  46. package/dist/esm/BaseClient.mjs +2 -2
  47. package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +5 -0
  48. package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +5 -0
  49. package/dist/esm/api/resources/calls/client/requests/CreateOutboundCallRequest.d.mts +4 -0
  50. package/dist/esm/api/resources/contacts/client/Client.d.mts +20 -0
  51. package/dist/esm/api/resources/contacts/client/Client.mjs +62 -0
  52. package/dist/esm/api/resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.d.mts +10 -0
  53. package/dist/esm/api/resources/contacts/client/requests/index.d.mts +1 -0
  54. package/dist/esm/api/resources/registration/client/Client.d.mts +36 -9
  55. package/dist/esm/api/resources/registration/client/Client.mjs +68 -10
  56. package/dist/esm/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.d.mts +8 -0
  57. package/dist/esm/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.mjs +2 -0
  58. package/dist/esm/api/resources/registration/client/requests/RegistrationRequest.d.mts +52 -30
  59. package/dist/esm/api/resources/registration/client/requests/RegistrationRequest.mjs +8 -1
  60. package/dist/esm/api/resources/registration/client/requests/index.d.mts +2 -1
  61. package/dist/esm/api/resources/registration/client/requests/index.mjs +1 -1
  62. package/dist/esm/api/resources/subAccounts/client/Client.d.mts +4 -1
  63. package/dist/esm/api/resources/subAccounts/client/Client.mjs +23 -10
  64. package/dist/esm/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.d.mts +8 -0
  65. package/dist/esm/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.mjs +2 -0
  66. package/dist/esm/api/resources/subAccounts/client/requests/index.d.mts +1 -0
  67. package/dist/esm/api/types/AgentResponse.d.mts +3 -0
  68. package/dist/esm/api/types/CampaignInclude.d.mts +7 -0
  69. package/dist/esm/api/types/CampaignInclude.mjs +7 -0
  70. package/dist/esm/api/types/CampaignStatusResponse.d.mts +4 -0
  71. package/dist/esm/api/types/CampaignStatusResponse.mjs +2 -0
  72. package/dist/esm/api/types/ContactCapabilitiesResponse.d.mts +6 -0
  73. package/dist/esm/api/types/ContactCapabilitiesResponse.mjs +2 -0
  74. package/dist/esm/api/types/ContactCapabilityFlags.d.mts +4 -0
  75. package/dist/esm/api/types/ContactCapabilityFlags.mjs +2 -0
  76. package/dist/esm/api/types/ContactTitle.d.mts +11 -0
  77. package/dist/esm/api/types/ContactTitle.mjs +11 -0
  78. package/dist/esm/api/types/CustomToolParam.d.mts +28 -0
  79. package/dist/esm/api/types/CustomToolParam.mjs +9 -0
  80. package/dist/esm/api/types/OrganizationType.d.mts +11 -0
  81. package/dist/esm/api/types/OrganizationType.mjs +11 -0
  82. package/dist/esm/api/types/RegistrationResponse.d.mts +2 -3
  83. package/dist/esm/api/types/UseCase.d.mts +13 -0
  84. package/dist/esm/api/types/UseCase.mjs +13 -0
  85. package/dist/esm/api/types/Volume.d.mts +5 -0
  86. package/dist/esm/api/types/Volume.mjs +5 -0
  87. package/dist/esm/api/types/index.d.mts +9 -1
  88. package/dist/esm/api/types/index.mjs +9 -1
  89. package/dist/esm/version.d.mts +1 -1
  90. package/dist/esm/version.mjs +1 -1
  91. package/package.json +1 -1
  92. package/reference.md +167 -10
  93. package/dist/cjs/api/types/FieldWarning.d.ts +0 -6
  94. package/dist/esm/api/types/FieldWarning.d.mts +0 -6
  95. /package/dist/cjs/api/{types/FieldWarning.js → resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.js} +0 -0
  96. /package/dist/esm/api/{types/FieldWarning.mjs → resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.mjs} +0 -0
@@ -13,14 +13,19 @@ export * from "./AppRoutesConversationsConversationSummary.mjs";
13
13
  export * from "./AttachNumberResponse.mjs";
14
14
  export * from "./CallListResponse.mjs";
15
15
  export * from "./CallSummary.mjs";
16
+ export * from "./CampaignInclude.mjs";
17
+ export * from "./CampaignStatusResponse.mjs";
18
+ export * from "./ContactCapabilitiesResponse.mjs";
19
+ export * from "./ContactCapabilityFlags.mjs";
16
20
  export * from "./ContactCardResponse.mjs";
17
21
  export * from "./ContactListResponse.mjs";
18
22
  export * from "./ContactResponse.mjs";
23
+ export * from "./ContactTitle.mjs";
19
24
  export * from "./ConversationDetail.mjs";
25
+ export * from "./CustomToolParam.mjs";
20
26
  export * from "./DailyUsagePoint.mjs";
21
27
  export * from "./DailyUsageResponse.mjs";
22
28
  export * from "./DeleteAgentResponse.mjs";
23
- export * from "./FieldWarning.mjs";
24
29
  export * from "./GroupParticipant.mjs";
25
30
  export * from "./HttpValidationError.mjs";
26
31
  export * from "./LocationRefreshResponse.mjs";
@@ -34,6 +39,7 @@ export * from "./MonthlyUsageResponse.mjs";
34
39
  export * from "./NumberLimits.mjs";
35
40
  export * from "./NumberUsageItem.mjs";
36
41
  export * from "./NumberUsageResponse.mjs";
42
+ export * from "./OrganizationType.mjs";
37
43
  export * from "./PaginatedDeliveriesResponse.mjs";
38
44
  export * from "./PhoneNumberListResponse.mjs";
39
45
  export * from "./PhoneNumberResponse.mjs";
@@ -48,7 +54,9 @@ export * from "./SendTypingResponse.mjs";
48
54
  export * from "./SetBackgroundResponse.mjs";
49
55
  export * from "./UsageResponse.mjs";
50
56
  export * from "./UsageStats.mjs";
57
+ export * from "./UseCase.mjs";
51
58
  export * from "./ValidationError.mjs";
59
+ export * from "./Volume.mjs";
52
60
  export * from "./WebhookCreateRequest.mjs";
53
61
  export * from "./WebhookDeliveryResponse.mjs";
54
62
  export * from "./WebhookDeliveryStatsResponse.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.0.15";
1
+ export declare const SDK_VERSION = "1.0.16";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.0.15";
1
+ export const SDK_VERSION = "1.0.16";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentphone",
3
- "version": "1.0.15",
3
+ "version": "1.0.16",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -1902,6 +1902,76 @@ await client.contacts.createContact({
1902
1902
  </dl>
1903
1903
 
1904
1904
 
1905
+ </dd>
1906
+ </dl>
1907
+ </details>
1908
+
1909
+ <details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getContactCapabilities</a>({ ...params }) -> AgentPhone.ContactCapabilitiesResponse</code></summary>
1910
+ <dl>
1911
+ <dd>
1912
+
1913
+ #### 📝 Description
1914
+
1915
+ <dl>
1916
+ <dd>
1917
+
1918
+ <dl>
1919
+ <dd>
1920
+
1921
+ Check which messaging channels a phone number supports, without sending
1922
+ a message.
1923
+
1924
+ Runs a live check (typically 1-2 seconds), so the result reflects the
1925
+ number right now. Capabilities can still change by the time you send.
1926
+ Requires at least one active iMessage-capable number on the account.
1927
+ </dd>
1928
+ </dl>
1929
+ </dd>
1930
+ </dl>
1931
+
1932
+ #### 🔌 Usage
1933
+
1934
+ <dl>
1935
+ <dd>
1936
+
1937
+ <dl>
1938
+ <dd>
1939
+
1940
+ ```typescript
1941
+ await client.contacts.getContactCapabilities({
1942
+ phone_number: "phone_number"
1943
+ });
1944
+
1945
+ ```
1946
+ </dd>
1947
+ </dl>
1948
+ </dd>
1949
+ </dl>
1950
+
1951
+ #### ⚙️ Parameters
1952
+
1953
+ <dl>
1954
+ <dd>
1955
+
1956
+ <dl>
1957
+ <dd>
1958
+
1959
+ **request:** `AgentPhone.GetContactCapabilitiesV1ContactsCapabilitiesGetRequest`
1960
+
1961
+ </dd>
1962
+ </dl>
1963
+
1964
+ <dl>
1965
+ <dd>
1966
+
1967
+ **requestOptions:** `ContactsClient.RequestOptions`
1968
+
1969
+ </dd>
1970
+ </dl>
1971
+ </dd>
1972
+ </dl>
1973
+
1974
+
1905
1975
  </dd>
1906
1976
  </dl>
1907
1977
  </details>
@@ -3881,6 +3951,79 @@ await client.contactCards.deleteContactCard({
3881
3951
  </details>
3882
3952
 
3883
3953
  ## Registration
3954
+ <details><summary><code>client.registration.<a href="/src/api/resources/registration/client/Client.ts">getRegistrationStatus</a>({ ...params }) -> AgentPhone.CampaignStatusResponse</code></summary>
3955
+ <dl>
3956
+ <dd>
3957
+
3958
+ #### 📝 Description
3959
+
3960
+ <dl>
3961
+ <dd>
3962
+
3963
+ <dl>
3964
+ <dd>
3965
+
3966
+ Check the status of your A2P 10DLC registration.
3967
+
3968
+ ### Sub-account status
3969
+
3970
+ To check the registration status of a sub-account, pass the `X-Sub-Account-Id` header with the sub-account ID returned from `POST /v1/register`.
3971
+
3972
+ ### Possible statuses
3973
+
3974
+ - `none` -- No registration submitted.
3975
+ - `pending` -- Registration is under review.
3976
+ - `approved` -- Registration approved. Your account is ready to send messages.
3977
+ </dd>
3978
+ </dl>
3979
+ </dd>
3980
+ </dl>
3981
+
3982
+ #### 🔌 Usage
3983
+
3984
+ <dl>
3985
+ <dd>
3986
+
3987
+ <dl>
3988
+ <dd>
3989
+
3990
+ ```typescript
3991
+ await client.registration.getRegistrationStatus();
3992
+
3993
+ ```
3994
+ </dd>
3995
+ </dl>
3996
+ </dd>
3997
+ </dl>
3998
+
3999
+ #### ⚙️ Parameters
4000
+
4001
+ <dl>
4002
+ <dd>
4003
+
4004
+ <dl>
4005
+ <dd>
4006
+
4007
+ **request:** `AgentPhone.GetRegistrationStatusV1RegisterStatusGetRequest`
4008
+
4009
+ </dd>
4010
+ </dl>
4011
+
4012
+ <dl>
4013
+ <dd>
4014
+
4015
+ **requestOptions:** `RegistrationClient.RequestOptions`
4016
+
4017
+ </dd>
4018
+ </dl>
4019
+ </dd>
4020
+ </dl>
4021
+
4022
+
4023
+ </dd>
4024
+ </dl>
4025
+ </details>
4026
+
3884
4027
  <details><summary><code>client.registration.<a href="/src/api/resources/registration/client/Client.ts">registerA2P</a>({ ...params }) -> AgentPhone.RegistrationResponse</code></summary>
3885
4028
  <dl>
3886
4029
  <dd>
@@ -3900,15 +4043,18 @@ US carriers require 10DLC registration before your AI agent can send text messag
3900
4043
  ### How it works
3901
4044
 
3902
4045
  1. Submit your registration details via this endpoint
3903
- 2. We validate your submission and flag any issues (RED = blocked, YELLOW = warning)
3904
- 3. On success, you receive a Stripe payment URL to pay the one-time registration fee
3905
- 4. After payment, we submit your registration to the carriers on your behalf
3906
- 5. Carrier approval typically takes 7-10 business days
4046
+ 2. A one-time $25 registration fee is deducted from your account balance
4047
+ 3. We submit your registration to the carriers on your behalf
4048
+ 4. Carrier approval typically takes 7-10 business days
3907
4049
 
3908
4050
  ### Registration types
3909
4051
 
3910
- - **`sole_proprietor`** For individuals or small businesses. Simpler requirements, fewer fields.
3911
- - **`standard_brand`** For established businesses. Requires `business_name`, `privacy_policy_url`, `terms_of_service_url`, `sample_message_1`, and `sample_message_2`.
4052
+ - **`sole_proprietor`** -- For individuals or small businesses. Simpler requirements, fewer fields.
4053
+ - **`standard_brand`** -- For established businesses. Requires `business_name`, `organization_type`, `ein`, `privacy_policy_url`, `terms_of_service_url`.
4054
+
4055
+ ### Sub-accounts
4056
+
4057
+ Parent accounts can set `create_sub_account: true` (the default) to create a dedicated sub-account for each registration. This lets you manage multiple campaigns independently. The $25 fee is always charged to the parent account.
3912
4058
 
3913
4059
  ### Opt-in image
3914
4060
 
@@ -3916,7 +4062,7 @@ US carriers require 10DLC registration before your AI agent can send text messag
3916
4062
 
3917
4063
  ### Re-submitting
3918
4064
 
3919
- If you've already submitted but haven't completed payment, calling this endpoint again returns the payment URL without re-sending the registration email.
4065
+ If your previous registration was rejected, you can call this endpoint again to re-register.
3920
4066
  </dd>
3921
4067
  </dl>
3922
4068
  </dd>
@@ -3932,7 +4078,7 @@ If you've already submitted but haven't completed payment, calling this endpoint
3932
4078
 
3933
4079
  ```typescript
3934
4080
  await client.registration.registerA2P({
3935
- registration_type: "registration_type",
4081
+ registration_type: "sole_proprietor",
3936
4082
  first_name: "first_name",
3937
4083
  last_name: "last_name",
3938
4084
  email: "email",
@@ -3941,7 +4087,10 @@ await client.registration.registerA2P({
3941
4087
  city: "city",
3942
4088
  state: "state",
3943
4089
  zip_code: "zip_code",
3944
- use_case_description: "use_case_description",
4090
+ description: "description",
4091
+ use_cases: ["account_notification"],
4092
+ message_samples: ["message_samples"],
4093
+ consent_flow: "consent_flow",
3945
4094
  opt_in_image_url: "opt_in_image_url"
3946
4095
  });
3947
4096
 
@@ -3980,7 +4129,7 @@ await client.registration.registerA2P({
3980
4129
  </details>
3981
4130
 
3982
4131
  ## SubAccounts
3983
- <details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">listSubAccounts</a>() -> unknown</code></summary>
4132
+ <details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">listSubAccounts</a>({ ...params }) -> unknown</code></summary>
3984
4133
  <dl>
3985
4134
  <dd>
3986
4135
 
@@ -4009,6 +4158,14 @@ await client.subAccounts.listSubAccounts();
4009
4158
  <dl>
4010
4159
  <dd>
4011
4160
 
4161
+ **request:** `AgentPhone.ListSubAccountsV1SubAccountsGetRequest`
4162
+
4163
+ </dd>
4164
+ </dl>
4165
+
4166
+ <dl>
4167
+ <dd>
4168
+
4012
4169
  **requestOptions:** `SubAccountsClient.RequestOptions`
4013
4170
 
4014
4171
  </dd>
@@ -1,6 +0,0 @@
1
- export interface FieldWarning {
2
- field: string;
3
- tier: string;
4
- message: string;
5
- suggestion: string;
6
- }
@@ -1,6 +0,0 @@
1
- export interface FieldWarning {
2
- field: string;
3
- tier: string;
4
- message: string;
5
- suggestion: string;
6
- }