Skip to content

Commit

Permalink
feat: flag Meetings API and Proactive Connect API as obsolete
Browse files Browse the repository at this point in the history
Both APIs are being sunset
  • Loading branch information
Tr00d committed Aug 29, 2024
1 parent 80440ee commit b4a3239
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
21 changes: 20 additions & 1 deletion Vonage/Meetings/IMeetingsClient.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
using System.Threading.Tasks;
#region
using System;
using System.Threading.Tasks;
using Vonage.Common.Monads;
using Vonage.Meetings.Common;
using Vonage.Meetings.CreateRoom;
Expand All @@ -16,6 +18,7 @@
using Vonage.Meetings.UpdateRoom;
using Vonage.Meetings.UpdateTheme;
using Vonage.Meetings.UpdateThemeLogo;
#endregion

namespace Vonage.Meetings;

Expand All @@ -29,108 +32,124 @@ public interface IMeetingsClient
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Room>> CreateRoomAsync(Result<CreateRoomRequest> request);

/// <summary>
/// Creates a theme.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Theme>> CreateThemeAsync(Result<CreateThemeRequest> request);

/// <summary>
/// Deletes a recording.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> DeleteRecordingAsync(Result<DeleteRecordingRequest> request);

/// <summary>
/// Deletes a theme.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> DeleteThemeAsync(Result<DeleteThemeRequest> request);

/// <summary>
/// Retrieves numbers that can be used to dial into a meeting.
/// </summary>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<GetDialNumbersResponse[]>> GetDialNumbersAsync();

/// <summary>
/// Retrieves a recording details.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Recording>> GetRecordingAsync(Result<GetRecordingRequest> request);

/// <summary>
/// Retrieves recordings from a session.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<GetRecordingsResponse>> GetRecordingsAsync(Result<GetRecordingsRequest> request);

/// <summary>
/// Retrieves a room details.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Room>> GetRoomAsync(Result<GetRoomRequest> request);

/// <summary>
/// Retrieves all rooms.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<GetRoomsResponse>> GetRoomsAsync(Result<GetRoomsRequest> request);

/// <summary>
/// Retrieves rooms by theme.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<GetRoomsByThemeResponse>> GetRoomsByThemeAsync(Result<GetRoomsByThemeRequest> request);

/// <summary>
/// Retrieves a theme.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Theme>> GetThemeAsync(Result<GetThemeRequest> request);

/// <summary>
/// Retrieves all themes.
/// </summary>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Theme[]>> GetThemesAsync();

/// <summary>
/// Updates an application.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<UpdateApplicationResponse>> UpdateApplicationAsync(Result<UpdateApplicationRequest> request);

/// <summary>
/// Updates a room.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Room>> UpdateRoomAsync(Result<UpdateRoomRequest> request);

/// <summary>
/// Updates a theme.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Theme>> UpdateThemeAsync(Result<UpdateThemeRequest> request);

/// <summary>
/// Updates a logo image and associates it with a theme.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>A result indicating if the request whether succeeded or failed.</returns>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> UpdateThemeLogoAsync(Result<UpdateThemeLogoRequest> request);
}
18 changes: 18 additions & 0 deletions Vonage/ProactiveConnect/IProactiveConnectClient.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#region
using System;
using System.Threading.Tasks;
using Vonage.Common.Monads;
using Vonage.ProactiveConnect.Events.GetEvents;
Expand All @@ -17,6 +19,7 @@
using Vonage.ProactiveConnect.Lists.GetLists;
using Vonage.ProactiveConnect.Lists.ReplaceItems;
using Vonage.ProactiveConnect.Lists.UpdateList;
#endregion

namespace Vonage.ProactiveConnect;

Expand All @@ -30,103 +33,118 @@ public interface IProactiveConnectClient
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> ClearListAsync(Result<ClearListRequest> request);

/// <summary>
/// Creates an item.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<ListItem>> CreateItemAsync(Result<CreateItemRequest> request);

/// <summary>
/// Creates a list.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<List>> CreateListAsync(Result<CreateListRequest> request);

/// <summary>
/// Deletes an item.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> DeleteItemAsync(Result<DeleteItemRequest> request);

/// <summary>
/// Deletes a list.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> DeleteListAsync(Result<DeleteListRequest> request);

/// <summary>
/// Extracts list items as a CSV format.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<string>> ExtractItemsAsync(Result<ExtractItemsRequest> request);

/// <summary>
/// Retrieves all events.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<PaginationResult<EmbeddedEvents>>> GetEventsAsync(Result<GetEventsRequest> request);

/// <summary>
/// Retrieves an item.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<ListItem>> GetItemAsync(Result<GetItemRequest> request);

/// <summary>
/// Retrieves all items of a list.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<PaginationResult<EmbeddedItems>>> GetItemsAsync(Result<GetItemsRequest> request);

/// <summary>
/// Retrieves a single list.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<List>> GetListAsync(Result<GetListRequest> request);

/// <summary>
/// Retrieves all lists.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<PaginationResult<EmbeddedLists>>> GetListsAsync(Result<GetListsRequest> request);

/// <summary>
/// Imports list items from a CSV file.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<ImportItemsResponse>> ImportItemsAsync(Result<ImportItemsRequest> request);

/// <summary>
/// Fetches and replaces all items from datasource.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<Unit>> ReplaceItemsAsync(Result<ReplaceItemsRequest> request);

/// <summary>
/// Updates an item.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<ListItem>> UpdateItemAsync(Result<UpdateItemRequest> request);

/// <summary>
/// Updates a list.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Success or Failure.</returns>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
Task<Result<List>> UpdateListAsync(Result<UpdateListRequest> request);
}
2 changes: 2 additions & 0 deletions Vonage/VonageClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public Credentials Credentials
/// <summary>
/// Exposes Meetings features.
/// </summary>
[Obsolete("Meetings API is being sunset. It will be removed from the SDK on the next major version.")]
public IMeetingsClient MeetingsClient { get; private set; }

public IMessagesClient MessagesClient { get; private set; }
Expand All @@ -107,6 +108,7 @@ public Credentials Credentials
/// <summary>
/// Exposes ProactiveConnect features.
/// </summary>
[Obsolete("Proactive Connect API is being sunset. It will be removed from the SDK on the next major version.")]
public IProactiveConnectClient ProactiveConnectClient { get; private set; }

public IRedactClient RedactClient { get; private set; }
Expand Down

0 comments on commit b4a3239

Please sign in to comment.