diff --git a/.gitignore b/.gitignore
index e508c10e7..695ce7401 100644
--- a/.gitignore
+++ b/.gitignore
@@ -88,6 +88,10 @@ Pods/
# For more information about the recommended setup visit:
# https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Gitignore.md
+#Jazzy
+#
+undocumented.json
+
fastlane/report.xml
fastlane/Preview.html
fastlane/screenshots
diff --git a/BoxSDK.podspec b/BoxSDK.podspec
index 1a9e9769b..5ffd7a010 100644
--- a/BoxSDK.podspec
+++ b/BoxSDK.podspec
@@ -1,6 +1,6 @@
Pod::Spec.new do |spec|
spec.name = "BoxSDK"
- spec.version = "3.1.0"
+ spec.version = "4.0.0"
spec.summary = "Box Swift SDK"
spec.description = <<-DESC
Official Box Swift SDK.
@@ -10,9 +10,6 @@ Pod::Spec.new do |spec|
spec.author = { "Box" => "sdks@box.com" }
spec.social_media_url = "https://twitter.com/box"
spec.ios.deployment_target = "11.0"
- spec.osx.deployment_target = "10.13"
- spec.watchos.deployment_target = "4.0"
- spec.tvos.deployment_target = "11.0"
spec.source = { :git => "https://github.com/box/box-ios-sdk.git", :tag => "v"+spec.version.to_s }
spec.swift_versions = ["5.0", "5.1"]
spec.requires_arc = true
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 48f83c092..95b254c7a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,11 +1,12 @@
Changelog
=========
-## Next Release
+## v4.0.0 [2020-02-13]
__Breaking Changes:__
- Change `status` field for task assignments from a String to an Enum
+- Remove macOS, tvOS, and watchOS support
__New Features and Enhancements:__
diff --git a/Package.swift b/Package.swift
index 19177108d..fc51b2b26 100644
--- a/Package.swift
+++ b/Package.swift
@@ -12,10 +12,7 @@ import PackageDescription
let package = Package(
name: "BoxSDK",
platforms: [
- .iOS(.v11),
- .macOS(.v10_13),
- .watchOS(.v4),
- .tvOS(.v11)
+ .iOS(.v11)
],
products: [
.library(
diff --git a/README.md b/README.md
index 70c79e775..18d1bd70c 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ Installing the SDK
__Step 1__: Add to your `Cartfile`
```
-git "https://github.com/box/box-ios-sdk.git" ~> 3.0
+git "https://github.com/box/box-ios-sdk.git" ~> 4.0
```
__Step 2__: Update dependencies
@@ -59,7 +59,7 @@ For more detailed instructions, please see the [official documentation for Carth
__Step 1__: Add to your `Podfile`
```
-pod 'BoxSDK', '~> 3.0'
+pod 'BoxSDK', '~> 4.0'
```
__Step 2__: Install pod by running the following command in the directory with the `Podfile`
diff --git a/SampleApps/JWTSampleApp/Cartfile b/SampleApps/JWTSampleApp/Cartfile
index 4d98b6048..fd135f95f 100644
--- a/SampleApps/JWTSampleApp/Cartfile
+++ b/SampleApps/JWTSampleApp/Cartfile
@@ -1 +1 @@
-git "https://github.com/box/box-ios-sdk.git" ~> 3.0
+git "https://github.com/box/box-ios-sdk.git" ~> 4.0
diff --git a/SampleApps/OAuth2SampleApp/Cartfile b/SampleApps/OAuth2SampleApp/Cartfile
index 4d98b6048..fd135f95f 100644
--- a/SampleApps/OAuth2SampleApp/Cartfile
+++ b/SampleApps/OAuth2SampleApp/Cartfile
@@ -1 +1 @@
-git "https://github.com/box/box-ios-sdk.git" ~> 3.0
+git "https://github.com/box/box-ios-sdk.git" ~> 4.0
diff --git a/Sources/Info.plist b/Sources/Info.plist
index d9f6dd6e3..afcf10700 100644
--- a/Sources/Info.plist
+++ b/Sources/Info.plist
@@ -21,7 +21,7 @@
Step 1: Add to your Cartfile
git "https://github.com/box/box-ios-sdk.git" ~> 3.0
+git "https://github.com/box/box-ios-sdk.git" ~> 4.0
Step 2: Update dependencies
@@ -767,7 +767,7 @@ Carthage
CocoaPods
Step 1: Add to your Podfile
-pod 'BoxSDK', '~> 3.0'
+pod 'BoxSDK', '~> 4.0'
Step 2: Install pod by running the following command in the directory with the Podfile
@@ -808,6 +808,10 @@ Getting Started
}
}
+
+The usage docs that show how to make calls to the Box API with the SDK can be found here.
+
+The Jazzy docs that show class, method, variable, etc definitions can be found here.
Sample Apps
OAuth2 Sample App
@@ -988,7 +992,7 @@ Copyright and License
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/undocumented.json b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/undocumented.json
index 2629694c1..a31ad0c76 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/undocumented.json
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/undocumented.json
@@ -1,1083 +1,1083 @@
{
"warnings": [
{
- "file": "/box-ios-sdk/Sources/BoxSDK.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/BoxSDK.swift",
"line": 181,
"symbol": "BoxSDK.getOAuth2Client(tokenInfo:tokenStore:context:completion:)",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
"line": 13,
"symbol": "BoxAPIError.request",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
"line": 14,
"symbol": "BoxAPIError.response",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
"line": 74,
"symbol": "BoxAPIError.getDictionary()",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 11,
"symbol": "BoxSDKErrorEnum",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 13,
"symbol": "BoxSDKErrorEnum.clientDestroyed",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 14,
"symbol": "BoxSDKErrorEnum.invalidURL(urlString:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 15,
"symbol": "BoxSDKErrorEnum.notFound(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 16,
"symbol": "BoxSDKErrorEnum.instanceDeallocated(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 17,
"symbol": "BoxSDKErrorEnum.keychainDataConversionError",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 18,
"symbol": "BoxSDKErrorEnum.keychainNoValue",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 19,
"symbol": "BoxSDKErrorEnum.keychainUnhandledError(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 20,
"symbol": "BoxSDKErrorEnum.rateLimitMaxRetries",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 21,
"symbol": "BoxSDKErrorEnum.typeMismatch(key:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 22,
"symbol": "BoxSDKErrorEnum.valueMismatch(key:value:acceptedValues:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 23,
"symbol": "BoxSDKErrorEnum.invalidValueFormat(key:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 24,
"symbol": "BoxSDKErrorEnum.notPresent(key:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 25,
"symbol": "BoxSDKErrorEnum.representationCreationFailed",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 26,
"symbol": "BoxSDKErrorEnum.tokenStoreFailure",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 27,
"symbol": "BoxSDKErrorEnum.tokenRetrieval",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 28,
"symbol": "BoxSDKErrorEnum.invalidOAuthRedirectConfiguration",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 29,
"symbol": "BoxSDKErrorEnum.invalidOAuthState",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 30,
"symbol": "BoxSDKErrorEnum.unauthorizedAccess",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 31,
"symbol": "BoxSDKErrorEnum.refreshTokenNotFound",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 32,
"symbol": "BoxSDKErrorEnum.expiredToken",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 33,
"symbol": "BoxSDKErrorEnum.jwtAuthError",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 34,
"symbol": "BoxSDKErrorEnum.nonIterableResponse",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 35,
"symbol": "BoxSDKErrorEnum.endOfList",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 36,
"symbol": "BoxSDKErrorEnum.customValue(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 131,
"symbol": "BoxSDKErrorEnum",
"symbol_kind": "source.lang.swift.decl.extension",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 139,
"symbol": "BoxSDKError.errorType",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 140,
"symbol": "BoxSDKError.message",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 141,
"symbol": "BoxSDKError.stackTrace",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 142,
"symbol": "BoxSDKError.error",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
"line": 151,
"symbol": "BoxSDKError.getDictionary()",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Network/PagingIterator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
"line": 11,
"symbol": "PagingParameter",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Network/PagingIterator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
"line": 13,
"symbol": "PagingParameter.offset(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Network/PagingIterator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
"line": 14,
"symbol": "PagingParameter.marker(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Network/PagingIterator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
"line": 15,
"symbol": "PagingParameter.streamPosition(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Network/PagingIterator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
"line": 35,
"symbol": "PagingIterator.nextPage",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Requests/BodyData/LockData.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Requests/BodyData/LockData.swift",
"line": 11,
"symbol": "LockData",
"symbol_kind": "source.lang.swift.decl.struct",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Requests/BodyData/LockData.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Requests/BodyData/LockData.swift",
"line": 22,
"symbol": "LockData.init(expiresAt:isDownloadPrevented:)",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/CollaborationWhitelistEntry.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/CollaborationWhitelistEntry.swift",
"line": 11,
"symbol": "CollaborationDirection",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Collaborator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
"line": 17,
"symbol": "Collaborator.CollaboratorType",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Collaborator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
"line": 18,
"symbol": "Collaborator.CollaboratorType.user(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Collaborator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
"line": 19,
"symbol": "Collaborator.CollaboratorType.group(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Collaborator.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
"line": 22,
"symbol": "Collaborator.collaboratorValue",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/CommentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/CommentItem.swift",
"line": 24,
"symbol": "CommentItem.file(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/CommentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/CommentItem.swift",
"line": 25,
"symbol": "CommentItem.comment(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/DevicePin.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
"line": 12,
"symbol": "DevicePin",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/DevicePin.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
"line": 26,
"symbol": "DevicePin.ownedBy",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/DevicePin.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
"line": 28,
"symbol": "DevicePin.productName",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/DevicePin.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
"line": 30,
"symbol": "DevicePin.createdAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/DevicePin.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
"line": 32,
"symbol": "DevicePin.modifiedAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/EventType.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/EventType.swift",
"line": 12,
"symbol": "EventType",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/EventType.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/EventType.swift",
"line": 174,
"symbol": "EventType.metadataInstanceCreated",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
"line": 11,
"symbol": "FileRepresentationHint",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
"line": 94,
"symbol": "FileRepresentation.Status",
"symbol_kind": "source.lang.swift.decl.struct",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
"line": 95,
"symbol": "FileRepresentation.Status.state",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/GroupMembership.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
"line": 47,
"symbol": "GroupMembership",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/GroupMembership.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
"line": 49,
"symbol": "GroupMembership.ConfigurablePermissions",
"symbol_kind": "source.lang.swift.decl.struct",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/GroupMembership.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
"line": 50,
"symbol": "GroupMembership.ConfigurablePermissions.canRunReports",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/GroupMembership.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
"line": 51,
"symbol": "GroupMembership.ConfigurablePermissions.canInstantLogin",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/GroupMembership.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
"line": 52,
"symbol": "GroupMembership.ConfigurablePermissions.canCreateAccounts",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/GroupMembership.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
"line": 53,
"symbol": "GroupMembership.ConfigurablePermissions.canEditAccounts",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
"line": 15,
"symbol": "LegalHoldPolicy.AssignmentCounts.user",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
"line": 16,
"symbol": "LegalHoldPolicy.AssignmentCounts.folder",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
"line": 17,
"symbol": "LegalHoldPolicy.AssignmentCounts.file",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
"line": 18,
"symbol": "LegalHoldPolicy.AssignmentCounts.fileVersion",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
"line": 15,
"symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
"line": 16,
"symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.file(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
"line": 17,
"symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.fileVersion(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
"line": 18,
"symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.folder(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
"line": 19,
"symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.user(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
"line": 22,
"symbol": "LegalHoldPolicyAssignmentItem.itemValue",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RecentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
"line": 11,
"symbol": "RecentItem",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RecentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
"line": 68,
"symbol": "RecentItem.type",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RecentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
"line": 70,
"symbol": "RecentItem.interactionType",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RecentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
"line": 72,
"symbol": "RecentItem.interactedAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RecentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
"line": 74,
"symbol": "RecentItem.item",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RecentItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
"line": 76,
"symbol": "RecentItem.interactionSharedLink",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RetentionPolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RetentionPolicyAssignment.swift",
"line": 13,
"symbol": "RetentionPolicyAssignment",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RetentionPolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RetentionPolicyAssignment.swift",
"line": 32,
"symbol": "RetentionPolicyAssignment.filterFields",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/RetentionPolicyEntry.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RetentionPolicyEntry.swift",
"line": 11,
"symbol": "RetentionPolicyEntry",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/SharedItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
"line": 17,
"symbol": "SharedItem.SharedItemType",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/SharedItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
"line": 18,
"symbol": "SharedItem.SharedItemType.file(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/SharedItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
"line": 19,
"symbol": "SharedItem.SharedItemType.folder(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/SharedItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
"line": 20,
"symbol": "SharedItem.SharedItemType.webLink(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/SharedItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
"line": 23,
"symbol": "SharedItem.itemValue",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
"line": 10,
"symbol": "StoragePolicy",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
"line": 16,
"symbol": "StoragePolicy.type",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
"line": 18,
"symbol": "StoragePolicy.id",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
"line": 20,
"symbol": "StoragePolicy.name",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 10,
"symbol": "StoragePolicyAssignment",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 14,
"symbol": "StoragePolicyAssignment.AssignedTo.type",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 15,
"symbol": "StoragePolicyAssignment.AssignedTo.id",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 22,
"symbol": "StoragePolicyAssignment.type",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 24,
"symbol": "StoragePolicyAssignment.id",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 26,
"symbol": "StoragePolicyAssignment.storagePolicy",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
"line": 28,
"symbol": "StoragePolicyAssignment.assignedTo",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 11,
"symbol": "TaskCompletionRule",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 12,
"symbol": "TaskCompletionRule.allAssignees",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 13,
"symbol": "TaskCompletionRule.anyAssignee",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 14,
"symbol": "TaskCompletionRule.customValue(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 44,
"symbol": "TaskAction",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 45,
"symbol": "TaskAction.review",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 46,
"symbol": "TaskAction.complete",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Task.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
"line": 47,
"symbol": "TaskAction.customValue(_:)",
"symbol_kind": "source.lang.swift.decl.enumelement",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/TaskItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/TaskItem.swift",
"line": 11,
"symbol": "TaskItem",
"symbol_kind": "source.lang.swift.decl.enum",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/TaskItem.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/TaskItem.swift",
"line": 44,
"symbol": "TaskItem",
"symbol_kind": "source.lang.swift.decl.extension",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/TermsOfService.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/TermsOfService.swift",
"line": 21,
"symbol": "TermsOfService.id",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadPart.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
"line": 13,
"symbol": "UploadPartDescription.partId",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadPart.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
"line": 14,
"symbol": "UploadPartDescription.offset",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadPart.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
"line": 15,
"symbol": "UploadPartDescription.size",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadPart.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
"line": 16,
"symbol": "UploadPartDescription.sha1",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
"line": 16,
"symbol": "UploadSession.UploadSessionEndpoints.listParts",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
"line": 17,
"symbol": "UploadSession.UploadSessionEndpoints.commit",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
"line": 18,
"symbol": "UploadSession.UploadSessionEndpoints.logEvent",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
"line": 19,
"symbol": "UploadSession.UploadSessionEndpoints.uploadPart",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
"line": 20,
"symbol": "UploadSession.UploadSessionEndpoints.status",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/UploadSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
"line": 21,
"symbol": "UploadSession.UploadSessionEndpoints.abort",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Watermark.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Watermark.swift",
"line": 16,
"symbol": "Watermark.resourceKey",
"symbol_kind": "source.lang.swift.decl.var.static",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Watermark.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Watermark.swift",
"line": 18,
"symbol": "Watermark.imprintKey",
"symbol_kind": "source.lang.swift.decl.var.static",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Watermark.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Watermark.swift",
"line": 19,
"symbol": "Watermark.defaultImprint",
"symbol_kind": "source.lang.swift.decl.var.static",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 8,
"symbol": "WebLink.Permissions.canRename",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 9,
"symbol": "WebLink.Permissions.canDelete",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 10,
"symbol": "WebLink.Permissions.canComment",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 11,
"symbol": "WebLink.Permissions.canShare",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 12,
"symbol": "WebLink.Permissions.canSetShareAccess",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 26,
"symbol": "WebLink.sequenceId",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 27,
"symbol": "WebLink.etag",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 32,
"symbol": "WebLink.createdBy",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 33,
"symbol": "WebLink.createdAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 34,
"symbol": "WebLink.modifiedAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 39,
"symbol": "WebLink.itemStatus",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 40,
"symbol": "WebLink.trashedAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 41,
"symbol": "WebLink.purgedAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 42,
"symbol": "WebLink.sharedLink",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 43,
"symbol": "WebLink.pathCollection",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 44,
"symbol": "WebLink.modifiedBy",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 45,
"symbol": "WebLink.ownedBy",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/WebLink.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
"line": 46,
"symbol": "WebLink.permissions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 11,
"symbol": "Webhook",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 256,
"symbol": "Webhook.type",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 263,
"symbol": "Webhook.target",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 265,
"symbol": "Webhook.createdBy",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 267,
"symbol": "Webhook.createdAt",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 269,
"symbol": "Webhook.address",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Responses/Webhook.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
"line": 271,
"symbol": "Webhook.triggers",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Sessions/OAuth2/OAuth2Session.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Sessions/OAuth2/OAuth2Session.swift",
"line": 11,
"symbol": "OAuth2Session",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Sessions/OAuth2/OAuth2Session.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Sessions/OAuth2/OAuth2Session.swift",
"line": 64,
"symbol": "OAuth2Session.refreshToken(completion:)",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/Sessions/SingleToken/SingleTokenSession.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Sessions/SingleToken/SingleTokenSession.swift",
"line": 11,
"symbol": "SingleTokenSession",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/TokenStore/KeychainTokenStore.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/TokenStore/KeychainTokenStore.swift",
"line": 14,
"symbol": "KeychainTokenStore",
"symbol_kind": "source.lang.swift.decl.class",
"warning": "undocumented"
},
{
- "file": "/box-ios-sdk/Sources/TokenStore/KeychainTokenStore.swift",
+ "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/TokenStore/KeychainTokenStore.swift",
"line": 17,
"symbol": "KeychainTokenStore.init()",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
}
],
- "source_directory": "/box-ios-sdk"
+ "source_directory": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk"
}
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/authentication.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/authentication.md
index 1894b1cf7..77054fd36 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/authentication.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/authentication.md
@@ -92,6 +92,7 @@ their accounts. The SDK provides a built-in flow for opening a secure web view,
login credentials. This requires that the application using the SDK registers itself for a custom URL scheme of the
format `boxsdk-<>://boxsdkoauth2redirect`.
+
```swift
import BoxSDK
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md
index 0133e07fc..4fb13de17 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md
@@ -23,6 +23,7 @@ To retrieve a Collaboration record from the API, call
[`client.collaborations.get(collaborationId:fields:completion:)`][get-collaboration]
with the ID of the collaboration.
+
```swift
client.collaborations.get(collaborationId: "12345") { (result: Result) in
guard case let .success(collaboration) = result else {
@@ -52,7 +53,7 @@ client.collaborations.get(collaborationId: "12345") { (result: Result
```swift
client.collaborations.create(
itemType: "folder",
@@ -79,7 +81,7 @@ client.collaborations.create(
}
```
-[create-collaboration]: http://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC19create8itemType0G2Id4role12accessibleBy0klH011canViewPath6fields6notify10completionySS_SSAA0F4RoleOSSAA010AccessibleL0OSbSgSaySSGSgARys6ResultOyAA0F0CAA0A5ErrorOGctF
+[create-collaboration]: https://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6create8itemType0F2Id4role12accessibleBy0jkG011canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSAA010AccessibleK0OSbSgSaySSGSgARys6ResultOyAA0R0CAA0A8SDKErrorCGctF
Update Collaboration
--------------------
@@ -88,6 +90,7 @@ To update a collaboration record, call
[`client.users.update(collaborationId:role:status:canViewPath:fields:completion:)`][update-collaboration]
with the ID of the collaboration to update and the properties to update, including at least the `role`.
+
```swift
client.collaborations.update(collaborationId: "12345", role: .viewer) { (result: Result) in
guard case let .success(collaboration) = result else {
@@ -99,7 +102,7 @@ client.collaborations.update(collaborationId: "12345", role: .viewer) { (result:
}
```
-[update-collaboration]: http://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC19update15collaborationId4role6status11canViewPath6fields10completionySS_AA0F4RoleOAA0F6StatusOSgSbSgSaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[update-collaboration]: https://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6update15collaborationId4role6status11canViewPath6fields10completionySS_AA17CollaborationRoleOAA0O6StatusOSgSbSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF
Delete Collaboration
--------------------
@@ -108,6 +111,7 @@ To delete a collaboration, removing the collaborator's access to the relevant it
[`client.collaborations.delete(collaborationId:completion:)`][delete-collaboration]
with the ID of the collaboration to delete.
+
```swift
client.collaborations.delete(collaborationId: "12345") { (result: Result) in
guard case .success = result else {
@@ -119,7 +123,7 @@ client.collaborations.delete(collaborationId: "12345") { (result: Result
```swift
client.collaborations.listPendingForEnterprise() { results in
switch results {
@@ -148,4 +153,4 @@ client.collaborations.listPendingForEnterprise() { results in
}
```
-[get-pending-collaborations]: http://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC010listPendingForEnterpriseC06offset5limit6fieldsAA18PaginationIteratorCyAA13CollaborationCGSiSg_AMSaySSGSgtF
+[get-pending-collaborations]: https://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fields10completionySiSg_AISaySSGSgys6ResultOyAA14PagingIteratorCyAA13CollaborationCGAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/comments.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/comments.md
index a696d0719..5c916f9e2 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/comments.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/comments.md
@@ -21,6 +21,7 @@ To retrieve information about a comment, call
[`client.comments.get(commentId:fields:completion:)`][get-comment]
with the ID of the comment.
+
```swift
client.comments.get(commentId: "55555") { (result: Result) in
guard case let .success(comment) = result else {
@@ -32,7 +33,7 @@ client.comments.get(commentId: "55555") { (result: Result)
}
```
-[get-comment]: http://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC14get9commentId6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[get-comment]: https://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC3get9commentId6fields10completionySS_SaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF
Create Comment
--------------
@@ -41,6 +42,7 @@ To create a comment, call
[`client.comments.create(itemId:itemType:message:fields:completion:)`][create-comment]
with the type and ID of the item to add a comment to, as well as the comment message.
+
```swift
client.comments.create(
itemId: "11111",
@@ -56,7 +58,7 @@ client.comments.create(
}
```
-[create-comment]: http://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC13create6itemId0G4Type7message6fields10completionySS_S2SSaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[create-comment]: https://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6create6itemId0F4Type7message6fields10completionySS_S2SSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF
Update Comment
--------------
@@ -65,6 +67,7 @@ To update a comment, call
[`client.comments.update(commentId:message:fields:completion:)`][update-comment]
with the ID of the comment to update and the properties to update.
+
```swift
client.comments.update(
commentId: "55555",
@@ -79,7 +82,7 @@ client.comments.update(
}
```
-[update-comment]: http://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC17update9commentId7message6fields10completionySS_SSSaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[update-comment]: https://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6update9commentId7message6fields10completionySS_SSSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF
Delete Comment
--------------
@@ -87,6 +90,7 @@ Delete Comment
To delete a comment, call [`client.comments.delete(commentId:completion:)`][delete-comment]
with the ID of the comment to delete.
+
```swift
client.comments.delete(commentId: "55555") { (result: Result) in
guard case .success = result else {
@@ -98,4 +102,4 @@ client.comments.delete(commentId: "55555") { (result: Result)
}
```
-[delete-comment]: http://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC13delete9commentId10completionySS_ys6ResultOyytAA0A5ErrorOGctF
+[delete-comment]: https://opensource.box.com/box-ios-sdk/Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6delete9commentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/devicepins.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/devicepins.md
index d6503a839..a009e1a07 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/devicepins.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/devicepins.md
@@ -19,6 +19,7 @@ To retrieve information about a device pin, call
[`client.devicepins.get(devicePinId: String, fields: [String]?, completion: @escaping Callback)`][get-device-pin] with the ID
of the device pin. You can control which fields are returned on the resulting `Device Pin` object by passing the desired field names in the optional `fields` parameter.
+
```swift
client.devicePins.get(devicePinId: "11111", fields: ["product_name"]) { (result: Result) in
guard case let .success(devicePin) = result else {
@@ -30,13 +31,14 @@ client.devicePins.get(devicePinId: "11111", fields: ["product_name"]) { (result:
}
```
-[get-device-pin]: https://opensource.box.com/box-swift-sdk/Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC03getC7PinInfo06deviceG2Id6fields10completionySS_SaySSGSgys6ResultOyAA0cG0CAA0A5ErrorOGctF
+[get-device-pin]: https://opensource.box.com/box-ios-sdk/Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC3get11devicePinId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF
Get Device Pins for Enterprise
------------------------------
To retrieve information about the device pins active for the enterprise, call [`client.devicePins.listForEnterprise(enterpriseId: String, marker: String?, limit: Int?, direction: OrdeDirection?, fields: [String]?)`][get-device-pins] with the ID of the enterpise. This method will return an iterator object in the completion, which is used to retrieve device pins for the enterprise.
+
```swift
client.devicePins.listForEnterprise(enterpriseId: "12345", direction: .ascending) { results in
switch results {
@@ -57,7 +59,7 @@ client.devicePins.listForEnterprise(enterpriseId: "12345", direction: .ascending
}
```
-[get-device-pins]: https://opensource.box.com/box-swift-sdk/Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC013getEnterprisecD012enterpriseId6marker5limit9direction6fieldsAA18PaginationIteratorCyAA0C3PinCGSS_SSSgSiSgAA14OrderDirectionOSgSaySSGSgtF
+[get-device-pins]: https://opensource.box.com/box-ios-sdk/Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC17listForEnterprise12enterpriseId6marker5limit9direction6fields10completionySS_SSSgSiSgAA14OrderDirectionOSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0C3PinCGAA0A8SDKErrorCGctF
Delete Device Pin
@@ -65,6 +67,7 @@ Delete Device Pin
To delete a device pin, call [`client.devicePins.delete(devicePinId: String, completion: @escaping: Callback)`][delete-device-pin] with the ID of the device pin to delete.
+
```swift
client.devicePins.delete(devicePinId: "12345") { result: Result in
guard case .success = result else {
@@ -76,4 +79,4 @@ client.devicePins.delete(devicePinId: "12345") { result: Result
```swift
client.files.get(fileId: "11111", fields: ["name", "created_at"]) { (result: Result) in
guard case let .success(file) = result else {
@@ -50,7 +51,7 @@ client.files.get(fileId: "11111", fields: ["name", "created_at"]) { (result: Res
}
```
-[get-file]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11getFileInfo6fileId6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[get-file]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC3get6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF
Update File
-----------
@@ -59,6 +60,7 @@ To update a file record, call
[`client.files.updateFileInfo(fileId:name:description:parentId:sharedLink:tags:collections:lock:ifMatch:fields:completion:)`][update-file]
with the ID of the file to update and the properties to update.
+
```swift
client.files.update(fileId: "11111", name: "New file name.docx") { (result: Result) in
guard case let .success(file) = result else {
@@ -70,6 +72,7 @@ client.files.update(fileId: "11111", name: "New file name.docx") { (result: Resu
}
```
+[update-file]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6update6fileId4name11description06parentG010sharedLink4tags11collections4lock7ifMatch6fields10completionySS_SSSgA2pA17NullableParameterOyAA06SharedL4DataVGSgSaySSGSgAxRyAA04LockW0VGSgApXys6ResultOyAA4FileCAA0A8SDKErrorCGctF
Upload File
-----------
@@ -79,6 +82,7 @@ To upload a file from data in memory, call
with the data to be uploaded, the name of the file, and the ID of the folder into which the file should be uploaded.
Use ID `"0"` to upload a file into the root folder, "All Files".
+
```swift
let data = "test content".data(using: .utf8)
@@ -114,8 +118,8 @@ client.files.streamUpload(
}
```
-[upload-file]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10uploadFile4data4name8parentId8progress10completiony10Foundation4DataV_S2SySo10NSProgressCcys6ResultOyAA0F0CAA0A5ErrorOGctF
-[upload-file-stream]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16streamUploadFile0E08fileSize4name8parentId8progress10completionySo13NSInputStreamC_SiS2SySo10NSProgressCcys6ResultOyAA0G0CAA0A5ErrorOGctF
+[upload-file]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6upload4data4name8parentId8progress21performPreflightCheck10completiony10Foundation4DataV_S2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF
+[upload-file-stream]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12streamUpload0E08fileSize4name8parentId8progress21performPreflightCheck10completionySo13NSInputStreamC_SiS2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF
Upload New File Version
-----------------------
@@ -124,6 +128,7 @@ To upload a new version of an existing file, call
[`client.files.uploadVersion(forFile:name:contentModifiedAt:data:progress:completion:)`][upload-file-version]
with the ID of the file and the file contents to be uploaded.
+
```swift
let data = "updated file content".data(using: .utf8)
client.files.uploadVersion(
@@ -141,7 +146,7 @@ client.files.uploadVersion(
}
```
-[upload-file-version]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC17uploadFileVersion03forF04name17contentModifiedAt4data8progress10completionySS_S2S10Foundation4DataVySo10NSProgressCcys6ResultOyAA0F0CAA0A5ErrorOGctF
+[upload-file-version]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13uploadVersion7forFile4name17contentModifiedAt4data8progress21performPreflightCheck10completionySS_SSSgAL10Foundation4DataVySo10NSProgressCcSbys6ResultOyAA0H0CAA0A8SDKErrorCGctF
Download File
-------------
@@ -150,6 +155,7 @@ To download a file to the device, call
[`client.files.download(fileId:version:destinationURL:progress:completion:)`][download-file]
with the ID of the file to download and a URL to the location where the file should be downloaded to.
+
```swift
let url = FileManager.default.homeDirectoryForCurrentUser
@@ -163,7 +169,7 @@ client.files.download(fileId: "11111", destinationURL: url) { (result: Result
```swift
client.files.copy(fileId: "11111", parentId: "0") { (result: Result) in
guard case let .success(copiedFile) = result else {
@@ -186,7 +193,7 @@ client.files.copy(fileId: "11111", parentId: "0") { (result: Result
```swift
client.files.lock(fileId: "11111") { (result: Result) in
guard case let .success(file) = result else {
@@ -207,13 +215,14 @@ client.files.lock(fileId: "11111") { (result: Result) in
}
```
-[lock-file]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC8lockFile6fileId9expiresAt19isDownloadPrevented6fields10completionySS_SSSgSbSgSaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[lock-file]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4lock6fileId9expiresAt19isDownloadPrevented6fields10completionySS_10Foundation4DateVSgSbSgSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF
Unlock File
-----------
To unlock a file, call [`client.files.unlock(fileId:fields:completion:)][unlock-file] with the ID of the file.
+
```swift
client.files.unlock(fileId: "11111") { (result: Result) in
guard case let .success(file) = result else {
@@ -225,7 +234,7 @@ client.files.unlock(fileId: "11111") { (result: Result) in
}
```
-[unlock-file]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10unlockFile6fileId9expiresAt19isDownloadPrevented6fields10completionySS_SSSgSbSgSaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[unlock-file]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6unlock6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF
Get File Thumbnail Image
------------------------
@@ -235,6 +244,7 @@ To retrieve the thumbnail image for a file, call
with the ID of the file and the desired image format extension. Optionally, constraints on the image
dimensions can be specified in the `minHeight`, `minWidth`, `maxHeight`, and `maxWidth` parameters.
+
```swift
client.files.getThumbnail(forFile: "11111", extension: .png) { (result: Result) in
guard case let .success(thumbnailData) = result else {
@@ -246,7 +256,7 @@ client.files.getThumbnail(forFile: "11111", extension: .png) { (result: Result` to display a fil
[`client.files.getEmbedLink(forFile:completion:)`][get-embed-link]
with the ID of the file.
+
```swift
client.files.getEmbedLink(forFile: "11111") { (result: Result) in
guard case let .success(embedLink) = result else {
@@ -266,7 +277,7 @@ client.files.getEmbedLink(forFile: "11111") { (result: Result
```swift
client.files.listCollaborations(forFile: "11111") { result in
switch results {
@@ -295,7 +307,7 @@ client.files.listCollaborations(forFile: "11111") { result in
}
```
-[get-collaborations]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC21getFileCollaborations03forF06marker5limit6fieldsAA18PaginationIteratorCyAA13CollaborationCGSS_SSSgSiSgSaySSGSgtF
+[get-collaborations]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC18listCollaborations7forFile6marker5limit6fields10completionySS_SSSgSiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA13CollaborationCGAA0A8SDKErrorCGctF
Get File Comments
-----------------
@@ -305,6 +317,7 @@ To retrieve a list of comments on the file, call
with the ID of the file. This method returns an iterator in the completion, which is used to page through the collection
of file comments.
+
```swift
client.files.listComments(forFile: "11111"){ results in
switch results {
@@ -325,7 +338,7 @@ client.files.listComments(forFile: "11111"){ results in
}
```
-[get-comments]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15getFileComments03forF06offset5limit6fieldsAA18PaginationIteratorCyAA7CommentCGSS_SiSgANSaySSGSgtF
+[get-comments]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listComments7forFile6offset5limit6fields10completionySS_SiSgAJSaySSGSgys6ResultOyAA14PagingIteratorCyAA7CommentCGAA0A8SDKErrorCGctF
Get File Tasks
--------------
@@ -333,6 +346,7 @@ Get File Tasks
To retrieve a list of file tasks, call [`client.files.listTasks(forFile:fields:)`][get-tasks] with the ID of the
file. This method returns an iterator in the completion, which is used to retrieve file comments.
+
```swift
client.files.listTasks(forFile: "11111") { results in
switch results {
@@ -353,7 +367,7 @@ client.files.listTasks(forFile: "11111") { results in
}
```
-[get-tasks]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getFileTasks03forF06fieldsAA18PaginationIteratorCyAA4TaskCGSS_SaySSGSgtF
+[get-tasks]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC9listTasks7forFile6fields10completionySS_SaySSGSgys6ResultOyAA14PagingIteratorCyAA4TaskCGAA0A8SDKErrorCGctF
Add File to Favorites
---------------------
@@ -362,6 +376,7 @@ To add a file to the user's favorites collection, call
[`client.files.addToFavorites(fileId:completion:)`][add-to-favorites]
with the ID of the file.
+
```swift
client.files.addToFavorites(fileId: "11111") { (result: Result) in
guard case .success = result else {
@@ -373,7 +388,7 @@ client.files.addToFavorites(fileId: "11111") { (result: Result
```swift
client.files.removeFromFavorites(fileId: "11111") { (result: Result) in
guard case .success = result else {
@@ -393,7 +409,7 @@ client.files.removeFromFavorites(fileId: "11111") { (result: Result
```swift
client.files.getSharedLink(forFile: "11111") { (result: Result) in
guard case let .success(sharedLink) = result else {
@@ -413,7 +430,7 @@ client.files.getSharedLink(forFile: "11111") { (result: Result
```swift
client.files.setSharedLink(forFile: "11111", access: .open) { (result: Result) in
guard case let .success(sharedLink) = result else {
@@ -433,7 +451,7 @@ client.files.setSharedLink(forFile: "11111", access: .open) { (result: Result
```swift
client.files.deleteSharedLink(fileId: "11111") { (result: Result) in
guard case .success = result else {
@@ -453,22 +472,23 @@ client.files.deleteSharedLink(fileId: "11111") { (result: Result
```swift
// Get full information about PDF representation
-client.files.getRepresentations(
+client.files.listRepresentations(
fileId: "11111",
- xRepHints: "[pdf]"
+ representationHint: "[pdf]"
) { (result: Result<[FileRepresentation], BoxSDKError>) in
guard case let .success(representations) = result else {
print("Error fetching representations")
@@ -479,4 +499,4 @@ client.files.getRepresentations(
}
```
-[get-representations]: http://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC18getRepresentations6fileId9xRepHints10completionySS_SSSgys6ResultOySayAA4FileC14RepresentationVGAA0A5ErrorOGctF
+[get-representations]: https://opensource.box.com/box-ios-sdk/Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19listRepresentations6fileId18representationHint10completionySS_AA018FileRepresentationJ0OSgys6ResultOySayAA0lM0VGAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/folders.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/folders.md
index da310d27f..913b6aa54 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/folders.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/folders.md
@@ -30,6 +30,7 @@ To retrieve information about a folder, call
with the ID of the folder. You can control which fields are returned in the resulting `Folder` object by passing the
`fields` parameter.
+
```swift
client.folders.get(
folderId: "22222",
@@ -44,7 +45,7 @@ client.folders.get(
}
```
-[get-folder]: http://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13getFolderInfo8folderId6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[get-folder]: https://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC3get8folderId6fields10completionySS_SaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF
Get Folder Items
----------------
@@ -53,6 +54,7 @@ To retrieve information about the items contained in a folder, call
[`client.folders.listItems(folderId:usemarker:marker:offset:limit:sort:direction:fields:)`][get-folder-items]
with the ID of the folder. This method will return an iterator in the completion, which is used to retrieve folder items.
+
```swift
let folderItems = client.folders.listItems(folderId: "22222", sort: .name, direction: .ascending) { results in
switch results {
@@ -80,7 +82,7 @@ let folderItems = client.folders.listItems(folderId: "22222", sort: .name, direc
}
```
-[get-folder-items]: http://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14getFolderItems8folderId9usemarker6marker6offset5limit4sort9direction6fieldsAA18PaginationIteratorCyAA0F4ItemCGSS_SbSgSSSgSiSgAtA7OrderByOSgAA0T9DirectionOSgSaySSGSgtF
+[get-folder-items]: https://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listItems8folderId9usemarker6marker6offset5limit4sort9direction6fields10completionySS_SbSgSSSgSiSgApA06FolderF7OrderByOSgAA0R9DirectionOSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0Q4ItemOGAA0A8SDKErrorCGctF
Create Folder
-------------
@@ -90,6 +92,7 @@ To create a new folder, call
with a name for the new folder and the ID of the folder to create the new folder in. To create a new folder inside the
root folder ("All Files"), use ID `"0"`.
+
```swift
client.folders.create(name: "New Folder", parentId: "22222") { (result: Result) in
guard case let .success(folder) = result else {
@@ -101,7 +104,7 @@ client.folders.create(name: "New Folder", parentId: "22222") { (result: Result
```swift
client.folders.delete(folderId: "22222", recursive: true) { result: Result} in
guard case .success = result else {
@@ -123,7 +127,7 @@ client.folders.delete(folderId: "22222", recursive: true) { result: Result
```swift
client.folders.copy(
folderId: "22222",
@@ -148,7 +153,7 @@ client.folders.copy(
}
```
-[copy-folder]: http://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10copyFolder8folderId011destinationF2ID4name6fields10completionySS_S2SSgSaySSGSgys6ResultOyAA0F0CAA0A5ErrorOGctF
+[copy-folder]: https://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC4copy8folderId19destinationFolderID4name6fields10completionySS_S2SSgSaySSGSgys6ResultOyAA0I0CAA0A8SDKErrorCGctF
Get Folder Collaborations
-------------------------
@@ -157,6 +162,7 @@ To retrieve a list of the collaborations on a folder, call
[`client.folders.listCollaborations(folderId:fields:)`][get-collaborations]
with the ID of the folder.
+
```swift
client.folders.listCollaborations(folderId: "22222") { results in
switch results {
@@ -177,7 +183,7 @@ client.folders.listCollaborations(folderId: "22222") { results in
}
```
-[get-collaborations]: http://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC23getFolderCollaborations8folderId6fieldsAA18PaginationIteratorCyAA13CollaborationCGSS_SaySSGSgtF
+[get-collaborations]: https://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC18listCollaborations8folderId6fields10completionySS_SaySSGSgys6ResultOyAA14PagingIteratorCyAA13CollaborationCGAA0A8SDKErrorCGctF
Add Folder to Favorites
-----------------------
@@ -186,6 +192,7 @@ To add a folder to the user's favorites, call
[`client.folders.addToFavorites(folderId:completion:)`][add-to-favorites]
with the ID of the folder.
+
```swift
client.folders.addToFavorites(folderId: "22222") { (result: Result) in
guard case .success = result else {
@@ -197,7 +204,7 @@ client.folders.addToFavorites(folderId: "22222") { (result: Result
```swift
client.folders.getSharedLink(forFolder: "11111") { (result: Result) in
guard case let .success(sharedLink) = result else {
@@ -226,7 +234,7 @@ client.folders.getSharedLink(forFolder: "11111") { (result: Result
```swift
client.folders.setSharedLink(forFolder: "11111", access: .open) { (result: Result) in
guard case let .success(sharedLink) = result else {
@@ -246,7 +255,7 @@ client.folders.setSharedLink(forFolder: "11111", access: .open) { (result: Resul
}
```
-[set-shared-link]: http://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13setSharedLink9forFolder6access10unsharedAt8password11canDownload10completionySS_AA0fG6AccessOSg10Foundation4DateVSgAA17OptionalParameterOySSGSgSbSgys6ResultOyAA0fG0CAA0A5ErrorOGctF
+[set-shared-link]: https://opensource.box.com/box-ios-sdk/Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13setSharedLink9forFolder6access10unsharedAt8password11canDownload10completionySS_AA0fG6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF
Remove Shared Link
------------------
@@ -255,6 +264,7 @@ To remove a file's shared link, call
[`client.folders.deleteSharedLink(forFolder:completion:)`][delete-shared-link]
with the ID of the folder.
+
```swift
client.folders.deleteSharedLink(forFolder: "11111") { (result: Result) in
guard case .success = result else {
@@ -266,4 +276,4 @@ client.folders.deleteSharedLink(forFolder: "11111") { (result: Result
-
-
-
-Requirements
-------------------
-
-- iOS 11.0+ / Mac OS X 10.13+ / tvOS 11.0+ / watchOS 4.0+
-- Xcode 10.0+
-
-Installing the SDK
-------------------
-
-### Carthage
-
-__Step 1__: Add to your `Cartfile`
-
-```
-git "https://github.com/box/box-ios-sdk.git" ~> 3.0
-```
-
-__Step 2__: Update dependencies
-
-```shell
-$ carthage update --platform iOS
-```
-
-__Step 3__: Drag the built framework from Carthage/Build/iOS into your project.
-
-For more detailed instructions, please see the [official documentation for Carthage](https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos).
-
-### CocoaPods
-
-__Step 1__: Add to your `Podfile`
-
-```
-pod 'BoxSDK', '~> 3.0'
-```
-
-__Step 2__: Install pod by running the following command in the directory with the `Podfile`
-
-```
-$ pod install
-```
-
-For more detailed instructions, please see the [official document for Cocoapods](https://guides.cocoapods.org/using/using-cocoapods.html).
-
-### Swift Package Manager
-
-#### Importing BoxSDK into Project
-
-__Step 1__: Click on Xcode project file
-
-__Step 2__: Click on Swift Packages and click on the plus to add a package
-
-__Step 3__: Enter the following repository url `https://github.com/box/box-ios-sdk.git` and click next
-
-__Step 4__: Leave the default settings to get the most recent release and click next to finish importing
-
-The process should look like below:
-
-![Import Package](import-sdk-spm.gif)
-
-
-
-#### Adding BoxSDK as a Dependency
-
-For detailed instructions, please see the [official document for SPM](https://swift.org/package-manager/).
-
-Getting Started
----------------
-
-To get started with the SDK, get a Developer Token from the Configuration page of your app in the
-[Box Developer Console][dev-console]. You can use this token to make test calls for your own Box account.
-
-```swift
-import BoxSDK
-
-let client = BoxSDK.getClient(token: "YOUR_DEVELOPER_TOKEN")
-client.users.getCurrentUser() { result in
- switch result {
- case let .error(error):
- print("Error: \(error)")
- case let .success(user):
- print("\(user.name) (\(user.login)) is logged in")
- }
-}
-```
-
-[dev-console]: https://app.box.com/developers/console
-
-Sample Apps
------------
-
-### OAuth2 Sample App
-
-A sample app using OAuth2 Authentication can be found in the repository [here][oauth2-sample-app]. This app demonstrates
-how to use the SDK to make calls, and can be run directly by entering your own credentials to log in.
-
-[oauth2-sample-app]:
-https://github.com/box/box-ios-sdk/tree/limited-beta-release/SampleApps/OAuth2SampleApp
-
-To execute the sample app:
-__Step 1__: Run carthage
-
-```shell
-$ cd SampleApps/OAuth2SampleApp
-$ carthage update --platform iOS
-```
-
-__Step 2__: Open Xcode Project File
-
-```shell
-$ open OAuth2SampleApp.xcodeproj
-```
-
-__Step 3__: Insert your client ID and client secret
-
-First, find your OAuth2 app's client ID and secret from the [Box Developer Console][dev-console]. Then, add these
-values to the sample app in the `Constants.swift` file in the sample app:
-
-```swift
-static let clientId = "YOUR CLIENT ID GOES HERE"
-static let clientSecret = "YOUR CLIENT SECRET GOES HERE"
-```
-
-__Step 4__: Set redirect URL
-
-Using the same client ID from the previous step, set the redirect URL for your application in the
-[Box Developer Console][dev-console] to `boxsdk-<>://boxsdkoauth2redirect`, where `<>`
-is replaced with your client ID. For example, if your client ID were `vvxff7v61xi7gqveejo8jh9d2z9xhox5` the redirect
-URL should be `boxsdk-vvxff7v61xi7gqveejo8jh9d2z9xhox5://boxsdkoauth2redirect`
-
-__Step 5__: Insert your client ID to receive the redirect in the app
-
-Open the `Info.plist` file in the sample app and find the key under `URL Types --> Item 0 --> URL Schemes --> Item 0`.
-Using the same client ID from the previous step, set the value for Item 0 to
-`boxsdk-<>`, where `<>` is replaced with your client ID. For example, if your client
-ID were `vvxff7v61xi7gqveejo8jh9d2z9xhox5` the redirect URL should be
-`boxsdk-vvxff7v61xi7gqveejo8jh9d2z9xhox5`
-
-![location to add redirect URL scheme in Xcode](redirect-url-scheme.png)
-
-__Step 6__: Run the sample app
-
-### JWT Auth Sample App
-
-A sample app using JWT Authentication can be found in the repository [here][jwt-sample-app]. This app demonstrates how to
-set up JWT authentication with a remote authorization service, and will not run until you provide the code to retrieve
-tokens.
-
-[jwt-sample-app]: https://github.com/box/box-ios-sdk/tree/limited-beta-release/SampleApps/JWTSampleApp
-
-To execute the sample app:
-__Step 1__: Run carthage
-
-```shell
-$ cd SampleApps/JWTSampleApp
-$ carthage update --platform iOS
-```
-
-__Step 2__: Open Xcode Project File
-
-```shell
-$ open JWTSampleApp.xcodeproj
-```
-
-__Step 3__: Insert your client ID and client secret
-
-First, find your OAuth2 app's client ID and secret from the [Box Developer Console][dev-console]. Then, add these
-values to the sample app in the `Constants.swift` file in the sample app:
-
-```swift
-static let clientId = "YOUR CLIENT ID GOES HERE"
-static let clientSecret = "YOUR CLIENT SECRET GOES HERE"
-```
-
-__Step 4__: Add code for retrieving access tokens
-
-In the `ViewController.swift` file in the sample app, edit the
-`obtainJWTTokenFromExternalSources()` method:
-
-```swift
-func obtainJWTTokenFromExternalSources() -> DelegatedAuthClosure {
- return { uniqueID, completion in
- #error("Obtain a JWT Token from your own service or a Developer Token for your app in the Box Developer Console at https://app.box.com/developers/console and return it in the completion.")
- // The code below is an example implementation of the delegate function
- // Please provide your own implementation
-
- // ...
- }
-}
-```
-
-__Step 5__: Run the sample app
-
-
-## Release Definitions
-
-Starting Oct 19th, 2019 the Box Swift SDK for iOS will be available for general use. This implies all Box developers will be able to use the SDK to build native iOS applications on Box. Between now and the next couple of months, we will be making frequent updates to the SDK based on feedback from our customers, and this document aims to set expectations with respect to:
-
-1. the various release types you will see over the next few months, what they mean and how to identify them
-1. support policy for each of the release types
-
-Between now and the next couple of months, the Box Swift SDK for iOS releases will be one of the following types:
-
-- [Release Candidate (RC)](#release-candidate-rc)
-- [Current Release](#current-release)
-- [Long Term Support](#long-term-support)
-
-### Release Candidate (RC)
-
-The initial releases of the SDK starting Oct 19th will be Release Candidate (RC). This means (1) the core functionality is present and tested, (2) additional functionality from this point on will be considered improvements or enhancements based on customer feedback. RC releases are usually more frequent (every few weeks), followed shortly by a current release. If you plan to use an RC release, we recommend:
-
-- that you don't use it for production workloads (If that is unavoidable, we recommend upgrading to the Current Release version once it's ready.)
-- that you create a plan to keep your application on the latest RC release version at all times (since older RC releases are considered "out of support" as soon as a new RC release is released)
-
-Also, RC releases may carry breaking changes from the previous release and we advise developers to test their application adequately with the new RC release before adopting it.
-
-The idea behind releasing RC releases is to rapidly iterate on the SDK (bug fixes, feature tweaks, etc.) to get it to a production-ready state, and typically we don't expect to have the SDK in the RC phase for more than a month.
-
-> #### Support for RC releases
->
-> A RC release
->
-> - is Considered [Active](#active) when released
-> - transitions to [End-of-life](#end-of-life) when the next release becomes Active
-
-
-### Current Release
-
-A Current Release is considered more stable that a Release Candidate Release and for that reason we expect less frequent releases of a Current Release. We typically expect to refresh Current Releases approximately every 3 months (could be shorter or longer depending on the criticality of the contents of the release).
-
-A new Current Release will usually carry new functionality, bug fixes and may contain breaking changes. We will call out all breaking changes (if any) in the Release Notes section of every Current Release, and we advise developers to test their application adequately before adopting in for production use.
-
-A Current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Current releases are not intended for long-term use, and will only receive enough support after the next release becomes available to allow for a smooth transition to the new version.
-
-
-> #### Support for Current Release
->
-> A Current Release
->
-> - is Considered [Active](#active) when released
-> - transitions to [Maintenance](#maintenance) 3 months after it becomes Active, or when the next release becomes Active, whichever is later
-> - reaches [End-of-life](#end-of-life) 6 months after it becomes Active, or 3 months after the next release becomes Active, whichever is later
-
-
-### Long Term Support
-
-A Long-Term Support (LTS) release is one which we plan to guarantee compatibility with for an extended period of time. The public interfaces of the SDK should not be changed in ways that would break customers’ application, and the release should continue to receive at least bug fixes for its entire lifecycle. We expect to refresh Long Term Release version every 18 - 24 months.
-
-For the above reasons, we recommend all developers who do not intend to make frequent updates (~every 6 - 12 months) to their application, only use a Long Term Release version of the SDK.
-
-> #### Support for Long Term Release
->
-> A Long Term Release
->
-> - is considered [Active](#active) when released
-> - transitions to [Maintenance](#maintenance) 1 year after it becomes Active, or when the next release becomes Active, whichever is later
-> - reaches [End-of-life](#end-of-life) 2 years after it becomes Active, or 1 year after the next LTS release becomes Active, whichever is later
-
-
-### Support Phases
-
-#### Active
-
-Once a release is considered ready for release, a new version is cut and the release enters the Active phase. However, new features may be added to the SDK, including support for new API endpoints.
-
-#### Maintenance
-
-After a time, the release is no longer under active development, but customers may still be depending on it. At this time, we consider the release to be in Maintenance phase; generally, only bug fixes will be considered for inclusion in new versions. We may of course opt to include new functionality based on customer demand, but in general customers should expect that the SDK feature set will be mostly frozen for the remainder of its lifecycle.
-
-#### End-of-life
-
-After a release is no longer being supported by Box, it enters End-of-life (EOL) and no further changes should be expected by customers. Customers must upgrade to a newer release if they want to receive support.
-
-
-Copyright and License
--------
-
-Copyright 2019 Box, Inc. All rights reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/groups.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/groups.md
index fd4533da5..85c5d4ac4 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/groups.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/groups.md
@@ -28,6 +28,7 @@ Create Group
To create a new group, call [`client.groups.create(name: String, provenance: String?, externalSyncIdentifier: String?, description: String?, invitabilityLevel: GroupInvitabilityLevel?, memberViewabilityLevel: GroupMemberViewabilityLevel, fields: [String]?, completion: @escaping Callback)`][create_group] with the name of the group you wish to create. You can control which fields are returned in the resulting `Group` object by passing the `fields` parameter.
+
```swift
client.groups.create(name: "Team A", provenance: "Test", externalSyncIdentifier: "Test Sync", description: "Test Description", invitabilityLevel: .allManagedUsers, memberViewabilityLevel: .allManagedUsers) { (result: Result) in
guard case let .success(group) = result else {
@@ -39,7 +40,7 @@ To create a new group, call [`client.groups.create(name: String, provenance: Str
}
```
-[create-group]:
+[create-group]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6create4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityM06fields10completionySS_SSSgA2mA017GroupInvitabilityM0OSgAA0r6MemberoM0OSgSaySSGSgys6ResultOyAA0R0CAA0A8SDKErrorCGctF
Update Group
------------
@@ -47,6 +48,7 @@ Update Group
To update an existing group, call [`client.groups.update(groupId: String, name: String?, provenance: NullableParameter?, externalSyncIdentifier: NullableParameter?, description: NullableParameter?, invitabilityLevel: GroupInvitabilityLevel?, memberViewabilityLevel: GroupMemberViewabilityLevel?, fields: [String]?, completion: @escaping Callback)`][update-group] with the ID of the group. You can control which fields are returned in the resulting `Group` object by passing the
`fields` parameter.
+
```swift
client.groups.update(groupId: "11111", name: "Team A", provenance: .value("Test"), externalSyncIdentifier: .value("Test Sync"), description: .value("Test Description"), invitabilityLevel: .allManagedUsers, memberViewabilityLevel: .allManagedUsers) {
(result: Result) in
@@ -60,13 +62,14 @@ client.groups.update(groupId: "11111", name: "Team A", provenance: .value("Test"
}
```
-[update-group]
+[update-group]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6update7groupId4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityO06fields10completionySS_SSSgAA17NullableParameterOySSGSgA2rA017GroupInvitabilityO0OSgAA0v6MemberqO0OSgSaySSGSgys6ResultOyAA0V0CAA0A8SDKErrorCGctF
Get Group Info
--------------
To retrieve information about a group, call [`client.groups.get(groupId: String, fields: [String]?, completion: @escaping Callback)`][get-group] with the ID of the group. You can control which fields are returned in the resulting `Group` object by passing the `fields` parameter.
+
```swift
client.groups.get(groupId: "12345") {
(result: Result) in
@@ -79,13 +82,14 @@ client.groups.get(groupId: "12345") {
}
```
-[get-group]
+[get-group]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC3get7groupId6fields10completionySS_SaySSGSgys6ResultOyAA5GroupCAA0A8SDKErrorCGctF
Get Enterprise Groups
---------------------
To retrieve information about the groups within the enterprise, call [`client.groups.listForEnterprise(name: String?, offset: Int?, limit: Int?, fields: [String]?)`][get-enterprise-groups]. You can also pass in a `name` paramter to act as a filter. This method will return an iterator object in the completion, which is used to retrieve groups in the enterprise.
+
```swift
client.groups.listForEnterprise() { results in
switch results {
@@ -106,13 +110,14 @@ client.groups.listForEnterprise() { results in
}
```
-[get-enterprise-groups]
+[get-enterprise-groups]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17listForEnterprise4name6offset5limit6fields10completionySSSg_SiSgAKSaySSGSgys6ResultOyAA14PagingIteratorCyAA5GroupCGAA0A8SDKErrorCGctF
Delete Group
------------
To delete a group, call [`client.groups.delete(groupId: String, completion: @escaping Callback)`][delete-group] with the ID of the group to delete.
+
```swift
client.groups.delete(groupId: "12345") {
(result: Result) in
@@ -125,7 +130,7 @@ client.groups.delete(groupId: "12345") {
}
```
-[delete-group]
+[delete-group]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6delete7groupId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
Group Membership
================
@@ -135,6 +140,7 @@ Get Group Membership Info
To retrieve information about a specified group membership, call [`client.groups.getMembershipInfo(membershipId: String, fields: [String]?, completion: @escaping Callback)`][get-membership-info] with the ID of the group membership. You can control which fields are returned on the resulting `Group Membership` object by passing the desired field names in the optional `fields` parameter.
+
```swift
client.groups.getMembershipInfo(membershipId: "12345") {
(result: Result) in
@@ -147,11 +153,14 @@ client.groups.getMembershipInfo(membershipId: "12345") {
}
```
+[get-membership-info]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17getMembershipInfo12membershipId6fields10completionySS_SaySSGSgys6ResultOyAA05GroupF0CAA0A8SDKErrorCGctF
+
Create Group Membership
-----------------------
To create a new group membership, call [`client.groups.createMembership(userId: String, groupId: String, role: GroupRole?, configurablePermission: NullableParameter?, fields: [String]?, completion: @escaping Callback)`][create-membership]. You can control which fields are returned on the resulting `Group Membership` object by passing the desired field names in the optional `fields` parameter.
+
```swift
client.createMembership(userId: "54321", groupId: "11111", role: .admin, configurablePermission: .value(ConfigurablePermissionData(canRunReports: true, canInstantLogin: true, canCreateAccounts: false, canEditAccounts: true))) {
(result: Result) in
@@ -164,13 +173,14 @@ client.createMembership(userId: "54321", groupId: "11111", role: .admin, configu
}
```
-[create-membership]:
+[create-membership]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16createMembership6userId05groupH04role22configurablePermission6fields10completionySS_SSAA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableL4DataVGSgSaySSGSgys6ResultOyAA0oF0CAA0A8SDKErrorCGctF
Update Group Membership
-----------------------
To update an existing group membership, call [`client.groups.updateMembership(membershipId: String, role: GroupRole?, configurablePermission: NullableParameter?, fields: [String]?, completion: @escaping Callback)`][update-membership] with the ID of the group membership to update.
+
```swift
client.groups.updateMembership(membershipId: "12345", role: .admin, configurablePermission: .value(ConfigurablePermissionData(canRunReports: true, canInstantLogin: true, canCreateAccounts: false, canEditAccounts: true))) {
(result: Result) in
@@ -183,13 +193,14 @@ client.groups.updateMembership(membershipId: "12345", role: .admin, configurable
}
```
-[update-membership]:
+[update-membership]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16updateMembership12membershipId4role22configurablePermission6fields10completionySS_AA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableK4DataVGSgSaySSGSgys6ResultOyAA0nF0CAA0A8SDKErrorCGctF
Delete Group Membership
-----------------------
To delete a group membership, call [`client.groups.deleteMembership(membershipId: String, completion: @escaping: Callback)`][delete-membership] with the ID of the group membership to delete.
+
```swift
client.groups.deleteMembership(membershipId: "12345") {
(result: Result) in
@@ -202,13 +213,14 @@ client.groups.deleteMembership(membershipId: "12345") {
}
```
-[delete-membership]:
+[delete-membership]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16deleteMembership12membershipId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
Get Memberships for Group
-------------------------
To retrieve information about the memberships in a group, call [`client.groups.listMemberships(groupID: String, offset: Int?, limit: Int?, fields: [String]?)`][get-memberships-for-group] with the ID of the group to retrieve group memberships for. This method will return an iterator object in the completion, which is used to retrieve the memberships.
+
```swift
client.groups.listMembership(groupId: "12345") {
switch results {
@@ -229,7 +241,7 @@ client.groups.listMembership(groupId: "12345") {
}
```
-[get-memberships-for-group]:
+[get-memberships-for-group]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC15listMemberships7groupId6offset5limit6fields10completionySS_SiSgAJSaySSGSgys6ResultOyAA14PagingIteratorCyAA15GroupMembershipCGAA0A8SDKErrorCGctF
Get Memberships for User
------------------------
@@ -237,6 +249,7 @@ Get Memberships for User
To retrieve information about the group memberships for a given user, call
[`client.groups.listMembershipsForUser(userId: String, offset: Int?, limit: Int?, fields: [String]?)`][get-memberships-for-user] with the ID of the user to retreive group memberships for. This method will return an iterator object in the completion, which is used to retrieve the memberships.
+
```swift
client.groups.listMembershipsForUser(userId: "12345") {
switch results {
@@ -257,13 +270,14 @@ client.groups.listMembershipsForUser(userId: "12345") {
}
```
-[get-memberships-for-user]:
+[get-memberships-for-user]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC22listMembershipsForUser6userId6offset5limit6fields10completionySS_SiSgAJSaySSGSgys6ResultOyAA14PagingIteratorCyAA15GroupMembershipCGAA0A8SDKErrorCGctF
Get Collaborations for Group
----------------------------
To retrieve all group collaborations for a given group, call [`client.groups.listCollaborations(groupId: String, offset: Int?, limit: Int? fields: [String]?)`][get-collaborations-for-group] with the ID of the group to retrieve collaborations for. This method will return an iterator object in the completion, which is used to retrieve the collaborations.
+
```swift
client.groups.listCollaborations(groupId: "12345") { results in
switch results {
@@ -284,4 +298,4 @@ client.groups.listCollaborations(groupId: "12345") { results in
}
```
-[get-collaborations-for-group]:
+[get-collaborations-for-group]: https://opensource.box.com/box-ios-sdk/Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC18listCollaborations7groupId6offset5limit6fields10completionySS_SiSgAJSaySSGSgys6ResultOyAA14PagingIteratorCyAA13CollaborationCGAA0A8SDKErrorCGctF
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/legal-holds.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/legal-holds.md
index 99fa00130..a824b43a5 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/legal-holds.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/legal-holds.md
@@ -26,6 +26,7 @@ To retrieve information about a legal hold policy, call
with the ID of the policy. You can control which fields are returned in the resulting `Legal Hold Policy` object by passing the
`fields` parameter.
+
```swift
client.legalHolds.get(policyId: "22222", fields: ["name", "created_at"]) { (result: Result) in
guard case let .success(policy) = result else {
@@ -36,6 +37,8 @@ client.legalHolds.get(policyId: "22222", fields: ["name", "created_at"]) { (resu
}
```
+[get-legal-hold-policy-info]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC3get8policyId6fields10completionySS_SaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF
+
Get Legal Hold Policies
----------------
@@ -43,6 +46,7 @@ To retrieve information about the items contained in a folder, call
[`client.legalHolds.listForEnterprise(policyName: String, marker: String?, limit: Int?, fields: [String]?)`][get-legal-hold-policies]
with the ID of the policy. This method will return an iterator object in the completion, which is used to retrieve policies in the enterprise.
+
```swift
client.legalHolds.listForEnterprise(policyName: "policy1") { results in
switch results {
@@ -63,6 +67,8 @@ client.legalHolds.listForEnterprise(policyName: "policy1") { results in
}
```
+[get-legal-hold-policies]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC17listForEnterprise10policyName6marker5limit6fields10completionySSSg_AJSiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0C10HoldPolicyCGAA0A8SDKErrorCGctF
+
Create Legal Hold Policy
-------------
@@ -70,6 +76,7 @@ To create a new legal hold policy, call
[`client.legalHolds.create(policyName: String, description: String? filterStartedAt: Date?, filterEndedAt: Date?, isOngoing: Bool?, fields: [String]?, completion: @escaping Callback`][create-legal-hold-policy]
with a name for the legal hold policy.
+
```swift
client.legalHolds.create(name: "New Folder") { (result: Result) in
guard case let .success(policy) = result else {
@@ -80,12 +87,15 @@ client.legalHolds.create(name: "New Folder") { (result: Result`][update-legal-hold-policy].
+
```swift
client.legalHolds.update(policyId: "1234", policyName: "New Name") { (result: Result) in
guard case let .success(policy) = result else {
@@ -96,6 +106,8 @@ client.legalHolds.update(policyId: "1234", policyName: "New Name") { (result: Re
}
```
+[update-legal-hold-policy]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6update8policyId0G4Name11description12releaseNotes6fields10completionySS_SSSgA2KSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF
+
Delete Legal Hold Policy
-------------
@@ -103,6 +115,7 @@ To delete a legal hold policy, call
[`client.folders.delete(policyId: String, completion: @escaping Callback`][delete-legal-hold-policy]
with the ID of the legal hold policy to delete.
+
```swift
client.legalHolds.delete() { result: Result} in
guard case .success = result else {
@@ -113,6 +126,8 @@ client.legalHolds.delete() { result: Result} in
}
```
+[delete-legal-hold-policy]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6delete8policyId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
+
Get Policy Assignment Info
---------------
@@ -121,6 +136,7 @@ To retrieve information about a legal hold policy assignment, call
with the ID of the policy assignment. You can control which fields are returned in the resulting `Legal Hold Policy Assignment` object by passing the
`fields` parameter.
+
```swift
client.legalHolds.getPolicyAssignment(assignmentId: "22222", fields: ["assigned_at"]) { (result: Result) in
guard case let .success(assignment) = result else {
@@ -131,6 +147,8 @@ client.legalHolds.getPolicyAssignment(assignmentId: "22222", fields: ["assigned_
}
```
+[get-policy-assignment-info]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC19getPolicyAssignment12assignmentId6fields10completionySS_SaySSGSgys6ResultOyAA0c4HoldgH0CAA0A8SDKErrorCGctF
+
Get Policy Assignments
----------------
@@ -138,6 +156,7 @@ To retrieve legal hold policy assignments, call
[`client.legalHolds.listPolicyAssignments(policyId: String, assignToType: String?, assignToId: String?, marker: String?, limit: String?, fields: [String]?)`][get-policy-assignments]
with the ID of a policy. This method will return an iterator object in the completion, which is used to retrieve policy assignments for a policy.
+
```swift
client.legalHolds.listPolicyAssignments(policyId: "1234") { results in
switch results {
@@ -159,6 +178,8 @@ client.legalHolds.listPolicyAssignments(policyId: "1234") { results in
}
```
+[get-policy-assignments]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC21listPolicyAssignments8policyId12assignToType0klJ06marker5limit6fields10completionySS_SSSgA2LSiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0c4HoldG10AssignmentCGAA0A8SDKErrorCGctF
+
Assign Policy
-------------
@@ -166,6 +187,7 @@ To assign a legal hold policy, call
[`client.legalHolds.forceApply(policyId: String, assignToId: String, assignToType: String, fields: [String]?, completion: @escaping Callback`][assign-policy]
with an ID of a policy, an ID of a file, file version, folder, or user and the type of the box item that the policy is being assigned to.
+
```swift
client.legalHolds.forceApply(policyId: "1234", assignToId: "4568" ,assignToType: "file") { (result: Result) in
guard case let .success(assignment) = result else {
@@ -176,6 +198,8 @@ client.legalHolds.forceApply(policyId: "1234", assignToId: "4568" ,assignToType:
}
```
+[assign-policy]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC12assignPolicy8policyId0f2ToI00fJ4Type6fields10completionySS_S2SSaySSGSgys6ResultOyAA0c4HoldG10AssignmentCAA0A8SDKErrorCGctF
+
Delete Policy Assignment
-------------
@@ -183,6 +207,7 @@ To delete a legal hold policy assignment, call
[`client.legalHolds.deletePolicyAssignment(policyId: String, completion: @escaping Callback`][delete-policy-assignment]
with the ID of the policy assignment to delete.
+
```swift
client.legalHolds.deletePolicyAssignment(assignmentId: "1234") { result: Result} in
guard case .success = result else {
@@ -193,6 +218,8 @@ client.legalHolds.deletePolicyAssignment(assignmentId: "1234") { result: Result<
}
```
+[delete-policy-assignment]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC22deletePolicyAssignment12assignmentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
+
Get File Version Legal Hold Info
---------------
@@ -201,6 +228,7 @@ To retrieve information about a file version legal hold, call
with the ID of legal hold. You can control which fields are returned in the resulting `File Version Legal Hold` object by passing the
`fields` parameter.
+
```swift
client.legalHolds.getFileVersionPolicy(legalHoldId: "22222") { (result: Result) in
guard case let .success(legalHold) = result else {
@@ -211,6 +239,8 @@ client.legalHolds.getFileVersionPolicy(legalHoldId: "22222") { (result: Result
```swift
client.legalHolds.listFileVersionPolicies(policyId: "1234") {
switch results {
@@ -237,3 +268,5 @@ client.legalHolds.listFileVersionPolicies(policyId: "1234") {
}
}
```
+
+[get-file-version-legal-holds]: https://opensource.box.com/box-ios-sdk/Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC23listFileVersionPolicies8policyId6marker5limit6fields10completionySS_SSSgSiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0ghC4HoldCGAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/metadata.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/metadata.md
index 4d325f956..02acf1fdd 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/metadata.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/metadata.md
@@ -46,6 +46,7 @@ To retrieve information about a metadata template, call
[`client.metadata.getTemplateByKey(scope:templateKey:completion:)`][get-md-template]
with the scope and key of the template.
+
```swift
client.metadata.getTemplateByKey(
scope: "enterprise",
@@ -64,6 +65,7 @@ Alternatively, if you know the ID of the metadata template, you can call
[`client.metadata.getTemplateById(id:completion:)`][get-md-template-id]
with the ID of the template.
+
```swift
client.metadata.getTemplateById(
id: "26004e29-7b94-44a1-8a63-f9aa384c7421"
@@ -77,8 +79,8 @@ client.metadata.getTemplateById(
}
```
-[get-md-template]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC03getC8Template5scope11templateKey10completionySS_SSys6ResultOyAA0cF0CAA0A5ErrorOGctF
-[get-md-template-id]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC03getC8Template2id10completionySS_ys6ResultOyAA0cF0CAA0A5ErrorOGctF
+[get-md-template]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC16getTemplateByKey5scope08templateH010completionySS_SSys6ResultOyAA0cF0CAA0A8SDKErrorCGctF
+[get-md-template-id]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC15getTemplateById2id10completionySS_ys6ResultOyAA0cF0CAA0A8SDKErrorCGctF
Create Metadata Template
------------------------
@@ -87,6 +89,7 @@ To create a new metadata template, call
[`client.metadata.createTemplate(scope:templateKey:displayName:hidden:fields:completion:)`][create-md-template]
with the scope and name of the template, as well as the fields the template should contain.
+
```swift
var templateFields: [MetadataField] = []
templateFields.append(MetadataField(
@@ -125,7 +128,7 @@ client.metadata.createTemplate(
}
```
-[create-md-template]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06createC8Template5scope11templateKey11displayName6hidden6fields10completionySS_S2SSbSayAA0C5FieldVGys6ResultOyAA0cF0CAA0A5ErrorOGctF
+[create-md-template]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14createTemplate5scope11templateKey11displayName6hidden6fields10completionySS_S2SSbSayAA0C5FieldVGys6ResultOyAA0cF0CAA0A8SDKErrorCGctF
Update Metadata Template
------------------------
@@ -136,6 +139,7 @@ with the scope and key of the template to update, as well as the update operatio
In this example, we are updating the metadata template using the ReorderEnumOptions operation.
Other metadata template update operations include: addEnumOption, addField, editTemplate, reorderFields
+
```swift
client.metadata.updateTemplate(
scope: "enterprise",
@@ -151,7 +155,7 @@ client.metadata.updateTemplate(
}
```
-[update-md-template]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06updateC8Template5scope11templateKey9operation10completionySS_SSAA0cF9OperationOys6ResultOyAA0cF0CAA0A5ErrorOGctF
+[update-md-template]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14updateTemplate5scope11templateKey9operation10completionySS_SSAA0cF9OperationOys6ResultOyAA0cF0CAA0A8SDKErrorCGctF
Delete Metadata Template
------------------------
@@ -160,6 +164,7 @@ To delete a metadata template, call
[`client.metadata.deleteTemplate(scope:templateKey:completion:)`][delete-md-template]
with the scope and key of the template to delete.
+
```swift
client.metadata.deleteTemplate(
scope: "enterprise",
@@ -174,7 +179,7 @@ client.metadata.deleteTemplate(
}
```
-[delete-md-template]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06deleteC8Template5scope11templateKey10completionySS_SSys6ResultOyytAA0A5ErrorOGctF
+[delete-md-template]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14deleteTemplate5scope11templateKey10completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF
List Metadata Templates
-----------------------
@@ -183,6 +188,7 @@ To retrieve the collection of available metadata templates in a particular scope
[`client.metadata.listEnterpriseTemplates(scope:marker:limit:)`][list-templates]
with the scope. This method will return an iterator object in the completion, which is used to retrieve metadata templates.
+
```swift
client.metadata.listEnterpriseTemplates(scope: "enterprise") { results in
switch results {
@@ -203,7 +209,30 @@ client.metadata.listEnterpriseTemplates(scope: "enterprise") { results in
}
```
-[list-templates]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC22getEnterpriseTemplates5scope6marker5limitAA24MarkerPaginationIteratorCyAA0C8TemplateCGSS_SSSgSiSgtF
+Similarly, to get all templates available in the `global` scope.
+
+
+```swift
+client.metadata.listEnterpriseTemplates(scope: "global") { results in
+ switch results {
+ case let .success(iterator):
+ for i in 1 ... 10 {
+ iterator.next { result in
+ switch result {
+ case let .success(template):
+ print("Template name: \(template.displayName)")
+ case let .failure(error):
+ print(error)
+ }
+ }
+ }
+ case let .failure(error):
+ print(error)
+ }
+}
+```
+
+[list-templates]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC23listEnterpriseTemplates5scope6marker5limit10completionySS_SSSgSiSgys6ResultOyAA14PagingIteratorCyAA0C8TemplateCGAA0A8SDKErrorCGctF
Get All Metadata on File
------------------------
@@ -212,6 +241,7 @@ To retrieve all metadata attached to a file, call
[`client.metadata.list(forFileId:completion:)`][get-all-md-file]
with the ID of the file.
+
```swift
client.metadata.list(forFileId: "11111") { (result: Result<[MetadataObject], BoxSDKError>) in
guard case let .success(metadata) = result {
@@ -226,7 +256,7 @@ client.metadata.list(forFileId: "11111") { (result: Result<[MetadataObject], Box
}
```
-[get-all-md-file]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06getAllC09forFileId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A5ErrorOGctF
+[get-all-md-file]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list9forFileId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF
Get Metadata Instance on File
-----------------------------
@@ -235,6 +265,7 @@ To retrieve a specific metadata instance attached to a file, call
[`client.metadata.get(forFileWithId:scope:templateKey:completion:)`][get-md-file]
with the file ID, as well as the scope and key of the metadata template of the instance.
+
```swift
client.metadata.get(
forFileWithId: "11111",
@@ -250,7 +281,7 @@ client.metadata.get(
}
```
-[get-md-file]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC03getC013forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A5ErrorOGctF
+[get-md-file]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF
Add Metadata Instance to File
-----------------------------
@@ -260,6 +291,7 @@ To attach a new metadata instance to a file, call
with the ID of the file, as well as the scope and key of the metadata template to use and the metadata keys and
values to attach.
+
```swift
let metadata = [
"name": "John Doe",
@@ -281,7 +313,7 @@ client.metadata.create(
}
```
-[add-md-file]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06createC013forFileWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A5ErrorOGctF
+[add-md-file]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create13forFileWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF
Update Metadata Instance on File
--------------------------------
@@ -291,6 +323,7 @@ To update the values in a metadata instance attached to a file, call
with the ID of the file, the scope and key of the metadata template associated with the instance, and the
operations to perform on the metadata.
+
```swift
client.metadata.update(
forFileWithId: "11111",
@@ -310,7 +343,7 @@ client.metadata.update(
}
```
-[update-md-file]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06updateC013forFileWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A5ErrorOGctF
+[update-md-file]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update13forFileWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF
Remove Metadata Instance from File
----------------------------------
@@ -319,6 +352,7 @@ To remove a specific metadata instance from a file, call
[`client.metadata.delete(forFileWithId:scope:templateKey:completion:)`][delete-md-file]
with the ID of the file, as well as the scope and key of the metadata template associated with the instance.
+
```swift
client.metadata.delete(
forFileWithId: "11111",
@@ -334,7 +368,7 @@ client.metadata.delete(
}
```
-[delete-md-file]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06deleteC013forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A5ErrorOGctF
+[delete-md-file]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF
Get All Metadata on Folder
--------------------------
@@ -343,6 +377,7 @@ To retrieve all metadata attached to a folder, call
[`client.metadata.list(forFolderId:completion:)`][get-all-md-folder]
with the ID of the folder.
+
```swift
client.metadata.list(forFolderId: "22222") { (result: Result<[MetadataObject], BoxSDKError>) in
guard case let .success(metadata) = result {
@@ -357,7 +392,7 @@ client.metadata.list(forFolderId: "22222") { (result: Result<[MetadataObject], B
}
```
-[get-all-md-folder]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06getAllC011forFolderId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A5ErrorOGctF
+[get-all-md-folder]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list11forFolderId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF
Get Metadata Instance on Folder
-------------------------------
@@ -366,6 +401,7 @@ To retrieve a specific metadata instance attached to a folder, call
[`client.metadata.get(forFolderWithId:scope:templateKey:completion:)`][get-md-folder]
with the folder ID, as well as the scope and key of the metadata template of the instance.
+
```swift
client.metadata.get(
forFolderWithId: "22222",
@@ -381,7 +417,7 @@ client.metadata.get(
}
```
-[get-md-folder]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC03getC015forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A5ErrorOGctF
+[get-md-folder]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF
Add Metadata Instance to Folder
-------------------------------
@@ -391,6 +427,7 @@ To attach a new metadata instance to a folder, call
with the ID of the folder, as well as the scope and key of the metadata template to use and the metadata keys and
values to attach.
+
```swift
let metadata = [
"name": "John Doe",
@@ -412,7 +449,7 @@ client.metadata.create(
}
```
-[add-md-folder]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06createC015forFolderWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A5ErrorOGctF
+[add-md-folder]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create15forFolderWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF
Update Metadata Instance on Folder
----------------------------------
@@ -422,6 +459,7 @@ To update the values in a metadata instance attached to a folder, call
with the ID of the folder, the scope and key of the metadata template associated with the instance, and the
operations to perform on the metadata.
+
```swift
client.metadata.update(
forFolderWithId: "22222",
@@ -441,7 +479,7 @@ client.metadata.update(
}
```
-[update-md-folder]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06updateC015forFolderWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A5ErrorOGctF
+[update-md-folder]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update15forFolderWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF
Remove Metadata Instance from Folder
------------------------------------
@@ -450,8 +488,9 @@ To remove a specific metadata instance from a folder, call
[`client.metadata.delete(forFolderWithId:scope:templateKey:completion:)`][delete-md-folder]
with the ID of the folder, as well as the scope and key of the metadata template associated with the instance.
+
```swift
-client.metadata.deleteMetadata(
+client.metadata.delete(
forFolderWithId: "22222",
scope: "enterprise",
templateKey: "personnelRecord"
@@ -465,4 +504,4 @@ client.metadata.deleteMetadata(
}
```
-[delete-md-folder]: http://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC06deleteC015forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A5ErrorOGctF
+[delete-md-folder]: https://opensource.box.com/box-ios-sdk/Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/recent-items.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/recent-items.md
index 76f8bba89..8e03c45c9 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/recent-items.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/recent-items.md
@@ -17,6 +17,7 @@ Get Recent Items
To get recently accessed items, call
[`client.recentItems.list(marker: String?, limit: Int?, fields: [String]?)`][get-recent-items]. This method will return an iterator object in the completion, which is used to retrieve recent items.
+
```swift
client.recentItems.list() { results in
switch results {
@@ -37,4 +38,4 @@ client.recentItems.list() { results in
}
```
-[get-recent-items]: https://opensource.box.com/box-swift-sdk/Classes/RecentItemsModule.html#/s:6BoxSDK17RecentItemsModuleC03getcD06marker5limit6fieldsAA18PaginationIteratorCyAA0C4ItemCGSSSg_SiSgSaySSGSgtF
+[get-recent-items]: https://opensource.box.com/box-ios-sdk/Classes/RecentItemsModule.html#/s:6BoxSDK17RecentItemsModuleC4list6marker5limit6fields10completionySSSg_SiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0C4ItemCGAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/search.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/search.md
index e49633bf6..bc78b7b7a 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/search.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/search.md
@@ -17,6 +17,7 @@ To get a list of items matching a search query, call [`client.search.query(query
string to query for. There are many possible options for advanced search filtering, which can be used to narrow down
the search results. This method will return an iterator object in the completion, which is used to get the results.
+
```swift
client.search.query(query: "Quarterly Business Review") { results in
switch results {
@@ -44,7 +45,7 @@ client.search.query(query: "Quarterly Business Review") { results in
}
```
-[search]: http://opensource.box.com/box-ios-sdk/Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC5queryAD5scope14fileExtensions12createdAfter0I6Before07updatedJ00lK011sizeAtLeast0mN4Most12ownerUserIDs014ancestorFolderS08searchIn8itemType0V5Trash6fields6offset5limitAA18PaginationIteratorCyAA0U4ItemCGSS_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA6_A6_A6_s5Int64VSgA9_A2_A2_SayAA0c7ContentY0OGSgAA0c4ItemY0OSgSbSgA2_SiSgA18_tF
+[search]: https://opensource.box.com/box-ios-sdk/Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC5queryAD5scope14fileExtensions12createdAfter0I6Before07updatedJ00lK011sizeAtLeast0mN4Most12ownerUserIDs014ancestorFolderS08searchIn8itemType0V5Trash14metadataFilter6fields6offset5limit10completionySSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA4_A4_A4_s5Int64VSgA7_A0_A0_SayAA0c7ContentY0OGSgAA0c4ItemY0OSgSbSgAA08MetadataC6FilterCSgA0_SiSgA19_ys6ResultOyAA14PagingIteratorCyAA0U4ItemOGAA0A8SDKErrorCGctF
Metadata Search
---------------
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/shared-items.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/shared-items.md
index f97f4a1a4..637695b97 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/shared-items.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/shared-items.md
@@ -19,6 +19,7 @@ To get the file or folder information for a shared link, call
with the URL of the shared link. The `sharedLinkPassword` parameter should be provided if the shared link is
password-protected.
+
```swift
client.sharedItems.get(
sharedLinkURL: "https://app.box.com/s/qqwertyuiopasdfghjklzxcvbnm123456"
@@ -40,4 +41,4 @@ client.sharedItems.get(
}
```
-[get-shared-item]: http://opensource.box.com/box-ios-sdk/Classes/SharedItemsModule.html#/s:6BoxSDK17SharedItemsModuleC03getC4Item13sharedLinkURL0hI8Password6fields10completionySS_SSSgSaySSGSgys6ResultOyAA0cG0CAA0A5ErrorOGctF
+[get-shared-item]: https://opensource.box.com/box-ios-sdk/Classes/SharedItemsModule.html#/s:6BoxSDK17SharedItemsModuleC3get13sharedLinkURL0gH8Password6fields10completionySS_SSSgSaySSGSgys6ResultOyAA0C4ItemCAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/storage-policies.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/storage-policies.md
index 0dee586dd..462deba17 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/storage-policies.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/storage-policies.md
@@ -24,6 +24,7 @@ To retrieve information about a storage policy, call
with the ID of the storage policy. You can control which fields are returned in the resulting `Storage Policy` object by passing the
`fields` parameter.
+
```swift
client.storagePolicies.get(storagePolicyId: "22222") { (result: Result) in
guard case let .success(policy) = result else {
@@ -34,12 +35,15 @@ client.storagePolicies.get(storagePolicyId: "22222") { (result: Result
```swift
client.storagePolicies.list() { results in
switch results {
@@ -60,6 +64,8 @@ client.storagePolicies.list() { results in
}
```
+[get-storage-policies]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC17listForEnterprise6marker5limit6fields10completionySSSg_SiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA0C6PolicyCGAA0A8SDKErrorCGctF
+
Get Storage Policy Assignment Info
----------------------------------
@@ -67,6 +73,7 @@ To get storage policy assignment, call
[`client.storagePolicies.getAssignment(storagePolicyAssignmentId: String, fields: [String]?, completion: @escaping Callback`][get-storage-policy-assignment-info]
with the id of a storage policy assignment.
+
```swift
client.storagePolicy.getAssignment(storagePolicyAssignmentId: "1234") { (result: Result) in
guard case let .success(assignment) = result else {
@@ -76,12 +83,15 @@ client.storagePolicy.getAssignment(storagePolicyAssignmentId: "1234") { (result:
print("Storage policy assignment ID \(assignment.id)")
}
```
+[get-storage-policy-assignment-info]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC13getAssignment013storagePolicyG2Id6fields10completionySS_SaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF
+
Get Storage Policy Assignments
------------------------------
To get storage policy assignments for a user or enterprise, call
[`client.storagePolicies.listAssignments(resolvedForType: String, resolvedForId: String, fields: [String]?, completion: @escaping Callback`][get-storage-policy-assignments]. This always returns a single storage policy assignment.
+
```swift
client.storagePolicy.listAssignments(resolvedForType: "user", resolvedForId: "1234") { (result: Result) in
guard case let .success(assignment) = result else {
@@ -92,12 +102,15 @@ client.storagePolicy.listAssignments(resolvedForType: "user", resolvedForId: "12
}
```
-Create Storage Policy Assignment
+[get-storage-policy-assignments]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC15listAssignments15resolvedForType0hI2Id6fields10completionySS_SSSaySSGSgys6ResultOyAA0C16PolicyAssignmentCAA0A8SDKErrorCGctF
+
+Assign Storage Policy
--------------------------------
To assign a storage policy, call
-[`client.storagePolicies.assign(storagePolicyId: String, assignedToType: String, assignedToId, fields: [String]?, completion: @escaping Callback`][storage-policy-assignment].
+[`client.storagePolicies.assign(storagePolicyId: String, assignedToType: String, assignedToId, fields: [String]?, completion: @escaping Callback`][assign-storage-policy].
+
```swift
client.storagePolicy.assign(storagePolicyId: "1234", assignedToType: "user", assignedToId: "123") { (result: Result) in
guard case let .success(assignment) = result else {
@@ -108,12 +121,15 @@ client.storagePolicy.assign(storagePolicyId: "1234", assignedToType: "user", ass
}
```
-Assign Storage Policy
+[assign-storage-policy]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC6assign15storagePolicyId14assignedToType0jkI06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cH10AssignmentCAA0A8SDKErrorCGctF
+
+Force Assign Storage Policy
---------------------
To assign a storage policy, call
-[`client.storagePolicies.forceAssign(storagePolicyId: String, assignedToType: String, assignedToId, fields: [String]?, completion: @escaping Callback`][assign-storage-policy]. The difference between this call and the createPolicyAssignment() above is that this method will guarantee an update to the assignee's policy. If an assignee already has a policy assigned to it, the createPolicyAssignment() will return a 409 Conflict error. assignPolicy() will instead make an additional updatePolicyAssignment() call to replace the existing policy with the new policy for a policy assignment.
+[`client.storagePolicies.forceAssign(storagePolicyId: String, assignedToType: String, assignedToId, fields: [String]?, completion: @escaping Callback`][force-assign-storage-policy]. The difference between this call and the createPolicyAssignment() above is that this method will guarantee an update to the assignee's policy. If an assignee already has a policy assigned to it, the createPolicyAssignment() will return a 409 Conflict error. assignPolicy() will instead make an additional updatePolicyAssignment() call to replace the existing policy with the new policy for a policy assignment.
+
```swift
client.storagePolicy.forceAssign(storagePolicyId: "1234", assignedToType: "user", assignedToId: "123") { (result: Result) in
guard case let .success(assignment) = result else {
@@ -124,12 +140,15 @@ client.storagePolicy.forceAssign(storagePolicyId: "1234", assignedToType: "user"
}
```
+[force-assign-storage-policy]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC11forceAssign15storagePolicyId14assignedToType0klJ06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cI10AssignmentCAA0A8SDKErrorCGctF
+
Update Storage Policy Assignment
--------------------------------
To update storage policy assignment, call
[`client.storagePolicies.updateAssignment(storagePolicyId: String, assignedToType: String, assignedToId, fields: [String]?, completion: @escaping Callback`][update-storage-policy-assignment].
+
```swift
client.storagePolicy.updateAssignment(storagePolicyAssignmentId: "1234", storagePolicyId: "123") { (result: Result) in
guard case let .success(assignment) = result else {
@@ -140,6 +159,8 @@ client.storagePolicy.updateAssignment(storagePolicyAssignmentId: "1234", storage
}
```
+[update-storage-policy-assignment]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16updateAssignment013storagePolicyG2Id0hiJ06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF
+
Delete Storage Policy Assignment
--------------------------------
@@ -147,6 +168,7 @@ To delete a storage policy assignment, call
[`client.folders.deleteAssignment(storagePolicyAssignmentId: String, completion: @escaping Callback`][delete-storage-policy-assignment]
with the ID of the storage policy to delete.
+
```swift
client.storagePolicies.deleteAssignment(storagePolicyAssignmentId: "22222") { result: Result} in
guard case .success = result else {
@@ -156,3 +178,5 @@ client.storagePolicies.deleteAssignment(storagePolicyAssignmentId: "22222") { re
print("Storage policy assignment is successfully deleted.")
}
```
+
+[delete-storage-policy-assignment]: https://opensource.box.com/box-ios-sdk/Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16deleteAssignment013storagePolicyG2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/terms_of_services.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/terms_of_services.md
index e950ab8d7..ff1d2a057 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/terms_of_services.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/terms_of_services.md
@@ -21,8 +21,9 @@ Get Terms of Service By ID
--------------------------
To retrieve information about a terms of service, call
-[`client.termsOfService.get(tosId:fields:completion)`] with the ID of the terms of service. You can control which fields are returned in the resulting `Terms of Service` object by passing the `fields` parameter.
+[`client.termsOfService.get(tosId:fields:completion)`][get-tos] with the ID of the terms of service. You can control which fields are returned in the resulting `Terms of Service` object by passing the `fields` parameter.
+
```swift
client.termsOfService.get(
tosID: "12345"
@@ -35,12 +36,15 @@ client.termsOfService.get(
}
```
+[get-tos]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC3get5tosId6fields10completionySS_SaySSGSgys6ResultOyAA0cD7ServiceCAA0A8SDKErrorCGctF
+
Create Terms of Service
-----------------------
To create a terms of service, call
-[`client.termsOfService.create(status:tosType:text:fields:completion`]. You can control which fields are returned in the resulting `Terms of Service` object by passing the `fields` parameter.
+[`client.termsOfService.create(status:tosType:text:fields:completion`][create-tos]. You can control which fields are returned in the resulting `Terms of Service` object by passing the `fields` parameter.
+
```swift
client.termsOfService.create(
status: .enabled,
@@ -55,11 +59,14 @@ client.termsOfService.create(
}
```
+[create-tos]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6create6status7tosType4text6fields10completionyAA0cD13ServiceStatusO_AA0cdnJ0OSSSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF
+
Update Terms of Service
-----------------------
-To update a terms of service, call [`client.termsOfService.update(tosId:text:status:fields:completion)`] with the ID of the terms of service to update. You can control which fields are returned in the resulting `Terms of Service` object by passing the `fields` parameter.
+To update a terms of service, call [`client.termsOfService.update(tosId:text:status:fields:completion)`][update-tos] with the ID of the terms of service to update. You can control which fields are returned in the resulting `Terms of Service` object by passing the `fields` parameter.
+
```swift
client.termsOfService.update(
tosId: "12345",
@@ -74,23 +81,29 @@ client.termsOfService.update(
}
```
+[update-tos]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6update5tosId4text6status6fields10completionySS_SSAA0cD13ServiceStatusOSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF
+
List Terms of Services for an Enterprise
----------------------------------------
-To retrieve a list of terms of services for an enterprise, call [`client.termsOfService.listForEnterprise(tosType:fields:completion)`] with the type of terms of service to retrieve. If left nil, then terms of services of both types, `managed` and `external` will be retrieved. You can control which fields are returned in the resulting `Terms of Service` objects by passing the `fields` parameter.
+To retrieve a list of terms of services for an enterprise, call [`client.termsOfService.listForEnterprise(tosType:fields:completion)`][list-tos] with the type of terms of service to retrieve. If left nil, then terms of services of both types, `managed` and `external` will be retrieved. You can control which fields are returned in the resulting `Terms of Service` objects by passing the `fields` parameter.
+
```swift
let termsOfServiceItems = client.termsOfService.listForEnterprise()
print("Terms of Service with ID \(termsOfServiceItems[0].id) and Terms of Service with ID \(termsOfServiceItems[1].id) was retrieved.")
```
+[list-tos]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC17listForEnterprise7tosType6fields10completionyAA0cd7ServiceK0OSg_SaySSGSgys6ResultOySayAA0cdN0CGAA0A8SDKErrorCGctF
+
Create User Status on Terms of Service
--------------------------------------
To accept or decline a terms of service for a user who has never
-accepted/declined this terms of service before call [`client.termsOfService.createUserStatus(tosId:isAccepted:userId:fields:completion)`]. You can control which fields are returned in the resulting `Terms of Service User Status` object by passing the `fields` parameter.
+accepted/declined this terms of service before call [`client.termsOfService.createUserStatus(tosId:isAccepted:userId:fields:completion)`][create-user-status]. You can control which fields are returned in the resulting `Terms of Service User Status` object by passing the `fields` parameter.
+
```swift
client.termsOfService.createUserStatus(
tosId: "12345",
@@ -106,11 +119,14 @@ client.termsOfService.createUserStatus(
}
```
+[create-user-status]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16createUserStatus5tosId10isAccepted04userK06fields10completionySS_SbSSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF
+
Update User Status of Terms of Service
--------------------------------------
-To update a user status on a terms of service call [`client.termsOfService.updateUserStatus(userStatusId:isAccepted:fields:completion)`]. You can control which fields are returned in the resulting `Terms of Service User Status` object by passing the `fields` parameter.
+To update a user status on a terms of service call [`client.termsOfService.updateUserStatus(userStatusId:isAccepted:fields:completion)`][update-user-status]. You can control which fields are returned in the resulting `Terms of Service User Status` object by passing the `fields` parameter.
+
```swift
client.termsOfService.updateUserStatus(
userStatusId: "12345",
@@ -125,11 +141,14 @@ client.termsOfService.updateUserStatus(
}
```
+[update-user-status]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16updateUserStatus04userI2Id10isAccepted6fields10completionySS_SbSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF
+
Get User Status for Terms of Service
------------------------------------
-To retrieve the user status for a user on a terms of service, call [`client.termsOfService.getUserStatus(tosId:userId:fields:completion)`] with the ID of the `Terms of Service` object and the ID of the user.
+To retrieve the user status for a user on a terms of service, call [`client.termsOfService.getUserStatus(tosId:userId:fields:completion)`][get-user-status] with the ID of the `Terms of Service` object and the ID of the user.
+
```swift
client.termsOfService.getUserStatus(
tosId: "12345",
@@ -142,4 +161,5 @@ client.termsOfService.getUserStatus(
print("User status with ID \(userStatus.id) was retrieved")
}
-```
\ No newline at end of file
+```
+[get-user-status]: https://opensource.box.com/box-ios-sdk/Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC13getUserStatus5tosId04userK06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF
\ No newline at end of file
diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/users.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/users.md
index 74b0d31f4..c765a7354 100644
--- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/users.md
+++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/users.md
@@ -3,12 +3,35 @@ Users
Users represent an individual's account on Box.
+
+
+
+
+- [Get Current User](#get-current-user)
+- [Get User](#get-user)
+- [Get User Avatar](#get-user-avatar)
+- [Create User](#list-terms-of-services-for-an-enterprise)
+- [Create App User](#create-app-user)
+- [Update User](#update-user)
+- [Change User Login](#change-user-login)
+- [Delete User](#delete-user)
+- [Get Enterprise Users](#get-enterprise-users)
+- [Invite User to Enterprise](#invite-user-to-enterprise)
+- [Move User Content](#move-user-content)
+- [Get User Email Aliases](#get-user-email-aliases)
+- [Add User Email Alias](#add-user-email-alias)
+- [Remove User Email Alias](#remove-user-email-alias)
+- [Roll User Out of Enterprise](#roll-user-out-of-enterprise)
+
+
+
Get Current User
----------------
To retrieve information about the currently authenticated user, call
[`client.users.getCurrent(fields:completion:)`][get-current-user].
+
```swift
client.users.getCurrent(fields: ["name", "login"]) { (result: Result) in
guard case let .success(user) = result else {
@@ -20,7 +43,7 @@ client.users.getCurrent(fields: ["name", "login"]) { (result: Result
```swift
client.users.get(userId: "33333", fields: ["name", "login"]) { (result: Result) in
guard case let .success(user) = result else {
@@ -40,7 +64,7 @@ client.users.get(userId: "33333", fields: ["name", "login"]) { (result: Result
```swift
client.users.getAvatar(userId: "33333") { (result: Result) in
guard case let .success(avatarData) = result else {
@@ -60,7 +85,7 @@ client.users.getAvatar(userId: "33333") { (result: Result) in
}
```
-[get-user-avatar]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13getUserAvatar6userId10completionySS_ys6ResultOy10Foundation4DataVAA0A5ErrorOGctF
+[get-user-avatar]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC9getAvatar6userId10completionySS_ys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF
Create User
-----------
@@ -69,6 +94,7 @@ As an admin user or service account, create a new user in your enterprise by cal
[`client.users.create(login:name:...)`][create-user] with the login email address and name for
the user.
+
```swift
client.users.create(login: "new.user@example.com", name: "New User") { (result: Result) in
guard case let .success(user) = result else {
@@ -80,7 +106,7 @@ client.users.create(login: "new.user@example.com", name: "New User") { (result:
}
```
-[create-user]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10createUser5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0K24ExternalCollabRestricted0K22ExemptFromDeviceLimits0K27ExemptFromLoginVerification6status6fields10completionySS_SSAA0F4RoleOSgSSSgSbSgA3Zs5Int64VSgSayAA0F0C12TrackingCodeVGSgA_AZA_A_A_AA0F6StatusOSgSaySSGSgys6ResultOyA4_AA0A5ErrorOGctF
+[create-user]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6create5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0J24ExternalCollabRestricted0J22ExemptFromDeviceLimits0J27ExemptFromLoginVerification6status6fields10completionySS_SSAA8UserRoleOSgSSSgSbSgA3Zs5Int64VSgSayAA4UserC12TrackingCodeVGSgA_AZA_A_A_AA10UserStatusOSgSaySSGSgys6ResultOyA4_AA0A8SDKErrorCGctF
Create App User
---------------
@@ -88,6 +114,7 @@ Create App User
To create an [app user][app-user], call [`client.users.createAppUser(name:...)`][create-app-user] with the
a name for that user.
+
```swift
client.users.createAppUser(name: "Doug") { (result: Result) in
guard case let .success(appUser) = result else {
@@ -100,7 +127,7 @@ client.users.createAppUser(name: "Doug") { (result: Result) i
```
[app-user]: https://developer.box.com/docs/user-types#section-app-user
-[create-app-user]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13createAppUser4name8language8jobTitle8timezone5phone7address11spaceAmount6status26isExternalCollabRestricted013canSeeManagedC06fields10completionySS_SSSgA4Qs5Int64VSgAA0G6StatusOSgSbSgAXSaySSGSgys6ResultOyAA0G0CAA0A5ErrorOGctF
+[create-app-user]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13createAppUser4name8language8jobTitle8timezone5phone7address11spaceAmount6status26isExternalCollabRestricted013canSeeManagedC06fields10completionySS_SSSgA4Qs5Int64VSgAA0G6StatusOSgSbSgAXSaySSGSgys6ResultOyAA0G0CAA0A8SDKErrorCGctF
Update User
-----------
@@ -108,6 +135,7 @@ Update User
To update the information on a user, call [`client.users.updateUser(userId:...)`][update-user]
with the ID of the user and the properties to update. The result is the updated user object.
+
```swift
// Restrict the user from collaborating content externally
client.users.update(userId: "33333", isExternalCollabRestricted: true) { (result: Result) in
@@ -120,7 +148,7 @@ client.users.update(userId: "33333", isExternalCollabRestricted: true) { (result
}
```
-[update-user]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10updateUser6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0M24ExternalCollabRestricted0M22ExemptFromDeviceLimits0M27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA0F4RoleOSgAXSbSgA3Xs5Int64VSgSayAA0F0C12TrackingCodeVGSgA0_AXA0_A0_A0_AA0F6StatusOSgSaySSGSgys6ResultOyA5_AA0A5ErrorOGctFhttp://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10updateUser6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0M24ExternalCollabRestricted0M22ExemptFromDeviceLimits0M27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA0F4RoleOSgAXSbSgA3Xs5Int64VSgSayAA0F0C12TrackingCodeVGSgA0_AXA0_A0_A0_AA0F6StatusOSgSaySSGSgys6ResultOyA5_AA0A5ErrorOGctF
+[update-user]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6update6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0L24ExternalCollabRestricted0L22ExemptFromDeviceLimits0L27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA8UserRoleOSgAXSbSgA3Xs5Int64VSgSayAA4UserC12TrackingCodeVGSgA0_AXA0_A0_A0_AA10UserStatusOSgSaySSGSgys6ResultOyA5_AA0A8SDKErrorCGctF
Change User Login
-----------------
@@ -132,6 +160,7 @@ To change a user's login email, call
[`client.users.changeLogin(userId:login:fields:completion:)`][change-login]
with the ID of the user and the new login email.
+
```swift
client.users.changeLogin(userId: "33333", login: "updated.address@example.com") { (result: Result) in
guard case let .success(user) = result else {
@@ -143,7 +172,7 @@ client.users.changeLogin(userId: "33333", login: "updated.address@example.com")
}
```
-[change-login]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC18changeLoginForUser6userId5login6fields10completionySS_SSSaySSGSgys6ResultOyAA0H0CAA0A5ErrorOGctF
+[change-login]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC11changeLogin6userId5login6fields10completionySS_SSSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF
Delete User
-----------
@@ -153,6 +182,7 @@ To delete a user, which removes their access to Box, call
with the ID of the user. By default, the user will not be deleted if they have any content remaining in their account.
To delete the user and any content that is in their account, set the `force` parameter to `true`.
+
```swift
client.users.delete(userId: "33333") { (result: Result) in
guard case .success = result else {
@@ -164,7 +194,7 @@ client.users.delete(userId: "33333") { (result: Result) in
}
```
-[delete-user]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10deleteUser6userId6notify5force10completionySS_SbSgAIys6ResultOyytAA0A5ErrorOGctF
+[delete-user]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6delete6userId6notify5force10completionySS_SbSgAIys6ResultOyytAA0A8SDKErrorCGctF
Get Enterprise Users
--------------------
@@ -173,6 +203,7 @@ To retrieve the users in an enterprise, call
[`client.users.listForEnterprise(filterTerm:fields:offset:limit:)`][get-enterprise-users].
The method returns an iterator object in the completion, which is used to get the users.
+
```swift
client.users.listForEnterprise() {
switch results {
@@ -193,7 +224,7 @@ client.users.listForEnterprise() {
}
```
-[get-enterprise-users]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC013getEnterpriseC010filterTerm6fields6offset5limitAA18PaginationIteratorCyAA4UserCGSSSg_SaySSGSgSiSgAQtF
+[get-enterprise-users]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC17listForEnterprise10filterTerm6fields9usemarker6marker6offset5limit10completionySSSg_SaySSGSgSbSgALSiSgAPys6ResultOyAA14PagingIteratorCyAA4UserCGAA0A8SDKErrorCGctF
Invite User to Enterprise
-------------------------
@@ -202,6 +233,7 @@ To invite a user who already has a Box account to join an enterprise, call
[`client.users.inviteToJoinEnterprise(login:enterpriseId:fields:completion:)`][invite-user]
with the login email of the user and the ID of the enterprise.
+
```swift
client.users.inviteToJoinEnterprise(
login: "user@example.com",
@@ -216,7 +248,7 @@ client.users.inviteToJoinEnterprise(
}
```
-[invite-user]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC26inviteUserToJoinEnterprise5login12enterpriseId6fields10completionySS_SSSaySSGSgys6ResultOyAA6InviteCAA0A5ErrorOGctF
+[invite-user]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC22inviteToJoinEnterprise5login12enterpriseId6fields10completionySS_SSSaySSGSgys6ResultOyAA6InviteCAA0A8SDKErrorCGctF
Move User Content
-----------------
@@ -226,6 +258,7 @@ Before deleting a user, it is recommended to move all content they own to anothe
with the ID of the source and destination users. The result of this method is a new folder created in the destination
user's root folder, containing all content previously owned by the source user.
+
```swift
client.users.moveItemsOwnedByUser(withID: "33333", toUserWithID: "44444") { (result: Result) in
guard case let .success(folder) = result else {
@@ -237,7 +270,7 @@ client.users.moveItemsOwnedByUser(withID: "33333", toUserWithID: "44444") { (res
}
```
-[move-user-content]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC20moveItemsOwnedByUser6withID02toi4WithK06notify6fields10completionySS_SSSbSgSaySSGSgys6ResultOyAA6FolderCAA0A5ErrorOGctF
+[move-user-content]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC20moveItemsOwnedByUser6withID02toi4WithK06notify6fields10completionySS_SSSbSgSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF
Get User Email Aliases
----------------------
@@ -246,6 +279,7 @@ To retrieve the list of email aliases associated with a user, call
[`client.users.listEmailAliases(userId:completion:)`][get-email-aliases]
with the ID of the user.
+
```swift
client.users.listEmailAliases(userId: "33333") { (result: Result, BoxSDKError>) in
guard case let .success(aliasCollection) = result else {
@@ -260,7 +294,7 @@ client.users.listEmailAliases(userId: "33333") { (result: Result
```swift
client.users.createEmailAlias(
userId: "33333",
@@ -283,7 +318,7 @@ client.users.createEmailAlias(
}
```
-[add-email-alias]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC23createEmailAliasForUser6userId5email10completionySS_SSys6ResultOyAA0fG0CAA0A5ErrorOGctF
+[add-email-alias]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC23createEmailAliasForUser6userId5email10completionySS_SSys6ResultOyAA0fG0CAA0A5ErrorOGctF
Remove User Email Alias
-----------------------
@@ -292,6 +327,7 @@ To remove a user's email alias, call
[`client.users.deleteEmailAlias(userId:emailAliasId:completion:)`][remove-email-alias]
with the ID of the user and the ID of the email alias to remove.
+
```swift
client.users.deleteEmailAlias(userId: "33333", emailAliasId: "99999") { (result: Result) in
guard case .success = result else {
@@ -303,7 +339,7 @@ client.users.deleteEmailAlias(userId: "33333", emailAliasId: "99999") { (result:
}
```
-[remove-email-alias]: http://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC23deleteEmailAliasForUser6userId05emailgK010completionySS_SSys6ResultOyytAA0A5ErrorOGctF
+[remove-email-alias]: https://opensource.box.com/box-ios-sdk/Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16deleteEmailAlias6userId05emailgI010completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF
Roll User Out of Enterprise
---------------------------
@@ -312,6 +348,7 @@ To roll a user out of an enterprise, converting them to a free user, call
[`client.users.rollOutOfEnterprise(userId:notify:fields:completion:)`][roll-out-user]
with the ID of the user.
+
```swift
client.users.rollOutOfEnterprise(userId: "33333") { (result: Result) in
guard case let .success(user) = result else {
@@ -323,4 +360,4 @@ client.users.rollOutOfEnterprise(userId: "33333") { (result: Result)`]
+[`client.webhooks.get(webhookId: String, fields: [String]?, completion: @escaping Callback)`][get-webhook]
with the ID of the webhook. You can control which fields are returned in the resulting `Webhook` object by passing the
`fields` parameter.
+
```swift
client.folders.get(webhookId: "22222", fields: ["id", "created_at"]) { (result: Result) in
guard case let .success(webhook) = result else {
@@ -34,12 +35,15 @@ client.folders.get(webhookId: "22222", fields: ["id", "created_at"]) { (result:
}
```
-Get Webhooks
+[get-webhook]: https://opensource.box.com/box-ios-sdk/Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC3get9webhookId6fields10completionySS_SaySSGSgys6ResultOyAA7WebhookCAA0A8SDKErrorCGctF
+
+List Webhooks
----------------
To retrieve information about webhooks in an enterprise, call
-[`client.webhook.list(webhookId: String, marker: String?, limit: Int?, fields: [String]?)`]. This method will return an iterator object in the completion, which is used to get the webhooks.
+[`client.webhook.list(webhookId: String, marker: String?, limit: Int?, fields: [String]?)`][list-webhooks]. This method will return an iterator object in the completion, which is used to get the webhooks.
+
```swift
client.webhooks.list() { results in
switch results {
@@ -60,12 +64,15 @@ client.webhooks.list() { results in
}
```
+[list-webhooks]: https://opensource.box.com/box-ios-sdk/Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC4list6marker5limit6fields10completionySSSg_SiSgSaySSGSgys6ResultOyAA14PagingIteratorCyAA7WebhookCGAA0A8SDKErrorCGctF
+
Create Webhook
-------------
To create a new webhook, call
-[`client.webhooks.create(targetType: String, targetId: String, triggers: [Webhook.EventTriggers], address: String, fields: [String]?, completion: @escaping Callback`]
+[`client.webhooks.create(targetType: String, targetId: String, triggers: [Webhook.EventTriggers], address: String, fields: [String]?, completion: @escaping Callback`][create-webhook]
+
```swift
client.webhooks.create(targetType: "file", targetId: "1234", triggers: [.fileDownloaded], address: "www.testurl.com") { (result: Result) in
guard case let .success(webhook) = result else {
@@ -77,12 +84,15 @@ client.webhooks.create(targetType: "file", targetId: "1234", triggers: [.fileDow
}
```
+[create-webhook]: https://opensource.box.com/box-ios-sdk/Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6create10targetType0F2Id8triggers7address6fields10completionySS_SSSayAA7WebhookC13EventTriggersOGSSSaySSGSgys6ResultOyAlA0A8SDKErrorCGctF
+
Update Webhook
-------------
To update a webhook, call
-[`client.webhooks.update(webhookId: String, targetType: String?, targetId: String?, triggers: [Webhook.EventTriggers]?, address: String?, fields: [String]?, completion: @escaping Callback`]
+[`client.webhooks.update(webhookId: String, targetType: String?, targetId: String?, triggers: [Webhook.EventTriggers]?, address: String?, fields: [String]?, completion: @escaping Callback`][update-webhook]
+
```swift
client.webhooks.update(webhookId: "1234", targetType: "file", targetId: "1234", address: "www.testurl.com") { (result: Result) in
guard case let .success(webhook) = result else {
@@ -94,12 +104,15 @@ client.webhooks.update(webhookId: "1234", targetType: "file", targetId: "1234",
}
```
+[update-webhook]: https://opensource.box.com/box-ios-sdk/Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6update9webhookId10targetType0hG08triggers7address6fields10completionySS_SSSgALSayAA7WebhookC13EventTriggersOGSgALSaySSGSgys6ResultOyAnA0A8SDKErrorCGctF
+
Delete Webhook
-------------
To delete a webhook, call
-[`client.webhooks.delete(webhookId: String, completion: @escaping Callback`]
+[`client.webhooks.delete(webhookId: String, completion: @escaping Callback`][delete-webhook]
+
```swift
client.webhooks.delete(webhookId: "22222") { result: Result} in
guard case .success = result else {
@@ -110,3 +123,5 @@ client.webhooks.delete(webhookId: "22222") { result: Result}
print("Webhook successfully deleted")
}
```
+
+[delete-webhook]: https://opensource.box.com/box-ios-sdk/Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6delete9webhookId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF
diff --git a/docs/docsets/BoxSDK.tgz b/docs/docsets/BoxSDK.tgz
index 4408b9fbf..48a5b9e29 100644
Binary files a/docs/docsets/BoxSDK.tgz and b/docs/docsets/BoxSDK.tgz differ
diff --git a/docs/index.html b/docs/index.html
index 9fbef3d25..e0a794785 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -754,7 +754,7 @@ Installing the SDK
Carthage
Step 1: Add to your Cartfile
-git "https://github.com/box/box-ios-sdk.git" ~> 3.0
+git "https://github.com/box/box-ios-sdk.git" ~> 4.0
Step 2: Update dependencies
@@ -767,7 +767,7 @@ Carthage
CocoaPods
Step 1: Add to your Podfile
-pod 'BoxSDK', '~> 3.0'
+pod 'BoxSDK', '~> 4.0'
Step 2: Install pod by running the following command in the directory with the Podfile
@@ -808,6 +808,10 @@ Getting Started
}
}
+
+The usage docs that show how to make calls to the Box API with the SDK can be found here.
+
+The Jazzy docs that show class, method, variable, etc definitions can be found here.
Sample Apps
OAuth2 Sample App
@@ -988,7 +992,7 @@ Copyright and License
diff --git a/docs/undocumented.json b/docs/undocumented.json
deleted file mode 100644
index a31ad0c76..000000000
--- a/docs/undocumented.json
+++ /dev/null
@@ -1,1083 +0,0 @@
-{
- "warnings": [
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/BoxSDK.swift",
- "line": 181,
- "symbol": "BoxSDK.getOAuth2Client(tokenInfo:tokenStore:context:completion:)",
- "symbol_kind": "source.lang.swift.decl.function.method.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
- "line": 13,
- "symbol": "BoxAPIError.request",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
- "line": 14,
- "symbol": "BoxAPIError.response",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxAPIError.swift",
- "line": 74,
- "symbol": "BoxAPIError.getDictionary()",
- "symbol_kind": "source.lang.swift.decl.function.method.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 11,
- "symbol": "BoxSDKErrorEnum",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 13,
- "symbol": "BoxSDKErrorEnum.clientDestroyed",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 14,
- "symbol": "BoxSDKErrorEnum.invalidURL(urlString:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 15,
- "symbol": "BoxSDKErrorEnum.notFound(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 16,
- "symbol": "BoxSDKErrorEnum.instanceDeallocated(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 17,
- "symbol": "BoxSDKErrorEnum.keychainDataConversionError",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 18,
- "symbol": "BoxSDKErrorEnum.keychainNoValue",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 19,
- "symbol": "BoxSDKErrorEnum.keychainUnhandledError(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 20,
- "symbol": "BoxSDKErrorEnum.rateLimitMaxRetries",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 21,
- "symbol": "BoxSDKErrorEnum.typeMismatch(key:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 22,
- "symbol": "BoxSDKErrorEnum.valueMismatch(key:value:acceptedValues:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 23,
- "symbol": "BoxSDKErrorEnum.invalidValueFormat(key:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 24,
- "symbol": "BoxSDKErrorEnum.notPresent(key:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 25,
- "symbol": "BoxSDKErrorEnum.representationCreationFailed",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 26,
- "symbol": "BoxSDKErrorEnum.tokenStoreFailure",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 27,
- "symbol": "BoxSDKErrorEnum.tokenRetrieval",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 28,
- "symbol": "BoxSDKErrorEnum.invalidOAuthRedirectConfiguration",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 29,
- "symbol": "BoxSDKErrorEnum.invalidOAuthState",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 30,
- "symbol": "BoxSDKErrorEnum.unauthorizedAccess",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 31,
- "symbol": "BoxSDKErrorEnum.refreshTokenNotFound",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 32,
- "symbol": "BoxSDKErrorEnum.expiredToken",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 33,
- "symbol": "BoxSDKErrorEnum.jwtAuthError",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 34,
- "symbol": "BoxSDKErrorEnum.nonIterableResponse",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 35,
- "symbol": "BoxSDKErrorEnum.endOfList",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 36,
- "symbol": "BoxSDKErrorEnum.customValue(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 131,
- "symbol": "BoxSDKErrorEnum",
- "symbol_kind": "source.lang.swift.decl.extension",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 139,
- "symbol": "BoxSDKError.errorType",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 140,
- "symbol": "BoxSDKError.message",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 141,
- "symbol": "BoxSDKError.stackTrace",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 142,
- "symbol": "BoxSDKError.error",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Core/Errors/BoxSDKError.swift",
- "line": 151,
- "symbol": "BoxSDKError.getDictionary()",
- "symbol_kind": "source.lang.swift.decl.function.method.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
- "line": 11,
- "symbol": "PagingParameter",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
- "line": 13,
- "symbol": "PagingParameter.offset(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
- "line": 14,
- "symbol": "PagingParameter.marker(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
- "line": 15,
- "symbol": "PagingParameter.streamPosition(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Network/PagingIterator.swift",
- "line": 35,
- "symbol": "PagingIterator.nextPage",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Requests/BodyData/LockData.swift",
- "line": 11,
- "symbol": "LockData",
- "symbol_kind": "source.lang.swift.decl.struct",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Requests/BodyData/LockData.swift",
- "line": 22,
- "symbol": "LockData.init(expiresAt:isDownloadPrevented:)",
- "symbol_kind": "source.lang.swift.decl.function.method.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/CollaborationWhitelistEntry.swift",
- "line": 11,
- "symbol": "CollaborationDirection",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
- "line": 17,
- "symbol": "Collaborator.CollaboratorType",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
- "line": 18,
- "symbol": "Collaborator.CollaboratorType.user(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
- "line": 19,
- "symbol": "Collaborator.CollaboratorType.group(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Collaborator.swift",
- "line": 22,
- "symbol": "Collaborator.collaboratorValue",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/CommentItem.swift",
- "line": 24,
- "symbol": "CommentItem.file(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/CommentItem.swift",
- "line": 25,
- "symbol": "CommentItem.comment(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
- "line": 12,
- "symbol": "DevicePin",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
- "line": 26,
- "symbol": "DevicePin.ownedBy",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
- "line": 28,
- "symbol": "DevicePin.productName",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
- "line": 30,
- "symbol": "DevicePin.createdAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/DevicePin.swift",
- "line": 32,
- "symbol": "DevicePin.modifiedAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/EventType.swift",
- "line": 12,
- "symbol": "EventType",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/EventType.swift",
- "line": 174,
- "symbol": "EventType.metadataInstanceCreated",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
- "line": 11,
- "symbol": "FileRepresentationHint",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
- "line": 94,
- "symbol": "FileRepresentation.Status",
- "symbol_kind": "source.lang.swift.decl.struct",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/FileRepresentation.swift",
- "line": 95,
- "symbol": "FileRepresentation.Status.state",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
- "line": 47,
- "symbol": "GroupMembership",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
- "line": 49,
- "symbol": "GroupMembership.ConfigurablePermissions",
- "symbol_kind": "source.lang.swift.decl.struct",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
- "line": 50,
- "symbol": "GroupMembership.ConfigurablePermissions.canRunReports",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
- "line": 51,
- "symbol": "GroupMembership.ConfigurablePermissions.canInstantLogin",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
- "line": 52,
- "symbol": "GroupMembership.ConfigurablePermissions.canCreateAccounts",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/GroupMembership.swift",
- "line": 53,
- "symbol": "GroupMembership.ConfigurablePermissions.canEditAccounts",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
- "line": 15,
- "symbol": "LegalHoldPolicy.AssignmentCounts.user",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
- "line": 16,
- "symbol": "LegalHoldPolicy.AssignmentCounts.folder",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
- "line": 17,
- "symbol": "LegalHoldPolicy.AssignmentCounts.file",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicy.swift",
- "line": 18,
- "symbol": "LegalHoldPolicy.AssignmentCounts.fileVersion",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
- "line": 15,
- "symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
- "line": 16,
- "symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.file(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
- "line": 17,
- "symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.fileVersion(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
- "line": 18,
- "symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.folder(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
- "line": 19,
- "symbol": "LegalHoldPolicyAssignmentItem.AssignmentItemType.user(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/LegalHoldPolicyAssignmentItem.swift",
- "line": 22,
- "symbol": "LegalHoldPolicyAssignmentItem.itemValue",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
- "line": 11,
- "symbol": "RecentItem",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
- "line": 68,
- "symbol": "RecentItem.type",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
- "line": 70,
- "symbol": "RecentItem.interactionType",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
- "line": 72,
- "symbol": "RecentItem.interactedAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
- "line": 74,
- "symbol": "RecentItem.item",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RecentItem.swift",
- "line": 76,
- "symbol": "RecentItem.interactionSharedLink",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RetentionPolicyAssignment.swift",
- "line": 13,
- "symbol": "RetentionPolicyAssignment",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RetentionPolicyAssignment.swift",
- "line": 32,
- "symbol": "RetentionPolicyAssignment.filterFields",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/RetentionPolicyEntry.swift",
- "line": 11,
- "symbol": "RetentionPolicyEntry",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
- "line": 17,
- "symbol": "SharedItem.SharedItemType",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
- "line": 18,
- "symbol": "SharedItem.SharedItemType.file(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
- "line": 19,
- "symbol": "SharedItem.SharedItemType.folder(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
- "line": 20,
- "symbol": "SharedItem.SharedItemType.webLink(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/SharedItem.swift",
- "line": 23,
- "symbol": "SharedItem.itemValue",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
- "line": 10,
- "symbol": "StoragePolicy",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
- "line": 16,
- "symbol": "StoragePolicy.type",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
- "line": 18,
- "symbol": "StoragePolicy.id",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicy.swift",
- "line": 20,
- "symbol": "StoragePolicy.name",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 10,
- "symbol": "StoragePolicyAssignment",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 14,
- "symbol": "StoragePolicyAssignment.AssignedTo.type",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 15,
- "symbol": "StoragePolicyAssignment.AssignedTo.id",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 22,
- "symbol": "StoragePolicyAssignment.type",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 24,
- "symbol": "StoragePolicyAssignment.id",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 26,
- "symbol": "StoragePolicyAssignment.storagePolicy",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/StoragePolicyAssignment.swift",
- "line": 28,
- "symbol": "StoragePolicyAssignment.assignedTo",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 11,
- "symbol": "TaskCompletionRule",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 12,
- "symbol": "TaskCompletionRule.allAssignees",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 13,
- "symbol": "TaskCompletionRule.anyAssignee",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 14,
- "symbol": "TaskCompletionRule.customValue(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 44,
- "symbol": "TaskAction",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 45,
- "symbol": "TaskAction.review",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 46,
- "symbol": "TaskAction.complete",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Task.swift",
- "line": 47,
- "symbol": "TaskAction.customValue(_:)",
- "symbol_kind": "source.lang.swift.decl.enumelement",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/TaskItem.swift",
- "line": 11,
- "symbol": "TaskItem",
- "symbol_kind": "source.lang.swift.decl.enum",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/TaskItem.swift",
- "line": 44,
- "symbol": "TaskItem",
- "symbol_kind": "source.lang.swift.decl.extension",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/TermsOfService.swift",
- "line": 21,
- "symbol": "TermsOfService.id",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
- "line": 13,
- "symbol": "UploadPartDescription.partId",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
- "line": 14,
- "symbol": "UploadPartDescription.offset",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
- "line": 15,
- "symbol": "UploadPartDescription.size",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadPart.swift",
- "line": 16,
- "symbol": "UploadPartDescription.sha1",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
- "line": 16,
- "symbol": "UploadSession.UploadSessionEndpoints.listParts",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
- "line": 17,
- "symbol": "UploadSession.UploadSessionEndpoints.commit",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
- "line": 18,
- "symbol": "UploadSession.UploadSessionEndpoints.logEvent",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
- "line": 19,
- "symbol": "UploadSession.UploadSessionEndpoints.uploadPart",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
- "line": 20,
- "symbol": "UploadSession.UploadSessionEndpoints.status",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/UploadSession.swift",
- "line": 21,
- "symbol": "UploadSession.UploadSessionEndpoints.abort",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Watermark.swift",
- "line": 16,
- "symbol": "Watermark.resourceKey",
- "symbol_kind": "source.lang.swift.decl.var.static",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Watermark.swift",
- "line": 18,
- "symbol": "Watermark.imprintKey",
- "symbol_kind": "source.lang.swift.decl.var.static",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Watermark.swift",
- "line": 19,
- "symbol": "Watermark.defaultImprint",
- "symbol_kind": "source.lang.swift.decl.var.static",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 8,
- "symbol": "WebLink.Permissions.canRename",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 9,
- "symbol": "WebLink.Permissions.canDelete",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 10,
- "symbol": "WebLink.Permissions.canComment",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 11,
- "symbol": "WebLink.Permissions.canShare",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 12,
- "symbol": "WebLink.Permissions.canSetShareAccess",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 26,
- "symbol": "WebLink.sequenceId",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 27,
- "symbol": "WebLink.etag",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 32,
- "symbol": "WebLink.createdBy",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 33,
- "symbol": "WebLink.createdAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 34,
- "symbol": "WebLink.modifiedAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 39,
- "symbol": "WebLink.itemStatus",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 40,
- "symbol": "WebLink.trashedAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 41,
- "symbol": "WebLink.purgedAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 42,
- "symbol": "WebLink.sharedLink",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 43,
- "symbol": "WebLink.pathCollection",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 44,
- "symbol": "WebLink.modifiedBy",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 45,
- "symbol": "WebLink.ownedBy",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/WebLink.swift",
- "line": 46,
- "symbol": "WebLink.permissions",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 11,
- "symbol": "Webhook",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 256,
- "symbol": "Webhook.type",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 263,
- "symbol": "Webhook.target",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 265,
- "symbol": "Webhook.createdBy",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 267,
- "symbol": "Webhook.createdAt",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 269,
- "symbol": "Webhook.address",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Responses/Webhook.swift",
- "line": 271,
- "symbol": "Webhook.triggers",
- "symbol_kind": "source.lang.swift.decl.var.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Sessions/OAuth2/OAuth2Session.swift",
- "line": 11,
- "symbol": "OAuth2Session",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Sessions/OAuth2/OAuth2Session.swift",
- "line": 64,
- "symbol": "OAuth2Session.refreshToken(completion:)",
- "symbol_kind": "source.lang.swift.decl.function.method.instance",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/Sessions/SingleToken/SingleTokenSession.swift",
- "line": 11,
- "symbol": "SingleTokenSession",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/TokenStore/KeychainTokenStore.swift",
- "line": 14,
- "symbol": "KeychainTokenStore",
- "symbol_kind": "source.lang.swift.decl.class",
- "warning": "undocumented"
- },
- {
- "file": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk/Sources/TokenStore/KeychainTokenStore.swift",
- "line": 17,
- "symbol": "KeychainTokenStore.init()",
- "symbol_kind": "source.lang.swift.decl.function.method.instance",
- "warning": "undocumented"
- }
- ],
- "source_directory": "/Users/sgarlanka/Documents/SDKs/iOS/box-ios-sdk"
-}
\ No newline at end of file
diff --git a/docs/usage/getting-started.md b/docs/usage/getting-started.md
deleted file mode 100644
index 88b9d8a12..000000000
--- a/docs/usage/getting-started.md
+++ /dev/null
@@ -1,312 +0,0 @@
-# BoxSDK
-
-[![Platforms](https://img.shields.io/cocoapods/p/BoxSDK.svg)](https://cocoapods.org/pods/BoxSDK)
-[![License](https://img.shields.io/cocoapods/l/BoxSDK.svg)](https://raw.githubusercontent.com/box/box-swift-sdk/master/LICENSE) [![Swift Package Manager](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)
- [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
- [![CocoaPods compatible](https://img.shields.io/cocoapods/v/BoxSDK.svg)](https://cocoapods.org/pods/BoxSDK) [![Build Status](https://travis-ci.com/box/box-swift-sdk.svg?token=4tREKKzQDqwgYX8vMDUk&branch=master)](https://travis-ci.com/box/box-swift-sdk) [![Coverage Status](https://coveralls.io/repos/github/box/box-swift-sdk/badge.svg?t=hF1jxr)](https://coveralls.io/github/box/box-swift-sdk)
-
-Box Swift SDK
-
-- [Requirements](#requirements)
-- [Installing the SDK](#installing-the-sdk)
- - [Carthage](#carthage)
- - [CocoaPods](#cocoapods)
- - [Swift Package Manager](#swift-package-manager)
-- [Getting Started](#getting-started)
-- [Sample Apps](#sample-apps)
- - [OAuth2 Sample App](#oauth2-sample-app)
- - [JWT Auth Sample App](#jwt-auth-sample-app)
-- [Release Definitions](#release-definitions)
-- [Copyright and License](#copyright-and-license)
-
-
-
-
-
-Requirements
-------------------
-
-- iOS 11.0+ / Mac OS X 10.13+ / tvOS 11.0+ / watchOS 4.0+
-- Xcode 10.0+
-
-Installing the SDK
-------------------
-
-### Carthage
-
-__Step 1__: Add to your `Cartfile`
-
-```
-git "https://github.com/box/box-ios-sdk.git" ~> 3.0
-```
-
-__Step 2__: Update dependencies
-
-```shell
-$ carthage update --platform iOS
-```
-
-__Step 3__: Drag the built framework from Carthage/Build/iOS into your project.
-
-For more detailed instructions, please see the [official documentation for Carthage](https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos).
-
-### CocoaPods
-
-__Step 1__: Add to your `Podfile`
-
-```
-pod 'BoxSDK', '~> 3.0'
-```
-
-__Step 2__: Install pod by running the following command in the directory with the `Podfile`
-
-```
-$ pod install
-```
-
-For more detailed instructions, please see the [official document for Cocoapods](https://guides.cocoapods.org/using/using-cocoapods.html).
-
-### Swift Package Manager
-
-#### Importing BoxSDK into Project
-
-__Step 1__: Click on Xcode project file
-
-__Step 2__: Click on Swift Packages and click on the plus to add a package
-
-__Step 3__: Enter the following repository url `https://github.com/box/box-ios-sdk.git` and click next
-
-__Step 4__: Leave the default settings to get the most recent release and click next to finish importing
-
-The process should look like below:
-
-![Import Package](import-sdk-spm.gif)
-
-
-
-#### Adding BoxSDK as a Dependency
-
-For detailed instructions, please see the [official document for SPM](https://swift.org/package-manager/).
-
-Getting Started
----------------
-
-To get started with the SDK, get a Developer Token from the Configuration page of your app in the
-[Box Developer Console][dev-console]. You can use this token to make test calls for your own Box account.
-
-```swift
-import BoxSDK
-
-let client = BoxSDK.getClient(token: "YOUR_DEVELOPER_TOKEN")
-client.users.getCurrentUser() { result in
- switch result {
- case let .error(error):
- print("Error: \(error)")
- case let .success(user):
- print("\(user.name) (\(user.login)) is logged in")
- }
-}
-```
-
-[dev-console]: https://app.box.com/developers/console
-
-The usage docs that show how to make calls to the Box API with the SDK can be found [here](https://github.com/box/box-ios-sdk/tree/master/docs/usage).
-
-The Jazzy docs that show class, method, variable, etc definitions can be found [here](https://opensource.box.com/box-ios-sdk/).
-
-Sample Apps
------------
-
-### OAuth2 Sample App
-
-A sample app using OAuth2 Authentication can be found in the repository [here][oauth2-sample-app]. This app demonstrates
-how to use the SDK to make calls, and can be run directly by entering your own credentials to log in.
-
-[oauth2-sample-app]:
-https://github.com/box/box-ios-sdk/tree/limited-beta-release/SampleApps/OAuth2SampleApp
-
-To execute the sample app:
-__Step 1__: Run carthage
-
-```shell
-$ cd SampleApps/OAuth2SampleApp
-$ carthage update --platform iOS
-```
-
-__Step 2__: Open Xcode Project File
-
-```shell
-$ open OAuth2SampleApp.xcodeproj
-```
-
-__Step 3__: Insert your client ID and client secret
-
-First, find your OAuth2 app's client ID and secret from the [Box Developer Console][dev-console]. Then, add these
-values to the sample app in the `Constants.swift` file in the sample app:
-
-```swift
-static let clientId = "YOUR CLIENT ID GOES HERE"
-static let clientSecret = "YOUR CLIENT SECRET GOES HERE"
-```
-
-__Step 4__: Set redirect URL
-
-Using the same client ID from the previous step, set the redirect URL for your application in the
-[Box Developer Console][dev-console] to `boxsdk-<>://boxsdkoauth2redirect`, where `<>`
-is replaced with your client ID. For example, if your client ID were `vvxff7v61xi7gqveejo8jh9d2z9xhox5` the redirect
-URL should be `boxsdk-vvxff7v61xi7gqveejo8jh9d2z9xhox5://boxsdkoauth2redirect`
-
-__Step 5__: Insert your client ID to receive the redirect in the app
-
-Open the `Info.plist` file in the sample app and find the key under `URL Types --> Item 0 --> URL Schemes --> Item 0`.
-Using the same client ID from the previous step, set the value for Item 0 to
-`boxsdk-<>`, where `<>` is replaced with your client ID. For example, if your client
-ID were `vvxff7v61xi7gqveejo8jh9d2z9xhox5` the redirect URL should be
-`boxsdk-vvxff7v61xi7gqveejo8jh9d2z9xhox5`
-
-![location to add redirect URL scheme in Xcode](redirect-url-scheme.png)
-
-__Step 6__: Run the sample app
-
-### JWT Auth Sample App
-
-A sample app using JWT Authentication can be found in the repository [here][jwt-sample-app]. This app demonstrates how to
-set up JWT authentication with a remote authorization service, and will not run until you provide the code to retrieve
-tokens.
-
-[jwt-sample-app]: https://github.com/box/box-ios-sdk/tree/limited-beta-release/SampleApps/JWTSampleApp
-
-To execute the sample app:
-__Step 1__: Run carthage
-
-```shell
-$ cd SampleApps/JWTSampleApp
-$ carthage update --platform iOS
-```
-
-__Step 2__: Open Xcode Project File
-
-```shell
-$ open JWTSampleApp.xcodeproj
-```
-
-__Step 3__: Insert your client ID and client secret
-
-First, find your OAuth2 app's client ID and secret from the [Box Developer Console][dev-console]. Then, add these
-values to the sample app in the `Constants.swift` file in the sample app:
-
-```swift
-static let clientId = "YOUR CLIENT ID GOES HERE"
-static let clientSecret = "YOUR CLIENT SECRET GOES HERE"
-```
-
-__Step 4__: Add code for retrieving access tokens
-
-In the `ViewController.swift` file in the sample app, edit the
-`obtainJWTTokenFromExternalSources()` method:
-
-```swift
-func obtainJWTTokenFromExternalSources() -> DelegatedAuthClosure {
- return { uniqueID, completion in
- #error("Obtain a JWT Token from your own service or a Developer Token for your app in the Box Developer Console at https://app.box.com/developers/console and return it in the completion.")
- // The code below is an example implementation of the delegate function
- // Please provide your own implementation
-
- // ...
- }
-}
-```
-
-__Step 5__: Run the sample app
-
-
-## Release Definitions
-
-Starting Oct 19th, 2019 the Box Swift SDK for iOS will be available for general use. This implies all Box developers will be able to use the SDK to build native iOS applications on Box. Between now and the next couple of months, we will be making frequent updates to the SDK based on feedback from our customers, and this document aims to set expectations with respect to:
-
-1. the various release types you will see over the next few months, what they mean and how to identify them
-1. support policy for each of the release types
-
-Between now and the next couple of months, the Box Swift SDK for iOS releases will be one of the following types:
-
-- [Release Candidate (RC)](#release-candidate-rc)
-- [Current Release](#current-release)
-- [Long Term Support](#long-term-support)
-
-### Release Candidate (RC)
-
-The initial releases of the SDK starting Oct 19th will be Release Candidate (RC). This means (1) the core functionality is present and tested, (2) additional functionality from this point on will be considered improvements or enhancements based on customer feedback. RC releases are usually more frequent (every few weeks), followed shortly by a current release. If you plan to use an RC release, we recommend:
-
-- that you don't use it for production workloads (If that is unavoidable, we recommend upgrading to the Current Release version once it's ready.)
-- that you create a plan to keep your application on the latest RC release version at all times (since older RC releases are considered "out of support" as soon as a new RC release is released)
-
-Also, RC releases may carry breaking changes from the previous release and we advise developers to test their application adequately with the new RC release before adopting it.
-
-The idea behind releasing RC releases is to rapidly iterate on the SDK (bug fixes, feature tweaks, etc.) to get it to a production-ready state, and typically we don't expect to have the SDK in the RC phase for more than a month.
-
-> #### Support for RC releases
->
-> A RC release
->
-> - is Considered [Active](#active) when released
-> - transitions to [End-of-life](#end-of-life) when the next release becomes Active
-
-
-### Current Release
-
-A Current Release is considered more stable that a Release Candidate Release and for that reason we expect less frequent releases of a Current Release. We typically expect to refresh Current Releases approximately every 3 months (could be shorter or longer depending on the criticality of the contents of the release).
-
-A new Current Release will usually carry new functionality, bug fixes and may contain breaking changes. We will call out all breaking changes (if any) in the Release Notes section of every Current Release, and we advise developers to test their application adequately before adopting in for production use.
-
-A Current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Current releases are not intended for long-term use, and will only receive enough support after the next release becomes available to allow for a smooth transition to the new version.
-
-
-> #### Support for Current Release
->
-> A Current Release
->
-> - is Considered [Active](#active) when released
-> - transitions to [Maintenance](#maintenance) 3 months after it becomes Active, or when the next release becomes Active, whichever is later
-> - reaches [End-of-life](#end-of-life) 6 months after it becomes Active, or 3 months after the next release becomes Active, whichever is later
-
-
-### Long Term Support
-
-A Long-Term Support (LTS) release is one which we plan to guarantee compatibility with for an extended period of time. The public interfaces of the SDK should not be changed in ways that would break customers’ application, and the release should continue to receive at least bug fixes for its entire lifecycle. We expect to refresh Long Term Release version every 18 - 24 months.
-
-For the above reasons, we recommend all developers who do not intend to make frequent updates (~every 6 - 12 months) to their application, only use a Long Term Release version of the SDK.
-
-> #### Support for Long Term Release
->
-> A Long Term Release
->
-> - is considered [Active](#active) when released
-> - transitions to [Maintenance](#maintenance) 1 year after it becomes Active, or when the next release becomes Active, whichever is later
-> - reaches [End-of-life](#end-of-life) 2 years after it becomes Active, or 1 year after the next LTS release becomes Active, whichever is later
-
-
-### Support Phases
-
-#### Active
-
-Once a release is considered ready for release, a new version is cut and the release enters the Active phase. However, new features may be added to the SDK, including support for new API endpoints.
-
-#### Maintenance
-
-After a time, the release is no longer under active development, but customers may still be depending on it. At this time, we consider the release to be in Maintenance phase; generally, only bug fixes will be considered for inclusion in new versions. We may of course opt to include new functionality based on customer demand, but in general customers should expect that the SDK feature set will be mostly frozen for the remainder of its lifecycle.
-
-#### End-of-life
-
-After a release is no longer being supported by Box, it enters End-of-life (EOL) and no further changes should be expected by customers. Customers must upgrade to a newer release if they want to receive support.
-
-
-Copyright and License
--------
-
-Copyright 2019 Box, Inc. All rights reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
-
-https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\ No newline at end of file