intercom-client 7.0.1 → 7.0.2

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 (152) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +3 -0
  3. package/dist/cjs/Client.js +33 -28
  4. package/dist/cjs/api/resources/index.d.ts +1 -0
  5. package/dist/cjs/api/resources/index.js +2 -1
  6. package/dist/cjs/api/resources/ipAllowlist/client/Client.d.ts +56 -0
  7. package/dist/cjs/api/resources/ipAllowlist/client/Client.js +176 -0
  8. package/dist/cjs/api/resources/ipAllowlist/client/index.d.ts +1 -0
  9. package/dist/cjs/api/resources/ipAllowlist/client/index.js +2 -0
  10. package/dist/cjs/api/resources/ipAllowlist/index.d.ts +1 -0
  11. package/dist/cjs/api/resources/ipAllowlist/index.js +17 -0
  12. package/dist/cjs/api/resources/unstable/client/Client.d.ts +3 -0
  13. package/dist/cjs/api/resources/unstable/client/Client.js +5 -0
  14. package/dist/cjs/api/resources/unstable/resources/aiAgent/types/AiAgent.d.ts +1 -0
  15. package/dist/cjs/api/resources/unstable/resources/aiAgent/types/AiAgent.js +1 -0
  16. package/dist/cjs/api/resources/unstable/resources/contacts/client/requests/UpdateContactRequest.d.ts +2 -0
  17. package/dist/cjs/api/resources/unstable/resources/contacts/types/Contact.d.ts +1 -1
  18. package/dist/cjs/api/resources/unstable/resources/conversations/client/Client.d.ts +18 -0
  19. package/dist/cjs/api/resources/unstable/resources/conversations/client/Client.js +56 -0
  20. package/dist/cjs/api/resources/unstable/resources/conversations/client/requests/ListHandlingEventsRequest.d.ts +10 -0
  21. package/dist/cjs/api/resources/unstable/resources/conversations/client/requests/ListHandlingEventsRequest.js +3 -0
  22. package/dist/cjs/api/resources/unstable/resources/conversations/client/requests/index.d.ts +1 -0
  23. package/dist/cjs/api/resources/unstable/resources/conversations/types/Conversation.d.ts +2 -0
  24. package/dist/cjs/api/resources/unstable/resources/index.d.ts +2 -0
  25. package/dist/cjs/api/resources/unstable/resources/index.js +3 -1
  26. package/dist/cjs/api/resources/unstable/resources/workflows/client/Client.d.ts +39 -0
  27. package/dist/cjs/api/resources/unstable/resources/workflows/client/Client.js +122 -0
  28. package/dist/cjs/api/resources/unstable/resources/workflows/client/index.d.ts +1 -0
  29. package/dist/cjs/api/resources/unstable/resources/workflows/client/index.js +17 -0
  30. package/dist/cjs/api/resources/unstable/resources/workflows/client/requests/ExportWorkflowRequest.d.ts +10 -0
  31. package/dist/cjs/api/resources/unstable/resources/workflows/client/requests/ExportWorkflowRequest.js +3 -0
  32. package/dist/cjs/api/resources/unstable/resources/workflows/client/requests/index.d.ts +1 -0
  33. package/dist/cjs/api/resources/unstable/resources/workflows/client/requests/index.js +2 -0
  34. package/dist/cjs/api/resources/unstable/resources/workflows/index.d.ts +1 -0
  35. package/dist/cjs/api/resources/unstable/resources/workflows/index.js +17 -0
  36. package/dist/cjs/api/resources/unstable/types/ConversationAttributeUpdatedByAdmin.d.ts +3 -1
  37. package/dist/cjs/api/resources/unstable/types/ConversationAttributeUpdatedByUser.d.ts +19 -0
  38. package/dist/cjs/api/resources/unstable/types/ConversationAttributeUpdatedByUser.js +3 -0
  39. package/dist/cjs/api/resources/unstable/types/ConversationSlaAppliedByRule.d.ts +24 -0
  40. package/dist/cjs/api/resources/unstable/types/ConversationSlaAppliedByRule.js +3 -0
  41. package/dist/cjs/api/resources/unstable/types/ConversationSlaAppliedByWorkflow.d.ts +24 -0
  42. package/dist/cjs/api/resources/unstable/types/ConversationSlaAppliedByWorkflow.js +3 -0
  43. package/dist/cjs/api/resources/unstable/types/ConversationSlaPaused.d.ts +29 -0
  44. package/dist/cjs/api/resources/unstable/types/ConversationSlaPaused.js +14 -0
  45. package/dist/cjs/api/resources/unstable/types/ConversationSlaRemoved.d.ts +7 -0
  46. package/dist/cjs/api/resources/unstable/types/ConversationSlaRemoved.js +3 -0
  47. package/dist/cjs/api/resources/unstable/types/ConversationSlaTargetMissed.d.ts +50 -0
  48. package/dist/cjs/api/resources/unstable/types/ConversationSlaTargetMissed.js +35 -0
  49. package/dist/cjs/api/resources/unstable/types/ConversationSlaUnpaused.d.ts +7 -0
  50. package/dist/cjs/api/resources/unstable/types/ConversationSlaUnpaused.js +3 -0
  51. package/dist/cjs/api/resources/unstable/types/ConversationTagsUpdated.d.ts +9 -0
  52. package/dist/cjs/api/resources/unstable/types/ConversationTagsUpdated.js +3 -0
  53. package/dist/cjs/api/resources/unstable/types/EventDetails.d.ts +1 -1
  54. package/dist/cjs/api/resources/unstable/types/HandlingEvent.d.ts +21 -0
  55. package/dist/cjs/api/resources/unstable/types/HandlingEvent.js +12 -0
  56. package/dist/cjs/api/resources/unstable/types/HandlingEventList.d.ts +8 -0
  57. package/dist/cjs/api/resources/unstable/types/HandlingEventList.js +3 -0
  58. package/dist/cjs/api/resources/unstable/types/PriorityChanged.d.ts +23 -0
  59. package/dist/cjs/api/resources/unstable/types/PriorityChanged.js +17 -0
  60. package/dist/cjs/api/resources/unstable/types/Snoozed.d.ts +9 -0
  61. package/dist/cjs/api/resources/unstable/types/Snoozed.js +3 -0
  62. package/dist/cjs/api/resources/unstable/types/TeammateReference.d.ts +22 -0
  63. package/dist/cjs/api/resources/unstable/types/TeammateReference.js +13 -0
  64. package/dist/cjs/api/resources/unstable/types/WorkflowExport.d.ts +55 -0
  65. package/dist/cjs/api/resources/unstable/types/WorkflowExport.js +16 -0
  66. package/dist/cjs/api/resources/unstable/types/index.d.ts +14 -0
  67. package/dist/cjs/api/resources/unstable/types/index.js +14 -0
  68. package/dist/cjs/api/types/ActivityLog.d.ts +6 -1
  69. package/dist/cjs/api/types/ActivityLog.js +6 -1
  70. package/dist/cjs/api/types/IpAllowlist.d.ts +16 -0
  71. package/dist/cjs/api/types/IpAllowlist.js +3 -0
  72. package/dist/cjs/api/types/index.d.ts +1 -0
  73. package/dist/cjs/api/types/index.js +1 -0
  74. package/dist/cjs/version.d.ts +1 -1
  75. package/dist/cjs/version.js +1 -1
  76. package/dist/esm/BaseClient.mjs +2 -2
  77. package/dist/esm/Client.d.mts +3 -0
  78. package/dist/esm/Client.mjs +5 -0
  79. package/dist/esm/api/resources/index.d.mts +1 -0
  80. package/dist/esm/api/resources/index.mjs +1 -0
  81. package/dist/esm/api/resources/ipAllowlist/client/Client.d.mts +56 -0
  82. package/dist/esm/api/resources/ipAllowlist/client/Client.mjs +139 -0
  83. package/dist/esm/api/resources/ipAllowlist/client/index.d.mts +1 -0
  84. package/dist/esm/api/resources/ipAllowlist/client/index.mjs +1 -0
  85. package/dist/esm/api/resources/ipAllowlist/index.d.mts +1 -0
  86. package/dist/esm/api/resources/ipAllowlist/index.mjs +1 -0
  87. package/dist/esm/api/resources/unstable/client/Client.d.mts +3 -0
  88. package/dist/esm/api/resources/unstable/client/Client.mjs +5 -0
  89. package/dist/esm/api/resources/unstable/resources/aiAgent/types/AiAgent.d.mts +1 -0
  90. package/dist/esm/api/resources/unstable/resources/aiAgent/types/AiAgent.mjs +1 -0
  91. package/dist/esm/api/resources/unstable/resources/contacts/client/requests/UpdateContactRequest.d.mts +2 -0
  92. package/dist/esm/api/resources/unstable/resources/contacts/types/Contact.d.mts +1 -1
  93. package/dist/esm/api/resources/unstable/resources/conversations/client/Client.d.mts +18 -0
  94. package/dist/esm/api/resources/unstable/resources/conversations/client/Client.mjs +56 -0
  95. package/dist/esm/api/resources/unstable/resources/conversations/client/requests/ListHandlingEventsRequest.d.mts +10 -0
  96. package/dist/esm/api/resources/unstable/resources/conversations/client/requests/ListHandlingEventsRequest.mjs +2 -0
  97. package/dist/esm/api/resources/unstable/resources/conversations/client/requests/index.d.mts +1 -0
  98. package/dist/esm/api/resources/unstable/resources/conversations/types/Conversation.d.mts +2 -0
  99. package/dist/esm/api/resources/unstable/resources/index.d.mts +2 -0
  100. package/dist/esm/api/resources/unstable/resources/index.mjs +2 -0
  101. package/dist/esm/api/resources/unstable/resources/workflows/client/Client.d.mts +39 -0
  102. package/dist/esm/api/resources/unstable/resources/workflows/client/Client.mjs +85 -0
  103. package/dist/esm/api/resources/unstable/resources/workflows/client/index.d.mts +1 -0
  104. package/dist/esm/api/resources/unstable/resources/workflows/client/index.mjs +1 -0
  105. package/dist/esm/api/resources/unstable/resources/workflows/client/requests/ExportWorkflowRequest.d.mts +10 -0
  106. package/dist/esm/api/resources/unstable/resources/workflows/client/requests/ExportWorkflowRequest.mjs +2 -0
  107. package/dist/esm/api/resources/unstable/resources/workflows/client/requests/index.d.mts +1 -0
  108. package/dist/esm/api/resources/unstable/resources/workflows/client/requests/index.mjs +1 -0
  109. package/dist/esm/api/resources/unstable/resources/workflows/index.d.mts +1 -0
  110. package/dist/esm/api/resources/unstable/resources/workflows/index.mjs +1 -0
  111. package/dist/esm/api/resources/unstable/types/ConversationAttributeUpdatedByAdmin.d.mts +3 -1
  112. package/dist/esm/api/resources/unstable/types/ConversationAttributeUpdatedByUser.d.mts +19 -0
  113. package/dist/esm/api/resources/unstable/types/ConversationAttributeUpdatedByUser.mjs +2 -0
  114. package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByRule.d.mts +24 -0
  115. package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByRule.mjs +2 -0
  116. package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByWorkflow.d.mts +24 -0
  117. package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByWorkflow.mjs +2 -0
  118. package/dist/esm/api/resources/unstable/types/ConversationSlaPaused.d.mts +29 -0
  119. package/dist/esm/api/resources/unstable/types/ConversationSlaPaused.mjs +11 -0
  120. package/dist/esm/api/resources/unstable/types/ConversationSlaRemoved.d.mts +7 -0
  121. package/dist/esm/api/resources/unstable/types/ConversationSlaRemoved.mjs +2 -0
  122. package/dist/esm/api/resources/unstable/types/ConversationSlaTargetMissed.d.mts +50 -0
  123. package/dist/esm/api/resources/unstable/types/ConversationSlaTargetMissed.mjs +32 -0
  124. package/dist/esm/api/resources/unstable/types/ConversationSlaUnpaused.d.mts +7 -0
  125. package/dist/esm/api/resources/unstable/types/ConversationSlaUnpaused.mjs +2 -0
  126. package/dist/esm/api/resources/unstable/types/ConversationTagsUpdated.d.mts +9 -0
  127. package/dist/esm/api/resources/unstable/types/ConversationTagsUpdated.mjs +2 -0
  128. package/dist/esm/api/resources/unstable/types/EventDetails.d.mts +1 -1
  129. package/dist/esm/api/resources/unstable/types/HandlingEvent.d.mts +21 -0
  130. package/dist/esm/api/resources/unstable/types/HandlingEvent.mjs +9 -0
  131. package/dist/esm/api/resources/unstable/types/HandlingEventList.d.mts +8 -0
  132. package/dist/esm/api/resources/unstable/types/HandlingEventList.mjs +2 -0
  133. package/dist/esm/api/resources/unstable/types/PriorityChanged.d.mts +23 -0
  134. package/dist/esm/api/resources/unstable/types/PriorityChanged.mjs +14 -0
  135. package/dist/esm/api/resources/unstable/types/Snoozed.d.mts +9 -0
  136. package/dist/esm/api/resources/unstable/types/Snoozed.mjs +2 -0
  137. package/dist/esm/api/resources/unstable/types/TeammateReference.d.mts +22 -0
  138. package/dist/esm/api/resources/unstable/types/TeammateReference.mjs +10 -0
  139. package/dist/esm/api/resources/unstable/types/WorkflowExport.d.mts +55 -0
  140. package/dist/esm/api/resources/unstable/types/WorkflowExport.mjs +13 -0
  141. package/dist/esm/api/resources/unstable/types/index.d.mts +14 -0
  142. package/dist/esm/api/resources/unstable/types/index.mjs +14 -0
  143. package/dist/esm/api/types/ActivityLog.d.mts +6 -1
  144. package/dist/esm/api/types/ActivityLog.mjs +6 -1
  145. package/dist/esm/api/types/IpAllowlist.d.mts +16 -0
  146. package/dist/esm/api/types/IpAllowlist.mjs +2 -0
  147. package/dist/esm/api/types/index.d.mts +1 -0
  148. package/dist/esm/api/types/index.mjs +1 -0
  149. package/dist/esm/version.d.mts +1 -1
  150. package/dist/esm/version.mjs +1 -1
  151. package/package.json +1 -1
  152. package/reference.md +265 -0
