@surgeapi/node 0.25.3 → 0.25.4

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 (119) hide show
  1. package/Client.d.ts +6 -0
  2. package/Client.js +20 -10
  3. package/README.md +3 -5
  4. package/api/index.d.ts +1 -1
  5. package/api/index.js +1 -1
  6. package/api/resources/accounts/client/Client.d.ts +57 -0
  7. package/api/resources/accounts/client/Client.js +167 -0
  8. package/api/resources/accounts/client/index.d.ts +1 -0
  9. package/api/resources/accounts/client/index.js +17 -0
  10. package/api/resources/accounts/client/requests/CreateAccountRequest.d.ts +16 -0
  11. package/api/resources/accounts/client/requests/CreateAccountRequest.js +5 -0
  12. package/api/resources/accounts/client/requests/UpdateAccountRequest.d.ts +16 -0
  13. package/api/resources/accounts/client/requests/UpdateAccountRequest.js +5 -0
  14. package/api/resources/accounts/client/requests/index.d.ts +2 -0
  15. package/api/resources/accounts/client/requests/index.js +2 -0
  16. package/api/resources/accounts/index.d.ts +1 -0
  17. package/api/resources/accounts/index.js +17 -0
  18. package/api/resources/blasts/client/Client.js +1 -1
  19. package/api/resources/contacts/client/Client.d.ts +2 -2
  20. package/api/resources/contacts/client/Client.js +7 -7
  21. package/api/resources/index.d.ts +5 -0
  22. package/api/resources/index.js +6 -1
  23. package/api/resources/messages/client/Client.d.ts +1 -3
  24. package/api/resources/messages/client/Client.js +2 -4
  25. package/api/resources/messages/client/requests/MessageRequest.d.ts +3 -3
  26. package/api/resources/phoneNumbers/client/Client.d.ts +44 -0
  27. package/api/resources/phoneNumbers/client/Client.js +117 -0
  28. package/api/resources/phoneNumbers/client/index.d.ts +1 -0
  29. package/api/resources/phoneNumbers/client/index.js +17 -0
  30. package/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.d.ts +17 -0
  31. package/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.js +5 -0
  32. package/api/resources/phoneNumbers/client/requests/index.d.ts +1 -0
  33. package/api/resources/phoneNumbers/client/requests/index.js +2 -0
  34. package/api/resources/phoneNumbers/index.d.ts +2 -0
  35. package/api/resources/phoneNumbers/index.js +18 -0
  36. package/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.d.ts +11 -0
  37. package/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.js +10 -0
  38. package/api/resources/phoneNumbers/types/index.d.ts +1 -0
  39. package/api/resources/phoneNumbers/types/index.js +17 -0
  40. package/api/resources/users/client/Client.d.ts +2 -2
  41. package/api/resources/users/client/Client.js +4 -4
  42. package/api/resources/verifications/client/Client.js +2 -2
  43. package/api/types/AccountResponse.d.ts +14 -0
  44. package/api/types/AccountResponse.js +5 -0
  45. package/api/types/Conversation.d.ts +1 -0
  46. package/api/types/ConversationPhoneNumber.d.ts +15 -0
  47. package/api/types/ConversationPhoneNumber.js +5 -0
  48. package/api/types/ConversationPhoneNumberType.d.ts +13 -0
  49. package/api/types/ConversationPhoneNumberType.js +12 -0
  50. package/api/types/MessageConversationContactParams.d.ts +0 -2
  51. package/api/types/MessageConversationParams.d.ts +3 -3
  52. package/api/types/PhoneNumber.d.ts +15 -0
  53. package/api/types/PhoneNumber.js +5 -0
  54. package/api/types/PhoneNumberType.d.ts +11 -0
  55. package/api/types/PhoneNumberType.js +10 -0
  56. package/api/types/index.d.ts +5 -0
  57. package/api/types/index.js +5 -0
  58. package/dist/Client.d.ts +6 -0
  59. package/dist/Client.js +20 -10
  60. package/dist/api/index.d.ts +1 -1
  61. package/dist/api/index.js +1 -1
  62. package/dist/api/resources/accounts/client/Client.d.ts +57 -0
  63. package/dist/api/resources/accounts/client/Client.js +167 -0
  64. package/dist/api/resources/accounts/client/index.d.ts +1 -0
  65. package/dist/api/resources/accounts/client/index.js +17 -0
  66. package/dist/api/resources/accounts/client/requests/CreateAccountRequest.d.ts +16 -0
  67. package/dist/api/resources/accounts/client/requests/CreateAccountRequest.js +5 -0
  68. package/dist/api/resources/accounts/client/requests/UpdateAccountRequest.d.ts +16 -0
  69. package/dist/api/resources/accounts/client/requests/UpdateAccountRequest.js +5 -0
  70. package/dist/api/resources/accounts/client/requests/index.d.ts +2 -0
  71. package/dist/api/resources/accounts/client/requests/index.js +2 -0
  72. package/dist/api/resources/accounts/index.d.ts +1 -0
  73. package/dist/api/resources/accounts/index.js +17 -0
  74. package/dist/api/resources/blasts/client/Client.js +1 -1
  75. package/dist/api/resources/contacts/client/Client.d.ts +2 -2
  76. package/dist/api/resources/contacts/client/Client.js +7 -7
  77. package/dist/api/resources/index.d.ts +5 -0
  78. package/dist/api/resources/index.js +6 -1
  79. package/dist/api/resources/messages/client/Client.d.ts +1 -3
  80. package/dist/api/resources/messages/client/Client.js +2 -4
  81. package/dist/api/resources/messages/client/requests/MessageRequest.d.ts +3 -3
  82. package/dist/api/resources/phoneNumbers/client/Client.d.ts +44 -0
  83. package/dist/api/resources/phoneNumbers/client/Client.js +117 -0
  84. package/dist/api/resources/phoneNumbers/client/index.d.ts +1 -0
  85. package/dist/api/resources/phoneNumbers/client/index.js +17 -0
  86. package/dist/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.d.ts +17 -0
  87. package/dist/api/resources/phoneNumbers/client/requests/CreatePhoneNumberRequest.js +5 -0
  88. package/dist/api/resources/phoneNumbers/client/requests/index.d.ts +1 -0
  89. package/dist/api/resources/phoneNumbers/client/requests/index.js +2 -0
  90. package/dist/api/resources/phoneNumbers/index.d.ts +2 -0
  91. package/dist/api/resources/phoneNumbers/index.js +18 -0
  92. package/dist/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.d.ts +11 -0
  93. package/dist/api/resources/phoneNumbers/types/CreatePhoneNumberRequestType.js +10 -0
  94. package/dist/api/resources/phoneNumbers/types/index.d.ts +1 -0
  95. package/dist/api/resources/phoneNumbers/types/index.js +17 -0
  96. package/dist/api/resources/users/client/Client.d.ts +2 -2
  97. package/dist/api/resources/users/client/Client.js +4 -4
  98. package/dist/api/resources/verifications/client/Client.js +2 -2
  99. package/dist/api/types/AccountResponse.d.ts +14 -0
  100. package/dist/api/types/AccountResponse.js +5 -0
  101. package/dist/api/types/Conversation.d.ts +1 -0
  102. package/dist/api/types/ConversationPhoneNumber.d.ts +15 -0
  103. package/dist/api/types/ConversationPhoneNumber.js +5 -0
  104. package/dist/api/types/ConversationPhoneNumberType.d.ts +13 -0
  105. package/dist/api/types/ConversationPhoneNumberType.js +12 -0
  106. package/dist/api/types/MessageConversationContactParams.d.ts +0 -2
  107. package/dist/api/types/MessageConversationParams.d.ts +3 -3
  108. package/dist/api/types/PhoneNumber.d.ts +15 -0
  109. package/dist/api/types/PhoneNumber.js +5 -0
  110. package/dist/api/types/PhoneNumberType.d.ts +11 -0
  111. package/dist/api/types/PhoneNumberType.js +10 -0
  112. package/dist/api/types/index.d.ts +5 -0
  113. package/dist/api/types/index.js +5 -0
  114. package/dist/version.d.ts +1 -1
  115. package/dist/version.js +1 -1
  116. package/package.json +2 -2
  117. package/reference.md +222 -6
  118. package/version.d.ts +1 -1
  119. package/version.js +1 -1
