intercom-client 6.1.0 → 6.2.0

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 (337) hide show
  1. package/Client.d.ts +2 -0
  2. package/README.md +33 -33
  3. package/api/errors/BadRequestError.js +17 -7
  4. package/api/errors/ForbiddenError.js +17 -7
  5. package/api/errors/NotFoundError.js +17 -7
  6. package/api/errors/UnauthorizedError.js +17 -7
  7. package/api/errors/UnprocessableEntityError.js +17 -7
  8. package/api/resources/admins/client/Client.d.ts +2 -0
  9. package/api/resources/admins/client/Client.js +34 -24
  10. package/api/resources/aiAgent/types/AiAgent.js +1 -1
  11. package/api/resources/aiContentSource/types/ContentSource.js +1 -1
  12. package/api/resources/articles/client/Client.d.ts +2 -0
  13. package/api/resources/articles/client/Client.js +41 -31
  14. package/api/resources/articles/client/requests/CreateArticleRequest.js +1 -1
  15. package/api/resources/articles/client/requests/UpdateArticleRequest.js +1 -1
  16. package/api/resources/articles/types/ArticleListItem.js +1 -1
  17. package/api/resources/articles/types/ArticleSearchHighlights.js +1 -1
  18. package/api/resources/companies/client/Client.d.ts +2 -0
  19. package/api/resources/companies/client/Client.js +60 -50
  20. package/api/resources/contacts/client/Client.d.ts +2 -0
  21. package/api/resources/contacts/client/Client.js +66 -56
  22. package/api/resources/contacts/types/Contact.d.ts +2 -9
  23. package/api/resources/conversations/client/Client.d.ts +2 -5
  24. package/api/resources/conversations/client/Client.js +57 -52
  25. package/api/resources/conversations/client/requests/CreateConversationRequest.js +1 -1
  26. package/api/resources/conversations/types/Conversation.js +1 -1
  27. package/api/resources/conversations/types/ConversationsManageRequestBody.d.ts +1 -1
  28. package/api/resources/dataAttributes/client/Client.d.ts +2 -0
  29. package/api/resources/dataAttributes/client/Client.js +30 -20
  30. package/api/resources/dataAttributes/client/requests/CreateDataAttributeRequest.js +1 -1
  31. package/api/resources/dataAttributes/types/DataAttribute.js +1 -1
  32. package/api/resources/dataAttributes/types/DataAttributesListRequestModel.d.ts +1 -1
  33. package/api/resources/dataExport/client/Client.d.ts +2 -0
  34. package/api/resources/dataExport/client/Client.js +31 -21
  35. package/api/resources/dataExport/types/DataExport.js +1 -1
  36. package/api/resources/events/client/Client.d.ts +2 -2
  37. package/api/resources/events/client/Client.js +30 -22
  38. package/api/resources/helpCenters/client/Client.d.ts +2 -0
  39. package/api/resources/helpCenters/client/Client.js +27 -17
  40. package/api/resources/helpCenters/resources/collections/client/Client.d.ts +2 -0
  41. package/api/resources/helpCenters/resources/collections/client/Client.js +36 -26
  42. package/api/resources/helpCenters/resources/index.js +17 -7
  43. package/api/resources/index.js +17 -7
  44. package/api/resources/messages/client/Client.d.ts +2 -0
  45. package/api/resources/messages/client/Client.js +22 -12
  46. package/api/resources/messages/types/Message.js +1 -1
  47. package/api/resources/news/client/Client.d.ts +2 -12
  48. package/api/resources/news/resources/feeds/client/Client.d.ts +2 -0
  49. package/api/resources/news/resources/feeds/client/Client.js +28 -18
  50. package/api/resources/news/resources/index.js +17 -7
  51. package/api/resources/news/resources/items/client/Client.d.ts +2 -0
  52. package/api/resources/news/resources/items/client/Client.js +34 -24
  53. package/api/resources/news/types/NewsItem.js +1 -1
  54. package/api/resources/notes/client/Client.d.ts +2 -0
  55. package/api/resources/notes/client/Client.js +28 -18
  56. package/api/resources/phoneCallRedirects/client/Client.d.ts +2 -0
  57. package/api/resources/phoneCallRedirects/client/Client.js +22 -12
  58. package/api/resources/segments/client/Client.d.ts +2 -0
  59. package/api/resources/segments/client/Client.js +27 -17
  60. package/api/resources/segments/types/Segment.js +1 -1
  61. package/api/resources/subscriptionTypes/client/Client.d.ts +2 -0
  62. package/api/resources/subscriptionTypes/client/Client.js +22 -12
  63. package/api/resources/subscriptionTypes/types/SubscriptionType.js +1 -1
  64. package/api/resources/tags/client/Client.d.ts +2 -1
  65. package/api/resources/tags/client/Client.js +49 -40
  66. package/api/resources/tags/types/TagsCreateRequestBody.d.ts +1 -1
  67. package/api/resources/teams/client/Client.d.ts +2 -0
  68. package/api/resources/teams/client/Client.js +25 -15
  69. package/api/resources/ticketTypes/client/Client.d.ts +2 -0
  70. package/api/resources/ticketTypes/client/Client.js +31 -21
  71. package/api/resources/ticketTypes/client/requests/CreateTicketTypeRequest.js +1 -1
  72. package/api/resources/ticketTypes/client/requests/UpdateTicketTypeRequest.js +1 -1
  73. package/api/resources/ticketTypes/resources/attributes/client/Client.d.ts +2 -0
  74. package/api/resources/ticketTypes/resources/attributes/client/Client.js +25 -15
  75. package/api/resources/ticketTypes/resources/attributes/client/requests/CreateTicketTypeAttributeRequest.js +1 -1
  76. package/api/resources/ticketTypes/resources/index.js +17 -7
  77. package/api/resources/tickets/client/Client.d.ts +2 -0
  78. package/api/resources/tickets/client/Client.js +34 -24
  79. package/api/resources/tickets/client/requests/UpdateTicketRequest.js +1 -1
  80. package/api/resources/tickets/types/Ticket.js +1 -1
  81. package/api/resources/tickets/types/TicketPart.js +1 -1
  82. package/api/resources/tickets/types/TicketType.js +1 -1
  83. package/api/resources/tickets/types/TicketsReplyRequestBody.d.ts +1 -1
  84. package/api/resources/visitors/client/Client.d.ts +2 -0
  85. package/api/resources/visitors/client/Client.js +28 -18
  86. package/api/types/ActionComponent.d.ts +1 -1
  87. package/api/types/ActivityLog.js +1 -1
  88. package/api/types/AdminReplyConversationRequest.js +1 -1
  89. package/api/types/AdminReplyTicketRequest.js +1 -1
  90. package/api/types/ArticleContent.js +1 -1
  91. package/api/types/ArticleList.d.ts +1 -1
  92. package/api/types/AssignConversationRequest.js +1 -1
  93. package/api/types/ButtonComponent.js +1 -1
  94. package/api/types/CheckboxComponent.js +1 -1
  95. package/api/types/CollectionList.d.ts +1 -1
  96. package/api/types/CompanyList.d.ts +1 -1
  97. package/api/types/Component.d.ts +1 -1
  98. package/api/types/ConfigureRequest.d.ts +1 -1
  99. package/api/types/ConfigureResponse.d.ts +1 -1
  100. package/api/types/ContactReplyConversationRequest.d.ts +1 -1
  101. package/api/types/ContactReplyTicketRequest.d.ts +1 -1
  102. package/api/types/Context.js +1 -1
  103. package/api/types/ConversationSource.js +1 -1
  104. package/api/types/CreateContactRequest.d.ts +1 -1
  105. package/api/types/CreateDataEventRequest.d.ts +1 -1
  106. package/api/types/CreateMessageRequest.d.ts +1 -1
  107. package/api/types/CreateMessageRequest.js +1 -1
  108. package/api/types/CreateTicketReplyWithCommentRequest.d.ts +1 -1
  109. package/api/types/CustomAttributes.d.ts +1 -1
  110. package/api/types/CustomerRequest.d.ts +1 -1
  111. package/api/types/DropdownComponent.js +1 -1
  112. package/api/types/ImageComponent.js +1 -1
  113. package/api/types/InputComponent.js +1 -1
  114. package/api/types/LinkedObject.js +1 -1
  115. package/api/types/MultipleFilterSearchRequest.js +1 -1
  116. package/api/types/MultipleOrSingleFilterSearchRequest.d.ts +1 -1
  117. package/api/types/NewsItemRequest.js +1 -1
  118. package/api/types/NoteList.d.ts +1 -1
  119. package/api/types/OffsetPages.d.ts +14 -0
  120. package/api/types/OffsetPages.js +5 -0
  121. package/api/types/RedactConversationRequest.d.ts +1 -1
  122. package/api/types/ReplyConversationRequest.d.ts +1 -1
  123. package/api/types/SingleFilterSearchRequest.js +1 -1
  124. package/api/types/SingleSelectComponent.js +1 -1
  125. package/api/types/SlaApplied.js +1 -1
  126. package/api/types/SpacerComponent.js +1 -1
  127. package/api/types/TextComponent.js +1 -1
  128. package/api/types/TicketCustomAttributes.d.ts +1 -1
  129. package/api/types/TicketPartAuthor.js +1 -1
  130. package/api/types/TicketReply.js +1 -1
  131. package/api/types/TicketRequestCustomAttributes.d.ts +1 -1
  132. package/api/types/TicketTypeAttribute.js +1 -1
  133. package/api/types/UpdateVisitorRequest.d.ts +1 -1
  134. package/api/types/index.d.ts +1 -0
  135. package/api/types/index.js +1 -0
  136. package/api/version.d.ts +1 -1
  137. package/core/auth/BearerToken.d.ts +1 -1
  138. package/core/fetcher/APIResponse.d.ts +1 -1
  139. package/core/fetcher/Fetcher.d.ts +2 -2
  140. package/core/fetcher/Fetcher.js +6 -5
  141. package/core/fetcher/Supplier.d.ts +1 -1
  142. package/core/fetcher/createRequestUrl.d.ts +1 -1
  143. package/core/fetcher/createRequestUrl.js +1 -2
  144. package/core/fetcher/getFetchFn.js +18 -9
  145. package/core/fetcher/getHeader.js +1 -2
  146. package/core/fetcher/getRequestBody.js +5 -5
  147. package/core/fetcher/getResponseBody.js +1 -2
  148. package/core/fetcher/makeRequest.d.ts +1 -1
  149. package/core/fetcher/requestWithRetries.js +4 -5
  150. package/core/fetcher/signals.d.ts +0 -1
  151. package/core/fetcher/signals.js +2 -3
  152. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -1
  153. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +6 -4
  154. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +1 -1
  155. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +1 -1
  156. package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +18 -9
  157. package/core/json.d.ts +15 -0
  158. package/core/json.js +24 -0
  159. package/core/pagination/Page.js +9 -6
  160. package/core/runtime/runtime.d.ts +1 -1
  161. package/core/runtime/runtime.js +51 -41
  162. package/core/utils/setObjectProperty.js +1 -2
  163. package/dist/Client.d.ts +2 -0
  164. package/dist/api/errors/BadRequestError.js +17 -7
  165. package/dist/api/errors/ForbiddenError.js +17 -7
  166. package/dist/api/errors/NotFoundError.js +17 -7
  167. package/dist/api/errors/UnauthorizedError.js +17 -7
  168. package/dist/api/errors/UnprocessableEntityError.js +17 -7
  169. package/dist/api/resources/admins/client/Client.d.ts +2 -0
  170. package/dist/api/resources/admins/client/Client.js +34 -24
  171. package/dist/api/resources/aiAgent/types/AiAgent.js +1 -1
  172. package/dist/api/resources/aiContentSource/types/ContentSource.js +1 -1
  173. package/dist/api/resources/articles/client/Client.d.ts +2 -0
  174. package/dist/api/resources/articles/client/Client.js +41 -31
  175. package/dist/api/resources/articles/client/requests/CreateArticleRequest.js +1 -1
  176. package/dist/api/resources/articles/client/requests/UpdateArticleRequest.js +1 -1
  177. package/dist/api/resources/articles/types/ArticleListItem.js +1 -1
  178. package/dist/api/resources/articles/types/ArticleSearchHighlights.js +1 -1
  179. package/dist/api/resources/companies/client/Client.d.ts +2 -0
  180. package/dist/api/resources/companies/client/Client.js +60 -50
  181. package/dist/api/resources/contacts/client/Client.d.ts +2 -0
  182. package/dist/api/resources/contacts/client/Client.js +66 -56
  183. package/dist/api/resources/contacts/types/Contact.d.ts +2 -9
  184. package/dist/api/resources/conversations/client/Client.d.ts +2 -5
  185. package/dist/api/resources/conversations/client/Client.js +57 -52
  186. package/dist/api/resources/conversations/client/requests/CreateConversationRequest.js +1 -1
  187. package/dist/api/resources/conversations/types/Conversation.js +1 -1
  188. package/dist/api/resources/conversations/types/ConversationsManageRequestBody.d.ts +1 -1
  189. package/dist/api/resources/dataAttributes/client/Client.d.ts +2 -0
  190. package/dist/api/resources/dataAttributes/client/Client.js +30 -20
  191. package/dist/api/resources/dataAttributes/client/requests/CreateDataAttributeRequest.js +1 -1
  192. package/dist/api/resources/dataAttributes/types/DataAttribute.js +1 -1
  193. package/dist/api/resources/dataAttributes/types/DataAttributesListRequestModel.d.ts +1 -1
  194. package/dist/api/resources/dataExport/client/Client.d.ts +2 -0
  195. package/dist/api/resources/dataExport/client/Client.js +31 -21
  196. package/dist/api/resources/dataExport/types/DataExport.js +1 -1
  197. package/dist/api/resources/events/client/Client.d.ts +2 -2
  198. package/dist/api/resources/events/client/Client.js +30 -22
  199. package/dist/api/resources/helpCenters/client/Client.d.ts +2 -0
  200. package/dist/api/resources/helpCenters/client/Client.js +27 -17
  201. package/dist/api/resources/helpCenters/resources/collections/client/Client.d.ts +2 -0
  202. package/dist/api/resources/helpCenters/resources/collections/client/Client.js +36 -26
  203. package/dist/api/resources/helpCenters/resources/index.js +17 -7
  204. package/dist/api/resources/index.js +17 -7
  205. package/dist/api/resources/messages/client/Client.d.ts +2 -0
  206. package/dist/api/resources/messages/client/Client.js +22 -12
  207. package/dist/api/resources/messages/types/Message.js +1 -1
  208. package/dist/api/resources/news/client/Client.d.ts +2 -12
  209. package/dist/api/resources/news/resources/feeds/client/Client.d.ts +2 -0
  210. package/dist/api/resources/news/resources/feeds/client/Client.js +28 -18
  211. package/dist/api/resources/news/resources/index.js +17 -7
  212. package/dist/api/resources/news/resources/items/client/Client.d.ts +2 -0
  213. package/dist/api/resources/news/resources/items/client/Client.js +34 -24
  214. package/dist/api/resources/news/types/NewsItem.js +1 -1
  215. package/dist/api/resources/notes/client/Client.d.ts +2 -0
  216. package/dist/api/resources/notes/client/Client.js +28 -18
  217. package/dist/api/resources/phoneCallRedirects/client/Client.d.ts +2 -0
  218. package/dist/api/resources/phoneCallRedirects/client/Client.js +22 -12
  219. package/dist/api/resources/segments/client/Client.d.ts +2 -0
  220. package/dist/api/resources/segments/client/Client.js +27 -17
  221. package/dist/api/resources/segments/types/Segment.js +1 -1
  222. package/dist/api/resources/subscriptionTypes/client/Client.d.ts +2 -0
  223. package/dist/api/resources/subscriptionTypes/client/Client.js +22 -12
  224. package/dist/api/resources/subscriptionTypes/types/SubscriptionType.js +1 -1
  225. package/dist/api/resources/tags/client/Client.d.ts +2 -1
  226. package/dist/api/resources/tags/client/Client.js +49 -40
  227. package/dist/api/resources/tags/types/TagsCreateRequestBody.d.ts +1 -1
  228. package/dist/api/resources/teams/client/Client.d.ts +2 -0
  229. package/dist/api/resources/teams/client/Client.js +25 -15
  230. package/dist/api/resources/ticketTypes/client/Client.d.ts +2 -0
  231. package/dist/api/resources/ticketTypes/client/Client.js +31 -21
  232. package/dist/api/resources/ticketTypes/client/requests/CreateTicketTypeRequest.js +1 -1
  233. package/dist/api/resources/ticketTypes/client/requests/UpdateTicketTypeRequest.js +1 -1
  234. package/dist/api/resources/ticketTypes/resources/attributes/client/Client.d.ts +2 -0
  235. package/dist/api/resources/ticketTypes/resources/attributes/client/Client.js +25 -15
  236. package/dist/api/resources/ticketTypes/resources/attributes/client/requests/CreateTicketTypeAttributeRequest.js +1 -1
  237. package/dist/api/resources/ticketTypes/resources/index.js +17 -7
  238. package/dist/api/resources/tickets/client/Client.d.ts +2 -0
  239. package/dist/api/resources/tickets/client/Client.js +34 -24
  240. package/dist/api/resources/tickets/client/requests/UpdateTicketRequest.js +1 -1
  241. package/dist/api/resources/tickets/types/Ticket.js +1 -1
  242. package/dist/api/resources/tickets/types/TicketPart.js +1 -1
  243. package/dist/api/resources/tickets/types/TicketType.js +1 -1
  244. package/dist/api/resources/tickets/types/TicketsReplyRequestBody.d.ts +1 -1
  245. package/dist/api/resources/visitors/client/Client.d.ts +2 -0
  246. package/dist/api/resources/visitors/client/Client.js +28 -18
  247. package/dist/api/types/ActionComponent.d.ts +1 -1
  248. package/dist/api/types/ActivityLog.js +1 -1
  249. package/dist/api/types/AdminReplyConversationRequest.js +1 -1
  250. package/dist/api/types/AdminReplyTicketRequest.js +1 -1
  251. package/dist/api/types/ArticleContent.js +1 -1
  252. package/dist/api/types/ArticleList.d.ts +1 -1
  253. package/dist/api/types/AssignConversationRequest.js +1 -1
  254. package/dist/api/types/ButtonComponent.js +1 -1
  255. package/dist/api/types/CheckboxComponent.js +1 -1
  256. package/dist/api/types/CollectionList.d.ts +1 -1
  257. package/dist/api/types/CompanyList.d.ts +1 -1
  258. package/dist/api/types/Component.d.ts +1 -1
  259. package/dist/api/types/ConfigureRequest.d.ts +1 -1
  260. package/dist/api/types/ConfigureResponse.d.ts +1 -1
  261. package/dist/api/types/ContactReplyConversationRequest.d.ts +1 -1
  262. package/dist/api/types/ContactReplyTicketRequest.d.ts +1 -1
  263. package/dist/api/types/Context.js +1 -1
  264. package/dist/api/types/ConversationSource.js +1 -1
  265. package/dist/api/types/CreateContactRequest.d.ts +1 -1
  266. package/dist/api/types/CreateDataEventRequest.d.ts +1 -1
  267. package/dist/api/types/CreateMessageRequest.d.ts +1 -1
  268. package/dist/api/types/CreateMessageRequest.js +1 -1
  269. package/dist/api/types/CreateTicketReplyWithCommentRequest.d.ts +1 -1
  270. package/dist/api/types/CustomAttributes.d.ts +1 -1
  271. package/dist/api/types/CustomerRequest.d.ts +1 -1
  272. package/dist/api/types/DropdownComponent.js +1 -1
  273. package/dist/api/types/ImageComponent.js +1 -1
  274. package/dist/api/types/InputComponent.js +1 -1
  275. package/dist/api/types/LinkedObject.js +1 -1
  276. package/dist/api/types/MultipleFilterSearchRequest.js +1 -1
  277. package/dist/api/types/MultipleOrSingleFilterSearchRequest.d.ts +1 -1
  278. package/dist/api/types/NewsItemRequest.js +1 -1
  279. package/dist/api/types/NoteList.d.ts +1 -1
  280. package/dist/api/types/OffsetPages.d.ts +14 -0
  281. package/dist/api/types/OffsetPages.js +5 -0
  282. package/dist/api/types/RedactConversationRequest.d.ts +1 -1
  283. package/dist/api/types/ReplyConversationRequest.d.ts +1 -1
  284. package/dist/api/types/SingleFilterSearchRequest.js +1 -1
  285. package/dist/api/types/SingleSelectComponent.js +1 -1
  286. package/dist/api/types/SlaApplied.js +1 -1
  287. package/dist/api/types/SpacerComponent.js +1 -1
  288. package/dist/api/types/TextComponent.js +1 -1
  289. package/dist/api/types/TicketCustomAttributes.d.ts +1 -1
  290. package/dist/api/types/TicketPartAuthor.js +1 -1
  291. package/dist/api/types/TicketReply.js +1 -1
  292. package/dist/api/types/TicketRequestCustomAttributes.d.ts +1 -1
  293. package/dist/api/types/TicketTypeAttribute.js +1 -1
  294. package/dist/api/types/UpdateVisitorRequest.d.ts +1 -1
  295. package/dist/api/types/index.d.ts +1 -0
  296. package/dist/api/types/index.js +1 -0
  297. package/dist/api/version.d.ts +1 -1
  298. package/dist/core/auth/BearerToken.d.ts +1 -1
  299. package/dist/core/fetcher/APIResponse.d.ts +1 -1
  300. package/dist/core/fetcher/Fetcher.d.ts +2 -2
  301. package/dist/core/fetcher/Fetcher.js +6 -5
  302. package/dist/core/fetcher/Supplier.d.ts +1 -1
  303. package/dist/core/fetcher/createRequestUrl.d.ts +1 -1
  304. package/dist/core/fetcher/createRequestUrl.js +1 -2
  305. package/dist/core/fetcher/getFetchFn.js +18 -9
  306. package/dist/core/fetcher/getHeader.js +1 -2
  307. package/dist/core/fetcher/getRequestBody.js +5 -5
  308. package/dist/core/fetcher/getResponseBody.js +1 -2
  309. package/dist/core/fetcher/makeRequest.d.ts +1 -1
  310. package/dist/core/fetcher/requestWithRetries.js +4 -5
  311. package/dist/core/fetcher/signals.d.ts +0 -1
  312. package/dist/core/fetcher/signals.js +2 -3
  313. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -1
  314. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +6 -4
  315. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +1 -1
  316. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +1 -1
  317. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +18 -9
  318. package/dist/core/json.d.ts +15 -0
  319. package/dist/core/json.js +24 -0
  320. package/dist/core/pagination/Page.js +9 -6
  321. package/dist/core/runtime/runtime.d.ts +1 -1
  322. package/dist/core/runtime/runtime.js +51 -41
  323. package/dist/core/utils/setObjectProperty.js +1 -2
  324. package/dist/environments.d.ts +1 -1
  325. package/dist/errors/IntercomError.js +2 -1
  326. package/dist/index.js +17 -7
  327. package/dist/version.d.ts +1 -1
  328. package/dist/version.js +1 -1
  329. package/environments.d.ts +1 -1
  330. package/errors/IntercomError.js +2 -1
  331. package/index.js +17 -7
  332. package/{jest.config.js → jest.config.mjs} +4 -1
  333. package/package.json +16 -16
  334. package/reference.md +32 -33
  335. package/scripts/rename-to-esm-files.js +115 -0
  336. package/version.d.ts +1 -1
  337. package/version.js +1 -1