package/reference.md CHANGED
@@ -2451,6 +2451,132 @@ await client.internalArticles.searchInternalArticles({
2451
2451
  </dl>
2452
2452
 
2453
2453
 
2454
+ </dd>
2455
+ </dl>
2456
+ </details>
2457
+
2458
+ ## IP Allowlist
2459
+ <details><summary><code>client.ipAllowlist.<a href="/src/api/resources/ipAllowlist/client/Client.ts">getIpAllowlist</a>() -> Intercom.IpAllowlist</code></summary>
2460
+ <dl>
2461
+ <dd>
2462
+
2463
+ #### 📝 Description
2464
+
2465
+ <dl>
2466
+ <dd>
2467
+
2468
+ <dl>
2469
+ <dd>
2470
+
2471
+ Retrieve the current IP allowlist configuration for the workspace.
2472
+ </dd>
2473
+ </dl>
2474
+ </dd>
2475
+ </dl>
2476
+
2477
+ #### 🔌 Usage
2478
+
2479
+ <dl>
2480
+ <dd>
2481
+
2482
+ <dl>
2483
+ <dd>
2484
+
2485
+ ```typescript
2486
+ await client.ipAllowlist.getIpAllowlist();
2487
+
2488
+ ```
2489
+ </dd>
2490
+ </dl>
2491
+ </dd>
2492
+ </dl>
2493
+
2494
+ #### ⚙️ Parameters
2495
+
2496
+ <dl>
2497
+ <dd>
2498
+
2499
+ <dl>
2500
+ <dd>
2501
+
2502
+ **requestOptions:** `IpAllowlistClient.RequestOptions`
2503
+
2504
+ </dd>
2505
+ </dl>
2506
+ </dd>
2507
+ </dl>
2508
+
2509
+
2510
+ </dd>
2511
+ </dl>
2512
+ </details>
2513
+
2514
+ <details><summary><code>client.ipAllowlist.<a href="/src/api/resources/ipAllowlist/client/Client.ts">updateIpAllowlist</a>({ ...params }) -> Intercom.IpAllowlist</code></summary>
2515
+ <dl>
2516
+ <dd>
2517
+
2518
+ #### 📝 Description
2519
+
2520
+ <dl>
2521
+ <dd>
2522
+
2523
+ <dl>
2524
+ <dd>
2525
+
2526
+ Update the IP allowlist configuration for the workspace.
2527
+
2528
+ {% admonition type="warning" name="Lockout Protection" %}
2529
+ The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.
2530
+ {% /admonition %}
2531
+ </dd>
2532
+ </dl>
2533
+ </dd>
2534
+ </dl>
2535
+
2536
+ #### 🔌 Usage
2537
+
2538
+ <dl>
2539
+ <dd>
2540
+
2541
+ <dl>
2542
+ <dd>
2543
+
2544
+ ```typescript
2545
+ await client.ipAllowlist.updateIpAllowlist({
2546
+ enabled: true,
2547
+ ip_allowlist: ["192.168.1.0/24", "10.0.0.1"]
2548
+ });
2549
+
2550
+ ```
2551
+ </dd>
2552
+ </dl>
2553
+ </dd>
2554
+ </dl>
2555
+
2556
+ #### ⚙️ Parameters
2557
+
2558
+ <dl>
2559
+ <dd>
2560
+
2561
+ <dl>
2562
+ <dd>
2563
+
2564
+ **request:** `Intercom.IpAllowlist`
2565
+
2566
+ </dd>
2567
+ </dl>
2568
+
2569
+ <dl>
2570
+ <dd>
2571
+
2572
+ **requestOptions:** `IpAllowlistClient.RequestOptions`
2573
+
2574
+ </dd>
2575
+ </dl>
2576
+ </dd>
2577
+ </dl>
2578
+
2579
+
2454
2580
  </dd>
2455
2581
  </dl>
2456
2582
  </details>
@@ -16633,6 +16759,73 @@ await client.unstable.conversations.detachContactFromConversation({
16633
16759
  </dl>
16634
16760
 
16635
16761
 
16762
+ </dd>
16763
+ </dl>
16764
+ </details>
16765
+
16766
+ <details><summary><code>client.unstable.conversations.<a href="/src/api/resources/unstable/resources/conversations/client/Client.ts">listHandlingEvents</a>({ ...params }) -> Intercom.HandlingEventList</code></summary>
16767
+ <dl>
16768
+ <dd>
16769
+
16770
+ #### 📝 Description
16771
+
16772
+ <dl>
16773
+ <dd>
16774
+
16775
+ <dl>
16776
+ <dd>
16777
+
16778
+ List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.
16779
+
16780
+ Requires the `read_conversations` OAuth scope.
16781
+ </dd>
16782
+ </dl>
16783
+ </dd>
16784
+ </dl>
16785
+
16786
+ #### 🔌 Usage
16787
+
16788
+ <dl>
16789
+ <dd>
16790
+
16791
+ <dl>
16792
+ <dd>
16793
+
16794
+ ```typescript
16795
+ await client.unstable.conversations.listHandlingEvents({
16796
+ id: "123"
16797
+ });
16798
+
16799
+ ```
16800
+ </dd>
16801
+ </dl>
16802
+ </dd>
16803
+ </dl>
16804
+
16805
+ #### ⚙️ Parameters
16806
+
16807
+ <dl>
16808
+ <dd>
16809
+
16810
+ <dl>
16811
+ <dd>
16812
+
16813
+ **request:** `Intercom.unstable.ListHandlingEventsRequest`
16814
+
16815
+ </dd>
16816
+ </dl>
16817
+
16818
+ <dl>
16819
+ <dd>
16820
+
16821
+ **requestOptions:** `ConversationsClient.RequestOptions`
16822
+
16823
+ </dd>
16824
+ </dl>
16825
+ </dd>
16826
+ </dl>
16827
+
16828
+
16636
16829
  </dd>
16637
16830
  </dl>
16638
16831
  </details>
@@ -18150,6 +18343,78 @@ await client.unstable.dataExport.downloadDataExport({
18150
18343
  </dl>
18151
18344
 
18152
18345
 
18346
+ </dd>
18347
+ </dl>
18348
+ </details>
18349
+
18350
+ ## Workflows
18351
+ <details><summary><code>client.unstable.workflows.<a href="/src/api/resources/unstable/resources/workflows/client/Client.ts">exportWorkflow</a>({ ...params }) -> Intercom.WorkflowExport</code></summary>
18352
+ <dl>
18353
+ <dd>
18354
+
18355
+ #### 📝 Description
18356
+
18357
+ <dl>
18358
+ <dd>
18359
+
18360
+ <dl>
18361
+ <dd>
18362
+
18363
+ Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.
18364
+
18365
+ This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.
18366
+
18367
+ {% admonition type="warning" name="Unstable API" %}
18368
+ This API is currently in the Unstable version. Its behavior may change in future releases.
18369
+ {% /admonition %}
18370
+ </dd>
18371
+ </dl>
18372
+ </dd>
18373
+ </dl>
18374
+
18375
+ #### 🔌 Usage
18376
+
18377
+ <dl>
18378
+ <dd>
18379
+
18380
+ <dl>
18381
+ <dd>
18382
+
18383
+ ```typescript
18384
+ await client.unstable.workflows.exportWorkflow({
18385
+ id: "12345"
18386
+ });
18387
+
18388
+ ```
18389
+ </dd>
18390
+ </dl>
18391
+ </dd>
18392
+ </dl>
18393
+
18394
+ #### ⚙️ Parameters
18395
+
18396
+ <dl>
18397
+ <dd>
18398
+
18399
+ <dl>
18400
+ <dd>
18401
+
18402
+ **request:** `Intercom.unstable.ExportWorkflowRequest`
18403
+
18404
+ </dd>
18405
+ </dl>
18406
+
18407
+ <dl>
18408
+ <dd>
18409
+
18410
+ **requestOptions:** `WorkflowsClient.RequestOptions`
18411
+
18412
+ </dd>
18413
+ </dl>
18414
+ </dd>
18415
+ </dl>
18416
+
18417
+
18153
18418
  </dd>
18154
18419
  </dl>
18155
18420
  </details>