@carbonvoice/cv-mcp-server 2.8.16 → 2.8.17

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 (255) hide show
  1. package/dist/generated/carbon-voice-api/CarbonVoiceSimplifiedAPI.zod.js +792 -126
  2. package/dist/generated/carbon-voice-api/CarbonVoiceSimplifiedAPI.zod.js.map +1 -1
  3. package/dist/generated/carbon-voice-api.js +225 -7
  4. package/dist/generated/carbon-voice-api.js.map +1 -1
  5. package/dist/generated/models/AIPromptControllerGetPromptsOwnerType.js +22 -49
  6. package/dist/generated/models/AIPromptControllerGetPromptsOwnerType.js.map +1 -1
  7. package/dist/generated/models/AIPromptOwnerType.js +22 -49
  8. package/dist/generated/models/AIPromptOwnerType.js.map +1 -1
  9. package/dist/generated/models/AIResponseControllerGetAllResponsesDirection.js +22 -49
  10. package/dist/generated/models/AIResponseControllerGetAllResponsesDirection.js.map +1 -1
  11. package/dist/generated/models/ActionItem.js +3 -0
  12. package/dist/generated/models/ActionItem.js.map +1 -0
  13. package/dist/generated/models/ActionItemContainerType.js +61 -0
  14. package/dist/generated/models/ActionItemContainerType.js.map +1 -0
  15. package/dist/generated/models/ActionItemControllerListDirection.js +60 -0
  16. package/dist/generated/models/ActionItemControllerListDirection.js.map +1 -0
  17. package/dist/generated/models/ActionItemControllerListIdsDirection.js +60 -0
  18. package/dist/generated/models/ActionItemControllerListIdsDirection.js.map +1 -0
  19. package/dist/generated/models/ActionItemControllerListIdsParams.js +3 -0
  20. package/dist/generated/models/ActionItemControllerListIdsParams.js.map +1 -0
  21. package/dist/generated/models/ActionItemControllerListMyActionItemsDirection.js +60 -0
  22. package/dist/generated/models/ActionItemControllerListMyActionItemsDirection.js.map +1 -0
  23. package/dist/generated/models/ActionItemControllerListMyActionItemsParams.js +3 -0
  24. package/dist/generated/models/ActionItemControllerListMyActionItemsParams.js.map +1 -0
  25. package/dist/generated/models/ActionItemControllerListParams.js +3 -0
  26. package/dist/generated/models/ActionItemControllerListParams.js.map +1 -0
  27. package/dist/generated/models/ActionItemStatus.js +61 -0
  28. package/dist/generated/models/ActionItemStatus.js.map +1 -0
  29. package/dist/generated/models/ActionMetadata.js +54 -0
  30. package/dist/generated/models/ActionMetadata.js.map +1 -0
  31. package/dist/generated/models/AddConversationUsers.js +3 -0
  32. package/dist/generated/models/AddConversationUsers.js.map +1 -0
  33. package/dist/generated/models/AddLinkAttachmentPayload.js +22 -49
  34. package/dist/generated/models/AddLinkAttachmentPayload.js.map +1 -1
  35. package/dist/generated/models/AddMessageToFolderPayload.js +22 -49
  36. package/dist/generated/models/AddMessageToFolderPayload.js.map +1 -1
  37. package/dist/generated/models/AppWebhooksAuthenticationHeader.js +22 -49
  38. package/dist/generated/models/AppWebhooksAuthenticationHeader.js.map +1 -1
  39. package/dist/generated/models/AppWebhooksUrlMode.js +22 -49
  40. package/dist/generated/models/AppWebhooksUrlMode.js.map +1 -1
  41. package/dist/generated/models/AttachmentLocation.js +0 -78
  42. package/dist/generated/models/AttachmentLocation.js.map +1 -1
  43. package/dist/generated/models/AttachmentStatus.js +62 -0
  44. package/dist/generated/models/AttachmentStatus.js.map +1 -0
  45. package/dist/generated/models/AttachmentStatusProperty.js +3 -0
  46. package/dist/generated/models/AttachmentStatusProperty.js.map +1 -0
  47. package/dist/generated/models/AttachmentType.js +23 -49
  48. package/dist/generated/models/AttachmentType.js.map +1 -1
  49. package/dist/generated/models/AudioDelivery.js +60 -0
  50. package/dist/generated/models/AudioDelivery.js.map +1 -0
  51. package/dist/generated/models/AudioModelV2.js +22 -49
  52. package/dist/generated/models/AudioModelV2.js.map +1 -1
  53. package/dist/generated/models/CaughtUpStatus.js +61 -0
  54. package/dist/generated/models/CaughtUpStatus.js.map +1 -0
  55. package/dist/generated/models/ConversationMatch.js +60 -0
  56. package/dist/generated/models/ConversationMatch.js.map +1 -0
  57. package/dist/generated/models/ConversationResponseType.js +22 -49
  58. package/dist/generated/models/ConversationResponseType.js.map +1 -1
  59. package/dist/generated/models/ConversationType.js +22 -49
  60. package/dist/generated/models/ConversationType.js.map +1 -1
  61. package/dist/generated/models/ConversationUsersInput.js +54 -0
  62. package/dist/generated/models/ConversationUsersInput.js.map +1 -0
  63. package/dist/generated/models/ConversationVisibility.js +22 -49
  64. package/dist/generated/models/ConversationVisibility.js.map +1 -1
  65. package/dist/generated/models/CreateAIResponse.js +22 -49
  66. package/dist/generated/models/CreateAIResponse.js.map +1 -1
  67. package/dist/generated/models/CreateActionItemPayload.js +3 -0
  68. package/dist/generated/models/CreateActionItemPayload.js.map +1 -0
  69. package/dist/generated/models/CreateConversationMessageFromMessageType.js +23 -49
  70. package/dist/generated/models/CreateConversationMessageFromMessageType.js.map +1 -1
  71. package/dist/generated/models/CreateFolderPayloadType.js +22 -49
  72. package/dist/generated/models/CreateFolderPayloadType.js.map +1 -1
  73. package/dist/generated/models/CreateMessageShareLink.js +3 -0
  74. package/dist/generated/models/CreateMessageShareLink.js.map +1 -0
  75. package/dist/generated/models/CreateMessageShareLinkAccessType.js +61 -0
  76. package/dist/generated/models/CreateMessageShareLinkAccessType.js.map +1 -0
  77. package/dist/generated/models/CreateMessageShareLinkShareType.js +60 -0
  78. package/dist/generated/models/CreateMessageShareLinkShareType.js.map +1 -0
  79. package/dist/generated/models/CreateShareLinkAIResponse.js +22 -49
  80. package/dist/generated/models/CreateShareLinkAIResponse.js.map +1 -1
  81. package/dist/generated/models/CreateSuggestionsFromMessagesPayload.js +54 -0
  82. package/dist/generated/models/CreateSuggestionsFromMessagesPayload.js.map +1 -0
  83. package/dist/generated/models/CreateVoicememoMessage.js +22 -49
  84. package/dist/generated/models/CreateVoicememoMessage.js.map +1 -1
  85. package/dist/generated/models/FolderType.js +22 -49
  86. package/dist/generated/models/FolderType.js.map +1 -1
  87. package/dist/generated/models/Gender.js +60 -0
  88. package/dist/generated/models/Gender.js.map +1 -0
  89. package/dist/generated/models/GetAIResponsesByIds.js +54 -0
  90. package/dist/generated/models/GetAIResponsesByIds.js.map +1 -0
  91. package/dist/generated/models/GetActionItemsByIdsPayload.js +54 -0
  92. package/dist/generated/models/GetActionItemsByIdsPayload.js.map +1 -0
  93. package/dist/generated/models/GetAllConversationsParams.js +3 -0
  94. package/dist/generated/models/GetAllConversationsParams.js.map +1 -0
  95. package/dist/generated/models/GetAllRootFoldersSortDirection.js +22 -49
  96. package/dist/generated/models/GetAllRootFoldersSortDirection.js.map +1 -1
  97. package/dist/generated/models/GetAllRootFoldersType.js +22 -49
  98. package/dist/generated/models/GetAllRootFoldersType.js.map +1 -1
  99. package/dist/generated/models/GetCountsGroupedByWorkspaceType.js +22 -49
  100. package/dist/generated/models/GetCountsGroupedByWorkspaceType.js.map +1 -1
  101. package/dist/generated/models/GetFolderByIdDirection.js +22 -49
  102. package/dist/generated/models/GetFolderByIdDirection.js.map +1 -1
  103. package/dist/generated/models/GetMessageByIdParams.js +22 -49
  104. package/dist/generated/models/GetMessageByIdParams.js.map +1 -1
  105. package/dist/generated/models/GetTenRecentMessagesResponseParams.js +22 -49
  106. package/dist/generated/models/GetTenRecentMessagesResponseParams.js.map +1 -1
  107. package/dist/generated/models/IdResponse.js +54 -0
  108. package/dist/generated/models/IdResponse.js.map +1 -0
  109. package/dist/generated/models/LatLon.js +54 -0
  110. package/dist/generated/models/LatLon.js.map +1 -0
  111. package/dist/generated/models/ListActionItemsFilters.js +3 -0
  112. package/dist/generated/models/ListActionItemsFilters.js.map +1 -0
  113. package/dist/generated/models/ListActionItemsFiltersDirection.js +60 -0
  114. package/dist/generated/models/ListActionItemsFiltersDirection.js.map +1 -0
  115. package/dist/generated/models/ListActionItemsIdsResponse.js +3 -0
  116. package/dist/generated/models/ListActionItemsIdsResponse.js.map +1 -0
  117. package/dist/generated/models/ListActionItemsResponse.js +3 -0
  118. package/dist/generated/models/ListActionItemsResponse.js.map +1 -0
  119. package/dist/generated/models/ListFoldersResponseSortDirection.js +22 -49
  120. package/dist/generated/models/ListFoldersResponseSortDirection.js.map +1 -1
  121. package/dist/generated/models/ListFoldersResponseType.js +22 -49
  122. package/dist/generated/models/ListFoldersResponseType.js.map +1 -1
  123. package/dist/generated/models/ListMessagesFilterType.js +22 -49
  124. package/dist/generated/models/ListMessagesFilterType.js.map +1 -1
  125. package/dist/generated/models/ListMessagesResponseSortDirection.js +22 -49
  126. package/dist/generated/models/ListMessagesResponseSortDirection.js.map +1 -1
  127. package/dist/generated/models/ListMessagesSortDirection.js +22 -49
  128. package/dist/generated/models/ListMessagesSortDirection.js.map +1 -1
  129. package/dist/generated/models/ListMessagesType.js +22 -49
  130. package/dist/generated/models/ListMessagesType.js.map +1 -1
  131. package/dist/generated/models/ListOwnedSubscriptionsDirection.js +60 -0
  132. package/dist/generated/models/ListOwnedSubscriptionsDirection.js.map +1 -0
  133. package/dist/generated/models/ListOwnedSubscriptionsParams.js +3 -0
  134. package/dist/generated/models/ListOwnedSubscriptionsParams.js.map +1 -0
  135. package/dist/generated/models/ListSubscriptionsPagination.js +3 -0
  136. package/dist/generated/models/ListSubscriptionsPagination.js.map +1 -0
  137. package/dist/generated/models/ListSubscriptionsPaginationDirection.js +60 -0
  138. package/dist/generated/models/ListSubscriptionsPaginationDirection.js.map +1 -0
  139. package/dist/generated/models/ListSubscriptionsResponse.js +3 -0
  140. package/dist/generated/models/ListSubscriptionsResponse.js.map +1 -0
  141. package/dist/generated/models/MessageShareLink.js +3 -0
  142. package/dist/generated/models/MessageShareLink.js.map +1 -0
  143. package/dist/generated/models/MessageShareLinkAccessType.js +61 -0
  144. package/dist/generated/models/MessageShareLinkAccessType.js.map +1 -0
  145. package/dist/generated/models/MessageShareLinkShareType.js +60 -0
  146. package/dist/generated/models/MessageShareLinkShareType.js.map +1 -0
  147. package/dist/generated/models/MessageStatus.js +22 -49
  148. package/dist/generated/models/MessageStatus.js.map +1 -1
  149. package/dist/generated/models/MessageType.js +22 -49
  150. package/dist/generated/models/MessageType.js.map +1 -1
  151. package/dist/generated/models/MessageV2Type.js +0 -87
  152. package/dist/generated/models/MessageV2Type.js.map +1 -1
  153. package/dist/generated/models/MoveFolderPayload.js +22 -49
  154. package/dist/generated/models/MoveFolderPayload.js.map +1 -1
  155. package/dist/generated/models/Quality.js +61 -0
  156. package/dist/generated/models/Quality.js.map +1 -0
  157. package/dist/generated/models/ReactionSummaryReactionCounts.js +22 -49
  158. package/dist/generated/models/ReactionSummaryReactionCounts.js.map +1 -1
  159. package/dist/generated/models/ResponseByLanguageJson.js +22 -49
  160. package/dist/generated/models/ResponseByLanguageJson.js.map +1 -1
  161. package/dist/generated/models/ResponseFormat.js +60 -0
  162. package/dist/generated/models/ResponseFormat.js.map +1 -0
  163. package/dist/generated/models/Role.js +63 -0
  164. package/dist/generated/models/Role.js.map +1 -0
  165. package/dist/generated/models/SearchUserParams.js +22 -49
  166. package/dist/generated/models/SearchUserParams.js.map +1 -1
  167. package/dist/generated/models/SearchUsersBody.js +22 -49
  168. package/dist/generated/models/SearchUsersBody.js.map +1 -1
  169. package/dist/generated/models/SendDirectMessageFromMessageType.js +23 -49
  170. package/dist/generated/models/SendDirectMessageFromMessageType.js.map +1 -1
  171. package/dist/generated/models/SimplifiedAIPrompt.js +22 -49
  172. package/dist/generated/models/SimplifiedAIPrompt.js.map +1 -1
  173. package/dist/generated/models/SimplifiedAttachment.js +3 -0
  174. package/dist/generated/models/SimplifiedAttachment.js.map +1 -0
  175. package/dist/generated/models/SimplifiedAttachmentLocation.js +54 -0
  176. package/dist/generated/models/SimplifiedAttachmentLocation.js.map +1 -0
  177. package/dist/generated/models/SimplifiedLabel.js +3 -0
  178. package/dist/generated/models/SimplifiedLabel.js.map +1 -0
  179. package/dist/generated/models/SimplifiedLabelBehavior.js +61 -0
  180. package/dist/generated/models/SimplifiedLabelBehavior.js.map +1 -0
  181. package/dist/generated/models/SimplifiedLabelType.js +62 -0
  182. package/dist/generated/models/SimplifiedLabelType.js.map +1 -0
  183. package/dist/generated/models/SimplifiedUser.js +54 -0
  184. package/dist/generated/models/SimplifiedUser.js.map +1 -0
  185. package/dist/generated/models/SortFolderBy.js +61 -0
  186. package/dist/generated/models/SortFolderBy.js.map +1 -0
  187. package/dist/generated/models/SpecifiedAccess.js +3 -0
  188. package/dist/generated/models/SpecifiedAccess.js.map +1 -0
  189. package/dist/generated/models/SpecifiedAccessType.js +62 -0
  190. package/dist/generated/models/SpecifiedAccessType.js.map +1 -0
  191. package/dist/generated/models/Stats.js +22 -49
  192. package/dist/generated/models/Stats.js.map +1 -1
  193. package/dist/generated/models/SubFolderType.js +22 -49
  194. package/dist/generated/models/SubFolderType.js.map +1 -1
  195. package/dist/generated/models/SubscribeUserPayloadSubscriptionsItem.js +26 -51
  196. package/dist/generated/models/SubscribeUserPayloadSubscriptionsItem.js.map +1 -1
  197. package/dist/generated/models/SubscribeUserPayloadWebhookHeaders.js +54 -0
  198. package/dist/generated/models/SubscribeUserPayloadWebhookHeaders.js.map +1 -0
  199. package/dist/generated/models/SubscribedUserSubscriptionsItem.js +26 -51
  200. package/dist/generated/models/SubscribedUserSubscriptionsItem.js.map +1 -1
  201. package/dist/generated/models/SubscribedUserWebhookHeaders.js +54 -0
  202. package/dist/generated/models/SubscribedUserWebhookHeaders.js.map +1 -0
  203. package/dist/generated/models/Subscription.js +3 -0
  204. package/dist/generated/models/Subscription.js.map +1 -0
  205. package/dist/generated/models/SubscriptionActionActionId.js +23 -49
  206. package/dist/generated/models/SubscriptionActionActionId.js.map +1 -1
  207. package/dist/generated/models/SubscriptionActionEntityType.js +23 -49
  208. package/dist/generated/models/SubscriptionActionEntityType.js.map +1 -1
  209. package/dist/generated/models/SubscriptionFilterOperator.js +22 -49
  210. package/dist/generated/models/SubscriptionFilterOperator.js.map +1 -1
  211. package/dist/generated/models/SubscriptionFilterValue.js +22 -49
  212. package/dist/generated/models/SubscriptionFilterValue.js.map +1 -1
  213. package/dist/generated/models/SubscriptionSubscriptionsItem.js +92 -0
  214. package/dist/generated/models/SubscriptionSubscriptionsItem.js.map +1 -0
  215. package/dist/generated/models/SubscriptionWebhookHeaders.js +54 -0
  216. package/dist/generated/models/SubscriptionWebhookHeaders.js.map +1 -0
  217. package/dist/generated/models/TextModelType.js +22 -49
  218. package/dist/generated/models/TextModelType.js.map +1 -1
  219. package/dist/generated/models/TimedText.js +22 -49
  220. package/dist/generated/models/TimedText.js.map +1 -1
  221. package/dist/generated/models/ToRecipient.js +22 -49
  222. package/dist/generated/models/ToRecipient.js.map +1 -1
  223. package/dist/generated/models/UpdateAIPrompt.js +3 -0
  224. package/dist/generated/models/UpdateAIPrompt.js.map +1 -0
  225. package/dist/generated/models/UpdateActionItemPayload.js +54 -0
  226. package/dist/generated/models/UpdateActionItemPayload.js.map +1 -0
  227. package/dist/generated/models/UpdateActionItemStatusPayload.js +3 -0
  228. package/dist/generated/models/UpdateActionItemStatusPayload.js.map +1 -0
  229. package/dist/generated/models/UpdateFolderNamePayload.js +22 -49
  230. package/dist/generated/models/UpdateFolderNamePayload.js.map +1 -1
  231. package/dist/generated/models/UpdateSubscriptionPayload.js +3 -0
  232. package/dist/generated/models/UpdateSubscriptionPayload.js.map +1 -0
  233. package/dist/generated/models/UpdateSubscriptionPayloadSubscriptionsItem.js +92 -0
  234. package/dist/generated/models/UpdateSubscriptionPayloadSubscriptionsItem.js.map +1 -0
  235. package/dist/generated/models/UpdateSubscriptionPayloadWebhookHeaders.js +54 -0
  236. package/dist/generated/models/UpdateSubscriptionPayloadWebhookHeaders.js.map +1 -0
  237. package/dist/generated/models/UserReaction.js +22 -49
  238. package/dist/generated/models/UserReaction.js.map +1 -1
  239. package/dist/generated/models/UserStats.js +22 -49
  240. package/dist/generated/models/UserStats.js.map +1 -1
  241. package/dist/generated/models/UsersNotAllowedReceiveNotifications.js +22 -49
  242. package/dist/generated/models/UsersNotAllowedReceiveNotifications.js.map +1 -1
  243. package/dist/generated/models/UsersNotAllowedReceiveNotificationsV2.js +22 -49
  244. package/dist/generated/models/UsersNotAllowedReceiveNotificationsV2.js.map +1 -1
  245. package/dist/generated/models/UtmData.js +22 -49
  246. package/dist/generated/models/UtmData.js.map +1 -1
  247. package/dist/generated/models/VoiceType.js +22 -49
  248. package/dist/generated/models/VoiceType.js.map +1 -1
  249. package/dist/generated/models/WorkspaceBasicInfo.js +22 -49
  250. package/dist/generated/models/WorkspaceBasicInfo.js.map +1 -1
  251. package/dist/generated/models/index.js +85 -49
  252. package/dist/generated/models/index.js.map +1 -1
  253. package/dist/server.js +1 -1
  254. package/dist/server.js.map +1 -1
  255. package/package.json +1 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AudioDelivery.js","sourceRoot":"","sources":["../../../src/generated/models/AudioDelivery.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;AAIH,2DAA2D;AAC9C,QAAA,aAAa,GAAG;IAC3B,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;CACd,CAAC"}
