@rc-ex/core 1.3.13 → 1.3.14

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 (143) hide show
  1. package/lib/definitions/ContactBusinessAddressInfo.d.ts +6 -6
  2. package/lib/definitions/ContactInfo.d.ts +12 -13
  3. package/lib/definitions/CreateFaxMessageRequest.d.ts +2 -1
  4. package/lib/definitions/CreateUserEmergencyLocationRequest.d.ts +4 -0
  5. package/lib/definitions/DepartmentInfo.d.ts +2 -2
  6. package/lib/definitions/DeviceResource.d.ts +5 -5
  7. package/lib/definitions/EmergencyLocationRequestResource.d.ts +42 -0
  8. package/lib/definitions/{ImportIdentityRequest.js → EmergencyLocationRequestResource.js} +1 -1
  9. package/lib/definitions/EmergencyLocationRequestResource.js.map +1 -0
  10. package/lib/definitions/EmergencyLocationResponseResource.d.ts +58 -0
  11. package/lib/definitions/EmergencyLocationResponseResource.js +3 -0
  12. package/lib/definitions/EmergencyLocationResponseResource.js.map +1 -0
  13. package/lib/definitions/ExtensionBulkUpdateInfo.d.ts +2 -0
  14. package/lib/definitions/ExtensionCreationRequest.d.ts +1 -2
  15. package/lib/definitions/ExtensionCreationResponse.d.ts +2 -2
  16. package/lib/definitions/ExtensionUpdateRequest.d.ts +2 -0
  17. package/lib/definitions/GetAccountInfoResponse.d.ts +2 -3
  18. package/lib/definitions/GetExtensionInfoResponse.d.ts +1 -1
  19. package/lib/definitions/GrantInfo.d.ts +4 -0
  20. package/lib/definitions/MessageStoreConfiguration.d.ts +1 -1
  21. package/lib/definitions/PauseResumeCallRecordingParameters.d.ts +1 -1
  22. package/lib/definitions/PronouncedNameInfo.d.ts +5 -6
  23. package/lib/definitions/ReadA2PSMSOptOutsParameters.d.ts +2 -1
  24. package/lib/definitions/ReadCallSessionStatusParameters.d.ts +2 -1
  25. package/lib/definitions/SipRegistrationDeviceInfo.d.ts +4 -7
  26. package/lib/definitions/SyncAccountCallLogParameters.d.ts +4 -1
  27. package/lib/definitions/SyncMessagesParameters.d.ts +1 -1
  28. package/lib/definitions/SyncUserCallLogParameters.d.ts +8 -3
  29. package/lib/definitions/TokenInfo.d.ts +3 -3
  30. package/lib/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.d.ts +1 -1
  31. package/lib/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.js +1 -1
  32. package/lib/paths/Ai/Audio/V1/Async/SpeechToText/index.d.ts +1 -1
  33. package/lib/paths/Ai/Audio/V1/Async/SpeechToText/index.js +1 -1
  34. package/lib/paths/Ai/Text/V1/Async/Punctuate/index.d.ts +1 -1
  35. package/lib/paths/Ai/Text/V1/Async/Punctuate/index.js +1 -1
  36. package/lib/paths/Ai/Text/V1/Async/Summarize/index.d.ts +3 -1
  37. package/lib/paths/Ai/Text/V1/Async/Summarize/index.js +3 -1
  38. package/lib/paths/Ai/Text/V1/Async/Summarize/index.js.map +1 -1
  39. package/lib/paths/Cx/SocialMessaging/V1/Identities/index.d.ts +0 -6
  40. package/lib/paths/Cx/SocialMessaging/V1/Identities/index.js +0 -15
  41. package/lib/paths/Cx/SocialMessaging/V1/Identities/index.js.map +1 -1
  42. package/lib/paths/Restapi/Account/A2pSms/OptOuts/index.d.ts +4 -1
  43. package/lib/paths/Restapi/Account/A2pSms/OptOuts/index.js +4 -1
  44. package/lib/paths/Restapi/Account/A2pSms/OptOuts/index.js.map +1 -1
  45. package/lib/paths/Restapi/Account/EmergencyLocations/index.d.ts +5 -4
  46. package/lib/paths/Restapi/Account/EmergencyLocations/index.js +4 -4
  47. package/lib/paths/Restapi/Account/EmergencyLocations/index.js.map +1 -1
  48. package/lib/paths/Restapi/Account/Extension/AssignedRole/index.d.ts +1 -1
  49. package/lib/paths/Restapi/Account/Extension/AssignedRole/index.js +1 -1
  50. package/lib/paths/Restapi/Account/Extension/EmergencyLocations/index.d.ts +4 -3
  51. package/lib/paths/Restapi/Account/Extension/EmergencyLocations/index.js +2 -2
  52. package/lib/paths/Restapi/Account/Extension/EmergencyLocations/index.js.map +1 -1
  53. package/lib/paths/Restapi/Account/Extension/Features/index.d.ts +6 -6
  54. package/lib/paths/Restapi/Account/Extension/Features/index.js +6 -6
  55. package/lib/paths/Restapi/Account/Extension/MessageStore/index.d.ts +3 -3
  56. package/lib/paths/Restapi/Account/Extension/MessageStore/index.js +3 -3
  57. package/lib/paths/Restapi/Account/Extension/OverflowSettings/index.d.ts +0 -1
  58. package/lib/paths/Restapi/Account/Extension/OverflowSettings/index.js +0 -1
  59. package/lib/paths/Restapi/Account/Extension/OverflowSettings/index.js.map +1 -1
  60. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.d.ts +6 -1
  61. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.js +6 -1
  62. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.js.map +1 -1
  63. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.d.ts +5 -1
  64. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.js +5 -1
  65. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.js.map +1 -1
  66. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.d.ts +1 -1
  67. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.js +1 -1
  68. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.d.ts +1 -1
  69. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.js +1 -1
  70. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.d.ts +11 -1
  71. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.js +11 -1
  72. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.js.map +1 -1
  73. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.d.ts +1 -1
  74. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.js +1 -1
  75. package/lib/paths/Restapi/Account/Telephony/Sessions/Supervise/index.d.ts +1 -1
  76. package/lib/paths/Restapi/Account/Telephony/Sessions/Supervise/index.js +1 -1
  77. package/lib/paths/Webinar/Configuration/V1/Webinars/index.d.ts +1 -1
  78. package/lib/paths/Webinar/Configuration/V1/Webinars/index.js +1 -1
  79. package/lib/paths/Webinar/Notifications/V1/Subscriptions/index.d.ts +1 -1
  80. package/lib/paths/Webinar/Notifications/V1/Subscriptions/index.js +1 -1
  81. package/package.json +2 -2
  82. package/src/definitions/ContactBusinessAddressInfo.ts +6 -6
  83. package/src/definitions/ContactInfo.ts +12 -13
  84. package/src/definitions/CreateFaxMessageRequest.ts +2 -1
  85. package/src/definitions/CreateUserEmergencyLocationRequest.ts +5 -0
  86. package/src/definitions/DepartmentInfo.ts +2 -2
  87. package/src/definitions/DeviceResource.ts +5 -5
  88. package/src/definitions/EmergencyLocationRequestResource.ts +52 -0
  89. package/src/definitions/EmergencyLocationResponseResource.ts +71 -0
  90. package/src/definitions/ExtensionBulkUpdateInfo.ts +2 -0
  91. package/src/definitions/ExtensionCreationRequest.ts +1 -2
  92. package/src/definitions/ExtensionCreationResponse.ts +2 -2
  93. package/src/definitions/ExtensionUpdateRequest.ts +2 -0
  94. package/src/definitions/GetAccountInfoResponse.ts +2 -3
  95. package/src/definitions/GetExtensionInfoResponse.ts +1 -1
  96. package/src/definitions/GrantInfo.ts +5 -0
  97. package/src/definitions/MessageStoreConfiguration.ts +1 -1
  98. package/src/definitions/PauseResumeCallRecordingParameters.ts +1 -1
  99. package/src/definitions/PronouncedNameInfo.ts +5 -6
  100. package/src/definitions/ReadA2PSMSOptOutsParameters.ts +2 -1
  101. package/src/definitions/ReadCallSessionStatusParameters.ts +2 -1
  102. package/src/definitions/SipRegistrationDeviceInfo.ts +4 -7
  103. package/src/definitions/SyncAccountCallLogParameters.ts +4 -1
  104. package/src/definitions/SyncMessagesParameters.ts +1 -1
  105. package/src/definitions/SyncUserCallLogParameters.ts +8 -3
  106. package/src/definitions/TokenInfo.ts +3 -3
  107. package/src/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.ts +1 -1
  108. package/src/paths/Ai/Audio/V1/Async/SpeechToText/index.ts +1 -1
  109. package/src/paths/Ai/Text/V1/Async/Punctuate/index.ts +1 -1
  110. package/src/paths/Ai/Text/V1/Async/Summarize/index.ts +3 -1
  111. package/src/paths/Cx/SocialMessaging/V1/Identities/index.ts +0 -15
  112. package/src/paths/Restapi/Account/A2pSms/OptOuts/index.ts +4 -1
  113. package/src/paths/Restapi/Account/EmergencyLocations/index.ts +11 -10
  114. package/src/paths/Restapi/Account/Extension/AssignedRole/index.ts +1 -1
  115. package/src/paths/Restapi/Account/Extension/EmergencyLocations/index.ts +8 -7
  116. package/src/paths/Restapi/Account/Extension/Features/index.ts +6 -6
  117. package/src/paths/Restapi/Account/Extension/MessageStore/index.ts +3 -3
  118. package/src/paths/Restapi/Account/Extension/OverflowSettings/index.ts +0 -1
  119. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.ts +6 -1
  120. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.ts +5 -1
  121. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.ts +1 -1
  122. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.ts +1 -1
  123. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.ts +11 -1
  124. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.ts +1 -1
  125. package/src/paths/Restapi/Account/Telephony/Sessions/Supervise/index.ts +1 -1
  126. package/src/paths/Webinar/Configuration/V1/Webinars/index.ts +1 -1
  127. package/src/paths/Webinar/Notifications/V1/Subscriptions/index.ts +1 -1
  128. package/src/samples.md +201 -267
  129. package/lib/definitions/ImportIdentityRequest.d.ts +0 -61
  130. package/lib/definitions/ImportIdentityRequest.js.map +0 -1
  131. package/lib/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.d.ts +0 -17
  132. package/lib/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.js +0 -25
  133. package/lib/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.js.map +0 -1
  134. package/lib/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.d.ts +0 -19
  135. package/lib/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.js +0 -27
  136. package/lib/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.js.map +0 -1
  137. package/lib/paths/Cx/SocialMessaging/V1/Identities/Import/index.d.ts +0 -20
  138. package/lib/paths/Cx/SocialMessaging/V1/Identities/Import/index.js +0 -27
  139. package/lib/paths/Cx/SocialMessaging/V1/Identities/Import/index.js.map +0 -1
  140. package/src/definitions/ImportIdentityRequest.ts +0 -73
  141. package/src/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.ts +0 -27
  142. package/src/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.ts +0 -29
  143. package/src/paths/Cx/SocialMessaging/V1/Identities/Import/index.ts +0 -33