package/Client.d.ts CHANGED
@@ -26,6 +26,8 @@ import { News } from "./api/resources/news/client/Client";
26
26
  export declare namespace IntercomClient {
27
27
  interface Options {
28
28
  environment?: core.Supplier<environments.IntercomEnvironment | string>;
29
+ /** Specify a custom URL to connect the client to. */
30
+ baseUrl?: core.Supplier<string>;
29
31
  token?: core.Supplier<core.BearerToken | undefined>;
30
32
  /** Override the Intercom-Version header */
31
33
  version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
package/README.md CHANGED
@@ -88,28 +88,6 @@ while (page.hasNextPage()) {
88
88
  }
89
89
  ```
90
90
 
91
- ## Request Options
92
-
93
- This client library also supports passing in [`request` options](https://github.com/axios/axios#request-config):
94
-
95
- ```typescript
96
- client.useRequestOpts({
97
- baseURL: "http://local.test-server.com",
98
- });
99
- ```
100
-
101
- Note that certain request options (such as `json`, and certain `headers` names cannot be overriden).
102
-
103
- ### Setting the API base url
104
-
105
- If you are using the european instance of intercom and would like to call it directly and not be redirected through our US instance, you can set the `baseUrl` as follows:
106
-
107
- ```typescript
108
- client.useRequestOpts({
109
- baseURL: "https://api.eu.intercom.io",
110
- });
111
- ```
112
-
113
91
  ## Advanced
114
92
 
115
93
  ### Additional Headers
@@ -127,14 +105,14 @@ const response = await client.articles.create(..., {
127
105
  ### Retries
128
106
 
129
107
  The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
130
- as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
108
+ as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
131
109
  retry limit (default: 2).
132
110
 
133
- A request is deemed retriable when any of the following HTTP status codes is returned:
111
+ A request is deemed retryable when any of the following HTTP status codes is returned:
134
112
 
135
- - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
136
- - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
137
- - [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
113
+ - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
114
+ - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
115
+ - [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
138
116
 
139
117
  Use the `maxRetries` request option to configure this behavior.
140
118
 
@@ -171,12 +149,12 @@ controller.abort(); // aborts the request
171
149
  The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
172
150
  runtimes:
173
151
 
174
- - Node.js 18+
175
- - Vercel
176
- - Cloudflare Workers
177
- - Deno v1.25+
178
- - Bun 1.0+
179
- - React Native
152
+ - Node.js 18+
153
+ - Vercel
154
+ - Cloudflare Workers
155
+ - Deno v1.25+
156
+ - Bun 1.0+
157
+ - React Native
180
158
 
181
159
  ### Customizing Fetch Client
182
160
 
@@ -201,3 +179,25 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg
201
179
  an issue first to discuss with us!
202
180
 
203
181
  On the other hand, contributions to the README are always very welcome!
182
+
183
+ ## Request Options
184
+
185
+ This client library also supports passing in [`request` options](https://github.com/axios/axios#request-config):
186
+
187
+ ```typescript
188
+ client.useRequestOpts({
189
+ baseURL: "http://local.test-server.com",
190
+ });
191
+ ```
192
+
193
+ Note that certain request options (such as `json`, and certain `headers` names cannot be overriden).
194
+
195
+ ### Setting the API base url
196
+
197
+ If you are using the european instance of intercom and would like to call it directly and not be redirected through our US instance, you can set the `baseUrl` as follows:
198
+
199
+ ```typescript
200
+ client.useRequestOpts({
201
+ baseURL: "https://api.eu.intercom.io",
202
+ });
203
+ ```
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.BadRequestError = void 0;
30
40
  const errors = __importStar(require("../../errors/index"));
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.ForbiddenError = void 0;
30
40
  const errors = __importStar(require("../../errors/index"));
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.NotFoundError = void 0;
30
40
  const errors = __importStar(require("../../errors/index"));
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.UnauthorizedError = void 0;
30
40
  const errors = __importStar(require("../../errors/index"));
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.UnprocessableEntityError = void 0;
30
40
  const errors = __importStar(require("../../errors/index"));
@@ -7,6 +7,8 @@ import * as Intercom from "../../../index";
7
7
  export declare namespace Admins {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.IntercomEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
10
12
  token?: core.Supplier<core.BearerToken | undefined>;
11
13
  /** Override the Intercom-Version header */
12
14
  version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
29
39
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
30
40
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -76,12 +86,12 @@ class Admins {
76
86
  * await client.admins.identify()
77
87
  */
78
88
  identify(requestOptions) {
79
- var _a, _b, _c, _d, _e;
80
89
  return __awaiter(this, void 0, void 0, function* () {
90
+ var _a, _b, _c, _d, _e, _f;
81
91
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
82
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.IntercomEnvironment.UsProduction, "me"),
92
+ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, "me"),
83
93
  method: "GET",
84
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.1.0", "User-Agent": "intercom-client/6.1.0", "Intercom-Version": (_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
94
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.2.0", "User-Agent": "intercom-client/6.2.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
85
95
  contentType: "application/json",
86
96
  requestType: "json",
87
97
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000,
@@ -129,13 +139,13 @@ class Admins {
129
139
  * })
130
140
  */
131
141
  away(request, requestOptions) {
132
- var _a, _b, _c, _d, _e;
133
142
  return __awaiter(this, void 0, void 0, function* () {
143
+ var _a, _b, _c, _d, _e, _f;
134
144
  const { admin_id: adminId } = request, _body = __rest(request, ["admin_id"]);
135
145
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
136
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.IntercomEnvironment.UsProduction, `admins/${encodeURIComponent(adminId)}/away`),
146
+ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, `admins/${encodeURIComponent(adminId)}/away`),
137
147
  method: "PUT",
138
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.1.0", "User-Agent": "intercom-client/6.1.0", "Intercom-Version": (_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
148
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.2.0", "User-Agent": "intercom-client/6.2.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
139
149
  contentType: "application/json",
140
150
  requestType: "json",
141
151
  body: _body,
@@ -189,8 +199,8 @@ class Admins {
189
199
  * })
190
200
  */
191
201
  listAllActivityLogs(request, requestOptions) {
192
- var _a, _b, _c, _d, _e;
193
202
  return __awaiter(this, void 0, void 0, function* () {
203
+ var _a, _b, _c, _d, _e, _f;
194
204
  const { created_at_after: createdAtAfter, created_at_before: createdAtBefore } = request;
195
205
  const _queryParams = {};
196
206
  _queryParams["created_at_after"] = createdAtAfter;
@@ -198,9 +208,9 @@ class Admins {
198
208
  _queryParams["created_at_before"] = createdAtBefore;
199
209
  }
200
210
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
201
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.IntercomEnvironment.UsProduction, "admins/activity_logs"),
211
+ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, "admins/activity_logs"),
202
212
  method: "GET",
203
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.1.0", "User-Agent": "intercom-client/6.1.0", "Intercom-Version": (_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
213
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.2.0", "User-Agent": "intercom-client/6.2.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
204
214
  contentType: "application/json",
205
215
  queryParameters: _queryParams,
206
216
  requestType: "json",
@@ -248,12 +258,12 @@ class Admins {
248
258
  * await client.admins.list()
249
259
  */
250
260
  list(requestOptions) {
251
- var _a, _b, _c, _d, _e;
252
261
  return __awaiter(this, void 0, void 0, function* () {
262
+ var _a, _b, _c, _d, _e, _f;
253
263
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
254
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.IntercomEnvironment.UsProduction, "admins"),
264
+ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, "admins"),
255
265
  method: "GET",
256
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.1.0", "User-Agent": "intercom-client/6.1.0", "Intercom-Version": (_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
266
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.2.0", "User-Agent": "intercom-client/6.2.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
257
267
  contentType: "application/json",
258
268
  requestType: "json",
259
269
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000,
@@ -304,13 +314,13 @@ class Admins {
304
314
  * })
305
315
  */
306
316
  find(request, requestOptions) {
307
- var _a, _b, _c, _d, _e;
308
317
  return __awaiter(this, void 0, void 0, function* () {
318
+ var _a, _b, _c, _d, _e, _f;
309
319
  const { admin_id: adminId } = request;
310
320
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
311
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.IntercomEnvironment.UsProduction, `admins/${encodeURIComponent(adminId)}`),
321
+ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, `admins/${encodeURIComponent(adminId)}`),
312
322
  method: "GET",
313
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.1.0", "User-Agent": "intercom-client/6.1.0", "Intercom-Version": (_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
323
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.2.0", "User-Agent": "intercom-client/6.2.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
314
324
  contentType: "application/json",
315
325
  requestType: "json",
316
326
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000,
@@ -349,12 +359,12 @@ class Admins {
349
359
  });
350
360
  }
351
361
  _getAuthorizationHeader() {
352
- var _a;
353
362
  return __awaiter(this, void 0, void 0, function* () {
363
+ var _a;
354
364
  const bearer = (_a = (yield core.Supplier.get(this._options.token))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["INTERCOM_API_KEY"];
355
365
  if (bearer == null) {
356
366
  throw new errors.IntercomError({
357
- message: "Please specify INTERCOM_API_KEY when instantiating the client.",
367
+ message: "Please specify a bearer by either passing it in to the constructor or initializing a INTERCOM_API_KEY environment variable",
358
368
  });
359
369
  }
360
370
  return `Bearer ${bearer}`;
@@ -13,4 +13,4 @@ var AiAgent;
13
13
  WorkflowPreview: "workflow_preview",
14
14
  FinPreview: "fin_preview",
15
15
  };
16
- })(AiAgent = exports.AiAgent || (exports.AiAgent = {}));
16
+ })(AiAgent || (exports.AiAgent = AiAgent = {}));
@@ -13,4 +13,4 @@ var ContentSource;
13
13
  ContentSnippet: "content_snippet",
14
14
  WorkflowConnectorAction: "workflow_connector_action",
15
15
  };
16
- })(ContentSource = exports.ContentSource || (exports.ContentSource = {}));
16
+ })(ContentSource || (exports.ContentSource = ContentSource = {}));
@@ -7,6 +7,8 @@ import * as Intercom from "../../../index";
7
7
  export declare namespace Articles {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.IntercomEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
10
12
  token?: core.Supplier<core.BearerToken | undefined>;
11
13
  /** Override the Intercom-Version header */
12
14
  version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";