@@ -5,75 +5,48 @@
5
5
  * Carbon Voice Simplified API
6
6
  * # Introduction
7
7
 
8
- The simplified version of the Carbon Voice API is designed to enhance usability for third-party clients looking to
9
- seamlessly integrate with our application. By streamlining authentication methods, providing clear error handling guidelines,
10
- and implementing straightforward rate limiting policies, we ensure that developers can quickly and efficiently connect to our services.
11
- This user-friendly approach minimizes complexity, making it easier for external applications to leverage the powerful communication
12
- features of Carbon Voice without extensive technical overhead.
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
13
9
 
14
- This API is designed for people who feel comfortable integrating with RESTful APIs.
15
-
16
- ## Full API Version
17
- We also have a full version of the API. You can find it [here](/docs).
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** Create API keys, OAuth integrations, and explore how-to examples.
18
11
 
19
12
  ## Terminology
20
-
21
- * **Workspace**: An area that groups together people and Conversations.
22
- * **Conversation**: A channel of communication. A grouping of people and messages related to a given topic.
23
- * **Collaborators**: A group of people who are part of a Conversation.
24
- * **Discussion**: Any post into a conversation
25
- * **CarbonLink**: A link (on a website, QR code, or phone call) to start a conversation.
26
13
 
27
- ## BaseURL
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
28
19
 