package/src/samples.md CHANGED
@@ -3521,30 +3521,6 @@ await rc.revoke();
3521
3521
 
3522
3522
  [Try it out](https://developer.ringcentral.com/api-reference#Identities-socMsgGetIdentity) in API Explorer.
3523
3523
 
3524
- ## socMsgImportIdentity
3525
-
3526
- Import Identity
3527
-
3528
- | Name | Value |
3529
- | ---------------- | ------------------------------------------- |
3530
- | HTTP Method | `POST` |
3531
- | Endpoint | `/cx/social-messaging/v1/identities/import` |
3532
- | Rate Limit Group | `Light` |
3533
- | App Permission | `SocialMessaging` |
3534
- | User Permission | `N/A` |
3535
-
3536
- ```ts
3537
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
3538
- await rc.authorize({ jwt });
3539
- var result = await rc.cx().socialMessaging().v1().identities().import().post(importIdentityRequest);
3540
- await rc.revoke();
3541
- ```
3542
-
3543
- - `importIdentityRequest` is of type [ImportIdentityRequest](./definitions/ImportIdentityRequest.ts)
3544
- - `result` is an empty string
3545
-
3546
- [Try it out](https://developer.ringcentral.com/api-reference#Identities-socMsgImportIdentity) in API Explorer.
3547
-
3548
3524
  ## getExtensionRecordings
3549
3525
 
3550
3526
  List User Recordings
@@ -4003,7 +3979,7 @@ await rc.revoke();
4003
3979
 
4004
3980
  ## readA2PSMSOptOuts
4005
3981
 
4006
- Get Opted Out Numbers
3982
+ List Opted Out Numbers
4007
3983
 
4008
3984
  | Name | Value |
4009
3985
  | ---------------- | ------------------------------------------------------------ |
@@ -4676,6 +4652,31 @@ await rc.revoke();
4676
4652
 
4677
4653
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-updateCallRecordingSettings) in API Explorer.
4678
4654
 
4655
+ ## listCallRecordingExtensions
4656
+
4657
+ Get Call Recording Extension List
4658
+
4659
+ | Name | Value |
4660
+ | ---------------- | --------------------------------------------------------------------- |
4661
+ | HTTP Method | `GET` |
4662
+ | Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/extensions` |
4663
+ | Rate Limit Group | `Medium` |
4664
+ | App Permission | `ReadAccounts` |
4665
+ | User Permission | `ReadCompanyInfo` |
4666
+
4667
+ ```ts
4668
+ const rc = new RingCentral({ clientId, clientSecret, serverURL });
4669
+ await rc.authorize({ jwt });
4670
+ var result = await rc.restapi(apiVersion).account(accountId).callRecording().extensions().get();
4671
+ await rc.revoke();
4672
+ ```
4673
+
4674
+ - Parameter `apiVersion` is optional with default value `v1.0`
4675
+ - Parameter `accountId` is optional with default value `~`
4676
+ - `result` is of type [CallRecordingExtensions](./definitions/CallRecordingExtensions.ts)
4677
+
4678
+ [Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-listCallRecordingExtensions) in API Explorer.
4679
+
4679
4680
  ## deleteCompanyCallRecordings
4680
4681
 
4681
4682
  Delete Company Call Recordings
@@ -5015,14 +5016,18 @@ Add Emergency Location
5015
5016
  ```ts
5016
5017
  const rc = new RingCentral({ clientId, clientSecret, serverURL });
5017
5018
  await rc.authorize({ jwt });
5018
- var result = await rc.restapi(apiVersion).account(accountId).emergencyLocations().post(emergencyLocationInfoRequest);
5019
+ var result = await rc
5020
+ .restapi(apiVersion)
5021
+ .account(accountId)
5022
+ .emergencyLocations()
5023
+ .post(emergencyLocationRequestResource);
5019
5024
  await rc.revoke();
5020
5025
  ```
5021
5026
 
5022
5027
  - Parameter `apiVersion` is optional with default value `v1.0`
5023
5028
  - Parameter `accountId` is optional with default value `~`
5024
- - `emergencyLocationInfoRequest` is of type [EmergencyLocationInfoRequest](./definitions/EmergencyLocationInfoRequest.ts)
5025
- - `result` is of type [CommonEmergencyLocationResource](./definitions/CommonEmergencyLocationResource.ts)
5029
+ - `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts)
5030
+ - `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts)
5026
5031
 
5027
5032
  [Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-createEmergencyLocation) in API Explorer.
5028
5033
 
@@ -5075,14 +5080,14 @@ var result = await rc
5075
5080
  .restapi(apiVersion)
5076
5081
  .account(accountId)
5077
5082
  .emergencyLocations(locationId)
5078
- .put(emergencyLocationInfoRequest);
5083
+ .put(emergencyLocationRequestResource);
5079
5084
  await rc.revoke();
5080
5085
  ```