package/reference.md CHANGED
@@ -1,5 +1,147 @@
1
1
  # Reference
2
2
 
3
+ ## Accounts
4
+
5
+ <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">create</a>({ ...params }) -> Surge.AccountResponse</code></summary>
6
+ <dl>
7
+ <dd>
8
+
9
+ #### 📝 Description
10
+
11
+ <dl>
12
+ <dd>
13
+
14
+ <dl>
15
+ <dd>
16
+
17
+ Creates a new Account within the calling Platform.
18
+
19
+ </dd>
20
+ </dl>
21
+ </dd>
22
+ </dl>
23
+
24
+ #### 🔌 Usage
25
+
26
+ <dl>
27
+ <dd>
28
+
29
+ <dl>
30
+ <dd>
31
+
32
+ ```typescript
33
+ await client.accounts.create({
34
+ name: "D\u00B7T Precision Auto Shop",
35
+ time_zone: "America/Los_Angeles",
36
+ });
37
+ ```
38
+
39
+ </dd>
40
+ </dl>
41
+ </dd>
42
+ </dl>
43
+
44
+ #### ⚙️ Parameters
45
+
46
+ <dl>
47
+ <dd>
48
+
49
+ <dl>
50
+ <dd>
51
+
52
+ **request:** `Surge.CreateAccountRequest`
53
+
54
+ </dd>
55
+ </dl>
56
+
57
+ <dl>
58
+ <dd>
59
+
60
+ **requestOptions:** `Accounts.RequestOptions`
61
+
62
+ </dd>
63
+ </dl>
64
+ </dd>
65
+ </dl>
66
+
67
+ </dd>
68
+ </dl>
69
+ </details>
70
+
71
+ <details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">update</a>(id, { ...params }) -> Surge.AccountResponse</code></summary>
72
+ <dl>
73
+ <dd>
74
+
75
+ #### 📝 Description
76
+
77
+ <dl>
78
+ <dd>
79
+
80
+ <dl>
81
+ <dd>
82
+
83
+ Updates an Account
84
+
85
+ </dd>
86
+ </dl>
87
+ </dd>
88
+ </dl>
89
+
90
+ #### 🔌 Usage
91
+
92
+ <dl>
93
+ <dd>
94
+
95
+ <dl>
96
+ <dd>
97
+
98
+ ```typescript
99
+ await client.accounts.update("acct_01jpqjvfg9enpt7pyxd60pcmxj", {
100
+ name: "D\u00B7T Precision Auto Shop",
101
+ time_zone: "America/Los_Angeles",
102
+ });
103
+ ```
104
+
105
+ </dd>
106
+ </dl>
107
+ </dd>
108
+ </dl>
109
+
110
+ #### ⚙️ Parameters
111
+
112
+ <dl>
113
+ <dd>
114
+
115
+ <dl>
116
+ <dd>
117
+
118
+ **id:** `string` —
119
+
120
+ </dd>
121
+ </dl>
122
+
123
+ <dl>
124
+ <dd>
125
+
126
+ **request:** `Surge.UpdateAccountRequest`
127
+
128
+ </dd>
129
+ </dl>
130
+
131
+ <dl>
132
+ <dd>
133
+
134
+ **requestOptions:** `Accounts.RequestOptions`
135
+
136
+ </dd>
137
+ </dl>
138
+ </dd>
139
+ </dl>
140
+
141
+ </dd>
142
+ </dl>
143
+ </details>
144
+
3
145
  ## Blasts
