@vonage/client-sdk 1.6.1-alpha.0 → 1.6.1-alpha.1
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.
- package/api_docs/ts/assets/navigation.js +1 -1
- package/api_docs/ts/assets/search.js +1 -1
- package/api_docs/ts/classes/VonageClient.html +27 -27
- package/api_docs/ts/enums/OrderBy.html +1 -1
- package/api_docs/ts/enums/PresentingOrder.html +1 -1
- package/api_docs/ts/index.html +2 -6
- package/api_docs/ts/interfaces/ConversationsPage.html +1 -1
- package/api_docs/ts/interfaces/CreateConversationParameters.html +1 -1
- package/api_docs/ts/interfaces/EventsPage.html +1 -1
- package/api_docs/ts/interfaces/GetCallLegsParameters.html +1 -1
- package/api_docs/ts/interfaces/GetConversationEventsParameters.html +1 -1
- package/api_docs/ts/interfaces/GetConversationMembersParameters.html +1 -1
- package/api_docs/ts/interfaces/GetConversationsParameters.html +1 -1
- package/api_docs/ts/interfaces/LegsPage.html +1 -1
- package/api_docs/ts/interfaces/Location.html +1 -1
- package/api_docs/ts/interfaces/MemberEventBody.html +1 -1
- package/api_docs/ts/interfaces/MembersPage.html +1 -1
- package/api_docs/ts/interfaces/MessageAudioEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageCustomEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageFileEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageImageEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageLocationEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageTemplateEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageTextEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageVCardEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageVideoEventBody.html +1 -1
- package/api_docs/ts/interfaces/Template.html +1 -1
- package/api_docs/ts/interfaces/UpdateConversationParameters.html +1 -1
- package/api_docs/ts/interfaces/Whatsapp.html +1 -1
- package/api_docs/ts/modules.html +26 -26
- package/api_docs/ts/types/Option.html +1 -1
- package/dist/client/VonageClient.d.ts +0 -27
- package/dist/client/index.cjs +6 -26
- package/dist/client/index.mjs +6 -26
- package/dist/coreExtend.d.ts +0 -1
- package/dist/utils/ConversationEventBodies.d.ts +0 -16
- package/dist/utils/ConversationModels.d.ts +0 -4
- package/dist/utils/Option.d.ts +0 -1
- package/dist/utils/RequestParameterModels.d.ts +0 -10
- package/dist/vonageClientSDK.js +6 -26
- package/dist/vonageClientSDK.min.js +1 -1
- package/dist/vonageClientSDK.min.mjs +1 -1
- package/dist/vonageClientSDK.mjs +6 -26
- package/package.json +1 -1
package/dist/client/index.cjs
CHANGED
|
@@ -33703,9 +33703,6 @@ function requireClientsdkClientcore () {
|
|
|
33703
33703
|
setMetadataFor(Companion_133, 'Companion', objectMeta);
|
|
33704
33704
|
setMetadataFor($serializer_153, '$serializer', objectMeta, VOID, [GeneratedSerializer]);
|
|
33705
33705
|
setMetadataFor(SessionTerminatedEvent, 'SessionTerminatedEvent', classMeta, VOID, [SocketEvent], VOID, VOID, {0: $serializer_getInstance_153});
|
|
33706
|
-
function onConversationEvent(event) {
|
|
33707
|
-
}
|
|
33708
|
-
setMetadataFor(ConversationEventListener, 'ConversationEventListener', interfaceMeta);
|
|
33709
33706
|
function onRTCHangup(conversationId, legId, hangup) {
|
|
33710
33707
|
}
|
|
33711
33708
|
function onRTCTransfer(conversationId, legId) {
|
|
@@ -33713,6 +33710,9 @@ function requireClientsdkClientcore () {
|
|
|
33713
33710
|
function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
|
|
33714
33711
|
}
|
|
33715
33712
|
setMetadataFor(RTCEventListener, 'RTCEventListener', interfaceMeta);
|
|
33713
|
+
function onConversationEvent(event) {
|
|
33714
|
+
}
|
|
33715
|
+
setMetadataFor(ConversationEventListener, 'ConversationEventListener', interfaceMeta);
|
|
33716
33716
|
function onAudioSay() {
|
|
33717
33717
|
}
|
|
33718
33718
|
function onAudioMuteUpdate(conversationId, legId, isMuted) {
|
|
@@ -33722,7 +33722,7 @@ function requireClientsdkClientcore () {
|
|
|
33722
33722
|
function onAudioDTMFUpdate(conversationId, legId, digits) {
|
|
33723
33723
|
}
|
|
33724
33724
|
setMetadataFor(AudioEventListener, 'AudioEventListener', interfaceMeta);
|
|
33725
|
-
setMetadataFor(ChatAPIImpl$1, VOID, classMeta, VOID, [
|
|
33725
|
+
setMetadataFor(ChatAPIImpl$1, VOID, classMeta, VOID, [RTCEventListener, ConversationEventListener, AudioEventListener]);
|
|
33726
33726
|
setMetadataFor(ChatAPIImpl, 'ChatAPIImpl', classMeta, VOID, [ChatAPI]);
|
|
33727
33727
|
setMetadataFor(LoggingLevel, 'LoggingLevel', classMeta, Enum);
|
|
33728
33728
|
setMetadataFor(ClientConfigRegion, 'ClientConfigRegion', classMeta, Enum);
|
|
@@ -33878,7 +33878,7 @@ function requireClientsdkClientcore () {
|
|
|
33878
33878
|
setMetadataFor(HangupReason, 'HangupReason', classMeta, Enum);
|
|
33879
33879
|
setMetadataFor(LegStatus, 'LegStatus', classMeta, Enum);
|
|
33880
33880
|
setMetadataFor(CallDisconnectReason, 'CallDisconnectReason', classMeta, Enum);
|
|
33881
|
-
setMetadataFor(VoiceAPIImpl$1, VOID, classMeta, VOID, [
|
|
33881
|
+
setMetadataFor(VoiceAPIImpl$1, VOID, classMeta, VOID, [RTCEventListener, ConversationEventListener, AudioEventListener]);
|
|
33882
33882
|
setMetadataFor(VoiceAPIImpl, 'VoiceAPIImpl', classMeta);
|
|
33883
33883
|
setMetadataFor(CallEvent, 'CallEvent', interfaceMeta);
|
|
33884
33884
|
setMetadataFor(SetupOutboundCall, 'SetupOutboundCall', classMeta, VOID, [CallEvent]);
|
|
@@ -34094,7 +34094,7 @@ function requireClientsdkClientcore () {
|
|
|
34094
34094
|
setMetadataFor(Failed, 'Failed', classMeta, StateTransition);
|
|
34095
34095
|
//endregion
|
|
34096
34096
|
function BuildKonfig() {
|
|
34097
|
-
this.g1d_1 = '1.6.1-alpha.
|
|
34097
|
+
this.g1d_1 = '1.6.1-alpha.1';
|
|
34098
34098
|
}
|
|
34099
34099
|
var BuildKonfig_instance;
|
|
34100
34100
|
function BuildKonfig_getInstance() {
|
|
@@ -83474,7 +83474,6 @@ const SessionErrorCodes = clientsdkClientcore_jsExports.vonage.SessionErrorCodes
|
|
|
83474
83474
|
|
|
83475
83475
|
/**
|
|
83476
83476
|
* The order in which paginated objects are presented.
|
|
83477
|
-
* @beta
|
|
83478
83477
|
* @group Chat
|
|
83479
83478
|
* @enum
|
|
83480
83479
|
* @property ASC Ascending order
|
|
@@ -83486,7 +83485,6 @@ const PresentingOrder = {
|
|
|
83486
83485
|
};
|
|
83487
83486
|
/**
|
|
83488
83487
|
* The sorting strategy used for paginated objects.
|
|
83489
|
-
* @beta
|
|
83490
83488
|
* @group Chat
|
|
83491
83489
|
* @enum
|
|
83492
83490
|
*/
|
|
@@ -83791,7 +83789,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
83791
83789
|
* [[include: snippet_GetCallLegs.txt]]
|
|
83792
83790
|
*
|
|
83793
83791
|
* @group Voice
|
|
83794
|
-
* @beta
|
|
83795
83792
|
* @param id - the Call's id
|
|
83796
83793
|
* @param parameters - A {@link GetCallLegsParameters} object containing the parameters for the request.
|
|
83797
83794
|
* @returns a `LegsPage` containing the legs
|
|
@@ -84015,7 +84012,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84015
84012
|
* [[include: snippet_LeaveConversation.txt]]
|
|
84016
84013
|
*
|
|
84017
84014
|
* @group Chat
|
|
84018
|
-
* @beta
|
|
84019
84015
|
* @param id - the Conversation's id
|
|
84020
84016
|
* @returns void
|
|
84021
84017
|
*/
|
|
@@ -84034,7 +84030,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84034
84030
|
* [[include: snippet_JoinConversation.txt]]
|
|
84035
84031
|
*
|
|
84036
84032
|
* @group Chat
|
|
84037
|
-
* @beta
|
|
84038
84033
|
* @param id - the Conversation's id
|
|
84039
84034
|
* @returns the `memberId` of the member
|
|
84040
84035
|
*/
|
|
@@ -84053,7 +84048,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84053
84048
|
* [[include: snippet_DeleteConversation.txt]]
|
|
84054
84049
|
*
|
|
84055
84050
|
* @group Chat
|
|
84056
|
-
* @beta
|
|
84057
84051
|
* @param id - the Conversation's id
|
|
84058
84052
|
* @returns void
|
|
84059
84053
|
*/
|
|
@@ -84072,7 +84066,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84072
84066
|
* [[include: snippet_InviteToConversation.txt]]
|
|
84073
84067
|
*
|
|
84074
84068
|
* @group Chat
|
|
84075
|
-
* @beta
|
|
84076
84069
|
* @param id - the Conversation's id
|
|
84077
84070
|
* @param name - the name of the user to invite
|
|
84078
84071
|
* @returns the `memberId` of the member
|
|
@@ -84092,7 +84085,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84092
84085
|
* [[include: snippet_SendTextMessage.txt]]
|
|
84093
84086
|
*
|
|
84094
84087
|
* @group Chat
|
|
84095
|
-
* @beta
|
|
84096
84088
|
* @param id - the Conversation's id
|
|
84097
84089
|
* @param text - the Body of the message
|
|
84098
84090
|
* @returns the `timestamp` of the message
|
|
@@ -84112,7 +84104,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84112
84104
|
* [[include: snippet_SendCustomMessage.txt]]
|
|
84113
84105
|
*
|
|
84114
84106
|
* @group Chat
|
|
84115
|
-
* @beta
|
|
84116
84107
|
* @param id - the Conversation's id
|
|
84117
84108
|
* @param customData - the body of the message
|
|
84118
84109
|
* @returns the `timestamp` of the message
|
|
@@ -84135,7 +84126,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84135
84126
|
* [[include: snippet_SendImageMessage.txt]]
|
|
84136
84127
|
*
|
|
84137
84128
|
* @group Chat
|
|
84138
|
-
* @beta
|
|
84139
84129
|
* @param id - the Conversation's id
|
|
84140
84130
|
* @param imageUrl - the url of the image resource.
|
|
84141
84131
|
* @returns the `timestamp` of the message
|
|
@@ -84155,7 +84145,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84155
84145
|
* [[include: snippet_SendVideoMessage.txt]]
|
|
84156
84146
|
*
|
|
84157
84147
|
* @group Chat
|
|
84158
|
-
* @beta
|
|
84159
84148
|
* @param id - the Conversation's id
|
|
84160
84149
|
* @param videoUrl - the url of the video resource.
|
|
84161
84150
|
* @returns the `timestamp` of the message
|
|
@@ -84175,7 +84164,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84175
84164
|
* [[include: snippet_SendFileMessage.txt]]
|
|
84176
84165
|
*
|
|
84177
84166
|
* @group Chat
|
|
84178
|
-
* @beta
|
|
84179
84167
|
* @param id - the Conversation's id
|
|
84180
84168
|
* @param fileUrl - the url of the file resource.
|
|
84181
84169
|
* @returns the `timestamp` of the message
|
|
@@ -84195,7 +84183,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84195
84183
|
* [[include: snippet_SendAudioMessage.txt]]
|
|
84196
84184
|
*
|
|
84197
84185
|
* @group Chat
|
|
84198
|
-
* @beta
|
|
84199
84186
|
* @param id - the Conversation's id
|
|
84200
84187
|
* @param audioUrl - the url of the audio resource.
|
|
84201
84188
|
* @returns the `timestamp` of the message
|
|
@@ -84215,7 +84202,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84215
84202
|
* [[include: snippet_SendVcardMessage.txt]]
|
|
84216
84203
|
*
|
|
84217
84204
|
* @group Chat
|
|
84218
|
-
* @beta
|
|
84219
84205
|
* @param id - the Conversation's id
|
|
84220
84206
|
* @param vCardUrl - the url of the vCardUrl resource.
|
|
84221
84207
|
* @returns the `timestamp` of the message
|
|
@@ -84235,7 +84221,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84235
84221
|
* [[include: snippet_SendLocationMessage.txt]]
|
|
84236
84222
|
*
|
|
84237
84223
|
* @group Chat
|
|
84238
|
-
* @beta
|
|
84239
84224
|
* @param id - the Conversation's id
|
|
84240
84225
|
* @param location - the description of the location.
|
|
84241
84226
|
* @returns the `timestamp` of the message
|
|
@@ -84255,7 +84240,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84255
84240
|
* [[include: snippet_SendTemplateMessage.txt]]
|
|
84256
84241
|
*
|
|
84257
84242
|
* @group Chat
|
|
84258
|
-
* @beta
|
|
84259
84243
|
* @param id - the Conversation's id
|
|
84260
84244
|
* @param whatsappObject - the description(locale and policies of business account) of the location.
|
|
84261
84245
|
* @param templateObject - the description(name and paramters) of the template.
|
|
@@ -84276,7 +84260,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84276
84260
|
* [[include: snippet_SendEphemeralEvent.txt]]
|
|
84277
84261
|
*
|
|
84278
84262
|
* @group Chat
|
|
84279
|
-
* @beta
|
|
84280
84263
|
* @param id - the Conversation's id
|
|
84281
84264
|
* @param customData - the body of the event
|
|
84282
84265
|
* @returns the `timestamp` of the message
|
|
@@ -84299,7 +84282,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84299
84282
|
* [[include: snippet_SendCustomEvent.txt]]
|
|
84300
84283
|
*
|
|
84301
84284
|
* @group Chat
|
|
84302
|
-
* @beta
|
|
84303
84285
|
* @param id - the Conversation's id
|
|
84304
84286
|
* @param evenType - the type of the custom event. Type must start with `custom:<...>`
|
|
84305
84287
|
* @param customData - the body of the event
|
|
@@ -84323,7 +84305,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84323
84305
|
* [[include:snippet_DeleteEvent.txt]]
|
|
84324
84306
|
*
|
|
84325
84307
|
* @group Chat
|
|
84326
|
-
* @beta
|
|
84327
84308
|
* @param id - the id for the Event to be deleted
|
|
84328
84309
|
* @param conversationId - the id for the conversation, the event belongs to.
|
|
84329
84310
|
* @returns void
|
|
@@ -84343,7 +84324,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84343
84324
|
* [[include: snippet_SendMessageSeenEvent.txt]]
|
|
84344
84325
|
*
|
|
84345
84326
|
* @group Chat
|
|
84346
|
-
* @beta
|
|
84347
84327
|
* @param id - the event id
|
|
84348
84328
|
* @param conversationId - the conversation id
|
|
84349
84329
|
* @returns the `timestamp` of the message
|
package/dist/client/index.mjs
CHANGED
|
@@ -33679,9 +33679,6 @@ function requireClientsdkClientcore () {
|
|
|
33679
33679
|
setMetadataFor(Companion_133, 'Companion', objectMeta);
|
|
33680
33680
|
setMetadataFor($serializer_153, '$serializer', objectMeta, VOID, [GeneratedSerializer]);
|
|
33681
33681
|
setMetadataFor(SessionTerminatedEvent, 'SessionTerminatedEvent', classMeta, VOID, [SocketEvent], VOID, VOID, {0: $serializer_getInstance_153});
|
|
33682
|
-
function onConversationEvent(event) {
|
|
33683
|
-
}
|
|
33684
|
-
setMetadataFor(ConversationEventListener, 'ConversationEventListener', interfaceMeta);
|
|
33685
33682
|
function onRTCHangup(conversationId, legId, hangup) {
|
|
33686
33683
|
}
|
|
33687
33684
|
function onRTCTransfer(conversationId, legId) {
|
|
@@ -33689,6 +33686,9 @@ function requireClientsdkClientcore () {
|
|
|
33689
33686
|
function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
|
|
33690
33687
|
}
|
|
33691
33688
|
setMetadataFor(RTCEventListener, 'RTCEventListener', interfaceMeta);
|
|
33689
|
+
function onConversationEvent(event) {
|
|
33690
|
+
}
|
|
33691
|
+
setMetadataFor(ConversationEventListener, 'ConversationEventListener', interfaceMeta);
|
|
33692
33692
|
function onAudioSay() {
|
|
33693
33693
|
}
|
|
33694
33694
|
function onAudioMuteUpdate(conversationId, legId, isMuted) {
|
|
@@ -33698,7 +33698,7 @@ function requireClientsdkClientcore () {
|
|
|
33698
33698
|
function onAudioDTMFUpdate(conversationId, legId, digits) {
|
|
33699
33699
|
}
|
|
33700
33700
|
setMetadataFor(AudioEventListener, 'AudioEventListener', interfaceMeta);
|
|
33701
|
-
setMetadataFor(ChatAPIImpl$1, VOID, classMeta, VOID, [
|
|
33701
|
+
setMetadataFor(ChatAPIImpl$1, VOID, classMeta, VOID, [RTCEventListener, ConversationEventListener, AudioEventListener]);
|
|
33702
33702
|
setMetadataFor(ChatAPIImpl, 'ChatAPIImpl', classMeta, VOID, [ChatAPI]);
|
|
33703
33703
|
setMetadataFor(LoggingLevel, 'LoggingLevel', classMeta, Enum);
|
|
33704
33704
|
setMetadataFor(ClientConfigRegion, 'ClientConfigRegion', classMeta, Enum);
|
|
@@ -33854,7 +33854,7 @@ function requireClientsdkClientcore () {
|
|
|
33854
33854
|
setMetadataFor(HangupReason, 'HangupReason', classMeta, Enum);
|
|
33855
33855
|
setMetadataFor(LegStatus, 'LegStatus', classMeta, Enum);
|
|
33856
33856
|
setMetadataFor(CallDisconnectReason, 'CallDisconnectReason', classMeta, Enum);
|
|
33857
|
-
setMetadataFor(VoiceAPIImpl$1, VOID, classMeta, VOID, [
|
|
33857
|
+
setMetadataFor(VoiceAPIImpl$1, VOID, classMeta, VOID, [RTCEventListener, ConversationEventListener, AudioEventListener]);
|
|
33858
33858
|
setMetadataFor(VoiceAPIImpl, 'VoiceAPIImpl', classMeta);
|
|
33859
33859
|
setMetadataFor(CallEvent, 'CallEvent', interfaceMeta);
|
|
33860
33860
|
setMetadataFor(SetupOutboundCall, 'SetupOutboundCall', classMeta, VOID, [CallEvent]);
|
|
@@ -34070,7 +34070,7 @@ function requireClientsdkClientcore () {
|
|
|
34070
34070
|
setMetadataFor(Failed, 'Failed', classMeta, StateTransition);
|
|
34071
34071
|
//endregion
|
|
34072
34072
|
function BuildKonfig() {
|
|
34073
|
-
this.g1d_1 = '1.6.1-alpha.
|
|
34073
|
+
this.g1d_1 = '1.6.1-alpha.1';
|
|
34074
34074
|
}
|
|
34075
34075
|
var BuildKonfig_instance;
|
|
34076
34076
|
function BuildKonfig_getInstance() {
|
|
@@ -83450,7 +83450,6 @@ const SessionErrorCodes = clientsdkClientcore_jsExports.vonage.SessionErrorCodes
|
|
|
83450
83450
|
|
|
83451
83451
|
/**
|
|
83452
83452
|
* The order in which paginated objects are presented.
|
|
83453
|
-
* @beta
|
|
83454
83453
|
* @group Chat
|
|
83455
83454
|
* @enum
|
|
83456
83455
|
* @property ASC Ascending order
|
|
@@ -83462,7 +83461,6 @@ const PresentingOrder = {
|
|
|
83462
83461
|
};
|
|
83463
83462
|
/**
|
|
83464
83463
|
* The sorting strategy used for paginated objects.
|
|
83465
|
-
* @beta
|
|
83466
83464
|
* @group Chat
|
|
83467
83465
|
* @enum
|
|
83468
83466
|
*/
|
|
@@ -83767,7 +83765,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
83767
83765
|
* [[include: snippet_GetCallLegs.txt]]
|
|
83768
83766
|
*
|
|
83769
83767
|
* @group Voice
|
|
83770
|
-
* @beta
|
|
83771
83768
|
* @param id - the Call's id
|
|
83772
83769
|
* @param parameters - A {@link GetCallLegsParameters} object containing the parameters for the request.
|
|
83773
83770
|
* @returns a `LegsPage` containing the legs
|
|
@@ -83991,7 +83988,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
83991
83988
|
* [[include: snippet_LeaveConversation.txt]]
|
|
83992
83989
|
*
|
|
83993
83990
|
* @group Chat
|
|
83994
|
-
* @beta
|
|
83995
83991
|
* @param id - the Conversation's id
|
|
83996
83992
|
* @returns void
|
|
83997
83993
|
*/
|
|
@@ -84010,7 +84006,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84010
84006
|
* [[include: snippet_JoinConversation.txt]]
|
|
84011
84007
|
*
|
|
84012
84008
|
* @group Chat
|
|
84013
|
-
* @beta
|
|
84014
84009
|
* @param id - the Conversation's id
|
|
84015
84010
|
* @returns the `memberId` of the member
|
|
84016
84011
|
*/
|
|
@@ -84029,7 +84024,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84029
84024
|
* [[include: snippet_DeleteConversation.txt]]
|
|
84030
84025
|
*
|
|
84031
84026
|
* @group Chat
|
|
84032
|
-
* @beta
|
|
84033
84027
|
* @param id - the Conversation's id
|
|
84034
84028
|
* @returns void
|
|
84035
84029
|
*/
|
|
@@ -84048,7 +84042,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84048
84042
|
* [[include: snippet_InviteToConversation.txt]]
|
|
84049
84043
|
*
|
|
84050
84044
|
* @group Chat
|
|
84051
|
-
* @beta
|
|
84052
84045
|
* @param id - the Conversation's id
|
|
84053
84046
|
* @param name - the name of the user to invite
|
|
84054
84047
|
* @returns the `memberId` of the member
|
|
@@ -84068,7 +84061,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84068
84061
|
* [[include: snippet_SendTextMessage.txt]]
|
|
84069
84062
|
*
|
|
84070
84063
|
* @group Chat
|
|
84071
|
-
* @beta
|
|
84072
84064
|
* @param id - the Conversation's id
|
|
84073
84065
|
* @param text - the Body of the message
|
|
84074
84066
|
* @returns the `timestamp` of the message
|
|
@@ -84088,7 +84080,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84088
84080
|
* [[include: snippet_SendCustomMessage.txt]]
|
|
84089
84081
|
*
|
|
84090
84082
|
* @group Chat
|
|
84091
|
-
* @beta
|
|
84092
84083
|
* @param id - the Conversation's id
|
|
84093
84084
|
* @param customData - the body of the message
|
|
84094
84085
|
* @returns the `timestamp` of the message
|
|
@@ -84111,7 +84102,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84111
84102
|
* [[include: snippet_SendImageMessage.txt]]
|
|
84112
84103
|
*
|
|
84113
84104
|
* @group Chat
|
|
84114
|
-
* @beta
|
|
84115
84105
|
* @param id - the Conversation's id
|
|
84116
84106
|
* @param imageUrl - the url of the image resource.
|
|
84117
84107
|
* @returns the `timestamp` of the message
|
|
@@ -84131,7 +84121,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84131
84121
|
* [[include: snippet_SendVideoMessage.txt]]
|
|
84132
84122
|
*
|
|
84133
84123
|
* @group Chat
|
|
84134
|
-
* @beta
|
|
84135
84124
|
* @param id - the Conversation's id
|
|
84136
84125
|
* @param videoUrl - the url of the video resource.
|
|
84137
84126
|
* @returns the `timestamp` of the message
|
|
@@ -84151,7 +84140,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84151
84140
|
* [[include: snippet_SendFileMessage.txt]]
|
|
84152
84141
|
*
|
|
84153
84142
|
* @group Chat
|
|
84154
|
-
* @beta
|
|
84155
84143
|
* @param id - the Conversation's id
|
|
84156
84144
|
* @param fileUrl - the url of the file resource.
|
|
84157
84145
|
* @returns the `timestamp` of the message
|
|
@@ -84171,7 +84159,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84171
84159
|
* [[include: snippet_SendAudioMessage.txt]]
|
|
84172
84160
|
*
|
|
84173
84161
|
* @group Chat
|
|
84174
|
-
* @beta
|
|
84175
84162
|
* @param id - the Conversation's id
|
|
84176
84163
|
* @param audioUrl - the url of the audio resource.
|
|
84177
84164
|
* @returns the `timestamp` of the message
|
|
@@ -84191,7 +84178,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84191
84178
|
* [[include: snippet_SendVcardMessage.txt]]
|
|
84192
84179
|
*
|
|
84193
84180
|
* @group Chat
|
|
84194
|
-
* @beta
|
|
84195
84181
|
* @param id - the Conversation's id
|
|
84196
84182
|
* @param vCardUrl - the url of the vCardUrl resource.
|
|
84197
84183
|
* @returns the `timestamp` of the message
|
|
@@ -84211,7 +84197,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84211
84197
|
* [[include: snippet_SendLocationMessage.txt]]
|
|
84212
84198
|
*
|
|
84213
84199
|
* @group Chat
|
|
84214
|
-
* @beta
|
|
84215
84200
|
* @param id - the Conversation's id
|
|
84216
84201
|
* @param location - the description of the location.
|
|
84217
84202
|
* @returns the `timestamp` of the message
|
|
@@ -84231,7 +84216,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84231
84216
|
* [[include: snippet_SendTemplateMessage.txt]]
|
|
84232
84217
|
*
|
|
84233
84218
|
* @group Chat
|
|
84234
|
-
* @beta
|
|
84235
84219
|
* @param id - the Conversation's id
|
|
84236
84220
|
* @param whatsappObject - the description(locale and policies of business account) of the location.
|
|
84237
84221
|
* @param templateObject - the description(name and paramters) of the template.
|
|
@@ -84252,7 +84236,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84252
84236
|
* [[include: snippet_SendEphemeralEvent.txt]]
|
|
84253
84237
|
*
|
|
84254
84238
|
* @group Chat
|
|
84255
|
-
* @beta
|
|
84256
84239
|
* @param id - the Conversation's id
|
|
84257
84240
|
* @param customData - the body of the event
|
|
84258
84241
|
* @returns the `timestamp` of the message
|
|
@@ -84275,7 +84258,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84275
84258
|
* [[include: snippet_SendCustomEvent.txt]]
|
|
84276
84259
|
*
|
|
84277
84260
|
* @group Chat
|
|
84278
|
-
* @beta
|
|
84279
84261
|
* @param id - the Conversation's id
|
|
84280
84262
|
* @param evenType - the type of the custom event. Type must start with `custom:<...>`
|
|
84281
84263
|
* @param customData - the body of the event
|
|
@@ -84299,7 +84281,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84299
84281
|
* [[include:snippet_DeleteEvent.txt]]
|
|
84300
84282
|
*
|
|
84301
84283
|
* @group Chat
|
|
84302
|
-
* @beta
|
|
84303
84284
|
* @param id - the id for the Event to be deleted
|
|
84304
84285
|
* @param conversationId - the id for the conversation, the event belongs to.
|
|
84305
84286
|
* @returns void
|
|
@@ -84319,7 +84300,6 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
84319
84300
|
* [[include: snippet_SendMessageSeenEvent.txt]]
|
|
84320
84301
|
*
|
|
84321
84302
|
* @group Chat
|
|
84322
|
-
* @beta
|
|
84323
84303
|
* @param id - the event id
|
|
84324
84304
|
* @param conversationId - the conversation id
|
|
84325
84305
|
* @returns the `timestamp` of the message
|
package/dist/coreExtend.d.ts
CHANGED
|
@@ -9,7 +9,6 @@ export type MemberStatus = Record<string, EventState>;
|
|
|
9
9
|
/**
|
|
10
10
|
* The {@link MessageAudioEvent} Body type
|
|
11
11
|
*
|
|
12
|
-
* @beta
|
|
13
12
|
* @property audio The audio URL
|
|
14
13
|
* @property deleted The message deletion timestamp
|
|
15
14
|
* @interface
|
|
@@ -19,7 +18,6 @@ export type MessageAudioEventBody = vonage.MessageAudioEventJS.MessageAudioEvent
|
|
|
19
18
|
/**
|
|
20
19
|
* The {@link MessageCustomEvent} Body type
|
|
21
20
|
*
|
|
22
|
-
* @beta
|
|
23
21
|
* @property custom The message custom data
|
|
24
22
|
* @property deleted The message deletion timestamp
|
|
25
23
|
* @interface
|
|
@@ -28,8 +26,6 @@ export type MessageAudioEventBody = vonage.MessageAudioEventJS.MessageAudioEvent
|
|
|
28
26
|
export type MessageCustomEventBody = vonage.MessageCustomEventJS.MessageCustomEventBody;
|
|
29
27
|
/**
|
|
30
28
|
* The {@link MessageFileEvent} Body type
|
|
31
|
-
*
|
|
32
|
-
* @beta
|
|
33
29
|
* @property fileUrl The file URL
|
|
34
30
|
* @property deleted The message deletion timestamp
|
|
35
31
|
* @interface
|
|
@@ -38,8 +34,6 @@ export type MessageCustomEventBody = vonage.MessageCustomEventJS.MessageCustomEv
|
|
|
38
34
|
export type MessageFileEventBody = vonage.MessageFileEventJS.MessageFileEventBody;
|
|
39
35
|
/**
|
|
40
36
|
* The {@link MessageImageEvent} Body type
|
|
41
|
-
*
|
|
42
|
-
* @beta
|
|
43
37
|
* @property imageUrl The image URL
|
|
44
38
|
* @property deleted The message deletion timestamp
|
|
45
39
|
* @interface
|
|
@@ -48,8 +42,6 @@ export type MessageFileEventBody = vonage.MessageFileEventJS.MessageFileEventBod
|
|
|
48
42
|
export type MessageImageEventBody = vonage.MessageImageEventJS.MessageImageEventBody;
|
|
49
43
|
/**
|
|
50
44
|
* The {@link MessageLocationEvent} Body type
|
|
51
|
-
*
|
|
52
|
-
* @beta
|
|
53
45
|
* @property location The {@link Location} object
|
|
54
46
|
* @property deleted The message deletion timestamp
|
|
55
47
|
* @interface
|
|
@@ -59,7 +51,6 @@ export type MessageLocationEventBody = vonage.MessageLocationEventJS.MessageLoca
|
|
|
59
51
|
/**
|
|
60
52
|
* The {@link MessageTemplateEvent} Body type
|
|
61
53
|
*
|
|
62
|
-
* @beta
|
|
63
54
|
* @property template The {@link Template} object
|
|
64
55
|
* @property whatsapp The {@link Whatsapp} object
|
|
65
56
|
* @property deleted The message deletion timestamp
|
|
@@ -70,7 +61,6 @@ export type MessageTemplateEventBody = vonage.MessageTemplateEventJS.MessageTemp
|
|
|
70
61
|
/**
|
|
71
62
|
* The {@link MessageVCardEvent} Body type
|
|
72
63
|
*
|
|
73
|
-
* @beta
|
|
74
64
|
* @property vcardUrl The VCard URL
|
|
75
65
|
* @property deleted The message deletion timestamp
|
|
76
66
|
* @interface
|
|
@@ -80,7 +70,6 @@ export type MessageVCardEventBody = vonage.MessageVCardEventJS.MessageVCardEvent
|
|
|
80
70
|
/**
|
|
81
71
|
* The {@link MessageVideoEvent} Body type
|
|
82
72
|
*
|
|
83
|
-
* @beta
|
|
84
73
|
* @property videoUrl The Video URL
|
|
85
74
|
* @property deleted The message deletion timestamp
|
|
86
75
|
* @interface
|
|
@@ -90,7 +79,6 @@ export type MessageVideoEventBody = vonage.MessageVideoEventJS.MessageVideoEvent
|
|
|
90
79
|
/**
|
|
91
80
|
* The {@link MessageTextEvent} Body type
|
|
92
81
|
*
|
|
93
|
-
* @beta
|
|
94
82
|
* @property text The message text
|
|
95
83
|
* @property deleted The message deletion timestamp
|
|
96
84
|
* @interface
|
|
@@ -100,7 +88,6 @@ export type MessageTextEventBody = vonage.MessageTextEventJS.MessageTextEventBod
|
|
|
100
88
|
/**
|
|
101
89
|
* The {@link MemberInvitedEvent}, {@link MemberJoinedEvent} and {@link MemberLeftEvent} Body type
|
|
102
90
|
*
|
|
103
|
-
* @beta
|
|
104
91
|
* @property memberId The member id
|
|
105
92
|
* @property user The {@link User} associated to the member
|
|
106
93
|
* @interface
|
|
@@ -110,7 +97,6 @@ export type MemberEventBody = vonage.MemberEventBodyJS;
|
|
|
110
97
|
/**
|
|
111
98
|
* The Location object for a {@link MessageLocationEventBody}
|
|
112
99
|
*
|
|
113
|
-
* @beta
|
|
114
100
|
* @group Chat
|
|
115
101
|
*/
|
|
116
102
|
export interface Location {
|
|
@@ -122,7 +108,6 @@ export interface Location {
|
|
|
122
108
|
/**
|
|
123
109
|
* The Template object for a {@link MessageTemplateEventBody}
|
|
124
110
|
*
|
|
125
|
-
* @beta
|
|
126
111
|
* @group Chat
|
|
127
112
|
*/
|
|
128
113
|
export interface Template {
|
|
@@ -132,7 +117,6 @@ export interface Template {
|
|
|
132
117
|
/**
|
|
133
118
|
* The Whatsapp object for a {@link MessageTemplateEventBody}
|
|
134
119
|
*
|
|
135
|
-
* @beta
|
|
136
120
|
* @group Chat
|
|
137
121
|
*/
|
|
138
122
|
export interface Whatsapp {
|
|
@@ -37,7 +37,6 @@ export type ConversationProperties = vonage.ConversationJS.Properties;
|
|
|
37
37
|
/**
|
|
38
38
|
* Represents a page of conversations
|
|
39
39
|
*
|
|
40
|
-
* @beta
|
|
41
40
|
* @property conversations The conversations in the page
|
|
42
41
|
* @property previousCursor The cursor to fetch the previous page
|
|
43
42
|
* @property nextCursor The cursor to fetch the next page
|
|
@@ -50,7 +49,6 @@ export type ConversationsPage = vonage.ConversationsPageJS & {
|
|
|
50
49
|
/**
|
|
51
50
|
* Represents a page of legs
|
|
52
51
|
*
|
|
53
|
-
* @beta
|
|
54
52
|
* @property legs The legs in the page
|
|
55
53
|
* @property previousCursor The cursor to fetch the previous page
|
|
56
54
|
* @property nextCursor The cursor to fetch the next page
|
|
@@ -63,7 +61,6 @@ export type LegsPage = vonage.LegsPageJS & {
|
|
|
63
61
|
/**
|
|
64
62
|
* Represents a page of conversation events
|
|
65
63
|
*
|
|
66
|
-
* @beta
|
|
67
64
|
* @property events The events in the page
|
|
68
65
|
* @property previousCursor The cursor to fetch the previous page
|
|
69
66
|
* @property nextCursor The cursor to fetch the next page
|
|
@@ -96,7 +93,6 @@ export type MemberTimestamp = vonage.MemberTimestampJS;
|
|
|
96
93
|
/**
|
|
97
94
|
* Represents a page of conversation members
|
|
98
95
|
*
|
|
99
|
-
* @beta
|
|
100
96
|
* @property members The members in the page
|
|
101
97
|
* @property previousCursor The cursor to fetch the previous page
|
|
102
98
|
* @property nextCursor The cursor to fetch the next page
|
package/dist/utils/Option.d.ts
CHANGED
|
@@ -5,7 +5,6 @@ import { Option } from './Option';
|
|
|
5
5
|
/**
|
|
6
6
|
* Parameters object for {@link VonageClient.createConversation}
|
|
7
7
|
*
|
|
8
|
-
* @beta
|
|
9
8
|
* @property name The name to initialize the conversation with
|
|
10
9
|
* @property displayName The displayName to initialize the conversation with
|
|
11
10
|
* @property imageUrl The name to imageUrl the conversation with
|
|
@@ -23,7 +22,6 @@ export type CreateConversationParameters = Omit<vonage.CreateConversationParamet
|
|
|
23
22
|
/**
|
|
24
23
|
* Parameters object for {@link VonageClient.getConversations}
|
|
25
24
|
*
|
|
26
|
-
* @beta
|
|
27
25
|
* @property order The order in which conversations are presented, default is {@link PresentingOrder.ASC}.
|
|
28
26
|
* @property pageSize The maximum number of conversations to retrieve per request, default is 10.
|
|
29
27
|
* @property cursor The cursor indicating the starting point for pagination, default is the first page.
|
|
@@ -40,7 +38,6 @@ export type GetConversationsParameters = Omit<vonage.GetConversationsParametersJ
|
|
|
40
38
|
/**
|
|
41
39
|
* Parameters object for {@link VonageClient.getConversationEvents}
|
|
42
40
|
*
|
|
43
|
-
* @beta
|
|
44
41
|
* @property order The order in which conversation events are presented, default is {@link PresentingOrder.ASC}.
|
|
45
42
|
* @property pageSize The maximum number of conversation events to retrieve per request, default is 10.
|
|
46
43
|
* @property cursor The cursor indicating the starting point for pagination, default is the first page.
|
|
@@ -58,7 +55,6 @@ export type GetConversationEventsParameters = Omit<vonage.GetConversationEventsP
|
|
|
58
55
|
/**
|
|
59
56
|
* Parameters object for {@link VonageClient.getConversationMembers}
|
|
60
57
|
*
|
|
61
|
-
* @beta
|
|
62
58
|
* @property order The order in which conversation members are presented, default is {@link PresentingOrder.ASC}.
|
|
63
59
|
* @property pageSize The maximum number of conversation members to retrieve per request, default is 10.
|
|
64
60
|
* @property cursor The cursor indicating the starting point for pagination, default is the first page.
|
|
@@ -72,7 +68,6 @@ export type GetConversationMembersParameters = Omit<vonage.GetConversationMember
|
|
|
72
68
|
/**
|
|
73
69
|
* Parameters object for {@link VonageClient.getCallLegs}
|
|
74
70
|
*
|
|
75
|
-
* @beta
|
|
76
71
|
* @property order The order in which call legs are presented, default is {@link PresentingOrder.ASC}.
|
|
77
72
|
* @property pageSize The maximum number of legs to retrieve per request, default is 10.
|
|
78
73
|
* @property cursor The cursor indicating the starting point for pagination, default is the first page.
|
|
@@ -90,7 +85,6 @@ export type GetCallLegsParameters = Omit<vonage.GetCallLegsParametersJS, 'pageSi
|
|
|
90
85
|
* When set to {@link Option.Some} the property will be updated.
|
|
91
86
|
* When set to {@link Option.None} the property will remain unchanged.
|
|
92
87
|
*
|
|
93
|
-
* @beta
|
|
94
88
|
* @property name The name of the conversation.
|
|
95
89
|
* @property displayName A display name for the conversation.
|
|
96
90
|
* @property imageUrl The URL of an image associated with the conversation.
|
|
@@ -111,13 +105,11 @@ export interface UpdateConversationParameters {
|
|
|
111
105
|
/**
|
|
112
106
|
* The order in which paginated objects are presented.
|
|
113
107
|
*
|
|
114
|
-
* @beta
|
|
115
108
|
* @group Chat
|
|
116
109
|
*/
|
|
117
110
|
export type PresentingOrder = Lowercase<typeof vonage.PresentingOrderJS.prototype.name> | vonage.PresentingOrderJS;
|
|
118
111
|
/**
|
|
119
112
|
* The order in which paginated objects are presented.
|
|
120
|
-
* @beta
|
|
121
113
|
* @group Chat
|
|
122
114
|
* @enum
|
|
123
115
|
* @property ASC Ascending order
|
|
@@ -129,13 +121,11 @@ export declare const PresentingOrder: {
|
|
|
129
121
|
/**
|
|
130
122
|
* The sorting strategy used for paginated objects.
|
|
131
123
|
*
|
|
132
|
-
* @beta
|
|
133
124
|
* @group Chat
|
|
134
125
|
*/
|
|
135
126
|
export type OrderBy = Lowercase<typeof vonage.OrderByJS.prototype.name> | vonage.OrderByJS;
|
|
136
127
|
/**
|
|
137
128
|
* The sorting strategy used for paginated objects.
|
|
138
|
-
* @beta
|
|
139
129
|
* @group Chat
|
|
140
130
|
* @enum
|
|
141
131
|
*/
|