5081
5086
 
5082
5087
  - Parameter `apiVersion` is optional with default value `v1.0`
5083
5088
  - Parameter `accountId` is optional with default value `~`
5084
- - `emergencyLocationInfoRequest` is of type [EmergencyLocationInfoRequest](./definitions/EmergencyLocationInfoRequest.ts)
5085
- - `result` is of type [CommonEmergencyLocationResource](./definitions/CommonEmergencyLocationResource.ts)
5089
+ - `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts)
5090
+ - `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts)
5086
5091
 
5087
5092
  [Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-updateEmergencyLocation) in API Explorer.
5088
5093
 
@@ -5338,7 +5343,7 @@ List User Assigned Roles
5338
5343
  | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role` |
5339
5344
  | Rate Limit Group | `Light` |
5340
5345
  | App Permission | `ReadAccounts` |
5341
- | User Permission | `ReadExtensions` |
5346
+ | User Permission | `ReadAssignedRoles` |
5342
5347
 
5343
5348
  ```ts
5344
5349
  const rc = new RingCentral({ clientId, clientSecret, serverURL });
@@ -5637,6 +5642,64 @@ await rc.revoke();
5637
5642
 
5638
5643
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Queues-updateUserCallQueues) in API Explorer.
5639
5644
 
5645
+ ## readCallerBlockingSettings
5646
+
5647
+ Get Caller Blocking Settings
5648
+
5649
+ | Name | Value |
5650
+ | ---------------- | ----------------------------------------------------------------------------------- |
5651
+ | HTTP Method | `GET` |
5652
+ | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` |
5653
+ | Rate Limit Group | `Light` |
5654
+ | App Permission | `ReadAccounts` |
5655
+ | User Permission | `ReadBlockedNumbers` |
5656
+
5657
+ ```ts
5658
+ const rc = new RingCentral({ clientId, clientSecret, serverURL });
5659
+ await rc.authorize({ jwt });
5660
+ var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callerBlocking().get();
5661
+ await rc.revoke();
5662
+ ```
5663
+
5664
+ - Parameter `apiVersion` is optional with default value `v1.0`
5665
+ - Parameter `accountId` is optional with default value `~`
5666
+ - Parameter `extensionId` is optional with default value `~`
5667
+ - `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts)
5668
+
5669
+ [Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-readCallerBlockingSettings) in API Explorer.
5670
+
5671
+ ## updateCallerBlockingSettings
5672
+
5673
+ Update Caller Blocking Settings
5674
+
5675
+ | Name | Value |
5676
+ | ---------------- | ----------------------------------------------------------------------------------- |
5677
+ | HTTP Method | `PUT` |
5678
+ | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` |
5679
+ | Rate Limit Group | `Light` |
5680
+ | App Permission | `EditExtensions` |
5681
+ | User Permission | `EditBlockedNumbers` |
5682
+
5683
+ ```ts
5684
+ const rc = new RingCentral({ clientId, clientSecret, serverURL });
5685
+ await rc.authorize({ jwt });
5686
+ var result = await rc
5687
+ .restapi(apiVersion)
5688
+ .account(accountId)
5689
+ .extension(extensionId)
5690
+ .callerBlocking()
5691
+ .put(callerBlockingSettingsUpdate);
5692
+ await rc.revoke();
5693
+ ```
5694
+
5695
+ - Parameter `apiVersion` is optional with default value `v1.0`
5696
+ - Parameter `accountId` is optional with default value `~`
5697
+ - Parameter `extensionId` is optional with default value `~`
5698
+ - `callerBlockingSettingsUpdate` is of type [CallerBlockingSettingsUpdate](./definitions/CallerBlockingSettingsUpdate.ts)
5699
+ - `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts)
5700
+
5701
+ [Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-updateCallerBlockingSettings) in API Explorer.
5702
+
5640
5703
  ## readExtensionCallerId
