feat(llc): ring individual call member (#1111)

* individual call ringing

* tweak

Author: Brazol

packages/stream_video/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+✅ Added
+- Introduced a new method in the `Call` class that allows ringing individual members of an existing call. Use `call.ring(userId: ['userId'])` to have the backend send a VoIP/ringing push notification to the user's devices. Note: the user must first be a member of the call (use `call.addMembers()` if needed).
+
 🐞 Fixed
 - Resolved an issue that could cause the StreamVideo instance to be disposed prematurely before ringing events were fully processed when handling ringing notifications in the terminated state.
 

packages/stream_video/lib/globals.dart

@@ -3,7 +3,7 @@ import 'package:stream_webrtc_flutter/stream_webrtc_flutter.dart' as webrtc;
 
 const String streamSdkName = 'stream-flutter';
 const String streamVideoVersion = '0.11.2';
-const String openapiModelsVersion = '190.7.0';
+const String openapiModelsVersion = '202.0.0';
 const String protocolModelsVersion = '1.40.1';
 const String androidWebRTCVersion = webrtc.androidWebRTCVersion;
 const String iosWebRTCVersion = webrtc.iosWebRTCVersion;

packages/stream_video/lib/open_api/video/coordinator/api.dart

@@ -189,6 +189,7 @@ part 'model/permission_request_event.dart';
 part 'model/pin_request.dart';
 part 'model/pin_response.dart';
 part 'model/privacy_settings.dart';
+part 'model/published_track_flags.dart';
 part 'model/publisher_stats_response.dart';
 part 'model/push_preferences.dart';
 part 'model/quality_score_report.dart';
@@ -218,6 +219,8 @@ part 'model/report_response.dart';
 part 'model/request_permission_request.dart';
 part 'model/request_permission_response.dart';
 part 'model/response.dart';
+part 'model/ring_call_request.dart';
+part 'model/ring_call_response.dart';
 part 'model/ring_settings_request.dart';
 part 'model/ring_settings_response.dart';
 part 'model/sdk_usage_report.dart';

packages/stream_video/lib/open_api/video/coordinator/api/productvideo_api.dart

@@ -2192,6 +2192,88 @@ class ProductvideoApi {
     return null;
   }
 
+  /// Ring Call Users
+  ///
+  /// Sends a ring notification to the provided users who are not already in the call. All users should be members of the call  Sends events: - call.ring
+  ///
+  /// Note: This method returns the HTTP [Response].
+  ///
+  /// Parameters:
+  ///
+  /// * [String] type (required):
+  ///
+  /// * [String] id (required):
+  ///
+  /// * [RingCallRequest] ringCallRequest (required):
+  ///   RingCallRequest
+  Future<Response> ringCallWithHttpInfo(
+    String type,
+    String id,
+    RingCallRequest ringCallRequest,
+  ) async {
+    // ignore: prefer_const_declarations
+    final path = r'/video/call/{type}/{id}/ring'
+        .replaceAll('{type}', type)
+        .replaceAll('{id}', id);
+
+    // ignore: prefer_final_locals
+    Object? postBody = ringCallRequest;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    const contentTypes = <String>['application/json'];
+
+    return apiClient.invokeAPI(
+      path,
+      'POST',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// Ring Call Users
+  ///
+  /// Sends a ring notification to the provided users who are not already in the call. All users should be members of the call  Sends events: - call.ring
+  ///
+  /// Parameters:
+  ///
+  /// * [String] type (required):
+  ///
+  /// * [String] id (required):
+  ///
+  /// * [RingCallRequest] ringCallRequest (required):
+  ///   RingCallRequest
+  Future<RingCallResponse?> ringCall(
+    String type,
+    String id,
+    RingCallRequest ringCallRequest,
+  ) async {
+    final response = await ringCallWithHttpInfo(
+      type,
+      id,
+      ringCallRequest,
+    );
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty &&
+        response.statusCode != HttpStatus.noContent) {
+      return await apiClient.deserializeAsync(
+        await _decodeBodyBytes(response),
+        'RingCallResponse',
+      ) as RingCallResponse;
+    }
+    return null;
+  }
+
   /// Send custom event
   ///
   /// Sends custom event to the call  Sends events: - custom

packages/stream_video/lib/open_api/video/coordinator/api_client.dart

@@ -548,6 +548,8 @@ class ApiClient {
           return PinResponse.fromJson(value);
         case 'PrivacySettings':
           return PrivacySettings.fromJson(value);
+        case 'PublishedTrackFlags':
+          return PublishedTrackFlags.fromJson(value);
         case 'PublisherStatsResponse':
           return PublisherStatsResponse.fromJson(value);
         case 'PushPreferences':
@@ -606,6 +608,10 @@ class ApiClient {
           return RequestPermissionResponse.fromJson(value);
         case 'DurationResponse':
           return DurationResponse.fromJson(value);
+        case 'RingCallRequest':
+          return RingCallRequest.fromJson(value);
+        case 'RingCallResponse':
+          return RingCallResponse.fromJson(value);
         case 'RingSettingsRequest':
           return RingSettingsRequest.fromJson(value);
         case 'RingSettingsResponse':

packages/stream_video/lib/open_api/video/coordinator/model/audio_settings_request.dart

@@ -15,6 +15,7 @@ class AudioSettingsRequest {
   AudioSettingsRequest({
     this.accessRequestEnabled,
     required this.defaultDevice,
+    this.hifiAudioEnabled,
     this.micDefaultOn,
     this.noiseCancellation,
     this.opusDtxEnabled,
@@ -32,6 +33,14 @@ class AudioSettingsRequest {
 
   AudioSettingsRequestDefaultDeviceEnum defaultDevice;
 
+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  bool? hifiAudioEnabled;
+
   ///
   /// Please note: This property should have been non-nullable! Since the specification file
   /// does not include a default value (using the "default:" property), however, the generated
@@ -78,6 +87,7 @@ class AudioSettingsRequest {
       other is AudioSettingsRequest &&
           other.accessRequestEnabled == accessRequestEnabled &&
           other.defaultDevice == defaultDevice &&
+          other.hifiAudioEnabled == hifiAudioEnabled &&
           other.micDefaultOn == micDefaultOn &&
           other.noiseCancellation == noiseCancellation &&
           other.opusDtxEnabled == opusDtxEnabled &&
@@ -89,6 +99,7 @@ class AudioSettingsRequest {
       // ignore: unnecessary_parenthesis
       (accessRequestEnabled == null ? 0 : accessRequestEnabled!.hashCode) +
       (defaultDevice.hashCode) +
+      (hifiAudioEnabled == null ? 0 : hifiAudioEnabled!.hashCode) +
       (micDefaultOn == null ? 0 : micDefaultOn!.hashCode) +
       (noiseCancellation == null ? 0 : noiseCancellation!.hashCode) +
       (opusDtxEnabled == null ? 0 : opusDtxEnabled!.hashCode) +
@@ -97,7 +108,7 @@ class AudioSettingsRequest {
 
   @override
   String toString() =>
-      'AudioSettingsRequest[accessRequestEnabled=$accessRequestEnabled, defaultDevice=$defaultDevice, micDefaultOn=$micDefaultOn, noiseCancellation=$noiseCancellation, opusDtxEnabled=$opusDtxEnabled, redundantCodingEnabled=$redundantCodingEnabled, speakerDefaultOn=$speakerDefaultOn]';
+      'AudioSettingsRequest[accessRequestEnabled=$accessRequestEnabled, defaultDevice=$defaultDevice, hifiAudioEnabled=$hifiAudioEnabled, micDefaultOn=$micDefaultOn, noiseCancellation=$noiseCancellation, opusDtxEnabled=$opusDtxEnabled, redundantCodingEnabled=$redundantCodingEnabled, speakerDefaultOn=$speakerDefaultOn]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
@@ -107,6 +118,11 @@ class AudioSettingsRequest {
       json[r'access_request_enabled'] = null;
     }
     json[r'default_device'] = this.defaultDevice;
+    if (this.hifiAudioEnabled != null) {
+      json[r'hifi_audio_enabled'] = this.hifiAudioEnabled;
+    } else {
+      json[r'hifi_audio_enabled'] = null;
+    }
     if (this.micDefaultOn != null) {
       json[r'mic_default_on'] = this.micDefaultOn;
     } else {
@@ -160,6 +176,7 @@ class AudioSettingsRequest {
             mapValueOfType<bool>(json, r'access_request_enabled'),
         defaultDevice: AudioSettingsRequestDefaultDeviceEnum.fromJson(
             json[r'default_device'])!,
+        hifiAudioEnabled: mapValueOfType<bool>(json, r'hifi_audio_enabled'),
         micDefaultOn: mapValueOfType<bool>(json, r'mic_default_on'),
         noiseCancellation:
             NoiseCancellationSettings.fromJson(json[r'noise_cancellation']),

packages/stream_video/lib/open_api/video/coordinator/model/audio_settings_response.dart

@@ -15,6 +15,7 @@ class AudioSettingsResponse {
   AudioSettingsResponse({
     required this.accessRequestEnabled,
     required this.defaultDevice,
+    required this.hifiAudioEnabled,
     required this.micDefaultOn,
     this.noiseCancellation,
     required this.opusDtxEnabled,
@@ -26,6 +27,8 @@ class AudioSettingsResponse {
 
   AudioSettingsResponseDefaultDeviceEnum defaultDevice;
 
+  bool hifiAudioEnabled;
+
   bool micDefaultOn;
 
   ///
@@ -48,6 +51,7 @@ class AudioSettingsResponse {
       other is AudioSettingsResponse &&
           other.accessRequestEnabled == accessRequestEnabled &&
           other.defaultDevice == defaultDevice &&
+          other.hifiAudioEnabled == hifiAudioEnabled &&
           other.micDefaultOn == micDefaultOn &&
           other.noiseCancellation == noiseCancellation &&
           other.opusDtxEnabled == opusDtxEnabled &&
@@ -59,6 +63,7 @@ class AudioSettingsResponse {
       // ignore: unnecessary_parenthesis
       (accessRequestEnabled.hashCode) +
       (defaultDevice.hashCode) +
+      (hifiAudioEnabled.hashCode) +
       (micDefaultOn.hashCode) +
       (noiseCancellation == null ? 0 : noiseCancellation!.hashCode) +
       (opusDtxEnabled.hashCode) +
@@ -67,12 +72,13 @@ class AudioSettingsResponse {
 
   @override
   String toString() =>
-      'AudioSettingsResponse[accessRequestEnabled=$accessRequestEnabled, defaultDevice=$defaultDevice, micDefaultOn=$micDefaultOn, noiseCancellation=$noiseCancellation, opusDtxEnabled=$opusDtxEnabled, redundantCodingEnabled=$redundantCodingEnabled, speakerDefaultOn=$speakerDefaultOn]';
+      'AudioSettingsResponse[accessRequestEnabled=$accessRequestEnabled, defaultDevice=$defaultDevice, hifiAudioEnabled=$hifiAudioEnabled, micDefaultOn=$micDefaultOn, noiseCancellation=$noiseCancellation, opusDtxEnabled=$opusDtxEnabled, redundantCodingEnabled=$redundantCodingEnabled, speakerDefaultOn=$speakerDefaultOn]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
     json[r'access_request_enabled'] = this.accessRequestEnabled;
     json[r'default_device'] = this.defaultDevice;
+    json[r'hifi_audio_enabled'] = this.hifiAudioEnabled;
     json[r'mic_default_on'] = this.micDefaultOn;
     if (this.noiseCancellation != null) {
       json[r'noise_cancellation'] = this.noiseCancellation;
@@ -110,6 +116,7 @@ class AudioSettingsResponse {
             mapValueOfType<bool>(json, r'access_request_enabled')!,
         defaultDevice: AudioSettingsResponseDefaultDeviceEnum.fromJson(
             json[r'default_device'])!,
+        hifiAudioEnabled: mapValueOfType<bool>(json, r'hifi_audio_enabled')!,
         micDefaultOn: mapValueOfType<bool>(json, r'mic_default_on')!,
         noiseCancellation:
             NoiseCancellationSettings.fromJson(json[r'noise_cancellation']),
@@ -175,6 +182,7 @@ class AudioSettingsResponse {
   static const requiredKeys = <String>{
     'access_request_enabled',
     'default_device',
+    'hifi_audio_enabled',
     'mic_default_on',
     'opus_dtx_enabled',
     'redundant_coding_enabled',

packages/stream_video/lib/open_api/video/coordinator/model/call_closed_caption.dart

@@ -14,51 +14,85 @@ class CallClosedCaption {
   /// Returns a new [CallClosedCaption] instance.
   CallClosedCaption({
     required this.endTime,
+    required this.id,
+    required this.language,
+    this.service,
     required this.speakerId,
     required this.startTime,
     required this.text,
+    required this.translated,
     required this.user,
   });
 
   DateTime endTime;
 
+  String id;
+
+  String language;
+
+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  String? service;
+
   String speakerId;
 
   DateTime startTime;
 
   String text;
 
+  bool translated;
+
   UserResponse user;
 
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
       other is CallClosedCaption &&
           other.endTime == endTime &&
+          other.id == id &&
+          other.language == language &&
+          other.service == service &&
           other.speakerId == speakerId &&
           other.startTime == startTime &&
           other.text == text &&
+          other.translated == translated &&
           other.user == user;
 
   @override
   int get hashCode =>
       // ignore: unnecessary_parenthesis
       (endTime.hashCode) +
+      (id.hashCode) +
+      (language.hashCode) +
+      (service == null ? 0 : service!.hashCode) +
       (speakerId.hashCode) +
       (startTime.hashCode) +
       (text.hashCode) +
+      (translated.hashCode) +
       (user.hashCode);
 
   @override
   String toString() =>
-      'CallClosedCaption[endTime=$endTime, speakerId=$speakerId, startTime=$startTime, text=$text, user=$user]';
+      'CallClosedCaption[endTime=$endTime, id=$id, language=$language, service=$service, speakerId=$speakerId, startTime=$startTime, text=$text, translated=$translated, user=$user]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
     json[r'end_time'] = this.endTime.toUtc().toIso8601String();
+    json[r'id'] = this.id;
+    json[r'language'] = this.language;
+    if (this.service != null) {
+      json[r'service'] = this.service;
+    } else {
+      json[r'service'] = null;
+    }
     json[r'speaker_id'] = this.speakerId;
     json[r'start_time'] = this.startTime.toUtc().toIso8601String();
     json[r'text'] = this.text;
+    json[r'translated'] = this.translated;
     json[r'user'] = this.user;
     return json;
   }
@@ -85,9 +119,13 @@ class CallClosedCaption {
 
       return CallClosedCaption(
         endTime: mapDateTime(json, r'end_time', r'')!,
+        id: mapValueOfType<String>(json, r'id')!,
+        language: mapValueOfType<String>(json, r'language')!,
+        service: mapValueOfType<String>(json, r'service'),
         speakerId: mapValueOfType<String>(json, r'speaker_id')!,
         startTime: mapDateTime(json, r'start_time', r'')!,
         text: mapValueOfType<String>(json, r'text')!,
+        translated: mapValueOfType<bool>(json, r'translated')!,
         user: UserResponse.fromJson(json[r'user'])!,
       );
     }
@@ -146,9 +184,12 @@ class CallClosedCaption {
   /// The list of required keys that must be present in a JSON.
   static const requiredKeys = <String>{
     'end_time',
+    'id',
+    'language',
     'speaker_id',
     'start_time',
     'text',
+    'translated',
     'user',
   };
 }