fix: Expose fields from BoxResponse for custom API calls

Sources/Core/Extensions/URLExtension.swift

@@ -8,12 +8,24 @@
 
 import Foundation
 
-extension URL {
+public extension URL {
 
+    /// Creates a valid `URL` based on configuration's `apiBaseURL` and `endpoint` path
+    ///
+    /// - Parameters:
+    ///   - endpoint: The relative path that will be appended to `apiBaseURL`
+    ///   - configuration: The SDK configuration that provides `apiBaseURL` URL
+    /// - Returns: The URL of the API endpoint.
     static func boxAPIEndpoint(_ endpoint: String, configuration: BoxSDKConfiguration) -> URL {
         return URL.make(from: endpoint, relativeTo: configuration.apiBaseURL)
     }
 
+    /// Creates a valid `URL` based on configuration's `uploadApiBaseURL` and `endpoint` path
+    ///
+    /// - Parameters:
+    ///   - endpoint: The relative path that will be appended to `uploadApiBaseURL`
+    ///   - configuration: The SDK configuration that provides `uploadApiBaseURL` URL
+    /// - Returns: The URL of the upload API endpoint.
     static func boxUploadEndpoint(_ endpoint: String, configuration: BoxSDKConfiguration) -> URL {
         return URL.make(from: endpoint, relativeTo: configuration.uploadApiBaseURL)
     }

Sources/Core/ResponseHandler.swift

@@ -9,13 +9,13 @@
 import Foundation
 
 /// Utility methods for common response handling
-enum ResponseHandler {
+public enum ResponseHandler {
 
     /// Make sure the response is successful (status code 2xx) and deserialize
     /// the response body into the appropriate type.
     ///
     /// - Parameter completion: The user-specified completion block to call with the resulting deserialized object
-    static func `default`<T: BoxModel>(wrapping completion: @escaping Callback<T>) -> Callback<BoxResponse> {
+    public static func `default`<T: BoxModel>(wrapping completion: @escaping Callback<T>) -> Callback<BoxResponse> {
         return { (result: Result<BoxResponse, BoxSDKError>) in
             let objectResult: Result<T, BoxSDKError> = result.flatMap { ObjectDeserializer.deserialize(data: $0.body) }
             completion(objectResult)
@@ -26,7 +26,7 @@ enum ResponseHandler {
     /// the response body into the appropriate type.
     ///
     /// - Parameter completion: The user-specified completion block to call with the resulting deserialized object
-    static func `default`<T: Decodable>(wrapping completion: @escaping Callback<T>) -> Callback<BoxResponse> {
+    public static func `default`<T: Decodable>(wrapping completion: @escaping Callback<T>) -> Callback<BoxResponse> {
         return { (result: Result<BoxResponse, BoxSDKError>) in
             let objectResult: Result<T, BoxSDKError> = result.flatMap { ObjectDeserializer.deserialize(response: $0) }
             completion(objectResult)
@@ -37,7 +37,7 @@ enum ResponseHandler {
     /// for operations that do not return meaningful results — just success vs. failure.
     ///
     /// - Parameter completion: The user-specified completion block to call with the result
-    static func `default`(wrapping completion: @escaping Callback<Void>) -> Callback<BoxResponse> {
+    public static func `default`(wrapping completion: @escaping Callback<Void>) -> Callback<BoxResponse> {
         return { (result: Result<BoxResponse, BoxSDKError>) in
             let objectResult = result.map { _ in }
             completion(objectResult)
@@ -47,7 +47,7 @@ enum ResponseHandler {
     /// This will help the user unwrap a response object that comes back as a collection where the collection
     /// is only of size one. This will give the user an Entry Container containing the Box Model expected.
     /// - Parameter completion: The user-specified completion block to call with the result
-    static func unwrapCollection<T: BoxModel>(wrapping completion: @escaping Callback<T>) -> Callback<BoxResponse> {
+    public static func unwrapCollection<T: BoxModel>(wrapping completion: @escaping Callback<T>) -> Callback<BoxResponse> {
         return { result in
             completion(result.flatMap {
                 ObjectDeserializer.deserialize(data: $0.body).flatMap { (container: EntryContainer<T>) in

Sources/Network/ObjectDeserializer.swift

@@ -8,9 +8,16 @@
 
 import Foundation
 
-enum ObjectDeserializer {
+/// Provides methods for deserialization JSON data to custom objects
+public enum ObjectDeserializer {
 
-    static func deserialize<ReturnType: BoxModel>(data: Data?) -> Result<ReturnType, BoxSDKError> {
+    /// Deserializes `Data?` object to the type that conforms to `BoxModel` and returns a `Result` of this type if success
+    /// or `BoxSDKError` on failure.
+    ///
+    /// - Parameters:
+    ///   - data: Binary data to deserialize
+    /// - Returns: Returns an object if success otherwise error
+    public static func deserialize<ReturnType: BoxModel>(data: Data?) -> Result<ReturnType, BoxSDKError> {
 
         guard let bodyData = data else {
             return .failure(BoxCodingError(message: "Invalid response to deserialize"))
@@ -33,7 +40,13 @@ enum ObjectDeserializer {
         }
     }
 
-    static func deserialize<ReturnType: Decodable>(response: BoxResponse) -> Result<ReturnType, BoxSDKError> {
+    /// Deserializes `BoxResponse` object to the type that conforms to `Decodable` and returns a `Result` of this type if success
+    /// or `BoxSDKError` on failure.
+    ///
+    /// - Parameters:
+    ///   - response: The `BoxResponse` object which `body` will be deserialize
+    /// - Returns: Returns an object if success otherwise error
+    public static func deserialize<ReturnType: Decodable>(response: BoxResponse) -> Result<ReturnType, BoxSDKError> {
 
         guard let bodyData = response.body else {
             return .failure(BoxCodingError(message: "Invalid response to deserialize"))

Sources/Responses/BoxResponse.swift

@@ -8,11 +8,15 @@
 
 import Foundation
 
-/// Box API request response
+/// Box API response
 public struct BoxResponse {
-    var request: BoxRequest
-    var body: Data?
-    var urlResponse: HTTPURLResponse?
+    /// The Box SDK API request related to this response.
+    public let request: BoxRequest
+    ///  The body of the response in a binary format
+    public let body: Data?
+    ///  The object that represents a  HTTP response which includes data such as
+    /// `statusCode` or `allHeaderFields`
+    public let urlResponse: HTTPURLResponse?
 
     init(request: BoxRequest, body: Data?, urlResponse: URLResponse?) {
         self.request = request