feat: add find app item for shared link endpoint (box/box-openapi#514) (#426)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "8f5e41b", "specHash": "6782a0d", "version": "1.8.0" }
+{ "engineHash": "41feeaa", "specHash": "3dc6f70", "version": "1.8.0" }

Box.Sdk.Gen/Client/BoxClient.cs

@@ -77,6 +77,8 @@ public class BoxClient : IBoxClient {
 
         public ISharedLinksWebLinksManager SharedLinksWebLinks { get; }
 
+        public ISharedLinksAppItemsManager SharedLinksAppItems { get; }
+
         public IUsersManager Users { get; }
 
         public ISessionTerminationManager SessionTermination { get; }
@@ -192,6 +194,7 @@ public BoxClient(IAuthentication auth, NetworkSession? networkSession = default)
             WebLinks = new WebLinksManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             TrashedWebLinks = new TrashedWebLinksManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             SharedLinksWebLinks = new SharedLinksWebLinksManager(networkSession: this.NetworkSession) { Auth = this.Auth };
+            SharedLinksAppItems = new SharedLinksAppItemsManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             Users = new UsersManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             SessionTermination = new SessionTerminationManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             Avatars = new AvatarsManager(networkSession: this.NetworkSession) { Auth = this.Auth };

Box.Sdk.Gen/Client/IBoxClient.cs

@@ -75,6 +75,8 @@ public interface IBoxClient {
 
         public ISharedLinksWebLinksManager SharedLinksWebLinks { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
 
+        public ISharedLinksAppItemsManager SharedLinksAppItems { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
+
         public IUsersManager Users { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
 
         public ISessionTerminationManager SessionTermination { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }

Box.Sdk.Gen/Managers/SharedLinksAppItems/GetSharedItemAppItemsHeaders.cs

@@ -0,0 +1,27 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetSharedItemAppItemsHeaders {
+        /// <summary>
+        /// A header containing the shared link and optional password for the
+        /// shared link.
+        /// 
+        /// The format for this header is `shared_link=[link]&shared_link_password=[password]`
+        /// </summary>
+        public string Boxapi { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public GetSharedItemAppItemsHeaders(string boxapi, Dictionary<string, string?>? extraHeaders = default) {
+            Boxapi = boxapi;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen/Managers/SharedLinksAppItems/ISharedLinksAppItemsManager.cs

@@ -0,0 +1,23 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+
+namespace Box.Sdk.Gen.Managers {
+    public interface ISharedLinksAppItemsManager {
+        /// <summary>
+    /// Returns the app item represented by a shared link.
+    /// 
+    /// The link can originate from the current enterprise or another.
+    /// </summary>
+    /// <param name="headers">
+    /// Headers of getSharedItemAppItems method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<AppItem> GetSharedItemAppItemsAsync(GetSharedItemAppItemsHeaders headers, 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/SharedLinksAppItems/SharedLinksAppItemsManager.cs

@@ -0,0 +1,34 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+
+namespace Box.Sdk.Gen.Managers {
+    public class SharedLinksAppItemsManager : ISharedLinksAppItemsManager {
+        public IAuthentication? Auth { get; init; }
+
+        public NetworkSession NetworkSession { get; }
+
+        public SharedLinksAppItemsManager(NetworkSession? networkSession = default) {
+            NetworkSession = networkSession ?? new NetworkSession();
+        }
+        /// <summary>
+        /// Returns the app item represented by a shared link.
+        /// 
+        /// The link can originate from the current enterprise or another.
+        /// </summary>
+        /// <param name="headers">
+        /// Headers of getSharedItemAppItems method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<AppItem> GetSharedItemAppItemsAsync(GetSharedItemAppItemsHeaders headers, System.Threading.CancellationToken? cancellationToken = null) {
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "boxapi", StringUtils.ToStringRepresentation(headers.Boxapi) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/shared_items#app_items"), method: "GET", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<AppItem>(NullableUtils.Unwrap(response.Data));
+        }
+
+    }
+}

docs/README.md

@@ -49,6 +49,7 @@ the SDK are available by topic:
 * [Retention policy assignments](RetentionPolicyAssignments.md)
 * [Search](Search.md)
 * [Session termination](SessionTermination.md)
+* [Shared links app items](SharedLinksAppItems.md)
 * [Shared links files](SharedLinksFiles.md)
 * [Shared links folders](SharedLinksFolders.md)
 * [Shared links web links](SharedLinksWebLinks.md)

docs/SharedLinksAppItems.md

@@ -0,0 +1,34 @@
+# ISharedLinksAppItemsManager
+
+
+- [Find app item for shared link](#find-app-item-for-shared-link)
+
+## Find app item for shared link
+
+Returns the app item represented by a shared link.
+
+The link can originate from the current enterprise or another.
+
+This operation is performed by calling function `GetSharedItemAppItems`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/get-shared-items--app-items/).
+
+*Currently we don't have an example for calling `GetSharedItemAppItems` in integration tests*
+
+### Arguments
+
+- headers `GetSharedItemAppItemsHeaders`
+  - Headers of getSharedItemAppItems method
+- cancellationToken `System.Threading.CancellationToken?`
+  - Token used for request cancellation.
+
+
+### Returns
+
+This function returns a value of type `AppItem`.
+
+Returns a full app item resource if the shared link is valid and
+the user has access to it.
+
+

docs/SharedLinksWebLinks.md

@@ -41,7 +41,7 @@ await userClient.SharedLinksWebLinks.FindWebLinkForSharedLinkAsync(queryParams:
 
 This function returns a value of type `WebLink`.
 
-Returns a full file resource if the shared link is valid and
+Returns a full web link resource if the shared link is valid and
 the user has access to it.