add the option for the generate-spec command to rename models (#624)

--------- Co-authored-by: Martin Mitrevski <[email protected]>
GetStream · Jan 17, 2025 · 9778d87 · 9778d87
1 parent 726e9cd
commit 9778d87
Show file tree

Hide file tree

Showing 38 changed files with 505 additions and 225 deletions.
diff --git a/Scripts/generate.sh b/Scripts/generate.sh
@@ -16,7 +16,7 @@ rm -rf ./Sources/StreamVideo/OpenApi/generated/Models/*
 # cd in API repo, generate new spec and then generate code from it
 (
   cd $SOURCE_PATH &&
-  go run ./cmd/chat-manager openapi generate-spec -products video -version v1 -clientside -output releases/video-openapi-clientside &&
+  go run ./cmd/chat-manager openapi generate-spec -products video -version v1 -clientside -output releases/video-openapi-clientside -renamed-models ../stream-video-swift/Scripts/renamed-models.json &&
   go run ./cmd/chat-manager openapi generate-client --language swift --spec ./releases/video-openapi-clientside.yaml --output ../stream-video-swift/Sources/StreamVideo/OpenApi/generated/
 )
 

diff --git a/Scripts/renamed-models.json b/Scripts/renamed-models.json
@@ -0,0 +1,23 @@
+{
+  "QueryCallMembersResponse": "QueryMembersResponse",
+  "QueryCallMembersRequest": "QueryMembersRequest",
+  "Response": "ModelResponse",
+  "SendCallEventRequest": "SendEventRequest",
+  "SendCallEventResponse": "SendEventResponse",
+  "AudioSettingsResponse": "AudioSettings",
+  "SortParam": "SortParamRequest",
+  "WSAuthMessage": "WSAuthMessageRequest",
+  "TranscriptionSettingsResponse": "TranscriptionSettings",
+  "SendCallEvent": "SendEvent",
+  "BackstageSettingsResponse": "BackstageSettings",
+  "GeofenceSettingsResponse": "GeofenceSettings",
+  "LayoutSettingsRequest": "LayoutSettings",
+  "RingSettingsResponse": "RingSettings",
+  "ScreensharingSettingsResponse": "ScreensharingSettings",
+  "ThumbnailsSettingsResponse": "ThumbnailsSettings",
+  "VideoSettingsResponse": "VideoSettings",
+  "TimeStats": "Stats",
+  "NoiseCancellationSettings": "NoiseCancellationSettingsRequest",
+  "VideoDimension": "VideoResolution",
+  "DeviceResponse": "Device"
+}
diff --git a/Sources/StreamVideo/Call.swift b/Sources/StreamVideo/Call.swift
@@ -734,7 +734,15 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
     /// Stops an ongoing live call.
     @discardableResult
     public func stopLive() async throws -> StopLiveResponse {
-        try await coordinatorClient.stopLive(type: callType, id: callId)
+        try await stopLive(request: .init())
+    }
+
+    public func stopLive(request: StopLiveRequest) async throws -> StopLiveResponse {
+        try await coordinatorClient.stopLive(
+            type: callType,
+            id: callId,
+            stopLiveRequest: request
+        )
     }
 
     // MARK: - Recording
@@ -786,7 +794,7 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
     /// - Throws: An error if the sending fails.
     @discardableResult
     public func sendCustomEvent(_ data: [String: RawJSON]) async throws -> SendEventResponse {
-        try await coordinatorClient.sendEvent(
+        try await coordinatorClient.sendCallEvent(
             type: callType,
             id: callId,
             sendEventRequest: SendEventRequest(custom: data)
@@ -1087,14 +1095,19 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
 
     /// Stops a conversation from being transcribed and returns whether the stop request was successful
     /// or not.
-    ///
-    /// - Returns: A StopTranscriptionResponse indicating whether the stop request was successful
+    /// - Parameter stopClosedCaptions: A boolean value indicating whether to stop closed captions.
+    /// - Returns: A StopTranscriptionResponse indicating whether the stop request was successful.
     /// or not.
     @discardableResult
-    public func stopTranscription() async throws -> StopTranscriptionResponse {
+    public func stopTranscription(
+        stopClosedCaptions: Bool? = nil
+    ) async throws -> StopTranscriptionResponse {
         try await coordinatorClient.stopTranscription(
             type: callType,
-            id: callId
+            id: callId,
+            stopTranscriptionRequest: StopTranscriptionRequest(
+                stopClosedCaptions: stopClosedCaptions
+            )
         )
     }
 

diff --git a/Sources/StreamVideo/OpenApi/generated/APIs/DefaultAPI.swift b/Sources/StreamVideo/OpenApi/generated/APIs/DefaultAPI.swift
@@ -318,7 +318,7 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
         }
     }
 
-    open func sendEvent(type: String, id: String, sendEventRequest: SendEventRequest) async throws -> SendEventResponse {
+    open func sendCallEvent(type: String, id: String, sendEventRequest: SendEventRequest) async throws -> SendEventResponse {
         var path = "/video/call/{type}/{id}/event"
 
         let typePreEscape = "\(APIHelper.mapValueToPathItem(type))"
@@ -665,7 +665,11 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
         }
     }
 
-    open func startClosedCaptions(type: String, id: String) async throws -> StartClosedCaptionsResponse {
+    open func startClosedCaptions(
+        type: String,
+        id: String,
+        startClosedCaptionsRequest: StartClosedCaptionsRequest
+    ) async throws -> StartClosedCaptionsResponse {
         var path = "/video/call/{type}/{id}/start_closed_captions"
 
         let typePreEscape = "\(APIHelper.mapValueToPathItem(type))"
@@ -677,7 +681,8 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
 
         let urlRequest = try makeRequest(
             uriPath: path,
-            httpMethod: "POST"
+            httpMethod: "POST",
+            request: startClosedCaptionsRequest
         )
         return try await send(request: urlRequest) {
             try self.jsonDecoder.decode(StartClosedCaptionsResponse.self, from: $0)
@@ -778,7 +783,11 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
         }
     }
 
-    open func stopClosedCaptions(type: String, id: String) async throws -> StopClosedCaptionsResponse {
+    open func stopClosedCaptions(
+        type: String,
+        id: String,
+        stopClosedCaptionsRequest: StopClosedCaptionsRequest
+    ) async throws -> StopClosedCaptionsResponse {
         var path = "/video/call/{type}/{id}/stop_closed_captions"
 
         let typePreEscape = "\(APIHelper.mapValueToPathItem(type))"
@@ -790,14 +799,15 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
 
         let urlRequest = try makeRequest(
             uriPath: path,
-            httpMethod: "POST"
+            httpMethod: "POST",
+            request: stopClosedCaptionsRequest
         )
         return try await send(request: urlRequest) {
             try self.jsonDecoder.decode(StopClosedCaptionsResponse.self, from: $0)
         }
     }
 
-    open func stopLive(type: String, id: String) async throws -> StopLiveResponse {
+    open func stopLive(type: String, id: String, stopLiveRequest: StopLiveRequest) async throws -> StopLiveResponse {
         var path = "/video/call/{type}/{id}/stop_live"
 
         let typePreEscape = "\(APIHelper.mapValueToPathItem(type))"
@@ -809,7 +819,8 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
 
         let urlRequest = try makeRequest(
             uriPath: path,
-            httpMethod: "POST"
+            httpMethod: "POST",
+            request: stopLiveRequest
         )
         return try await send(request: urlRequest) {
             try self.jsonDecoder.decode(StopLiveResponse.self, from: $0)
@@ -835,7 +846,11 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
         }
     }
 
-    open func stopTranscription(type: String, id: String) async throws -> StopTranscriptionResponse {
+    open func stopTranscription(
+        type: String,
+        id: String,
+        stopTranscriptionRequest: StopTranscriptionRequest
+    ) async throws -> StopTranscriptionResponse {
         var path = "/video/call/{type}/{id}/stop_transcription"
 
         let typePreEscape = "\(APIHelper.mapValueToPathItem(type))"
@@ -847,7 +862,8 @@ open class DefaultAPI: DefaultAPIEndpoints, @unchecked Sendable {
 
         let urlRequest = try makeRequest(
             uriPath: path,
-            httpMethod: "POST"
+            httpMethod: "POST",
+            request: stopTranscriptionRequest
         )
         return try await send(request: urlRequest) {
             try self.jsonDecoder.decode(StopTranscriptionResponse.self, from: $0)
@@ -1125,7 +1141,7 @@ protocol DefaultAPIEndpoints {
 
     func deleteCall(type: String, id: String, deleteCallRequest: DeleteCallRequest) async throws -> DeleteCallResponse
 
-    func sendEvent(type: String, id: String, sendEventRequest: SendEventRequest) async throws -> SendEventResponse
+    func sendCallEvent(type: String, id: String, sendEventRequest: SendEventRequest) async throws -> SendEventResponse
 
     func collectUserFeedback(
         type: String,
@@ -1165,7 +1181,8 @@ protocol DefaultAPIEndpoints {
 
     func startHLSBroadcasting(type: String, id: String) async throws -> StartHLSBroadcastingResponse
 
-    func startClosedCaptions(type: String, id: String) async throws -> StartClosedCaptionsResponse
+    func startClosedCaptions(type: String, id: String, startClosedCaptionsRequest: StartClosedCaptionsRequest) async throws
+        -> StartClosedCaptionsResponse
 
     func startRecording(type: String, id: String, startRecordingRequest: StartRecordingRequest) async throws
         -> StartRecordingResponse
@@ -1177,13 +1194,15 @@ protocol DefaultAPIEndpoints {
 
     func stopHLSBroadcasting(type: String, id: String) async throws -> StopHLSBroadcastingResponse
 
-    func stopClosedCaptions(type: String, id: String) async throws -> StopClosedCaptionsResponse
+    func stopClosedCaptions(type: String, id: String, stopClosedCaptionsRequest: StopClosedCaptionsRequest) async throws
+        -> StopClosedCaptionsResponse
 
-    func stopLive(type: String, id: String) async throws -> StopLiveResponse
+    func stopLive(type: String, id: String, stopLiveRequest: StopLiveRequest) async throws -> StopLiveResponse
 
     func stopRecording(type: String, id: String) async throws -> StopRecordingResponse
 
-    func stopTranscription(type: String, id: String) async throws -> StopTranscriptionResponse
+    func stopTranscription(type: String, id: String, stopTranscriptionRequest: StopTranscriptionRequest) async throws
+        -> StopTranscriptionResponse
 
     func listTranscriptions(type: String, id: String) async throws -> ListTranscriptionsResponse
 

diff --git a/Sources/StreamVideo/OpenApi/generated/Models/CallClosedCaption.swift b/Sources/StreamVideo/OpenApi/generated/Models/CallClosedCaption.swift
@@ -10,9 +10,9 @@ public final class CallClosedCaption: @unchecked Sendable, Codable, JSONEncodabl
     public var speakerId: String
     public var startTime: Date
     public var text: String
-    public var user: UserResponse?
+    public var user: UserResponse
 
-    public init(endTime: Date, speakerId: String, startTime: Date, text: String, user: UserResponse? = nil) {
+    public init(endTime: Date, speakerId: String, startTime: Date, text: String, user: UserResponse) {
         self.endTime = endTime
         self.speakerId = speakerId
         self.startTime = startTime

diff --git a/Sources/StreamVideo/OpenApi/generated/Models/CallEvent.swift b/Sources/StreamVideo/OpenApi/generated/Models/CallEvent.swift
@@ -12,7 +12,7 @@ public final class CallEvent: @unchecked Sendable, Codable, JSONEncodable, Hasha
     public var description: String
     public var endTimestamp: Int
     public var issueTags: [String]?
-    public var kind: String?
+    public var kind: String
     public var severity: Int
     public var timestamp: Int
     public var type: String
@@ -24,7 +24,7 @@ public final class CallEvent: @unchecked Sendable, Codable, JSONEncodable, Hasha
         description: String,
         endTimestamp: Int,
         issueTags: [String]? = nil,
-        kind: String? = nil,
+        kind: String,
         severity: Int,
         timestamp: Int,
         type: String

diff --git a/Sources/StreamVideo/OpenApi/generated/Models/CallResponse.swift b/Sources/StreamVideo/OpenApi/generated/Models/CallResponse.swift
@@ -8,7 +8,7 @@ public final class CallResponse: @unchecked Sendable, Codable, JSONEncodable, Ha
 
     public var backstage: Bool
     public var blockedUserIds: [String]
-    public var captioning: Bool?
+    public var captioning: Bool
     public var cid: String
     public var createdAt: Date
     public var createdBy: UserResponse
@@ -32,7 +32,7 @@ public final class CallResponse: @unchecked Sendable, Codable, JSONEncodable, Ha
     public init(
         backstage: Bool,
         blockedUserIds: [String],
-        captioning: Bool? = nil,
+        captioning: Bool,
         cid: String,
         createdAt: Date,
         createdBy: UserResponse,

diff --git a/Sources/StreamVideo/OpenApi/generated/Models/CallSessionParticipantLeftEvent.swift b/Sources/StreamVideo/OpenApi/generated/Models/CallSessionParticipantLeftEvent.swift
@@ -8,20 +8,23 @@ public final class CallSessionParticipantLeftEvent: @unchecked Sendable, Event,
 
     public var callCid: String
     public var createdAt: Date
+    public var durationSeconds: Int
     public var participant: CallParticipantResponse
     public var sessionId: String
     public var type: String = "call.session_participant_left"
 
-    public init(callCid: String, createdAt: Date, participant: CallParticipantResponse, sessionId: String) {
+    public init(callCid: String, createdAt: Date, durationSeconds: Int, participant: CallParticipantResponse, sessionId: String) {
         self.callCid = callCid
         self.createdAt = createdAt
+        self.durationSeconds = durationSeconds
         self.participant = participant
         self.sessionId = sessionId
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
         case callCid = "call_cid"
         case createdAt = "created_at"
+        case durationSeconds = "duration_seconds"
         case participant
         case sessionId = "session_id"
         case type
@@ -30,6 +33,7 @@ public final class CallSessionParticipantLeftEvent: @unchecked Sendable, Event,
     public static func == (lhs: CallSessionParticipantLeftEvent, rhs: CallSessionParticipantLeftEvent) -> Bool {
         lhs.callCid == rhs.callCid &&
             lhs.createdAt == rhs.createdAt &&
+            lhs.durationSeconds == rhs.durationSeconds &&
             lhs.participant == rhs.participant &&
             lhs.sessionId == rhs.sessionId &&
             lhs.type == rhs.type
@@ -38,6 +42,7 @@ public final class CallSessionParticipantLeftEvent: @unchecked Sendable, Event,
     public func hash(into hasher: inout Hasher) {
         hasher.combine(callCid)
         hasher.combine(createdAt)
+        hasher.combine(durationSeconds)
         hasher.combine(participant)
         hasher.combine(sessionId)
         hasher.combine(type)

diff --git a/Sources/StreamVideo/OpenApi/generated/Models/CallSettingsRequest.swift b/Sources/StreamVideo/OpenApi/generated/Models/CallSettingsRequest.swift
@@ -14,6 +14,7 @@ public final class CallSettingsRequest: @unchecked Sendable, Codable, JSONEncoda
     public var recording: RecordSettingsRequest?
     public var ring: RingSettingsRequest?
     public var screensharing: ScreensharingSettingsRequest?
+    public var session: SessionSettingsRequest?
     public var thumbnails: ThumbnailsSettingsRequest?
     public var transcription: TranscriptionSettingsRequest?
     public var video: VideoSettingsRequest?
@@ -27,6 +28,7 @@ public final class CallSettingsRequest: @unchecked Sendable, Codable, JSONEncoda
         recording: RecordSettingsRequest? = nil,
         ring: RingSettingsRequest? = nil,
         screensharing: ScreensharingSettingsRequest? = nil,
+        session: SessionSettingsRequest? = nil,
         thumbnails: ThumbnailsSettingsRequest? = nil,
         transcription: TranscriptionSettingsRequest? = nil,
         video: VideoSettingsRequest? = nil
@@ -39,6 +41,7 @@ public final class CallSettingsRequest: @unchecked Sendable, Codable, JSONEncoda
         self.recording = recording
         self.ring = ring
         self.screensharing = screensharing
+        self.session = session
         self.thumbnails = thumbnails
         self.transcription = transcription
         self.video = video
@@ -53,6 +56,7 @@ public final class CallSettingsRequest: @unchecked Sendable, Codable, JSONEncoda
         case recording
         case ring
         case screensharing
+        case session
         case thumbnails
         case transcription
         case video
@@ -67,6 +71,7 @@ public final class CallSettingsRequest: @unchecked Sendable, Codable, JSONEncoda
             lhs.recording == rhs.recording &&
             lhs.ring == rhs.ring &&
             lhs.screensharing == rhs.screensharing &&
+            lhs.session == rhs.session &&
             lhs.thumbnails == rhs.thumbnails &&
             lhs.transcription == rhs.transcription &&
             lhs.video == rhs.video
@@ -81,6 +86,7 @@ public final class CallSettingsRequest: @unchecked Sendable, Codable, JSONEncoda
         hasher.combine(recording)
         hasher.combine(ring)
         hasher.combine(screensharing)
+        hasher.combine(session)
         hasher.combine(thumbnails)
         hasher.combine(transcription)
         hasher.combine(video)