5641
5704
 
5642
5705
  Get Extension Caller ID
@@ -8134,64 +8197,6 @@ await rc.revoke();
8134
8197
 
8135
8198
  [Try it out](https://developer.ringcentral.com/api-reference#Historical-Webinars-rcwHistoryGetSession) in API Explorer.
8136
8199
 
8137
- ## readCallerBlockingSettings
8138
-
8139
- Get Caller Blocking Settings
8140
-
8141
- | Name | Value |
8142
- | ---------------- | ----------------------------------------------------------------------------------- |
8143
- | HTTP Method | `GET` |
8144
- | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` |
8145
- | Rate Limit Group | `Light` |
8146
- | App Permission | `ReadAccounts` |
8147
- | User Permission | `ReadBlockedNumbers` |
8148
-
8149
- ```ts
8150
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
8151
- await rc.authorize({ jwt });
8152
- var result = await rc.restapi(apiVersion).account(accountId).extension(extensionId).callerBlocking().get();
8153
- await rc.revoke();
8154
- ```
8155
-
8156
- - Parameter `apiVersion` is optional with default value `v1.0`
8157
- - Parameter `accountId` is optional with default value `~`
8158
- - Parameter `extensionId` is optional with default value `~`
8159
- - `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts)
8160
-
8161
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-readCallerBlockingSettings) in API Explorer.
8162
-
8163
- ## updateCallerBlockingSettings
8164
-
8165
- Update Caller Blocking Settings
8166
-
8167
- | Name | Value |
8168
- | ---------------- | ----------------------------------------------------------------------------------- |
8169
- | HTTP Method | `PUT` |
8170
- | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking` |
8171
- | Rate Limit Group | `Light` |
8172
- | App Permission | `EditExtensions` |
8173
- | User Permission | `EditBlockedNumbers` |
8174
-
8175
- ```ts
8176
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
8177
- await rc.authorize({ jwt });
8178
- var result = await rc
8179
- .restapi(apiVersion)
8180
- .account(accountId)
8181
- .extension(extensionId)
8182
- .callerBlocking()
8183
- .put(callerBlockingSettingsUpdate);
8184
- await rc.revoke();
8185
- ```
8186
-
8187
- - Parameter `apiVersion` is optional with default value `v1.0`
8188
- - Parameter `accountId` is optional with default value `~`
8189
- - Parameter `extensionId` is optional with default value `~`
8190
- - `callerBlockingSettingsUpdate` is of type [CallerBlockingSettingsUpdate](./definitions/CallerBlockingSettingsUpdate.ts)
8191
- - `result` is of type [CallerBlockingSettings](./definitions/CallerBlockingSettings.ts)
8192
-
8193
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-updateCallerBlockingSettings) in API Explorer.
8194
-
8195
8200
  ## listExtensionPhoneNumbers
8196
8201
 
8197
8202
  Get Extension Phone Number List
@@ -8539,52 +8544,6 @@ await rc.revoke();
8539
8544
 
8540
8545
  [Try it out](https://developer.ringcentral.com/api-reference#Business-Analytics-analyticsCallsTimelineFetch) in API Explorer.
8541
8546
 
8542
- ## socMsgAnonymizeIdentity
8543
-
8544
- Anonymize Identity
8545
-
8546
- | Name | Value |
8547
- | ---------------- | ----------------------------------------------------------- |
8548
- | HTTP Method | `POST` |
8549
- | Endpoint | `/cx/social-messaging/v1/identities/{identityId}/anonymize` |
8550
- | Rate Limit Group | `Light` |
8551
- | App Permission | `SocialMessaging` |
8552
- | User Permission | `N/A` |
8553
-
8554
- ```ts
8555
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
8556
- await rc.authorize({ jwt });
8557
- var result = await rc.cx().socialMessaging().v1().identities(identityId).anonymize().post();
8558
- await rc.revoke();
8559
- ```
8560
-
8561
- - `result` is an empty string
8562
-
8563
- [Try it out](https://developer.ringcentral.com/api-reference#Identities-socMsgAnonymizeIdentity) in API Explorer.
8564
-
8565
- ## socMsgDeanonymizeIdentity
8566
-
8567
- Deanonymize Identity
8568
-
8569
- | Name | Value |
8570
- | ---------------- | ------------------------------------------------------------- |
8571
- | HTTP Method | `POST` |
8572
- | Endpoint | `/cx/social-messaging/v1/identities/{identityId}/deanonymize` |
8573
- | Rate Limit Group | `Light` |
8574
- | App Permission | `SocialMessaging` |
8575
- | User Permission | `N/A` |
8576
-
8577
- ```ts
8578
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
8579
- await rc.authorize({ jwt });
8580
- var result = await rc.cx().socialMessaging().v1().identities(identityId).deanonymize().post();
8581
- await rc.revoke();
8582
- ```
8583
-
8584
- - `result` is an empty string
8585
-
8586
- [Try it out](https://developer.ringcentral.com/api-reference#Identities-socMsgDeanonymizeIdentity) in API Explorer.
8587
-
8588
8547
  ## getDefaultBridge
8589
8548
 
8590
8549
  Get User's Default Bridge
@@ -8854,31 +8813,6 @@ await rc.revoke();
8854
8813
 
8855
8814
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-updateCallRecordingExtensionList) in API Explorer.
8856
8815
 
8857
- ## listCallRecordingExtensions
8858
-
8859
- Get Call Recording Extension List
8860
-
8861
- | Name | Value |
8862
- | ---------------- | --------------------------------------------------------------------- |
8863
- | HTTP Method | `GET` |
8864
- | Endpoint | `/restapi/{apiVersion}/account/{accountId}/call-recording/extensions` |
8865
- | Rate Limit Group | `Medium` |
8866
- | App Permission | `ReadAccounts` |
8867
- | User Permission | `ReadCompanyInfo` |
8868
-
8869
- ```ts
8870
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
8871
- await rc.authorize({ jwt });
8872
- var result = await rc.restapi(apiVersion).account(accountId).callRecording().extensions().get();
8873
- await rc.revoke();
8874
- ```
8875
-
8876
- - Parameter `apiVersion` is optional with default value `v1.0`
8877
- - Parameter `accountId` is optional with default value `~`
8878
- - `result` is of type [CallRecordingExtensions](./definitions/CallRecordingExtensions.ts)
8879
-
8880
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Recording-Settings-listCallRecordingExtensions) in API Explorer.
8881
-
8882
8816
  ## getExtensionBulkUpdateTask
8883
8817
 
8884
8818
  Get Extension Update Task Status
@@ -9438,7 +9372,7 @@ await rc.revoke();
9438
9372
  - Parameter `accountId` is optional with default value `~`
9439
9373
  - Parameter `extensionId` is optional with default value `~`
9440
9374
  - `createUserEmergencyLocationRequest` is of type [CreateUserEmergencyLocationRequest](./definitions/CreateUserEmergencyLocationRequest.ts)
9441
- - `result` is of type [CommonEmergencyLocationResource](./definitions/CommonEmergencyLocationResource.ts)
9375
+ - `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts)
9442
9376
 