29
- This API is served over HTTPS.
20
+ ## Base URL
30
21
 
31
- All URLs referenced in the documentation have the following base: https://api.carbonvoice.app/api/simplified.
22
+ `https://api.carbonvoice.app/api/simplified`
32
23
 
33
24
  ## Authentication
34
25
 
35
- There are three ways to authenticate with this API:
36
-
37
- * with an OAuth2 Access Token in the Authorization request header field
38
- (which uses the Bearer authentication scheme to transmit the Access Token)
39
- * with your Client ID and Client Secret credentials
40
- * with a PXToken
26
+ Authenticate using one of these methods:
41
27
 
42
- Each endpoint supports only one option.
28
+ 1. **OAuth2 Bearer token** `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
43
31
 
44
32
  <SecurityDefinitions />
45
33
 
46
34
  ## Errors
47
35
 
48
- When an error occurs, you will receive an error object. Most of these error objects
49
- contain an error code and an error description so that your applications can more
50
- efficiently identify the problem.
51
-
52
- If you get an 4xx HTTP response code, then you can assume that there is a bad request
53
- from your end. In this case, check the [Error Responses section](#section/Introduction/Error-Responses) for more context.
54
-
55
- 5xx errors suggest a problem on our end, so in this case, check [Carbon Voice's Status](https://status.carbonvoice.app)
56
- to see how our systems are doing.
57
-
58
- In any other case you can use our support options.
59
-
60
- ## Error Responses
61
-
62
- `{ "success": false, requestId: "uuid", errmsg: "error message"`
63
-
64
- ## Rate-Limiting
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
65
37
 
66
- This API is subject to rate limiting. The limits differ per endpoint.
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
67
39
 
68
- If you exceed the provided rate limit for a given endpoint, you will receive the 429
69
- Too Many Requests response with the following message: Too many requests. Check the
70
- X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
40
+ ## Rate Limiting
71
41
 
72
- For details on rate limiting, refer to Rate Limit Policy.
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
73
43
 
74
- ## Support
44
+ ## Resources
75
45
 
76
- If you have problems or need help with your case, you can always reach out to our Support.
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
77
50
 
78
51
  * OpenAPI spec version: 1.0.0
79
52
  */
@@ -1 +1 @@
1
- {"version":3,"file":"AudioModelV2.js","sourceRoot":"","sources":["../../../src/generated/models/AudioModelV2.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG"}
1
+ {"version":3,"file":"AudioModelV2.js","sourceRoot":"","sources":["../../../src/generated/models/AudioModelV2.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG"}
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval v7.9.0 🍺
4
+ * Do not edit manually.
5
+ * Carbon Voice Simplified API
6
+ * # Introduction
7
+
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
9
+
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** — Create API keys, OAuth integrations, and explore how-to examples.
11
+
12
+ ## Terminology
13
+
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
19
+
20
+ ## Base URL
21
+
22
+ `https://api.carbonvoice.app/api/simplified`
23
+
24
+ ## Authentication
25
+
26
+ Authenticate using one of these methods:
27
+
28
+ 1. **OAuth2 Bearer token** — `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
31
+
32
+ <SecurityDefinitions />
33
+
34
+ ## Errors
35
+
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
37
+
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
39
+
40
+ ## Rate Limiting
41
+
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
43
+
44
+ ## Resources
45
+
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** — API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
50
+
51
+ * OpenAPI spec version: 1.0.0
52
+ */
53
+ Object.defineProperty(exports, "__esModule", { value: true });
54
+ exports.CaughtUpStatus = void 0;
55
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
56
+ exports.CaughtUpStatus = {
57
+ all: 'all',
58
+ some: 'some',
59
+ none: 'none',
60
+ };
61
+ //# sourceMappingURL=CaughtUpStatus.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CaughtUpStatus.js","sourceRoot":"","sources":["../../../src/generated/models/CaughtUpStatus.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;AAQH,2DAA2D;AAC9C,QAAA,cAAc,GAAG;IAC5B,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC"}
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval v7.9.0 🍺
4
+ * Do not edit manually.
5
+ * Carbon Voice Simplified API
6
+ * # Introduction
7
+
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
9
+
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** — Create API keys, OAuth integrations, and explore how-to examples.
11
+
12
+ ## Terminology
13
+
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
19
+
20
+ ## Base URL
21
+
22
+ `https://api.carbonvoice.app/api/simplified`
23
+
24
+ ## Authentication
25
+
26
+ Authenticate using one of these methods:
27
+
28
+ 1. **OAuth2 Bearer token** — `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
31
+
32
+ <SecurityDefinitions />
33
+
34
+ ## Errors
35
+
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
37
+
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
39
+
40
+ ## Rate Limiting
41
+
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
43
+
44
+ ## Resources
45
+
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** — API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
50
+
51
+ * OpenAPI spec version: 1.0.0
52
+ */
53
+ Object.defineProperty(exports, "__esModule", { value: true });
54
+ exports.ConversationMatch = void 0;
55
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
56
+ exports.ConversationMatch = {
57
+ any: 'any',
58
+ all: 'all',
59
+ };
60
+ //# sourceMappingURL=ConversationMatch.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ConversationMatch.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationMatch.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;AAKH,2DAA2D;AAC9C,QAAA,iBAAiB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;CACF,CAAC"}
@@ -5,75 +5,48 @@
5
5
  * Carbon Voice Simplified API
6
6
  * # Introduction
7
7
 
8
- The simplified version of the Carbon Voice API is designed to enhance usability for third-party clients looking to
9
- seamlessly integrate with our application. By streamlining authentication methods, providing clear error handling guidelines,
10
- and implementing straightforward rate limiting policies, we ensure that developers can quickly and efficiently connect to our services.
11
- This user-friendly approach minimizes complexity, making it easier for external applications to leverage the powerful communication
12
- features of Carbon Voice without extensive technical overhead.
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
13
9
 
14
- This API is designed for people who feel comfortable integrating with RESTful APIs.
15
-
16
- ## Full API Version
17
- We also have a full version of the API. You can find it [here](/docs).
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** Create API keys, OAuth integrations, and explore how-to examples.
18
11
 
19
12
  ## Terminology
20
-
21
- * **Workspace**: An area that groups together people and Conversations.
22
- * **Conversation**: A channel of communication. A grouping of people and messages related to a given topic.
23
- * **Collaborators**: A group of people who are part of a Conversation.
24
- * **Discussion**: Any post into a conversation
25
- * **CarbonLink**: A link (on a website, QR code, or phone call) to start a conversation.
26
13
 
27
- ## BaseURL
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
28
19
 
29
- This API is served over HTTPS.
20
+ ## Base URL
30
21
 
31
- All URLs referenced in the documentation have the following base: https://api.carbonvoice.app/api/simplified.
22
+ `https://api.carbonvoice.app/api/simplified`
32
23
 
33
24
  ## Authentication
34
25
 
35
- There are three ways to authenticate with this API:
36
-
37
- * with an OAuth2 Access Token in the Authorization request header field
38
- (which uses the Bearer authentication scheme to transmit the Access Token)
39
- * with your Client ID and Client Secret credentials
40
- * with a PXToken
26
+ Authenticate using one of these methods:
41
27
 
42
- Each endpoint supports only one option.
28
+ 1. **OAuth2 Bearer token** `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
43
31
 
44
32
  <SecurityDefinitions />
45
33
 
46
34
  ## Errors
47
35
 
48
- When an error occurs, you will receive an error object. Most of these error objects
49
- contain an error code and an error description so that your applications can more
50
- efficiently identify the problem.
51
-
52
- If you get an 4xx HTTP response code, then you can assume that there is a bad request
53
- from your end. In this case, check the [Error Responses section](#section/Introduction/Error-Responses) for more context.
54
-
55
- 5xx errors suggest a problem on our end, so in this case, check [Carbon Voice's Status](https://status.carbonvoice.app)
56
- to see how our systems are doing.
57
-
58
- In any other case you can use our support options.
59
-
60
- ## Error Responses
61
-
62
- `{ "success": false, requestId: "uuid", errmsg: "error message"`
63
-
64
- ## Rate-Limiting
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
65
37
 
66
- This API is subject to rate limiting. The limits differ per endpoint.
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
67
39
 
68
- If you exceed the provided rate limit for a given endpoint, you will receive the 429
69
- Too Many Requests response with the following message: Too many requests. Check the
70
- X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
40
+ ## Rate Limiting
71
41
 
72
- For details on rate limiting, refer to Rate Limit Policy.
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
73
43
 
74
- ## Support
44
+ ## Resources
75
45
 
76
- If you have problems or need help with your case, you can always reach out to our Support.
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
77
50
 
78
51
  * OpenAPI spec version: 1.0.0
79
52
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ConversationResponseType.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationResponseType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;;;AAQH,2DAA2D;AAC9C,QAAA,wBAAwB,GAAG;IACtC,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,sBAAsB;IAC5C,iBAAiB,EAAE,mBAAmB;IACtC,YAAY,EAAE,cAAc;CACpB,CAAC"}
1
+ {"version":3,"file":"ConversationResponseType.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationResponseType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;AAQH,2DAA2D;AAC9C,QAAA,wBAAwB,GAAG;IACtC,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,sBAAsB;IAC5C,iBAAiB,EAAE,mBAAmB;IACtC,YAAY,EAAE,cAAc;CACpB,CAAC"}
@@ -5,75 +5,48 @@
5
5
  * Carbon Voice Simplified API
6
6
  * # Introduction
7
7
 
8
- The simplified version of the Carbon Voice API is designed to enhance usability for third-party clients looking to
9
- seamlessly integrate with our application. By streamlining authentication methods, providing clear error handling guidelines,
10
- and implementing straightforward rate limiting policies, we ensure that developers can quickly and efficiently connect to our services.
11
- This user-friendly approach minimizes complexity, making it easier for external applications to leverage the powerful communication
12
- features of Carbon Voice without extensive technical overhead.
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
13
9
 
14
- This API is designed for people who feel comfortable integrating with RESTful APIs.
15
-
16
- ## Full API Version
17
- We also have a full version of the API. You can find it [here](/docs).
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** Create API keys, OAuth integrations, and explore how-to examples.
18
11
 
19
12
  ## Terminology
20
-
21
- * **Workspace**: An area that groups together people and Conversations.
22
- * **Conversation**: A channel of communication. A grouping of people and messages related to a given topic.
23
- * **Collaborators**: A group of people who are part of a Conversation.
24
- * **Discussion**: Any post into a conversation
25
- * **CarbonLink**: A link (on a website, QR code, or phone call) to start a conversation.
26
13
 
27
- ## BaseURL
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
28
19
 
29
- This API is served over HTTPS.
20
+ ## Base URL
30
21
 
31
- All URLs referenced in the documentation have the following base: https://api.carbonvoice.app/api/simplified.
22
+ `https://api.carbonvoice.app/api/simplified`
32
23
 
33
24
  ## Authentication
34
25
 
35
- There are three ways to authenticate with this API:
36
-
37
- * with an OAuth2 Access Token in the Authorization request header field
38
- (which uses the Bearer authentication scheme to transmit the Access Token)
39
- * with your Client ID and Client Secret credentials
40
- * with a PXToken
26
+ Authenticate using one of these methods:
41
27
 
42
- Each endpoint supports only one option.
28
+ 1. **OAuth2 Bearer token** `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
43
31
 
44
32
  <SecurityDefinitions />
45
33
 
46
34
  ## Errors
47
35
 
48
- When an error occurs, you will receive an error object. Most of these error objects
49
- contain an error code and an error description so that your applications can more
50
- efficiently identify the problem.
51
-
52
- If you get an 4xx HTTP response code, then you can assume that there is a bad request
53
- from your end. In this case, check the [Error Responses section](#section/Introduction/Error-Responses) for more context.
54
-
55
- 5xx errors suggest a problem on our end, so in this case, check [Carbon Voice's Status](https://status.carbonvoice.app)
56
- to see how our systems are doing.
57
-
58
- In any other case you can use our support options.
59
-
60
- ## Error Responses
61
-
62
- `{ "success": false, requestId: "uuid", errmsg: "error message"`
63
-
64
- ## Rate-Limiting
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
65
37
 
66
- This API is subject to rate limiting. The limits differ per endpoint.
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
67
39
 
68
- If you exceed the provided rate limit for a given endpoint, you will receive the 429
69
- Too Many Requests response with the following message: Too many requests. Check the
70
- X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
40
+ ## Rate Limiting
71
41
 
72
- For details on rate limiting, refer to Rate Limit Policy.
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
73
43
 
74
- ## Support
44
+ ## Resources
75
45
 
76
- If you have problems or need help with your case, you can always reach out to our Support.
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
77
50
 
78
51
  * OpenAPI spec version: 1.0.0
79
52
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ConversationType.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;;;AAQH,2DAA2D;AAC9C,QAAA,gBAAgB,GAAG;IAC9B,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,sBAAsB;IAC5C,iBAAiB,EAAE,mBAAmB;IACtC,YAAY,EAAE,cAAc;CACpB,CAAC"}
1
+ {"version":3,"file":"ConversationType.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;AAQH,2DAA2D;AAC9C,QAAA,gBAAgB,GAAG;IAC9B,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,sBAAsB;IAC5C,iBAAiB,EAAE,mBAAmB;IACtC,YAAY,EAAE,cAAc;CACpB,CAAC"}
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by orval v7.9.0 🍺
4
+ * Do not edit manually.
5
+ * Carbon Voice Simplified API
6
+ * # Introduction
7
+
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
9
+
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** — Create API keys, OAuth integrations, and explore how-to examples.
11
+
12
+ ## Terminology
13
+
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
19
+
20
+ ## Base URL
21
+
22
+ `https://api.carbonvoice.app/api/simplified`
23
+
24
+ ## Authentication
25
+
26
+ Authenticate using one of these methods:
27
+
28
+ 1. **OAuth2 Bearer token** — `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
31
+
32
+ <SecurityDefinitions />
33
+
34
+ ## Errors
35
+
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
37
+
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
39
+
40
+ ## Rate Limiting
41
+
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
43
+
44
+ ## Resources
45
+
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** — API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
50
+
51
+ * OpenAPI spec version: 1.0.0
52
+ */
53
+ Object.defineProperty(exports, "__esModule", { value: true });
54
+ //# sourceMappingURL=ConversationUsersInput.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ConversationUsersInput.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationUsersInput.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG"}
@@ -5,75 +5,48 @@
5
5
  * Carbon Voice Simplified API
6
6
  * # Introduction
7
7
 
8
- The simplified version of the Carbon Voice API is designed to enhance usability for third-party clients looking to
9
- seamlessly integrate with our application. By streamlining authentication methods, providing clear error handling guidelines,
10
- and implementing straightforward rate limiting policies, we ensure that developers can quickly and efficiently connect to our services.
11
- This user-friendly approach minimizes complexity, making it easier for external applications to leverage the powerful communication
12
- features of Carbon Voice without extensive technical overhead.
8
+ Simplified Carbon Voice API for third-party integrations. Full API [here](/docs).
13
9
 
14
- This API is designed for people who feel comfortable integrating with RESTful APIs.
15
-
16
- ## Full API Version
17
- We also have a full version of the API. You can find it [here](/docs).
10
+ **[Developer Portal](https://www.developer.carbonvoice.app/)** Create API keys, OAuth integrations, and explore how-to examples.
18
11
 
19
12
  ## Terminology
20
-
21
- * **Workspace**: An area that groups together people and Conversations.
22
- * **Conversation**: A channel of communication. A grouping of people and messages related to a given topic.
23
- * **Collaborators**: A group of people who are part of a Conversation.
24
- * **Discussion**: Any post into a conversation
25
- * **CarbonLink**: A link (on a website, QR code, or phone call) to start a conversation.
26
13
 
27
- ## BaseURL
14
+ * **Workspace**: Area that groups people and conversations.
15
+ * **Conversation**: A channel of communication (people + messages around a topic).
16
+ * **Collaborators**: People who are part of a conversation.
17
+ * **Discussion**: A post into a conversation.
18
+ * **CarbonLink**: Link (website, QR code, phone) to start a conversation.
28
19
 
29
- This API is served over HTTPS.
20
+ ## Base URL
30
21
 
31
- All URLs referenced in the documentation have the following base: https://api.carbonvoice.app/api/simplified.
22
+ `https://api.carbonvoice.app/api/simplified`
32
23
 
33
24
  ## Authentication
34
25
 
35
- There are three ways to authenticate with this API:
36
-
37
- * with an OAuth2 Access Token in the Authorization request header field
38
- (which uses the Bearer authentication scheme to transmit the Access Token)
39
- * with your Client ID and Client Secret credentials
40
- * with a PXToken
26
+ Authenticate using one of these methods:
41
27
 
42
- Each endpoint supports only one option.
28
+ 1. **OAuth2 Bearer token** `Authorization: Bearer <access_token>` (obtain via OAuth2 flow)
29
+ 2. **PXToken** — `pxtoken` header, query param, body, or cookie (session token from login)
30
+ 3. **API Key** — `x-api-key` header
43
31
 
44
32
  <SecurityDefinitions />
45
33
 
46
34
  ## Errors
47
35
 
48
- When an error occurs, you will receive an error object. Most of these error objects
49
- contain an error code and an error description so that your applications can more
50
- efficiently identify the problem.
51
-
52
- If you get an 4xx HTTP response code, then you can assume that there is a bad request
53
- from your end. In this case, check the [Error Responses section](#section/Introduction/Error-Responses) for more context.
54
-
55
- 5xx errors suggest a problem on our end, so in this case, check [Carbon Voice's Status](https://status.carbonvoice.app)
56
- to see how our systems are doing.
57
-
58
- In any other case you can use our support options.
59
-
60
- ## Error Responses
61
-
62
- `{ "success": false, requestId: "uuid", errmsg: "error message"`
63
-
64
- ## Rate-Limiting
36
+ 4xx responses indicate a client error. 5xx indicate a server error. Check [health](https://api.carbonvoice.app/v2/health) for system status.
65
37
 
66
- This API is subject to rate limiting. The limits differ per endpoint.
38
+ Error format: `{ "success": false, requestId: "uuid", errmsg: "error message" }`
67
39
 
68
- If you exceed the provided rate limit for a given endpoint, you will receive the 429
69
- Too Many Requests response with the following message: Too many requests. Check the
70
- X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
40
+ ## Rate Limiting
71
41
 
72
- For details on rate limiting, refer to Rate Limit Policy.
42
+ Rate limits vary per endpoint. On 429 responses, check `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers.
73
43
 
74
- ## Support
44
+ ## Resources
75
45
 
76
- If you have problems or need help with your case, you can always reach out to our Support.
46
+ * **[Developer Portal](https://www.developer.carbonvoice.app/)** API keys, integrations, and how-to examples
47
+ * **[User Terms of Service](https://www.getcarbon.app/usertos)** — Legal terms for API use
48
+ * **[Support](https://www.getcarbon.app/support)** — Help and documentation
49
+ * **Email** — support@carbonvoice.app
77
50
 
78
51
  * OpenAPI spec version: 1.0.0
79
52
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ConversationVisibility.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationVisibility.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;;;AAQH,2DAA2D;AAC9C,QAAA,sBAAsB,GAAG;IACpC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAC"}
1
+ {"version":3,"file":"ConversationVisibility.js","sourceRoot":"","sources":["../../../src/generated/models/ConversationVisibility.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;;;AAQH,2DAA2D;AAC9C,QAAA,sBAAsB,GAAG;IACpC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAC"}