feat: add Shield Lists APIs (box/box-openapi#528) (#496)

Co-authored-by: box-sdk-build <[email protected]>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "20cb559", "specHash": "a54170e", "version": "1.10.0" }
+{ "engineHash": "20cb559", "specHash": "630fc85", "version": "1.10.0" }

Box.Sdk.Gen/Client/BoxClient.cs

@@ -157,6 +157,8 @@ public class BoxClient : IBoxClient {
 
         public IDocgenManager Docgen { get; }
 
+        public IShieldListsManager ShieldLists { get; }
+
         public BoxClient(IAuthentication auth, NetworkSession? networkSession = default) {
             Auth = auth;
             NetworkSession = networkSession ?? new NetworkSession(baseUrls: new BaseUrls());
@@ -234,6 +236,7 @@ public BoxClient(IAuthentication auth, NetworkSession? networkSession = default)
             AiStudio = new AiStudioManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             DocgenTemplate = new DocgenTemplateManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             Docgen = new DocgenManager(networkSession: this.NetworkSession) { Auth = this.Auth };
+            ShieldLists = new ShieldListsManager(networkSession: this.NetworkSession) { Auth = this.Auth };
         }
         /// <summary>
         /// Make a custom http request using the client authentication and network session.

Box.Sdk.Gen/Client/IBoxClient.cs

@@ -155,5 +155,7 @@ public interface IBoxClient {
 
         public IDocgenManager Docgen { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
 
+        public IShieldListsManager ShieldLists { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
+
     }
 }

Box.Sdk.Gen/Managers/ShieldLists/CreateShieldListV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class CreateShieldListV2025R0Headers {
+        /// <summary>
+        /// Version header
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public CreateShieldListV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen/Managers/ShieldLists/DeleteShieldListByIdV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class DeleteShieldListByIdV2025R0Headers {
+        /// <summary>
+        /// Version header
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public DeleteShieldListByIdV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen/Managers/ShieldLists/GetShieldListByIdV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetShieldListByIdV2025R0Headers {
+        /// <summary>
+        /// Version header
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public GetShieldListByIdV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen/Managers/ShieldLists/GetShieldListsV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetShieldListsV2025R0Headers {
+        /// <summary>
+        /// Version header
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public GetShieldListsV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen/Managers/ShieldLists/IShieldListsManager.cs

@@ -0,0 +1,90 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public interface IShieldListsManager {
+        /// <summary>
+    /// Retrieves all shield lists in the enterprise.
+    /// </summary>
+    /// <param name="headers">
+    /// Headers of getShieldListsV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<ShieldListsV2025R0> GetShieldListsV2025R0Async(GetShieldListsV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+        /// <summary>
+    /// Creates a shield list.
+    /// </summary>
+    /// <param name="requestBody">
+    /// Request body of createShieldListV2025R0 method
+    /// </param>
+    /// <param name="headers">
+    /// Headers of createShieldListV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<ShieldListV2025R0> CreateShieldListV2025R0Async(ShieldListsCreateV2025R0 requestBody, CreateShieldListV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+        /// <summary>
+    /// Retrieves a single shield list by its ID.
+    /// </summary>
+    /// <param name="shieldListId">
+    /// The unique identifier that represents a shield list.
+    /// The ID for any Shield List can be determined by the response from the endpoint
+    /// fetching all shield lists for the enterprise.
+    /// Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+    /// </param>
+    /// <param name="headers">
+    /// Headers of getShieldListByIdV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<ShieldListV2025R0> GetShieldListByIdV2025R0Async(string shieldListId, GetShieldListByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+        /// <summary>
+    /// Delete a single shield list by its ID.
+    /// </summary>
+    /// <param name="shieldListId">
+    /// The unique identifier that represents a shield list.
+    /// The ID for any Shield List can be determined by the response from the endpoint
+    /// fetching all shield lists for the enterprise.
+    /// Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+    /// </param>
+    /// <param name="headers">
+    /// Headers of deleteShieldListByIdV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task DeleteShieldListByIdV2025R0Async(string shieldListId, DeleteShieldListByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+        /// <summary>
+    /// Updates a shield list.
+    /// </summary>
+    /// <param name="shieldListId">
+    /// The unique identifier that represents a shield list.
+    /// The ID for any Shield List can be determined by the response from the endpoint
+    /// fetching all shield lists for the enterprise.
+    /// Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+    /// </param>
+    /// <param name="requestBody">
+    /// Request body of updateShieldListByIdV2025R0 method
+    /// </param>
+    /// <param name="headers">
+    /// Headers of updateShieldListByIdV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<ShieldListV2025R0> UpdateShieldListByIdV2025R0Async(string shieldListId, ShieldListsUpdateV2025R0 requestBody, UpdateShieldListByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+    }
+}

Box.Sdk.Gen/Managers/ShieldLists/ShieldListsManager.cs

@@ -0,0 +1,121 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class ShieldListsManager : IShieldListsManager {
+        public IAuthentication? Auth { get; init; }
+
+        public NetworkSession NetworkSession { get; }
+
+        public ShieldListsManager(NetworkSession? networkSession = default) {
+            NetworkSession = networkSession ?? new NetworkSession();
+        }
+        /// <summary>
+        /// Retrieves all shield lists in the enterprise.
+        /// </summary>
+        /// <param name="headers">
+        /// Headers of getShieldListsV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<ShieldListsV2025R0> GetShieldListsV2025R0Async(GetShieldListsV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new GetShieldListsV2025R0Headers();
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/shield_lists"), method: "GET", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<ShieldListsV2025R0>(NullableUtils.Unwrap(response.Data));
+        }
+
+        /// <summary>
+        /// Creates a shield list.
+        /// </summary>
+        /// <param name="requestBody">
+        /// Request body of createShieldListV2025R0 method
+        /// </param>
+        /// <param name="headers">
+        /// Headers of createShieldListV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<ShieldListV2025R0> CreateShieldListV2025R0Async(ShieldListsCreateV2025R0 requestBody, CreateShieldListV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new CreateShieldListV2025R0Headers();
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/shield_lists"), method: "POST", contentType: "application/json", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Data = SimpleJsonSerializer.Serialize(requestBody), Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<ShieldListV2025R0>(NullableUtils.Unwrap(response.Data));
+        }
+
+        /// <summary>
+        /// Retrieves a single shield list by its ID.
+        /// </summary>
+        /// <param name="shieldListId">
+        /// The unique identifier that represents a shield list.
+        /// The ID for any Shield List can be determined by the response from the endpoint
+        /// fetching all shield lists for the enterprise.
+        /// Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+        /// </param>
+        /// <param name="headers">
+        /// Headers of getShieldListByIdV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<ShieldListV2025R0> GetShieldListByIdV2025R0Async(string shieldListId, GetShieldListByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new GetShieldListByIdV2025R0Headers();
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/shield_lists/", StringUtils.ToStringRepresentation(shieldListId)), method: "GET", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<ShieldListV2025R0>(NullableUtils.Unwrap(response.Data));
+        }
+
+        /// <summary>
+        /// Delete a single shield list by its ID.
+        /// </summary>
+        /// <param name="shieldListId">
+        /// The unique identifier that represents a shield list.
+        /// The ID for any Shield List can be determined by the response from the endpoint
+        /// fetching all shield lists for the enterprise.
+        /// Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+        /// </param>
+        /// <param name="headers">
+        /// Headers of deleteShieldListByIdV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task DeleteShieldListByIdV2025R0Async(string shieldListId, DeleteShieldListByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new DeleteShieldListByIdV2025R0Headers();
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/shield_lists/", StringUtils.ToStringRepresentation(shieldListId)), method: "DELETE", responseFormat: Box.Sdk.Gen.ResponseFormat.NoContent) { Headers = headersMap, Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Updates a shield list.
+        /// </summary>
+        /// <param name="shieldListId">
+        /// The unique identifier that represents a shield list.
+        /// The ID for any Shield List can be determined by the response from the endpoint
+        /// fetching all shield lists for the enterprise.
+        /// Example: "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 "
+        /// </param>
+        /// <param name="requestBody">
+        /// Request body of updateShieldListByIdV2025R0 method
+        /// </param>
+        /// <param name="headers">
+        /// Headers of updateShieldListByIdV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<ShieldListV2025R0> UpdateShieldListByIdV2025R0Async(string shieldListId, ShieldListsUpdateV2025R0 requestBody, UpdateShieldListByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new UpdateShieldListByIdV2025R0Headers();
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/shield_lists/", StringUtils.ToStringRepresentation(shieldListId)), method: "PUT", contentType: "application/json", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Data = SimpleJsonSerializer.Serialize(requestBody), Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<ShieldListV2025R0>(NullableUtils.Unwrap(response.Data));
+        }
+
+    }
+}

Box.Sdk.Gen/Managers/ShieldLists/UpdateShieldListByIdV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class UpdateShieldListByIdV2025R0Headers {
+        /// <summary>
+        /// Version header
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public UpdateShieldListByIdV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}