9443
9377
  [Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-createExtensionEmergencyLocation) in API Explorer.
9444
9378
 
@@ -9493,15 +9427,15 @@ var result = await rc
9493
9427
  .account(accountId)
9494
9428
  .extension(extensionId)
9495
9429
  .emergencyLocations(locationId)
9496
- .put(emergencyLocationInfoRequest);
9430
+ .put(emergencyLocationRequestResource);
9497
9431
  await rc.revoke();
9498
9432
  ```
9499
9433
 
9500
9434
  - Parameter `apiVersion` is optional with default value `v1.0`
9501
9435
  - Parameter `accountId` is optional with default value `~`
9502
9436
  - Parameter `extensionId` is optional with default value `~`
9503
- - `emergencyLocationInfoRequest` is of type [EmergencyLocationInfoRequest](./definitions/EmergencyLocationInfoRequest.ts)
9504
- - `result` is of type [CommonEmergencyLocationResource](./definitions/CommonEmergencyLocationResource.ts)
9437
+ - `emergencyLocationRequestResource` is of type [EmergencyLocationRequestResource](./definitions/EmergencyLocationRequestResource.ts)
9438
+ - `result` is of type [EmergencyLocationResponseResource](./definitions/EmergencyLocationResponseResource.ts)
9505
9439
 
9506
9440
  [Try it out](https://developer.ringcentral.com/api-reference#Automatic-Location-Updates-updateExtensionEmergencyLocation) in API Explorer.
9507
9441
 
@@ -9764,6 +9698,43 @@ Please refer to [Binary content downloading](/README.md#Binary-content-downloadi
9764
9698
 
9765
9699
  [Try it out](https://developer.ringcentral.com/api-reference#Greetings-readGreetingContent) in API Explorer.
9766
9700
 
9701
+ ## readMessageContent
9702
+
9703
+ Get Message Attachment Content
9704
+
9705
+ | Name | Value |
9706
+ | ---------------- | -------------------------------------------------------------------------------------------------------------------- |
9707
+ | HTTP Method | `GET` |
9708
+ | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}` |
9709
+ | Rate Limit Group | `Medium` |
9710
+ | App Permission | `ReadMessages` |
9711
+ | User Permission | `N/A` |
9712
+
9713
+ ```ts
9714
+ const rc = new RingCentral({ clientId, clientSecret, serverURL });
9715
+ await rc.authorize({ jwt });
9716
+ var result = await rc
9717
+ .restapi(apiVersion)
9718
+ .account(accountId)
9719
+ .extension(extensionId)
9720
+ .messageStore(messageId)
9721
+ .content(attachmentId)
9722
+ .get(readMessageContentParameters);
9723
+ await rc.revoke();
9724
+ ```
9725
+
9726
+ - Parameter `apiVersion` is optional with default value `v1.0`
9727
+ - Parameter `accountId` is optional with default value `~`
9728
+ - Parameter `extensionId` is optional with default value `~`
9729
+ - `readMessageContentParameters` is of type [ReadMessageContentParameters](./definitions/ReadMessageContentParameters.ts)
9730
+ - `result` is of type `byte[]`
9731
+
9732
+ ### ❗❗❗ Code sample above may not work
9733
+
9734
+ Please refer to [Binary content downloading](/README.md#Binary-content-downloading).
9735
+
9736
+ [Try it out](https://developer.ringcentral.com/api-reference#Message-Store-readMessageContent) in API Explorer.
9737
+
9767
9738
  ## readUnifiedPresence
9768
9739
 
9769
9740
  Get Unified Presence
@@ -10080,6 +10051,71 @@ await rc.revoke();
10080
10051
 
10081
10052
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-updateCallParty) in API Explorer.
10082
10053
 
10054
+ ## callFlipParty
10055
+
10056
+ Call Flip on Party
10057
+
10058
+ | Name | Value |
10059
+ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
10060
+ | HTTP Method | `POST` |
10061
+ | Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip` |
10062
+ | Rate Limit Group | `Light` |
10063
+ | App Permission | `CallControl` |
10064
+ | User Permission | `N/A` |
10065
+
10066
+ ```ts
10067
+ const rc = new RingCentral({ clientId, clientSecret, serverURL });
10068
+ await rc.authorize({ jwt });
10069
+ var result = await rc
10070
+ .restapi(apiVersion)
10071
+ .account(accountId)
10072
+ .telephony()
10073
+ .sessions(telephonySessionId)
10074
+ .parties(partyId)
10075
+ .flip()
10076
+ .post(callPartyFlip);
10077
+ await rc.revoke();
10078
+ ```
10079
+
10080
+ - Parameter `apiVersion` is optional with default value `v1.0`
10081
+ - Parameter `accountId` is optional with default value `~`
10082
+ - `callPartyFlip` is of type [CallPartyFlip](./definitions/CallPartyFlip.ts)
10083
+ - `result` is an empty string
10084
+
10085
+ [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-callFlipParty) in API Explorer.
10086
+
10087
+ ## callParkParty
10088
+
10089
+ Call Park
10090
+
10091
+ | Name | Value |
10092
+ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
10093
+ | HTTP Method | `POST` |
10094
+ | Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/park` |
10095
+ | Rate Limit Group | `Light` |
10096
+ | App Permission | `CallControl` |
10097
+ | User Permission | `N/A` |
10098
+
10099
+ ```ts
10100
+ const rc = new RingCentral({ clientId, clientSecret, serverURL });
10101
+ await rc.authorize({ jwt });
10102
+ var result = await rc
10103
+ .restapi(apiVersion)
10104
+ .account(accountId)
10105
+ .telephony()
10106
+ .sessions(telephonySessionId)
10107
+ .parties(partyId)
10108
+ .park()
10109
+ .post();
10110
+ await rc.revoke();
10111
+ ```
10112
+
10113
+ - Parameter `apiVersion` is optional with default value `v1.0`
10114
+ - Parameter `accountId` is optional with default value `~`
10115
+ - `result` is of type [CallParty](./definitions/CallParty.ts)
10116
+
10117
+ [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-callParkParty) in API Explorer.
10118
+
10083
10119
  ## superviseCallSession
10084
10120
 
10085
10121
  Supervise Call Session
@@ -11605,43 +11641,6 @@ await rc.revoke();
11605
11641
 
11606
11642
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Blocking-deleteBlockedAllowedNumber) in API Explorer.
11607
11643
 
