From c914cc6b3bad7956b7cb39e9c73058eeb3a87c81 Mon Sep 17 00:00:00 2001 From: box-apimgmt Date: Tue, 20 Aug 2024 01:53:56 -0700 Subject: [PATCH] docs: adding missing fields to sign template signer --- openapi.json | 1790 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 1356 insertions(+), 434 deletions(-) diff --git a/openapi.json b/openapi.json index 11a8a691..1de0e55a 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2.0.0", - "x-box-commit-hash": "" + "x-box-commit-hash": "7166973b7f" }, "servers": [ { @@ -23668,7 +23668,7 @@ }, "post": { "operationId": "post_integration_mappings_slack", - "summary": "Create integration mapping", + "summary": "Create Slack integration mapping", "tags": [ "Integration mappings" ], @@ -24088,12 +24088,19 @@ "title": "AI ask request", "type": "object", "x-box-tag": "ai", - "required": ["prompt", "items", "mode"], + "required": [ + "prompt", + "items", + "mode" + ], "properties": { "mode": { "type": "string", "description": "The mode specifies if this request is for a single or multiple items. If you select `single_item_qa` the `items` array can have one element only. Selecting `multiple_item_qa` allows you to provide up to 25 items.", - "enum": ["multiple_item_qa", "single_item_qa"], + "enum": [ + "multiple_item_qa", + "single_item_qa" + ], "example": "multiple_item_qa", "nullable": false }, @@ -24111,7 +24118,10 @@ "items": { "type": "object", "description": "The item to be processed by the LLM.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -24121,7 +24131,9 @@ "type": { "type": "string", "description": "The type of the item.", - "enum": ["file"], + "enum": [ + "file" + ], "example": "file" }, "content": { @@ -24154,7 +24166,10 @@ "title": "AI text gen request", "type": "object", "x-box-tag": "ai", - "required": ["prompt", "items"], + "required": [ + "prompt", + "items" + ], "properties": { "prompt": { "type": "string", @@ -24164,7 +24179,10 @@ "items": { "type": "array", "description": "The items to be processed by the LLM, often files.\nThe array can include **exactly one** element.\n\n**Note**: Box AI handles documents with text representations up to 1MB in size.\nIf the file size exceeds 1MB, the first 1MB of text representation will be processed.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "minItems": 1, "maxItems": 1, "uniqueItems": true, @@ -24180,7 +24198,9 @@ "type": { "type": "string", "description": "The type of the item.", - "enum": ["file"], + "enum": [ + "file" + ], "example": "file" }, "content": { @@ -24208,7 +24228,9 @@ "title": "Token request", "type": "object", "description": "A request for a new OAuth 2.0 token", - "required": ["grant_type"], + "required": [ + "grant_type" + ], "properties": { "grant_type": { "type": "string", @@ -24261,7 +24283,9 @@ "type": "string", "example": "urn:ietf:params:oauth:token-type:access_token", "description": "The type of `subject_token` passed in.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.", - "enum": ["urn:ietf:params:oauth:token-type:access_token"] + "enum": [ + "urn:ietf:params:oauth:token-type:access_token" + ] }, "actor_token": { "type": "string", @@ -24274,7 +24298,9 @@ "format": "urn", "example": "urn:ietf:params:oauth:token-type:id_token", "description": "The type of `actor_token` passed in.\n\nUsed in combination with `urn:ietf:params:oauth:grant-type:token-exchange`\nas the `grant_type`.", - "enum": ["urn:ietf:params:oauth:token-type:id_token"] + "enum": [ + "urn:ietf:params:oauth:token-type:id_token" + ] }, "scope": { "type": "string", @@ -24292,7 +24318,10 @@ "type": "string", "example": "enterprise", "description": "Used in combination with `client_credentials` as the `grant_type`.", - "enum": ["enterprise", "user"] + "enum": [ + "enterprise", + "user" + ] }, "box_subject_id": { "type": "string", @@ -24323,7 +24352,9 @@ "format": "urn", "example": "refresh_token", "description": "The type of request being made, in this case a refresh request.", - "enum": ["refresh_token"] + "enum": [ + "refresh_token" + ] }, "client_id": { "type": "string", @@ -24347,7 +24378,9 @@ "title": "Token revocation request", "type": "object", "description": "A request to revoke an OAuth 2.0 token", - "required": ["grant_type"], + "required": [ + "grant_type" + ], "properties": { "client_id": { "type": "string", @@ -24371,7 +24404,9 @@ "title": "Create a `zip` archive", "type": "object", "description": "A request to create a `zip` archive to download", - "required": ["items"], + "required": [ + "items" + ], "properties": { "items": { "type": "array", @@ -24379,13 +24414,19 @@ "items": { "type": "object", "description": "An item to add to the `zip` archive. This can be a file or a folder.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "description": "The type of the item to add to the archive.", "example": "file", - "enum": ["file", "folder"] + "enum": [ + "file", + "folder" + ] }, "id": { "type": "string", @@ -24406,7 +24447,10 @@ "title": "Metadata query search request", "type": "object", "description": "Create a search using SQL-like syntax to return items that match specific\nmetadata.", - "required": ["from", "ancestor_folder_id"], + "required": [ + "from", + "ancestor_folder_id" + ], "properties": { "from": { "type": "string", @@ -24452,7 +24496,12 @@ "type": "string", "description": "The direction to order by, either ascending or descending.\n\nThe `ordering` direction must be the same for each item in the\narray.", "example": "asc", - "enum": ["ASC", "DESC", "asc", "desc"] + "enum": [ + "ASC", + "DESC", + "asc", + "desc" + ] } } } @@ -24505,7 +24554,10 @@ "type": "string", "description": "An optional new status of the file request.\n\nWhen the status is set to `inactive`, the file request\nwill no longer accept new submissions, and any visitor\nto the file request URL will receive a `HTTP 404` status\ncode.\n\nThis will default to the value on the existing file request.", "example": "active", - "enum": ["active", "inactive"] + "enum": [ + "active", + "inactive" + ] }, "is_email_required": { "type": "boolean", @@ -24529,7 +24581,9 @@ "title": "File Request (Copy)", "type": "object", "description": "The request body to copy a file request.", - "required": ["folder"], + "required": [ + "folder" + ], "allOf": [ { "$ref": "#/components/schemas/FileRequestUpdateRequest" @@ -24539,13 +24593,17 @@ "folder": { "type": "object", "description": "The folder to associate the new file request to.", - "required": ["id"], + "required": [ + "id" + ], "properties": { "type": { "type": "string", "example": "folder", "description": "`folder`", - "enum": ["folder"] + "enum": [ + "folder" + ] }, "id": { "type": "string", @@ -24562,7 +24620,9 @@ "title": "Create a Box Sign request", "type": "object", "description": "Creates a Box Sign request object.", - "required": ["signers"], + "required": [ + "signers" + ], "allOf": [ { "$ref": "#/components/schemas/SignRequest--Base" @@ -24582,7 +24642,11 @@ "type": "string", "example": "blue", "description": "Force a specific color for the signature (blue, black, or red)", - "enum": ["blue", "black", "red"], + "enum": [ + "blue", + "black", + "red" + ], "nullable": true }, "signers": { @@ -24611,33 +24675,47 @@ "type": "object", "x-box-resource-id": "integration_mapping_slack_create_request", "description": "A request to create a\nSlack Integration Mapping object", - "properties": { - "partner_item": { - "allOf": [ - { - "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" - } - ], - "nullable": false - }, - "box_item": { - "allOf": [ - { - "$ref": "#/components/schemas/IntegrationMappingBoxItemSlack" + "allOf": [ + { + "type": "object", + "properties": { + "box_item": { + "allOf": [ + { + "$ref": "#/components/schemas/IntegrationMappingBoxItemSlack" + } + ], + "nullable": false + }, + "options": { + "allOf": [ + { + "$ref": "#/components/schemas/IntegrationMappingSlackOptions" + } + ], + "nullable": false } - ], - "nullable": false + }, + "required": [ + "box_item" + ] }, - "options": { - "allOf": [ - { - "$ref": "#/components/schemas/IntegrationMappingSlackOptions" + { + "properties": { + "partner_item": { + "allOf": [ + { + "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" + } + ], + "nullable": false } - ], - "nullable": false + } } - }, - "required": ["partner_item", "box_item"] + ], + "required": [ + "partner_item" + ] }, "ClientError": { "title": "Client error", @@ -24649,7 +24727,9 @@ "description": "error", "example": "error", "type": "string", - "enum": ["error"], + "enum": [ + "error" + ], "nullable": false }, "status": { @@ -24773,7 +24853,9 @@ "type": "string", "description": "`skill_invocation`", "example": "skill_invocation", - "enum": ["skill_invocation"] + "enum": [ + "skill_invocation" + ] }, "id": { "type": "string", @@ -24796,7 +24878,9 @@ "type": "string", "description": "`skill`", "example": "skill", - "enum": ["skill"] + "enum": [ + "skill" + ] }, "name": { "type": "string", @@ -24837,7 +24921,9 @@ }, "token_type": { "type": "string", - "enum": ["bearer"], + "enum": [ + "bearer" + ], "example": "bearer", "description": "The type of access token returned." }, @@ -24866,7 +24952,9 @@ }, "token_type": { "type": "string", - "enum": ["bearer"], + "enum": [ + "bearer" + ], "example": "bearer", "description": "The type of access token returned." }, @@ -24939,7 +25027,9 @@ "type": "string", "description": "`enterprise`", "example": "enterprise", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "name": { "description": "The name of the enterprise", @@ -24998,7 +25088,9 @@ "type": "string", "description": "`webhook_event`", "example": "webhook_event", - "enum": ["webhook_event"] + "enum": [ + "webhook_event" + ] }, "webhook": { "allOf": [ @@ -25121,7 +25213,9 @@ }, "token_type": { "type": "string", - "enum": ["bearer"], + "enum": [ + "bearer" + ], "example": "bearer", "description": "The type of access token returned." }, @@ -25142,7 +25236,9 @@ "type": "string", "format": "urn", "example": "urn:ietf:params:oauth:token-type:access_token", - "enum": ["urn:ietf:params:oauth:token-type:access_token"], + "enum": [ + "urn:ietf:params:oauth:token-type:access_token" + ], "description": "The type of downscoped access token returned. This is only\nreturned if an access token has been downscoped." } } @@ -25153,8 +25249,14 @@ "x-box-resource-id": "ai_response", "x-box-tag": "ai", "x-box-variant": "standard", - "x-box-variants": ["standard", "full"], - "required": ["answer", "created_at"], + "x-box-variants": [ + "standard", + "full" + ], + "required": [ + "answer", + "created_at" + ], "properties": { "answer": { "type": "string", @@ -25180,9 +25282,15 @@ "x-box-resource-id": "ai_response--full", "x-box-tag": "ai", "x-box-variant": "full", - "x-box-variants": ["standard", "full"], + "x-box-variants": [ + "standard", + "full" + ], "type": "object", - "required": ["answer", "created_at"], + "required": [ + "answer", + "created_at" + ], "allOf": [ { "$ref": "#/components/schemas/AiResponse" @@ -25206,11 +25314,15 @@ "type": "object", "x-box-resource-id": "ai_agent_ask", "x-box-tag": "ai", - "required": ["type"], + "required": [ + "type" + ], "properties": { "type": { "type": "string", - "enum": ["ai_agent_ask"], + "enum": [ + "ai_agent_ask" + ], "description": "The type of AI agent used to handle queries.", "example": "ai_agent_ask", "nullable": false @@ -25235,11 +25347,15 @@ "type": "object", "x-box-tag": "ai", "x-box-resource-id": "ai_agent_text_gen", - "required": ["type"], + "required": [ + "type" + ], "properties": { "type": { "type": "string", - "enum": ["ai_agent_text_gen"], + "enum": [ + "ai_agent_text_gen" + ], "description": "The type of AI agent used for generating text.", "example": "ai_agent_text_gen", "nullable": false @@ -25271,7 +25387,9 @@ "type": "string", "example": "securityClassification-6VMVochwUWo", "description": "`securityClassification-6VMVochwUWo`", - "enum": ["securityClassification-6VMVochwUWo"] + "enum": [ + "securityClassification-6VMVochwUWo" + ] }, "$scope": { "type": "string", @@ -25324,7 +25442,9 @@ "type": "string", "description": "`metadata_template`", "example": "metadata_template", - "enum": ["metadata_template"], + "enum": [ + "metadata_template" + ], "nullable": false }, "scope": { @@ -25336,13 +25456,17 @@ "type": "string", "example": "securityClassification-6VMVochwUWo", "description": "`securityClassification-6VMVochwUWo`", - "enum": ["securityClassification-6VMVochwUWo"] + "enum": [ + "securityClassification-6VMVochwUWo" + ] }, "displayName": { "type": "string", "example": "Classification", "description": "The name of this template as shown in web and mobile interfaces.", - "enum": ["Classification"] + "enum": [ + "Classification" + ] }, "hidden": { "type": "boolean", @@ -25361,7 +25485,13 @@ "description": "A list of fields for this classification template. This includes\nonly one field, the `Box__Security__Classification__Key`, which defines\nthe different classifications available in this enterprise.", "items": { "type": "object", - "required": ["id", "type", "key", "displayName", "options"], + "required": [ + "id", + "type", + "key", + "displayName", + "options" + ], "description": "The metadata template field that represents the available\nclassifications.", "properties": { "id": { @@ -25373,19 +25503,25 @@ "type": "string", "example": "enum", "description": "The array item type.", - "enum": ["enum"] + "enum": [ + "enum" + ] }, "key": { "type": "string", "example": "Box__Security__Classification__Key", "description": "Defines classifications \navailable in the enterprise.", - "enum": ["Box__Security__Classification__Key"] + "enum": [ + "Box__Security__Classification__Key" + ] }, "displayName": { "type": "string", "example": "Classification", "description": "`Classification`", - "enum": ["Classification"] + "enum": [ + "Classification" + ] }, "hidden": { "type": "boolean", @@ -25397,7 +25533,10 @@ "description": "A list of classifications available in this enterprise.", "minItems": 1, "items": { - "required": ["key", "id"], + "required": [ + "key", + "id" + ], "type": "object", "description": "A single classification available in this enterprise.", "properties": { @@ -25448,7 +25587,10 @@ "x-box-resource-id": "collaboration", "x-box-tag": "user_collaborations", "description": "Collaborations define access permissions for users and groups to files and\nfolders, similar to access control lists. A collaboration object grants a\nuser or group access to a file or folder with permissions defined by a\nspecific role.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -25459,7 +25601,9 @@ "type": "string", "description": "`collaboration`", "example": "collaboration", - "enum": ["collaboration"] + "enum": [ + "collaboration" + ] }, "item": { "allOf": [ @@ -25535,7 +25679,11 @@ "status": { "type": "string", "example": "accepted", - "enum": ["accepted", "pending", "rejected"], + "enum": [ + "accepted", + "pending", + "rejected" + ], "description": "The status of the collaboration invitation. If the status\nis `pending`, `login` and `name` return an empty string." }, "acknowledged_at": { @@ -25711,7 +25859,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -25747,7 +25898,9 @@ "type": "string", "description": "`collaboration_whitelist_entry`", "example": "collaboration_whitelist_entry", - "enum": ["collaboration_whitelist_entry"] + "enum": [ + "collaboration_whitelist_entry" + ] }, "domain": { "type": "string", @@ -25758,7 +25911,11 @@ "type": "string", "example": "both", "description": "The direction of the collaborations to allow.", - "enum": ["inbound", "outbound", "both"] + "enum": [ + "inbound", + "outbound", + "both" + ] }, "enterprise": { "allOf": [ @@ -25776,7 +25933,9 @@ "type": "string", "description": "`enterprise`", "example": "enterprise", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "name": { "description": "The name of the enterprise", @@ -25858,7 +26017,9 @@ "type": "string", "description": "`collaboration_whitelist_exempt_target`", "example": "collaboration_whitelist_exempt_target", - "enum": ["collaboration_whitelist_exempt_target"] + "enum": [ + "collaboration_whitelist_exempt_target" + ] }, "enterprise": { "allOf": [ @@ -25876,7 +26037,9 @@ "type": "string", "description": "`enterprise`", "example": "enterprise", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "name": { "description": "The name of the enterprise", @@ -25974,18 +26137,24 @@ "type": "string", "description": "`collection`", "example": "collection", - "enum": ["collection"] + "enum": [ + "collection" + ] }, "name": { "type": "string", "description": "The name of the collection.", - "enum": ["Favorites"], + "enum": [ + "Favorites" + ], "example": "Favorites" }, "collection_type": { "type": "string", "description": "The type of the collection. This is used to\ndetermine the proper visual treatment for\ncollections.", - "enum": ["favorites"], + "enum": [ + "favorites" + ], "example": "favorites" } } @@ -26035,7 +26204,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -26172,7 +26344,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -26197,7 +26372,11 @@ "type": "object", "x-box-resource-id": "comment--base", "x-box-tag": "comments", - "x-box-variants": ["base", "standard", "full"], + "x-box-variants": [ + "base", + "standard", + "full" + ], "x-box-variant": "base", "description": "Base representation of a comment.", "properties": { @@ -26210,7 +26389,9 @@ "type": "string", "description": "`comment`", "example": "comment", - "enum": ["comment"] + "enum": [ + "comment" + ] } } }, @@ -26251,7 +26432,9 @@ "type": "string", "description": "`device_pinner`", "example": "device_pinner", - "enum": ["device_pinner"] + "enum": [ + "device_pinner" + ] }, "owned_by": { "allOf": [ @@ -26307,14 +26490,19 @@ "by": { "description": "The field that is ordered by", "example": "id", - "enum": ["id"], + "enum": [ + "id" + ], "type": "string" }, "direction": { "type": "string", "description": "The direction to order by, either ascending or descending", "example": "asc", - "enum": ["asc", "desc"] + "enum": [ + "asc", + "desc" + ] } } } @@ -26337,7 +26525,9 @@ "type": "string", "description": "`email_alias`", "example": "email_alias", - "enum": ["email_alias"] + "enum": [ + "email_alias" + ] }, "email": { "type": "string", @@ -26377,7 +26567,12 @@ "title": "Enterprise (Base)", "type": "object", "x-box-resource-id": "enterprise--base", - "x-box-variants": ["base", "mini", "standard", "full"], + "x-box-variants": [ + "base", + "mini", + "standard", + "full" + ], "x-box-variant": "base", "description": "A mini representation of a enterprise, used when\nnested within another resource.", "properties": { @@ -26391,7 +26586,9 @@ "description": "`enterprise`", "example": "enterprise", "nullable": false, - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] } } }, @@ -26692,7 +26889,10 @@ "title": "Path collection", "description": "A list of parent folders for an item.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -26844,14 +27044,22 @@ "access": { "type": "string", "description": "The access level for this shared link.\n\n* `open` - provides access to this item to anyone with this link\n* `company` - only provides access to this item to people the same company\n* `collaborators` - only provides access to this item to people who are\n collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level\nwill be set to the default access level specified by the enterprise admin.", - "enum": ["open", "company", "collaborators"], + "enum": [ + "open", + "company", + "collaborators" + ], "example": "open", "nullable": false }, "effective_access": { "type": "string", "description": "The effective access level for the shared link. This can be a more\nrestrictive access level than the value in the `access` field when the\nenterprise settings restrict the allowed access levels.", - "enum": ["open", "company", "collaborators"], + "enum": [ + "open", + "company", + "collaborators" + ], "example": "company", "nullable": false }, @@ -26883,7 +27091,11 @@ "permissions": { "type": "object", "description": "Defines if this link allows a user to preview, edit, and download an item.\nThese permissions refer to the shared link only and\ndo not supersede permissions applied to the item itself.", - "required": ["can_download", "can_preview", "can_edit"], + "required": [ + "can_download", + "can_preview", + "can_edit" + ], "properties": { "can_download": { "type": "boolean", @@ -26941,7 +27153,11 @@ "item_status": { "type": "string", "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.", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "deleted" + ], "nullable": false, "example": "active" } @@ -27135,7 +27351,9 @@ "allOf": [ { "type": "array", - "example": ["approved"], + "example": [ + "approved" + ], "items": { "type": "string" }, @@ -27164,7 +27382,9 @@ "type": "string", "description": "`lock`", "example": "lock", - "enum": ["lock"] + "enum": [ + "lock" + ] }, "created_by": { "allOf": [ @@ -27248,7 +27468,9 @@ }, "token_type": { "type": "string", - "enum": ["bearer"], + "enum": [ + "bearer" + ], "example": "bearer", "description": "The type of access token returned." }, @@ -27301,11 +27523,16 @@ "type": "boolean", "description": "Specifies if the file can be accessed\nvia the direct shared link or a shared link\nto a parent folder.", "example": true, - "enum": [true, false] + "enum": [ + true, + false + ] }, "allowed_invitee_roles": { "type": "array", - "example": ["editor"], + "example": [ + "editor" + ], "nullable": false, "description": "A list of the types of roles that user can be invited at\nwhen sharing this file.", "items": { @@ -27526,12 +27753,18 @@ }, "shared_link_permission_options": { "type": "array", - "example": ["can_preview"], + "example": [ + "can_preview" + ], "nullable": true, "description": "A list of the types of roles that user can be invited at\nwhen sharing this file.", "items": { "type": "string", - "enum": ["can_preview", "can_download", "can_edit"] + "enum": [ + "can_preview", + "can_download", + "can_edit" + ] } } } @@ -27595,11 +27828,19 @@ "type": "object", "x-box-resource-id": "file--base", "x-box-tag": "files", - "x-box-variants": ["base", "mini", "standard", "full"], + "x-box-variants": [ + "base", + "mini", + "standard", + "full" + ], "x-box-variant": "base", "nullable": true, "description": "The bare basic representation of a file, the minimal\namount of fields returned when using the `fields` query\nparameter.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -27617,7 +27858,9 @@ "type": "string", "description": "`file`", "example": "file", - "enum": ["file"], + "enum": [ + "file" + ], "nullable": false } } @@ -27628,7 +27871,13 @@ "x-box-resource-id": "file_request", "x-box-tag": "file_requests", "description": "A standard representation of a file request, as returned\nfrom any file request API endpoints by default.", - "required": ["id", "type", "folder", "created_at", "updated_at"], + "required": [ + "id", + "type", + "folder", + "created_at", + "updated_at" + ], "properties": { "id": { "type": "string", @@ -27640,7 +27889,9 @@ "type": "string", "description": "`file_request`", "example": "file_request", - "enum": ["file_request"], + "enum": [ + "file_request" + ], "readOnly": true }, "title": { @@ -27658,7 +27909,10 @@ "type": "string", "example": "active", "description": "The status of the file request. This defaults\nto `active`.\n\nWhen the status is set to `inactive`, the file request\nwill no longer accept new submissions, and any visitor\nto the file request URL will receive a `HTTP 404` status\ncode.\n\nThis defaults to status of file request that was\ncopied to create this file request.", - "enum": ["active", "inactive"] + "enum": [ + "active", + "inactive" + ] }, "is_email_required": { "type": "boolean", @@ -27996,10 +28250,18 @@ "title": "File version (Base)", "type": "object", "x-box-resource-id": "file_version--base", - "x-box-variants": ["base", "mini", "standard", "full"], + "x-box-variants": [ + "base", + "mini", + "standard", + "full" + ], "x-box-variant": "base", "description": "The bare basic representation of a file version, the minimal\namount of fields returned when using the `fields` query\nparameter.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -28011,7 +28273,9 @@ "type": "string", "description": "`file_version`", "example": "file_version", - "enum": ["file_version"], + "enum": [ + "file_version" + ], "nullable": false } } @@ -28082,7 +28346,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -28118,7 +28385,9 @@ "type": "string", "description": "`file_version_legal_hold`", "example": "file_version_legal_hold", - "enum": ["file_version_legal_hold"] + "enum": [ + "file_version_legal_hold" + ] }, "file_version": { "allOf": [ @@ -28215,7 +28484,9 @@ "type": "string", "description": "`file_version_retention`", "example": "file_version_retention", - "enum": ["file_version_retention"] + "enum": [ + "file_version_retention" + ] }, "file_version": { "allOf": [ @@ -28358,7 +28629,10 @@ "title": "Path collection", "description": "A list of parent folders for an item.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -28499,14 +28773,22 @@ "access": { "type": "string", "description": "The access level for this shared link.\n\n* `open` - provides access to this item to anyone with this link\n* `company` - only provides access to this item to people the same company\n* `collaborators` - only provides access to this item to people who are\n collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level\nwill be set to the default access level specified by the enterprise admin.", - "enum": ["open", "company", "collaborators"], + "enum": [ + "open", + "company", + "collaborators" + ], "example": "open", "nullable": false }, "effective_access": { "type": "string", "description": "The effective access level for the shared link. This can be a more\nrestrictive access level than the value in the `access` field when the\nenterprise settings restrict the allowed access levels.", - "enum": ["open", "company", "collaborators"], + "enum": [ + "open", + "company", + "collaborators" + ], "example": "company", "nullable": false }, @@ -28538,7 +28820,11 @@ "permissions": { "type": "object", "description": "Defines if this link allows a user to preview, edit, and download an item.\nThese permissions refer to the shared link only and\ndo not supersede permissions applied to the item itself.", - "required": ["can_download", "can_preview", "can_edit"], + "required": [ + "can_download", + "can_preview", + "can_edit" + ], "properties": { "can_download": { "type": "boolean", @@ -28589,7 +28875,10 @@ "type": "string", "example": "open", "nullable": false, - "enum": ["open", "collaborators"], + "enum": [ + "open", + "collaborators" + ], "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." }, "email": { @@ -28615,7 +28904,11 @@ "item_status": { "type": "string", "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.", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "deleted" + ], "nullable": false, "example": "active" }, @@ -28655,7 +28948,11 @@ "example": "synced", "nullable": false, "description": "Specifies whether a folder should be synced to a\nuser's device or not. This is used by Box Sync\n(discontinued) and is not used by Box Drive.", - "enum": ["synced", "not_synced", "partially_synced"] + "enum": [ + "synced", + "not_synced", + "partially_synced" + ] } ] }, @@ -28670,7 +28967,9 @@ { "type": "object", "description": "The permissions that the authenticated user has for a folder.", - "required": ["can_upload"], + "required": [ + "can_upload" + ], "allOf": [ { "type": "object", @@ -28746,7 +29045,9 @@ "allOf": [ { "type": "array", - "example": ["approved"], + "example": [ + "approved" + ], "items": { "type": "string" }, @@ -28836,17 +29137,25 @@ }, "allowed_shared_link_access_levels": { "type": "array", - "example": ["open"], + "example": [ + "open" + ], "items": { "type": "string", - "enum": ["open", "company", "collaborators"] + "enum": [ + "open", + "company", + "collaborators" + ] }, "nullable": false, "description": "A list of access levels that are available\nfor this folder.\n\nFor some folders, like the root folder, this will always\nbe an empty list as sharing is not allowed at that level." }, "allowed_invitee_roles": { "type": "array", - "example": ["editor"], + "example": [ + "editor" + ], "nullable": false, "description": "A list of the types of roles that user can be invited at\nwhen sharing this folder.", "items": { @@ -28888,7 +29197,10 @@ "type": "boolean", "description": "Specifies if the folder can be accessed\nwith the direct shared link or a shared link\nto a parent folder.", "example": true, - "enum": [true, false] + "enum": [ + true, + false + ] }, "can_non_owners_view_collaborators": { "type": "boolean", @@ -28970,10 +29282,18 @@ "type": "object", "x-box-resource-id": "folder--base", "x-box-tag": "folders", - "x-box-variants": ["base", "mini", "standard", "full"], + "x-box-variants": [ + "base", + "mini", + "standard", + "full" + ], "x-box-variant": "base", "description": "The bare basic representation of a folder, the minimal\namount of fields returned when using the `fields` query\nparameter.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -28991,7 +29311,9 @@ "type": "string", "description": "`folder`", "example": "folder", - "enum": ["folder"], + "enum": [ + "folder" + ], "nullable": false } } @@ -29042,7 +29364,10 @@ "locked_operations": { "type": "object", "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", - "required": ["move", "delete"], + "required": [ + "move", + "delete" + ], "properties": { "move": { "type": "boolean", @@ -29112,29 +29437,14 @@ "x-box-resource-id": "integration_mapping", "x-box-tag": "integration_mappings", "x-box-variant": "standard", - "description": "A standard representation of an integration\nmapping object.", + "description": "A Slack specific representation of an integration\nmapping object.", "allOf": [ { "$ref": "#/components/schemas/IntegrationMapping--Base" }, { + "type": "object", "properties": { - "type": { - "type": "string", - "example": "integration_mapping", - "enum": ["integration_mapping"], - "description": "Mapping type", - "nullable": false - }, - "partner_item": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" - } - ], - "nullable": false, - "description": "Mapped item object for Slack" - }, "box_item": { "allOf": [ { @@ -29151,11 +29461,8 @@ "nullable": false }, "options": { - "type": "object", "nullable": false, - "example": {}, - "description": "Integration mapping options for Slack", - "anyOf": [ + "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingSlackOptions" } @@ -29193,10 +29500,42 @@ "example": "2012-12-12T10:53:43-08:00", "nullable": false } + }, + "required": [ + "box_item" + ] + }, + { + "properties": { + "integration_type": { + "type": "string", + "nullable": false, + "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`)", + "example": "slack", + "enum": [ + "slack" + ] + }, + "partner_item": { + "oneOf": [ + { + "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" + } + ], + "nullable": false, + "example": { + "id": "C12378991223", + "type": "channel", + "slack_org_id": "E1234567" + }, + "description": "Mapped item object for Slack or Teams" + } } } ], - "required": ["type", "partner_item", "box_item"] + "required": [ + "partner_item" + ] }, "IntegrationMapping--Base": { "title": "Integration mapping (Base)", @@ -29204,7 +29543,11 @@ "x-box-resource-id": "integration_mapping--base", "x-box-tag": "integration_mappings", "x-box-variant": "base", - "x-box-variants": ["base", "standard", "mini"], + "x-box-variants": [ + "base", + "standard", + "mini" + ], "description": "A base representation of an\nintegration mapping object.", "properties": { "id": { @@ -29213,56 +29556,19 @@ "example": "12345", "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`)" }, - "integration_type": { + "type": { "type": "string", - "nullable": false, - "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`)", - "example": "slack", - "enum": ["slack"] - } - } - }, - "IntegrationMapping--Mini": { - "title": "Integration mapping (Mini)", - "type": "object", - "x-box-resource-id": "integration_mapping--mini", - "x-box-tag": "integration_mappings", - "x-box-variant": "mini", - "description": "A mini representation of an\nintegration mapping object.", - "allOf": [ - { - "$ref": "#/components/schemas/IntegrationMapping--Base" - }, - { - "properties": { - "partner_item_id": { - "type": "string", - "example": "C12351346", - "description": "ID of the mapped partner item", - "nullable": false - }, - "partner_item_type": { - "type": "string", - "example": "channel", - "enum": ["channel"], - "description": "Domain-specific type of the mapped partner item", - "nullable": false - }, - "box_item_id": { - "type": "string", - "example": "123124351", - "description": "ID of the Box item mapped to the object referenced in `partner_item_id`", - "nullable": false - }, - "box_item_type": { - "type": "string", - "example": "folder", - "enum": ["folder"], - "description": "Type of the Box object referenced in `box_item_id`", - "nullable": false - } - } + "example": "integration_mapping", + "enum": [ + "integration_mapping" + ], + "description": "Mapping type", + "nullable": false } + }, + "required": [ + "id", + "type" ] }, "IntegrationMappings": { @@ -29376,7 +29682,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -29401,10 +29710,18 @@ "type": "object", "x-box-resource-id": "group--base", "x-box-tag": "groups", - "x-box-variants": ["base", "mini", "standard", "full"], + "x-box-variants": [ + "base", + "mini", + "standard", + "full" + ], "x-box-variant": "base", "description": "A base representation of a group.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -29415,7 +29732,9 @@ "type": "string", "description": "`group`", "example": "group", - "enum": ["group"] + "enum": [ + "group" + ] } } }, @@ -29511,7 +29830,10 @@ "type": "string", "description": "The type of the group.", "example": "managed_group", - "enum": ["managed_group", "all_users_group"] + "enum": [ + "managed_group", + "all_users_group" + ] } } } @@ -29533,7 +29855,9 @@ "type": "string", "description": "`group_membership`", "example": "group_membership", - "enum": ["group_membership"] + "enum": [ + "group_membership" + ] }, "user": { "allOf": [ @@ -29559,7 +29883,10 @@ "type": "string", "example": "member", "description": "The role of the user in the group.", - "enum": ["member", "admin"] + "enum": [ + "member", + "admin" + ] }, "created_at": { "type": "string", @@ -29620,7 +29947,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -29646,7 +29976,10 @@ "x-box-resource-id": "invite", "x-box-tag": "invites", "description": "An invite for a user to an enterprise.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -29657,7 +29990,9 @@ "type": "string", "description": "`invite`", "example": "invite", - "enum": ["invite"] + "enum": [ + "invite" + ] }, "invited_to": { "title": "Enterprise", @@ -29673,7 +30008,9 @@ "type": "string", "description": "`enterprise`", "example": "enterprise", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "name": { "description": "The name of the enterprise", @@ -29776,7 +30113,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -29833,7 +30173,12 @@ "status": { "type": "string", "example": "active", - "enum": ["active", "applying", "releasing", "released"], + "enum": [ + "active", + "applying", + "releasing", + "released" + ], "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" }, "assignment_counts": { @@ -29965,10 +30310,16 @@ "type": "object", "x-box-resource-id": "legal_hold_policy--mini", "x-box-tag": "legal_hold_policies", - "x-box-variants": ["mini", "standard"], + "x-box-variants": [ + "mini", + "standard" + ], "x-box-variant": "mini", "description": "A mini legal hold policy", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -29979,7 +30330,9 @@ "type": "string", "description": "`legal_hold_policy`", "example": "legal_hold_policy", - "enum": ["legal_hold_policy"] + "enum": [ + "legal_hold_policy" + ] } } }, @@ -30056,7 +30409,10 @@ "type": "object", "x-box-resource-id": "legal_hold_policy_assignment--base", "x-box-tag": "legal_hold_policy_assignments", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "base", "description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to Users, Folders, Files, or File Versions.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.", "properties": { @@ -30069,7 +30425,9 @@ "type": "string", "description": "`legal_hold_policy_assignment`", "example": "legal_hold_policy_assignment", - "enum": ["legal_hold_policy_assignment"] + "enum": [ + "legal_hold_policy_assignment" + ] } } }, @@ -30187,7 +30545,11 @@ "type": "object", "x-box-resource-id": "metadata--base", "x-box-tag": "file_metadata", - "x-box-variants": ["base", "standard", "full"], + "x-box-variants": [ + "base", + "standard", + "full" + ], "x-box-variant": "base", "description": "The base representation of a metadata instance.", "properties": { @@ -30240,7 +30602,10 @@ "x-box-resource-id": "metadata_cascade_policy", "x-box-tag": "metadata_cascade_policies", "description": "A metadata cascade policy automatically applies a metadata template instance\nto all the files and folders within the targeted folder.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -30251,7 +30616,9 @@ "type": "string", "description": "`metadata_cascade_policy`", "example": "metadata_cascade_policy", - "enum": ["metadata_cascade_policy"] + "enum": [ + "metadata_cascade_policy" + ] }, "owner_enterprise": { "type": "object", @@ -30261,7 +30628,9 @@ "type": "string", "example": "enterprise", "description": "`enterprise`", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "id": { "type": "string", @@ -30278,7 +30647,9 @@ "type": "string", "example": "folder", "description": "`folder`", - "enum": ["folder"] + "enum": [ + "folder" + ] }, "id": { "type": "string", @@ -30349,7 +30720,10 @@ "x-box-resource-id": "metadata_query_index", "x-box-tag": "search", "description": "A metadata query index", - "required": ["type", "status"], + "required": [ + "type", + "status" + ], "properties": { "id": { "type": "string", @@ -30366,7 +30740,11 @@ "type": "string", "description": "The status of the metadata query index", "example": "active", - "enum": ["building", "active", "disabled"], + "enum": [ + "building", + "active", + "disabled" + ], "nullable": false }, "fields": { @@ -30387,7 +30765,10 @@ "type": "string", "example": "asc", "description": "The sort direction of the field.", - "enum": ["asc", "desc"] + "enum": [ + "asc", + "desc" + ] } } } @@ -30438,7 +30819,10 @@ "x-box-resource-id": "metadata_template", "x-box-tag": "metadata_templates", "description": "A template for metadata that can be applied to files and folders", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "id": { "type": "string", @@ -30449,7 +30833,9 @@ "type": "string", "description": "`metadata_template`", "example": "metadata_template", - "enum": ["metadata_template"], + "enum": [ + "metadata_template" + ], "nullable": false }, "scope": { @@ -30485,7 +30871,11 @@ { "title": "Metadata Field (Read)", "description": "A field within a metadata template. Fields can be a basic text, date, or\nnumber field, or a list of options.", - "required": ["type", "key", "displayName"], + "required": [ + "type", + "key", + "displayName" + ], "type": "object", "properties": { "type": { @@ -30531,7 +30921,9 @@ "title": "Metadata Option (Write)", "type": "object", "description": "An option for a Metadata Template Field.\n\nOptions only need to be provided for fields of type `enum` and `multiSelect`.\nOptions represent the value(s) a user can select for the field either through\nthe UI or through the API.", - "required": ["key"], + "required": [ + "key" + ], "properties": { "key": { "description": "The text value of the option. This represents both the display name of the\noption and the internal key used when updating templates.", @@ -30561,7 +30953,9 @@ "title": "Metadata Option (Write)", "type": "object", "description": "An option for a Metadata Template Field.\n\nOptions only need to be provided for fields of type `enum` and `multiSelect`.\nOptions represent the value(s) a user can select for the field either through\nthe UI or through the API.", - "required": ["key"], + "required": [ + "key" + ], "properties": { "key": { "description": "The text value of the option. This represents both the display name of the\noption and the internal key used when updating templates.", @@ -30853,19 +31247,28 @@ "type": "string", "example": "finite", "description": "The type of the retention policy. A retention\npolicy type can either be `finite`, where a\nspecific amount of time to retain the content is known\nupfront, or `indefinite`, where the amount of time\nto retain the content is still unknown.", - "enum": ["finite", "indefinite"] + "enum": [ + "finite", + "indefinite" + ] }, "retention_type": { "type": "string", "example": "non_modifiable", "description": "Specifies the retention type:\n\n* `modifiable`: You can modify the retention policy. For example,\n you can add or remove folders, shorten or lengthen\n the policy duration, or delete the assignment.\n Use this type if your retention policy\n is not related to any regulatory purposes.\n\n* `non-modifiable`: You can modify the retention policy\n only in a limited way: add a folder, lengthen the duration,\n retire the policy, change the disposition action\n or notification settings. You cannot perform other actions,\n such as deleting the assignment or shortening the\n policy duration. Use this type to ensure\n compliance with regulatory retention policies.", - "enum": ["modifiable", "non_modifiable"] + "enum": [ + "modifiable", + "non_modifiable" + ] }, "status": { "type": "string", "example": "active", "description": "The status of the retention policy. The status of\na policy will be `active`, unless explicitly retired by an\nadministrator, in which case the status will be `retired`.\nOnce a policy has been retired, it cannot become\nactive again.", - "enum": ["active", "retired"] + "enum": [ + "active", + "retired" + ] }, "created_by": { "allOf": [ @@ -30962,7 +31365,10 @@ "type": "string", "example": "permanently_delete", "description": "The disposition action of the retention policy.\nThis action can be `permanently_delete`, which\nwill cause the content retained by the policy\nto be permanently deleted, or `remove_retention`,\nwhich will lift the retention policy from the content,\nallowing it to be deleted by users,\nonce the retention policy has expired.", - "enum": ["permanently_delete", "remove_retention"] + "enum": [ + "permanently_delete", + "remove_retention" + ] } } } @@ -30973,10 +31379,17 @@ "type": "object", "x-box-resource-id": "retention_policy--base", "x-box-tag": "retention_policies", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "base", "description": "A base representation of a retention policy.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -30988,7 +31401,9 @@ "type": "string", "description": "`retention_policy`", "example": "retention_policy", - "enum": ["retention_policy"], + "enum": [ + "retention_policy" + ], "nullable": false } } @@ -30998,10 +31413,16 @@ "type": "object", "x-box-resource-id": "retention_policy_assignment--base", "x-box-tag": "retention_policy_assignments", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "base", "description": "A base representation of a retention policy assignment.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -31013,7 +31434,9 @@ "type": "string", "description": "`retention_policy_assignment`", "example": "retention_policy_assignment", - "enum": ["retention_policy_assignment"], + "enum": [ + "retention_policy_assignment" + ], "nullable": false } } @@ -31024,7 +31447,10 @@ "x-box-resource-id": "retention_policy_assignment", "x-box-tag": "retention_policy_assignments", "description": "A retention assignment represents a rule specifying\nthe files a retention policy retains.\nAssignments can retain files based on their folder or metadata,\nor hold all files in the enterprise.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -31035,7 +31461,9 @@ "type": "string", "description": "`retention_policy_assignment`", "example": "retention_policy_assignment", - "enum": ["retention_policy_assignment"] + "enum": [ + "retention_policy_assignment" + ] }, "retention_policy": { "allOf": [ @@ -31061,7 +31489,11 @@ "type": "string", "example": "metadata_template", "description": "The type of resource the policy is assigned to.", - "enum": ["folder", "enterprise", "metadata_template"] + "enum": [ + "folder", + "enterprise", + "metadata_template" + ] } } }, @@ -31154,7 +31586,10 @@ "type": "object", "x-box-resource-id": "shield_information_barrier", "x-box-tag": "shield_information_barriers", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "standard", "description": "A standard representation of a\nshield information barrier object", "properties": { @@ -31167,7 +31602,9 @@ "type": "string", "description": "The type of the shield information barrier", "example": "shield_information_barrier", - "enum": ["shield_information_barrier"] + "enum": [ + "shield_information_barrier" + ] }, "enterprise": { "allOf": [ @@ -31179,7 +31616,13 @@ }, "status": { "type": "string", - "enum": ["draft", "pending", "disabled", "enabled", "invalid"], + "enum": [ + "draft", + "pending", + "disabled", + "enabled", + "invalid" + ], "description": "Status of the shield information barrier", "example": "draft" }, @@ -31234,7 +31677,10 @@ "type": "object", "x-box-resource-id": "shield_information_barrier--base", "x-box-tag": "shield_information_barriers", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "base", "description": "A base representation of a\nshield information barrier object", "properties": { @@ -31247,7 +31693,9 @@ "type": "string", "description": "The type of the shield information barrier", "example": "shield_information_barrier", - "enum": ["shield_information_barrier"] + "enum": [ + "shield_information_barrier" + ] } } }, @@ -31294,7 +31742,10 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_report", "x-box-tag": "shield_information_barrier_reports", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "standard", "description": "A standard representation\nof a shield information barrier report object", "allOf": [ @@ -31312,7 +31763,12 @@ }, "status": { "type": "string", - "enum": ["pending", "error", "done", "cancelled"], + "enum": [ + "pending", + "error", + "done", + "cancelled" + ], "description": "Status of the shield information report", "example": "pending" }, @@ -31354,7 +31810,10 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_report--base", "x-box-tag": "shield_information_barrier_reports", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "base", "description": "A base representation of a\nshield information barrier report object", "properties": { @@ -31367,7 +31826,9 @@ "type": "string", "description": "The type of the shield information barrier report", "example": "shield_information_barrier_report", - "enum": ["shield_information_barrier_report"] + "enum": [ + "shield_information_barrier_report" + ] } } }, @@ -31425,7 +31886,9 @@ "type": "string", "description": "The type of the shield information barrier segment", "example": "shield_information_barrier_segment", - "enum": ["shield_information_barrier_segment"] + "enum": [ + "shield_information_barrier_segment" + ] }, "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" @@ -31517,7 +31980,11 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_segment_member", "x-box-tag": "shield_information_barrier_segment_members", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "standard", "description": "A standard representation of a\nshield information barrier segment member object", "allOf": [ @@ -31541,7 +32008,9 @@ "type": "string", "example": "shield_information_barrier_segment", "description": "The type of the shield information barrier segment", - "enum": ["shield_information_barrier_segment"] + "enum": [ + "shield_information_barrier_segment" + ] } }, "description": "The `type` and `id` of the requested\nshield information barrier segment." @@ -31597,7 +32066,11 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_segment_member--base", "x-box-tag": "shield_information_barrier_segment_members", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "base", "description": "A base representation of a\nshield information barrier segment member object", "properties": { @@ -31610,7 +32083,9 @@ "type": "string", "description": "The type of the shield information barrier segment member", "example": "shield_information_barrier_segment_member", - "enum": ["shield_information_barrier_segment_member"] + "enum": [ + "shield_information_barrier_segment_member" + ] } } }, @@ -31619,7 +32094,11 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_segment_member--mini", "x-box-tag": "shield_information_barrier_segment_members", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "mini", "description": "A mini representation of a\nshield information barrier segment member object", "allOf": [ @@ -31685,7 +32164,11 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_segment_restriction", "x-box-tag": "shield_information_barrier_segment_restrictions", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "standard", "description": "A standard representation of a\nsegment restriction of a shield information barrier\nobject", "required": [ @@ -31742,7 +32225,11 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_segment_restriction--base", "x-box-tag": "shield_information_barrier_segment_restrictions", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "base", "description": "A base representation of\na segment restriction object for\nthe shield information barrier", "required": [ @@ -31754,7 +32241,9 @@ "type": "string", "description": "Shield information barrier segment restriction", "example": "shield_information_barrier_segment_restriction", - "enum": ["shield_information_barrier_segment_restriction"] + "enum": [ + "shield_information_barrier_segment_restriction" + ] }, "id": { "type": "string", @@ -31768,7 +32257,11 @@ "type": "object", "x-box-resource-id": "shield_information_barrier_segment_restriction--mini", "x-box-tag": "shield_information_barrier_segment_restrictions", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "mini", "description": "A mini representation of\na segment restriction object for\nthe shield information barrier", "required": [ @@ -31793,7 +32286,9 @@ "type": "string", "description": "The type of the shield information barrier segment", "example": "shield_information_barrier_segment", - "enum": ["shield_information_barrier_segment"] + "enum": [ + "shield_information_barrier_segment" + ] } }, "description": "The `type` and `id` of the\nrequested shield information barrier segment." @@ -31810,7 +32305,9 @@ "type": "string", "description": "The type of the shield information segment", "example": "shield_information_barrier_segment", - "enum": ["shield_information_barrier_segment"] + "enum": [ + "shield_information_barrier_segment" + ] } }, "description": "The `type` and `id` of the\nrestricted shield information barrier segment." @@ -31863,7 +32360,9 @@ "x-box-resource-id": "search_results", "x-box-tag": "search", "description": "A list of files, folders and web links that matched the search query.", - "required": ["type"], + "required": [ + "type" + ], "allOf": [ { "type": "object", @@ -31894,7 +32393,9 @@ "description": "Specifies the response as search result items without shared links", "type": "string", "example": "search_results_items", - "enum": ["search_results_items"], + "enum": [ + "search_results_items" + ], "nullable": false }, "entries": { @@ -31924,7 +32425,9 @@ "x-box-resource-id": "search_results_with_shared_links", "x-box-tag": "search", "description": "A list of files, folders and web links that matched the search query,\nincluding the additional information about any shared links through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the `include_recent_shared_links`\nquery parameter has been set to `true`.", - "required": ["type"], + "required": [ + "type" + ], "allOf": [ { "type": "object", @@ -31955,7 +32458,9 @@ "description": "Specifies the response as search result items with shared links", "type": "string", "example": "search_results_with_shared_links", - "enum": ["search_results_with_shared_links"], + "enum": [ + "search_results_with_shared_links" + ], "nullable": false }, "entries": { @@ -32164,10 +32669,16 @@ "type": "object", "x-box-resource-id": "storage_policy--mini", "x-box-tag": "storage_policies", - "x-box-variants": ["standard", "mini"], + "x-box-variants": [ + "standard", + "mini" + ], "x-box-variant": "mini", "description": "A mini description of a Storage Policy object", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -32178,7 +32689,9 @@ "type": "string", "description": "`storage_policy`", "example": "storage_policy", - "enum": ["storage_policy"] + "enum": [ + "storage_policy" + ] } } }, @@ -32188,7 +32701,10 @@ "x-box-resource-id": "storage_policy_assignment", "x-box-tag": "storage_policy_assignments", "description": "The assignment of a storage policy to a user or enterprise", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -32199,7 +32715,9 @@ "type": "string", "description": "`storage_policy_assignment`", "example": "storage_policy_assignment", - "enum": ["storage_policy_assignment"] + "enum": [ + "storage_policy_assignment" + ] }, "storage_policy": { "allOf": [ @@ -32297,7 +32815,9 @@ "type": "string", "description": "`task`", "example": "task", - "enum": ["task"] + "enum": [ + "task" + ] }, "item": { "allOf": [ @@ -32319,7 +32839,10 @@ "type": "string", "example": "review", "description": "The type of task the task assignee will be prompted to\nperform.", - "enum": ["review", "complete"] + "enum": [ + "review", + "complete" + ] }, "message": { "type": "string", @@ -32361,7 +32884,10 @@ "type": "string", "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` requires all assignees to review or\napprove the the task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the the task in order for it to be considered completed.", "example": "all_assignees", - "enum": ["all_assignees", "any_assignee"] + "enum": [ + "all_assignees", + "any_assignee" + ] } } }, @@ -32403,7 +32929,9 @@ "type": "string", "description": "`task_assignment`", "example": "task_assignment", - "enum": ["task_assignment"] + "enum": [ + "task_assignment" + ] }, "item": { "allOf": [ @@ -32452,7 +32980,12 @@ "type": "string", "description": "The current state of the assignment. The available states depend on\nthe `action` value of the task object.", "example": "incomplete", - "enum": ["completed", "incomplete", "approved", "rejected"] + "enum": [ + "completed", + "incomplete", + "approved", + "rejected" + ] }, "assigned_by": { "allOf": [ @@ -32504,7 +33037,10 @@ "description": "Whether these terms are enabled or not", "type": "string", "example": "enabled", - "enum": ["enabled", "disabled"] + "enum": [ + "enabled", + "disabled" + ] }, "enterprise": { "allOf": [ @@ -32522,7 +33058,9 @@ "type": "string", "description": "`enterprise`", "example": "enterprise", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "name": { "description": "The name of the enterprise", @@ -32540,7 +33078,10 @@ "description": "Whether to apply these terms to managed users or external users", "type": "string", "example": "managed", - "enum": ["managed", "external"] + "enum": [ + "managed", + "external" + ] }, "text": { "description": "The text for your terms and conditions. This text could be\nempty if the `status` is set to `disabled`.", @@ -32590,10 +33131,16 @@ "type": "object", "x-box-resource-id": "terms_of_service--base", "x-box-tag": "terms_of_services", - "x-box-variants": ["base", "standard"], + "x-box-variants": [ + "base", + "standard" + ], "x-box-variant": "base", "description": "The root-level record that is supposed to represent a\nsingle Terms of Service.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -32604,7 +33151,9 @@ "type": "string", "description": "`terms_of_service`", "example": "terms_of_service", - "enum": ["terms_of_service"] + "enum": [ + "terms_of_service" + ] } } }, @@ -32614,7 +33163,10 @@ "x-box-resource-id": "terms_of_service_user_status", "x-box-tag": "terms_of_service_user_statuses", "description": "The association between a Terms of Service and a user", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -32625,7 +33177,9 @@ "type": "string", "description": "`terms_of_service_user_status`", "example": "terms_of_service_user_status", - "enum": ["terms_of_service_user_status"] + "enum": [ + "terms_of_service_user_status" + ] }, "tos": { "allOf": [ @@ -32700,7 +33254,9 @@ "type": { "type": "string", "example": "sign-template", - "enum": ["sign-template"], + "enum": [ + "sign-template" + ], "description": "object type" }, "id": { @@ -32801,7 +33357,10 @@ "source_files" ] }, - "example": ["email_subject", "name"] + "example": [ + "email_subject", + "name" + ] }, "required": { "type": "object", @@ -32809,15 +33368,26 @@ "properties": { "signers": { "description": "Required signer fields.", - "example": [["email"], ["email"]], + "example": [ + [ + "email" + ], + [ + "email" + ] + ], "type": "array", "items": { "type": "array", "items": { "type": "string", - "enum": ["email"] + "enum": [ + "email" + ] }, - "example": ["email"] + "example": [ + "email" + ] } } } @@ -32965,7 +33535,11 @@ }, "role": { "type": "string", - "enum": ["signer", "approver", "final_copy_reader"], + "enum": [ + "signer", + "approver", + "final_copy_reader" + ], "description": "Defines the role of the signer in the signature request. A role of\n`signer` needs to sign the document, a role `approver`\napproves the document and\na `final_copy_reader` role only\nreceives the final signed document and signing log.", "example": "signer", "default": "signer" @@ -32986,6 +33560,17 @@ "description": "If provided, this value points signers that are assigned the same inputs and belongs to same signer group.\nA signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used\nwithin Box Sign requests created from it.", "example": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7", "nullable": true + }, + "label": { + "type": "string", + "description": "A placeholder label for the signer set by the template creator to differentiate between signers.", + "example": "Jane Doe", + "nullable": true + }, + "public_id": { + "type": "string", + "description": "An identifier for the signer. This can be used to identify a signer within the template.", + "example": "RJZYYVPR" } } } @@ -32995,7 +33580,9 @@ "title": "Template Signer Input", "type": "object", "description": "Input created by a Signer on a Template", - "required": ["page_index"], + "required": [ + "page_index" + ], "allOf": [ { "$ref": "#/components/schemas/SignRequestPrefillTag" @@ -33056,7 +33643,11 @@ }, "dropdown_choices": { "type": "array", - "example": ["Yes", "No", "Maybe"], + "example": [ + "Yes", + "No", + "Maybe" + ], "description": "When the input is of the type `dropdown` this values will be filled with all the dropdown options.", "nullable": true, "items": { @@ -33153,7 +33744,9 @@ "type": "string", "description": "`file`", "example": "file", - "enum": ["file"], + "enum": [ + "file" + ], "nullable": false }, "sequence_id": { @@ -33210,7 +33803,10 @@ "title": "Path collection (Trash)", "description": "A list of parent folders for an item in the trash.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -33229,7 +33825,9 @@ "type": { "type": "string", "description": "`folder`", - "enum": ["folder"], + "enum": [ + "folder" + ], "example": "folder" }, "id": { @@ -33368,7 +33966,11 @@ "item_status": { "type": "string", "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.", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "deleted" + ], "nullable": false, "example": "trashed" } @@ -33409,7 +34011,9 @@ "type": "string", "description": "`folder`", "example": "folder", - "enum": ["folder"], + "enum": [ + "folder" + ], "nullable": false }, "sequence_id": { @@ -33472,7 +34076,10 @@ "title": "Path collection (Trash)", "description": "A list of parent folders for an item in the trash.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -33491,7 +34098,9 @@ "type": { "type": "string", "description": "`folder`", - "enum": ["folder"], + "enum": [ + "folder" + ], "example": "folder" }, "id": { @@ -33625,7 +34234,11 @@ "item_status": { "type": "string", "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.", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "deleted" + ], "nullable": false, "example": "trashed" } @@ -33642,7 +34255,9 @@ "type": "string", "description": "`web_link`", "example": "web_link", - "enum": ["web_link"] + "enum": [ + "web_link" + ] }, "id": { "type": "string", @@ -33698,7 +34313,10 @@ "title": "Path collection (Trash)", "description": "A list of parent folders for an item in the trash.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -33717,7 +34335,9 @@ "type": { "type": "string", "description": "`folder`", - "enum": ["folder"], + "enum": [ + "folder" + ], "example": "folder" }, "id": { @@ -33821,7 +34441,11 @@ "item_status": { "type": "string", "example": "trashed", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "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" } } @@ -33863,7 +34487,9 @@ "type": "string", "description": "`file`", "example": "file", - "enum": ["file"], + "enum": [ + "file" + ], "nullable": false }, "sequence_id": { @@ -33920,7 +34546,10 @@ "title": "Path collection", "description": "A list of parent folders for an item.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -34045,7 +34674,11 @@ "item_status": { "type": "string", "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.", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "deleted" + ], "nullable": false, "example": "active" } @@ -34074,7 +34707,9 @@ "type": "string", "description": "`folder`", "example": "folder", - "enum": ["folder"], + "enum": [ + "folder" + ], "nullable": false }, "sequence_id": { @@ -34137,7 +34772,10 @@ "title": "Path collection", "description": "A list of parent folders for an item.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -34257,7 +34895,11 @@ "item_status": { "type": "string", "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.", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "deleted" + ], "nullable": false, "example": "active" } @@ -34269,13 +34911,18 @@ "x-box-resource-id": "trash_web_link_restored", "x-box-tag": "trashed_web_links", "description": "Represents a web link restored from the trash.", - "required": ["sequence_id", "path_collection"], + "required": [ + "sequence_id", + "path_collection" + ], "properties": { "type": { "type": "string", "description": "`web_link`", "example": "web_link", - "enum": ["web_link"] + "enum": [ + "web_link" + ] }, "id": { "type": "string", @@ -34331,7 +34978,10 @@ "title": "Path collection", "description": "A list of parent folders for an item.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -34421,7 +35071,11 @@ "item_status": { "type": "string", "example": "trashed", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "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" } } @@ -34452,7 +35106,10 @@ "type": "object", "x-box-resource-id": "upload_part--mini", "x-box-tag": "chunked_uploads", - "x-box-variants": ["mini", "standard"], + "x-box-variants": [ + "mini", + "standard" + ], "x-box-variant": "mini", "description": "The basic representation of an upload\nsession chunk.", "properties": { @@ -34532,7 +35189,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -34568,7 +35228,9 @@ "type": "string", "description": "`upload_session`", "example": "upload_session", - "enum": ["upload_session"] + "enum": [ + "upload_session" + ] }, "session_expires_at": { "description": "The date and time when this session expires.", @@ -34866,7 +35528,10 @@ "type": "string", "description": "The direction to order by, either ascending or descending", "example": "ASC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } } @@ -34900,7 +35565,11 @@ "properties": { "role": { "type": "string", - "enum": ["admin", "coadmin", "user"], + "enum": [ + "admin", + "coadmin", + "user" + ], "description": "The user’s enterprise role", "example": "admin" }, @@ -34952,7 +35621,9 @@ "type": "string", "description": "`enterprise`", "example": "enterprise", - "enum": ["enterprise"] + "enum": [ + "enterprise" + ] }, "name": { "description": "The name of the enterprise", @@ -34971,7 +35642,9 @@ "items": { "type": "string" }, - "example": ["important"], + "example": [ + "important" + ], "description": "Tags for all files and folders owned by the user. Values returned\nwill only contain tags that were set by the requester." }, "hostname": { @@ -35028,10 +35701,18 @@ "type": "object", "x-box-resource-id": "user--base", "x-box-tag": "users", - "x-box-variants": ["base", "mini", "standard", "full"], + "x-box-variants": [ + "base", + "mini", + "standard", + "full" + ], "x-box-variant": "base", "description": "A mini representation of a user, used when\nnested within another resource.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "id": { "type": "string", @@ -35043,7 +35724,9 @@ "description": "`user`", "example": "user", "nullable": false, - "enum": ["user"] + "enum": [ + "user" + ] } } }, @@ -35174,7 +35857,9 @@ }, "triggers": { "type": "array", - "example": ["FILE.UPLOADED"], + "example": [ + "FILE.UPLOADED" + ], "description": "An array of event names that this webhook is\nto be triggered for", "items": { "title": "Webhook Trigger", @@ -35234,7 +35919,10 @@ "type": "object", "x-box-resource-id": "webhook--mini", "x-box-tag": "webhooks", - "x-box-variants": ["mini", "standard"], + "x-box-variants": [ + "mini", + "standard" + ], "x-box-variant": "mini", "description": "Represents a configured webhook.", "properties": { @@ -35247,7 +35935,9 @@ "type": "string", "description": "`webhook`", "example": "webhook", - "enum": ["webhook"] + "enum": [ + "webhook" + ] }, "target": { "type": "object", @@ -35262,7 +35952,10 @@ "description": "The type of item to trigger a webhook", "type": "string", "example": "file", - "enum": ["file", "folder"] + "enum": [ + "file", + "folder" + ] } } } @@ -35345,7 +36038,10 @@ "title": "Path collection", "description": "A list of parent folders for an item.", "type": "object", - "required": ["total_count", "entries"], + "required": [ + "total_count", + "entries" + ], "properties": { "total_count": { "description": "The number of folders in this list.", @@ -35475,14 +36171,22 @@ "access": { "type": "string", "description": "The access level for this shared link.\n\n* `open` - provides access to this item to anyone with this link\n* `company` - only provides access to this item to people the same company\n* `collaborators` - only provides access to this item to people who are\n collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level\nwill be set to the default access level specified by the enterprise admin.", - "enum": ["open", "company", "collaborators"], + "enum": [ + "open", + "company", + "collaborators" + ], "example": "open", "nullable": false }, "effective_access": { "type": "string", "description": "The effective access level for the shared link. This can be a more\nrestrictive access level than the value in the `access` field when the\nenterprise settings restrict the allowed access levels.", - "enum": ["open", "company", "collaborators"], + "enum": [ + "open", + "company", + "collaborators" + ], "example": "company", "nullable": false }, @@ -35514,7 +36218,11 @@ "permissions": { "type": "object", "description": "Defines if this link allows a user to preview, edit, and download an item.\nThese permissions refer to the shared link only and\ndo not supersede permissions applied to the item itself.", - "required": ["can_download", "can_preview", "can_edit"], + "required": [ + "can_download", + "can_preview", + "can_edit" + ], "properties": { "can_download": { "type": "boolean", @@ -35561,7 +36269,11 @@ "item_status": { "type": "string", "example": "active", - "enum": ["active", "trashed", "deleted"], + "enum": [ + "active", + "trashed", + "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" } } @@ -35573,10 +36285,17 @@ "type": "object", "x-box-resource-id": "web_link--base", "x-box-tag": "web_links", - "x-box-variants": ["base", "mini", "standard"], + "x-box-variants": [ + "base", + "mini", + "standard" + ], "x-box-variant": "base", "description": "Web links are objects that point to URLs. These objects\nare also known as bookmarks within the Box web application.\n\nWeb link objects are treated similarly to file objects,\nthey will also support most actions that apply to regular files.", - "required": ["id", "type"], + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -35587,7 +36306,9 @@ "type": "string", "description": "`web_link`", "example": "web_link", - "enum": ["web_link"] + "enum": [ + "web_link" + ] }, "etag": { "type": "string", @@ -35663,7 +36384,9 @@ "type": "string", "description": "The flow's resource type", "example": "flow", - "enum": ["flow"] + "enum": [ + "flow" + ] }, "trigger": { "allOf": [ @@ -35674,13 +36397,17 @@ "type": "string", "description": "The trigger's resource type", "example": "trigger", - "enum": ["trigger"] + "enum": [ + "trigger" + ] }, "trigger_type": { "type": "string", "description": "The type of trigger selected for this flow", "example": "WORKFLOW_MANUAL_START", - "enum": ["WORKFLOW_MANUAL_START"] + "enum": [ + "WORKFLOW_MANUAL_START" + ] }, "scope": { "type": "array", @@ -35693,7 +36420,9 @@ "type": "string", "description": "The trigger scope's resource type", "example": "trigger_scope", - "enum": ["trigger_scope"] + "enum": [ + "trigger_scope" + ] }, "ref": { "type": "string", @@ -35708,7 +36437,9 @@ "type": "string", "description": "The type of the object", "example": "folder", - "enum": ["folder"] + "enum": [ + "folder" + ] }, "id": { "type": "string", @@ -35744,7 +36475,9 @@ "type": "string", "description": "The outcomes resource type", "example": "outcome", - "enum": ["outcome"] + "enum": [ + "outcome" + ] }, "name": { "type": "string", @@ -35804,7 +36537,9 @@ "type": "string", "description": "The outcomes resource type", "example": "outcome", - "enum": ["outcome"] + "enum": [ + "outcome" + ] }, "name": { "type": "string", @@ -35936,7 +36671,11 @@ "type": "object", "x-box-resource-id": "workflow--mini", "x-box-tag": "workflows", - "x-box-variants": ["mini", "standard", "full"], + "x-box-variants": [ + "mini", + "standard", + "full" + ], "x-box-variant": "mini", "description": "Box Relay Workflows are objects that represent a named collection of flows.\n\nYou application must be authorized to use the `Manage Box Relay` application\nscope within the developer console in order to use this resource.", "properties": { @@ -35949,7 +36688,9 @@ "type": "string", "description": "`workflow`", "example": "workflow", - "enum": ["workflow"] + "enum": [ + "workflow" + ] }, "name": { "type": "string", @@ -36076,7 +36817,10 @@ "type": "string", "description": "The type of this item", "example": "file", - "enum": ["file", "folder"] + "enum": [ + "file", + "folder" + ] }, "original_name": { "type": "string", @@ -36132,7 +36876,11 @@ "description": "The state of the archive being downloaded.", "default": "in_progress", "example": "succeeded", - "enum": ["in_progress", "failed", "succeeded"] + "enum": [ + "in_progress", + "failed", + "succeeded" + ] } } }, @@ -36141,7 +36889,10 @@ "type": "object", "x-box-resource-id": "sign_request--base", "x-box-tag": "sign_requests", - "x-box-variants": ["standard", "base"], + "x-box-variants": [ + "standard", + "base" + ], "x-box-variant": "base", "description": "A standard representation of a signature request object.", "properties": { @@ -36236,7 +36987,10 @@ "type": "object", "x-box-resource-id": "sign_request", "x-box-tag": "sign_requests", - "x-box-variants": ["standard", "base"], + "x-box-variants": [ + "standard", + "base" + ], "x-box-variant": "standard", "description": "A Box Sign request object.", "allOf": [ @@ -36248,7 +37002,9 @@ "type": { "type": "string", "example": "sign-request", - "enum": ["sign-request"], + "enum": [ + "sign-request" + ], "description": "object type" }, "source_files": { @@ -36541,13 +37297,17 @@ "title": "AI LLM endpoint params Google", "type": "object", "x-box-resource-id": "ai_llm_endpoint_params_google", - "required": ["type"], + "required": [ + "type" + ], "properties": { "type": { "type": "string", "description": "The type of the AI LLM endpoint params object for Google.\nThis parameter is **required**.", "example": "google_params", - "enum": ["google_params"], + "enum": [ + "google_params" + ], "nullable": false }, "temperature": { @@ -36555,21 +37315,24 @@ "description": "The temperature is used for sampling during response generation, which occurs when `top-P` and `top-K` are applied. \nTemperature controls the degree of randomness in token selection.", "example": 0, "minimum": 0, - "maximum": 2 + "maximum": 2, + "nullable": true }, "top_p": { "type": "number", "description": "`Top-P` changes how the model selects tokens for output. Tokens are selected from the most (see `top-K`) to least probable\nuntil the sum of their probabilities equals the `top-P` value.", "example": 1, "minimum": 0.1, - "maximum": 2 + "maximum": 2, + "nullable": true }, "top_k": { "type": "number", "description": "`Top-K` changes how the model selects tokens for output. A `top-K` of 1 means the next selected token is\nthe most probable among all tokens in the model's vocabulary (also called greedy decoding),\nwhile a `top-K` of 3 means that the next token is selected from among the three most probable tokens by using temperature.", "example": 1, "minimum": 0.1, - "maximum": 2 + "maximum": 2, + "nullable": true } }, "description": "AI LLM endpoint params Google object" @@ -36578,13 +37341,17 @@ "title": "AI LLM endpoint params OpenAI", "type": "object", "x-box-resource-id": "ai_llm_endpoint_params_openai", - "required": ["type"], + "required": [ + "type" + ], "properties": { "type": { "type": "string", "description": "The type of the AI LLM endpoint params object for OpenAI.\nThis parameter is **required**.", "example": "openai_params", - "enum": ["openai_params"], + "enum": [ + "openai_params" + ], "nullable": false }, "temperature": { @@ -36592,33 +37359,38 @@ "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, \nwhile lower values like 0.2 will make it more focused and deterministic. \nWe generally recommend altering this or `top_p` but not both.", "example": 0, "minimum": 0, - "maximum": 2 + "maximum": 2, + "nullable": true }, "top_p": { "type": "number", "example": 1, "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results \nof the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability \nmass are considered. We generally recommend altering this or temperature but not both.", "minimum": 0.1, - "maximum": 1 + "maximum": 1, + "nullable": true }, "frequency_penalty": { "type": "number", "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the \ntext so far, decreasing the model's likelihood to repeat the same line verbatim.", "minimum": -2, "maximum": 2, - "example": 1.5 + "example": 1.5, + "nullable": true }, "presence_penalty": { "type": "number", "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, \nincreasing the model's likelihood to talk about new topics.", "minimum": -2, "maximum": 2, - "example": 1.5 + "example": 1.5, + "nullable": true }, "stop": { "type": "string", "description": "Up to 4 sequences where the API will stop generating further tokens.", - "example": "<|im_end|>" + "example": "<|im_end|>", + "nullable": true } }, "description": "AI LLM endpoint params OpenAI object." @@ -36640,7 +37412,9 @@ "type": { "type": "string", "description": "The type of the item.", - "enum": ["file"], + "enum": [ + "file" + ], "example": "file" }, "name": { @@ -36678,11 +37452,17 @@ "title": "Completion rule variable", "type": "object", "description": "A completion\nrule object. Determines\nif an action should be completed\nby all or any assignees.", - "required": ["type", "variable_type", "variable_value"], + "required": [ + "type", + "variable_type", + "variable_value" + ], "properties": { "type": { "type": "string", - "enum": ["variable"], + "enum": [ + "variable" + ], "description": "Completion\nRule object type.\n", "example": "variable" }, @@ -36690,13 +37470,18 @@ "type": "string", "description": "Variable type\nfor the Completion\nRule object.\n", "example": "task_completion_rule", - "enum": ["task_completion_rule"] + "enum": [ + "task_completion_rule" + ] }, "variable_value": { "type": "string", "description": "Variable\nvalues for a completion\nrule.\n", "example": "all_assignees", - "enum": ["all_assignees", "any_assignees"] + "enum": [ + "all_assignees", + "any_assignees" + ] } } }, @@ -36704,11 +37489,17 @@ "title": "Collaborator variable", "type": "object", "description": "A collaborator\nobject. Allows to\nspecify a list of user\nID's that are affected\nby the workflow result.", - "required": ["type", "variable_type", "variable_value"], + "required": [ + "type", + "variable_type", + "variable_value" + ], "properties": { "type": { "type": "string", - "enum": ["variable"], + "enum": [ + "variable" + ], "description": "Collaborator\nobject type.\n", "example": "variable" }, @@ -36716,19 +37507,26 @@ "type": "string", "description": "Variable type \nfor the Collaborator\nobject.\n", "example": "user_list", - "enum": ["user_list"] + "enum": [ + "user_list" + ] }, "variable_value": { "type": "array", "description": "A list of user IDs.", "items": { "type": "object", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "description": "User variable used\nin workflow outcomes.", "properties": { "type": { "type": "string", - "enum": ["user"], + "enum": [ + "user" + ], "description": "The object type.", "example": "user" }, @@ -36791,12 +37589,19 @@ "type": "object", "x-box-resource-id": "event_source", "description": "The source file or folder that triggered an event in\nthe event stream.", - "required": ["item_type", "item_id", "item_name"], + "required": [ + "item_type", + "item_id", + "item_name" + ], "properties": { "item_type": { "type": "string", "nullable": false, - "enum": ["file", "folder"], + "enum": [ + "file", + "folder" + ], "description": "The type of the item that the event\nrepresents. Can be `file` or `folder`.\n", "example": "file" }, @@ -36854,7 +37659,11 @@ "type": "object", "x-box-resource-id": "app_item_event_source", "description": "The AppItem that triggered an event in the event stream.", - "required": ["id", "type", "app_item_type"], + "required": [ + "id", + "type", + "app_item_type" + ], "properties": { "id": { "type": "string", @@ -36864,7 +37673,9 @@ "type": { "type": "string", "nullable": false, - "enum": ["app_item"], + "enum": [ + "app_item" + ], "description": "The type of the source that this event represents. Can only be `app_item`.\n", "example": "app_item" }, @@ -36919,18 +37730,24 @@ "type": "string", "description": "`skill_card`", "example": "skill_card", - "enum": ["skill_card"] + "enum": [ + "skill_card" + ] }, "skill_card_type": { "type": "string", "description": "`keyword`", "example": "keyword", - "enum": ["keyword"] + "enum": [ + "keyword" + ] }, "skill_card_title": { "type": "object", "description": "The title of the card.", - "required": ["message"], + "required": [ + "message" + ], "properties": { "code": { "type": "string", @@ -36947,13 +37764,18 @@ "skill": { "type": "object", "description": "The service that applied this metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "service", "description": "`service`", - "enum": ["service"] + "enum": [ + "service" + ] }, "id": { "type": "string", @@ -36965,13 +37787,18 @@ "invocation": { "type": "object", "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "skill_invocation", "description": "`skill_invocation`", - "enum": ["skill_invocation"] + "enum": [ + "skill_invocation" + ] }, "id": { "type": "string", @@ -37017,7 +37844,9 @@ "properties": { "type": { "type": "string", - "enum": ["channel"], + "enum": [ + "channel" + ], "example": "channel", "description": "Type of the mapped item referenced in `id`", "nullable": false @@ -37041,7 +37870,10 @@ "nullable": true } }, - "required": ["id", "type"] + "required": [ + "id", + "type" + ] }, "IntegrationMappingBoxItemSlack": { "title": "Integration mapping Box item schema for type Slack", @@ -37050,7 +37882,9 @@ "properties": { "type": { "type": "string", - "enum": ["folder"], + "enum": [ + "folder" + ], "example": "folder", "description": "Type of the mapped item referenced in `id`", "nullable": false @@ -37062,13 +37896,18 @@ "nullable": false } }, - "required": ["id", "type"] + "required": [ + "id", + "type" + ] }, "Outcome": { "title": "Outcome", "type": "object", "description": "An instance of an outcome.", - "required": ["id"], + "required": [ + "id" + ], "properties": { "id": { "type": "string", @@ -37131,11 +37970,17 @@ "title": "Role variable", "type": "object", "description": "Determines if the\nworkflow outcome\naffects a specific\ncollaborator role.", - "required": ["type", "variable_type", "variable_value"], + "required": [ + "type", + "variable_type", + "variable_value" + ], "properties": { "type": { "type": "string", - "enum": ["variable"], + "enum": [ + "variable" + ], "description": "Role object type.\n", "example": "variable" }, @@ -37143,7 +37988,9 @@ "type": "string", "description": "The variable type used\nby the object.\n", "example": "collaborator_role", - "enum": ["collaborator_role"] + "enum": [ + "collaborator_role" + ] }, "variable_value": { "allOf": [ @@ -37192,18 +38039,24 @@ "type": "string", "description": "`skill_card`", "example": "skill_card", - "enum": ["skill_card"] + "enum": [ + "skill_card" + ] }, "skill_card_type": { "type": "string", "description": "`timeline`", "example": "timeline", - "enum": ["timeline"] + "enum": [ + "timeline" + ] }, "skill_card_title": { "type": "object", "description": "The title of the card.", - "required": ["message"], + "required": [ + "message" + ], "properties": { "code": { "type": "string", @@ -37220,13 +38073,18 @@ "skill": { "type": "object", "description": "The service that applied this metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "service", "description": "`service`", - "enum": ["service"] + "enum": [ + "service" + ] }, "id": { "type": "string", @@ -37238,13 +38096,18 @@ "invocation": { "type": "object", "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "skill_invocation", "description": "`skill_invocation`", - "enum": ["skill_invocation"] + "enum": [ + "skill_invocation" + ] }, "id": { "type": "string", @@ -37273,7 +38136,10 @@ "appears": { "type": "array", "description": "Defines a list of timestamps for when this item should appear on the\ntimeline.", - "required": ["start", "end"], + "required": [ + "start", + "end" + ], "items": { "type": "object", "description": "The timestamp for an entry.", @@ -37325,18 +38191,24 @@ "type": "string", "description": "`skill_card`", "example": "skill_card", - "enum": ["skill_card"] + "enum": [ + "skill_card" + ] }, "skill_card_type": { "type": "string", "description": "`transcript`", "example": "transcript", - "enum": ["transcript"] + "enum": [ + "transcript" + ] }, "skill_card_title": { "type": "object", "description": "The title of the card.", - "required": ["message"], + "required": [ + "message" + ], "properties": { "code": { "type": "string", @@ -37353,13 +38225,18 @@ "skill": { "type": "object", "description": "The service that applied this metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "service", "description": "`service`", - "enum": ["service"] + "enum": [ + "service" + ] }, "id": { "type": "string", @@ -37371,13 +38248,18 @@ "invocation": { "type": "object", "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "skill_invocation", "description": "`skill_invocation`", - "enum": ["skill_invocation"] + "enum": [ + "skill_invocation" + ] }, "id": { "type": "string", @@ -37406,7 +38288,9 @@ "appears": { "type": "array", "description": "Defines when a transcribed bit of text appears. This only includes a\nstart time and no end time.", - "required": ["start"], + "required": [ + "start" + ], "items": { "type": "object", "description": "The timestamp for an entry.", @@ -37448,18 +38332,24 @@ "type": "string", "description": "`skill_card`", "example": "skill_card", - "enum": ["skill_card"] + "enum": [ + "skill_card" + ] }, "skill_card_type": { "type": "string", "description": "`status`", "example": "status", - "enum": ["status"] + "enum": [ + "status" + ] }, "skill_card_title": { "type": "object", "description": "The title of the card.", - "required": ["message"], + "required": [ + "message" + ], "properties": { "code": { "type": "string", @@ -37476,7 +38366,9 @@ "status": { "type": "object", "description": "Sets the status of the skill. This can be used to show a message to the user while the Skill is processing the data, or if it was not able to process the file.", - "required": ["code"], + "required": [ + "code" + ], "properties": { "code": { "type": "string", @@ -37500,13 +38392,18 @@ "skill": { "type": "object", "description": "The service that applied this metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "service", "description": "`service`", - "enum": ["service"] + "enum": [ + "service" + ] }, "id": { "type": "string", @@ -37518,13 +38415,18 @@ "invocation": { "type": "object", "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata.", - "required": ["type", "id"], + "required": [ + "type", + "id" + ], "properties": { "type": { "type": "string", "example": "skill_invocation", "description": "`skill_invocation`", - "enum": ["skill_invocation"] + "enum": [ + "skill_invocation" + ] }, "id": { "type": "string", @@ -37548,7 +38450,11 @@ }, "role": { "type": "string", - "enum": ["signer", "approver", "final_copy_reader"], + "enum": [ + "signer", + "approver", + "final_copy_reader" + ], "description": "Defines the role of the signer in the signature request. A `signer`\nmust sign the document and an `approver` must approve the document. A\n`final_copy_reader` only receives the final signed document and signing\nlog.", "example": "signer", "default": "signer" @@ -37651,7 +38557,9 @@ "title": "Sign Request Signer Input", "type": "object", "description": "Input created by a Signer on a Sign Request", - "required": ["page_index"], + "required": [ + "page_index" + ], "allOf": [ { "$ref": "#/components/schemas/SignRequestPrefillTag" @@ -37711,7 +38619,9 @@ "title": "Signer fields for Box Sign request response", "type": "object", "description": "The schema for a Signer object used\non the body of a Box Sign request object.", - "required": ["email"], + "required": [ + "email" + ], "allOf": [ { "$ref": "#/components/schemas/SignRequestCreateSigner" @@ -37729,7 +38639,10 @@ "properties": { "type": { "type": "string", - "enum": ["signed", "declined"], + "enum": [ + "signed", + "declined" + ], "example": "signed", "description": "Type of decision made by the signer." }, @@ -37813,7 +38726,9 @@ "type": "string", "description": "`tracking_code`", "example": "tracking_code", - "enum": ["tracking_code"] + "enum": [ + "tracking_code" + ] }, "name": { "type": "string", @@ -37838,7 +38753,11 @@ "description": "Specifies the scope of the template to filter search results by.\n\nThis will be `enterprise_{enterprise_id}` for templates defined\nfor use in this enterprise, and `global` for general templates\nthat are available to all enterprises using Box.", "type": "string", "example": "enterprise", - "enum": ["global", "enterprise", "enterprise_{enterprise_id}"] + "enum": [ + "global", + "enterprise", + "enterprise_{enterprise_id}" + ] }, "templateKey": { "description": "The key of the template used to filter search results.\n\nIn many cases the template key is automatically derived\nof its display name, for example `Contract Template` would\nbecome `contractTemplate`. In some cases the creator of the\ntemplate will have provided its own template key.\n\nPlease [list the templates for an enterprise][list], or\nget all instances on a [file][file] or [folder][folder]\nto inspect a template's key.\n\n[list]: e://get-metadata-templates-enterprise\n[file]: e://get-files-id-metadata\n[folder]: e://get-folders-id-metadata", @@ -37868,7 +38787,10 @@ "type": "string" }, "description": "Specifies the values to match for a `multiSelect` metadata\nfield. When performing a search, the query will essentially\nperform an `OR` operation to match any template where any of\nthe provided values match this field.", - "example": ["online", "enterprise"] + "example": [ + "online", + "enterprise" + ] }, { "$ref": "#/components/schemas/MetadataFieldFilterFloatRange"