4
146
 
5
147
  <details><summary><code>client.blasts.<a href="/src/api/resources/blasts/client/Client.ts">send</a>(accountId, { ...params }) -> Surge.BlastResponse</code></summary>
@@ -165,7 +307,7 @@ await client.contacts.create("acct_01j9a43avnfqzbjfch6pygv1td", {
165
307
  </dl>
166
308
  </details>
167
309
 
168
- <details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">surgeWebContactControllerShow</a>(id) -> Surge.ContactResponse</code></summary>
310
+ <details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getContact</a>(id) -> Surge.ContactResponse</code></summary>
169
311
  <dl>
170
312
  <dd>
171
313
 
@@ -193,7 +335,7 @@ Retrieves a Contact object.
193
335
  <dd>
194
336
 
195
337
  ```typescript
196
- await client.contacts.surgeWebContactControllerShow("ctc_01j9dy8mdzfn3r0e8x1tbdrdrf");
338
+ await client.contacts.getContact("ctc_01j9dy8mdzfn3r0e8x1tbdrdrf");
197
339
  ```
198
340
 
199
341
  </dd>
@@ -347,11 +489,9 @@ await client.messages.send("acct_01j9a43avnfqzbjfch6pygv1td", {
347
489
  conversation: {
348
490
  contact: {
349
491
  first_name: "Dominic",
350
- id: "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
351
492
  last_name: "Toretto",
352
493
  phone_number: "+18015551234",
353
494
  },
354
- id: "cnv_01j9e0dgmdfkj86c877ws0znae",
355
495
  },
356
496
  });
357
497
  ```
@@ -396,6 +536,82 @@ await client.messages.send("acct_01j9a43avnfqzbjfch6pygv1td", {
396
536
  </dl>
397
537
  </details>
398
538
 
539
+ ## PhoneNumbers
540
+
541
+ <details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">create</a>(accountId, { ...params }) -> Surge.PhoneNumber</code></summary>
542
+ <dl>
543
+ <dd>
544
+
545
+ #### 📝 Description
546
+
547
+ <dl>
548
+ <dd>
549
+
550
+ <dl>
551
+ <dd>
552
+
553
+ Create a new phone number for the account.
554
+
555
+ </dd>
556
+ </dl>
557
+ </dd>
558
+ </dl>
559
+
560
+ #### 🔌 Usage
561
+
562
+ <dl>
563
+ <dd>
564
+
565
+ <dl>
566
+ <dd>
567
+
568
+ ```typescript
569
+ await client.phoneNumbers.create("acct_01j9a43avnfqzbjfch6pygv1td", {
570
+ area_code: "801",
571
+ type: "local",
572
+ });
573
+ ```
574
+
575
+ </dd>
576
+ </dl>
577
+ </dd>
578
+ </dl>
579
+
580
+ #### ⚙️ Parameters
581
+
582
+ <dl>
583
+ <dd>
584
+
585
+ <dl>
586
+ <dd>
587
+
588
+ **accountId:** `string` — The account for which the phone number should be created.
589
+
590
+ </dd>
591
+ </dl>
592
+
593
+ <dl>
594
+ <dd>
595
+
596
+ **request:** `Surge.CreatePhoneNumberRequest`
597
+
598
+ </dd>
599
+ </dl>
600
+
601
+ <dl>
602
+ <dd>
603
+
604
+ **requestOptions:** `PhoneNumbers.RequestOptions`
605
+
606
+ </dd>
607
+ </dl>
608
+ </dd>
609
+ </dl>
610
+
611
+ </dd>
612
+ </dl>
613
+ </details>
614
+
399
615
  ## Users
400
616
 
401
617
  <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">create</a>(accountId, { ...params }) -> Surge.UserResponse</code></summary>
@@ -477,7 +693,7 @@ await client.users.create("acct_01j9a43avnfqzbjfch6pygv1td", {
477
693
  </dl>
478
694
  </details>
479
695
 
480
- <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">surgeWebUserControllerShow</a>(id) -> Surge.UserResponse</code></summary>
696
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUser</a>(id) -> Surge.UserResponse</code></summary>
481
697
  <dl>
482
698
  <dd>
483
699
 
@@ -505,7 +721,7 @@ Retrieves a User object.
505
721
  <dd>
506
722
 
507
723
  ```typescript
508
- await client.users.surgeWebUserControllerShow("usr_01j9dwavghe1ttppewekjjkfrx");
724
+ await client.users.getUser("usr_01j9dwavghe1ttppewekjjkfrx");
509
725
  ```
510
726
 
511
727
  </dd>
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.25.3";
1
+ export declare const SDK_VERSION = "0.25.4";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.25.3";
4
+ exports.SDK_VERSION = "0.25.4";