diff --git a/openapi.json b/openapi.json index 913a9a2a..2aa5c8cf 100644 --- a/openapi.json +++ b/openapi.json @@ -14,12 +14,12 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "8f64ba5ffc" + "x-box-commit-hash": "eff357f39b" }, "servers": [ { "url": "https://api.box.com/2.0", - "description": "Box Platform API server" + "description": "Box Platform API server." } ], "paths": { @@ -114,7 +114,7 @@ "servers": [ { "url": "https://account.box.com/api/oauth2", - "description": "Server for client-side authentication" + "description": "Server for client-side authentication." } ], "tags": [ @@ -173,7 +173,7 @@ "servers": [ { "url": "https://api.box.com", - "description": "Server for server-side authentication" + "description": "Server for server-side authentication." } ], "tags": [ @@ -232,7 +232,7 @@ "servers": [ { "url": "https://api.box.com", - "description": "Server for server-side authentication" + "description": "Server for server-side authentication." } ], "tags": [ @@ -285,7 +285,7 @@ "servers": [ { "url": "https://api.box.com", - "description": "Server for server-side authentication" + "description": "Server for server-side authentication." } ], "tags": [ @@ -350,7 +350,7 @@ { "name": "x-rep-hints", "in": "header", - "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", + "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`.", "required": false, "schema": { "type": "string", @@ -478,10 +478,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } @@ -619,10 +619,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" }, @@ -744,16 +744,16 @@ "type": "array", "items": { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } @@ -993,7 +993,7 @@ { "name": "application_type", "in": "query", - "description": "If given, only return app items for this application type", + "description": "If given, only return app items for this application type.", "required": false, "schema": { "type": "string", @@ -1079,7 +1079,7 @@ { "name": "version", "in": "query", - "description": "The file version to download", + "description": "The file version to download.", "required": false, "schema": { "type": "string" @@ -1103,7 +1103,7 @@ "content": { "application/octet-stream": { "schema": { - "description": "The binary content of the file", + "description": "The binary content of the file.", "type": "string", "format": "binary" } @@ -1114,7 +1114,7 @@ "description": "If the file is not ready to be downloaded yet `Retry-After` header will\nbe returned indicating the time in seconds after which the file will\nbe available for the client to download.\n\nThis response can occur when the file was uploaded immediately before the\ndownload request.", "headers": { "Retry-After": { - "description": "The time in seconds after which to retry the download", + "description": "The time in seconds after which to retry the download.", "schema": { "type": "integer" } @@ -1125,7 +1125,7 @@ "description": "If the file is available for download the response will include a\n`Location` header for the file on `dl.boxcloud.com`.\n\nThe `dl.boxcloud.com` URL is not persistent and clients will need\nto follow the redirect to actually download the file.", "headers": { "Location": { - "description": "A pointer to the download URL", + "description": "A pointer to the download URL.", "schema": { "type": "string", "format": "url" @@ -1279,7 +1279,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1303,12 +1303,12 @@ "type": "object", "properties": { "name": { - "description": "The name for the file", + "description": "The name for the file.", "type": "string", "example": "File.mp4" }, "size": { - "description": "The size of the file in bytes", + "description": "The size of the file in bytes.", "type": "integer", "format": "int32", "example": 1024 @@ -1317,17 +1317,17 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } } }, { - "description": "The parent folder to upload the file to" + "description": "The parent folder to upload the file to." } ] } @@ -1419,7 +1419,7 @@ "example": "Photo.png" }, "parent": { - "description": "The parent folder to upload the file to", + "description": "The parent folder to upload the file to.", "type": "object", "properties": { "id": { @@ -1520,7 +1520,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1545,13 +1545,13 @@ "example": "0" }, "file_size": { - "description": "The total number of bytes of the file to be uploaded", + "description": "The total number of bytes of the file to be uploaded.", "type": "integer", "format": "int64", "example": 104857600 }, "file_name": { - "description": "The name of new file", + "description": "The name of new file.", "type": "string", "example": "Project.mov" } @@ -1577,7 +1577,7 @@ } }, "400": { - "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `missing_destination`: No `folder_id` was provided\n* `invalid_folder_id`: `folder_id` is not valid\n* `item_name_invalid`: `file_name` is not valid\n* `missing_file_size`: `file_size` was not provided\n* `invalid_file_size`: `file_size` was not a valid number\n* `file_size_too_small`: `file_size` is below minimum file size for\n uploads via this API\n* `missing_file_name`: `file_name` was not provided", + "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `missing_destination`: No `folder_id` was provided.\n* `invalid_folder_id`: `folder_id` is not valid.\n* `item_name_invalid`: `file_name` is not valid.\n* `missing_file_size`: `file_size` was not provided.\n* `invalid_file_size`: `file_size` was not a valid number.\n* `file_size_too_small`: `file_size` is below minimum file size for\n uploads via this API.\n* `missing_file_name`: `file_name` was not provided.", "content": { "application/json": { "schema": { @@ -1587,7 +1587,7 @@ } }, "403": { - "description": "Returns an error if the operation is not allowed for some reason.\n\n* `storage_limit_exceeded`: Account storage limit reached", + "description": "Returns an error if the operation is not allowed for some reason.\n\n* `storage_limit_exceeded`: Account storage limit reached.", "content": { "application/json": { "schema": { @@ -1631,7 +1631,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1663,13 +1663,13 @@ "type": "object", "properties": { "file_size": { - "description": "The total number of bytes of the file to be uploaded", + "description": "The total number of bytes of the file to be uploaded.", "type": "integer", "format": "int64", "example": 104857600 }, "file_name": { - "description": "The optional new name of new file", + "description": "The optional new name of new file.", "type": "string", "example": "Project.mov" } @@ -1717,7 +1717,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1768,7 +1768,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -1800,7 +1800,7 @@ { "name": "digest", "in": "header", - "description": "The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", + "description": "The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "required": true, "schema": { "type": "string" @@ -1822,7 +1822,7 @@ "content": { "application/octet-stream": { "schema": { - "description": "The binary content of the file", + "description": "The binary content of the file.", "type": "string", "format": "binary" } @@ -1885,7 +1885,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -1934,7 +1934,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -2016,7 +2016,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -2085,7 +2085,7 @@ "type": "object", "properties": { "parts": { - "description": "The list details for the uploaded parts", + "description": "The list details for the uploaded parts.", "type": "array", "items": { "$ref": "#/components/schemas/UploadPart" @@ -2156,7 +2156,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -2281,7 +2281,7 @@ } }, "404": { - "description": "Returns an error if either the source file or the destination\nfolder could not be found, or the authenticated user does not\nhave access to either.\n\n* `not_found` when the authenticated user does not have access\n to the source file or the destination folder", + "description": "Returns an error if either the source file or the destination\nfolder could not be found, or the authenticated user does not\nhave access to either.\n\n* `not_found` when the authenticated user does not have access\n to the source file or the destination folder.", "content": { "application/json": { "schema": { @@ -2291,7 +2291,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use` when a folder with the same name already\n exists.", + "description": "`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in process.\n\nThe operation can be retried at a later point.\n\n`item_name_in_use` when a folder with the same name already\nexists.", "content": { "application/json": { "schema": { @@ -2336,7 +2336,7 @@ { "name": "extension", "in": "path", - "description": "The file format for the thumbnail", + "description": "The file format for the thumbnail.", "required": true, "schema": { "type": "string", @@ -2350,7 +2350,7 @@ { "name": "min_height", "in": "query", - "description": "The minimum height of the thumbnail", + "description": "The minimum height of the thumbnail.", "schema": { "type": "integer", "maximum": 320, @@ -2361,7 +2361,7 @@ { "name": "min_width", "in": "query", - "description": "The minimum width of the thumbnail", + "description": "The minimum width of the thumbnail.", "schema": { "type": "integer", "maximum": 320, @@ -2372,7 +2372,7 @@ { "name": "max_height", "in": "query", - "description": "The maximum height of the thumbnail", + "description": "The maximum height of the thumbnail.", "required": false, "schema": { "type": "integer", @@ -2384,7 +2384,7 @@ { "name": "max_width", "in": "query", - "description": "The maximum width of the thumbnail", + "description": "The maximum width of the thumbnail.", "required": false, "schema": { "type": "integer", @@ -2400,14 +2400,14 @@ "content": { "image/jpg": { "schema": { - "description": "The thumbnail", + "description": "The thumbnail.", "type": "string", "format": "binary" } }, "image/png": { "schema": { - "description": "The thumbnail", + "description": "The thumbnail.", "type": "string", "format": "binary" } @@ -2466,7 +2466,7 @@ } }, "404": { - "description": "Returned if the file is not found, or the user does not\nhave access to the file, or for additional reasons.\n\n* `preview_cannot_be_generated` - Box does not support thumbnails\n for this type of file", + "description": "Returned if the file is not found, or the user does not\nhave access to the file, or for additional reasons.\n\n* `preview_cannot_be_generated` - Box does not support thumbnails\n for this type of file.", "content": { "application/json": { "schema": { @@ -2982,7 +2982,7 @@ { "name": "file_version_id", "in": "path", - "description": "The ID of the file version", + "description": "The ID of the file version.", "required": true, "schema": { "type": "string" @@ -3035,7 +3035,7 @@ { "name": "file_version_id", "in": "path", - "description": "The ID of the file version", + "description": "The ID of the file version.", "required": true, "schema": { "type": "string" @@ -3091,7 +3091,7 @@ { "name": "file_version_id", "in": "path", - "description": "The ID of the file version", + "description": "The ID of the file version.", "required": true, "schema": { "type": "string" @@ -3103,7 +3103,7 @@ "content": { "application/json": { "schema": { - "description": "The file version to be\nrestored", + "description": "The file version to be\nrestored.", "type": "object", "properties": { "trashed_at": { @@ -3184,16 +3184,16 @@ "content": { "application/json": { "schema": { - "description": "The file version to promote", + "description": "The file version to promote.", "type": "object", "properties": { "id": { - "description": "The file version ID", + "description": "The file version ID.", "type": "string", "example": "11446498" }, "type": { - "description": "The type to promote", + "description": "The type to promote.", "type": "string", "example": "file_version", "enum": [ @@ -3493,7 +3493,7 @@ ], "properties": { "op": { - "description": "`replace`", + "description": "The value will always be `replace`.", "type": "string", "example": "replace", "enum": [ @@ -3655,7 +3655,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -3669,7 +3669,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -3752,7 +3752,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -3766,7 +3766,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -3874,7 +3874,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -3888,7 +3888,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -4004,7 +4004,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -4018,7 +4018,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -4255,7 +4255,7 @@ "description": "An operation that replaces an existing card.", "properties": { "op": { - "description": "`replace`", + "description": "The value will always be `replace`.", "type": "string", "example": "replace", "enum": [ @@ -4308,7 +4308,7 @@ } }, "404": { - "description": "The requested file could not be found", + "description": "The requested file could not be found.", "content": { "application/json": { "schema": { @@ -4467,7 +4467,7 @@ "type": "object", "properties": { "watermark": { - "description": "The watermark to imprint on the file", + "description": "The watermark to imprint on the file.", "type": "object", "properties": { "imprint": { @@ -5142,10 +5142,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } @@ -5193,7 +5193,7 @@ } }, "409": { - "description": "* Returned an error if there is a folder with the same name\n in the destination folder.\n\n* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.", + "description": "Returned an error if there is a folder with the same name\nin the destination folder.\n\n`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in process.\n\nThe operation can be retried at a later point.", "content": { "application/json": { "schema": { @@ -5275,7 +5275,7 @@ "example": "New Folder" }, "description": { - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "type": "string", "example": "Legal contracts for the new ACME deal", "maxLength": 256, @@ -5301,10 +5301,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" }, @@ -5375,7 +5375,7 @@ { "title": "Folder upload email", "type": "object", - "description": "The Write Folder Upload Email object", + "description": "The Write Folder Upload Email object.", "properties": { "access": { "description": "When this parameter has been set, users can email files\nto the email address that has been automatically\ncreated for this folder.\n\nTo create an email address, set this property either when\ncreating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email\naddresses for collaborators will be accepted. This includes\nany email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email\naddress.", @@ -5417,16 +5417,16 @@ "type": "array", "items": { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } @@ -5486,7 +5486,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in progress.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if a folder with the name\n already exists in the parent folder.", + "description": "`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in progress.\n\nThe operation can be retried at a later point.\n\n`item_name_in_use`: Returned if a folder with the name\nalready exists in the parent folder.", "content": { "application/json": { "schema": { @@ -5603,7 +5603,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if the folder\n is locked due to another move, copy, delete or restore\n operation in progress.\n\n The operation can be retried at a later point.", + "description": "`operation_blocked_temporary`: Returned if the folder\nis locked due to another move, copy, delete or restore\noperation in progress.\n\nThe operation can be retried at a later point.", "content": { "application/json": { "schema": { @@ -5691,7 +5691,7 @@ { "name": "application_type", "in": "query", - "description": "If given, returns only app items for this application type", + "description": "If given, returns only app items for this application type.", "required": false, "schema": { "type": "string", @@ -5959,7 +5959,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of parent folder", + "description": "The ID of parent folder.", "type": "string", "example": "0" } @@ -5973,7 +5973,7 @@ { "title": "Folder upload email", "type": "object", - "description": "The Write Folder Upload Email object", + "description": "The Write Folder Upload Email object.", "properties": { "access": { "description": "When this parameter has been set, users can email files\nto the email address that has been automatically\ncreated for this folder.\n\nTo create an email address, set this property either when\ncreating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email\naddresses for collaborators will be accepted. This includes\nany email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email\naddress.", @@ -6044,7 +6044,7 @@ } }, "404": { - "description": "Returns an error if the parent folder could not be found,\nor the authenticated user does not have access to the parent\nfolder.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", + "description": "Returns an error if the parent folder could not be found,\nor the authenticated user does not have access to the parent\nfolder.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder.", "content": { "application/json": { "schema": { @@ -6054,7 +6054,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if a folder with the name\n already exists in the parent folder.", + "description": "`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in process.\n\nThe operation can be retried at a later point.\n\n`item_name_in_use`: Returned if a folder with the name\nalready exists in the parent folder.", "content": { "application/json": { "schema": { @@ -6134,7 +6134,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of parent folder", + "description": "The ID of parent folder.", "type": "string", "example": "0" } @@ -6187,7 +6187,7 @@ } }, "404": { - "description": "Returns an error if either the source or destination folder\ncould not be found, or the authenticated user does not\nhave access to either folders.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", + "description": "Returns an error if either the source or destination folder\ncould not be found, or the authenticated user does not\nhave access to either folders.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder.", "content": { "application/json": { "schema": { @@ -6704,7 +6704,7 @@ ], "properties": { "op": { - "description": "`replace`", + "description": "The value will always be `replace`.", "type": "string", "example": "replace", "enum": [ @@ -6868,7 +6868,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -6882,7 +6882,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -6966,7 +6966,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -6980,7 +6980,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -7089,7 +7089,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -7103,7 +7103,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -7220,7 +7220,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -7234,7 +7234,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -7393,7 +7393,7 @@ ], "responses": { "200": { - "description": "Returns a list of items that have been deleted", + "description": "Returns a list of items that have been deleted.", "content": { "application/json": { "schema": { @@ -7508,7 +7508,7 @@ "type": "object", "properties": { "watermark": { - "description": "The watermark to imprint on the folder", + "description": "The watermark to imprint on the folder.", "type": "object", "properties": { "imprint": { @@ -7591,7 +7591,7 @@ "description": "An empty response will be returned when the watermark\nwas successfully deleted." }, "404": { - "description": "Returns an error if the folder did not have\na watermark applied to it", + "description": "Returns an error if the folder did not have\na watermark applied to it.", "content": { "application/json": { "schema": { @@ -8048,7 +8048,7 @@ "example": "Sensitive information that must not be shared." }, "colorID": { - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -8184,7 +8184,7 @@ "example": "Sensitive information that must not be shared." }, "colorID": { - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -8264,7 +8264,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -8278,7 +8278,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -8341,7 +8341,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -8355,7 +8355,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -8504,7 +8504,7 @@ } }, "404": { - "description": "The requested template could not be found", + "description": "The requested template could not be found.", "content": { "application/json": { "schema": { @@ -8537,7 +8537,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -8551,7 +8551,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -8609,7 +8609,7 @@ { "name": "template_id", "in": "path", - "description": "The ID of the template", + "description": "The ID of the template.", "required": true, "schema": { "type": "string" @@ -8726,7 +8726,7 @@ "get": { "operationId": "get_metadata_templates_enterprise", "summary": "List all metadata templates for enterprise", - "description": "Used to retrieve all metadata templates created to be used specifically within\nthe user's enterprise", + "description": "Used to retrieve all metadata templates created to be used specifically within\nthe user's enterprise.", "parameters": [ { "name": "marker", @@ -9074,7 +9074,7 @@ "example": "Sensitive information" }, "colorID": { - "description": "An identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may\nchange without notice. Currently, the color\nmappings are as follows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may\nchange without notice. Currently, the color\nmappings are as follows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -9198,7 +9198,7 @@ ], "responses": { "200": { - "description": "Returns a list of metadata cascade policies", + "description": "Returns a list of metadata cascade policies.", "content": { "application/json": { "schema": { @@ -9294,7 +9294,7 @@ }, "responses": { "201": { - "description": "Returns a new of metadata cascade policy", + "description": "Returns a new of metadata cascade policy.", "content": { "application/json": { "schema": { @@ -9379,7 +9379,7 @@ ], "responses": { "200": { - "description": "Returns a metadata cascade policy", + "description": "Returns a metadata cascade policy.", "content": { "application/json": { "schema": { @@ -9697,7 +9697,7 @@ "type": "object", "properties": { "message": { - "description": "The text of the comment to update", + "description": "The text of the comment to update.", "type": "string", "example": "Review completed!" } @@ -9816,7 +9816,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the item", + "description": "The ID of the item.", "type": "string", "example": "11446498" }, @@ -9882,7 +9882,7 @@ { "name": "collaboration_id", "in": "path", - "description": "The ID of the collaboration", + "description": "The ID of the collaboration.", "required": true, "schema": { "type": "string" @@ -9943,7 +9943,7 @@ { "name": "collaboration_id", "in": "path", - "description": "The ID of the collaboration", + "description": "The ID of the collaboration.", "required": true, "schema": { "type": "string" @@ -9973,7 +9973,7 @@ ] }, "status": { - "description": "\nSet the status of a `pending` collaboration invitation,\neffectively accepting, or rejecting the invite.", + "description": "Set the status of a `pending` collaboration invitation,\neffectively accepting, or rejecting the invite.", "type": "string", "example": "accepted", "enum": [ @@ -10049,7 +10049,7 @@ { "name": "collaboration_id", "in": "path", - "description": "The ID of the collaboration", + "description": "The ID of the collaboration.", "required": true, "schema": { "type": "string" @@ -10087,7 +10087,7 @@ { "name": "status", "in": "query", - "description": "The status of the collaborations to retrieve", + "description": "The status of the collaborations to retrieve.", "required": true, "schema": { "type": "string", @@ -10212,7 +10212,7 @@ "type": "object", "properties": { "type": { - "description": "The type of the item that this collaboration will be\ngranted access to", + "description": "The type of the item that this collaboration will be\ngranted access to.", "type": "string", "example": "file", "enum": [ @@ -10221,7 +10221,7 @@ ] }, "id": { - "description": "The ID of the item that will be granted access to", + "description": "The ID of the item that will be granted access to.", "type": "string", "example": "11446498" } @@ -10514,7 +10514,7 @@ { "name": "type", "in": "query", - "description": "Limits the search results to any items of this type. This\nparameter only takes one value. By default the API returns\nitems that match any of these types.\n\n* `file` - Limits the search results to files\n* `folder` - Limits the search results to folders\n* `web_link` - Limits the search results to web links, also known\n as bookmarks", + "description": "Limits the search results to any items of this type. This\nparameter only takes one value. By default the API returns\nitems that match any of these types.\n\n* `file` - Limits the search results to files,\n* `folder` - Limits the search results to folders,\n* `web_link` - Limits the search results to web links, also known\n as bookmarks.", "required": false, "schema": { "type": "string", @@ -10616,7 +10616,7 @@ { "name": "include_recent_shared_links", "in": "query", - "description": "Defines whether the search results should include any items\nthat the user recently accessed through a shared link.\n\nWhen this parameter has been set to true,\nthe format of the response of this API changes to return\na list of [Search Results with\nShared Links](r://search_results_with_shared_links)", + "description": "Defines whether the search results should include any items\nthat the user recently accessed through a shared link.\n\nWhen this parameter has been set to true,\nthe format of the response of this API changes to return\na list of [Search Results with\nShared Links](r://search_results_with_shared_links).", "required": false, "schema": { "type": "boolean", @@ -10769,12 +10769,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the file", + "description": "The ID of the file.", "type": "string", "example": "11446498" }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -10784,7 +10784,7 @@ } }, "action": { - "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or\nrejected\n* `complete` defines a general task which can be completed", + "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or,\nrejected\n* `complete` defines a general task which can be completed.", "type": "string", "example": "review", "default": "review", @@ -10958,7 +10958,7 @@ "type": "object", "properties": { "action": { - "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or\nrejected\n* `complete` defines a general task which can be completed", + "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or\nrejected,\n* `complete` defines a general task which can be completed.", "type": "string", "example": "review", "enum": [ @@ -10993,7 +10993,7 @@ }, "responses": { "200": { - "description": "Returns the updated task object", + "description": "Returns the updated task object.", "content": { "application/json": { "schema": { @@ -11176,7 +11176,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the task", + "description": "The ID of the task.", "type": "string", "example": "11446498" }, @@ -11505,7 +11505,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows.\n\n`shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -11787,7 +11787,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -11994,7 +11994,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -12239,7 +12239,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows.\n\n`shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -12523,7 +12523,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -12730,7 +12730,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -12960,7 +12960,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of parent folder", + "description": "The ID of parent folder.", "type": "string", "example": "0" } @@ -13119,10 +13119,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } @@ -13226,10 +13226,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" }, @@ -13514,7 +13514,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows.\n\n`shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -13796,7 +13796,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -14003,7 +14003,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -14220,7 +14220,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is `shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is `shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -14418,7 +14418,7 @@ "type": "object", "properties": { "name": { - "description": "The name of the user", + "description": "The name of the user.", "type": "string", "example": "Aaron Levie", "maxLength": 50 @@ -14434,7 +14434,7 @@ "example": true }, "role": { - "description": "The user’s enterprise role", + "description": "The user’s enterprise role.", "type": "string", "example": "user", "enum": [ @@ -14448,24 +14448,24 @@ "example": "en" }, "is_sync_enabled": { - "description": "Whether the user can use Box Sync", + "description": "Whether the user can use Box Sync.", "type": "boolean", "example": true }, "job_title": { - "description": "The user’s job title", + "description": "The user’s job title.", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { - "description": "The user’s phone number", + "description": "The user’s phone number.", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { - "description": "The user’s address", + "description": "The user’s address.", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 @@ -14484,33 +14484,33 @@ } }, "can_see_managed_users": { - "description": "Whether the user can see other enterprise users in their\ncontact list", + "description": "Whether the user can see other enterprise users in their\ncontact list.", "type": "boolean", "example": true }, "timezone": { - "description": "The user's timezone", + "description": "The user's timezone.", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "is_external_collab_restricted": { - "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise", + "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise.", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { - "description": "Whether to exempt the user from enterprise device limits", + "description": "Whether to exempt the user from enterprise device limits.", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { - "description": "Whether the user must use two-factor authentication", + "description": "Whether the user must use two-factor authentication.", "type": "boolean", "example": true }, "status": { - "description": "The user's account status", + "description": "The user's account status.", "type": "string", "example": "active", "enum": [ @@ -14626,7 +14626,7 @@ "type": "object", "properties": { "user_ids": { - "description": "A list of user IDs", + "description": "A list of user IDs.", "type": "array", "items": { "type": "string" @@ -14637,7 +14637,7 @@ ] }, "user_logins": { - "description": "A list of user logins", + "description": "A list of user logins.", "type": "array", "items": { "type": "string" @@ -14668,7 +14668,7 @@ } }, "400": { - "description": "Returns an error if some of the parameters are\n not valid.\n\n * `Users can not be NULL or EMPTY` when no value is provided\n * `User id format is string` when the provided user id format\n is incorrect\n * `Supported payload format is JSON` when the provided payload\n format is incorrect", + "description": "Returns an error if some of the parameters are\n not valid.\n\n * `Users can not be NULL or EMPTY` when no value is provided.\n * `User id format is string` when the provided user id format\n is incorrect.\n * `Supported payload format is JSON` when the provided payload\n format is incorrect.", "content": { "application/json": { "schema": { @@ -14847,18 +14847,18 @@ "type": "object", "properties": { "enterprise": { - "description": "Set this to `null` to roll the user out of the enterprise\nand make them a free user", + "description": "Set this to `null` to roll the user out of the enterprise\nand make them a free user.", "type": "string", "example": null, "nullable": true }, "notify": { - "description": "Whether the user should receive an email when they\nare rolled out of an enterprise", + "description": "Whether the user should receive an email when they\nare rolled out of an enterprise.", "type": "boolean", "example": true }, "name": { - "description": "The name of the user", + "description": "The name of the user.", "type": "string", "example": "Aaron Levie", "maxLength": 50 @@ -14869,7 +14869,7 @@ "example": "somename@box.com" }, "role": { - "description": "The user’s enterprise role", + "description": "The user’s enterprise role.", "type": "string", "example": "user", "enum": [ @@ -14883,24 +14883,24 @@ "example": "en" }, "is_sync_enabled": { - "description": "Whether the user can use Box Sync", + "description": "Whether the user can use Box Sync.", "type": "boolean", "example": true }, "job_title": { - "description": "The user’s job title", + "description": "The user’s job title.", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { - "description": "The user’s phone number", + "description": "The user’s phone number.", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { - "description": "The user’s address", + "description": "The user’s address.", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 @@ -14913,38 +14913,38 @@ } }, "can_see_managed_users": { - "description": "Whether the user can see other enterprise users in their\ncontact list", + "description": "Whether the user can see other enterprise users in their\ncontact list.", "type": "boolean", "example": true }, "timezone": { - "description": "The user's timezone", + "description": "The user's timezone.", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "is_external_collab_restricted": { - "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise", + "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise.", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { - "description": "Whether to exempt the user from enterprise device limits", + "description": "Whether to exempt the user from enterprise device limits.", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { - "description": "Whether the user must use two-factor authentication", + "description": "Whether the user must use two-factor authentication.", "type": "boolean", "example": true }, "is_password_reset_required": { - "description": "Whether the user is required to reset their password", + "description": "Whether the user is required to reset their password.", "type": "boolean", "example": true }, "status": { - "description": "The user's account status", + "description": "The user's account status.", "type": "string", "example": "active", "enum": [ @@ -15047,7 +15047,7 @@ { "name": "notify", "in": "query", - "description": "Whether the user will receive email notification of\nthe deletion", + "description": "Whether the user will receive email notification of\nthe deletion.", "schema": { "type": "boolean" }, @@ -15056,7 +15056,7 @@ { "name": "force", "in": "query", - "description": "Whether the user should be deleted even if this user\nstill own files", + "description": "Whether the user should be deleted even if this user\nstill own files.", "schema": { "type": "boolean" }, @@ -15107,7 +15107,7 @@ "content": { "image/jpg": { "schema": { - "description": "The avatar", + "description": "The avatar.", "type": "string", "format": "binary" } @@ -15167,7 +15167,7 @@ }, "responses": { "200": { - "description": "* `ok`: Returns the `pic_urls` object with URLs to existing\nuser avatars that were updated.", + "description": "`ok`: Returns the `pic_urls` object with URLs to existing\nuser avatars that were updated.", "content": { "application/json": { "schema": { @@ -15177,7 +15177,7 @@ } }, "201": { - "description": "* `created`: Returns the `pic_urls` object with URLS to user avatars\nuploaded to Box with the request.", + "description": "`created`: Returns the `pic_urls` object with URLS to user avatars\nuploaded to Box with the request.", "content": { "application/json": { "schema": { @@ -15187,7 +15187,7 @@ } }, "400": { - "description": "* `bad_request`: Returns an error when:\n * An image is not included in the request\n * The uploaded file is empty\n * The image size exceeds 1024 * 1024 pixels\n or 1MB\n * The file extension is other than `.jpg` or `.png`.", + "description": "`bad_request`: Returns an error when:\n * An image is not included in the request\n * The uploaded file is empty\n * The image size exceeds 1024 * 1024 pixels or 1MB\n * The file extension is other than `.jpg` or `.png`.", "content": { "application/json": { "schema": { @@ -15197,7 +15197,7 @@ } }, "403": { - "description": "* `forbidden`: Returns an error if the user does not have permissions\nnecessary to upload an avatar or is not activated.", + "description": "`forbidden`: Returns an error if the user does not have permissions\nnecessary to upload an avatar or is not activated.", "content": { "application/json": { "schema": { @@ -15207,7 +15207,7 @@ } }, "404": { - "description": "* `not_found`: Returns an error if the user\ndoes not exist or cannot be found.", + "description": "`not_found`: Returns an error if the user\ndoes not exist or cannot be found.", "content": { "application/json": { "schema": { @@ -15250,10 +15250,10 @@ ], "responses": { "204": { - "description": "* `no_content`: Removes the avatar and returns an empty response." + "description": "`no_content`: Removes the avatar and returns an empty response." }, "403": { - "description": "* `forbidden`: Returned if the user does not have necessary permissions\n or is not activated.", + "description": "`forbidden`: Returned if the user does not have necessary permissions\n or is not activated.", "content": { "application/json": { "schema": { @@ -15263,7 +15263,7 @@ } }, "404": { - "description": "* `not_found`: Returned if the user or user avatar does not exist\n or cannot be found.", + "description": "`not_found`: Returned if the user or user avatar does not exist\n or cannot be found.", "content": { "application/json": { "schema": { @@ -15341,11 +15341,11 @@ "type": "object", "properties": { "owned_by": { - "description": "The user who the folder will be transferred to", + "description": "The user who the folder will be transferred to.", "type": "object", "properties": { "id": { - "description": "The ID of the user who the folder will be\ntransferred to", + "description": "The ID of the user who the folder will be\ntransferred to.", "type": "string", "example": "1232234" } @@ -15656,11 +15656,11 @@ "type": "object", "properties": { "enterprise": { - "description": "The enterprise to invite the user to", + "description": "The enterprise to invite the user to.", "type": "object", "properties": { "id": { - "description": "The ID of the enterprise", + "description": "The ID of the enterprise.", "type": "string", "example": "1232234" } @@ -15670,11 +15670,11 @@ ] }, "actionable_by": { - "description": "The user to invite", + "description": "The user to invite.", "type": "object", "properties": { "login": { - "description": "The login of the invited user", + "description": "The login of the invited user.", "type": "string", "example": "john@example.com" } @@ -15767,7 +15767,7 @@ ], "responses": { "200": { - "description": "Returns an invite object", + "description": "Returns an invite object.", "content": { "application/json": { "schema": { @@ -15942,7 +15942,7 @@ ] }, "member_viewability_level": { - "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", + "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin.\n* `admins_and_members` - all admins and group members.\n* `all_managed_users` - all managed users in the\n enterprise.", "type": "string", "example": "admins_only", "enum": [ @@ -16009,7 +16009,7 @@ "type": "object", "properties": { "group_ids": { - "description": "A list of group IDs", + "description": "A list of group IDs.", "type": "array", "items": { "type": "string" @@ -16039,7 +16039,7 @@ } }, "400": { - "description": "Returns an error if some of the parameters are\nnot valid.\n\n* `Groups can not be NULL or EMPTY` when no value is provided\n* `group id format is string` when the provided group id format\nis incorrect\n* `Supported payload format is JSON` when the provided payload\nformat is incorrect", + "description": "Returns an error if some of the parameters are\nnot valid.\n\n* `Groups can not be NULL or EMPTY` when no value is provided.\n* `group id format is string` when the provided group id format\nis incorrect.\n* `Supported payload format is JSON` when the provided payload\nformat is incorrect.", "content": { "application/json": { "schema": { @@ -16152,7 +16152,7 @@ ], "responses": { "200": { - "description": "Returns the group object", + "description": "Returns the group object.", "content": { "application/json": { "schema": { @@ -16250,7 +16250,7 @@ ] }, "member_viewability_level": { - "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", + "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin.\n* `admins_and_members` - all admins and group members.\n* `all_managed_users` - all managed users in the\n enterprise.", "type": "string", "example": "admins_only", "enum": [ @@ -16512,7 +16512,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the user to add to the group", + "description": "The ID of the user to add to the group.", "type": "string", "example": "1434325" } @@ -16526,7 +16526,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the group to add the user to", + "description": "The ID of the group to add the user to.", "type": "string", "example": "4545523" } @@ -16876,16 +16876,16 @@ "type": "object", "properties": { "target": { - "description": "The item that will trigger the webhook", + "description": "The item that will trigger the webhook.", "type": "object", "properties": { "id": { - "description": "The ID of the item to trigger a webhook", + "description": "The ID of the item to trigger a webhook.", "type": "string", "example": "1231232" }, "type": { - "description": "The type of item to trigger a webhook", + "description": "The type of item to trigger a webhook.", "type": "string", "example": "file", "enum": [ @@ -16896,18 +16896,18 @@ } }, "address": { - "description": "The URL that is notified by this webhook", + "description": "The URL that is notified by this webhook.", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for", + "description": "An array of event names that this webhook is\nto be triggered for.", "type": "array", "items": { "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -16997,7 +16997,7 @@ } }, "404": { - "description": "Returns an error if the target item could\nnot be found", + "description": "Returns an error if the target item could\nnot be found.", "content": { "application/json": { "schema": { @@ -17037,7 +17037,7 @@ "get": { "operationId": "get_webhooks_id", "summary": "Get webhook", - "description": "Retrieves a specific webhook", + "description": "Retrieves a specific webhook.", "parameters": [ { "name": "webhook_id", @@ -17052,7 +17052,7 @@ ], "responses": { "200": { - "description": "Returns a webhook object", + "description": "Returns a webhook object.", "content": { "application/json": { "schema": { @@ -17072,7 +17072,7 @@ } }, "404": { - "description": "Returns an error if the webhook could not be found", + "description": "Returns an error if the webhook could not be found.", "content": { "application/json": { "schema": { @@ -17120,16 +17120,16 @@ "type": "object", "properties": { "target": { - "description": "The item that will trigger the webhook", + "description": "The item that will trigger the webhook.", "type": "object", "properties": { "id": { - "description": "The ID of the item to trigger a webhook", + "description": "The ID of the item to trigger a webhook.", "type": "string", "example": "1231232" }, "type": { - "description": "The type of item to trigger a webhook", + "description": "The type of item to trigger a webhook.", "type": "string", "example": "file", "enum": [ @@ -17140,18 +17140,18 @@ } }, "address": { - "description": "The URL that is notified by this webhook", + "description": "The URL that is notified by this webhook.", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for", + "description": "An array of event names that this webhook is\nto be triggered for.", "type": "array", "items": { "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -17236,7 +17236,7 @@ } }, "404": { - "description": "Returns an error if the target item or webhook\ncould not be found", + "description": "Returns an error if the target item or webhook\ncould not be found.", "content": { "application/json": { "schema": { @@ -17302,7 +17302,7 @@ } }, "404": { - "description": "Returns an error if the webhook could not be found", + "description": "Returns an error if the webhook could not be found.", "content": { "application/json": { "schema": { @@ -17394,7 +17394,7 @@ "type": "object", "properties": { "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -17402,7 +17402,7 @@ ] }, "id": { - "description": "The ID of the file", + "description": "The ID of the file.", "type": "string", "example": "3243244" } @@ -17413,7 +17413,7 @@ "type": "object", "properties": { "type": { - "description": "`file_version`", + "description": "The value will always be `file_version`.", "type": "string", "example": "file_version", "enum": [ @@ -17421,7 +17421,7 @@ ] }, "id": { - "description": "The ID of the file version", + "description": "The ID of the file version.", "type": "string", "example": "731381601045" } @@ -17432,12 +17432,12 @@ "type": "object", "properties": { "unit": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file" }, "value": { - "description": "`1`", + "description": "Number of resources affected.", "type": "number", "example": 1 } @@ -17560,7 +17560,7 @@ { "name": "limit", "in": "query", - "description": "Limits the number of events returned\n\nNote: Sometimes, the events less than the limit requested can be returned\neven when there may be more events remaining. This is primarily done in\nthe case where a number of events have already been retrieved and these\nretrieved events are returned rather than delaying for an unknown amount\nof time to see if there are any more results.", + "description": "Limits the number of events returned.\n\nNote: Sometimes, the events less than the limit requested can be returned\neven when there may be more events remaining. This is primarily done in\nthe case where a number of events have already been retrieved and these\nretrieved events are returned rather than delaying for an unknown amount\nof time to see if there are any more results.", "schema": { "type": "integer", "format": "int64", @@ -17577,7 +17577,7 @@ "type": "array", "items": { "type": "string", - "description": "An event type that can be filtered by", + "description": "An event type that can be filtered by.", "enum": [ "ACCESS_GRANTED", "ACCESS_REVOKED", @@ -17801,7 +17801,7 @@ ], "responses": { "200": { - "description": "Returns all collections for the given user", + "description": "Returns all collections for the given user.", "content": { "application/json": { "schema": { @@ -18173,7 +18173,7 @@ "type": "object", "properties": { "policy_name": { - "description": "The name for the retention policy", + "description": "The name for the retention policy.", "type": "string", "example": "Some Policy Name" }, @@ -18274,7 +18274,7 @@ } }, "409": { - "description": "Returns an error if a retention policy with the given name already exists", + "description": "Returns an error if a retention policy with the given name already exists.", "content": { "application/json": { "schema": { @@ -18385,7 +18385,7 @@ "type": "object", "properties": { "policy_name": { - "description": "The name for the retention policy", + "description": "The name for the retention policy.", "type": "string", "example": "Some Policy Name", "nullable": true @@ -18499,7 +18499,7 @@ } }, "409": { - "description": "Returns an error if a retention policy with the given name already exists", + "description": "Returns an error if a retention policy with the given name already exists.", "content": { "application/json": { "schema": { @@ -18703,12 +18703,12 @@ "type": "object", "properties": { "policy_id": { - "description": "The ID of the retention policy to assign", + "description": "The ID of the retention policy to assign.", "type": "string", "example": "173463" }, "assign_to": { - "description": "The item to assign the policy to", + "description": "The item to assign the policy to.", "type": "object", "properties": { "type": { @@ -18827,7 +18827,7 @@ "get": { "operationId": "get_retention_policy_assignments_id", "summary": "Get retention policy assignment", - "description": "Retrieves a retention policy assignment", + "description": "Retrieves a retention policy assignment.", "parameters": [ { "name": "retention_policy_assignment_id", @@ -19286,7 +19286,7 @@ { "name": "legal_hold_policy_id", "in": "path", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19329,7 +19329,7 @@ { "name": "legal_hold_policy_id", "in": "path", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19411,7 +19411,7 @@ { "name": "legal_hold_policy_id", "in": "path", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19449,7 +19449,7 @@ { "name": "policy_id", "in": "query", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19566,11 +19566,11 @@ "example": "123244" }, "assign_to": { - "description": "The item to assign the policy to", + "description": "The item to assign the policy to.", "type": "object", "properties": { "type": { - "description": "The type of item to assign the policy to", + "description": "The type of item to assign the policy to.", "type": "string", "example": "folder", "enum": [ @@ -19583,7 +19583,7 @@ ] }, "id": { - "description": "The ID of item to assign the policy to", + "description": "The ID of item to assign the policy to.", "type": "string", "example": "6564564" } @@ -19639,7 +19639,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -19682,7 +19682,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -19720,7 +19720,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -19926,7 +19926,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -20011,7 +20011,7 @@ { "name": "file_version_retention_id", "in": "path", - "description": "The ID of the file version retention", + "description": "The ID of the file version retention.", "required": true, "schema": { "type": "string" @@ -20056,7 +20056,7 @@ { "name": "file_version_legal_hold_id", "in": "path", - "description": "The ID of the file version legal hold", + "description": "The ID of the file version legal hold.", "required": true, "schema": { "type": "string" @@ -20690,7 +20690,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the shield information\nbarrier segment with specified ID was not found.", @@ -20896,12 +20896,12 @@ "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "name": { - "description": "Name of the shield information barrier segment", + "description": "Name of the shield information barrier segment.", "type": "string", "example": "Investment Banking" }, "description": { - "description": "Description of the shield information barrier segment", + "description": "Description of the shield information barrier segment.", "type": "string", "example": "'Corporate division that engages in\n advisory_based financial\ntransactions on behalf of individuals,\ncorporations, and governments.'" } @@ -21140,7 +21140,7 @@ "type": "object", "properties": { "type": { - "description": "-| A type of the shield barrier segment member.", + "description": "A type of the shield barrier segment member.", "type": "string", "example": "shield_information_barrier_segment_member", "enum": [ @@ -21296,7 +21296,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the\nshield information barrier segment restriction was not found.", @@ -21507,7 +21507,7 @@ { "name": "device_pinner_id", "in": "path", - "description": "The ID of the device pin", + "description": "The ID of the device pin.", "required": true, "schema": { "type": "string" @@ -21550,7 +21550,7 @@ { "name": "device_pinner_id", "in": "path", - "description": "The ID of the device pin", + "description": "The ID of the device pin.", "required": true, "schema": { "type": "string" @@ -21588,7 +21588,7 @@ { "name": "enterprise_id", "in": "path", - "description": "The ID of the enterprise", + "description": "The ID of the enterprise.", "required": true, "schema": { "type": "string" @@ -21752,7 +21752,7 @@ }, "responses": { "200": { - "description": "Returns a new task object", + "description": "Returns a new task object.", "content": { "application/json": { "schema": { @@ -21972,7 +21972,7 @@ ] }, "id": { - "description": "The ID of terms of service", + "description": "The ID of terms of service.", "type": "string", "example": "1232132" } @@ -21995,7 +21995,7 @@ ] }, "id": { - "description": "The ID of user", + "description": "The ID of user.", "type": "string", "example": "3423423" } @@ -22647,7 +22647,7 @@ { "name": "resolved_for_type", "in": "query", - "description": "The target type to return assignments for", + "description": "The target type to return assignments for.", "required": true, "schema": { "type": "string", @@ -22661,7 +22661,7 @@ { "name": "resolved_for_id", "in": "query", - "description": "The ID of the user or enterprise to return assignments for", + "description": "The ID of the user or enterprise to return assignments for.", "required": true, "schema": { "type": "string" @@ -22707,7 +22707,7 @@ "type": "object", "properties": { "storage_policy": { - "description": "The storage policy to assign to the user or\nenterprise", + "description": "The storage policy to assign to the user or\nenterprise.", "type": "object", "properties": { "type": { @@ -22743,7 +22743,7 @@ ] }, "id": { - "description": "The ID of the user or enterprise", + "description": "The ID of the user or enterprise.", "type": "string", "example": "9987987" } @@ -22857,7 +22857,7 @@ "type": "object", "properties": { "storage_policy": { - "description": "The storage policy to assign to the user or\nenterprise", + "description": "The storage policy to assign to the user or\nenterprise.", "type": "object", "properties": { "type": { @@ -23071,7 +23071,7 @@ "description": "Returns the content of the items requested for this download, formatted as\na stream of files and folders in a `zip` archive.", "headers": { "Content-Disposition": { - "description": "The name of the archive to be downloaded", + "description": "The name of the archive to be downloaded.", "schema": { "type": "string", "example": "attachment;filename=\"Avatars.zip\";filename*=UTF-8''Avatars.zip" @@ -23218,7 +23218,7 @@ { "name": "sign_request_id", "in": "path", - "description": "The ID of the signature request", + "description": "The ID of the signature request.", "required": true, "schema": { "type": "string" @@ -23273,7 +23273,7 @@ { "name": "sign_request_id", "in": "path", - "description": "The ID of the signature request", + "description": "The ID of the signature request.", "required": true, "schema": { "type": "string" @@ -23321,7 +23321,7 @@ { "name": "sign_request_id", "in": "path", - "description": "The ID of the signature request", + "description": "The ID of the signature request.", "required": true, "schema": { "type": "string" @@ -23425,7 +23425,7 @@ ], "responses": { "200": { - "description": "Returns a collection of sign requests", + "description": "Returns a collection of sign requests.", "content": { "application/json": { "schema": { @@ -23614,7 +23614,7 @@ "type": "object", "properties": { "type": { - "description": "The type of the parameters object", + "description": "The type of the parameters object.", "type": "string", "example": "workflow_parameters", "enum": [ @@ -23622,16 +23622,16 @@ ] }, "flow": { - "description": "The flow that will be triggered", + "description": "The flow that will be triggered.", "type": "object", "properties": { "type": { - "description": "The type of the flow object", + "description": "The type of the flow object.", "type": "string", "example": "flow" }, "id": { - "description": "The id of the flow", + "description": "The id of the flow.", "type": "string", "example": "123456789" } @@ -23642,10 +23642,10 @@ "type": "array", "items": { "type": "object", - "description": "A file the workflow should start for", + "description": "A file the workflow should start for.", "properties": { "type": { - "description": "The type of the file object", + "description": "The type of the file object.", "type": "string", "example": "file", "enum": [ @@ -23653,7 +23653,7 @@ ] }, "id": { - "description": "The id of the file", + "description": "The id of the file.", "type": "string", "example": "12345678" } @@ -23665,7 +23665,7 @@ "type": "object", "properties": { "type": { - "description": "The type of the folder object", + "description": "The type of the folder object.", "type": "string", "example": "folder", "enum": [ @@ -23673,7 +23673,7 @@ ] }, "id": { - "description": "The id of the folder", + "description": "The id of the folder.", "type": "string", "example": "87654321" } @@ -23701,7 +23701,7 @@ "description": "Starts the workflow." }, "400": { - "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `workflow_is_not_enabled` when the workflow is not enabled\n* `workflow_not_active_on_provided_folder` when the workflow is not\n enabled for the specified folder id\n* `parameters_provided_do_not_match_target_outcome` when the provided\n parameters do not match the expected parameters", + "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `workflow_is_not_enabled` when the workflow is not enabled.\n* `workflow_not_active_on_provided_folder` when the workflow is not\n enabled for the specified folder id.\n* `parameters_provided_do_not_match_target_outcome` when the provided\n parameters do not match the expected parameters.", "content": { "application/json": { "schema": { @@ -23711,7 +23711,7 @@ } }, "403": { - "description": "Returns an error if there are insufficient permissions.\n\n* `insufficient_access` when the user does not have access rights to file\n or folder\n* `missing_relay_full_access` when the user does not have access to Relay\n Full", + "description": "Returns an error if there are insufficient permissions.\n\n* `insufficient_access` when the user does not have access rights to file\n or folder.\n* `missing_relay_full_access` when the user does not have access to Relay\n Full.", "content": { "application/json": { "schema": { @@ -23721,7 +23721,7 @@ } }, "404": { - "description": "Returns an error if the workflow could not be found,\nor the authenticated user does not have access to the workflow.\n\n* `workflow_not_found` when the workflow is not found\n* `flow_missing_or_inaccessible` when the flow is not a manual start flow", + "description": "Returns an error if the workflow could not be found,\nor the authenticated user does not have access to the workflow.\n\n* `workflow_not_found` when the workflow is not found.\n* `flow_missing_or_inaccessible` when the flow is not a manual start flow.", "content": { "application/json": { "schema": { @@ -23910,7 +23910,7 @@ { "name": "partner_item_type", "in": "query", - "description": "Mapped item type, for which the mapping should be returned", + "description": "Mapped item type, for which the mapping should be returned.", "schema": { "type": "string", "enum": [ @@ -23922,7 +23922,7 @@ { "name": "partner_item_id", "in": "query", - "description": "ID of the mapped item, for which the mapping should be returned", + "description": "ID of the mapped item,\nfor which the mapping should be returned.", "schema": { "type": "string" }, @@ -23931,7 +23931,7 @@ { "name": "box_item_id", "in": "query", - "description": "Box item ID, for which the mappings should be returned", + "description": "Box item ID, for which the mappings should be returned.", "schema": { "type": "string", "nullable": false @@ -23941,7 +23941,7 @@ { "name": "box_item_type", "in": "query", - "description": "Box item type, for which the mappings should be returned", + "description": "Box item type, for\nwhich the mappings should be returned.", "schema": { "type": "string", "enum": [ @@ -23954,7 +23954,7 @@ { "name": "is_manually_created", "in": "query", - "description": "Whether the mapping has been manually created", + "description": "Whether the mapping has been manually created.", "schema": { "type": "boolean", "nullable": false @@ -23964,7 +23964,7 @@ ], "responses": { "200": { - "description": "Returns a collection of integration mappings", + "description": "Returns a collection of integration mappings.", "content": { "application/json": { "schema": { @@ -24079,7 +24079,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24168,7 +24168,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24178,7 +24178,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the integration mapping could not be found.", @@ -24217,7 +24217,7 @@ { "name": "partner_item_type", "in": "query", - "description": "Mapped item type, for which the mapping should be returned", + "description": "Mapped item type, for which the mapping should be returned.", "schema": { "type": "string", "enum": [ @@ -24230,7 +24230,7 @@ { "name": "partner_item_id", "in": "query", - "description": "ID of the mapped item, for which the mapping should be returned", + "description": "ID of the mapped item,\nfor which the mapping should be returned.", "schema": { "type": "string" }, @@ -24239,7 +24239,7 @@ { "name": "box_item_id", "in": "query", - "description": "Box item ID, for which the mappings should be returned", + "description": "Box item ID, for which the mappings should be returned.", "schema": { "type": "string" }, @@ -24248,7 +24248,7 @@ { "name": "box_item_type", "in": "query", - "description": "Box item type, for which the mappings should be returned", + "description": "Box item type, for\nwhich the mappings should be returned.", "schema": { "type": "string", "enum": [ @@ -24260,7 +24260,7 @@ ], "responses": { "200": { - "description": "Returns a collection of integration mappings", + "description": "Returns a collection of integration mappings.", "content": { "application/json": { "schema": { @@ -24377,7 +24377,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24397,7 +24397,7 @@ "$ref": "#/components/schemas/FolderReference" }, { - "description": "The Box folder, to which the object from the partner app domain is mapped" + "description": "The Box folder, to which the object from the partner app domain is mapped." } ] } @@ -24462,7 +24462,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24472,7 +24472,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the integration mapping could not be found.", @@ -24616,7 +24616,7 @@ "get": { "operationId": "get_ai_agent_default", "summary": "Get AI agent default configuration", - "description": "Get the AI agent default config", + "description": "Get the AI agent default config.", "x-stability-level": "stable", "parameters": [ { @@ -25293,7 +25293,7 @@ "x-box-tag": "ai" }, "AiAgentBasicGenTool": { - "description": "AI agent basic tool used to generate text. ", + "description": "AI agent basic tool used to generate text.", "type": "object", "allOf": [ { @@ -25453,23 +25453,23 @@ "type": "object", "properties": { "models": { - "description": "The models used for the request", + "description": "The models used for the request.", "type": "array", "items": { "type": "object", "properties": { "name": { - "description": "The name of the model used for the request", + "description": "The name of the model used for the request.", "type": "string", "example": "azure__openai__text_embedding_ada_002" }, "provider": { - "description": "The provider that owns the model used for the request", + "description": "The provider that owns the model used for the request.", "type": "string", "example": "azure" }, "supported_purpose": { - "description": "The supported purpose utilized by the model used for the request", + "description": "The supported purpose utilized by the model used for the request.", "type": "string", "example": "embedding" } @@ -25477,7 +25477,7 @@ } }, "processor": { - "description": "The processor used for the request", + "description": "The processor used for the request.", "type": "string", "example": "basic_text" } @@ -25582,7 +25582,7 @@ "nullable": false }, "id": { - "description": "The ID of an Agent", + "description": "The ID of an Agent.", "type": "string", "example": "14031", "nullable": false @@ -25620,11 +25620,11 @@ "x-box-tag": "ai" }, "AiAsk": { - "description": "AI ask request object", + "description": "AI ask request object.", "type": "object", "properties": { "mode": { - "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only process the text.", + "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, \nwhichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. \nBox AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages \nfor multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will \nbe processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. \nCurrently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only \nprocess the text.", "type": "string", "example": "multiple_item_qa", "enum": [ @@ -25634,7 +25634,7 @@ "nullable": false }, "prompt": { - "description": "The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.", + "description": "The prompt provided by the client to be answered by the LLM.\nThe prompt's length is limited to 10000 characters.", "type": "string", "example": "What is the value provided by public APIs based on this document?" }, @@ -25740,7 +25740,7 @@ "title": "Dialogue history" }, "AiExtract": { - "description": "AI metadata freeform extraction request object", + "description": "AI metadata freeform extraction request object.", "type": "object", "properties": { "prompt": { @@ -25919,7 +25919,7 @@ "x-box-tag": "ai" }, "AiExtractStructuredResponse": { - "description": "AI extract structured response", + "description": "AI extract structured response.", "type": "object", "properties": { "answer": { @@ -26031,7 +26031,7 @@ "title": "AI LLM endpoint parameters" }, "AiLlmEndpointParamsAWS": { - "description": "AI LLM endpoint params AWS object", + "description": "AI LLM endpoint params AWS object.", "type": "object", "properties": { "type": { @@ -26067,7 +26067,7 @@ "x-box-resource-id": "ai_llm_endpoint_params_aws" }, "AiLlmEndpointParamsGoogle": { - "description": "AI LLM endpoint params Google object", + "description": "AI LLM endpoint params Google object.", "type": "object", "properties": { "type": { @@ -26111,7 +26111,7 @@ "x-box-resource-id": "ai_llm_endpoint_params_google" }, "AiLlmEndpointParamsIBM": { - "description": "AI LLM endpoint params IBM object", + "description": "AI LLM endpoint params IBM object.", "type": "object", "properties": { "type": { @@ -26214,7 +26214,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -26256,7 +26256,7 @@ "x-box-tag": "ai_studio" }, "AiResponse": { - "description": "AI response", + "description": "AI response.", "type": "object", "properties": { "answer": { @@ -26293,7 +26293,7 @@ ] }, "AiResponse--Full": { - "description": "AI ask response", + "description": "AI ask response.", "type": "object", "allOf": [ { @@ -26567,7 +26567,7 @@ { "properties": { "is_custom_instructions_included": { - "description": "True if system message contains custom instructions placeholder, false otherwise", + "description": "True if system message contains custom instructions placeholder, false otherwise.", "type": "boolean", "example": false } @@ -26587,7 +26587,7 @@ { "properties": { "warnings": { - "description": "Warnings concerning tool", + "description": "Warnings concerning tool.", "type": "array", "items": { "type": "string" @@ -26612,7 +26612,7 @@ { "properties": { "is_custom_instructions_included": { - "description": "True if system message contains custom instructions placeholder, false otherwise", + "description": "True if system message contains custom instructions placeholder, false otherwise.", "type": "boolean", "example": false } @@ -26632,7 +26632,7 @@ { "properties": { "warnings": { - "description": "Warnings concerning tool", + "description": "Warnings concerning tool.", "type": "array", "items": { "type": "string" @@ -26751,7 +26751,7 @@ { "properties": { "is_custom_instructions_included": { - "description": "True if system message contains custom instructions placeholder, false otherwise", + "description": "True if system message contains custom instructions placeholder, false otherwise.", "type": "boolean", "example": false } @@ -26771,7 +26771,7 @@ { "properties": { "warnings": { - "description": "Warnings concerning tool", + "description": "Warnings concerning tool.", "type": "array", "items": { "type": "string" @@ -26875,7 +26875,7 @@ "x-box-tag": "ai_studio" }, "AiTextGen": { - "description": "AI text gen request object", + "description": "AI text gen request object.", "type": "object", "properties": { "prompt": { @@ -26960,7 +26960,7 @@ "example": "12345678" }, "type": { - "description": "`app_item`", + "description": "The value will always be `app_item`.", "type": "string", "example": "app_item", "enum": [ @@ -26993,7 +26993,7 @@ "nullable": false }, "type": { - "description": "`app_item_association`", + "description": "The value will always be `app_item_association`.", "type": "string", "example": "app_item_association", "enum": [ @@ -27045,12 +27045,12 @@ "x-box-tag": "app_item_associations" }, "AppItemAssociations": { - "description": "A list of app item associations", + "description": "A list of app item associations.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27092,12 +27092,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the `AppItem`", + "description": "The id of the `AppItem`.", "type": "string", "example": "6374669741" }, "type": { - "description": "The type of the source that this event represents. Can only be `app_item`.\n", + "description": "The type of the source that this event represents. Can only be `app_item`.", "type": "string", "example": "app_item", "enum": [ @@ -27106,7 +27106,7 @@ "nullable": false }, "app_item_type": { - "description": "The type of the `AppItem`", + "description": "The type of the `AppItem`.", "type": "string", "example": "hubs" }, @@ -27154,7 +27154,7 @@ "example": "folder_59449484661," }, "$template": { - "description": "`securityClassification-6VMVochwUWo`", + "description": "The value will always be `securityClassification-6VMVochwUWo`.", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ @@ -27201,7 +27201,7 @@ "example": "58063d82-4128-7b43-bba9-92f706befcdf" }, "type": { - "description": "`metadata_template`", + "description": "The value will always be `metadata_template`.", "type": "string", "example": "metadata_template", "enum": [ @@ -27215,7 +27215,7 @@ "example": "enterprise_123456" }, "templateKey": { - "description": "`securityClassification-6VMVochwUWo`", + "description": "The value will always be `securityClassification-6VMVochwUWo`.", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ @@ -27276,7 +27276,7 @@ ] }, "displayName": { - "description": "`Classification`", + "description": "The value will always be `Classification`.", "type": "string", "example": "Classification", "enum": [ @@ -27323,7 +27323,7 @@ "example": "Sensitive information" }, "colorID": { - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -27355,11 +27355,11 @@ "x-box-tag": "classifications" }, "ClientError": { - "description": "A generic error", + "description": "A generic error.", "type": "object", "properties": { "type": { - "description": "error", + "description": "The value will always be `error`.", "type": "string", "example": "error", "enum": [ @@ -27375,7 +27375,7 @@ "nullable": false }, "code": { - "description": "A Box-specific error code", + "description": "A Box-specific error code.", "type": "string", "example": "item_name_invalid", "enum": [ @@ -27439,7 +27439,7 @@ "example": "12345678" }, "type": { - "description": "`collaboration`", + "description": "The value will always be `collaboration`.", "type": "string", "example": "collaboration", "enum": [ @@ -27655,7 +27655,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27680,7 +27680,7 @@ { "properties": { "entries": { - "description": "A list of allowed collaboration domains", + "description": "A list of allowed collaboration domains.", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationAllowlistEntry" @@ -27698,12 +27698,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this entry", + "description": "The unique identifier for this entry.", "type": "string", "example": "11446498" }, "type": { - "description": "`collaboration_whitelist_entry`", + "description": "The value will always be `collaboration_whitelist_entry`.", "type": "string", "example": "collaboration_whitelist_entry", "enum": [ @@ -27711,7 +27711,7 @@ ] }, "domain": { - "description": "The whitelisted domain", + "description": "The whitelisted domain.", "type": "string", "example": "example.com" }, @@ -27730,7 +27730,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -27738,7 +27738,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -27746,19 +27746,19 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise this list is applied to" + "description": "The enterprise this list is applied to." } ] }, "created_at": { - "description": "The time the entry was created at", + "description": "The time the entry was created at.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -27773,12 +27773,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this exemption", + "description": "The unique identifier for this exemption.", "type": "string", "example": "11446498" }, "type": { - "description": "`collaboration_whitelist_exempt_target`", + "description": "The value will always be `collaboration_whitelist_exempt_target`.", "type": "string", "example": "collaboration_whitelist_exempt_target", "enum": [ @@ -27790,7 +27790,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -27798,7 +27798,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -27806,14 +27806,14 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise this entry belongs to" + "description": "The enterprise this entry belongs to." } ] }, @@ -27823,18 +27823,18 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that has been exempt" + "description": "The user that has been exempt." } ] }, "created_at": { - "description": "The time the entry was created", + "description": "The time the entry was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "The time the entry was modified", + "description": "The time the entry was modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -27850,7 +27850,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27889,12 +27889,12 @@ "x-box-tag": "collaboration_allowlist_exempt_targets" }, "Collaborations": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27919,7 +27919,7 @@ { "properties": { "entries": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "array", "items": { "$ref": "#/components/schemas/Collaboration" @@ -27933,12 +27933,12 @@ "x-box-tag": "user_collaborations" }, "CollaborationsOffsetPaginated": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -27963,7 +27963,7 @@ { "properties": { "entries": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "array", "items": { "$ref": "#/components/schemas/Collaboration" @@ -27981,7 +27981,7 @@ "type": "object", "properties": { "type": { - "description": "Collaborator\nobject type.\n", + "description": "Collaborator\nobject type.", "type": "string", "example": "variable", "enum": [ @@ -27989,7 +27989,7 @@ ] }, "variable_type": { - "description": "Variable type \nfor the Collaborator\nobject.\n", + "description": "Variable type \nfor the Collaborator\nobject.", "type": "string", "example": "user_list", "enum": [ @@ -28041,7 +28041,7 @@ "example": "11446498" }, "type": { - "description": "`collection`", + "description": "The value will always be `collection`.", "type": "string", "example": "collection", "enum": [ @@ -28070,12 +28070,12 @@ "x-box-tag": "collections" }, "Collections": { - "description": "A list of collections", + "description": "A list of collections.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -28100,15 +28100,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -28124,7 +28124,7 @@ { "properties": { "entries": { - "description": "A list of collections", + "description": "A list of collections.", "type": "array", "items": { "$ref": "#/components/schemas/Collection" @@ -28147,12 +28147,12 @@ { "properties": { "is_reply_comment": { - "description": "Whether or not this comment is a reply to another\ncomment", + "description": "Whether or not this comment is a reply to another\ncomment.", "type": "boolean", "example": true }, "message": { - "description": "The text of the comment, as provided by the user", + "description": "The text of the comment, as provided by the user.", "type": "string", "example": "@Aaron Levie these tigers are cool!" }, @@ -28162,18 +28162,18 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "A mini user object representing the author of the\ncomment" + "description": "A mini user object representing the author of the\ncomment." } ] }, "created_at": { - "description": "The time this comment was created", + "description": "The time this comment was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "The time this comment was last modified", + "description": "The time this comment was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -28182,23 +28182,23 @@ "allOf": [ { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } } }, { - "description": "The file this comment was placed on" + "description": "The file this comment was placed on." } ] } @@ -28219,7 +28219,7 @@ "example": "11446498" }, "type": { - "description": "`comment`", + "description": "The value will always be `comment`.", "type": "string", "example": "comment", "enum": [ @@ -28238,7 +28238,7 @@ ] }, "Comment--Full": { - "description": "Comments are messages created on files. Comments\ncan be made independently or created as responses to other\ncomments", + "description": "Comments are messages created on files. Comments\ncan be made independently or created as responses to other\ncomments.", "type": "object", "allOf": [ { @@ -28259,12 +28259,12 @@ "x-box-variant": "full" }, "Comments": { - "description": "A list of comments", + "description": "A list of comments.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -28289,15 +28289,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -28313,7 +28313,7 @@ { "properties": { "entries": { - "description": "A list of comments", + "description": "A list of comments.", "type": "array", "items": { "$ref": "#/components/schemas/Comment--Full" @@ -28331,7 +28331,7 @@ "type": "object", "properties": { "type": { - "description": "Completion\nRule object type.\n", + "description": "Completion\nRule object type.", "type": "string", "example": "variable", "enum": [ @@ -28339,7 +28339,7 @@ ] }, "variable_type": { - "description": "Variable type\nfor the Completion\nRule object.\n", + "description": "Variable type\nfor the Completion\nRule object.", "type": "string", "example": "task_completion_rule", "enum": [ @@ -28347,7 +28347,7 @@ ] }, "variable_value": { - "description": "Variable\nvalues for a completion\nrule.\n", + "description": "Variable\nvalues for a completion\nrule.", "type": "string", "example": "all_assignees", "enum": [ @@ -28416,7 +28416,7 @@ "x-box-tag": "ai_studio" }, "icon_reference": { - "description": "The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/`\nwhere possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png`", + "description": "The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/`\nwhere possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png`.", "type": "string", "example": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg", "minLength": 1 @@ -28456,7 +28456,7 @@ "example": "11446498" }, "type": { - "description": "`device_pinner`", + "description": "The value will always be `device_pinner`.", "type": "string", "example": "device_pinner", "enum": [ @@ -28469,12 +28469,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that the device pin belongs to" + "description": "The user that the device pin belongs to." } ] }, "product_name": { - "description": "The type of device being pinned", + "description": "The type of device being pinned.", "type": "string", "example": "iPad" } @@ -28484,11 +28484,11 @@ "x-box-tag": "device_pinners" }, "DevicePinners": { - "description": "A list of device pins", + "description": "A list of device pins.", "type": "object", "properties": { "entries": { - "description": "A list of device pins", + "description": "A list of device pins.", "type": "array", "items": { "$ref": "#/components/schemas/DevicePinner" @@ -28512,10 +28512,10 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field that is ordered by", + "description": "The field that is ordered by.", "type": "string", "example": "id", "enum": [ @@ -28523,7 +28523,7 @@ ] }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "asc", "enum": [ @@ -28544,12 +28544,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "`email_alias`", + "description": "The value will always be `email_alias`.", "type": "string", "example": "email_alias", "enum": [ @@ -28557,12 +28557,12 @@ ] }, "email": { - "description": "The email address", + "description": "The email address.", "type": "string", "example": "alias@example.com" }, "is_confirmed": { - "description": "Whether the email address has been confirmed", + "description": "Whether the email address has been confirmed.", "type": "boolean", "example": true } @@ -28572,7 +28572,7 @@ "x-box-tag": "email_aliases" }, "EmailAliases": { - "description": "A list of email aliases", + "description": "A list of email aliases.", "type": "object", "properties": { "total_count": { @@ -28582,7 +28582,7 @@ "example": 5000 }, "entries": { - "description": "A list of email aliases", + "description": "A list of email aliases.", "type": "array", "items": { "$ref": "#/components/schemas/EmailAlias" @@ -28598,12 +28598,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this enterprise", + "description": "The unique identifier for this enterprise.", "type": "string", "example": "1910967" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -28623,28 +28623,28 @@ ] }, "Event": { - "description": "The description of an event that happened within Box", + "description": "The description of an event that happened within Box.", "type": "object", "properties": { "type": { - "description": "`event`", + "description": "The value will always be `event`.", "type": "string", "example": "event" }, "created_at": { - "description": "When the event object was created", + "description": "When the event object was created.", "type": "string", "format": "date-time", "example": "2022-12-12T10:53:43-08:00" }, "recorded_at": { - "description": "When the event object was recorded in database", + "description": "When the event object was recorded in database.", "type": "string", "format": "date-time", "example": "2022-12-12T10:54:43-08:00" }, "event_id": { - "description": "The ID of the event object. You can use this to detect duplicate events", + "description": "The ID of the event object. You can use this to detect duplicate events.", "type": "string", "example": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83" }, @@ -28654,7 +28654,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that performed the action represented by the event.\nSome events may be performed by users not logged into Box.\nIn that case, not all attributes of the object are populated and the\nevent is attributed to a unknown user (`user_id = 2`)" + "description": "The user that performed the action represented by the event.\nSome events may be performed by users not logged into Box.\nIn that case, not all attributes of the object are populated and the\nevent is attributed to a unknown user (`user_id = 2`)." } ] }, @@ -28664,7 +28664,7 @@ "title": "Event Type", "example": "FILE_MARKED_MALICIOUS", "type": "string", - "description": "An event type that can trigger an event", + "description": "An event type that can trigger an event.", "enum": [ "ACCESS_GRANTED", "ACCESS_REVOKED", @@ -28810,7 +28810,7 @@ ] }, { - "description": "The event type that triggered this event" + "description": "The event type that triggered this event." } ] }, @@ -28865,7 +28865,7 @@ "type": "object", "properties": { "item_type": { - "description": "The type of the item that the event\nrepresents. Can be `file` or `folder`.\n", + "description": "The type of the item that the event\nrepresents. Can be `file` or `folder`.", "type": "string", "example": "file", "enum": [ @@ -28875,13 +28875,13 @@ "nullable": false }, "item_id": { - "description": "The unique identifier that represents the\nitem.\n", + "description": "The unique identifier that represents the\nitem.", "type": "string", "example": "560284318361", "nullable": false }, "item_name": { - "description": "The name of the item.\n", + "description": "The name of the item.", "type": "string", "example": "report.pdf", "nullable": false @@ -28891,7 +28891,7 @@ "type": "object", "properties": { "name": { - "description": "The classification's name", + "description": "The classification's name.", "type": "string", "example": "Top Secret" } @@ -28931,7 +28931,7 @@ "x-box-resource-id": "event_source" }, "Events": { - "description": "A list of event objects", + "description": "A list of event objects.", "type": "object", "properties": { "chunk_size": { @@ -28953,7 +28953,7 @@ ] }, "entries": { - "description": "A list of events", + "description": "A list of events.", "type": "array", "items": { "$ref": "#/components/schemas/Event" @@ -28965,7 +28965,7 @@ "x-box-tag": "events" }, "File": { - "description": "A standard representation of a file, as returned from any\nfile API endpoints by default", + "description": "A standard representation of a file, as returned from any\nfile API endpoints by default.", "type": "object", "allOf": [ { @@ -29005,7 +29005,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -29070,7 +29070,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this file" + "description": "The user who created this file." } ] }, @@ -29080,7 +29080,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this file" + "description": "The user who last modified this file." }, { "nullable": false @@ -29093,7 +29093,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this file" + "description": "The user who owns this file." }, { "nullable": false @@ -29288,7 +29288,7 @@ "nullable": true }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -29314,7 +29314,7 @@ ] }, "File--Full": { - "description": "A full representation of a file, as can be returned from any\nfile API endpoints by default", + "description": "A full representation of a file, as can be returned from any\nfile API endpoints by default.", "type": "object", "allOf": [ { @@ -29323,12 +29323,12 @@ { "properties": { "version_number": { - "description": "The version number of this file", + "description": "The version number of this file.", "type": "string", "example": "1" }, "comment_count": { - "description": "The number of comments on this file", + "description": "The number of comments on this file.", "type": "integer", "example": 10 }, @@ -29423,13 +29423,13 @@ "nullable": false }, "can_view_annotations_all": { - "description": "Specifies if the user view all annotations placed on this file", + "description": "Specifies if the user view all annotations placed on this file.", "type": "boolean", "example": true, "nullable": false }, "can_view_annotations_self": { - "description": "Specifies if the user view annotations placed by themselves\non this file", + "description": "Specifies if the user view annotations placed by themselves\non this file.", "type": "boolean", "example": true, "nullable": false @@ -29473,12 +29473,12 @@ "description": "The lock held on a file. A lock prevents a file from being moved,\nrenamed, or otherwise changed by anyone else than the user who created the\nlock.", "properties": { "id": { - "description": "The unique identifier for this lock", + "description": "The unique identifier for this lock.", "type": "string", "example": "11446498" }, "type": { - "description": "`lock`", + "description": "The value will always be `lock`.", "type": "string", "example": "lock", "enum": [ @@ -29551,7 +29551,7 @@ "allOf": [ { "type": "object", - "description": "The basics of an access token", + "description": "The basics of an access token.", "properties": { "access_token": { "description": "The requested access token.", @@ -29603,7 +29603,7 @@ "allOf": [ { "type": "object", - "description": "Details about the watermark applied to this item", + "description": "Details about the watermark applied to this item.", "properties": { "is_watermarked": { "description": "Specifies if this item has a watermark applied.", @@ -29614,7 +29614,7 @@ } }, { - "description": "Details about the watermark applied to this file" + "description": "Details about the watermark applied to this file." } ] }, @@ -29701,7 +29701,7 @@ ] }, "expires_at": { - "description": "When the file will automatically be deleted", + "description": "When the file will automatically be deleted.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", @@ -29711,15 +29711,15 @@ "allOf": [ { "title": "Representations", - "description": "A list of file representations", + "description": "A list of file representations.", "type": "object", "properties": { "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "type": "object", - "description": "A file representation", + "description": "A file representation.", "properties": { "content": { "description": "An object containing the URL that can be used to actually fetch\nthe representation.", @@ -29801,10 +29801,10 @@ "allOf": [ { "type": "object", - "description": "The classification applied to an item", + "description": "The classification applied to an item.", "properties": { "name": { - "description": "The name of the classification", + "description": "The name of the classification.", "type": "string", "example": "Top Secret" }, @@ -29840,7 +29840,7 @@ ] }, "disposition_at": { - "description": "The retention expiration timestamp for the given file", + "description": "The retention expiration timestamp for the given file.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", @@ -29898,7 +29898,7 @@ ] }, "name": { - "description": "The name of the file", + "description": "The name of the file.", "type": "string", "example": "Contract.pdf" }, @@ -29928,7 +29928,7 @@ "x-box-variant": "mini" }, "FileConflict": { - "description": "A representation of a file that is used to show", + "description": "A representation of a file that is used to show.", "type": "object", "allOf": [ { @@ -29952,11 +29952,11 @@ "x-box-tag": null }, "FileOrFolderScope": { - "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed", + "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed.", "type": "object", "properties": { "scope": { - "description": "The scopes for the resource access", + "description": "The scopes for the resource access.", "type": "string", "example": "item_download", "enum": [ @@ -29989,7 +29989,7 @@ ] }, { - "description": "The file or folder resource" + "description": "The file or folder resource." } ] } @@ -30007,7 +30007,7 @@ "readOnly": true }, "type": { - "description": "`file_request`", + "description": "The value will always be `file_request`.", "type": "string", "example": "file_request", "enum": [ @@ -30137,7 +30137,7 @@ "type": "object", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -30205,7 +30205,7 @@ "title": "File Request (Update)" }, "FileVersion": { - "description": "A standard representation of a file version", + "description": "A standard representation of a file version.", "type": "object", "allOf": [ { @@ -30214,24 +30214,24 @@ { "properties": { "name": { - "description": "The name of the file version", + "description": "The name of the file version.", "type": "string", "example": "tigers.jpeg" }, "size": { - "description": "Size of the file version in bytes", + "description": "Size of the file version in bytes.", "type": "integer", "format": "int64", "example": 629644 }, "created_at": { - "description": "When the file version object was created", + "description": "When the file version object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the file version object was last updated", + "description": "When the file version object was last updated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -30242,7 +30242,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last updated the file version" + "description": "The user who last updated the file version." } ] }, @@ -30259,7 +30259,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who trashed the file version" + "description": "The user who trashed the file version." } ] }, @@ -30316,7 +30316,7 @@ "nullable": false }, "type": { - "description": "`file_version`", + "description": "The value will always be `file_version`.", "type": "string", "example": "file_version", "enum": [ @@ -30340,7 +30340,7 @@ ] }, "FileVersion--Full": { - "description": "A full representation of a file version, as can be returned from any\nfile version API endpoints by default", + "description": "A full representation of a file version, as can be returned from any\nfile version API endpoints by default.", "type": "object", "allOf": [ { @@ -30349,7 +30349,7 @@ { "properties": { "version_number": { - "description": "The version number of this file version", + "description": "The version number of this file version.", "type": "string", "example": "1" } @@ -30386,12 +30386,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this file version legal hold", + "description": "The unique identifier for this file version legal hold.", "type": "string", "example": "11446498" }, "type": { - "description": "`file_version_legal_hold`", + "description": "The value will always be `file_version_legal_hold`.", "type": "string", "example": "file_version_legal_hold", "enum": [ @@ -30404,7 +30404,7 @@ "$ref": "#/components/schemas/FileVersion--Mini" }, { - "description": "The file version that is held" + "description": "The file version that is held." } ] }, @@ -30442,7 +30442,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30467,7 +30467,7 @@ { "properties": { "entries": { - "description": "A list of file version legal holds", + "description": "A list of file version legal holds.", "type": "array", "items": { "$ref": "#/components/schemas/FileVersionLegalHold" @@ -30490,7 +30490,7 @@ "example": "11446498" }, "type": { - "description": "`file_version_retention`", + "description": "The value will always be `file_version_retention`.", "type": "string", "example": "file_version_retention", "enum": [ @@ -30503,7 +30503,7 @@ "$ref": "#/components/schemas/FileVersion--Mini" }, { - "description": "The file version this file version retention was\napplied to" + "description": "The file version this file version retention was\napplied to." } ] }, @@ -30513,18 +30513,18 @@ "$ref": "#/components/schemas/File--Mini" }, { - "description": "The file this file version retention was applied to" + "description": "The file this file version retention was applied to." } ] }, "applied_at": { - "description": "When this file version retention object was\ncreated", + "description": "When this file version retention object was\ncreated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "disposition_at": { - "description": "When the retention expires on this file\nversion retention", + "description": "When the retention expires on this file\nversion retention.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -30550,7 +30550,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30575,7 +30575,7 @@ { "properties": { "entries": { - "description": "A list of file version retentions", + "description": "A list of file version retentions.", "type": "array", "items": { "$ref": "#/components/schemas/FileVersionRetention" @@ -30589,12 +30589,12 @@ "x-box-tag": "file_version_retentions" }, "FileVersions": { - "description": "A list of file versions", + "description": "A list of file versions.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -30619,15 +30619,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -30643,7 +30643,7 @@ { "properties": { "entries": { - "description": "A list of file versions", + "description": "A list of file versions.", "type": "array", "items": { "$ref": "#/components/schemas/FileVersion--Full" @@ -30657,12 +30657,12 @@ "x-box-tag": "file_versions" }, "FileVersionsOnHold": { - "description": "A list of files on hold for legal policy assignment", + "description": "A list of files on hold for legal policy assignment.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30701,7 +30701,7 @@ "x-box-tag": "legal_hold_policy_assignments" }, "Files": { - "description": "A list of files", + "description": "A list of files.", "type": "object", "properties": { "total_count": { @@ -30711,7 +30711,7 @@ "example": 1 }, "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "$ref": "#/components/schemas/File--Full" @@ -30723,12 +30723,12 @@ "x-box-tag": "files" }, "FilesOnHold": { - "description": "A list of files on hold for legal policy assignment", + "description": "A list of files on hold for legal policy assignment.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30753,7 +30753,7 @@ { "properties": { "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "$ref": "#/components/schemas/File--Mini" @@ -30772,7 +30772,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30797,7 +30797,7 @@ { "properties": { "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "$ref": "#/components/schemas/File--Mini" @@ -30811,7 +30811,7 @@ "x-box-tag": "retention_policy_assignments" }, "Folder": { - "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default", + "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default.", "type": "object", "allOf": [ { @@ -30837,7 +30837,7 @@ "allOf": [ { "type": "string", - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false @@ -30873,7 +30873,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -30896,7 +30896,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this folder" + "description": "The user who created this folder." }, { "nullable": false @@ -31098,7 +31098,7 @@ "nullable": true }, "folder_upload_email": { - "description": "The `folder_upload_email` parameter is not `null` if one of the following options is **true**:\n\n * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.\n\n * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).\n\nIf the conditions are not met, the parameter will have the following value: `folder_upload_email: null`", + "description": "The `folder_upload_email` parameter is not `null` if one of the following options is **true**:\n\n * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.\n\n * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).\n\nIf the conditions are not met, the parameter will have the following value: `folder_upload_email: null`.", "type": "object", "nullable": true, "properties": { @@ -31180,7 +31180,7 @@ "nullable": true }, "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -31205,7 +31205,7 @@ ] }, "Folder--Full": { - "description": "A full representation of a folder, as can be returned from any\nfolder API endpoints by default", + "description": "A full representation of a folder, as can be returned from any\nfolder API endpoints by default.", "type": "object", "allOf": [ { @@ -31306,7 +31306,7 @@ ] }, { - "description": "Describes the permissions that the current user has\nfor this folder" + "description": "Describes the permissions that the current user has\nfor this folder." }, { "nullable": false @@ -31447,7 +31447,7 @@ "allOf": [ { "type": "object", - "description": "Details about the watermark applied to this item", + "description": "Details about the watermark applied to this item.", "properties": { "is_watermarked": { "description": "Specifies if this item has a watermark applied.", @@ -31458,7 +31458,7 @@ } }, { - "description": "Details about the watermark applied to this folder" + "description": "Details about the watermark applied to this folder." }, { "nullable": false @@ -31479,10 +31479,10 @@ "allOf": [ { "type": "object", - "description": "The classification applied to an item", + "description": "The classification applied to an item.", "properties": { "name": { - "description": "The name of the classification", + "description": "The name of the classification.", "type": "string", "example": "Top Secret" }, @@ -31595,7 +31595,7 @@ "example": "2020-09-14T23:12:53Z" }, "locked_operations": { - "description": "The operations that have been locked. Currently the `move`\nand `delete` operations cannot be locked separately, and both need to be\nset to `true`.\n", + "description": "The operations that have been locked. Currently the `move`\nand `delete` operations cannot be locked separately, and both need to be\nset to `true`.", "type": "object", "properties": { "move": { @@ -31627,11 +31627,11 @@ "x-box-tag": "folder_locks" }, "FolderLocks": { - "description": "A list of folder locks", + "description": "A list of folder locks.", "type": "object", "properties": { "entries": { - "description": "A list of folder locks", + "description": "A list of folder locks.", "type": "array", "items": { "$ref": "#/components/schemas/FolderLock" @@ -31654,11 +31654,11 @@ "x-box-tag": "folder_locks" }, "FolderReference": { - "description": "Folder reference", + "description": "Folder reference.", "type": "object", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -31667,7 +31667,7 @@ "nullable": false }, "id": { - "description": "ID of the folder", + "description": "ID of the folder.", "type": "string", "example": "42037322" } @@ -31685,7 +31685,7 @@ "allOf": [ {}, { - "description": "A definition of a generic\nevent source object. The set of\nparameters depends on the\nobject type. For example, a Box Shield\nevent source would have the following\nset of parameters:\n```yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n {\n \"name\": \"8\",\n \"member_count\": 1\n },\n {\n \"name\": \"9\",\n \"member_count\": 1\n }\n ]\n} \n```\n" + "description": "A definition of a generic\nevent source object. The set of\nparameters depends on the\nobject type. For example, a Box Shield\nevent source would have the following\nset of parameters:\n```yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n {\n \"name\": \"8\",\n \"member_count\": 1\n },\n {\n \"name\": \"9\",\n \"member_count\": 1\n }\n ]\n} \n```." } ] }, @@ -31693,7 +31693,7 @@ "x-box-resource-id": "generic_source" }, "Group": { - "description": "A standard representation of a group, as returned from any\ngroup API endpoints by default", + "description": "A standard representation of a group, as returned from any\ngroup API endpoints by default.", "type": "object", "allOf": [ { @@ -31702,13 +31702,13 @@ { "properties": { "created_at": { - "description": "When the group object was created", + "description": "When the group object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the group object was last modified", + "description": "When the group object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -31725,12 +31725,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "`group`", + "description": "The value will always be `group`.", "type": "string", "example": "group", "enum": [ @@ -31790,7 +31790,7 @@ ] }, "member_viewability_level": { - "description": "Specifies who can view the members of the group\n(Get Memberships for Group).\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", + "description": "Specifies who can view the members of the group\n(Get Memberships for Group).\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin.\n* `admins_and_members` - all admins and group members.\n* `all_managed_users` - all managed users in the\n enterprise.", "type": "string", "example": "admins_only", "enum": [ @@ -31834,7 +31834,7 @@ { "properties": { "name": { - "description": "The name of the group", + "description": "The name of the group.", "type": "string", "example": "Support" }, @@ -31859,12 +31859,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this group membership", + "description": "The unique identifier for this group membership.", "type": "string", "example": "11446498" }, "type": { - "description": "`group_membership`", + "description": "The value will always be `group_membership`.", "type": "string", "example": "group_membership", "enum": [ @@ -31877,7 +31877,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that the membership applies to" + "description": "The user that the membership applies to." } ] }, @@ -31887,7 +31887,7 @@ "$ref": "#/components/schemas/Group--Mini" }, { - "description": "The group that the membership applies to" + "description": "The group that the membership applies to." } ] }, @@ -31923,7 +31923,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -31948,15 +31948,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -31972,7 +31972,7 @@ { "properties": { "entries": { - "description": "A list of group memberships", + "description": "A list of group memberships.", "type": "array", "items": { "$ref": "#/components/schemas/GroupMembership" @@ -31991,7 +31991,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -32016,15 +32016,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -32040,7 +32040,7 @@ { "properties": { "entries": { - "description": "A list of groups", + "description": "A list of groups.", "type": "array", "items": { "$ref": "#/components/schemas/Group--Full" @@ -32063,7 +32063,7 @@ { "properties": { "integration_type": { - "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nCurrently only supports Slack.\n(part of the composite key together with `id`)", + "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nCurrently only supports Slack.\n(part of the composite key together with `id`).", "type": "string", "example": "slack", "enum": [ @@ -32071,7 +32071,7 @@ ] }, "is_manually_created": { - "description": "Identifies whether the mapping has\nbeen manually set\n(as opposed to being automatically created)", + "description": "Identifies whether the mapping has\nbeen manually set\n(as opposed to being automatically created).", "type": "boolean", "example": true }, @@ -32083,7 +32083,7 @@ ] }, "created_by": { - "description": "An object representing the user who\ncreated the integration mapping", + "description": "An object representing the user who\ncreated the integration mapping.", "allOf": [ { "$ref": "#/components/schemas/UserIntegrationMappings" @@ -32091,7 +32091,7 @@ ] }, "modified_by": { - "description": "The user who\nlast modified the integration mapping", + "description": "The user who\nlast modified the integration mapping.", "allOf": [ { "$ref": "#/components/schemas/UserIntegrationMappings" @@ -32099,7 +32099,7 @@ ] }, "partner_item": { - "description": "Mapped item object for Slack", + "description": "Mapped item object for Slack.", "example": { "id": "C12378991223", "type": "channel", @@ -32112,7 +32112,7 @@ ] }, "box_item": { - "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped", + "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped.", "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" @@ -32120,13 +32120,13 @@ ] }, "created_at": { - "description": "When the integration mapping object was created", + "description": "When the integration mapping object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the integration mapping object was last modified", + "description": "When the integration mapping object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -32147,12 +32147,12 @@ "type": "object", "properties": { "id": { - "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`)", + "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`).", "type": "string", "example": "12345" }, "type": { - "description": "Mapping type", + "description": "Mapping type.", "type": "string", "example": "integration_mapping", "enum": [ @@ -32167,11 +32167,11 @@ "title": "Integration mapping" }, "IntegrationMappingBoxItemSlack": { - "description": "The schema for an integration mapping Box item object for type Slack", + "description": "The schema for an integration mapping Box item object for type Slack.", "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "folder", "enum": [ @@ -32180,7 +32180,7 @@ "nullable": false }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "1234567891", "nullable": false @@ -32197,7 +32197,7 @@ "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "channel", "enum": [ @@ -32206,7 +32206,7 @@ "nullable": false }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "C12378991223", "nullable": false @@ -32235,7 +32235,7 @@ "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "channel", "enum": [ @@ -32244,7 +32244,7 @@ ] }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2" }, @@ -32266,7 +32266,7 @@ "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "channel", "enum": [ @@ -32275,7 +32275,7 @@ ] }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2" }, @@ -32299,7 +32299,7 @@ "title": "Integration mapping mapped item schema for type Teams" }, "IntegrationMappingSlackCreateRequest": { - "description": "A request to create a Slack Integration Mapping object", + "description": "A request to create a Slack Integration Mapping object.", "type": "object", "properties": { "partner_item": { @@ -32353,7 +32353,7 @@ { "properties": { "integration_type": { - "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nSupports Slack and Teams.\n(part of the composite key together with `id`)", + "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nSupports Slack and Teams.\n(part of the composite key together with `id`).", "type": "string", "example": "teams", "enum": [ @@ -32361,12 +32361,12 @@ ] }, "is_overridden_by_manual_mapping": { - "description": "Identifies whether the mapping has\nbeen manually set by the team owner from UI for channels\n(as opposed to being automatically created)", + "description": "Identifies whether the mapping has\nbeen manually set by the team owner from UI for channels\n(as opposed to being automatically created).", "type": "boolean", "example": true }, "partner_item": { - "description": "Mapped item object for Teams", + "description": "Mapped item object for Teams.", "example": { "id": "19%3ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2", "type": "channel", @@ -32385,18 +32385,18 @@ "$ref": "#/components/schemas/FolderReference" }, { - "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped" + "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped." } ] }, "created_at": { - "description": "When the integration mapping object was created", + "description": "When the integration mapping object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the integration mapping object was last modified", + "description": "When the integration mapping object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -32414,7 +32414,7 @@ "x-box-variant": "standard" }, "IntegrationMappingTeamsCreateRequest": { - "description": "A request to create a Teams Integration Mapping object", + "description": "A request to create a Teams Integration Mapping object.", "type": "object", "properties": { "partner_item": { @@ -32430,7 +32430,7 @@ "$ref": "#/components/schemas/FolderReference" }, { - "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped" + "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped." } ] } @@ -32448,7 +32448,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -32467,7 +32467,7 @@ { "properties": { "entries": { - "description": "A list of integration mappings", + "description": "A list of integration mappings.", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMapping" @@ -32487,7 +32487,7 @@ { "properties": { "entries": { - "description": "A list of integration mappings", + "description": "A list of integration mappings.", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMappingTeams" @@ -32505,12 +32505,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this invite", + "description": "The unique identifier for this invite.", "type": "string", "example": "11446498" }, "type": { - "description": "`invite`", + "description": "The value will always be `invite`.", "type": "string", "example": "invite", "enum": [ @@ -32518,7 +32518,7 @@ ] }, "invited_to": { - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "type": "object", "properties": { "id": { @@ -32527,7 +32527,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -32535,7 +32535,7 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } @@ -32549,12 +32549,12 @@ "$ref": "#/components/schemas/User--Mini" }, "status": { - "description": "The status of the invite", + "description": "The status of the invite.", "type": "string", "example": "pending" }, "created_at": { - "description": "When the invite was created", + "description": "When the invite was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -32580,7 +32580,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -32604,7 +32604,7 @@ }, { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -32629,15 +32629,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -32682,7 +32682,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -32707,15 +32707,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -32755,7 +32755,7 @@ "x-box-tag": "folders" }, "KeywordSkillCard": { - "description": "A skill card that contains a set of keywords", + "description": "A skill card that contains a set of keywords.", "type": "object", "properties": { "created_at": { @@ -32765,7 +32765,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -32773,7 +32773,7 @@ ] }, "skill_card_type": { - "description": "`keyword`", + "description": "The value will always be `keyword`.", "type": "string", "example": "keyword", "enum": [ @@ -32804,7 +32804,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -32827,7 +32827,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -32850,7 +32850,7 @@ "type": "array", "items": { "type": "object", - "description": "An entry in the `entries` attribute of a metadata card", + "description": "An entry in the `entries` attribute of a metadata card.", "properties": { "text": { "description": "The text of the keyword.", @@ -32878,7 +32878,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -32903,7 +32903,7 @@ { "properties": { "entries": { - "description": "A list of legal hold policies", + "description": "A list of legal hold policies.", "type": "array", "items": { "$ref": "#/components/schemas/LegalHoldPolicy" @@ -32938,7 +32938,7 @@ "maxLength": 500 }, "status": { - "description": "* 'active' - the policy is not in a transition state\n* 'applying' - that the policy is in the process of\n being applied\n* 'releasing' - that the process is in the process\n of being released\n* 'released' - the policy is no longer active", + "description": "Possible values:\n* 'active' - the policy is not in a transition state.\n* 'applying' - that the policy is in the process of\n being applied.\n* 'releasing' - that the process is in the process\n of being released.\n* 'released' - the policy is no longer active.", "type": "string", "example": "active", "enum": [ @@ -32949,29 +32949,29 @@ ] }, "assignment_counts": { - "description": "Counts of assignments within this a legal hold policy by item type", + "description": "Counts of assignments within this a legal hold policy by item type.", "type": "object", "properties": { "user": { - "description": "The number of users this policy is applied to", + "description": "The number of users this policy is applied to.", "type": "integer", "format": "int64", "example": 1 }, "folder": { - "description": "The number of folders this policy is applied to", + "description": "The number of folders this policy is applied to.", "type": "integer", "format": "int64", "example": 2 }, "file": { - "description": "The number of files this policy is applied to", + "description": "The number of files this policy is applied to.", "type": "integer", "format": "int64", "example": 3 }, "file_version": { - "description": "The number of file versions this policy is applied to", + "description": "The number of file versions this policy is applied to.", "type": "integer", "format": "int64", "example": 4 @@ -32984,12 +32984,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the legal hold policy object" + "description": "The user who created the legal hold policy object." } ] }, "created_at": { - "description": "When the legal hold policy object was created", + "description": "When the legal hold policy object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -33007,13 +33007,13 @@ "example": "2012-12-12T10:53:43-08:00" }, "filter_started_at": { - "description": "User-specified, optional date filter applies to\nCustodian assignments only", + "description": "User-specified, optional date filter applies to\nCustodian assignments only.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "filter_ended_at": { - "description": "User-specified, optional date filter applies to\nCustodian assignments only", + "description": "User-specified, optional date filter applies to\nCustodian assignments only.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -33032,16 +33032,16 @@ "x-box-variant": "standard" }, "LegalHoldPolicy--Mini": { - "description": "A mini legal hold policy", + "description": "A mini legal hold policy.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this legal hold policy", + "description": "The unique identifier for this legal hold policy.", "type": "string", "example": "11446498" }, "type": { - "description": "`legal_hold_policy`", + "description": "The value will always be `legal_hold_policy`.", "type": "string", "example": "legal_hold_policy", "enum": [ @@ -33077,7 +33077,7 @@ "$ref": "#/components/schemas/LegalHoldPolicy--Mini" }, { - "description": "The policy that the legal hold policy assignment\nis part of" + "description": "The policy that the legal hold policy assignment\nis part of." } ] }, @@ -33107,12 +33107,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the legal hold policy\nassignment" + "description": "The user who created the legal hold policy\nassignment." } ] }, "assigned_at": { - "description": "When the legal hold policy assignment object was\ncreated", + "description": "When the legal hold policy assignment object was\ncreated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -33135,12 +33135,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this legal hold assignment", + "description": "The unique identifier for this legal hold assignment.", "type": "string", "example": "11446498" }, "type": { - "description": "`legal_hold_policy_assignment`", + "description": "The value will always be `legal_hold_policy_assignment`.", "type": "string", "example": "legal_hold_policy_assignment", "enum": [ @@ -33163,7 +33163,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -33188,7 +33188,7 @@ { "properties": { "entries": { - "description": "A list of legal hold\npolicy assignments", + "description": "A list of legal hold\npolicy assignments.", "type": "array", "items": { "$ref": "#/components/schemas/LegalHoldPolicyAssignment" @@ -33224,7 +33224,7 @@ "example": "folder_59449484661," }, "$template": { - "description": "The name of the template", + "description": "The name of the template.", "type": "string", "example": "marketingCollateral" }, @@ -33307,7 +33307,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -33332,7 +33332,7 @@ { "properties": { "entries": { - "description": "A list of metadata cascade policies", + "description": "A list of metadata cascade policies.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataCascadePolicy" @@ -33350,12 +33350,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the metadata cascade policy object", + "description": "The ID of the metadata cascade policy object.", "type": "string", "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" }, "type": { - "description": "`metadata_cascade_policy`", + "description": "The value will always be `metadata_cascade_policy`.", "type": "string", "example": "metadata_cascade_policy", "enum": [ @@ -33367,7 +33367,7 @@ "type": "object", "properties": { "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -33386,7 +33386,7 @@ "type": "object", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -33648,7 +33648,7 @@ "title": "Metadata query search request" }, "MetadataQueryIndex": { - "description": "A metadata query index", + "description": "A metadata query index.", "type": "object", "properties": { "id": { @@ -33657,13 +33657,13 @@ "example": "-9876" }, "type": { - "description": "Value is always `metadata_query_index`", + "description": "Value is always `metadata_query_index`.", "type": "string", "example": "metadata_query_index", "nullable": false }, "status": { - "description": "The status of the metadata query index", + "description": "The status of the metadata query index.", "type": "string", "example": "active", "enum": [ @@ -33747,7 +33747,7 @@ "x-box-tag": "search" }, "MetadataTemplate": { - "description": "A template for metadata that can be applied to files and folders", + "description": "A template for metadata that can be applied to files and folders.", "type": "object", "properties": { "id": { @@ -33756,7 +33756,7 @@ "example": "58063d82-4128-7b43-bba9-92f706befcdf" }, "type": { - "description": "`metadata_template`", + "description": "The value will always be `metadata_template`.", "type": "string", "example": "metadata_template", "enum": [ @@ -33922,12 +33922,12 @@ "x-box-tag": "metadata_templates" }, "MetadataTemplates": { - "description": "A list of metadata templates", + "description": "A list of metadata templates.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -33952,7 +33952,7 @@ { "properties": { "entries": { - "description": "A list of metadata templates", + "description": "A list of metadata templates.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataTemplate" @@ -33987,7 +33987,7 @@ "x-box-tag": "file_metadata" }, "OAuth2Error": { - "description": "An OAuth 2.0 error", + "description": "An OAuth 2.0 error.", "type": "object", "properties": { "error": { @@ -34010,7 +34010,7 @@ "type": "object", "properties": { "id": { - "description": "ID of a specific outcome", + "description": "ID of a specific outcome.", "type": "string", "example": "17363629" }, @@ -34071,7 +34071,7 @@ "title": "Outcome" }, "PostOAuth2Revoke": { - "description": "A request to revoke an OAuth 2.0 token", + "description": "A request to revoke an OAuth 2.0 token.", "type": "object", "properties": { "client_id": { @@ -34097,7 +34097,7 @@ "title": "Token revocation request" }, "PostOAuth2Token": { - "description": "A request for a new OAuth 2.0 token", + "description": "A request for a new OAuth 2.0 token.", "type": "object", "properties": { "grant_type": { @@ -34171,7 +34171,7 @@ ] }, "scope": { - "description": "The space-delimited list of scopes that you want apply to the\nnew access token.\n\nThe `subject_token` will need to have all of these scopes or\nthe call will error with **401 Unauthorized**.", + "description": "The space-delimited list of scopes that you want apply to the\nnew access token.\n\nThe `subject_token` will need to have all of these scopes or\nthe call will error with **401 Unauthorized**..", "type": "string", "format": "space_delimited_list", "example": "item_upload item_preview base_explorer" @@ -34247,11 +34247,11 @@ "title": "Refresh access token" }, "RealtimeServer": { - "description": "A real-time server that can be used for\nlong polling user events", + "description": "A real-time server that can be used for\nlong polling user events.", "type": "object", "properties": { "type": { - "description": "`realtime_server`", + "description": "The value will always be `realtime_server`.", "type": "string", "example": "realtime_server" }, @@ -34261,7 +34261,7 @@ "example": "http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all" }, "ttl": { - "description": "The time in minutes for which this server is available", + "description": "The time in minutes for which this server is available.", "type": "string", "example": "10" }, @@ -34290,7 +34290,7 @@ "example": 1 }, "entries": { - "description": "A list of real-time servers", + "description": "A list of real-time servers.", "type": "array", "items": { "$ref": "#/components/schemas/RealtimeServer" @@ -34306,7 +34306,7 @@ "type": "object", "properties": { "type": { - "description": "`recent_item`", + "description": "The value will always be `recent_item`.", "type": "string", "example": "recent_item" }, @@ -34364,7 +34364,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -34389,7 +34389,7 @@ { "properties": { "entries": { - "description": "A list of recent items", + "description": "A list of recent items.", "type": "array", "items": { "$ref": "#/components/schemas/RecentItem" @@ -34418,7 +34418,7 @@ }, { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -34562,7 +34562,7 @@ "nullable": false }, "type": { - "description": "`retention_policy`", + "description": "The value will always be `retention_policy`.", "type": "string", "example": "retention_policy", "enum": [ @@ -34632,7 +34632,7 @@ "example": "11446498" }, "type": { - "description": "`retention_policy_assignment`", + "description": "The value will always be `retention_policy_assignment`.", "type": "string", "example": "retention_policy_assignment", "enum": [ @@ -34735,7 +34735,7 @@ "nullable": false }, "type": { - "description": "`retention_policy_assignment`", + "description": "The value will always be `retention_policy_assignment`.", "type": "string", "example": "retention_policy_assignment", "enum": [ @@ -34764,7 +34764,7 @@ { "properties": { "entries": { - "description": "A list of retention policy assignments", + "description": "A list of retention policy assignments.", "type": "array", "items": { "$ref": "#/components/schemas/RetentionPolicyAssignment" @@ -34774,7 +34774,7 @@ }, { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -34800,7 +34800,7 @@ "type": "object", "properties": { "type": { - "description": "Role object type.\n", + "description": "Role object type.", "type": "string", "example": "variable", "enum": [ @@ -34808,7 +34808,7 @@ ] }, "variable_type": { - "description": "The variable type used\nby the object.\n", + "description": "The variable type used\nby the object.", "type": "string", "example": "collaborator_role", "enum": [ @@ -34914,7 +34914,7 @@ { "properties": { "type": { - "description": "Specifies the response as search result items without shared links", + "description": "Specifies the response as search result items without shared links.", "type": "string", "example": "search_results_items", "enum": [ @@ -34979,7 +34979,7 @@ { "properties": { "type": { - "description": "Specifies the response as search result items with shared links", + "description": "Specifies the response as search result items with shared links.", "type": "string", "example": "search_results_with_shared_links", "enum": [ @@ -35005,11 +35005,11 @@ "x-box-tag": "search" }, "SessionTerminationMessage": { - "description": "A message informing about the\ntermination job status", + "description": "A message informing about the\ntermination job status.", "type": "object", "properties": { "message": { - "description": "The unique identifier for the termination job status", + "description": "The unique identifier for the termination job status.", "type": "string", "example": "Request is successful, please check the admin\nevents for the status of the job" } @@ -35019,16 +35019,16 @@ "x-box-tag": "session_termination" }, "ShieldInformationBarrier": { - "description": "A standard representation of a\nshield information barrier object", + "description": "A standard representation of a\nshield information barrier object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier", + "description": "The unique identifier for the shield information barrier.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier", + "description": "The type of the shield information barrier.", "type": "string", "example": "shield_information_barrier", "enum": [ @@ -35044,7 +35044,7 @@ ] }, "status": { - "description": "Status of the shield information barrier", + "description": "Status of the shield information barrier.", "type": "string", "example": "draft", "enum": [ @@ -35110,16 +35110,16 @@ ] }, "ShieldInformationBarrier--Base": { - "description": "A base representation of a\nshield information barrier object", + "description": "A base representation of a\nshield information barrier object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier", + "description": "The unique identifier for the shield information barrier.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier", + "description": "The type of the shield information barrier.", "type": "string", "example": "shield_information_barrier", "enum": [ @@ -35137,7 +35137,7 @@ ] }, "ShieldInformationBarrierReference": { - "description": "A shield information barrier reference for requests and responses", + "description": "A shield information barrier reference for requests and responses.", "type": "object", "properties": { "shield_information_barrier": { @@ -35149,7 +35149,7 @@ "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierReport": { - "description": "A standard representation\nof a shield information barrier report object", + "description": "A standard representation\nof a shield information barrier report object.", "type": "object", "allOf": [ { @@ -35165,7 +35165,7 @@ ] }, "status": { - "description": "Status of the shield information report", + "description": "Status of the shield information report.", "type": "string", "example": "pending", "enum": [ @@ -35217,16 +35217,16 @@ ] }, "ShieldInformationBarrierReport--Base": { - "description": "A base representation of a\nshield information barrier report object", + "description": "A base representation of a\nshield information barrier report object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier report", + "description": "The unique identifier for the shield information barrier report.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier report", + "description": "The type of the shield information barrier report.", "type": "string", "example": "shield_information_barrier_report", "enum": [ @@ -35251,7 +35251,7 @@ "type": "object", "properties": { "folder_id": { - "description": "Folder ID for locating this report", + "description": "Folder ID for locating this report.", "type": "string", "example": "124235" } @@ -35268,7 +35268,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35301,16 +35301,16 @@ "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierSegment": { - "description": "A shield information barrier segment object", + "description": "A shield information barrier segment object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier segment", + "description": "The unique identifier for the shield information barrier segment.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier segment", + "description": "The type of the shield information barrier segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35321,12 +35321,12 @@ "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "name": { - "description": "Name of the shield information barrier segment", + "description": "Name of the shield information barrier segment.", "type": "string", "example": "Investment Banking" }, "description": { - "description": "Description of the shield information barrier segment", + "description": "Description of the shield information barrier segment.", "type": "string", "example": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'" }, @@ -35368,7 +35368,7 @@ "x-box-tag": "shield_information_barrier_segments" }, "ShieldInformationBarrierSegmentMember": { - "description": "A standard representation of a\nshield information barrier segment member object", + "description": "A standard representation of a\nshield information barrier segment member object.", "type": "object", "allOf": [ { @@ -35389,7 +35389,7 @@ "example": "432554" }, "type": { - "description": "The type of the shield information barrier segment", + "description": "The type of the shield information barrier segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35454,16 +35454,16 @@ ] }, "ShieldInformationBarrierSegmentMember--Base": { - "description": "A base representation of a\nshield information barrier segment member object", + "description": "A base representation of a\nshield information barrier segment member object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the\nshield information barrier segment member", + "description": "The unique identifier for the\nshield information barrier segment member.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier segment member", + "description": "The type of the shield information barrier segment member.", "type": "string", "example": "shield_information_barrier_segment_member", "enum": [ @@ -35482,7 +35482,7 @@ ] }, "ShieldInformationBarrierSegmentMember--Mini": { - "description": "A mini representation of a\nshield information barrier segment member object", + "description": "A mini representation of a\nshield information barrier segment member object.", "type": "object", "allOf": [ { @@ -35514,12 +35514,12 @@ ] }, "ShieldInformationBarrierSegmentMembers": { - "description": "List of Shield Information Barrier Member objects", + "description": "List of Shield Information Barrier Member objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35538,7 +35538,7 @@ { "properties": { "entries": { - "description": "A list of shield information\nbarrier segment members", + "description": "A list of shield information\nbarrier segment members.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember" @@ -35552,7 +35552,7 @@ "x-box-tag": "shield_information_barrier_segment_members" }, "ShieldInformationBarrierSegmentRestriction": { - "description": "A standard representation of a\nsegment restriction of a shield information barrier\nobject", + "description": "A standard representation of a\nsegment restriction of a shield information barrier\nobject.", "type": "object", "allOf": [ { @@ -35613,11 +35613,11 @@ ] }, "ShieldInformationBarrierSegmentRestriction--Base": { - "description": "A base representation of\na segment restriction object for\nthe shield information barrier", + "description": "A base representation of\na segment restriction object for\nthe shield information barrier.", "type": "object", "properties": { "type": { - "description": "Shield information barrier segment restriction", + "description": "Shield information barrier segment restriction.", "type": "string", "example": "shield_information_barrier_segment_restriction", "enum": [ @@ -35645,7 +35645,7 @@ ] }, "ShieldInformationBarrierSegmentRestriction--Mini": { - "description": "A mini representation of\na segment restriction object for\nthe shield information barrier", + "description": "A mini representation of\na segment restriction object for\nthe shield information barrier.", "type": "object", "allOf": [ { @@ -35663,7 +35663,7 @@ "example": "1910967" }, "type": { - "description": "The type of the shield information barrier segment", + "description": "The type of the shield information barrier segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35682,7 +35682,7 @@ "example": "1910967" }, "type": { - "description": "The type of the shield information segment", + "description": "The type of the shield information segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35709,12 +35709,12 @@ ] }, "ShieldInformationBarrierSegmentRestrictions": { - "description": "List of shield information barrier segment restriction objects", + "description": "List of shield information barrier segment restriction objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35733,7 +35733,7 @@ { "properties": { "entries": { - "description": "A list of shield information barrier\nsegment restriction objects", + "description": "A list of shield information barrier\nsegment restriction objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction" @@ -35747,12 +35747,12 @@ "x-box-tag": "shield_information_barrier_segment_restrictions" }, "ShieldInformationBarrierSegments": { - "description": "List of Shield Information Barrier Segment objects", + "description": "List of Shield Information Barrier Segment objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35771,7 +35771,7 @@ { "properties": { "entries": { - "description": "A list of shield information barrier\nsegments", + "description": "A list of shield information barrier\nsegments.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegment" @@ -35785,12 +35785,12 @@ "x-box-tag": "shield_information_barrier_segments" }, "ShieldInformationBarriers": { - "description": "List of Shield Information Barrier objects", + "description": "List of Shield Information Barrier objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35809,7 +35809,7 @@ { "properties": { "entries": { - "description": "A list of shield information barrier objects", + "description": "A list of shield information barrier objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrier" @@ -35832,7 +35832,7 @@ { "properties": { "type": { - "description": "object type", + "description": "The value will always be `sign-request`.", "type": "string", "example": "sign-request", "enum": [ @@ -35935,7 +35935,7 @@ "nullable": false }, "collaborator_level": { - "description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\"", + "description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\".", "type": "string", "example": "owner", "nullable": true @@ -36075,7 +36075,7 @@ "nullable": true }, "signature_color": { - "description": "Force a specific color for the signature (blue, black, or red)", + "description": "Force a specific color for the signature (blue, black, or red).", "type": "string", "example": "blue", "enum": [ @@ -36137,7 +36137,7 @@ "example": true }, "order": { - "description": "Order of the signer", + "description": "Order of the signer.", "type": "integer", "example": 2, "minimum": 0 @@ -36186,7 +36186,7 @@ "nullable": true }, "suppress_notifications": { - "description": "If true, no emails about the sign request will be sent", + "description": "If true, no emails about the sign request will be sent.", "type": "boolean", "example": false, "nullable": true @@ -36205,19 +36205,19 @@ "nullable": true }, "text_value": { - "description": "Text prefill value", + "description": "Text prefill value.", "type": "string", "example": "text", "nullable": true }, "checkbox_value": { - "description": "Checkbox prefill value", + "description": "Checkbox prefill value.", "type": "boolean", "example": true, "nullable": true }, "date_value": { - "description": "Date prefill value", + "description": "Date prefill value.", "type": "string", "format": "date", "example": "2021-04-26", @@ -36236,7 +36236,7 @@ { "properties": { "has_viewed_document": { - "description": "Set to `true` if the signer views the document", + "description": "Set to `true` if the signer views the document.", "type": "boolean", "example": true, "readOnly": true @@ -36277,7 +36277,7 @@ "readOnly": true }, "embed_url": { - "description": "URL to direct a signer to for signing", + "description": "URL to direct a signer to for signing.", "type": "string", "example": "https://example.com", "nullable": true, @@ -36298,7 +36298,7 @@ "title": "Signer fields for Box Sign request response" }, "SignRequestSignerInput": { - "description": "Input created by a Signer on a Sign Request", + "description": "Input created by a Signer on a Sign Request.", "type": "object", "allOf": [ { @@ -36307,7 +36307,7 @@ { "properties": { "type": { - "description": "Type of input", + "description": "Type of input.", "type": "string", "example": "text", "enum": [ @@ -36320,7 +36320,7 @@ ] }, "content_type": { - "description": "Content type of input", + "description": "Content type of input.", "type": "string", "example": "signature", "enum": [ @@ -36342,12 +36342,12 @@ ] }, "page_index": { - "description": "Index of page that the input is on", + "description": "Index of page that the input is on.", "type": "integer", "example": 4 }, "read_only": { - "description": "Whether this input was defined as read-only(immutable by signers) or not", + "description": "Whether this input was defined as read-only(immutable by signers) or not.", "type": "boolean", "example": true } @@ -36365,7 +36365,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -36398,13 +36398,13 @@ "x-box-tag": "sign_requests" }, "SignTemplate": { - "description": "A Box Sign template object", + "description": "A Box Sign template object.", "type": "object", "allOf": [ { "properties": { "type": { - "description": "object type", + "description": "The value will always be `sign-template`.", "type": "string", "example": "sign-template", "enum": [ @@ -36423,19 +36423,19 @@ "nullable": true }, "email_subject": { - "description": "Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.", + "description": "Subject of signature request email. This is cleaned by sign\nrequest. If this field is not passed, a default subject will be used.", "type": "string", "example": "Sign Request from Acme", "nullable": true }, "email_message": { - "description": "Message to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.", + "description": "Message to include in signature request email. The field\nis cleaned through sanitization of specific characters. However,\nsome html tags are allowed. Links included in the\nmessage are also converted to hyperlinks in the email. The\nmessage may contain the following html tags including `a`, `abbr`,\n`acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and\n`strong`. Be aware that when the text\nto html ratio is too high, the email\nmay end up in spam filters. Custom styles on\nthese tags are not allowed.\nIf this field is not passed, a default message will be used.", "type": "string", "example": "Hello! Please sign the document below", "nullable": true }, "days_valid": { - "description": "Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.", + "description": "Set the number of days after which the\ncreated signature request will automatically\nexpire if not completed. By default, we do\nnot apply any expiration date on signature\nrequests, and the signature request does not expire.", "type": "integer", "example": 2, "maximum": 730, @@ -36453,19 +36453,19 @@ ] }, "source_files": { - "description": "List of files to create a signing document from. Only the ID and type fields are required for each file.", + "description": "List of files to create a signing document from.\nOnly the ID and type fields are required\nfor each file.", "type": "array", "items": { "$ref": "#/components/schemas/File--Mini" } }, "are_fields_locked": { - "description": "Indicates if the template input fields are editable or not.", + "description": "Indicates if the template input\nfields are editable or not.", "type": "boolean", "example": false }, "are_options_locked": { - "description": "Indicates if the template document options are editable or not, for example renaming the document.", + "description": "Indicates if the template document options\nare editable or not,\nfor example renaming the document.", "type": "boolean", "example": true }, @@ -36480,7 +36480,7 @@ "example": true }, "are_files_locked": { - "description": "Indicates if the template files are editable or not. This includes deleting or renaming template files.", + "description": "Indicates if the template files are editable or not.\nThis includes deleting or renaming template files.", "type": "boolean", "example": true }, @@ -36492,7 +36492,7 @@ } }, "additional_info": { - "description": "Additional information on which fields are required and which fields are not editable.", + "description": "Additional information on which fields are\nrequired and which fields are not editable.", "type": "object", "properties": { "non_editable": { @@ -36547,7 +36547,7 @@ } }, "ready_sign_link": { - "description": "Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.", + "description": "Box's ready-sign link feature enables you to create a\nlink to a signature request that\nyou've created from a template. Use this link\nwhen you want to post a signature request\non a public form — such as an email, social media post,\nor web page — without knowing who the signers will be.\nNote: The ready-sign link feature is\nlimited to Enterprise Plus customers and not\navailable to Box Verified Enterprises.", "type": "object", "nullable": true, "properties": { @@ -36592,7 +36592,7 @@ "nullable": true, "properties": { "company_name": { - "description": "Name of the company", + "description": "Name of the company.", "type": "string", "example": "Corporation inc.", "nullable": true @@ -36630,7 +36630,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -36673,29 +36673,29 @@ "type": "object", "properties": { "$canEdit": { - "description": "Whether the user can edit this metadata", + "description": "Whether the user can edit this metadata.", "type": "boolean", "example": true }, "$id": { - "description": "A UUID to identify the metadata object", + "description": "A UUID to identify the metadata object.", "type": "string", "format": "uuid", "example": "01234500-12f1-1234-aa12-b1d234cb567e", "maxLength": 36 }, "$parent": { - "description": "An ID for the parent folder", + "description": "An ID for the parent folder.", "type": "string", "example": "folder_59449484661," }, "$scope": { - "description": "An ID for the scope in which this template\nhas been applied", + "description": "An ID for the scope in which this template\nhas been applied.", "type": "string", "example": "enterprise_27335" }, "$template": { - "description": "The name of the template", + "description": "The name of the template.", "type": "string", "example": "properties" }, @@ -36744,7 +36744,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -36761,15 +36761,15 @@ { "title": "Skill", "type": "object", - "description": "An object representing a skill", + "description": "An object representing a skill.", "properties": { "id": { - "description": "The unique identifier for this skill", + "description": "The unique identifier for this skill.", "type": "string", "example": "11446498" }, "type": { - "description": "`skill`", + "description": "The value will always be `skill`.", "type": "string", "example": "skill", "enum": [ @@ -36777,28 +36777,28 @@ ] }, "name": { - "description": "The name of the skill", + "description": "The name of the skill.", "type": "string", "example": "Hello World Skill" }, "api_key": { - "description": "The client ID of the application", + "description": "The client ID of the application.", "type": "string", "example": "hxel2s12wd2h9r8ne103c4gjbqefofih" } } }, { - "description": "The skill that triggered this invocation" + "description": "The skill that triggered this invocation." } ] }, "token": { - "description": "The read-only and read-write access tokens for this item", + "description": "The read-only and read-write access tokens for this item.", "type": "object", "properties": { "read": { - "description": "The basics of an access token", + "description": "The basics of an access token.", "type": "object", "properties": { "access_token": { @@ -36829,7 +36829,7 @@ } }, "write": { - "description": "The basics of an access token", + "description": "The basics of an access token.", "type": "object", "properties": { "access_token": { @@ -36878,7 +36878,7 @@ ] }, "message": { - "description": "Status information", + "description": "Status information.", "type": "string", "example": "Example" }, @@ -36901,7 +36901,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "trigger": { - "description": "Action that triggered the invocation", + "description": "Action that triggered the invocation.", "type": "string", "example": "FILE_CONTENT" }, @@ -36910,7 +36910,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -36918,7 +36918,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -36926,14 +36926,14 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise that this invocation was triggered for" + "description": "The enterprise that this invocation was triggered for." } ] }, @@ -36950,7 +36950,7 @@ ] }, { - "description": "The item that caused the invocation to trigger" + "description": "The item that caused the invocation to trigger." } ] }, @@ -36960,7 +36960,7 @@ "$ref": "#/components/schemas/Event" }, { - "description": "The event that triggered this invocation" + "description": "The event that triggered this invocation." } ] } @@ -36980,7 +36980,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -36988,7 +36988,7 @@ ] }, "skill_card_type": { - "description": "`status`", + "description": "The value will always be `status`.", "type": "string", "example": "status", "enum": [ @@ -37045,7 +37045,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -37068,7 +37068,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -37104,7 +37104,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -37129,7 +37129,7 @@ { "properties": { "entries": { - "description": "A list of storage policies", + "description": "A list of storage policies.", "type": "array", "items": { "$ref": "#/components/schemas/StoragePolicy" @@ -37152,7 +37152,7 @@ { "properties": { "name": { - "description": "A descriptive name of the region", + "description": "A descriptive name of the region.", "type": "string", "example": "Montreal / Dublin" } @@ -37164,16 +37164,16 @@ "x-box-variant": "standard" }, "StoragePolicy--Mini": { - "description": "A mini description of a Storage Policy object", + "description": "A mini description of a Storage Policy object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this storage policy", + "description": "The unique identifier for this storage policy.", "type": "string", "example": "11446498" }, "type": { - "description": "`storage_policy`", + "description": "The value will always be `storage_policy`.", "type": "string", "example": "storage_policy", "enum": [ @@ -37195,7 +37195,7 @@ ] }, "StoragePolicyAssignment": { - "description": "The assignment of a storage policy to a user or enterprise", + "description": "The assignment of a storage policy to a user or enterprise.", "type": "object", "properties": { "id": { @@ -37204,7 +37204,7 @@ "example": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw" }, "type": { - "description": "`storage_policy_assignment`", + "description": "The value will always be `storage_policy_assignment`.", "type": "string", "example": "storage_policy_assignment", "enum": [ @@ -37217,7 +37217,7 @@ "$ref": "#/components/schemas/StoragePolicy--Mini" }, { - "description": "The assigned storage policy" + "description": "The assigned storage policy." } ] }, @@ -37225,23 +37225,23 @@ "allOf": [ { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } } }, { - "description": "The enterprise or use the policy is assigned to" + "description": "The enterprise or use the policy is assigned to." } ] } @@ -37260,7 +37260,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -37285,7 +37285,7 @@ { "properties": { "entries": { - "description": "A list of storage policy assignments", + "description": "A list of storage policy assignments.", "type": "array", "items": { "$ref": "#/components/schemas/StoragePolicyAssignment" @@ -37303,12 +37303,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this task", + "description": "The unique identifier for this task.", "type": "string", "example": "11446498" }, "type": { - "description": "`task`", + "description": "The value will always be `task`.", "type": "string", "example": "task", "enum": [ @@ -37321,12 +37321,12 @@ "$ref": "#/components/schemas/File--Mini" }, { - "description": "The file associated with the task" + "description": "The file associated with the task." } ] }, "due_at": { - "description": "When the task is due", + "description": "When the task is due.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37341,7 +37341,7 @@ ] }, "message": { - "description": "A message that will be included with the task", + "description": "A message that will be included with the task.", "type": "string", "example": "Legal review" }, @@ -37351,12 +37351,12 @@ "$ref": "#/components/schemas/TaskAssignments" }, { - "description": "A collection of task assignment objects\nassociated with the task" + "description": "A collection of task assignment objects\nassociated with the task." } ] }, "is_completed": { - "description": "Whether the task has been completed", + "description": "Whether the task has been completed.", "type": "boolean", "example": true }, @@ -37366,12 +37366,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the task" + "description": "The user who created the task." } ] }, "created_at": { - "description": "When the task object was created", + "description": "When the task object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37395,12 +37395,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this task assignment", + "description": "The unique identifier for this task assignment.", "type": "string", "example": "11446498" }, "type": { - "description": "`task_assignment`", + "description": "The value will always be `task_assignment`.", "type": "string", "example": "task_assignment", "enum": [ @@ -37477,7 +37477,7 @@ "x-box-tag": "task_assignments" }, "TaskAssignments": { - "description": "A list of task assignments", + "description": "A list of task assignments.", "type": "object", "properties": { "total_count": { @@ -37487,7 +37487,7 @@ "example": 100 }, "entries": { - "description": "A list of task assignments", + "description": "A list of task assignments.", "type": "array", "items": { "$ref": "#/components/schemas/TaskAssignment" @@ -37499,7 +37499,7 @@ "x-box-tag": "task_assignments" }, "Tasks": { - "description": "A list of tasks", + "description": "A list of tasks.", "type": "object", "properties": { "total_count": { @@ -37509,7 +37509,7 @@ "example": 5000 }, "entries": { - "description": "A list of tasks", + "description": "A list of tasks.", "type": "array", "items": { "$ref": "#/components/schemas/Task" @@ -37521,7 +37521,7 @@ "x-box-tag": "tasks" }, "TemplateSigner": { - "description": "The schema for a Signer for Templates", + "description": "The schema for a Signer for Templates.", "type": "object", "properties": { "inputs": { @@ -37532,7 +37532,7 @@ "readOnly": true }, "email": { - "description": "Email address of the signer", + "description": "Email address of the signer.", "type": "string", "example": "example@mail.com", "nullable": true @@ -37554,7 +37554,7 @@ "example": true }, "order": { - "description": "Order of the signer", + "description": "Order of the signer.", "type": "integer", "example": 2, "minimum": 0 @@ -37598,7 +37598,7 @@ "title": "Signer fields for Templates" }, "TemplateSignerInput": { - "description": "Input created by a Signer on a Template", + "description": "Input created by a Signer on a Template.", "type": "object", "allOf": [ { @@ -37607,7 +37607,7 @@ { "properties": { "type": { - "description": "Type of input", + "description": "Type of input.", "type": "string", "example": "text", "enum": [ @@ -37621,7 +37621,7 @@ ] }, "content_type": { - "description": "Content type of input", + "description": "Content type of input.", "type": "string", "example": "text", "enum": [ @@ -37659,7 +37659,7 @@ "nullable": true }, "dropdown_choices": { - "description": "When the input is of the type `dropdown` this values will be filled with all the dropdown options.", + "description": "When the input is of the type `dropdown` this\nvalues will be filled with all the\ndropdown options.", "type": "array", "items": { "type": "string" @@ -37672,7 +37672,7 @@ "nullable": true }, "group_id": { - "description": "When the input is of type `radio` they can be grouped to gather with this identifier.", + "description": "When the input is of type `radio` they can be\ngrouped to gather with this identifier.", "type": "string", "example": "da317330-225a-4c72-89ad-0d6dcaaf4df6", "nullable": true @@ -37716,7 +37716,7 @@ "nullable": true }, "read_only": { - "description": "Whether this input was defined as read-only(immutable by signers) or not", + "description": "Whether this input was defined as read-only(immutable by signers) or not.", "type": "boolean", "example": true } @@ -37738,7 +37738,7 @@ { "properties": { "status": { - "description": "Whether these terms are enabled or not", + "description": "Whether these terms are enabled or not.", "type": "string", "example": "enabled", "enum": [ @@ -37751,7 +37751,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -37759,7 +37759,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -37767,19 +37767,19 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise these terms apply to" + "description": "The enterprise these terms apply to." } ] }, "tos_type": { - "description": "Whether to apply these terms to managed users or external users", + "description": "Whether to apply these terms to managed users or external users.", "type": "string", "example": "managed", "enum": [ @@ -37793,7 +37793,7 @@ "example": "By using this service, you agree to ..." }, "created_at": { - "description": "When the legal item was created", + "description": "When the legal item was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37821,7 +37821,7 @@ "example": "11446498" }, "type": { - "description": "`terms_of_service`", + "description": "The value will always be `terms_of_service`.", "type": "string", "example": "terms_of_service", "enum": [ @@ -37843,16 +37843,16 @@ ] }, "TermsOfServiceUserStatus": { - "description": "The association between a Terms of Service and a user", + "description": "The association between a Terms of Service and a user.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this terms of service user status", + "description": "The unique identifier for this terms of service user status.", "type": "string", "example": "11446498" }, "type": { - "description": "`terms_of_service_user_status`", + "description": "The value will always be `terms_of_service_user_status`.", "type": "string", "example": "terms_of_service_user_status", "enum": [ @@ -37865,7 +37865,7 @@ "$ref": "#/components/schemas/TermsOfService--Base" }, { - "description": "The terms of service" + "description": "The terms of service." } ] }, @@ -37875,17 +37875,17 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user" + "description": "The user." } ] }, "is_accepted": { - "description": "If the user has accepted the terms of services", + "description": "If the user has accepted the terms of services.", "type": "boolean", "example": true }, "created_at": { - "description": "When the legal item was created", + "description": "When the legal item was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37906,7 +37906,7 @@ "x-box-tag": "terms_of_service_user_statuses" }, "TermsOfServiceUserStatuses": { - "description": "A list of terms of service user statuses", + "description": "A list of terms of service user statuses.", "type": "object", "properties": { "total_count": { @@ -37916,7 +37916,7 @@ "example": 2 }, "entries": { - "description": "A list of terms of service user statuses", + "description": "A list of terms of service user statuses.", "type": "array", "items": { "$ref": "#/components/schemas/TermsOfServiceUserStatus" @@ -37928,7 +37928,7 @@ "x-box-tag": "terms_of_service_user_statuses" }, "TermsOfServices": { - "description": "A list of terms of services", + "description": "A list of terms of services.", "type": "object", "properties": { "total_count": { @@ -37938,7 +37938,7 @@ "example": 2 }, "entries": { - "description": "A list of terms of service objects", + "description": "A list of terms of service objects.", "type": "array", "items": { "$ref": "#/components/schemas/TermsOfService" @@ -37960,7 +37960,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -37968,7 +37968,7 @@ ] }, "skill_card_type": { - "description": "`timeline`", + "description": "The value will always be `timeline`.", "type": "string", "example": "timeline", "enum": [ @@ -37999,7 +37999,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -38022,7 +38022,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -38106,7 +38106,7 @@ "type": "object", "properties": { "type": { - "description": "`tracking_code`", + "description": "The value will always be `tracking_code`.", "type": "string", "example": "tracking_code", "enum": [ @@ -38114,12 +38114,12 @@ ] }, "name": { - "description": "The name of the tracking code, which must be preconfigured in\nthe Admin Console", + "description": "The name of the tracking code, which must be preconfigured in\nthe Admin Console.", "type": "string", "example": "department" }, "value": { - "description": "The value of the tracking code", + "description": "The value of the tracking code.", "type": "string", "example": "Sales" } @@ -38137,7 +38137,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -38145,7 +38145,7 @@ ] }, "skill_card_type": { - "description": "`transcript`", + "description": "The value will always be `transcript`.", "type": "string", "example": "transcript", "enum": [ @@ -38176,7 +38176,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -38199,7 +38199,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -38227,7 +38227,7 @@ "type": "array", "items": { "type": "object", - "description": "An entry in the `entries` attribute of a metadata card", + "description": "An entry in the `entries` attribute of a metadata card.", "properties": { "text": { "description": "The text of the entry. This would be the transcribed text assigned\nto the entry on the timeline.", @@ -38263,7 +38263,7 @@ "invocation", "entries" ], - "title": "Transcript Skill Card", + "title": "Transcript Skill Card.", "x-box-resource-id": "transcript_skill_card", "x-box-tag": "skills" }, @@ -38284,7 +38284,7 @@ "nullable": true }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -38306,7 +38306,7 @@ ] }, "name": { - "description": "The name of the file", + "description": "The name of the file.", "type": "string", "example": "Contract.pdf" }, @@ -38328,7 +38328,7 @@ ] }, "description": { - "description": "The optional description of this file", + "description": "The optional description of this file.", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 256, @@ -38359,14 +38359,14 @@ "nullable": false }, "entries": { - "description": "Array of folders for this item's path collection", + "description": "Array of folders for this item's path collection.", "type": "array", "items": { "type": "object", - "description": "The parent folder for this item", + "description": "The parent folder for this item.", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -38379,13 +38379,13 @@ "example": "123456789" }, "sequence_id": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true }, "etag": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true @@ -38457,7 +38457,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this file" + "description": "The user who created this file." } ] }, @@ -38467,7 +38467,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this file" + "description": "The user who last modified this file." }, { "nullable": false @@ -38480,7 +38480,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this file" + "description": "The user who owns this file." }, { "nullable": false @@ -38553,7 +38553,7 @@ "nullable": true }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -38575,7 +38575,7 @@ ] }, "name": { - "description": "The name of the file", + "description": "The name of the file.", "type": "string", "example": "Contract.pdf" }, @@ -38597,7 +38597,7 @@ ] }, "description": { - "description": "The optional description of this file", + "description": "The optional description of this file.", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 256, @@ -38628,7 +38628,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -38691,7 +38691,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this file" + "description": "The user who created this file." } ] }, @@ -38701,7 +38701,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this file" + "description": "The user who last modified this file." }, { "nullable": false @@ -38714,7 +38714,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this file" + "description": "The user who owns this file." }, { "nullable": false @@ -38787,7 +38787,7 @@ "nullable": true }, "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -38832,7 +38832,7 @@ "allOf": [ { "type": "string", - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false @@ -38868,14 +38868,14 @@ "nullable": false }, "entries": { - "description": "Array of folders for this item's path collection", + "description": "Array of folders for this item's path collection.", "type": "array", "items": { "type": "object", - "description": "The parent folder for this item", + "description": "The parent folder for this item.", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -38888,13 +38888,13 @@ "example": "123456789" }, "sequence_id": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true }, "etag": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true @@ -38924,7 +38924,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this folder" + "description": "The user who created this folder." }, { "nullable": false @@ -39055,7 +39055,7 @@ "nullable": true }, "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -39100,7 +39100,7 @@ "allOf": [ { "type": "string", - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false @@ -39136,7 +39136,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -39159,7 +39159,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this folder" + "description": "The user who created this folder." }, { "nullable": false @@ -39244,7 +39244,7 @@ ] }, "item_status": { - "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash\n* `trashed` when the item has been moved to the trash but not deleted\n* `deleted` when the item has been permanently deleted.", + "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash,\n* `trashed` when the item has been moved to the trash but not deleted,\n* `deleted` when the item has been permanently deleted.", "type": "string", "example": "active", "enum": [ @@ -39264,7 +39264,7 @@ "type": "object", "properties": { "type": { - "description": "`web_link`", + "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ @@ -39272,7 +39272,7 @@ ] }, "id": { - "description": "The unique identifier for this web link", + "description": "The unique identifier for this web link.", "type": "string", "example": "11446498" }, @@ -39295,12 +39295,12 @@ "example": "1" }, "name": { - "description": "The name of the web link", + "description": "The name of the web link.", "type": "string", "example": "My Bookmark" }, "url": { - "description": "The URL this web link points to", + "description": "The URL this web link points to.", "type": "string", "example": "https://www.example.com/example/1234" }, @@ -39310,7 +39310,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The parent object the web link belongs to" + "description": "The parent object the web link belongs to." } ] }, @@ -39338,14 +39338,14 @@ "nullable": false }, "entries": { - "description": "Array of folders for this item's path collection", + "description": "Array of folders for this item's path collection.", "type": "array", "items": { "type": "object", - "description": "The parent folder for this item", + "description": "The parent folder for this item.", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -39358,13 +39358,13 @@ "example": "123456789" }, "sequence_id": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true }, "etag": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true @@ -39420,7 +39420,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this web link" + "description": "The user who created this web link." } ] }, @@ -39430,7 +39430,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this web link" + "description": "The user who last modified this web link." } ] }, @@ -39440,7 +39440,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this web link" + "description": "The user who owns this web link." } ] }, @@ -39451,7 +39451,7 @@ "nullable": true }, "item_status": { - "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted", + "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.", "type": "string", "example": "trashed", "enum": [ @@ -39470,7 +39470,7 @@ "type": "object", "properties": { "type": { - "description": "`web_link`", + "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ @@ -39478,7 +39478,7 @@ ] }, "id": { - "description": "The unique identifier for this web link", + "description": "The unique identifier for this web link.", "type": "string", "example": "11446498" }, @@ -39501,12 +39501,12 @@ "example": "1" }, "name": { - "description": "The name of the web link", + "description": "The name of the web link.", "type": "string", "example": "My Bookmark" }, "url": { - "description": "The URL this web link points to", + "description": "The URL this web link points to.", "type": "string", "example": "https://www.example.com/example/1234" }, @@ -39516,7 +39516,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The parent object the web link belongs to" + "description": "The parent object the web link belongs to." } ] }, @@ -39544,7 +39544,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -39591,7 +39591,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this web link" + "description": "The user who created this web link." } ] }, @@ -39601,7 +39601,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this web link" + "description": "The user who last modified this web link." } ] }, @@ -39611,7 +39611,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this web link" + "description": "The user who owns this web link." } ] }, @@ -39622,7 +39622,7 @@ "nullable": true }, "item_status": { - "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted", + "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.", "type": "string", "example": "trashed", "enum": [ @@ -39698,7 +39698,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -39723,15 +39723,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -39747,7 +39747,7 @@ { "properties": { "entries": { - "description": "A list of uploaded chunks for an upload\nsession", + "description": "A list of uploaded chunks for an upload\nsession.", "type": "array", "items": { "$ref": "#/components/schemas/UploadPart" @@ -39765,12 +39765,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this session", + "description": "The unique identifier for this session.", "type": "string", "example": "F971964745A5CD0C001BBE4E58196BFD" }, "type": { - "description": "`upload_session`", + "description": "The value will always be `upload_session`.", "type": "string", "example": "upload_session", "enum": [ @@ -39809,12 +39809,12 @@ "type": "object", "properties": { "upload_part": { - "description": "The URL to upload parts to", + "description": "The URL to upload parts to.", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" }, "commit": { - "description": "The URL used to commit the file", + "description": "The URL used to commit the file.", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit" }, @@ -39860,7 +39860,7 @@ "example": "https://upload-las.app.box.com/api/2.0/files/content?upload_session_id=1234" }, "upload_token": { - "description": "An optional access token to use to upload the file", + "description": "An optional access token to use to upload the file.", "type": "string", "example": "Pc3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQP" } @@ -39882,7 +39882,7 @@ "x-box-tag": "chunked_uploads" }, "User": { - "description": "A standard representation of a user, as returned from any\nuser API endpoints by default", + "description": "A standard representation of a user, as returned from any\nuser API endpoints by default.", "type": "object", "allOf": [ { @@ -39891,13 +39891,13 @@ { "properties": { "created_at": { - "description": "When the user object was created", + "description": "When the user object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the user object was last modified", + "description": "When the user object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -39908,31 +39908,31 @@ "example": "en" }, "timezone": { - "description": "The user's timezone", + "description": "The user's timezone.", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "space_amount": { - "description": "The user’s total available space amount in bytes", + "description": "The user’s total available space amount in bytes.", "type": "integer", "format": "int64", "example": 11345156112 }, "space_used": { - "description": "The amount of space in use by the user", + "description": "The amount of space in use by the user.", "type": "integer", "format": "int64", "example": 1237009912 }, "max_upload_size": { - "description": "The maximum individual file size in bytes the user can have", + "description": "The maximum individual file size in bytes the user can have.", "type": "integer", "format": "int64", "example": 2147483648 }, "status": { - "description": "The user's account status", + "description": "The user's account status.", "type": "string", "example": "active", "enum": [ @@ -39943,25 +39943,25 @@ ] }, "job_title": { - "description": "The user’s job title", + "description": "The user’s job title.", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { - "description": "The user’s phone number", + "description": "The user’s phone number.", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { - "description": "The user’s address", + "description": "The user’s address.", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 }, "avatar_url": { - "description": "URL of the user’s avatar image", + "description": "URL of the user’s avatar image.", "type": "string", "example": "https://www.box.com/api/avatar/large/181216415" }, @@ -39994,12 +39994,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this user", + "description": "The unique identifier for this user.", "type": "string", "example": "11446498" }, "type": { - "description": "`user`", + "description": "The value will always be `user`.", "type": "string", "example": "user", "enum": [ @@ -40067,7 +40067,7 @@ { "properties": { "role": { - "description": "The user’s enterprise role", + "description": "The user’s enterprise role.", "type": "string", "example": "admin", "enum": [ @@ -40084,27 +40084,27 @@ } }, "can_see_managed_users": { - "description": "Whether the user can see other enterprise users in their contact list", + "description": "Whether the user can see other enterprise users in their contact list.", "type": "boolean", "example": true }, "is_sync_enabled": { - "description": "Whether the user can use Box Sync", + "description": "Whether the user can use Box Sync.", "type": "boolean", "example": true }, "is_external_collab_restricted": { - "description": "Whether the user is allowed to collaborate with users outside their\nenterprise", + "description": "Whether the user is allowed to collaborate with users outside their\nenterprise.", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { - "description": "Whether to exempt the user from Enterprise device limits", + "description": "Whether to exempt the user from Enterprise device limits.", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { - "description": "Whether the user must use two-factor authentication", + "description": "Whether the user must use two-factor authentication.", "type": "boolean", "example": true }, @@ -40113,7 +40113,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -40121,7 +40121,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -40129,14 +40129,14 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "Representation of the user’s enterprise" + "description": "Representation of the user’s enterprise." } ] }, @@ -40151,12 +40151,12 @@ ] }, "hostname": { - "description": "The root (protocol, subdomain, domain) of any links that need to be\ngenerated for the user", + "description": "The root (protocol, subdomain, domain) of any links that need to be\ngenerated for the user.", "type": "string", "example": "https://example.app.box.com/" }, "is_platform_access_only": { - "description": "Whether the user is an App User", + "description": "Whether the user is an App User.", "type": "boolean", "example": true }, @@ -40182,14 +40182,14 @@ { "properties": { "name": { - "description": "The display name of this user", + "description": "The display name of this user.", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { - "description": "The primary email address of this user", + "description": "The primary email address of this user.", "type": "string", "format": "email", "example": "ceo@example.com", @@ -40242,14 +40242,14 @@ { "properties": { "name": { - "description": "The display name of this user", + "description": "The display name of this user.", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { - "description": "The primary email address of this user", + "description": "The primary email address of this user.", "type": "string", "format": "email", "example": "ceo@example.com", @@ -40268,7 +40268,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -40292,7 +40292,7 @@ }, { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -40317,15 +40317,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -40341,7 +40341,7 @@ { "properties": { "entries": { - "description": "A list of users", + "description": "A list of users.", "type": "array", "items": { "$ref": "#/components/schemas/User--Full" @@ -40355,20 +40355,20 @@ "x-box-tag": "users" }, "Watermark": { - "description": "A watermark is a semi-transparent overlay on an embedded file\npreview that displays a viewer's email address or user ID\nand the time of access over a file's content", + "description": "A watermark is a semi-transparent overlay on an embedded file\npreview that displays a viewer's email address or user ID\nand the time of access over a file's content.", "type": "object", "properties": { "watermark": { "type": "object", "properties": { "created_at": { - "description": "When this watermark was created", + "description": "When this watermark was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When this task was modified", + "description": "When this task was modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -40395,7 +40395,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The parent object the web link belongs to" + "description": "The parent object the web link belongs to." } ] }, @@ -40423,7 +40423,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -40472,7 +40472,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this web link" + "description": "The user who created this web link." } ] }, @@ -40482,7 +40482,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this web link" + "description": "The user who last modified this web link." } ] }, @@ -40492,7 +40492,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this web link" + "description": "The user who owns this web link." } ] }, @@ -40639,7 +40639,7 @@ ] }, "item_status": { - "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted", + "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.", "type": "string", "example": "active", "enum": [ @@ -40660,12 +40660,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this web link", + "description": "The unique identifier for this web link.", "type": "string", "example": "11446498" }, "type": { - "description": "`web_link`", + "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ @@ -40702,7 +40702,7 @@ { "properties": { "url": { - "description": "The URL this web link points to", + "description": "The URL this web link points to.", "type": "string", "example": "https://www.example.com/example/1234" }, @@ -40720,7 +40720,7 @@ ] }, "name": { - "description": "The name of the web link", + "description": "The name of the web link.", "type": "string", "example": "My Bookmark" } @@ -40746,7 +40746,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the webhook" + "description": "The user who created the webhook." } ] }, @@ -40757,18 +40757,18 @@ "example": "2012-12-12T10:53:43-08:00" }, "address": { - "description": "The URL that is notified by this webhook", + "description": "The URL that is notified by this webhook.", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for", + "description": "An array of event names that this webhook is\nto be triggered for.", "type": "array", "items": { "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -40834,7 +40834,7 @@ "example": "11446498" }, "type": { - "description": "`webhook`", + "description": "The value will always be `webhook`.", "type": "string", "example": "webhook", "enum": [ @@ -40842,16 +40842,16 @@ ] }, "target": { - "description": "The item that will trigger the webhook", + "description": "The item that will trigger the webhook.", "type": "object", "properties": { "id": { - "description": "The ID of the item to trigger a webhook", + "description": "The ID of the item to trigger a webhook.", "type": "string", "example": "1231232" }, "type": { - "description": "The type of item to trigger a webhook", + "description": "The type of item to trigger a webhook.", "type": "string", "example": "file", "enum": [ @@ -40876,12 +40876,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this webhook invocation", + "description": "The unique identifier for this webhook invocation.", "type": "string", "example": "11446498" }, "type": { - "description": "`webhook_event`", + "description": "The value will always be `webhook_event`.", "type": "string", "example": "webhook_event", "enum": [ @@ -40894,7 +40894,7 @@ "$ref": "#/components/schemas/Webhook" }, { - "description": "The webhook object that triggered this event" + "description": "The webhook object that triggered this event." } ] }, @@ -40904,7 +40904,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that triggered this event" + "description": "The user that triggered this event." } ] }, @@ -40920,7 +40920,7 @@ "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -40965,7 +40965,7 @@ ] }, { - "description": "The event name that triggered this webhook" + "description": "The event name that triggered this webhook." } ] }, @@ -40982,7 +40982,7 @@ ] }, { - "description": "The item that caused the event to trigger" + "description": "The item that caused the event to trigger." } ] } @@ -40997,7 +40997,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -41022,7 +41022,7 @@ { "properties": { "entries": { - "description": "A list of webhooks", + "description": "A list of webhooks.", "type": "array", "items": { "$ref": "#/components/schemas/Webhook--Mini" @@ -41049,15 +41049,15 @@ "type": "array", "items": { "type": "object", - "description": "A step in a Box Relay Workflow. Each flow contains a `Trigger` and\na collection of Outcomes to perform once the conditions of a\n`Trigger` are met", + "description": "A step in a Box Relay Workflow. Each flow contains a `Trigger` and\na collection of Outcomes to perform once the conditions of a\n`Trigger` are met.", "properties": { "id": { - "description": "The identifier of the flow", + "description": "The identifier of the flow.", "type": "string", "example": "12345" }, "type": { - "description": "The flow's resource type", + "description": "The flow's resource type.", "type": "string", "example": "flow", "enum": [ @@ -41070,7 +41070,7 @@ "type": "object", "properties": { "type": { - "description": "The trigger's resource type", + "description": "The trigger's resource type.", "type": "string", "example": "trigger", "enum": [ @@ -41078,7 +41078,7 @@ ] }, "trigger_type": { - "description": "The type of trigger selected for this flow", + "description": "The type of trigger selected for this flow.", "type": "string", "example": "WORKFLOW_MANUAL_START", "enum": [ @@ -41086,14 +41086,14 @@ ] }, "scope": { - "description": "List of trigger scopes", + "description": "List of trigger scopes.", "type": "array", "items": { "type": "object", - "description": "Object that describes where and how a Trigger condition is met", + "description": "Object that describes where and how a Trigger condition is met.", "properties": { "type": { - "description": "The trigger scope's resource type", + "description": "The trigger scope's resource type.", "type": "string", "example": "trigger_scope", "enum": [ @@ -41101,16 +41101,16 @@ ] }, "ref": { - "description": "Indicates the path of the condition value to check", + "description": "Indicates the path of the condition value to check.", "type": "string", "example": "/event/source/parameters/folder" }, "object": { - "description": "The object the `ref` points to", + "description": "The object the `ref` points to.", "type": "object", "properties": { "type": { - "description": "The type of the object", + "description": "The type of the object.", "type": "string", "example": "folder", "enum": [ @@ -41118,7 +41118,7 @@ ] }, "id": { - "description": "The id of the object", + "description": "The id of the object.", "type": "string", "example": "12345" } @@ -41130,7 +41130,7 @@ } }, { - "description": "Trigger that initiates flow" + "description": "Trigger that initiates flow." } ] }, @@ -41143,12 +41143,12 @@ "description": "List of outcomes to perform once the conditions of trigger are met.", "properties": { "id": { - "description": "The identifier of the outcome", + "description": "The identifier of the outcome.", "type": "string", "example": "12345" }, "type": { - "description": "The outcomes resource type", + "description": "The outcomes resource type.", "type": "string", "example": "outcome", "enum": [ @@ -41156,7 +41156,7 @@ ] }, "name": { - "description": "The name of the outcome", + "description": "The name of the outcome.", "type": "string", "example": "Task Approval Outcome" }, @@ -41166,7 +41166,7 @@ "title": "Action Type", "example": "assign_task", "type": "string", - "description": "The type of outcome", + "description": "The type of outcome.", "enum": [ "add_metadata", "assign_task", @@ -41194,23 +41194,23 @@ ] }, { - "description": "The type of outcome" + "description": "The type of outcome." } ] }, "if_rejected": { - "description": "If `action_type` is `assign_task` and the task is rejected, returns a\nlist of outcomes to complete", + "description": "If `action_type` is `assign_task` and the task is rejected, returns a\nlist of outcomes to complete.", "type": "array", "items": { "type": "object", "properties": { "id": { - "description": "The identifier of the outcome", + "description": "The identifier of the outcome.", "type": "string", "example": "12345" }, "type": { - "description": "The outcomes resource type", + "description": "The outcomes resource type.", "type": "string", "example": "outcome", "enum": [ @@ -41218,7 +41218,7 @@ ] }, "name": { - "description": "The name of the outcome", + "description": "The name of the outcome.", "type": "string", "example": "Approval Rejection Outcome" }, @@ -41228,7 +41228,7 @@ "title": "Action Type", "example": "assign_task", "type": "string", - "description": "The type of outcome", + "description": "The type of outcome.", "enum": [ "add_metadata", "assign_task", @@ -41256,7 +41256,7 @@ ] }, { - "description": "The type of outcome" + "description": "The type of outcome." } ] } @@ -41267,12 +41267,12 @@ } }, { - "description": "Actions that are completed once the flow is triggered" + "description": "Actions that are completed once the flow is triggered." } ] }, "created_at": { - "description": "When this flow was created", + "description": "When this flow was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -41283,7 +41283,7 @@ "$ref": "#/components/schemas/User--Base" }, { - "description": "The user who created this flow" + "description": "The user who created this flow." } ] } @@ -41307,13 +41307,13 @@ { "properties": { "created_at": { - "description": "The date and time when the workflow was created on Box", + "description": "The date and time when the workflow was created on Box.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "The date and time when the workflow was last updated on Box", + "description": "The date and time when the workflow was last updated on Box.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -41324,7 +41324,7 @@ "$ref": "#/components/schemas/User--Base" }, { - "description": "The user who created this workflow" + "description": "The user who created this workflow." } ] }, @@ -41334,7 +41334,7 @@ "$ref": "#/components/schemas/User--Base" }, { - "description": "The user who last modified this workflow" + "description": "The user who last modified this workflow." } ] } @@ -41350,12 +41350,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for the workflow", + "description": "The unique identifier for the workflow.", "type": "string", "example": "11446498" }, "type": { - "description": "`workflow`", + "description": "The value will always be `workflow`.", "type": "string", "example": "workflow", "enum": [ @@ -41363,7 +41363,7 @@ ] }, "name": { - "description": "The name of the workflow", + "description": "The name of the workflow.", "type": "string", "example": "New Hire Workflow" }, @@ -41373,7 +41373,7 @@ "example": "This workflow sets off a new hire approval flow" }, "is_enabled": { - "description": "Specifies if this workflow is enabled", + "description": "Specifies if this workflow is enabled.", "type": "boolean", "example": true } @@ -41394,7 +41394,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -41419,7 +41419,7 @@ { "properties": { "entries": { - "description": "A list of workflows", + "description": "A list of workflows.", "type": "array", "items": { "$ref": "#/components/schemas/Workflow" @@ -41463,12 +41463,12 @@ "description": "A file or folder for which a conflict was encountered, This object provides the type and identifier of the original item, as well as a mapping between its original name and it's new name as it will appear in the archive.", "properties": { "id": { - "description": "The identifier of the item", + "description": "The identifier of the item.", "type": "string", "example": "12345" }, "type": { - "description": "The type of this item", + "description": "The type of this item.", "type": "string", "example": "file", "enum": [ @@ -41477,7 +41477,7 @@ ] }, "original_name": { - "description": "The original name of this item", + "description": "Box Developer Documentation.", "type": "string", "example": "Report.pdf" }, @@ -41518,7 +41518,7 @@ "x-box-tag": "zip_downloads" }, "ZipDownloadRequest": { - "description": "A request to create a `zip` archive to download", + "description": "A request to create a `zip` archive to download.", "type": "object", "properties": { "items": { @@ -41998,7 +41998,7 @@ } ], "externalDocs": { - "description": "Box Developer Documentation", + "description": "Box Developer Documentation.", "url": "https://developer.box.com" } } \ No newline at end of file diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 5097a5d5..bf67badd 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,12 +14,12 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "8f64ba5ffc" + "x-box-commit-hash": "eff357f39b" }, "servers": [ { "url": "https://api.box.com/2.0", - "description": "Box Platform API server" + "description": "Box Platform API server." } ], "paths": { @@ -184,7 +184,7 @@ "delete": { "operationId": "delete_docgen_templates_id_v2025.0", "summary": "Delete Box Doc Gen template", - "description": "Unmarks file as Box Doc Gen template", + "description": "Unmarks file as Box Doc Gen template.", "parameters": [ { "name": "template_id", @@ -739,7 +739,7 @@ "get": { "operationId": "get_docgen_batch_jobs_id_v2025.0", "summary": "Get Box Doc Gen jobs by batch ID", - "description": "Lists Box Doc Gen jobs in a batch", + "description": "Lists Box Doc Gen jobs in a batch.", "parameters": [ { "name": "batch_id", @@ -1155,7 +1155,7 @@ "BoxVersionHeader": { "name": "box-version", "in": "header", - "description": "Version header", + "description": "Version header.", "allowEmptyValue": false, "required": true, "schema": { @@ -1169,11 +1169,11 @@ }, "schemas": { "ClientError": { - "description": "A generic error", + "description": "A generic error.", "type": "object", "properties": { "type": { - "description": "error", + "description": "The value will always be `error`.", "type": "string", "example": "error", "enum": [ @@ -1189,7 +1189,7 @@ "nullable": false }, "code": { - "description": "A Box-specific error code", + "description": "A Box-specific error code.", "type": "string", "example": "item_name_invalid", "enum": [ @@ -1221,14 +1221,11 @@ "context_info": { "description": "A free-form object that contains additional context\nabout the error. The possible fields are defined on\na per-endpoint basis. `message` is only one example.", "type": "object", - "nullable": true, - "properties": { - "message": { - "description": "More details on the error.", - "type": "string", - "example": "Something went wrong." - } - } + "example": { + "message": "Something went wrong" + }, + "additionalProperties": {}, + "nullable": true }, "help_url": { "description": "A URL that links to more information about why this error occurred.", @@ -1257,7 +1254,7 @@ "nullable": false }, "type": { - "description": "`docgen_batch`", + "description": "The value will always be `docgen_batch`.", "type": "string", "example": "docgen_batch", "enum": [ @@ -1312,14 +1309,14 @@ { "title": "Folder reference", "type": "object", - "description": "Folder reference", + "description": "Folder reference.", "required": [ "type", "id" ], "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -1328,7 +1325,7 @@ "nullable": false }, "id": { - "description": "ID of the folder", + "description": "ID of the folder.", "type": "string", "example": "42037322" } @@ -1431,7 +1428,7 @@ }, { "title": "OpenAPI 3.0 null schema type", - "description": "The definition for a null schema type in OpenAPI 3.0", + "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false @@ -1452,7 +1449,7 @@ }, { "title": "OpenAPI 3.0 null schema type", - "description": "The definition for a null schema type in OpenAPI 3.0", + "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false @@ -1513,7 +1510,7 @@ "nullable": false }, "type": { - "description": "`docgen_job`", + "description": "The value will always be `docgen_job`.", "type": "string", "example": "docgen_job", "enum": [ @@ -1607,7 +1604,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -1656,7 +1653,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -1754,7 +1751,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -1820,7 +1817,7 @@ { "properties": { "file_name": { - "description": "The name of the template", + "description": "The name of the template.", "type": "string", "example": "Official contract", "nullable": true @@ -1886,7 +1883,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -1929,12 +1926,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this enterprise", + "description": "The unique identifier for this enterprise.", "type": "string", "example": "1910967" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -1946,11 +1943,11 @@ "title": "Enterprise reference" }, "FileReference": { - "description": "File reference", + "description": "File reference.", "type": "object", "properties": { "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -1959,7 +1956,7 @@ "nullable": false }, "id": { - "description": "ID of the object", + "description": "ID of the object.", "type": "string", "example": "42037322", "nullable": false @@ -1982,7 +1979,7 @@ "nullable": false }, "type": { - "description": "`file_version`", + "description": "The value will always be `file_version`.", "type": "string", "example": "file_version", "enum": [ @@ -2027,7 +2024,7 @@ ] }, "description": { - "description": "Description of Shield List", + "description": "Description of Shield List.", "type": "string", "example": "A list of things that are shielded" }, @@ -2072,12 +2069,12 @@ "type": "object", "properties": { "id": { - "description": "Unique global identifier for this list", + "description": "Unique global identifier for this list.", "type": "string", "example": "12345678-1234-1234-1234-123456789012" }, "type": { - "description": "The type of object", + "description": "The type of object.", "type": "string", "example": "shield_list", "enum": [ @@ -2085,7 +2082,7 @@ ] }, "name": { - "description": "Name of Shield List", + "description": "Name of Shield List.", "type": "string", "example": "My Shield List" }, @@ -2111,7 +2108,7 @@ "x-box-tag": "shield_lists" }, "ShieldListContent": { - "description": "Representation of content of a Shield List", + "description": "Representation of content of a Shield List.", "type": "object", "oneOf": [ { @@ -2215,7 +2212,7 @@ ] }, "email_addresses": { - "description": "List of emails", + "description": "List of emails.", "type": "array", "items": { "type": "string" @@ -2250,7 +2247,7 @@ ] }, "integrations": { - "description": "List of integration", + "description": "List of integration.", "type": "array", "items": { "type": "object", @@ -2310,7 +2307,7 @@ "x-box-tag": "shield_lists" }, "ShieldListContentRequest": { - "description": "Representation of content of a Shield List", + "description": "Representation of content of a Shield List.", "type": "object", "oneOf": [ { @@ -2329,13 +2326,13 @@ "title": "Shield List Content for requests" }, "ShieldLists": { - "description": "List of Shield List objects", + "description": "List of Shield List objects.", "type": "object", "allOf": [ { "properties": { "entries": { - "description": "A list of shield list objects", + "description": "A list of shield list objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldList--Mini" @@ -2358,7 +2355,7 @@ "example": "My Shield List" }, "description": { - "description": "Description of Shield List: Optional.", + "description": "Optional description of Shield List.", "type": "string", "example": "A list of things that are shielded" }, @@ -2390,7 +2387,7 @@ "example": "My Shield List" }, "description": { - "description": "Description of Shield List: Optional.", + "description": "Optional description of Shield List.", "type": "string", "example": "A list of things that are shielded" }, @@ -2417,12 +2414,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this user", + "description": "The unique identifier for this user.", "type": "string", "example": "11446498" }, "type": { - "description": "user", + "description": "The value will always be `user`.", "type": "string", "example": "user", "enum": [ @@ -2484,7 +2481,7 @@ } ], "externalDocs": { - "description": "Box Developer Documentation", + "description": "Box Developer Documentation.", "url": "https://developer.box.com" } } \ No newline at end of file diff --git a/openapi/openapi.json b/openapi/openapi.json index 913a9a2a..2aa5c8cf 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,12 +14,12 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "8f64ba5ffc" + "x-box-commit-hash": "eff357f39b" }, "servers": [ { "url": "https://api.box.com/2.0", - "description": "Box Platform API server" + "description": "Box Platform API server." } ], "paths": { @@ -114,7 +114,7 @@ "servers": [ { "url": "https://account.box.com/api/oauth2", - "description": "Server for client-side authentication" + "description": "Server for client-side authentication." } ], "tags": [ @@ -173,7 +173,7 @@ "servers": [ { "url": "https://api.box.com", - "description": "Server for server-side authentication" + "description": "Server for server-side authentication." } ], "tags": [ @@ -232,7 +232,7 @@ "servers": [ { "url": "https://api.box.com", - "description": "Server for server-side authentication" + "description": "Server for server-side authentication." } ], "tags": [ @@ -285,7 +285,7 @@ "servers": [ { "url": "https://api.box.com", - "description": "Server for server-side authentication" + "description": "Server for server-side authentication." } ], "tags": [ @@ -350,7 +350,7 @@ { "name": "x-rep-hints", "in": "header", - "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", + "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`.", "required": false, "schema": { "type": "string", @@ -478,10 +478,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } @@ -619,10 +619,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" }, @@ -744,16 +744,16 @@ "type": "array", "items": { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } @@ -993,7 +993,7 @@ { "name": "application_type", "in": "query", - "description": "If given, only return app items for this application type", + "description": "If given, only return app items for this application type.", "required": false, "schema": { "type": "string", @@ -1079,7 +1079,7 @@ { "name": "version", "in": "query", - "description": "The file version to download", + "description": "The file version to download.", "required": false, "schema": { "type": "string" @@ -1103,7 +1103,7 @@ "content": { "application/octet-stream": { "schema": { - "description": "The binary content of the file", + "description": "The binary content of the file.", "type": "string", "format": "binary" } @@ -1114,7 +1114,7 @@ "description": "If the file is not ready to be downloaded yet `Retry-After` header will\nbe returned indicating the time in seconds after which the file will\nbe available for the client to download.\n\nThis response can occur when the file was uploaded immediately before the\ndownload request.", "headers": { "Retry-After": { - "description": "The time in seconds after which to retry the download", + "description": "The time in seconds after which to retry the download.", "schema": { "type": "integer" } @@ -1125,7 +1125,7 @@ "description": "If the file is available for download the response will include a\n`Location` header for the file on `dl.boxcloud.com`.\n\nThe `dl.boxcloud.com` URL is not persistent and clients will need\nto follow the redirect to actually download the file.", "headers": { "Location": { - "description": "A pointer to the download URL", + "description": "A pointer to the download URL.", "schema": { "type": "string", "format": "url" @@ -1279,7 +1279,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1303,12 +1303,12 @@ "type": "object", "properties": { "name": { - "description": "The name for the file", + "description": "The name for the file.", "type": "string", "example": "File.mp4" }, "size": { - "description": "The size of the file in bytes", + "description": "The size of the file in bytes.", "type": "integer", "format": "int32", "example": 1024 @@ -1317,17 +1317,17 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } } }, { - "description": "The parent folder to upload the file to" + "description": "The parent folder to upload the file to." } ] } @@ -1419,7 +1419,7 @@ "example": "Photo.png" }, "parent": { - "description": "The parent folder to upload the file to", + "description": "The parent folder to upload the file to.", "type": "object", "properties": { "id": { @@ -1520,7 +1520,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1545,13 +1545,13 @@ "example": "0" }, "file_size": { - "description": "The total number of bytes of the file to be uploaded", + "description": "The total number of bytes of the file to be uploaded.", "type": "integer", "format": "int64", "example": 104857600 }, "file_name": { - "description": "The name of new file", + "description": "The name of new file.", "type": "string", "example": "Project.mov" } @@ -1577,7 +1577,7 @@ } }, "400": { - "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `missing_destination`: No `folder_id` was provided\n* `invalid_folder_id`: `folder_id` is not valid\n* `item_name_invalid`: `file_name` is not valid\n* `missing_file_size`: `file_size` was not provided\n* `invalid_file_size`: `file_size` was not a valid number\n* `file_size_too_small`: `file_size` is below minimum file size for\n uploads via this API\n* `missing_file_name`: `file_name` was not provided", + "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `missing_destination`: No `folder_id` was provided.\n* `invalid_folder_id`: `folder_id` is not valid.\n* `item_name_invalid`: `file_name` is not valid.\n* `missing_file_size`: `file_size` was not provided.\n* `invalid_file_size`: `file_size` was not a valid number.\n* `file_size_too_small`: `file_size` is below minimum file size for\n uploads via this API.\n* `missing_file_name`: `file_name` was not provided.", "content": { "application/json": { "schema": { @@ -1587,7 +1587,7 @@ } }, "403": { - "description": "Returns an error if the operation is not allowed for some reason.\n\n* `storage_limit_exceeded`: Account storage limit reached", + "description": "Returns an error if the operation is not allowed for some reason.\n\n* `storage_limit_exceeded`: Account storage limit reached.", "content": { "application/json": { "schema": { @@ -1631,7 +1631,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1663,13 +1663,13 @@ "type": "object", "properties": { "file_size": { - "description": "The total number of bytes of the file to be uploaded", + "description": "The total number of bytes of the file to be uploaded.", "type": "integer", "format": "int64", "example": 104857600 }, "file_name": { - "description": "The optional new name of new file", + "description": "The optional new name of new file.", "type": "string", "example": "Project.mov" } @@ -1717,7 +1717,7 @@ "servers": [ { "url": "https://upload.box.com/api/2.0", - "description": "Server for file uploads" + "description": "Server for file uploads." } ], "tags": [ @@ -1768,7 +1768,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -1800,7 +1800,7 @@ { "name": "digest", "in": "header", - "description": "The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", + "description": "The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "required": true, "schema": { "type": "string" @@ -1822,7 +1822,7 @@ "content": { "application/octet-stream": { "schema": { - "description": "The binary content of the file", + "description": "The binary content of the file.", "type": "string", "format": "binary" } @@ -1885,7 +1885,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -1934,7 +1934,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -2016,7 +2016,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -2085,7 +2085,7 @@ "type": "object", "properties": { "parts": { - "description": "The list details for the uploaded parts", + "description": "The list details for the uploaded parts.", "type": "array", "items": { "$ref": "#/components/schemas/UploadPart" @@ -2156,7 +2156,7 @@ "servers": [ { "url": "https://{box-upload-server}/api/2.0", - "description": "Server for file uploads", + "description": "Server for file uploads.", "variables": { "box-upload-server": { "description": "The server for the upload session.", @@ -2281,7 +2281,7 @@ } }, "404": { - "description": "Returns an error if either the source file or the destination\nfolder could not be found, or the authenticated user does not\nhave access to either.\n\n* `not_found` when the authenticated user does not have access\n to the source file or the destination folder", + "description": "Returns an error if either the source file or the destination\nfolder could not be found, or the authenticated user does not\nhave access to either.\n\n* `not_found` when the authenticated user does not have access\n to the source file or the destination folder.", "content": { "application/json": { "schema": { @@ -2291,7 +2291,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use` when a folder with the same name already\n exists.", + "description": "`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in process.\n\nThe operation can be retried at a later point.\n\n`item_name_in_use` when a folder with the same name already\nexists.", "content": { "application/json": { "schema": { @@ -2336,7 +2336,7 @@ { "name": "extension", "in": "path", - "description": "The file format for the thumbnail", + "description": "The file format for the thumbnail.", "required": true, "schema": { "type": "string", @@ -2350,7 +2350,7 @@ { "name": "min_height", "in": "query", - "description": "The minimum height of the thumbnail", + "description": "The minimum height of the thumbnail.", "schema": { "type": "integer", "maximum": 320, @@ -2361,7 +2361,7 @@ { "name": "min_width", "in": "query", - "description": "The minimum width of the thumbnail", + "description": "The minimum width of the thumbnail.", "schema": { "type": "integer", "maximum": 320, @@ -2372,7 +2372,7 @@ { "name": "max_height", "in": "query", - "description": "The maximum height of the thumbnail", + "description": "The maximum height of the thumbnail.", "required": false, "schema": { "type": "integer", @@ -2384,7 +2384,7 @@ { "name": "max_width", "in": "query", - "description": "The maximum width of the thumbnail", + "description": "The maximum width of the thumbnail.", "required": false, "schema": { "type": "integer", @@ -2400,14 +2400,14 @@ "content": { "image/jpg": { "schema": { - "description": "The thumbnail", + "description": "The thumbnail.", "type": "string", "format": "binary" } }, "image/png": { "schema": { - "description": "The thumbnail", + "description": "The thumbnail.", "type": "string", "format": "binary" } @@ -2466,7 +2466,7 @@ } }, "404": { - "description": "Returned if the file is not found, or the user does not\nhave access to the file, or for additional reasons.\n\n* `preview_cannot_be_generated` - Box does not support thumbnails\n for this type of file", + "description": "Returned if the file is not found, or the user does not\nhave access to the file, or for additional reasons.\n\n* `preview_cannot_be_generated` - Box does not support thumbnails\n for this type of file.", "content": { "application/json": { "schema": { @@ -2982,7 +2982,7 @@ { "name": "file_version_id", "in": "path", - "description": "The ID of the file version", + "description": "The ID of the file version.", "required": true, "schema": { "type": "string" @@ -3035,7 +3035,7 @@ { "name": "file_version_id", "in": "path", - "description": "The ID of the file version", + "description": "The ID of the file version.", "required": true, "schema": { "type": "string" @@ -3091,7 +3091,7 @@ { "name": "file_version_id", "in": "path", - "description": "The ID of the file version", + "description": "The ID of the file version.", "required": true, "schema": { "type": "string" @@ -3103,7 +3103,7 @@ "content": { "application/json": { "schema": { - "description": "The file version to be\nrestored", + "description": "The file version to be\nrestored.", "type": "object", "properties": { "trashed_at": { @@ -3184,16 +3184,16 @@ "content": { "application/json": { "schema": { - "description": "The file version to promote", + "description": "The file version to promote.", "type": "object", "properties": { "id": { - "description": "The file version ID", + "description": "The file version ID.", "type": "string", "example": "11446498" }, "type": { - "description": "The type to promote", + "description": "The type to promote.", "type": "string", "example": "file_version", "enum": [ @@ -3493,7 +3493,7 @@ ], "properties": { "op": { - "description": "`replace`", + "description": "The value will always be `replace`.", "type": "string", "example": "replace", "enum": [ @@ -3655,7 +3655,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -3669,7 +3669,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -3752,7 +3752,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -3766,7 +3766,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -3874,7 +3874,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -3888,7 +3888,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -4004,7 +4004,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -4018,7 +4018,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -4255,7 +4255,7 @@ "description": "An operation that replaces an existing card.", "properties": { "op": { - "description": "`replace`", + "description": "The value will always be `replace`.", "type": "string", "example": "replace", "enum": [ @@ -4308,7 +4308,7 @@ } }, "404": { - "description": "The requested file could not be found", + "description": "The requested file could not be found.", "content": { "application/json": { "schema": { @@ -4467,7 +4467,7 @@ "type": "object", "properties": { "watermark": { - "description": "The watermark to imprint on the file", + "description": "The watermark to imprint on the file.", "type": "object", "properties": { "imprint": { @@ -5142,10 +5142,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } @@ -5193,7 +5193,7 @@ } }, "409": { - "description": "* Returned an error if there is a folder with the same name\n in the destination folder.\n\n* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.", + "description": "Returned an error if there is a folder with the same name\nin the destination folder.\n\n`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in process.\n\nThe operation can be retried at a later point.", "content": { "application/json": { "schema": { @@ -5275,7 +5275,7 @@ "example": "New Folder" }, "description": { - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "type": "string", "example": "Legal contracts for the new ACME deal", "maxLength": 256, @@ -5301,10 +5301,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" }, @@ -5375,7 +5375,7 @@ { "title": "Folder upload email", "type": "object", - "description": "The Write Folder Upload Email object", + "description": "The Write Folder Upload Email object.", "properties": { "access": { "description": "When this parameter has been set, users can email files\nto the email address that has been automatically\ncreated for this folder.\n\nTo create an email address, set this property either when\ncreating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email\naddresses for collaborators will be accepted. This includes\nany email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email\naddress.", @@ -5417,16 +5417,16 @@ "type": "array", "items": { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } @@ -5486,7 +5486,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in progress.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if a folder with the name\n already exists in the parent folder.", + "description": "`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in progress.\n\nThe operation can be retried at a later point.\n\n`item_name_in_use`: Returned if a folder with the name\nalready exists in the parent folder.", "content": { "application/json": { "schema": { @@ -5603,7 +5603,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if the folder\n is locked due to another move, copy, delete or restore\n operation in progress.\n\n The operation can be retried at a later point.", + "description": "`operation_blocked_temporary`: Returned if the folder\nis locked due to another move, copy, delete or restore\noperation in progress.\n\nThe operation can be retried at a later point.", "content": { "application/json": { "schema": { @@ -5691,7 +5691,7 @@ { "name": "application_type", "in": "query", - "description": "If given, returns only app items for this application type", + "description": "If given, returns only app items for this application type.", "required": false, "schema": { "type": "string", @@ -5959,7 +5959,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of parent folder", + "description": "The ID of parent folder.", "type": "string", "example": "0" } @@ -5973,7 +5973,7 @@ { "title": "Folder upload email", "type": "object", - "description": "The Write Folder Upload Email object", + "description": "The Write Folder Upload Email object.", "properties": { "access": { "description": "When this parameter has been set, users can email files\nto the email address that has been automatically\ncreated for this folder.\n\nTo create an email address, set this property either when\ncreating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email\naddresses for collaborators will be accepted. This includes\nany email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email\naddress.", @@ -6044,7 +6044,7 @@ } }, "404": { - "description": "Returns an error if the parent folder could not be found,\nor the authenticated user does not have access to the parent\nfolder.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", + "description": "Returns an error if the parent folder could not be found,\nor the authenticated user does not have access to the parent\nfolder.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder.", "content": { "application/json": { "schema": { @@ -6054,7 +6054,7 @@ } }, "409": { - "description": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if a folder with the name\n already exists in the parent folder.", + "description": "`operation_blocked_temporary`: Returned if either of the destination\nor source folders is locked due to another move, copy, delete or\nrestore operation in process.\n\nThe operation can be retried at a later point.\n\n`item_name_in_use`: Returned if a folder with the name\nalready exists in the parent folder.", "content": { "application/json": { "schema": { @@ -6134,7 +6134,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of parent folder", + "description": "The ID of parent folder.", "type": "string", "example": "0" } @@ -6187,7 +6187,7 @@ } }, "404": { - "description": "Returns an error if either the source or destination folder\ncould not be found, or the authenticated user does not\nhave access to either folders.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", + "description": "Returns an error if either the source or destination folder\ncould not be found, or the authenticated user does not\nhave access to either folders.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder.", "content": { "application/json": { "schema": { @@ -6704,7 +6704,7 @@ ], "properties": { "op": { - "description": "`replace`", + "description": "The value will always be `replace`.", "type": "string", "example": "replace", "enum": [ @@ -6868,7 +6868,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -6882,7 +6882,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -6966,7 +6966,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -6980,7 +6980,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -7089,7 +7089,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -7103,7 +7103,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -7220,7 +7220,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -7234,7 +7234,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -7393,7 +7393,7 @@ ], "responses": { "200": { - "description": "Returns a list of items that have been deleted", + "description": "Returns a list of items that have been deleted.", "content": { "application/json": { "schema": { @@ -7508,7 +7508,7 @@ "type": "object", "properties": { "watermark": { - "description": "The watermark to imprint on the folder", + "description": "The watermark to imprint on the folder.", "type": "object", "properties": { "imprint": { @@ -7591,7 +7591,7 @@ "description": "An empty response will be returned when the watermark\nwas successfully deleted." }, "404": { - "description": "Returns an error if the folder did not have\na watermark applied to it", + "description": "Returns an error if the folder did not have\na watermark applied to it.", "content": { "application/json": { "schema": { @@ -8048,7 +8048,7 @@ "example": "Sensitive information that must not be shared." }, "colorID": { - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -8184,7 +8184,7 @@ "example": "Sensitive information that must not be shared." }, "colorID": { - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -8264,7 +8264,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -8278,7 +8278,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -8341,7 +8341,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -8355,7 +8355,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -8504,7 +8504,7 @@ } }, "404": { - "description": "The requested template could not be found", + "description": "The requested template could not be found.", "content": { "application/json": { "schema": { @@ -8537,7 +8537,7 @@ { "name": "scope", "in": "path", - "description": "The scope of the metadata template", + "description": "The scope of the metadata template.", "required": true, "schema": { "type": "string", @@ -8551,7 +8551,7 @@ { "name": "template_key", "in": "path", - "description": "The name of the metadata template", + "description": "The name of the metadata template.", "required": true, "schema": { "type": "string" @@ -8609,7 +8609,7 @@ { "name": "template_id", "in": "path", - "description": "The ID of the template", + "description": "The ID of the template.", "required": true, "schema": { "type": "string" @@ -8726,7 +8726,7 @@ "get": { "operationId": "get_metadata_templates_enterprise", "summary": "List all metadata templates for enterprise", - "description": "Used to retrieve all metadata templates created to be used specifically within\nthe user's enterprise", + "description": "Used to retrieve all metadata templates created to be used specifically within\nthe user's enterprise.", "parameters": [ { "name": "marker", @@ -9074,7 +9074,7 @@ "example": "Sensitive information" }, "colorID": { - "description": "An identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may\nchange without notice. Currently, the color\nmappings are as follows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may\nchange without notice. Currently, the color\nmappings are as follows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -9198,7 +9198,7 @@ ], "responses": { "200": { - "description": "Returns a list of metadata cascade policies", + "description": "Returns a list of metadata cascade policies.", "content": { "application/json": { "schema": { @@ -9294,7 +9294,7 @@ }, "responses": { "201": { - "description": "Returns a new of metadata cascade policy", + "description": "Returns a new of metadata cascade policy.", "content": { "application/json": { "schema": { @@ -9379,7 +9379,7 @@ ], "responses": { "200": { - "description": "Returns a metadata cascade policy", + "description": "Returns a metadata cascade policy.", "content": { "application/json": { "schema": { @@ -9697,7 +9697,7 @@ "type": "object", "properties": { "message": { - "description": "The text of the comment to update", + "description": "The text of the comment to update.", "type": "string", "example": "Review completed!" } @@ -9816,7 +9816,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the item", + "description": "The ID of the item.", "type": "string", "example": "11446498" }, @@ -9882,7 +9882,7 @@ { "name": "collaboration_id", "in": "path", - "description": "The ID of the collaboration", + "description": "The ID of the collaboration.", "required": true, "schema": { "type": "string" @@ -9943,7 +9943,7 @@ { "name": "collaboration_id", "in": "path", - "description": "The ID of the collaboration", + "description": "The ID of the collaboration.", "required": true, "schema": { "type": "string" @@ -9973,7 +9973,7 @@ ] }, "status": { - "description": "\nSet the status of a `pending` collaboration invitation,\neffectively accepting, or rejecting the invite.", + "description": "Set the status of a `pending` collaboration invitation,\neffectively accepting, or rejecting the invite.", "type": "string", "example": "accepted", "enum": [ @@ -10049,7 +10049,7 @@ { "name": "collaboration_id", "in": "path", - "description": "The ID of the collaboration", + "description": "The ID of the collaboration.", "required": true, "schema": { "type": "string" @@ -10087,7 +10087,7 @@ { "name": "status", "in": "query", - "description": "The status of the collaborations to retrieve", + "description": "The status of the collaborations to retrieve.", "required": true, "schema": { "type": "string", @@ -10212,7 +10212,7 @@ "type": "object", "properties": { "type": { - "description": "The type of the item that this collaboration will be\ngranted access to", + "description": "The type of the item that this collaboration will be\ngranted access to.", "type": "string", "example": "file", "enum": [ @@ -10221,7 +10221,7 @@ ] }, "id": { - "description": "The ID of the item that will be granted access to", + "description": "The ID of the item that will be granted access to.", "type": "string", "example": "11446498" } @@ -10514,7 +10514,7 @@ { "name": "type", "in": "query", - "description": "Limits the search results to any items of this type. This\nparameter only takes one value. By default the API returns\nitems that match any of these types.\n\n* `file` - Limits the search results to files\n* `folder` - Limits the search results to folders\n* `web_link` - Limits the search results to web links, also known\n as bookmarks", + "description": "Limits the search results to any items of this type. This\nparameter only takes one value. By default the API returns\nitems that match any of these types.\n\n* `file` - Limits the search results to files,\n* `folder` - Limits the search results to folders,\n* `web_link` - Limits the search results to web links, also known\n as bookmarks.", "required": false, "schema": { "type": "string", @@ -10616,7 +10616,7 @@ { "name": "include_recent_shared_links", "in": "query", - "description": "Defines whether the search results should include any items\nthat the user recently accessed through a shared link.\n\nWhen this parameter has been set to true,\nthe format of the response of this API changes to return\na list of [Search Results with\nShared Links](r://search_results_with_shared_links)", + "description": "Defines whether the search results should include any items\nthat the user recently accessed through a shared link.\n\nWhen this parameter has been set to true,\nthe format of the response of this API changes to return\na list of [Search Results with\nShared Links](r://search_results_with_shared_links).", "required": false, "schema": { "type": "boolean", @@ -10769,12 +10769,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the file", + "description": "The ID of the file.", "type": "string", "example": "11446498" }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -10784,7 +10784,7 @@ } }, "action": { - "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or\nrejected\n* `complete` defines a general task which can be completed", + "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or,\nrejected\n* `complete` defines a general task which can be completed.", "type": "string", "example": "review", "default": "review", @@ -10958,7 +10958,7 @@ "type": "object", "properties": { "action": { - "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or\nrejected\n* `complete` defines a general task which can be completed", + "description": "The action the task assignee will be prompted to do. Must be\n\n* `review` defines an approval task that can be approved or\nrejected,\n* `complete` defines a general task which can be completed.", "type": "string", "example": "review", "enum": [ @@ -10993,7 +10993,7 @@ }, "responses": { "200": { - "description": "Returns the updated task object", + "description": "Returns the updated task object.", "content": { "application/json": { "schema": { @@ -11176,7 +11176,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the task", + "description": "The ID of the task.", "type": "string", "example": "11446498" }, @@ -11505,7 +11505,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows.\n\n`shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -11787,7 +11787,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -11994,7 +11994,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -12239,7 +12239,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows.\n\n`shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -12523,7 +12523,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -12730,7 +12730,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -12960,7 +12960,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of parent folder", + "description": "The ID of parent folder.", "type": "string", "example": "0" } @@ -13119,10 +13119,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" } @@ -13226,10 +13226,10 @@ "allOf": [ { "type": "object", - "description": "The parent for this item", + "description": "The parent for this item.", "properties": { "id": { - "description": "The ID of parent item", + "description": "The ID of parent item.", "type": "string", "example": "123" }, @@ -13514,7 +13514,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows.\n\n`shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -13796,7 +13796,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -14003,7 +14003,7 @@ } }, "400": { - "description": "Returned when there is an incorrect permission combination", + "description": "Returned when there is an incorrect permission combination.", "content": { "application/json": { "schema": { @@ -14220,7 +14220,7 @@ { "name": "boxapi", "in": "header", - "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is `shared_link=[link]&shared_link_password=[password]`", + "description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is `shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" @@ -14418,7 +14418,7 @@ "type": "object", "properties": { "name": { - "description": "The name of the user", + "description": "The name of the user.", "type": "string", "example": "Aaron Levie", "maxLength": 50 @@ -14434,7 +14434,7 @@ "example": true }, "role": { - "description": "The user’s enterprise role", + "description": "The user’s enterprise role.", "type": "string", "example": "user", "enum": [ @@ -14448,24 +14448,24 @@ "example": "en" }, "is_sync_enabled": { - "description": "Whether the user can use Box Sync", + "description": "Whether the user can use Box Sync.", "type": "boolean", "example": true }, "job_title": { - "description": "The user’s job title", + "description": "The user’s job title.", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { - "description": "The user’s phone number", + "description": "The user’s phone number.", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { - "description": "The user’s address", + "description": "The user’s address.", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 @@ -14484,33 +14484,33 @@ } }, "can_see_managed_users": { - "description": "Whether the user can see other enterprise users in their\ncontact list", + "description": "Whether the user can see other enterprise users in their\ncontact list.", "type": "boolean", "example": true }, "timezone": { - "description": "The user's timezone", + "description": "The user's timezone.", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "is_external_collab_restricted": { - "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise", + "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise.", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { - "description": "Whether to exempt the user from enterprise device limits", + "description": "Whether to exempt the user from enterprise device limits.", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { - "description": "Whether the user must use two-factor authentication", + "description": "Whether the user must use two-factor authentication.", "type": "boolean", "example": true }, "status": { - "description": "The user's account status", + "description": "The user's account status.", "type": "string", "example": "active", "enum": [ @@ -14626,7 +14626,7 @@ "type": "object", "properties": { "user_ids": { - "description": "A list of user IDs", + "description": "A list of user IDs.", "type": "array", "items": { "type": "string" @@ -14637,7 +14637,7 @@ ] }, "user_logins": { - "description": "A list of user logins", + "description": "A list of user logins.", "type": "array", "items": { "type": "string" @@ -14668,7 +14668,7 @@ } }, "400": { - "description": "Returns an error if some of the parameters are\n not valid.\n\n * `Users can not be NULL or EMPTY` when no value is provided\n * `User id format is string` when the provided user id format\n is incorrect\n * `Supported payload format is JSON` when the provided payload\n format is incorrect", + "description": "Returns an error if some of the parameters are\n not valid.\n\n * `Users can not be NULL or EMPTY` when no value is provided.\n * `User id format is string` when the provided user id format\n is incorrect.\n * `Supported payload format is JSON` when the provided payload\n format is incorrect.", "content": { "application/json": { "schema": { @@ -14847,18 +14847,18 @@ "type": "object", "properties": { "enterprise": { - "description": "Set this to `null` to roll the user out of the enterprise\nand make them a free user", + "description": "Set this to `null` to roll the user out of the enterprise\nand make them a free user.", "type": "string", "example": null, "nullable": true }, "notify": { - "description": "Whether the user should receive an email when they\nare rolled out of an enterprise", + "description": "Whether the user should receive an email when they\nare rolled out of an enterprise.", "type": "boolean", "example": true }, "name": { - "description": "The name of the user", + "description": "The name of the user.", "type": "string", "example": "Aaron Levie", "maxLength": 50 @@ -14869,7 +14869,7 @@ "example": "somename@box.com" }, "role": { - "description": "The user’s enterprise role", + "description": "The user’s enterprise role.", "type": "string", "example": "user", "enum": [ @@ -14883,24 +14883,24 @@ "example": "en" }, "is_sync_enabled": { - "description": "Whether the user can use Box Sync", + "description": "Whether the user can use Box Sync.", "type": "boolean", "example": true }, "job_title": { - "description": "The user’s job title", + "description": "The user’s job title.", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { - "description": "The user’s phone number", + "description": "The user’s phone number.", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { - "description": "The user’s address", + "description": "The user’s address.", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 @@ -14913,38 +14913,38 @@ } }, "can_see_managed_users": { - "description": "Whether the user can see other enterprise users in their\ncontact list", + "description": "Whether the user can see other enterprise users in their\ncontact list.", "type": "boolean", "example": true }, "timezone": { - "description": "The user's timezone", + "description": "The user's timezone.", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "is_external_collab_restricted": { - "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise", + "description": "Whether the user is allowed to collaborate with users outside\ntheir enterprise.", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { - "description": "Whether to exempt the user from enterprise device limits", + "description": "Whether to exempt the user from enterprise device limits.", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { - "description": "Whether the user must use two-factor authentication", + "description": "Whether the user must use two-factor authentication.", "type": "boolean", "example": true }, "is_password_reset_required": { - "description": "Whether the user is required to reset their password", + "description": "Whether the user is required to reset their password.", "type": "boolean", "example": true }, "status": { - "description": "The user's account status", + "description": "The user's account status.", "type": "string", "example": "active", "enum": [ @@ -15047,7 +15047,7 @@ { "name": "notify", "in": "query", - "description": "Whether the user will receive email notification of\nthe deletion", + "description": "Whether the user will receive email notification of\nthe deletion.", "schema": { "type": "boolean" }, @@ -15056,7 +15056,7 @@ { "name": "force", "in": "query", - "description": "Whether the user should be deleted even if this user\nstill own files", + "description": "Whether the user should be deleted even if this user\nstill own files.", "schema": { "type": "boolean" }, @@ -15107,7 +15107,7 @@ "content": { "image/jpg": { "schema": { - "description": "The avatar", + "description": "The avatar.", "type": "string", "format": "binary" } @@ -15167,7 +15167,7 @@ }, "responses": { "200": { - "description": "* `ok`: Returns the `pic_urls` object with URLs to existing\nuser avatars that were updated.", + "description": "`ok`: Returns the `pic_urls` object with URLs to existing\nuser avatars that were updated.", "content": { "application/json": { "schema": { @@ -15177,7 +15177,7 @@ } }, "201": { - "description": "* `created`: Returns the `pic_urls` object with URLS to user avatars\nuploaded to Box with the request.", + "description": "`created`: Returns the `pic_urls` object with URLS to user avatars\nuploaded to Box with the request.", "content": { "application/json": { "schema": { @@ -15187,7 +15187,7 @@ } }, "400": { - "description": "* `bad_request`: Returns an error when:\n * An image is not included in the request\n * The uploaded file is empty\n * The image size exceeds 1024 * 1024 pixels\n or 1MB\n * The file extension is other than `.jpg` or `.png`.", + "description": "`bad_request`: Returns an error when:\n * An image is not included in the request\n * The uploaded file is empty\n * The image size exceeds 1024 * 1024 pixels or 1MB\n * The file extension is other than `.jpg` or `.png`.", "content": { "application/json": { "schema": { @@ -15197,7 +15197,7 @@ } }, "403": { - "description": "* `forbidden`: Returns an error if the user does not have permissions\nnecessary to upload an avatar or is not activated.", + "description": "`forbidden`: Returns an error if the user does not have permissions\nnecessary to upload an avatar or is not activated.", "content": { "application/json": { "schema": { @@ -15207,7 +15207,7 @@ } }, "404": { - "description": "* `not_found`: Returns an error if the user\ndoes not exist or cannot be found.", + "description": "`not_found`: Returns an error if the user\ndoes not exist or cannot be found.", "content": { "application/json": { "schema": { @@ -15250,10 +15250,10 @@ ], "responses": { "204": { - "description": "* `no_content`: Removes the avatar and returns an empty response." + "description": "`no_content`: Removes the avatar and returns an empty response." }, "403": { - "description": "* `forbidden`: Returned if the user does not have necessary permissions\n or is not activated.", + "description": "`forbidden`: Returned if the user does not have necessary permissions\n or is not activated.", "content": { "application/json": { "schema": { @@ -15263,7 +15263,7 @@ } }, "404": { - "description": "* `not_found`: Returned if the user or user avatar does not exist\n or cannot be found.", + "description": "`not_found`: Returned if the user or user avatar does not exist\n or cannot be found.", "content": { "application/json": { "schema": { @@ -15341,11 +15341,11 @@ "type": "object", "properties": { "owned_by": { - "description": "The user who the folder will be transferred to", + "description": "The user who the folder will be transferred to.", "type": "object", "properties": { "id": { - "description": "The ID of the user who the folder will be\ntransferred to", + "description": "The ID of the user who the folder will be\ntransferred to.", "type": "string", "example": "1232234" } @@ -15656,11 +15656,11 @@ "type": "object", "properties": { "enterprise": { - "description": "The enterprise to invite the user to", + "description": "The enterprise to invite the user to.", "type": "object", "properties": { "id": { - "description": "The ID of the enterprise", + "description": "The ID of the enterprise.", "type": "string", "example": "1232234" } @@ -15670,11 +15670,11 @@ ] }, "actionable_by": { - "description": "The user to invite", + "description": "The user to invite.", "type": "object", "properties": { "login": { - "description": "The login of the invited user", + "description": "The login of the invited user.", "type": "string", "example": "john@example.com" } @@ -15767,7 +15767,7 @@ ], "responses": { "200": { - "description": "Returns an invite object", + "description": "Returns an invite object.", "content": { "application/json": { "schema": { @@ -15942,7 +15942,7 @@ ] }, "member_viewability_level": { - "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", + "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin.\n* `admins_and_members` - all admins and group members.\n* `all_managed_users` - all managed users in the\n enterprise.", "type": "string", "example": "admins_only", "enum": [ @@ -16009,7 +16009,7 @@ "type": "object", "properties": { "group_ids": { - "description": "A list of group IDs", + "description": "A list of group IDs.", "type": "array", "items": { "type": "string" @@ -16039,7 +16039,7 @@ } }, "400": { - "description": "Returns an error if some of the parameters are\nnot valid.\n\n* `Groups can not be NULL or EMPTY` when no value is provided\n* `group id format is string` when the provided group id format\nis incorrect\n* `Supported payload format is JSON` when the provided payload\nformat is incorrect", + "description": "Returns an error if some of the parameters are\nnot valid.\n\n* `Groups can not be NULL or EMPTY` when no value is provided.\n* `group id format is string` when the provided group id format\nis incorrect.\n* `Supported payload format is JSON` when the provided payload\nformat is incorrect.", "content": { "application/json": { "schema": { @@ -16152,7 +16152,7 @@ ], "responses": { "200": { - "description": "Returns the group object", + "description": "Returns the group object.", "content": { "application/json": { "schema": { @@ -16250,7 +16250,7 @@ ] }, "member_viewability_level": { - "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", + "description": "Specifies who can see the members of the group.\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin.\n* `admins_and_members` - all admins and group members.\n* `all_managed_users` - all managed users in the\n enterprise.", "type": "string", "example": "admins_only", "enum": [ @@ -16512,7 +16512,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the user to add to the group", + "description": "The ID of the user to add to the group.", "type": "string", "example": "1434325" } @@ -16526,7 +16526,7 @@ "type": "object", "properties": { "id": { - "description": "The ID of the group to add the user to", + "description": "The ID of the group to add the user to.", "type": "string", "example": "4545523" } @@ -16876,16 +16876,16 @@ "type": "object", "properties": { "target": { - "description": "The item that will trigger the webhook", + "description": "The item that will trigger the webhook.", "type": "object", "properties": { "id": { - "description": "The ID of the item to trigger a webhook", + "description": "The ID of the item to trigger a webhook.", "type": "string", "example": "1231232" }, "type": { - "description": "The type of item to trigger a webhook", + "description": "The type of item to trigger a webhook.", "type": "string", "example": "file", "enum": [ @@ -16896,18 +16896,18 @@ } }, "address": { - "description": "The URL that is notified by this webhook", + "description": "The URL that is notified by this webhook.", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for", + "description": "An array of event names that this webhook is\nto be triggered for.", "type": "array", "items": { "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -16997,7 +16997,7 @@ } }, "404": { - "description": "Returns an error if the target item could\nnot be found", + "description": "Returns an error if the target item could\nnot be found.", "content": { "application/json": { "schema": { @@ -17037,7 +17037,7 @@ "get": { "operationId": "get_webhooks_id", "summary": "Get webhook", - "description": "Retrieves a specific webhook", + "description": "Retrieves a specific webhook.", "parameters": [ { "name": "webhook_id", @@ -17052,7 +17052,7 @@ ], "responses": { "200": { - "description": "Returns a webhook object", + "description": "Returns a webhook object.", "content": { "application/json": { "schema": { @@ -17072,7 +17072,7 @@ } }, "404": { - "description": "Returns an error if the webhook could not be found", + "description": "Returns an error if the webhook could not be found.", "content": { "application/json": { "schema": { @@ -17120,16 +17120,16 @@ "type": "object", "properties": { "target": { - "description": "The item that will trigger the webhook", + "description": "The item that will trigger the webhook.", "type": "object", "properties": { "id": { - "description": "The ID of the item to trigger a webhook", + "description": "The ID of the item to trigger a webhook.", "type": "string", "example": "1231232" }, "type": { - "description": "The type of item to trigger a webhook", + "description": "The type of item to trigger a webhook.", "type": "string", "example": "file", "enum": [ @@ -17140,18 +17140,18 @@ } }, "address": { - "description": "The URL that is notified by this webhook", + "description": "The URL that is notified by this webhook.", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for", + "description": "An array of event names that this webhook is\nto be triggered for.", "type": "array", "items": { "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -17236,7 +17236,7 @@ } }, "404": { - "description": "Returns an error if the target item or webhook\ncould not be found", + "description": "Returns an error if the target item or webhook\ncould not be found.", "content": { "application/json": { "schema": { @@ -17302,7 +17302,7 @@ } }, "404": { - "description": "Returns an error if the webhook could not be found", + "description": "Returns an error if the webhook could not be found.", "content": { "application/json": { "schema": { @@ -17394,7 +17394,7 @@ "type": "object", "properties": { "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -17402,7 +17402,7 @@ ] }, "id": { - "description": "The ID of the file", + "description": "The ID of the file.", "type": "string", "example": "3243244" } @@ -17413,7 +17413,7 @@ "type": "object", "properties": { "type": { - "description": "`file_version`", + "description": "The value will always be `file_version`.", "type": "string", "example": "file_version", "enum": [ @@ -17421,7 +17421,7 @@ ] }, "id": { - "description": "The ID of the file version", + "description": "The ID of the file version.", "type": "string", "example": "731381601045" } @@ -17432,12 +17432,12 @@ "type": "object", "properties": { "unit": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file" }, "value": { - "description": "`1`", + "description": "Number of resources affected.", "type": "number", "example": 1 } @@ -17560,7 +17560,7 @@ { "name": "limit", "in": "query", - "description": "Limits the number of events returned\n\nNote: Sometimes, the events less than the limit requested can be returned\neven when there may be more events remaining. This is primarily done in\nthe case where a number of events have already been retrieved and these\nretrieved events are returned rather than delaying for an unknown amount\nof time to see if there are any more results.", + "description": "Limits the number of events returned.\n\nNote: Sometimes, the events less than the limit requested can be returned\neven when there may be more events remaining. This is primarily done in\nthe case where a number of events have already been retrieved and these\nretrieved events are returned rather than delaying for an unknown amount\nof time to see if there are any more results.", "schema": { "type": "integer", "format": "int64", @@ -17577,7 +17577,7 @@ "type": "array", "items": { "type": "string", - "description": "An event type that can be filtered by", + "description": "An event type that can be filtered by.", "enum": [ "ACCESS_GRANTED", "ACCESS_REVOKED", @@ -17801,7 +17801,7 @@ ], "responses": { "200": { - "description": "Returns all collections for the given user", + "description": "Returns all collections for the given user.", "content": { "application/json": { "schema": { @@ -18173,7 +18173,7 @@ "type": "object", "properties": { "policy_name": { - "description": "The name for the retention policy", + "description": "The name for the retention policy.", "type": "string", "example": "Some Policy Name" }, @@ -18274,7 +18274,7 @@ } }, "409": { - "description": "Returns an error if a retention policy with the given name already exists", + "description": "Returns an error if a retention policy with the given name already exists.", "content": { "application/json": { "schema": { @@ -18385,7 +18385,7 @@ "type": "object", "properties": { "policy_name": { - "description": "The name for the retention policy", + "description": "The name for the retention policy.", "type": "string", "example": "Some Policy Name", "nullable": true @@ -18499,7 +18499,7 @@ } }, "409": { - "description": "Returns an error if a retention policy with the given name already exists", + "description": "Returns an error if a retention policy with the given name already exists.", "content": { "application/json": { "schema": { @@ -18703,12 +18703,12 @@ "type": "object", "properties": { "policy_id": { - "description": "The ID of the retention policy to assign", + "description": "The ID of the retention policy to assign.", "type": "string", "example": "173463" }, "assign_to": { - "description": "The item to assign the policy to", + "description": "The item to assign the policy to.", "type": "object", "properties": { "type": { @@ -18827,7 +18827,7 @@ "get": { "operationId": "get_retention_policy_assignments_id", "summary": "Get retention policy assignment", - "description": "Retrieves a retention policy assignment", + "description": "Retrieves a retention policy assignment.", "parameters": [ { "name": "retention_policy_assignment_id", @@ -19286,7 +19286,7 @@ { "name": "legal_hold_policy_id", "in": "path", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19329,7 +19329,7 @@ { "name": "legal_hold_policy_id", "in": "path", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19411,7 +19411,7 @@ { "name": "legal_hold_policy_id", "in": "path", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19449,7 +19449,7 @@ { "name": "policy_id", "in": "query", - "description": "The ID of the legal hold policy", + "description": "The ID of the legal hold policy.", "required": true, "schema": { "type": "string" @@ -19566,11 +19566,11 @@ "example": "123244" }, "assign_to": { - "description": "The item to assign the policy to", + "description": "The item to assign the policy to.", "type": "object", "properties": { "type": { - "description": "The type of item to assign the policy to", + "description": "The type of item to assign the policy to.", "type": "string", "example": "folder", "enum": [ @@ -19583,7 +19583,7 @@ ] }, "id": { - "description": "The ID of item to assign the policy to", + "description": "The ID of item to assign the policy to.", "type": "string", "example": "6564564" } @@ -19639,7 +19639,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -19682,7 +19682,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -19720,7 +19720,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -19926,7 +19926,7 @@ { "name": "legal_hold_policy_assignment_id", "in": "path", - "description": "The ID of the legal hold policy assignment", + "description": "The ID of the legal hold policy assignment.", "required": true, "schema": { "type": "string" @@ -20011,7 +20011,7 @@ { "name": "file_version_retention_id", "in": "path", - "description": "The ID of the file version retention", + "description": "The ID of the file version retention.", "required": true, "schema": { "type": "string" @@ -20056,7 +20056,7 @@ { "name": "file_version_legal_hold_id", "in": "path", - "description": "The ID of the file version legal hold", + "description": "The ID of the file version legal hold.", "required": true, "schema": { "type": "string" @@ -20690,7 +20690,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the shield information\nbarrier segment with specified ID was not found.", @@ -20896,12 +20896,12 @@ "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "name": { - "description": "Name of the shield information barrier segment", + "description": "Name of the shield information barrier segment.", "type": "string", "example": "Investment Banking" }, "description": { - "description": "Description of the shield information barrier segment", + "description": "Description of the shield information barrier segment.", "type": "string", "example": "'Corporate division that engages in\n advisory_based financial\ntransactions on behalf of individuals,\ncorporations, and governments.'" } @@ -21140,7 +21140,7 @@ "type": "object", "properties": { "type": { - "description": "-| A type of the shield barrier segment member.", + "description": "A type of the shield barrier segment member.", "type": "string", "example": "shield_information_barrier_segment_member", "enum": [ @@ -21296,7 +21296,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the\nshield information barrier segment restriction was not found.", @@ -21507,7 +21507,7 @@ { "name": "device_pinner_id", "in": "path", - "description": "The ID of the device pin", + "description": "The ID of the device pin.", "required": true, "schema": { "type": "string" @@ -21550,7 +21550,7 @@ { "name": "device_pinner_id", "in": "path", - "description": "The ID of the device pin", + "description": "The ID of the device pin.", "required": true, "schema": { "type": "string" @@ -21588,7 +21588,7 @@ { "name": "enterprise_id", "in": "path", - "description": "The ID of the enterprise", + "description": "The ID of the enterprise.", "required": true, "schema": { "type": "string" @@ -21752,7 +21752,7 @@ }, "responses": { "200": { - "description": "Returns a new task object", + "description": "Returns a new task object.", "content": { "application/json": { "schema": { @@ -21972,7 +21972,7 @@ ] }, "id": { - "description": "The ID of terms of service", + "description": "The ID of terms of service.", "type": "string", "example": "1232132" } @@ -21995,7 +21995,7 @@ ] }, "id": { - "description": "The ID of user", + "description": "The ID of user.", "type": "string", "example": "3423423" } @@ -22647,7 +22647,7 @@ { "name": "resolved_for_type", "in": "query", - "description": "The target type to return assignments for", + "description": "The target type to return assignments for.", "required": true, "schema": { "type": "string", @@ -22661,7 +22661,7 @@ { "name": "resolved_for_id", "in": "query", - "description": "The ID of the user or enterprise to return assignments for", + "description": "The ID of the user or enterprise to return assignments for.", "required": true, "schema": { "type": "string" @@ -22707,7 +22707,7 @@ "type": "object", "properties": { "storage_policy": { - "description": "The storage policy to assign to the user or\nenterprise", + "description": "The storage policy to assign to the user or\nenterprise.", "type": "object", "properties": { "type": { @@ -22743,7 +22743,7 @@ ] }, "id": { - "description": "The ID of the user or enterprise", + "description": "The ID of the user or enterprise.", "type": "string", "example": "9987987" } @@ -22857,7 +22857,7 @@ "type": "object", "properties": { "storage_policy": { - "description": "The storage policy to assign to the user or\nenterprise", + "description": "The storage policy to assign to the user or\nenterprise.", "type": "object", "properties": { "type": { @@ -23071,7 +23071,7 @@ "description": "Returns the content of the items requested for this download, formatted as\na stream of files and folders in a `zip` archive.", "headers": { "Content-Disposition": { - "description": "The name of the archive to be downloaded", + "description": "The name of the archive to be downloaded.", "schema": { "type": "string", "example": "attachment;filename=\"Avatars.zip\";filename*=UTF-8''Avatars.zip" @@ -23218,7 +23218,7 @@ { "name": "sign_request_id", "in": "path", - "description": "The ID of the signature request", + "description": "The ID of the signature request.", "required": true, "schema": { "type": "string" @@ -23273,7 +23273,7 @@ { "name": "sign_request_id", "in": "path", - "description": "The ID of the signature request", + "description": "The ID of the signature request.", "required": true, "schema": { "type": "string" @@ -23321,7 +23321,7 @@ { "name": "sign_request_id", "in": "path", - "description": "The ID of the signature request", + "description": "The ID of the signature request.", "required": true, "schema": { "type": "string" @@ -23425,7 +23425,7 @@ ], "responses": { "200": { - "description": "Returns a collection of sign requests", + "description": "Returns a collection of sign requests.", "content": { "application/json": { "schema": { @@ -23614,7 +23614,7 @@ "type": "object", "properties": { "type": { - "description": "The type of the parameters object", + "description": "The type of the parameters object.", "type": "string", "example": "workflow_parameters", "enum": [ @@ -23622,16 +23622,16 @@ ] }, "flow": { - "description": "The flow that will be triggered", + "description": "The flow that will be triggered.", "type": "object", "properties": { "type": { - "description": "The type of the flow object", + "description": "The type of the flow object.", "type": "string", "example": "flow" }, "id": { - "description": "The id of the flow", + "description": "The id of the flow.", "type": "string", "example": "123456789" } @@ -23642,10 +23642,10 @@ "type": "array", "items": { "type": "object", - "description": "A file the workflow should start for", + "description": "A file the workflow should start for.", "properties": { "type": { - "description": "The type of the file object", + "description": "The type of the file object.", "type": "string", "example": "file", "enum": [ @@ -23653,7 +23653,7 @@ ] }, "id": { - "description": "The id of the file", + "description": "The id of the file.", "type": "string", "example": "12345678" } @@ -23665,7 +23665,7 @@ "type": "object", "properties": { "type": { - "description": "The type of the folder object", + "description": "The type of the folder object.", "type": "string", "example": "folder", "enum": [ @@ -23673,7 +23673,7 @@ ] }, "id": { - "description": "The id of the folder", + "description": "The id of the folder.", "type": "string", "example": "87654321" } @@ -23701,7 +23701,7 @@ "description": "Starts the workflow." }, "400": { - "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `workflow_is_not_enabled` when the workflow is not enabled\n* `workflow_not_active_on_provided_folder` when the workflow is not\n enabled for the specified folder id\n* `parameters_provided_do_not_match_target_outcome` when the provided\n parameters do not match the expected parameters", + "description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `workflow_is_not_enabled` when the workflow is not enabled.\n* `workflow_not_active_on_provided_folder` when the workflow is not\n enabled for the specified folder id.\n* `parameters_provided_do_not_match_target_outcome` when the provided\n parameters do not match the expected parameters.", "content": { "application/json": { "schema": { @@ -23711,7 +23711,7 @@ } }, "403": { - "description": "Returns an error if there are insufficient permissions.\n\n* `insufficient_access` when the user does not have access rights to file\n or folder\n* `missing_relay_full_access` when the user does not have access to Relay\n Full", + "description": "Returns an error if there are insufficient permissions.\n\n* `insufficient_access` when the user does not have access rights to file\n or folder.\n* `missing_relay_full_access` when the user does not have access to Relay\n Full.", "content": { "application/json": { "schema": { @@ -23721,7 +23721,7 @@ } }, "404": { - "description": "Returns an error if the workflow could not be found,\nor the authenticated user does not have access to the workflow.\n\n* `workflow_not_found` when the workflow is not found\n* `flow_missing_or_inaccessible` when the flow is not a manual start flow", + "description": "Returns an error if the workflow could not be found,\nor the authenticated user does not have access to the workflow.\n\n* `workflow_not_found` when the workflow is not found.\n* `flow_missing_or_inaccessible` when the flow is not a manual start flow.", "content": { "application/json": { "schema": { @@ -23910,7 +23910,7 @@ { "name": "partner_item_type", "in": "query", - "description": "Mapped item type, for which the mapping should be returned", + "description": "Mapped item type, for which the mapping should be returned.", "schema": { "type": "string", "enum": [ @@ -23922,7 +23922,7 @@ { "name": "partner_item_id", "in": "query", - "description": "ID of the mapped item, for which the mapping should be returned", + "description": "ID of the mapped item,\nfor which the mapping should be returned.", "schema": { "type": "string" }, @@ -23931,7 +23931,7 @@ { "name": "box_item_id", "in": "query", - "description": "Box item ID, for which the mappings should be returned", + "description": "Box item ID, for which the mappings should be returned.", "schema": { "type": "string", "nullable": false @@ -23941,7 +23941,7 @@ { "name": "box_item_type", "in": "query", - "description": "Box item type, for which the mappings should be returned", + "description": "Box item type, for\nwhich the mappings should be returned.", "schema": { "type": "string", "enum": [ @@ -23954,7 +23954,7 @@ { "name": "is_manually_created", "in": "query", - "description": "Whether the mapping has been manually created", + "description": "Whether the mapping has been manually created.", "schema": { "type": "boolean", "nullable": false @@ -23964,7 +23964,7 @@ ], "responses": { "200": { - "description": "Returns a collection of integration mappings", + "description": "Returns a collection of integration mappings.", "content": { "application/json": { "schema": { @@ -24079,7 +24079,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24168,7 +24168,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24178,7 +24178,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the integration mapping could not be found.", @@ -24217,7 +24217,7 @@ { "name": "partner_item_type", "in": "query", - "description": "Mapped item type, for which the mapping should be returned", + "description": "Mapped item type, for which the mapping should be returned.", "schema": { "type": "string", "enum": [ @@ -24230,7 +24230,7 @@ { "name": "partner_item_id", "in": "query", - "description": "ID of the mapped item, for which the mapping should be returned", + "description": "ID of the mapped item,\nfor which the mapping should be returned.", "schema": { "type": "string" }, @@ -24239,7 +24239,7 @@ { "name": "box_item_id", "in": "query", - "description": "Box item ID, for which the mappings should be returned", + "description": "Box item ID, for which the mappings should be returned.", "schema": { "type": "string" }, @@ -24248,7 +24248,7 @@ { "name": "box_item_type", "in": "query", - "description": "Box item type, for which the mappings should be returned", + "description": "Box item type, for\nwhich the mappings should be returned.", "schema": { "type": "string", "enum": [ @@ -24260,7 +24260,7 @@ ], "responses": { "200": { - "description": "Returns a collection of integration mappings", + "description": "Returns a collection of integration mappings.", "content": { "application/json": { "schema": { @@ -24377,7 +24377,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24397,7 +24397,7 @@ "$ref": "#/components/schemas/FolderReference" }, { - "description": "The Box folder, to which the object from the partner app domain is mapped" + "description": "The Box folder, to which the object from the partner app domain is mapped." } ] } @@ -24462,7 +24462,7 @@ { "name": "integration_mapping_id", "in": "path", - "description": "An ID of an integration mapping", + "description": "An ID of an integration mapping.", "required": true, "schema": { "type": "string" @@ -24472,7 +24472,7 @@ ], "responses": { "204": { - "description": "Empty body in response" + "description": "Empty body in response." }, "404": { "description": "Returns a `not_found` error if the integration mapping could not be found.", @@ -24616,7 +24616,7 @@ "get": { "operationId": "get_ai_agent_default", "summary": "Get AI agent default configuration", - "description": "Get the AI agent default config", + "description": "Get the AI agent default config.", "x-stability-level": "stable", "parameters": [ { @@ -25293,7 +25293,7 @@ "x-box-tag": "ai" }, "AiAgentBasicGenTool": { - "description": "AI agent basic tool used to generate text. ", + "description": "AI agent basic tool used to generate text.", "type": "object", "allOf": [ { @@ -25453,23 +25453,23 @@ "type": "object", "properties": { "models": { - "description": "The models used for the request", + "description": "The models used for the request.", "type": "array", "items": { "type": "object", "properties": { "name": { - "description": "The name of the model used for the request", + "description": "The name of the model used for the request.", "type": "string", "example": "azure__openai__text_embedding_ada_002" }, "provider": { - "description": "The provider that owns the model used for the request", + "description": "The provider that owns the model used for the request.", "type": "string", "example": "azure" }, "supported_purpose": { - "description": "The supported purpose utilized by the model used for the request", + "description": "The supported purpose utilized by the model used for the request.", "type": "string", "example": "embedding" } @@ -25477,7 +25477,7 @@ } }, "processor": { - "description": "The processor used for the request", + "description": "The processor used for the request.", "type": "string", "example": "basic_text" } @@ -25582,7 +25582,7 @@ "nullable": false }, "id": { - "description": "The ID of an Agent", + "description": "The ID of an Agent.", "type": "string", "example": "14031", "nullable": false @@ -25620,11 +25620,11 @@ "x-box-tag": "ai" }, "AiAsk": { - "description": "AI ask request object", + "description": "AI ask request object.", "type": "object", "properties": { "mode": { - "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only process the text.", + "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, \nwhichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. \nBox AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages \nfor multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will \nbe processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. \nCurrently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only \nprocess the text.", "type": "string", "example": "multiple_item_qa", "enum": [ @@ -25634,7 +25634,7 @@ "nullable": false }, "prompt": { - "description": "The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.", + "description": "The prompt provided by the client to be answered by the LLM.\nThe prompt's length is limited to 10000 characters.", "type": "string", "example": "What is the value provided by public APIs based on this document?" }, @@ -25740,7 +25740,7 @@ "title": "Dialogue history" }, "AiExtract": { - "description": "AI metadata freeform extraction request object", + "description": "AI metadata freeform extraction request object.", "type": "object", "properties": { "prompt": { @@ -25919,7 +25919,7 @@ "x-box-tag": "ai" }, "AiExtractStructuredResponse": { - "description": "AI extract structured response", + "description": "AI extract structured response.", "type": "object", "properties": { "answer": { @@ -26031,7 +26031,7 @@ "title": "AI LLM endpoint parameters" }, "AiLlmEndpointParamsAWS": { - "description": "AI LLM endpoint params AWS object", + "description": "AI LLM endpoint params AWS object.", "type": "object", "properties": { "type": { @@ -26067,7 +26067,7 @@ "x-box-resource-id": "ai_llm_endpoint_params_aws" }, "AiLlmEndpointParamsGoogle": { - "description": "AI LLM endpoint params Google object", + "description": "AI LLM endpoint params Google object.", "type": "object", "properties": { "type": { @@ -26111,7 +26111,7 @@ "x-box-resource-id": "ai_llm_endpoint_params_google" }, "AiLlmEndpointParamsIBM": { - "description": "AI LLM endpoint params IBM object", + "description": "AI LLM endpoint params IBM object.", "type": "object", "properties": { "type": { @@ -26214,7 +26214,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -26256,7 +26256,7 @@ "x-box-tag": "ai_studio" }, "AiResponse": { - "description": "AI response", + "description": "AI response.", "type": "object", "properties": { "answer": { @@ -26293,7 +26293,7 @@ ] }, "AiResponse--Full": { - "description": "AI ask response", + "description": "AI ask response.", "type": "object", "allOf": [ { @@ -26567,7 +26567,7 @@ { "properties": { "is_custom_instructions_included": { - "description": "True if system message contains custom instructions placeholder, false otherwise", + "description": "True if system message contains custom instructions placeholder, false otherwise.", "type": "boolean", "example": false } @@ -26587,7 +26587,7 @@ { "properties": { "warnings": { - "description": "Warnings concerning tool", + "description": "Warnings concerning tool.", "type": "array", "items": { "type": "string" @@ -26612,7 +26612,7 @@ { "properties": { "is_custom_instructions_included": { - "description": "True if system message contains custom instructions placeholder, false otherwise", + "description": "True if system message contains custom instructions placeholder, false otherwise.", "type": "boolean", "example": false } @@ -26632,7 +26632,7 @@ { "properties": { "warnings": { - "description": "Warnings concerning tool", + "description": "Warnings concerning tool.", "type": "array", "items": { "type": "string" @@ -26751,7 +26751,7 @@ { "properties": { "is_custom_instructions_included": { - "description": "True if system message contains custom instructions placeholder, false otherwise", + "description": "True if system message contains custom instructions placeholder, false otherwise.", "type": "boolean", "example": false } @@ -26771,7 +26771,7 @@ { "properties": { "warnings": { - "description": "Warnings concerning tool", + "description": "Warnings concerning tool.", "type": "array", "items": { "type": "string" @@ -26875,7 +26875,7 @@ "x-box-tag": "ai_studio" }, "AiTextGen": { - "description": "AI text gen request object", + "description": "AI text gen request object.", "type": "object", "properties": { "prompt": { @@ -26960,7 +26960,7 @@ "example": "12345678" }, "type": { - "description": "`app_item`", + "description": "The value will always be `app_item`.", "type": "string", "example": "app_item", "enum": [ @@ -26993,7 +26993,7 @@ "nullable": false }, "type": { - "description": "`app_item_association`", + "description": "The value will always be `app_item_association`.", "type": "string", "example": "app_item_association", "enum": [ @@ -27045,12 +27045,12 @@ "x-box-tag": "app_item_associations" }, "AppItemAssociations": { - "description": "A list of app item associations", + "description": "A list of app item associations.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27092,12 +27092,12 @@ "type": "object", "properties": { "id": { - "description": "The id of the `AppItem`", + "description": "The id of the `AppItem`.", "type": "string", "example": "6374669741" }, "type": { - "description": "The type of the source that this event represents. Can only be `app_item`.\n", + "description": "The type of the source that this event represents. Can only be `app_item`.", "type": "string", "example": "app_item", "enum": [ @@ -27106,7 +27106,7 @@ "nullable": false }, "app_item_type": { - "description": "The type of the `AppItem`", + "description": "The type of the `AppItem`.", "type": "string", "example": "hubs" }, @@ -27154,7 +27154,7 @@ "example": "folder_59449484661," }, "$template": { - "description": "`securityClassification-6VMVochwUWo`", + "description": "The value will always be `securityClassification-6VMVochwUWo`.", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ @@ -27201,7 +27201,7 @@ "example": "58063d82-4128-7b43-bba9-92f706befcdf" }, "type": { - "description": "`metadata_template`", + "description": "The value will always be `metadata_template`.", "type": "string", "example": "metadata_template", "enum": [ @@ -27215,7 +27215,7 @@ "example": "enterprise_123456" }, "templateKey": { - "description": "`securityClassification-6VMVochwUWo`", + "description": "The value will always be `securityClassification-6VMVochwUWo`.", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ @@ -27276,7 +27276,7 @@ ] }, "displayName": { - "description": "`Classification`", + "description": "The value will always be `Classification`.", "type": "string", "example": "Classification", "enum": [ @@ -27323,7 +27323,7 @@ "example": "Sensitive information" }, "colorID": { - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray", + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow.\n* `1`: Orange.\n* `2`: Watermelon red.\n* `3`: Purple rain.\n* `4`: Light blue.\n* `5`: Dark blue.\n* `6`: Light green.\n* `7`: Gray.", "type": "integer", "format": "int64", "example": 4 @@ -27355,11 +27355,11 @@ "x-box-tag": "classifications" }, "ClientError": { - "description": "A generic error", + "description": "A generic error.", "type": "object", "properties": { "type": { - "description": "error", + "description": "The value will always be `error`.", "type": "string", "example": "error", "enum": [ @@ -27375,7 +27375,7 @@ "nullable": false }, "code": { - "description": "A Box-specific error code", + "description": "A Box-specific error code.", "type": "string", "example": "item_name_invalid", "enum": [ @@ -27439,7 +27439,7 @@ "example": "12345678" }, "type": { - "description": "`collaboration`", + "description": "The value will always be `collaboration`.", "type": "string", "example": "collaboration", "enum": [ @@ -27655,7 +27655,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27680,7 +27680,7 @@ { "properties": { "entries": { - "description": "A list of allowed collaboration domains", + "description": "A list of allowed collaboration domains.", "type": "array", "items": { "$ref": "#/components/schemas/CollaborationAllowlistEntry" @@ -27698,12 +27698,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this entry", + "description": "The unique identifier for this entry.", "type": "string", "example": "11446498" }, "type": { - "description": "`collaboration_whitelist_entry`", + "description": "The value will always be `collaboration_whitelist_entry`.", "type": "string", "example": "collaboration_whitelist_entry", "enum": [ @@ -27711,7 +27711,7 @@ ] }, "domain": { - "description": "The whitelisted domain", + "description": "The whitelisted domain.", "type": "string", "example": "example.com" }, @@ -27730,7 +27730,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -27738,7 +27738,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -27746,19 +27746,19 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise this list is applied to" + "description": "The enterprise this list is applied to." } ] }, "created_at": { - "description": "The time the entry was created at", + "description": "The time the entry was created at.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -27773,12 +27773,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this exemption", + "description": "The unique identifier for this exemption.", "type": "string", "example": "11446498" }, "type": { - "description": "`collaboration_whitelist_exempt_target`", + "description": "The value will always be `collaboration_whitelist_exempt_target`.", "type": "string", "example": "collaboration_whitelist_exempt_target", "enum": [ @@ -27790,7 +27790,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -27798,7 +27798,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -27806,14 +27806,14 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise this entry belongs to" + "description": "The enterprise this entry belongs to." } ] }, @@ -27823,18 +27823,18 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that has been exempt" + "description": "The user that has been exempt." } ] }, "created_at": { - "description": "The time the entry was created", + "description": "The time the entry was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "The time the entry was modified", + "description": "The time the entry was modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -27850,7 +27850,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27889,12 +27889,12 @@ "x-box-tag": "collaboration_allowlist_exempt_targets" }, "Collaborations": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -27919,7 +27919,7 @@ { "properties": { "entries": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "array", "items": { "$ref": "#/components/schemas/Collaboration" @@ -27933,12 +27933,12 @@ "x-box-tag": "user_collaborations" }, "CollaborationsOffsetPaginated": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -27963,7 +27963,7 @@ { "properties": { "entries": { - "description": "A list of collaborations", + "description": "A list of collaborations.", "type": "array", "items": { "$ref": "#/components/schemas/Collaboration" @@ -27981,7 +27981,7 @@ "type": "object", "properties": { "type": { - "description": "Collaborator\nobject type.\n", + "description": "Collaborator\nobject type.", "type": "string", "example": "variable", "enum": [ @@ -27989,7 +27989,7 @@ ] }, "variable_type": { - "description": "Variable type \nfor the Collaborator\nobject.\n", + "description": "Variable type \nfor the Collaborator\nobject.", "type": "string", "example": "user_list", "enum": [ @@ -28041,7 +28041,7 @@ "example": "11446498" }, "type": { - "description": "`collection`", + "description": "The value will always be `collection`.", "type": "string", "example": "collection", "enum": [ @@ -28070,12 +28070,12 @@ "x-box-tag": "collections" }, "Collections": { - "description": "A list of collections", + "description": "A list of collections.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -28100,15 +28100,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -28124,7 +28124,7 @@ { "properties": { "entries": { - "description": "A list of collections", + "description": "A list of collections.", "type": "array", "items": { "$ref": "#/components/schemas/Collection" @@ -28147,12 +28147,12 @@ { "properties": { "is_reply_comment": { - "description": "Whether or not this comment is a reply to another\ncomment", + "description": "Whether or not this comment is a reply to another\ncomment.", "type": "boolean", "example": true }, "message": { - "description": "The text of the comment, as provided by the user", + "description": "The text of the comment, as provided by the user.", "type": "string", "example": "@Aaron Levie these tigers are cool!" }, @@ -28162,18 +28162,18 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "A mini user object representing the author of the\ncomment" + "description": "A mini user object representing the author of the\ncomment." } ] }, "created_at": { - "description": "The time this comment was created", + "description": "The time this comment was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "The time this comment was last modified", + "description": "The time this comment was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -28182,23 +28182,23 @@ "allOf": [ { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } } }, { - "description": "The file this comment was placed on" + "description": "The file this comment was placed on." } ] } @@ -28219,7 +28219,7 @@ "example": "11446498" }, "type": { - "description": "`comment`", + "description": "The value will always be `comment`.", "type": "string", "example": "comment", "enum": [ @@ -28238,7 +28238,7 @@ ] }, "Comment--Full": { - "description": "Comments are messages created on files. Comments\ncan be made independently or created as responses to other\ncomments", + "description": "Comments are messages created on files. Comments\ncan be made independently or created as responses to other\ncomments.", "type": "object", "allOf": [ { @@ -28259,12 +28259,12 @@ "x-box-variant": "full" }, "Comments": { - "description": "A list of comments", + "description": "A list of comments.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -28289,15 +28289,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -28313,7 +28313,7 @@ { "properties": { "entries": { - "description": "A list of comments", + "description": "A list of comments.", "type": "array", "items": { "$ref": "#/components/schemas/Comment--Full" @@ -28331,7 +28331,7 @@ "type": "object", "properties": { "type": { - "description": "Completion\nRule object type.\n", + "description": "Completion\nRule object type.", "type": "string", "example": "variable", "enum": [ @@ -28339,7 +28339,7 @@ ] }, "variable_type": { - "description": "Variable type\nfor the Completion\nRule object.\n", + "description": "Variable type\nfor the Completion\nRule object.", "type": "string", "example": "task_completion_rule", "enum": [ @@ -28347,7 +28347,7 @@ ] }, "variable_value": { - "description": "Variable\nvalues for a completion\nrule.\n", + "description": "Variable\nvalues for a completion\nrule.", "type": "string", "example": "all_assignees", "enum": [ @@ -28416,7 +28416,7 @@ "x-box-tag": "ai_studio" }, "icon_reference": { - "description": "The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/`\nwhere possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png`", + "description": "The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/`\nwhere possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png`.", "type": "string", "example": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg", "minLength": 1 @@ -28456,7 +28456,7 @@ "example": "11446498" }, "type": { - "description": "`device_pinner`", + "description": "The value will always be `device_pinner`.", "type": "string", "example": "device_pinner", "enum": [ @@ -28469,12 +28469,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that the device pin belongs to" + "description": "The user that the device pin belongs to." } ] }, "product_name": { - "description": "The type of device being pinned", + "description": "The type of device being pinned.", "type": "string", "example": "iPad" } @@ -28484,11 +28484,11 @@ "x-box-tag": "device_pinners" }, "DevicePinners": { - "description": "A list of device pins", + "description": "A list of device pins.", "type": "object", "properties": { "entries": { - "description": "A list of device pins", + "description": "A list of device pins.", "type": "array", "items": { "$ref": "#/components/schemas/DevicePinner" @@ -28512,10 +28512,10 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field that is ordered by", + "description": "The field that is ordered by.", "type": "string", "example": "id", "enum": [ @@ -28523,7 +28523,7 @@ ] }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "asc", "enum": [ @@ -28544,12 +28544,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "`email_alias`", + "description": "The value will always be `email_alias`.", "type": "string", "example": "email_alias", "enum": [ @@ -28557,12 +28557,12 @@ ] }, "email": { - "description": "The email address", + "description": "The email address.", "type": "string", "example": "alias@example.com" }, "is_confirmed": { - "description": "Whether the email address has been confirmed", + "description": "Whether the email address has been confirmed.", "type": "boolean", "example": true } @@ -28572,7 +28572,7 @@ "x-box-tag": "email_aliases" }, "EmailAliases": { - "description": "A list of email aliases", + "description": "A list of email aliases.", "type": "object", "properties": { "total_count": { @@ -28582,7 +28582,7 @@ "example": 5000 }, "entries": { - "description": "A list of email aliases", + "description": "A list of email aliases.", "type": "array", "items": { "$ref": "#/components/schemas/EmailAlias" @@ -28598,12 +28598,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this enterprise", + "description": "The unique identifier for this enterprise.", "type": "string", "example": "1910967" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -28623,28 +28623,28 @@ ] }, "Event": { - "description": "The description of an event that happened within Box", + "description": "The description of an event that happened within Box.", "type": "object", "properties": { "type": { - "description": "`event`", + "description": "The value will always be `event`.", "type": "string", "example": "event" }, "created_at": { - "description": "When the event object was created", + "description": "When the event object was created.", "type": "string", "format": "date-time", "example": "2022-12-12T10:53:43-08:00" }, "recorded_at": { - "description": "When the event object was recorded in database", + "description": "When the event object was recorded in database.", "type": "string", "format": "date-time", "example": "2022-12-12T10:54:43-08:00" }, "event_id": { - "description": "The ID of the event object. You can use this to detect duplicate events", + "description": "The ID of the event object. You can use this to detect duplicate events.", "type": "string", "example": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83" }, @@ -28654,7 +28654,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that performed the action represented by the event.\nSome events may be performed by users not logged into Box.\nIn that case, not all attributes of the object are populated and the\nevent is attributed to a unknown user (`user_id = 2`)" + "description": "The user that performed the action represented by the event.\nSome events may be performed by users not logged into Box.\nIn that case, not all attributes of the object are populated and the\nevent is attributed to a unknown user (`user_id = 2`)." } ] }, @@ -28664,7 +28664,7 @@ "title": "Event Type", "example": "FILE_MARKED_MALICIOUS", "type": "string", - "description": "An event type that can trigger an event", + "description": "An event type that can trigger an event.", "enum": [ "ACCESS_GRANTED", "ACCESS_REVOKED", @@ -28810,7 +28810,7 @@ ] }, { - "description": "The event type that triggered this event" + "description": "The event type that triggered this event." } ] }, @@ -28865,7 +28865,7 @@ "type": "object", "properties": { "item_type": { - "description": "The type of the item that the event\nrepresents. Can be `file` or `folder`.\n", + "description": "The type of the item that the event\nrepresents. Can be `file` or `folder`.", "type": "string", "example": "file", "enum": [ @@ -28875,13 +28875,13 @@ "nullable": false }, "item_id": { - "description": "The unique identifier that represents the\nitem.\n", + "description": "The unique identifier that represents the\nitem.", "type": "string", "example": "560284318361", "nullable": false }, "item_name": { - "description": "The name of the item.\n", + "description": "The name of the item.", "type": "string", "example": "report.pdf", "nullable": false @@ -28891,7 +28891,7 @@ "type": "object", "properties": { "name": { - "description": "The classification's name", + "description": "The classification's name.", "type": "string", "example": "Top Secret" } @@ -28931,7 +28931,7 @@ "x-box-resource-id": "event_source" }, "Events": { - "description": "A list of event objects", + "description": "A list of event objects.", "type": "object", "properties": { "chunk_size": { @@ -28953,7 +28953,7 @@ ] }, "entries": { - "description": "A list of events", + "description": "A list of events.", "type": "array", "items": { "$ref": "#/components/schemas/Event" @@ -28965,7 +28965,7 @@ "x-box-tag": "events" }, "File": { - "description": "A standard representation of a file, as returned from any\nfile API endpoints by default", + "description": "A standard representation of a file, as returned from any\nfile API endpoints by default.", "type": "object", "allOf": [ { @@ -29005,7 +29005,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -29070,7 +29070,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this file" + "description": "The user who created this file." } ] }, @@ -29080,7 +29080,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this file" + "description": "The user who last modified this file." }, { "nullable": false @@ -29093,7 +29093,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this file" + "description": "The user who owns this file." }, { "nullable": false @@ -29288,7 +29288,7 @@ "nullable": true }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -29314,7 +29314,7 @@ ] }, "File--Full": { - "description": "A full representation of a file, as can be returned from any\nfile API endpoints by default", + "description": "A full representation of a file, as can be returned from any\nfile API endpoints by default.", "type": "object", "allOf": [ { @@ -29323,12 +29323,12 @@ { "properties": { "version_number": { - "description": "The version number of this file", + "description": "The version number of this file.", "type": "string", "example": "1" }, "comment_count": { - "description": "The number of comments on this file", + "description": "The number of comments on this file.", "type": "integer", "example": 10 }, @@ -29423,13 +29423,13 @@ "nullable": false }, "can_view_annotations_all": { - "description": "Specifies if the user view all annotations placed on this file", + "description": "Specifies if the user view all annotations placed on this file.", "type": "boolean", "example": true, "nullable": false }, "can_view_annotations_self": { - "description": "Specifies if the user view annotations placed by themselves\non this file", + "description": "Specifies if the user view annotations placed by themselves\non this file.", "type": "boolean", "example": true, "nullable": false @@ -29473,12 +29473,12 @@ "description": "The lock held on a file. A lock prevents a file from being moved,\nrenamed, or otherwise changed by anyone else than the user who created the\nlock.", "properties": { "id": { - "description": "The unique identifier for this lock", + "description": "The unique identifier for this lock.", "type": "string", "example": "11446498" }, "type": { - "description": "`lock`", + "description": "The value will always be `lock`.", "type": "string", "example": "lock", "enum": [ @@ -29551,7 +29551,7 @@ "allOf": [ { "type": "object", - "description": "The basics of an access token", + "description": "The basics of an access token.", "properties": { "access_token": { "description": "The requested access token.", @@ -29603,7 +29603,7 @@ "allOf": [ { "type": "object", - "description": "Details about the watermark applied to this item", + "description": "Details about the watermark applied to this item.", "properties": { "is_watermarked": { "description": "Specifies if this item has a watermark applied.", @@ -29614,7 +29614,7 @@ } }, { - "description": "Details about the watermark applied to this file" + "description": "Details about the watermark applied to this file." } ] }, @@ -29701,7 +29701,7 @@ ] }, "expires_at": { - "description": "When the file will automatically be deleted", + "description": "When the file will automatically be deleted.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", @@ -29711,15 +29711,15 @@ "allOf": [ { "title": "Representations", - "description": "A list of file representations", + "description": "A list of file representations.", "type": "object", "properties": { "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "type": "object", - "description": "A file representation", + "description": "A file representation.", "properties": { "content": { "description": "An object containing the URL that can be used to actually fetch\nthe representation.", @@ -29801,10 +29801,10 @@ "allOf": [ { "type": "object", - "description": "The classification applied to an item", + "description": "The classification applied to an item.", "properties": { "name": { - "description": "The name of the classification", + "description": "The name of the classification.", "type": "string", "example": "Top Secret" }, @@ -29840,7 +29840,7 @@ ] }, "disposition_at": { - "description": "The retention expiration timestamp for the given file", + "description": "The retention expiration timestamp for the given file.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", @@ -29898,7 +29898,7 @@ ] }, "name": { - "description": "The name of the file", + "description": "The name of the file.", "type": "string", "example": "Contract.pdf" }, @@ -29928,7 +29928,7 @@ "x-box-variant": "mini" }, "FileConflict": { - "description": "A representation of a file that is used to show", + "description": "A representation of a file that is used to show.", "type": "object", "allOf": [ { @@ -29952,11 +29952,11 @@ "x-box-tag": null }, "FileOrFolderScope": { - "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed", + "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed.", "type": "object", "properties": { "scope": { - "description": "The scopes for the resource access", + "description": "The scopes for the resource access.", "type": "string", "example": "item_download", "enum": [ @@ -29989,7 +29989,7 @@ ] }, { - "description": "The file or folder resource" + "description": "The file or folder resource." } ] } @@ -30007,7 +30007,7 @@ "readOnly": true }, "type": { - "description": "`file_request`", + "description": "The value will always be `file_request`.", "type": "string", "example": "file_request", "enum": [ @@ -30137,7 +30137,7 @@ "type": "object", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -30205,7 +30205,7 @@ "title": "File Request (Update)" }, "FileVersion": { - "description": "A standard representation of a file version", + "description": "A standard representation of a file version.", "type": "object", "allOf": [ { @@ -30214,24 +30214,24 @@ { "properties": { "name": { - "description": "The name of the file version", + "description": "The name of the file version.", "type": "string", "example": "tigers.jpeg" }, "size": { - "description": "Size of the file version in bytes", + "description": "Size of the file version in bytes.", "type": "integer", "format": "int64", "example": 629644 }, "created_at": { - "description": "When the file version object was created", + "description": "When the file version object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the file version object was last updated", + "description": "When the file version object was last updated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -30242,7 +30242,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last updated the file version" + "description": "The user who last updated the file version." } ] }, @@ -30259,7 +30259,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who trashed the file version" + "description": "The user who trashed the file version." } ] }, @@ -30316,7 +30316,7 @@ "nullable": false }, "type": { - "description": "`file_version`", + "description": "The value will always be `file_version`.", "type": "string", "example": "file_version", "enum": [ @@ -30340,7 +30340,7 @@ ] }, "FileVersion--Full": { - "description": "A full representation of a file version, as can be returned from any\nfile version API endpoints by default", + "description": "A full representation of a file version, as can be returned from any\nfile version API endpoints by default.", "type": "object", "allOf": [ { @@ -30349,7 +30349,7 @@ { "properties": { "version_number": { - "description": "The version number of this file version", + "description": "The version number of this file version.", "type": "string", "example": "1" } @@ -30386,12 +30386,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this file version legal hold", + "description": "The unique identifier for this file version legal hold.", "type": "string", "example": "11446498" }, "type": { - "description": "`file_version_legal_hold`", + "description": "The value will always be `file_version_legal_hold`.", "type": "string", "example": "file_version_legal_hold", "enum": [ @@ -30404,7 +30404,7 @@ "$ref": "#/components/schemas/FileVersion--Mini" }, { - "description": "The file version that is held" + "description": "The file version that is held." } ] }, @@ -30442,7 +30442,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30467,7 +30467,7 @@ { "properties": { "entries": { - "description": "A list of file version legal holds", + "description": "A list of file version legal holds.", "type": "array", "items": { "$ref": "#/components/schemas/FileVersionLegalHold" @@ -30490,7 +30490,7 @@ "example": "11446498" }, "type": { - "description": "`file_version_retention`", + "description": "The value will always be `file_version_retention`.", "type": "string", "example": "file_version_retention", "enum": [ @@ -30503,7 +30503,7 @@ "$ref": "#/components/schemas/FileVersion--Mini" }, { - "description": "The file version this file version retention was\napplied to" + "description": "The file version this file version retention was\napplied to." } ] }, @@ -30513,18 +30513,18 @@ "$ref": "#/components/schemas/File--Mini" }, { - "description": "The file this file version retention was applied to" + "description": "The file this file version retention was applied to." } ] }, "applied_at": { - "description": "When this file version retention object was\ncreated", + "description": "When this file version retention object was\ncreated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "disposition_at": { - "description": "When the retention expires on this file\nversion retention", + "description": "When the retention expires on this file\nversion retention.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -30550,7 +30550,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30575,7 +30575,7 @@ { "properties": { "entries": { - "description": "A list of file version retentions", + "description": "A list of file version retentions.", "type": "array", "items": { "$ref": "#/components/schemas/FileVersionRetention" @@ -30589,12 +30589,12 @@ "x-box-tag": "file_version_retentions" }, "FileVersions": { - "description": "A list of file versions", + "description": "A list of file versions.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -30619,15 +30619,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -30643,7 +30643,7 @@ { "properties": { "entries": { - "description": "A list of file versions", + "description": "A list of file versions.", "type": "array", "items": { "$ref": "#/components/schemas/FileVersion--Full" @@ -30657,12 +30657,12 @@ "x-box-tag": "file_versions" }, "FileVersionsOnHold": { - "description": "A list of files on hold for legal policy assignment", + "description": "A list of files on hold for legal policy assignment.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30701,7 +30701,7 @@ "x-box-tag": "legal_hold_policy_assignments" }, "Files": { - "description": "A list of files", + "description": "A list of files.", "type": "object", "properties": { "total_count": { @@ -30711,7 +30711,7 @@ "example": 1 }, "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "$ref": "#/components/schemas/File--Full" @@ -30723,12 +30723,12 @@ "x-box-tag": "files" }, "FilesOnHold": { - "description": "A list of files on hold for legal policy assignment", + "description": "A list of files on hold for legal policy assignment.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30753,7 +30753,7 @@ { "properties": { "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "$ref": "#/components/schemas/File--Mini" @@ -30772,7 +30772,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -30797,7 +30797,7 @@ { "properties": { "entries": { - "description": "A list of files", + "description": "A list of files.", "type": "array", "items": { "$ref": "#/components/schemas/File--Mini" @@ -30811,7 +30811,7 @@ "x-box-tag": "retention_policy_assignments" }, "Folder": { - "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default", + "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default.", "type": "object", "allOf": [ { @@ -30837,7 +30837,7 @@ "allOf": [ { "type": "string", - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false @@ -30873,7 +30873,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -30896,7 +30896,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this folder" + "description": "The user who created this folder." }, { "nullable": false @@ -31098,7 +31098,7 @@ "nullable": true }, "folder_upload_email": { - "description": "The `folder_upload_email` parameter is not `null` if one of the following options is **true**:\n\n * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.\n\n * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).\n\nIf the conditions are not met, the parameter will have the following value: `folder_upload_email: null`", + "description": "The `folder_upload_email` parameter is not `null` if one of the following options is **true**:\n\n * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.\n\n * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).\n\nIf the conditions are not met, the parameter will have the following value: `folder_upload_email: null`.", "type": "object", "nullable": true, "properties": { @@ -31180,7 +31180,7 @@ "nullable": true }, "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -31205,7 +31205,7 @@ ] }, "Folder--Full": { - "description": "A full representation of a folder, as can be returned from any\nfolder API endpoints by default", + "description": "A full representation of a folder, as can be returned from any\nfolder API endpoints by default.", "type": "object", "allOf": [ { @@ -31306,7 +31306,7 @@ ] }, { - "description": "Describes the permissions that the current user has\nfor this folder" + "description": "Describes the permissions that the current user has\nfor this folder." }, { "nullable": false @@ -31447,7 +31447,7 @@ "allOf": [ { "type": "object", - "description": "Details about the watermark applied to this item", + "description": "Details about the watermark applied to this item.", "properties": { "is_watermarked": { "description": "Specifies if this item has a watermark applied.", @@ -31458,7 +31458,7 @@ } }, { - "description": "Details about the watermark applied to this folder" + "description": "Details about the watermark applied to this folder." }, { "nullable": false @@ -31479,10 +31479,10 @@ "allOf": [ { "type": "object", - "description": "The classification applied to an item", + "description": "The classification applied to an item.", "properties": { "name": { - "description": "The name of the classification", + "description": "The name of the classification.", "type": "string", "example": "Top Secret" }, @@ -31595,7 +31595,7 @@ "example": "2020-09-14T23:12:53Z" }, "locked_operations": { - "description": "The operations that have been locked. Currently the `move`\nand `delete` operations cannot be locked separately, and both need to be\nset to `true`.\n", + "description": "The operations that have been locked. Currently the `move`\nand `delete` operations cannot be locked separately, and both need to be\nset to `true`.", "type": "object", "properties": { "move": { @@ -31627,11 +31627,11 @@ "x-box-tag": "folder_locks" }, "FolderLocks": { - "description": "A list of folder locks", + "description": "A list of folder locks.", "type": "object", "properties": { "entries": { - "description": "A list of folder locks", + "description": "A list of folder locks.", "type": "array", "items": { "$ref": "#/components/schemas/FolderLock" @@ -31654,11 +31654,11 @@ "x-box-tag": "folder_locks" }, "FolderReference": { - "description": "Folder reference", + "description": "Folder reference.", "type": "object", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -31667,7 +31667,7 @@ "nullable": false }, "id": { - "description": "ID of the folder", + "description": "ID of the folder.", "type": "string", "example": "42037322" } @@ -31685,7 +31685,7 @@ "allOf": [ {}, { - "description": "A definition of a generic\nevent source object. The set of\nparameters depends on the\nobject type. For example, a Box Shield\nevent source would have the following\nset of parameters:\n```yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n {\n \"name\": \"8\",\n \"member_count\": 1\n },\n {\n \"name\": \"9\",\n \"member_count\": 1\n }\n ]\n} \n```\n" + "description": "A definition of a generic\nevent source object. The set of\nparameters depends on the\nobject type. For example, a Box Shield\nevent source would have the following\nset of parameters:\n```yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n {\n \"name\": \"8\",\n \"member_count\": 1\n },\n {\n \"name\": \"9\",\n \"member_count\": 1\n }\n ]\n} \n```." } ] }, @@ -31693,7 +31693,7 @@ "x-box-resource-id": "generic_source" }, "Group": { - "description": "A standard representation of a group, as returned from any\ngroup API endpoints by default", + "description": "A standard representation of a group, as returned from any\ngroup API endpoints by default.", "type": "object", "allOf": [ { @@ -31702,13 +31702,13 @@ { "properties": { "created_at": { - "description": "When the group object was created", + "description": "When the group object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the group object was last modified", + "description": "When the group object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -31725,12 +31725,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "`group`", + "description": "The value will always be `group`.", "type": "string", "example": "group", "enum": [ @@ -31790,7 +31790,7 @@ ] }, "member_viewability_level": { - "description": "Specifies who can view the members of the group\n(Get Memberships for Group).\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin\n* `admins_and_members` - all admins and group members\n* `all_managed_users` - all managed users in the\n enterprise", + "description": "Specifies who can view the members of the group\n(Get Memberships for Group).\n\n* `admins_only` - the enterprise admin, co-admins, group's\n group admin.\n* `admins_and_members` - all admins and group members.\n* `all_managed_users` - all managed users in the\n enterprise.", "type": "string", "example": "admins_only", "enum": [ @@ -31834,7 +31834,7 @@ { "properties": { "name": { - "description": "The name of the group", + "description": "The name of the group.", "type": "string", "example": "Support" }, @@ -31859,12 +31859,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this group membership", + "description": "The unique identifier for this group membership.", "type": "string", "example": "11446498" }, "type": { - "description": "`group_membership`", + "description": "The value will always be `group_membership`.", "type": "string", "example": "group_membership", "enum": [ @@ -31877,7 +31877,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that the membership applies to" + "description": "The user that the membership applies to." } ] }, @@ -31887,7 +31887,7 @@ "$ref": "#/components/schemas/Group--Mini" }, { - "description": "The group that the membership applies to" + "description": "The group that the membership applies to." } ] }, @@ -31923,7 +31923,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -31948,15 +31948,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -31972,7 +31972,7 @@ { "properties": { "entries": { - "description": "A list of group memberships", + "description": "A list of group memberships.", "type": "array", "items": { "$ref": "#/components/schemas/GroupMembership" @@ -31991,7 +31991,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -32016,15 +32016,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -32040,7 +32040,7 @@ { "properties": { "entries": { - "description": "A list of groups", + "description": "A list of groups.", "type": "array", "items": { "$ref": "#/components/schemas/Group--Full" @@ -32063,7 +32063,7 @@ { "properties": { "integration_type": { - "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nCurrently only supports Slack.\n(part of the composite key together with `id`)", + "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nCurrently only supports Slack.\n(part of the composite key together with `id`).", "type": "string", "example": "slack", "enum": [ @@ -32071,7 +32071,7 @@ ] }, "is_manually_created": { - "description": "Identifies whether the mapping has\nbeen manually set\n(as opposed to being automatically created)", + "description": "Identifies whether the mapping has\nbeen manually set\n(as opposed to being automatically created).", "type": "boolean", "example": true }, @@ -32083,7 +32083,7 @@ ] }, "created_by": { - "description": "An object representing the user who\ncreated the integration mapping", + "description": "An object representing the user who\ncreated the integration mapping.", "allOf": [ { "$ref": "#/components/schemas/UserIntegrationMappings" @@ -32091,7 +32091,7 @@ ] }, "modified_by": { - "description": "The user who\nlast modified the integration mapping", + "description": "The user who\nlast modified the integration mapping.", "allOf": [ { "$ref": "#/components/schemas/UserIntegrationMappings" @@ -32099,7 +32099,7 @@ ] }, "partner_item": { - "description": "Mapped item object for Slack", + "description": "Mapped item object for Slack.", "example": { "id": "C12378991223", "type": "channel", @@ -32112,7 +32112,7 @@ ] }, "box_item": { - "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped", + "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped.", "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" @@ -32120,13 +32120,13 @@ ] }, "created_at": { - "description": "When the integration mapping object was created", + "description": "When the integration mapping object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the integration mapping object was last modified", + "description": "When the integration mapping object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -32147,12 +32147,12 @@ "type": "object", "properties": { "id": { - "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`)", + "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`).", "type": "string", "example": "12345" }, "type": { - "description": "Mapping type", + "description": "Mapping type.", "type": "string", "example": "integration_mapping", "enum": [ @@ -32167,11 +32167,11 @@ "title": "Integration mapping" }, "IntegrationMappingBoxItemSlack": { - "description": "The schema for an integration mapping Box item object for type Slack", + "description": "The schema for an integration mapping Box item object for type Slack.", "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "folder", "enum": [ @@ -32180,7 +32180,7 @@ "nullable": false }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "1234567891", "nullable": false @@ -32197,7 +32197,7 @@ "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "channel", "enum": [ @@ -32206,7 +32206,7 @@ "nullable": false }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "C12378991223", "nullable": false @@ -32235,7 +32235,7 @@ "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "channel", "enum": [ @@ -32244,7 +32244,7 @@ ] }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2" }, @@ -32266,7 +32266,7 @@ "type": "object", "properties": { "type": { - "description": "Type of the mapped item referenced in `id`", + "description": "Type of the mapped item referenced in `id`.", "type": "string", "example": "channel", "enum": [ @@ -32275,7 +32275,7 @@ ] }, "id": { - "description": "ID of the mapped item (of type referenced in `type`)", + "description": "ID of the mapped item (of type referenced in `type`).", "type": "string", "example": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2" }, @@ -32299,7 +32299,7 @@ "title": "Integration mapping mapped item schema for type Teams" }, "IntegrationMappingSlackCreateRequest": { - "description": "A request to create a Slack Integration Mapping object", + "description": "A request to create a Slack Integration Mapping object.", "type": "object", "properties": { "partner_item": { @@ -32353,7 +32353,7 @@ { "properties": { "integration_type": { - "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nSupports Slack and Teams.\n(part of the composite key together with `id`)", + "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nSupports Slack and Teams.\n(part of the composite key together with `id`).", "type": "string", "example": "teams", "enum": [ @@ -32361,12 +32361,12 @@ ] }, "is_overridden_by_manual_mapping": { - "description": "Identifies whether the mapping has\nbeen manually set by the team owner from UI for channels\n(as opposed to being automatically created)", + "description": "Identifies whether the mapping has\nbeen manually set by the team owner from UI for channels\n(as opposed to being automatically created).", "type": "boolean", "example": true }, "partner_item": { - "description": "Mapped item object for Teams", + "description": "Mapped item object for Teams.", "example": { "id": "19%3ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2", "type": "channel", @@ -32385,18 +32385,18 @@ "$ref": "#/components/schemas/FolderReference" }, { - "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped" + "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped." } ] }, "created_at": { - "description": "When the integration mapping object was created", + "description": "When the integration mapping object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the integration mapping object was last modified", + "description": "When the integration mapping object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -32414,7 +32414,7 @@ "x-box-variant": "standard" }, "IntegrationMappingTeamsCreateRequest": { - "description": "A request to create a Teams Integration Mapping object", + "description": "A request to create a Teams Integration Mapping object.", "type": "object", "properties": { "partner_item": { @@ -32430,7 +32430,7 @@ "$ref": "#/components/schemas/FolderReference" }, { - "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped" + "description": "The Box folder, to which the object from the\npartner app domain (referenced in `partner_item_id`) is mapped." } ] } @@ -32448,7 +32448,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -32467,7 +32467,7 @@ { "properties": { "entries": { - "description": "A list of integration mappings", + "description": "A list of integration mappings.", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMapping" @@ -32487,7 +32487,7 @@ { "properties": { "entries": { - "description": "A list of integration mappings", + "description": "A list of integration mappings.", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMappingTeams" @@ -32505,12 +32505,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this invite", + "description": "The unique identifier for this invite.", "type": "string", "example": "11446498" }, "type": { - "description": "`invite`", + "description": "The value will always be `invite`.", "type": "string", "example": "invite", "enum": [ @@ -32518,7 +32518,7 @@ ] }, "invited_to": { - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "type": "object", "properties": { "id": { @@ -32527,7 +32527,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -32535,7 +32535,7 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } @@ -32549,12 +32549,12 @@ "$ref": "#/components/schemas/User--Mini" }, "status": { - "description": "The status of the invite", + "description": "The status of the invite.", "type": "string", "example": "pending" }, "created_at": { - "description": "When the invite was created", + "description": "When the invite was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -32580,7 +32580,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -32604,7 +32604,7 @@ }, { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -32629,15 +32629,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -32682,7 +32682,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -32707,15 +32707,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -32755,7 +32755,7 @@ "x-box-tag": "folders" }, "KeywordSkillCard": { - "description": "A skill card that contains a set of keywords", + "description": "A skill card that contains a set of keywords.", "type": "object", "properties": { "created_at": { @@ -32765,7 +32765,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -32773,7 +32773,7 @@ ] }, "skill_card_type": { - "description": "`keyword`", + "description": "The value will always be `keyword`.", "type": "string", "example": "keyword", "enum": [ @@ -32804,7 +32804,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -32827,7 +32827,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -32850,7 +32850,7 @@ "type": "array", "items": { "type": "object", - "description": "An entry in the `entries` attribute of a metadata card", + "description": "An entry in the `entries` attribute of a metadata card.", "properties": { "text": { "description": "The text of the keyword.", @@ -32878,7 +32878,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -32903,7 +32903,7 @@ { "properties": { "entries": { - "description": "A list of legal hold policies", + "description": "A list of legal hold policies.", "type": "array", "items": { "$ref": "#/components/schemas/LegalHoldPolicy" @@ -32938,7 +32938,7 @@ "maxLength": 500 }, "status": { - "description": "* 'active' - the policy is not in a transition state\n* 'applying' - that the policy is in the process of\n being applied\n* 'releasing' - that the process is in the process\n of being released\n* 'released' - the policy is no longer active", + "description": "Possible values:\n* 'active' - the policy is not in a transition state.\n* 'applying' - that the policy is in the process of\n being applied.\n* 'releasing' - that the process is in the process\n of being released.\n* 'released' - the policy is no longer active.", "type": "string", "example": "active", "enum": [ @@ -32949,29 +32949,29 @@ ] }, "assignment_counts": { - "description": "Counts of assignments within this a legal hold policy by item type", + "description": "Counts of assignments within this a legal hold policy by item type.", "type": "object", "properties": { "user": { - "description": "The number of users this policy is applied to", + "description": "The number of users this policy is applied to.", "type": "integer", "format": "int64", "example": 1 }, "folder": { - "description": "The number of folders this policy is applied to", + "description": "The number of folders this policy is applied to.", "type": "integer", "format": "int64", "example": 2 }, "file": { - "description": "The number of files this policy is applied to", + "description": "The number of files this policy is applied to.", "type": "integer", "format": "int64", "example": 3 }, "file_version": { - "description": "The number of file versions this policy is applied to", + "description": "The number of file versions this policy is applied to.", "type": "integer", "format": "int64", "example": 4 @@ -32984,12 +32984,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the legal hold policy object" + "description": "The user who created the legal hold policy object." } ] }, "created_at": { - "description": "When the legal hold policy object was created", + "description": "When the legal hold policy object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -33007,13 +33007,13 @@ "example": "2012-12-12T10:53:43-08:00" }, "filter_started_at": { - "description": "User-specified, optional date filter applies to\nCustodian assignments only", + "description": "User-specified, optional date filter applies to\nCustodian assignments only.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "filter_ended_at": { - "description": "User-specified, optional date filter applies to\nCustodian assignments only", + "description": "User-specified, optional date filter applies to\nCustodian assignments only.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -33032,16 +33032,16 @@ "x-box-variant": "standard" }, "LegalHoldPolicy--Mini": { - "description": "A mini legal hold policy", + "description": "A mini legal hold policy.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this legal hold policy", + "description": "The unique identifier for this legal hold policy.", "type": "string", "example": "11446498" }, "type": { - "description": "`legal_hold_policy`", + "description": "The value will always be `legal_hold_policy`.", "type": "string", "example": "legal_hold_policy", "enum": [ @@ -33077,7 +33077,7 @@ "$ref": "#/components/schemas/LegalHoldPolicy--Mini" }, { - "description": "The policy that the legal hold policy assignment\nis part of" + "description": "The policy that the legal hold policy assignment\nis part of." } ] }, @@ -33107,12 +33107,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the legal hold policy\nassignment" + "description": "The user who created the legal hold policy\nassignment." } ] }, "assigned_at": { - "description": "When the legal hold policy assignment object was\ncreated", + "description": "When the legal hold policy assignment object was\ncreated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -33135,12 +33135,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this legal hold assignment", + "description": "The unique identifier for this legal hold assignment.", "type": "string", "example": "11446498" }, "type": { - "description": "`legal_hold_policy_assignment`", + "description": "The value will always be `legal_hold_policy_assignment`.", "type": "string", "example": "legal_hold_policy_assignment", "enum": [ @@ -33163,7 +33163,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -33188,7 +33188,7 @@ { "properties": { "entries": { - "description": "A list of legal hold\npolicy assignments", + "description": "A list of legal hold\npolicy assignments.", "type": "array", "items": { "$ref": "#/components/schemas/LegalHoldPolicyAssignment" @@ -33224,7 +33224,7 @@ "example": "folder_59449484661," }, "$template": { - "description": "The name of the template", + "description": "The name of the template.", "type": "string", "example": "marketingCollateral" }, @@ -33307,7 +33307,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -33332,7 +33332,7 @@ { "properties": { "entries": { - "description": "A list of metadata cascade policies", + "description": "A list of metadata cascade policies.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataCascadePolicy" @@ -33350,12 +33350,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the metadata cascade policy object", + "description": "The ID of the metadata cascade policy object.", "type": "string", "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" }, "type": { - "description": "`metadata_cascade_policy`", + "description": "The value will always be `metadata_cascade_policy`.", "type": "string", "example": "metadata_cascade_policy", "enum": [ @@ -33367,7 +33367,7 @@ "type": "object", "properties": { "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -33386,7 +33386,7 @@ "type": "object", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -33648,7 +33648,7 @@ "title": "Metadata query search request" }, "MetadataQueryIndex": { - "description": "A metadata query index", + "description": "A metadata query index.", "type": "object", "properties": { "id": { @@ -33657,13 +33657,13 @@ "example": "-9876" }, "type": { - "description": "Value is always `metadata_query_index`", + "description": "Value is always `metadata_query_index`.", "type": "string", "example": "metadata_query_index", "nullable": false }, "status": { - "description": "The status of the metadata query index", + "description": "The status of the metadata query index.", "type": "string", "example": "active", "enum": [ @@ -33747,7 +33747,7 @@ "x-box-tag": "search" }, "MetadataTemplate": { - "description": "A template for metadata that can be applied to files and folders", + "description": "A template for metadata that can be applied to files and folders.", "type": "object", "properties": { "id": { @@ -33756,7 +33756,7 @@ "example": "58063d82-4128-7b43-bba9-92f706befcdf" }, "type": { - "description": "`metadata_template`", + "description": "The value will always be `metadata_template`.", "type": "string", "example": "metadata_template", "enum": [ @@ -33922,12 +33922,12 @@ "x-box-tag": "metadata_templates" }, "MetadataTemplates": { - "description": "A list of metadata templates", + "description": "A list of metadata templates.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -33952,7 +33952,7 @@ { "properties": { "entries": { - "description": "A list of metadata templates", + "description": "A list of metadata templates.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataTemplate" @@ -33987,7 +33987,7 @@ "x-box-tag": "file_metadata" }, "OAuth2Error": { - "description": "An OAuth 2.0 error", + "description": "An OAuth 2.0 error.", "type": "object", "properties": { "error": { @@ -34010,7 +34010,7 @@ "type": "object", "properties": { "id": { - "description": "ID of a specific outcome", + "description": "ID of a specific outcome.", "type": "string", "example": "17363629" }, @@ -34071,7 +34071,7 @@ "title": "Outcome" }, "PostOAuth2Revoke": { - "description": "A request to revoke an OAuth 2.0 token", + "description": "A request to revoke an OAuth 2.0 token.", "type": "object", "properties": { "client_id": { @@ -34097,7 +34097,7 @@ "title": "Token revocation request" }, "PostOAuth2Token": { - "description": "A request for a new OAuth 2.0 token", + "description": "A request for a new OAuth 2.0 token.", "type": "object", "properties": { "grant_type": { @@ -34171,7 +34171,7 @@ ] }, "scope": { - "description": "The space-delimited list of scopes that you want apply to the\nnew access token.\n\nThe `subject_token` will need to have all of these scopes or\nthe call will error with **401 Unauthorized**.", + "description": "The space-delimited list of scopes that you want apply to the\nnew access token.\n\nThe `subject_token` will need to have all of these scopes or\nthe call will error with **401 Unauthorized**..", "type": "string", "format": "space_delimited_list", "example": "item_upload item_preview base_explorer" @@ -34247,11 +34247,11 @@ "title": "Refresh access token" }, "RealtimeServer": { - "description": "A real-time server that can be used for\nlong polling user events", + "description": "A real-time server that can be used for\nlong polling user events.", "type": "object", "properties": { "type": { - "description": "`realtime_server`", + "description": "The value will always be `realtime_server`.", "type": "string", "example": "realtime_server" }, @@ -34261,7 +34261,7 @@ "example": "http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all" }, "ttl": { - "description": "The time in minutes for which this server is available", + "description": "The time in minutes for which this server is available.", "type": "string", "example": "10" }, @@ -34290,7 +34290,7 @@ "example": 1 }, "entries": { - "description": "A list of real-time servers", + "description": "A list of real-time servers.", "type": "array", "items": { "$ref": "#/components/schemas/RealtimeServer" @@ -34306,7 +34306,7 @@ "type": "object", "properties": { "type": { - "description": "`recent_item`", + "description": "The value will always be `recent_item`.", "type": "string", "example": "recent_item" }, @@ -34364,7 +34364,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -34389,7 +34389,7 @@ { "properties": { "entries": { - "description": "A list of recent items", + "description": "A list of recent items.", "type": "array", "items": { "$ref": "#/components/schemas/RecentItem" @@ -34418,7 +34418,7 @@ }, { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -34562,7 +34562,7 @@ "nullable": false }, "type": { - "description": "`retention_policy`", + "description": "The value will always be `retention_policy`.", "type": "string", "example": "retention_policy", "enum": [ @@ -34632,7 +34632,7 @@ "example": "11446498" }, "type": { - "description": "`retention_policy_assignment`", + "description": "The value will always be `retention_policy_assignment`.", "type": "string", "example": "retention_policy_assignment", "enum": [ @@ -34735,7 +34735,7 @@ "nullable": false }, "type": { - "description": "`retention_policy_assignment`", + "description": "The value will always be `retention_policy_assignment`.", "type": "string", "example": "retention_policy_assignment", "enum": [ @@ -34764,7 +34764,7 @@ { "properties": { "entries": { - "description": "A list of retention policy assignments", + "description": "A list of retention policy assignments.", "type": "array", "items": { "$ref": "#/components/schemas/RetentionPolicyAssignment" @@ -34774,7 +34774,7 @@ }, { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -34800,7 +34800,7 @@ "type": "object", "properties": { "type": { - "description": "Role object type.\n", + "description": "Role object type.", "type": "string", "example": "variable", "enum": [ @@ -34808,7 +34808,7 @@ ] }, "variable_type": { - "description": "The variable type used\nby the object.\n", + "description": "The variable type used\nby the object.", "type": "string", "example": "collaborator_role", "enum": [ @@ -34914,7 +34914,7 @@ { "properties": { "type": { - "description": "Specifies the response as search result items without shared links", + "description": "Specifies the response as search result items without shared links.", "type": "string", "example": "search_results_items", "enum": [ @@ -34979,7 +34979,7 @@ { "properties": { "type": { - "description": "Specifies the response as search result items with shared links", + "description": "Specifies the response as search result items with shared links.", "type": "string", "example": "search_results_with_shared_links", "enum": [ @@ -35005,11 +35005,11 @@ "x-box-tag": "search" }, "SessionTerminationMessage": { - "description": "A message informing about the\ntermination job status", + "description": "A message informing about the\ntermination job status.", "type": "object", "properties": { "message": { - "description": "The unique identifier for the termination job status", + "description": "The unique identifier for the termination job status.", "type": "string", "example": "Request is successful, please check the admin\nevents for the status of the job" } @@ -35019,16 +35019,16 @@ "x-box-tag": "session_termination" }, "ShieldInformationBarrier": { - "description": "A standard representation of a\nshield information barrier object", + "description": "A standard representation of a\nshield information barrier object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier", + "description": "The unique identifier for the shield information barrier.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier", + "description": "The type of the shield information barrier.", "type": "string", "example": "shield_information_barrier", "enum": [ @@ -35044,7 +35044,7 @@ ] }, "status": { - "description": "Status of the shield information barrier", + "description": "Status of the shield information barrier.", "type": "string", "example": "draft", "enum": [ @@ -35110,16 +35110,16 @@ ] }, "ShieldInformationBarrier--Base": { - "description": "A base representation of a\nshield information barrier object", + "description": "A base representation of a\nshield information barrier object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier", + "description": "The unique identifier for the shield information barrier.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier", + "description": "The type of the shield information barrier.", "type": "string", "example": "shield_information_barrier", "enum": [ @@ -35137,7 +35137,7 @@ ] }, "ShieldInformationBarrierReference": { - "description": "A shield information barrier reference for requests and responses", + "description": "A shield information barrier reference for requests and responses.", "type": "object", "properties": { "shield_information_barrier": { @@ -35149,7 +35149,7 @@ "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierReport": { - "description": "A standard representation\nof a shield information barrier report object", + "description": "A standard representation\nof a shield information barrier report object.", "type": "object", "allOf": [ { @@ -35165,7 +35165,7 @@ ] }, "status": { - "description": "Status of the shield information report", + "description": "Status of the shield information report.", "type": "string", "example": "pending", "enum": [ @@ -35217,16 +35217,16 @@ ] }, "ShieldInformationBarrierReport--Base": { - "description": "A base representation of a\nshield information barrier report object", + "description": "A base representation of a\nshield information barrier report object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier report", + "description": "The unique identifier for the shield information barrier report.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier report", + "description": "The type of the shield information barrier report.", "type": "string", "example": "shield_information_barrier_report", "enum": [ @@ -35251,7 +35251,7 @@ "type": "object", "properties": { "folder_id": { - "description": "Folder ID for locating this report", + "description": "Folder ID for locating this report.", "type": "string", "example": "124235" } @@ -35268,7 +35268,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35301,16 +35301,16 @@ "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierSegment": { - "description": "A shield information barrier segment object", + "description": "A shield information barrier segment object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the shield information barrier segment", + "description": "The unique identifier for the shield information barrier segment.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier segment", + "description": "The type of the shield information barrier segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35321,12 +35321,12 @@ "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "name": { - "description": "Name of the shield information barrier segment", + "description": "Name of the shield information barrier segment.", "type": "string", "example": "Investment Banking" }, "description": { - "description": "Description of the shield information barrier segment", + "description": "Description of the shield information barrier segment.", "type": "string", "example": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'" }, @@ -35368,7 +35368,7 @@ "x-box-tag": "shield_information_barrier_segments" }, "ShieldInformationBarrierSegmentMember": { - "description": "A standard representation of a\nshield information barrier segment member object", + "description": "A standard representation of a\nshield information barrier segment member object.", "type": "object", "allOf": [ { @@ -35389,7 +35389,7 @@ "example": "432554" }, "type": { - "description": "The type of the shield information barrier segment", + "description": "The type of the shield information barrier segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35454,16 +35454,16 @@ ] }, "ShieldInformationBarrierSegmentMember--Base": { - "description": "A base representation of a\nshield information barrier segment member object", + "description": "A base representation of a\nshield information barrier segment member object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for the\nshield information barrier segment member", + "description": "The unique identifier for the\nshield information barrier segment member.", "type": "string", "example": "11446498" }, "type": { - "description": "The type of the shield information barrier segment member", + "description": "The type of the shield information barrier segment member.", "type": "string", "example": "shield_information_barrier_segment_member", "enum": [ @@ -35482,7 +35482,7 @@ ] }, "ShieldInformationBarrierSegmentMember--Mini": { - "description": "A mini representation of a\nshield information barrier segment member object", + "description": "A mini representation of a\nshield information barrier segment member object.", "type": "object", "allOf": [ { @@ -35514,12 +35514,12 @@ ] }, "ShieldInformationBarrierSegmentMembers": { - "description": "List of Shield Information Barrier Member objects", + "description": "List of Shield Information Barrier Member objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35538,7 +35538,7 @@ { "properties": { "entries": { - "description": "A list of shield information\nbarrier segment members", + "description": "A list of shield information\nbarrier segment members.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember" @@ -35552,7 +35552,7 @@ "x-box-tag": "shield_information_barrier_segment_members" }, "ShieldInformationBarrierSegmentRestriction": { - "description": "A standard representation of a\nsegment restriction of a shield information barrier\nobject", + "description": "A standard representation of a\nsegment restriction of a shield information barrier\nobject.", "type": "object", "allOf": [ { @@ -35613,11 +35613,11 @@ ] }, "ShieldInformationBarrierSegmentRestriction--Base": { - "description": "A base representation of\na segment restriction object for\nthe shield information barrier", + "description": "A base representation of\na segment restriction object for\nthe shield information barrier.", "type": "object", "properties": { "type": { - "description": "Shield information barrier segment restriction", + "description": "Shield information barrier segment restriction.", "type": "string", "example": "shield_information_barrier_segment_restriction", "enum": [ @@ -35645,7 +35645,7 @@ ] }, "ShieldInformationBarrierSegmentRestriction--Mini": { - "description": "A mini representation of\na segment restriction object for\nthe shield information barrier", + "description": "A mini representation of\na segment restriction object for\nthe shield information barrier.", "type": "object", "allOf": [ { @@ -35663,7 +35663,7 @@ "example": "1910967" }, "type": { - "description": "The type of the shield information barrier segment", + "description": "The type of the shield information barrier segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35682,7 +35682,7 @@ "example": "1910967" }, "type": { - "description": "The type of the shield information segment", + "description": "The type of the shield information segment.", "type": "string", "example": "shield_information_barrier_segment", "enum": [ @@ -35709,12 +35709,12 @@ ] }, "ShieldInformationBarrierSegmentRestrictions": { - "description": "List of shield information barrier segment restriction objects", + "description": "List of shield information barrier segment restriction objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35733,7 +35733,7 @@ { "properties": { "entries": { - "description": "A list of shield information barrier\nsegment restriction objects", + "description": "A list of shield information barrier\nsegment restriction objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction" @@ -35747,12 +35747,12 @@ "x-box-tag": "shield_information_barrier_segment_restrictions" }, "ShieldInformationBarrierSegments": { - "description": "List of Shield Information Barrier Segment objects", + "description": "List of Shield Information Barrier Segment objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35771,7 +35771,7 @@ { "properties": { "entries": { - "description": "A list of shield information barrier\nsegments", + "description": "A list of shield information barrier\nsegments.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegment" @@ -35785,12 +35785,12 @@ "x-box-tag": "shield_information_barrier_segments" }, "ShieldInformationBarriers": { - "description": "List of Shield Information Barrier objects", + "description": "List of Shield Information Barrier objects.", "type": "object", "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -35809,7 +35809,7 @@ { "properties": { "entries": { - "description": "A list of shield information barrier objects", + "description": "A list of shield information barrier objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrier" @@ -35832,7 +35832,7 @@ { "properties": { "type": { - "description": "object type", + "description": "The value will always be `sign-request`.", "type": "string", "example": "sign-request", "enum": [ @@ -35935,7 +35935,7 @@ "nullable": false }, "collaborator_level": { - "description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\"", + "description": "The collaborator level of the user to the sign request. Values can include \"owner\", \"editor\", and \"viewer\".", "type": "string", "example": "owner", "nullable": true @@ -36075,7 +36075,7 @@ "nullable": true }, "signature_color": { - "description": "Force a specific color for the signature (blue, black, or red)", + "description": "Force a specific color for the signature (blue, black, or red).", "type": "string", "example": "blue", "enum": [ @@ -36137,7 +36137,7 @@ "example": true }, "order": { - "description": "Order of the signer", + "description": "Order of the signer.", "type": "integer", "example": 2, "minimum": 0 @@ -36186,7 +36186,7 @@ "nullable": true }, "suppress_notifications": { - "description": "If true, no emails about the sign request will be sent", + "description": "If true, no emails about the sign request will be sent.", "type": "boolean", "example": false, "nullable": true @@ -36205,19 +36205,19 @@ "nullable": true }, "text_value": { - "description": "Text prefill value", + "description": "Text prefill value.", "type": "string", "example": "text", "nullable": true }, "checkbox_value": { - "description": "Checkbox prefill value", + "description": "Checkbox prefill value.", "type": "boolean", "example": true, "nullable": true }, "date_value": { - "description": "Date prefill value", + "description": "Date prefill value.", "type": "string", "format": "date", "example": "2021-04-26", @@ -36236,7 +36236,7 @@ { "properties": { "has_viewed_document": { - "description": "Set to `true` if the signer views the document", + "description": "Set to `true` if the signer views the document.", "type": "boolean", "example": true, "readOnly": true @@ -36277,7 +36277,7 @@ "readOnly": true }, "embed_url": { - "description": "URL to direct a signer to for signing", + "description": "URL to direct a signer to for signing.", "type": "string", "example": "https://example.com", "nullable": true, @@ -36298,7 +36298,7 @@ "title": "Signer fields for Box Sign request response" }, "SignRequestSignerInput": { - "description": "Input created by a Signer on a Sign Request", + "description": "Input created by a Signer on a Sign Request.", "type": "object", "allOf": [ { @@ -36307,7 +36307,7 @@ { "properties": { "type": { - "description": "Type of input", + "description": "Type of input.", "type": "string", "example": "text", "enum": [ @@ -36320,7 +36320,7 @@ ] }, "content_type": { - "description": "Content type of input", + "description": "Content type of input.", "type": "string", "example": "signature", "enum": [ @@ -36342,12 +36342,12 @@ ] }, "page_index": { - "description": "Index of page that the input is on", + "description": "Index of page that the input is on.", "type": "integer", "example": 4 }, "read_only": { - "description": "Whether this input was defined as read-only(immutable by signers) or not", + "description": "Whether this input was defined as read-only(immutable by signers) or not.", "type": "boolean", "example": true } @@ -36365,7 +36365,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -36398,13 +36398,13 @@ "x-box-tag": "sign_requests" }, "SignTemplate": { - "description": "A Box Sign template object", + "description": "A Box Sign template object.", "type": "object", "allOf": [ { "properties": { "type": { - "description": "object type", + "description": "The value will always be `sign-template`.", "type": "string", "example": "sign-template", "enum": [ @@ -36423,19 +36423,19 @@ "nullable": true }, "email_subject": { - "description": "Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.", + "description": "Subject of signature request email. This is cleaned by sign\nrequest. If this field is not passed, a default subject will be used.", "type": "string", "example": "Sign Request from Acme", "nullable": true }, "email_message": { - "description": "Message to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.", + "description": "Message to include in signature request email. The field\nis cleaned through sanitization of specific characters. However,\nsome html tags are allowed. Links included in the\nmessage are also converted to hyperlinks in the email. The\nmessage may contain the following html tags including `a`, `abbr`,\n`acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and\n`strong`. Be aware that when the text\nto html ratio is too high, the email\nmay end up in spam filters. Custom styles on\nthese tags are not allowed.\nIf this field is not passed, a default message will be used.", "type": "string", "example": "Hello! Please sign the document below", "nullable": true }, "days_valid": { - "description": "Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.", + "description": "Set the number of days after which the\ncreated signature request will automatically\nexpire if not completed. By default, we do\nnot apply any expiration date on signature\nrequests, and the signature request does not expire.", "type": "integer", "example": 2, "maximum": 730, @@ -36453,19 +36453,19 @@ ] }, "source_files": { - "description": "List of files to create a signing document from. Only the ID and type fields are required for each file.", + "description": "List of files to create a signing document from.\nOnly the ID and type fields are required\nfor each file.", "type": "array", "items": { "$ref": "#/components/schemas/File--Mini" } }, "are_fields_locked": { - "description": "Indicates if the template input fields are editable or not.", + "description": "Indicates if the template input\nfields are editable or not.", "type": "boolean", "example": false }, "are_options_locked": { - "description": "Indicates if the template document options are editable or not, for example renaming the document.", + "description": "Indicates if the template document options\nare editable or not,\nfor example renaming the document.", "type": "boolean", "example": true }, @@ -36480,7 +36480,7 @@ "example": true }, "are_files_locked": { - "description": "Indicates if the template files are editable or not. This includes deleting or renaming template files.", + "description": "Indicates if the template files are editable or not.\nThis includes deleting or renaming template files.", "type": "boolean", "example": true }, @@ -36492,7 +36492,7 @@ } }, "additional_info": { - "description": "Additional information on which fields are required and which fields are not editable.", + "description": "Additional information on which fields are\nrequired and which fields are not editable.", "type": "object", "properties": { "non_editable": { @@ -36547,7 +36547,7 @@ } }, "ready_sign_link": { - "description": "Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.", + "description": "Box's ready-sign link feature enables you to create a\nlink to a signature request that\nyou've created from a template. Use this link\nwhen you want to post a signature request\non a public form — such as an email, social media post,\nor web page — without knowing who the signers will be.\nNote: The ready-sign link feature is\nlimited to Enterprise Plus customers and not\navailable to Box Verified Enterprises.", "type": "object", "nullable": true, "properties": { @@ -36592,7 +36592,7 @@ "nullable": true, "properties": { "company_name": { - "description": "Name of the company", + "description": "Name of the company.", "type": "string", "example": "Corporation inc.", "nullable": true @@ -36630,7 +36630,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -36673,29 +36673,29 @@ "type": "object", "properties": { "$canEdit": { - "description": "Whether the user can edit this metadata", + "description": "Whether the user can edit this metadata.", "type": "boolean", "example": true }, "$id": { - "description": "A UUID to identify the metadata object", + "description": "A UUID to identify the metadata object.", "type": "string", "format": "uuid", "example": "01234500-12f1-1234-aa12-b1d234cb567e", "maxLength": 36 }, "$parent": { - "description": "An ID for the parent folder", + "description": "An ID for the parent folder.", "type": "string", "example": "folder_59449484661," }, "$scope": { - "description": "An ID for the scope in which this template\nhas been applied", + "description": "An ID for the scope in which this template\nhas been applied.", "type": "string", "example": "enterprise_27335" }, "$template": { - "description": "The name of the template", + "description": "The name of the template.", "type": "string", "example": "properties" }, @@ -36744,7 +36744,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -36761,15 +36761,15 @@ { "title": "Skill", "type": "object", - "description": "An object representing a skill", + "description": "An object representing a skill.", "properties": { "id": { - "description": "The unique identifier for this skill", + "description": "The unique identifier for this skill.", "type": "string", "example": "11446498" }, "type": { - "description": "`skill`", + "description": "The value will always be `skill`.", "type": "string", "example": "skill", "enum": [ @@ -36777,28 +36777,28 @@ ] }, "name": { - "description": "The name of the skill", + "description": "The name of the skill.", "type": "string", "example": "Hello World Skill" }, "api_key": { - "description": "The client ID of the application", + "description": "The client ID of the application.", "type": "string", "example": "hxel2s12wd2h9r8ne103c4gjbqefofih" } } }, { - "description": "The skill that triggered this invocation" + "description": "The skill that triggered this invocation." } ] }, "token": { - "description": "The read-only and read-write access tokens for this item", + "description": "The read-only and read-write access tokens for this item.", "type": "object", "properties": { "read": { - "description": "The basics of an access token", + "description": "The basics of an access token.", "type": "object", "properties": { "access_token": { @@ -36829,7 +36829,7 @@ } }, "write": { - "description": "The basics of an access token", + "description": "The basics of an access token.", "type": "object", "properties": { "access_token": { @@ -36878,7 +36878,7 @@ ] }, "message": { - "description": "Status information", + "description": "Status information.", "type": "string", "example": "Example" }, @@ -36901,7 +36901,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "trigger": { - "description": "Action that triggered the invocation", + "description": "Action that triggered the invocation.", "type": "string", "example": "FILE_CONTENT" }, @@ -36910,7 +36910,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -36918,7 +36918,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -36926,14 +36926,14 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise that this invocation was triggered for" + "description": "The enterprise that this invocation was triggered for." } ] }, @@ -36950,7 +36950,7 @@ ] }, { - "description": "The item that caused the invocation to trigger" + "description": "The item that caused the invocation to trigger." } ] }, @@ -36960,7 +36960,7 @@ "$ref": "#/components/schemas/Event" }, { - "description": "The event that triggered this invocation" + "description": "The event that triggered this invocation." } ] } @@ -36980,7 +36980,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -36988,7 +36988,7 @@ ] }, "skill_card_type": { - "description": "`status`", + "description": "The value will always be `status`.", "type": "string", "example": "status", "enum": [ @@ -37045,7 +37045,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -37068,7 +37068,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -37104,7 +37104,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -37129,7 +37129,7 @@ { "properties": { "entries": { - "description": "A list of storage policies", + "description": "A list of storage policies.", "type": "array", "items": { "$ref": "#/components/schemas/StoragePolicy" @@ -37152,7 +37152,7 @@ { "properties": { "name": { - "description": "A descriptive name of the region", + "description": "A descriptive name of the region.", "type": "string", "example": "Montreal / Dublin" } @@ -37164,16 +37164,16 @@ "x-box-variant": "standard" }, "StoragePolicy--Mini": { - "description": "A mini description of a Storage Policy object", + "description": "A mini description of a Storage Policy object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this storage policy", + "description": "The unique identifier for this storage policy.", "type": "string", "example": "11446498" }, "type": { - "description": "`storage_policy`", + "description": "The value will always be `storage_policy`.", "type": "string", "example": "storage_policy", "enum": [ @@ -37195,7 +37195,7 @@ ] }, "StoragePolicyAssignment": { - "description": "The assignment of a storage policy to a user or enterprise", + "description": "The assignment of a storage policy to a user or enterprise.", "type": "object", "properties": { "id": { @@ -37204,7 +37204,7 @@ "example": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw" }, "type": { - "description": "`storage_policy_assignment`", + "description": "The value will always be `storage_policy_assignment`.", "type": "string", "example": "storage_policy_assignment", "enum": [ @@ -37217,7 +37217,7 @@ "$ref": "#/components/schemas/StoragePolicy--Mini" }, { - "description": "The assigned storage policy" + "description": "The assigned storage policy." } ] }, @@ -37225,23 +37225,23 @@ "allOf": [ { "title": "Reference", - "description": "The bare basic reference for an object", + "description": "The bare basic reference for an object.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this object", + "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { - "description": "The type for this object", + "description": "The type for this object.", "type": "string", "example": "file" } } }, { - "description": "The enterprise or use the policy is assigned to" + "description": "The enterprise or use the policy is assigned to." } ] } @@ -37260,7 +37260,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -37285,7 +37285,7 @@ { "properties": { "entries": { - "description": "A list of storage policy assignments", + "description": "A list of storage policy assignments.", "type": "array", "items": { "$ref": "#/components/schemas/StoragePolicyAssignment" @@ -37303,12 +37303,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this task", + "description": "The unique identifier for this task.", "type": "string", "example": "11446498" }, "type": { - "description": "`task`", + "description": "The value will always be `task`.", "type": "string", "example": "task", "enum": [ @@ -37321,12 +37321,12 @@ "$ref": "#/components/schemas/File--Mini" }, { - "description": "The file associated with the task" + "description": "The file associated with the task." } ] }, "due_at": { - "description": "When the task is due", + "description": "When the task is due.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37341,7 +37341,7 @@ ] }, "message": { - "description": "A message that will be included with the task", + "description": "A message that will be included with the task.", "type": "string", "example": "Legal review" }, @@ -37351,12 +37351,12 @@ "$ref": "#/components/schemas/TaskAssignments" }, { - "description": "A collection of task assignment objects\nassociated with the task" + "description": "A collection of task assignment objects\nassociated with the task." } ] }, "is_completed": { - "description": "Whether the task has been completed", + "description": "Whether the task has been completed.", "type": "boolean", "example": true }, @@ -37366,12 +37366,12 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the task" + "description": "The user who created the task." } ] }, "created_at": { - "description": "When the task object was created", + "description": "When the task object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37395,12 +37395,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this task assignment", + "description": "The unique identifier for this task assignment.", "type": "string", "example": "11446498" }, "type": { - "description": "`task_assignment`", + "description": "The value will always be `task_assignment`.", "type": "string", "example": "task_assignment", "enum": [ @@ -37477,7 +37477,7 @@ "x-box-tag": "task_assignments" }, "TaskAssignments": { - "description": "A list of task assignments", + "description": "A list of task assignments.", "type": "object", "properties": { "total_count": { @@ -37487,7 +37487,7 @@ "example": 100 }, "entries": { - "description": "A list of task assignments", + "description": "A list of task assignments.", "type": "array", "items": { "$ref": "#/components/schemas/TaskAssignment" @@ -37499,7 +37499,7 @@ "x-box-tag": "task_assignments" }, "Tasks": { - "description": "A list of tasks", + "description": "A list of tasks.", "type": "object", "properties": { "total_count": { @@ -37509,7 +37509,7 @@ "example": 5000 }, "entries": { - "description": "A list of tasks", + "description": "A list of tasks.", "type": "array", "items": { "$ref": "#/components/schemas/Task" @@ -37521,7 +37521,7 @@ "x-box-tag": "tasks" }, "TemplateSigner": { - "description": "The schema for a Signer for Templates", + "description": "The schema for a Signer for Templates.", "type": "object", "properties": { "inputs": { @@ -37532,7 +37532,7 @@ "readOnly": true }, "email": { - "description": "Email address of the signer", + "description": "Email address of the signer.", "type": "string", "example": "example@mail.com", "nullable": true @@ -37554,7 +37554,7 @@ "example": true }, "order": { - "description": "Order of the signer", + "description": "Order of the signer.", "type": "integer", "example": 2, "minimum": 0 @@ -37598,7 +37598,7 @@ "title": "Signer fields for Templates" }, "TemplateSignerInput": { - "description": "Input created by a Signer on a Template", + "description": "Input created by a Signer on a Template.", "type": "object", "allOf": [ { @@ -37607,7 +37607,7 @@ { "properties": { "type": { - "description": "Type of input", + "description": "Type of input.", "type": "string", "example": "text", "enum": [ @@ -37621,7 +37621,7 @@ ] }, "content_type": { - "description": "Content type of input", + "description": "Content type of input.", "type": "string", "example": "text", "enum": [ @@ -37659,7 +37659,7 @@ "nullable": true }, "dropdown_choices": { - "description": "When the input is of the type `dropdown` this values will be filled with all the dropdown options.", + "description": "When the input is of the type `dropdown` this\nvalues will be filled with all the\ndropdown options.", "type": "array", "items": { "type": "string" @@ -37672,7 +37672,7 @@ "nullable": true }, "group_id": { - "description": "When the input is of type `radio` they can be grouped to gather with this identifier.", + "description": "When the input is of type `radio` they can be\ngrouped to gather with this identifier.", "type": "string", "example": "da317330-225a-4c72-89ad-0d6dcaaf4df6", "nullable": true @@ -37716,7 +37716,7 @@ "nullable": true }, "read_only": { - "description": "Whether this input was defined as read-only(immutable by signers) or not", + "description": "Whether this input was defined as read-only(immutable by signers) or not.", "type": "boolean", "example": true } @@ -37738,7 +37738,7 @@ { "properties": { "status": { - "description": "Whether these terms are enabled or not", + "description": "Whether these terms are enabled or not.", "type": "string", "example": "enabled", "enum": [ @@ -37751,7 +37751,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -37759,7 +37759,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -37767,19 +37767,19 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "The enterprise these terms apply to" + "description": "The enterprise these terms apply to." } ] }, "tos_type": { - "description": "Whether to apply these terms to managed users or external users", + "description": "Whether to apply these terms to managed users or external users.", "type": "string", "example": "managed", "enum": [ @@ -37793,7 +37793,7 @@ "example": "By using this service, you agree to ..." }, "created_at": { - "description": "When the legal item was created", + "description": "When the legal item was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37821,7 +37821,7 @@ "example": "11446498" }, "type": { - "description": "`terms_of_service`", + "description": "The value will always be `terms_of_service`.", "type": "string", "example": "terms_of_service", "enum": [ @@ -37843,16 +37843,16 @@ ] }, "TermsOfServiceUserStatus": { - "description": "The association between a Terms of Service and a user", + "description": "The association between a Terms of Service and a user.", "type": "object", "properties": { "id": { - "description": "The unique identifier for this terms of service user status", + "description": "The unique identifier for this terms of service user status.", "type": "string", "example": "11446498" }, "type": { - "description": "`terms_of_service_user_status`", + "description": "The value will always be `terms_of_service_user_status`.", "type": "string", "example": "terms_of_service_user_status", "enum": [ @@ -37865,7 +37865,7 @@ "$ref": "#/components/schemas/TermsOfService--Base" }, { - "description": "The terms of service" + "description": "The terms of service." } ] }, @@ -37875,17 +37875,17 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user" + "description": "The user." } ] }, "is_accepted": { - "description": "If the user has accepted the terms of services", + "description": "If the user has accepted the terms of services.", "type": "boolean", "example": true }, "created_at": { - "description": "When the legal item was created", + "description": "When the legal item was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -37906,7 +37906,7 @@ "x-box-tag": "terms_of_service_user_statuses" }, "TermsOfServiceUserStatuses": { - "description": "A list of terms of service user statuses", + "description": "A list of terms of service user statuses.", "type": "object", "properties": { "total_count": { @@ -37916,7 +37916,7 @@ "example": 2 }, "entries": { - "description": "A list of terms of service user statuses", + "description": "A list of terms of service user statuses.", "type": "array", "items": { "$ref": "#/components/schemas/TermsOfServiceUserStatus" @@ -37928,7 +37928,7 @@ "x-box-tag": "terms_of_service_user_statuses" }, "TermsOfServices": { - "description": "A list of terms of services", + "description": "A list of terms of services.", "type": "object", "properties": { "total_count": { @@ -37938,7 +37938,7 @@ "example": 2 }, "entries": { - "description": "A list of terms of service objects", + "description": "A list of terms of service objects.", "type": "array", "items": { "$ref": "#/components/schemas/TermsOfService" @@ -37960,7 +37960,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -37968,7 +37968,7 @@ ] }, "skill_card_type": { - "description": "`timeline`", + "description": "The value will always be `timeline`.", "type": "string", "example": "timeline", "enum": [ @@ -37999,7 +37999,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -38022,7 +38022,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -38106,7 +38106,7 @@ "type": "object", "properties": { "type": { - "description": "`tracking_code`", + "description": "The value will always be `tracking_code`.", "type": "string", "example": "tracking_code", "enum": [ @@ -38114,12 +38114,12 @@ ] }, "name": { - "description": "The name of the tracking code, which must be preconfigured in\nthe Admin Console", + "description": "The name of the tracking code, which must be preconfigured in\nthe Admin Console.", "type": "string", "example": "department" }, "value": { - "description": "The value of the tracking code", + "description": "The value of the tracking code.", "type": "string", "example": "Sales" } @@ -38137,7 +38137,7 @@ "example": "2018-04-13T13:53:23-07:00" }, "type": { - "description": "`skill_card`", + "description": "The value will always be `skill_card`.", "type": "string", "example": "skill_card", "enum": [ @@ -38145,7 +38145,7 @@ ] }, "skill_card_type": { - "description": "`transcript`", + "description": "The value will always be `transcript`.", "type": "string", "example": "transcript", "enum": [ @@ -38176,7 +38176,7 @@ "type": "object", "properties": { "type": { - "description": "`service`", + "description": "The value will always be `service`.", "type": "string", "example": "service", "enum": [ @@ -38199,7 +38199,7 @@ "type": "object", "properties": { "type": { - "description": "`skill_invocation`", + "description": "The value will always be `skill_invocation`.", "type": "string", "example": "skill_invocation", "enum": [ @@ -38227,7 +38227,7 @@ "type": "array", "items": { "type": "object", - "description": "An entry in the `entries` attribute of a metadata card", + "description": "An entry in the `entries` attribute of a metadata card.", "properties": { "text": { "description": "The text of the entry. This would be the transcribed text assigned\nto the entry on the timeline.", @@ -38263,7 +38263,7 @@ "invocation", "entries" ], - "title": "Transcript Skill Card", + "title": "Transcript Skill Card.", "x-box-resource-id": "transcript_skill_card", "x-box-tag": "skills" }, @@ -38284,7 +38284,7 @@ "nullable": true }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -38306,7 +38306,7 @@ ] }, "name": { - "description": "The name of the file", + "description": "The name of the file.", "type": "string", "example": "Contract.pdf" }, @@ -38328,7 +38328,7 @@ ] }, "description": { - "description": "The optional description of this file", + "description": "The optional description of this file.", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 256, @@ -38359,14 +38359,14 @@ "nullable": false }, "entries": { - "description": "Array of folders for this item's path collection", + "description": "Array of folders for this item's path collection.", "type": "array", "items": { "type": "object", - "description": "The parent folder for this item", + "description": "The parent folder for this item.", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -38379,13 +38379,13 @@ "example": "123456789" }, "sequence_id": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true }, "etag": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true @@ -38457,7 +38457,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this file" + "description": "The user who created this file." } ] }, @@ -38467,7 +38467,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this file" + "description": "The user who last modified this file." }, { "nullable": false @@ -38480,7 +38480,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this file" + "description": "The user who owns this file." }, { "nullable": false @@ -38553,7 +38553,7 @@ "nullable": true }, "type": { - "description": "`file`", + "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ @@ -38575,7 +38575,7 @@ ] }, "name": { - "description": "The name of the file", + "description": "The name of the file.", "type": "string", "example": "Contract.pdf" }, @@ -38597,7 +38597,7 @@ ] }, "description": { - "description": "The optional description of this file", + "description": "The optional description of this file.", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 256, @@ -38628,7 +38628,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -38691,7 +38691,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this file" + "description": "The user who created this file." } ] }, @@ -38701,7 +38701,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this file" + "description": "The user who last modified this file." }, { "nullable": false @@ -38714,7 +38714,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this file" + "description": "The user who owns this file." }, { "nullable": false @@ -38787,7 +38787,7 @@ "nullable": true }, "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -38832,7 +38832,7 @@ "allOf": [ { "type": "string", - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false @@ -38868,14 +38868,14 @@ "nullable": false }, "entries": { - "description": "Array of folders for this item's path collection", + "description": "Array of folders for this item's path collection.", "type": "array", "items": { "type": "object", - "description": "The parent folder for this item", + "description": "The parent folder for this item.", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -38888,13 +38888,13 @@ "example": "123456789" }, "sequence_id": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true }, "etag": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true @@ -38924,7 +38924,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this folder" + "description": "The user who created this folder." }, { "nullable": false @@ -39055,7 +39055,7 @@ "nullable": true }, "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -39100,7 +39100,7 @@ "allOf": [ { "type": "string", - "description": "The optional description of this folder", + "description": "The optional description of this folder.", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false @@ -39136,7 +39136,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -39159,7 +39159,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this folder" + "description": "The user who created this folder." }, { "nullable": false @@ -39244,7 +39244,7 @@ ] }, "item_status": { - "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash\n* `trashed` when the item has been moved to the trash but not deleted\n* `deleted` when the item has been permanently deleted.", + "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash,\n* `trashed` when the item has been moved to the trash but not deleted,\n* `deleted` when the item has been permanently deleted.", "type": "string", "example": "active", "enum": [ @@ -39264,7 +39264,7 @@ "type": "object", "properties": { "type": { - "description": "`web_link`", + "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ @@ -39272,7 +39272,7 @@ ] }, "id": { - "description": "The unique identifier for this web link", + "description": "The unique identifier for this web link.", "type": "string", "example": "11446498" }, @@ -39295,12 +39295,12 @@ "example": "1" }, "name": { - "description": "The name of the web link", + "description": "The name of the web link.", "type": "string", "example": "My Bookmark" }, "url": { - "description": "The URL this web link points to", + "description": "The URL this web link points to.", "type": "string", "example": "https://www.example.com/example/1234" }, @@ -39310,7 +39310,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The parent object the web link belongs to" + "description": "The parent object the web link belongs to." } ] }, @@ -39338,14 +39338,14 @@ "nullable": false }, "entries": { - "description": "Array of folders for this item's path collection", + "description": "Array of folders for this item's path collection.", "type": "array", "items": { "type": "object", - "description": "The parent folder for this item", + "description": "The parent folder for this item.", "properties": { "type": { - "description": "`folder`", + "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ @@ -39358,13 +39358,13 @@ "example": "123456789" }, "sequence_id": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true }, "etag": { - "description": "This field is null for the Trash folder", + "description": "This field is null for the Trash folder.", "type": "string", "example": null, "nullable": true @@ -39420,7 +39420,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this web link" + "description": "The user who created this web link." } ] }, @@ -39430,7 +39430,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this web link" + "description": "The user who last modified this web link." } ] }, @@ -39440,7 +39440,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this web link" + "description": "The user who owns this web link." } ] }, @@ -39451,7 +39451,7 @@ "nullable": true }, "item_status": { - "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted", + "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.", "type": "string", "example": "trashed", "enum": [ @@ -39470,7 +39470,7 @@ "type": "object", "properties": { "type": { - "description": "`web_link`", + "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ @@ -39478,7 +39478,7 @@ ] }, "id": { - "description": "The unique identifier for this web link", + "description": "The unique identifier for this web link.", "type": "string", "example": "11446498" }, @@ -39501,12 +39501,12 @@ "example": "1" }, "name": { - "description": "The name of the web link", + "description": "The name of the web link.", "type": "string", "example": "My Bookmark" }, "url": { - "description": "The URL this web link points to", + "description": "The URL this web link points to.", "type": "string", "example": "https://www.example.com/example/1234" }, @@ -39516,7 +39516,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The parent object the web link belongs to" + "description": "The parent object the web link belongs to." } ] }, @@ -39544,7 +39544,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -39591,7 +39591,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this web link" + "description": "The user who created this web link." } ] }, @@ -39601,7 +39601,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this web link" + "description": "The user who last modified this web link." } ] }, @@ -39611,7 +39611,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this web link" + "description": "The user who owns this web link." } ] }, @@ -39622,7 +39622,7 @@ "nullable": true }, "item_status": { - "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted", + "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.", "type": "string", "example": "trashed", "enum": [ @@ -39698,7 +39698,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -39723,15 +39723,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -39747,7 +39747,7 @@ { "properties": { "entries": { - "description": "A list of uploaded chunks for an upload\nsession", + "description": "A list of uploaded chunks for an upload\nsession.", "type": "array", "items": { "$ref": "#/components/schemas/UploadPart" @@ -39765,12 +39765,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this session", + "description": "The unique identifier for this session.", "type": "string", "example": "F971964745A5CD0C001BBE4E58196BFD" }, "type": { - "description": "`upload_session`", + "description": "The value will always be `upload_session`.", "type": "string", "example": "upload_session", "enum": [ @@ -39809,12 +39809,12 @@ "type": "object", "properties": { "upload_part": { - "description": "The URL to upload parts to", + "description": "The URL to upload parts to.", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" }, "commit": { - "description": "The URL used to commit the file", + "description": "The URL used to commit the file.", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit" }, @@ -39860,7 +39860,7 @@ "example": "https://upload-las.app.box.com/api/2.0/files/content?upload_session_id=1234" }, "upload_token": { - "description": "An optional access token to use to upload the file", + "description": "An optional access token to use to upload the file.", "type": "string", "example": "Pc3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQP" } @@ -39882,7 +39882,7 @@ "x-box-tag": "chunked_uploads" }, "User": { - "description": "A standard representation of a user, as returned from any\nuser API endpoints by default", + "description": "A standard representation of a user, as returned from any\nuser API endpoints by default.", "type": "object", "allOf": [ { @@ -39891,13 +39891,13 @@ { "properties": { "created_at": { - "description": "When the user object was created", + "description": "When the user object was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When the user object was last modified", + "description": "When the user object was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -39908,31 +39908,31 @@ "example": "en" }, "timezone": { - "description": "The user's timezone", + "description": "The user's timezone.", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "space_amount": { - "description": "The user’s total available space amount in bytes", + "description": "The user’s total available space amount in bytes.", "type": "integer", "format": "int64", "example": 11345156112 }, "space_used": { - "description": "The amount of space in use by the user", + "description": "The amount of space in use by the user.", "type": "integer", "format": "int64", "example": 1237009912 }, "max_upload_size": { - "description": "The maximum individual file size in bytes the user can have", + "description": "The maximum individual file size in bytes the user can have.", "type": "integer", "format": "int64", "example": 2147483648 }, "status": { - "description": "The user's account status", + "description": "The user's account status.", "type": "string", "example": "active", "enum": [ @@ -39943,25 +39943,25 @@ ] }, "job_title": { - "description": "The user’s job title", + "description": "The user’s job title.", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { - "description": "The user’s phone number", + "description": "The user’s phone number.", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { - "description": "The user’s address", + "description": "The user’s address.", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 }, "avatar_url": { - "description": "URL of the user’s avatar image", + "description": "URL of the user’s avatar image.", "type": "string", "example": "https://www.box.com/api/avatar/large/181216415" }, @@ -39994,12 +39994,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this user", + "description": "The unique identifier for this user.", "type": "string", "example": "11446498" }, "type": { - "description": "`user`", + "description": "The value will always be `user`.", "type": "string", "example": "user", "enum": [ @@ -40067,7 +40067,7 @@ { "properties": { "role": { - "description": "The user’s enterprise role", + "description": "The user’s enterprise role.", "type": "string", "example": "admin", "enum": [ @@ -40084,27 +40084,27 @@ } }, "can_see_managed_users": { - "description": "Whether the user can see other enterprise users in their contact list", + "description": "Whether the user can see other enterprise users in their contact list.", "type": "boolean", "example": true }, "is_sync_enabled": { - "description": "Whether the user can use Box Sync", + "description": "Whether the user can use Box Sync.", "type": "boolean", "example": true }, "is_external_collab_restricted": { - "description": "Whether the user is allowed to collaborate with users outside their\nenterprise", + "description": "Whether the user is allowed to collaborate with users outside their\nenterprise.", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { - "description": "Whether to exempt the user from Enterprise device limits", + "description": "Whether to exempt the user from Enterprise device limits.", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { - "description": "Whether the user must use two-factor authentication", + "description": "Whether the user must use two-factor authentication.", "type": "boolean", "example": true }, @@ -40113,7 +40113,7 @@ { "title": "Enterprise", "type": "object", - "description": "A representation of a Box enterprise", + "description": "A representation of a Box enterprise.", "properties": { "id": { "description": "The unique identifier for this enterprise.", @@ -40121,7 +40121,7 @@ "example": "11446498" }, "type": { - "description": "`enterprise`", + "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ @@ -40129,14 +40129,14 @@ ] }, "name": { - "description": "The name of the enterprise", + "description": "The name of the enterprise.", "type": "string", "example": "Acme Inc." } } }, { - "description": "Representation of the user’s enterprise" + "description": "Representation of the user’s enterprise." } ] }, @@ -40151,12 +40151,12 @@ ] }, "hostname": { - "description": "The root (protocol, subdomain, domain) of any links that need to be\ngenerated for the user", + "description": "The root (protocol, subdomain, domain) of any links that need to be\ngenerated for the user.", "type": "string", "example": "https://example.app.box.com/" }, "is_platform_access_only": { - "description": "Whether the user is an App User", + "description": "Whether the user is an App User.", "type": "boolean", "example": true }, @@ -40182,14 +40182,14 @@ { "properties": { "name": { - "description": "The display name of this user", + "description": "The display name of this user.", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { - "description": "The primary email address of this user", + "description": "The primary email address of this user.", "type": "string", "format": "email", "example": "ceo@example.com", @@ -40242,14 +40242,14 @@ { "properties": { "name": { - "description": "The display name of this user", + "description": "The display name of this user.", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { - "description": "The primary email address of this user", + "description": "The primary email address of this user.", "type": "string", "format": "email", "example": "ceo@example.com", @@ -40268,7 +40268,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -40292,7 +40292,7 @@ }, { "type": "object", - "description": "The part of an API response that describes pagination", + "description": "The part of an API response that describes pagination.", "properties": { "total_count": { "description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.", @@ -40317,15 +40317,15 @@ "type": "array", "items": { "type": "object", - "description": "The order in which a pagination is ordered", + "description": "The order in which a pagination is ordered.", "properties": { "by": { - "description": "The field to order by", + "description": "The field to order by.", "type": "string", "example": "type" }, "direction": { - "description": "The direction to order by, either ascending or descending", + "description": "The direction to order by, either ascending or descending.", "type": "string", "example": "ASC", "enum": [ @@ -40341,7 +40341,7 @@ { "properties": { "entries": { - "description": "A list of users", + "description": "A list of users.", "type": "array", "items": { "$ref": "#/components/schemas/User--Full" @@ -40355,20 +40355,20 @@ "x-box-tag": "users" }, "Watermark": { - "description": "A watermark is a semi-transparent overlay on an embedded file\npreview that displays a viewer's email address or user ID\nand the time of access over a file's content", + "description": "A watermark is a semi-transparent overlay on an embedded file\npreview that displays a viewer's email address or user ID\nand the time of access over a file's content.", "type": "object", "properties": { "watermark": { "type": "object", "properties": { "created_at": { - "description": "When this watermark was created", + "description": "When this watermark was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "When this task was modified", + "description": "When this task was modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -40395,7 +40395,7 @@ "$ref": "#/components/schemas/Folder--Mini" }, { - "description": "The parent object the web link belongs to" + "description": "The parent object the web link belongs to." } ] }, @@ -40423,7 +40423,7 @@ "nullable": false }, "entries": { - "description": "The parent folders for this item", + "description": "The parent folders for this item.", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" @@ -40472,7 +40472,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created this web link" + "description": "The user who created this web link." } ] }, @@ -40482,7 +40482,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who last modified this web link" + "description": "The user who last modified this web link." } ] }, @@ -40492,7 +40492,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who owns this web link" + "description": "The user who owns this web link." } ] }, @@ -40639,7 +40639,7 @@ ] }, "item_status": { - "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted", + "description": "Whether this item is deleted or not. Values include `active`,\n`trashed` if the file has been moved to the trash, and `deleted` if\nthe file has been permanently deleted.", "type": "string", "example": "active", "enum": [ @@ -40660,12 +40660,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this web link", + "description": "The unique identifier for this web link.", "type": "string", "example": "11446498" }, "type": { - "description": "`web_link`", + "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ @@ -40702,7 +40702,7 @@ { "properties": { "url": { - "description": "The URL this web link points to", + "description": "The URL this web link points to.", "type": "string", "example": "https://www.example.com/example/1234" }, @@ -40720,7 +40720,7 @@ ] }, "name": { - "description": "The name of the web link", + "description": "The name of the web link.", "type": "string", "example": "My Bookmark" } @@ -40746,7 +40746,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user who created the webhook" + "description": "The user who created the webhook." } ] }, @@ -40757,18 +40757,18 @@ "example": "2012-12-12T10:53:43-08:00" }, "address": { - "description": "The URL that is notified by this webhook", + "description": "The URL that is notified by this webhook.", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for", + "description": "An array of event names that this webhook is\nto be triggered for.", "type": "array", "items": { "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -40834,7 +40834,7 @@ "example": "11446498" }, "type": { - "description": "`webhook`", + "description": "The value will always be `webhook`.", "type": "string", "example": "webhook", "enum": [ @@ -40842,16 +40842,16 @@ ] }, "target": { - "description": "The item that will trigger the webhook", + "description": "The item that will trigger the webhook.", "type": "object", "properties": { "id": { - "description": "The ID of the item to trigger a webhook", + "description": "The ID of the item to trigger a webhook.", "type": "string", "example": "1231232" }, "type": { - "description": "The type of item to trigger a webhook", + "description": "The type of item to trigger a webhook.", "type": "string", "example": "file", "enum": [ @@ -40876,12 +40876,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for this webhook invocation", + "description": "The unique identifier for this webhook invocation.", "type": "string", "example": "11446498" }, "type": { - "description": "`webhook_event`", + "description": "The value will always be `webhook_event`.", "type": "string", "example": "webhook_event", "enum": [ @@ -40894,7 +40894,7 @@ "$ref": "#/components/schemas/Webhook" }, { - "description": "The webhook object that triggered this event" + "description": "The webhook object that triggered this event." } ] }, @@ -40904,7 +40904,7 @@ "$ref": "#/components/schemas/User--Mini" }, { - "description": "The user that triggered this event" + "description": "The user that triggered this event." } ] }, @@ -40920,7 +40920,7 @@ "title": "Webhook Trigger", "example": "FILE.UPLOADED", "type": "string", - "description": "The event name that triggered this webhook", + "description": "The event name that triggered this webhook.", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", @@ -40965,7 +40965,7 @@ ] }, { - "description": "The event name that triggered this webhook" + "description": "The event name that triggered this webhook." } ] }, @@ -40982,7 +40982,7 @@ ] }, { - "description": "The item that caused the event to trigger" + "description": "The item that caused the event to trigger." } ] } @@ -40997,7 +40997,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -41022,7 +41022,7 @@ { "properties": { "entries": { - "description": "A list of webhooks", + "description": "A list of webhooks.", "type": "array", "items": { "$ref": "#/components/schemas/Webhook--Mini" @@ -41049,15 +41049,15 @@ "type": "array", "items": { "type": "object", - "description": "A step in a Box Relay Workflow. Each flow contains a `Trigger` and\na collection of Outcomes to perform once the conditions of a\n`Trigger` are met", + "description": "A step in a Box Relay Workflow. Each flow contains a `Trigger` and\na collection of Outcomes to perform once the conditions of a\n`Trigger` are met.", "properties": { "id": { - "description": "The identifier of the flow", + "description": "The identifier of the flow.", "type": "string", "example": "12345" }, "type": { - "description": "The flow's resource type", + "description": "The flow's resource type.", "type": "string", "example": "flow", "enum": [ @@ -41070,7 +41070,7 @@ "type": "object", "properties": { "type": { - "description": "The trigger's resource type", + "description": "The trigger's resource type.", "type": "string", "example": "trigger", "enum": [ @@ -41078,7 +41078,7 @@ ] }, "trigger_type": { - "description": "The type of trigger selected for this flow", + "description": "The type of trigger selected for this flow.", "type": "string", "example": "WORKFLOW_MANUAL_START", "enum": [ @@ -41086,14 +41086,14 @@ ] }, "scope": { - "description": "List of trigger scopes", + "description": "List of trigger scopes.", "type": "array", "items": { "type": "object", - "description": "Object that describes where and how a Trigger condition is met", + "description": "Object that describes where and how a Trigger condition is met.", "properties": { "type": { - "description": "The trigger scope's resource type", + "description": "The trigger scope's resource type.", "type": "string", "example": "trigger_scope", "enum": [ @@ -41101,16 +41101,16 @@ ] }, "ref": { - "description": "Indicates the path of the condition value to check", + "description": "Indicates the path of the condition value to check.", "type": "string", "example": "/event/source/parameters/folder" }, "object": { - "description": "The object the `ref` points to", + "description": "The object the `ref` points to.", "type": "object", "properties": { "type": { - "description": "The type of the object", + "description": "The type of the object.", "type": "string", "example": "folder", "enum": [ @@ -41118,7 +41118,7 @@ ] }, "id": { - "description": "The id of the object", + "description": "The id of the object.", "type": "string", "example": "12345" } @@ -41130,7 +41130,7 @@ } }, { - "description": "Trigger that initiates flow" + "description": "Trigger that initiates flow." } ] }, @@ -41143,12 +41143,12 @@ "description": "List of outcomes to perform once the conditions of trigger are met.", "properties": { "id": { - "description": "The identifier of the outcome", + "description": "The identifier of the outcome.", "type": "string", "example": "12345" }, "type": { - "description": "The outcomes resource type", + "description": "The outcomes resource type.", "type": "string", "example": "outcome", "enum": [ @@ -41156,7 +41156,7 @@ ] }, "name": { - "description": "The name of the outcome", + "description": "The name of the outcome.", "type": "string", "example": "Task Approval Outcome" }, @@ -41166,7 +41166,7 @@ "title": "Action Type", "example": "assign_task", "type": "string", - "description": "The type of outcome", + "description": "The type of outcome.", "enum": [ "add_metadata", "assign_task", @@ -41194,23 +41194,23 @@ ] }, { - "description": "The type of outcome" + "description": "The type of outcome." } ] }, "if_rejected": { - "description": "If `action_type` is `assign_task` and the task is rejected, returns a\nlist of outcomes to complete", + "description": "If `action_type` is `assign_task` and the task is rejected, returns a\nlist of outcomes to complete.", "type": "array", "items": { "type": "object", "properties": { "id": { - "description": "The identifier of the outcome", + "description": "The identifier of the outcome.", "type": "string", "example": "12345" }, "type": { - "description": "The outcomes resource type", + "description": "The outcomes resource type.", "type": "string", "example": "outcome", "enum": [ @@ -41218,7 +41218,7 @@ ] }, "name": { - "description": "The name of the outcome", + "description": "The name of the outcome.", "type": "string", "example": "Approval Rejection Outcome" }, @@ -41228,7 +41228,7 @@ "title": "Action Type", "example": "assign_task", "type": "string", - "description": "The type of outcome", + "description": "The type of outcome.", "enum": [ "add_metadata", "assign_task", @@ -41256,7 +41256,7 @@ ] }, { - "description": "The type of outcome" + "description": "The type of outcome." } ] } @@ -41267,12 +41267,12 @@ } }, { - "description": "Actions that are completed once the flow is triggered" + "description": "Actions that are completed once the flow is triggered." } ] }, "created_at": { - "description": "When this flow was created", + "description": "When this flow was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -41283,7 +41283,7 @@ "$ref": "#/components/schemas/User--Base" }, { - "description": "The user who created this flow" + "description": "The user who created this flow." } ] } @@ -41307,13 +41307,13 @@ { "properties": { "created_at": { - "description": "The date and time when the workflow was created on Box", + "description": "The date and time when the workflow was created on Box.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { - "description": "The date and time when the workflow was last updated on Box", + "description": "The date and time when the workflow was last updated on Box.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" @@ -41324,7 +41324,7 @@ "$ref": "#/components/schemas/User--Base" }, { - "description": "The user who created this workflow" + "description": "The user who created this workflow." } ] }, @@ -41334,7 +41334,7 @@ "$ref": "#/components/schemas/User--Base" }, { - "description": "The user who last modified this workflow" + "description": "The user who last modified this workflow." } ] } @@ -41350,12 +41350,12 @@ "type": "object", "properties": { "id": { - "description": "The unique identifier for the workflow", + "description": "The unique identifier for the workflow.", "type": "string", "example": "11446498" }, "type": { - "description": "`workflow`", + "description": "The value will always be `workflow`.", "type": "string", "example": "workflow", "enum": [ @@ -41363,7 +41363,7 @@ ] }, "name": { - "description": "The name of the workflow", + "description": "The name of the workflow.", "type": "string", "example": "New Hire Workflow" }, @@ -41373,7 +41373,7 @@ "example": "This workflow sets off a new hire approval flow" }, "is_enabled": { - "description": "Specifies if this workflow is enabled", + "description": "Specifies if this workflow is enabled.", "type": "boolean", "example": true } @@ -41394,7 +41394,7 @@ "allOf": [ { "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", + "description": "The part of an API response that describes marker\nbased pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", @@ -41419,7 +41419,7 @@ { "properties": { "entries": { - "description": "A list of workflows", + "description": "A list of workflows.", "type": "array", "items": { "$ref": "#/components/schemas/Workflow" @@ -41463,12 +41463,12 @@ "description": "A file or folder for which a conflict was encountered, This object provides the type and identifier of the original item, as well as a mapping between its original name and it's new name as it will appear in the archive.", "properties": { "id": { - "description": "The identifier of the item", + "description": "The identifier of the item.", "type": "string", "example": "12345" }, "type": { - "description": "The type of this item", + "description": "The type of this item.", "type": "string", "example": "file", "enum": [ @@ -41477,7 +41477,7 @@ ] }, "original_name": { - "description": "The original name of this item", + "description": "Box Developer Documentation.", "type": "string", "example": "Report.pdf" }, @@ -41518,7 +41518,7 @@ "x-box-tag": "zip_downloads" }, "ZipDownloadRequest": { - "description": "A request to create a `zip` archive to download", + "description": "A request to create a `zip` archive to download.", "type": "object", "properties": { "items": { @@ -41998,7 +41998,7 @@ } ], "externalDocs": { - "description": "Box Developer Documentation", + "description": "Box Developer Documentation.", "url": "https://developer.box.com" } } \ No newline at end of file