11608
- ## readMessageContent
11609
-
11610
- Get Message Attachment Content
11611
-
11612
- | Name | Value |
11613
- | ---------------- | -------------------------------------------------------------------------------------------------------------------- |
11614
- | HTTP Method | `GET` |
11615
- | Endpoint | `/restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}` |
11616
- | Rate Limit Group | `Medium` |
11617
- | App Permission | `ReadMessages` |
11618
- | User Permission | `N/A` |
11619
-
11620
- ```ts
11621
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
11622
- await rc.authorize({ jwt });
11623
- var result = await rc
11624
- .restapi(apiVersion)
11625
- .account(accountId)
11626
- .extension(extensionId)
11627
- .messageStore(messageId)
11628
- .content(attachmentId)
11629
- .get(readMessageContentParameters);
11630
- await rc.revoke();
11631
- ```
11632
-
11633
- - Parameter `apiVersion` is optional with default value `v1.0`
11634
- - Parameter `accountId` is optional with default value `~`
11635
- - Parameter `extensionId` is optional with default value `~`
11636
- - `readMessageContentParameters` is of type [ReadMessageContentParameters](./definitions/ReadMessageContentParameters.ts)
11637
- - `result` is of type `byte[]`
11638
-
11639
- ### ❗❗❗ Code sample above may not work
11640
-
11641
- Please refer to [Binary content downloading](/README.md#Binary-content-downloading).
11642
-
11643
- [Try it out](https://developer.ringcentral.com/api-reference#Message-Store-readMessageContent) in API Explorer.
11644
-
11645
11644
  ## readNotificationSettings
11646
11645
 
11647
11646
  Get Notification Settings
@@ -11799,39 +11798,6 @@ await rc.revoke();
11799
11798
 
11800
11799
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-bridgeCallParty) in API Explorer.
11801
11800
 
11802
- ## callFlipParty
11803
-
11804
- Call Flip on Party
11805
-
11806
- | Name | Value |
11807
- | ---------------- | ---------------------------------------------------------------------------------------------------------- |
11808
- | HTTP Method | `POST` |
11809
- | Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip` |
11810
- | Rate Limit Group | `Light` |
11811
- | App Permission | `CallControl` |
11812
- | User Permission | `N/A` |
11813
-
11814
- ```ts
11815
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
11816
- await rc.authorize({ jwt });
11817
- var result = await rc
11818
- .restapi(apiVersion)
11819
- .account(accountId)
11820
- .telephony()
11821
- .sessions(telephonySessionId)
11822
- .parties(partyId)
11823
- .flip()
11824
- .post(callPartyFlip);
11825
- await rc.revoke();
11826
- ```
11827
-
11828
- - Parameter `apiVersion` is optional with default value `v1.0`
11829
- - Parameter `accountId` is optional with default value `~`
11830
- - `callPartyFlip` is of type [CallPartyFlip](./definitions/CallPartyFlip.ts)
11831
- - `result` is an empty string
11832
-
11833
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-callFlipParty) in API Explorer.
11834
-
11835
11801
  ## forwardCallParty
11836
11802
 
11837
11803
  Forward Call Party
@@ -11931,38 +11897,6 @@ await rc.revoke();
11931
11897
 
11932
11898
  [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-ignoreCallInQueue) in API Explorer.
11933
11899
 
11934
- ## callParkParty
11935
-
11936
- Call Park
11937
-
11938
- | Name | Value |
11939
- | ---------------- | ---------------------------------------------------------------------------------------------------------- |
11940
- | HTTP Method | `POST` |
11941
- | Endpoint | `/restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/park` |
11942
- | Rate Limit Group | `Light` |
11943
- | App Permission | `CallControl` |
11944
- | User Permission | `N/A` |
11945
-
11946
- ```ts
11947
- const rc = new RingCentral({ clientId, clientSecret, serverURL });
11948
- await rc.authorize({ jwt });
11949
- var result = await rc
11950
- .restapi(apiVersion)
11951
- .account(accountId)
11952
- .telephony()
11953
- .sessions(telephonySessionId)
11954
- .parties(partyId)
11955
- .park()
11956
- .post();
11957
- await rc.revoke();
11958
- ```
11959
-
11960
- - Parameter `apiVersion` is optional with default value `v1.0`
11961
- - Parameter `accountId` is optional with default value `~`
11962
- - `result` is of type [CallParty](./definitions/CallParty.ts)
11963
-
11964
- [Try it out](https://developer.ringcentral.com/api-reference#Call-Control-callParkParty) in API Explorer.
11965
-
11966
11900
  ## pickupCallParty
11967
11901
 
11968
11902
  Pickup Call
@@ -1,61 +0,0 @@
1
- import type IdentityExtraValues from './IdentityExtraValues';
2
- interface ImportIdentityRequest {
3
- /**
4
- * Identifier of the identity on the remote channel.
5
- * Required
6
- * Example: 9680ab94-3b78-495c-bb2c-a969954d8260
7
- */
8
- foreignId?: string;
9
- /**
10
- * The channel identifier to create the identity for.
11
- * Required
12
- * Example: 541014e17aa58d8ccf000023
13
- */
14
- sourceId?: string;
15
- /**
16
- * Company.
17
- * Example: Test Company
18
- */
19
- company?: string;
20
- /**
21
- * FirstName.
22
- * Example: John
23
- */
24
- firstName?: string;
25
- /**
26
- * Gender.
27
- * Example: Woman
28
- */
29
- gender?: 'Man' | 'Woman';
30
- /**
31
- * Phone number.
32
- * Example: +33634231224
33
- */
34
- homePhone?: string;
35
- /**
36
- * LastName.
37
- * Example: Doe
38
- */
39
- lastName?: string;
40
- /**
41
- * Phone number.
42
- * Example: +33634231224
43
- */
44
- mobilePhone?: string;
45
- /**
46
- * Screen name of the identity.
47
- * Example: John D.
48
- */
49
- screenName?: string;
50
- /**
51
- */
52
- extraValues?: IdentityExtraValues;
53
- /**
54
- * Permit to update an existing identity if set to true.
55
- *
56
- * false by default.
57
- * Example: true
58
- */
59
- upsert?: boolean;
60
- }
61
- export default ImportIdentityRequest;
@@ -1 +0,0 @@
1
- {"version":3,"file":"ImportIdentityRequest.js","sourceRoot":"","sources":["../../src/definitions/ImportIdentityRequest.ts"],"names":[],"mappings":""}
@@ -1,17 +0,0 @@
1
- import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
2
- declare class Index {
3
- rc: RingCentralInterface;
4
- _parent: ParentInterface;
5
- constructor(_parent: ParentInterface);
6
- path(): string;
7
- /**
8
- * Anonymizes an Identity.
9
- *
10
- * HTTP Method: post
11
- * Endpoint: /cx/social-messaging/v1/identities/{identityId}/anonymize
12
- * Rate Limit Group: Light
13
- * App Permission: SocialMessaging
14
- */
15
- post(restRequestConfig?: RestRequestConfig): Promise<string>;
16
- }
17
- export default Index;