From f5acceb3cf6292fd1a09e2da6ca790d3c35c3f25 Mon Sep 17 00:00:00 2001 From: Barbara Czyz Date: Thu, 22 Feb 2024 09:44:53 +0100 Subject: [PATCH] docs: New resource tests --- openapi.json | 930 ++++++++++++++++++++++++--------------------------- 1 file changed, 441 insertions(+), 489 deletions(-) diff --git a/openapi.json b/openapi.json index c2834a75..77134cd7 100644 --- a/openapi.json +++ b/openapi.json @@ -87,7 +87,7 @@ }, { "name": "scope", - "description": "A comma-separated list of application scopes you'd like to\nauthenticate the user for. This defaults to all the scopes configured\nfor the application in its configuration page.", + "description": "A space-separated list of application scopes you'd like to\nauthenticate the user for. This defaults to all the scopes configured\nfor the application in its configuration page.", "in": "query", "example": "admin_readwrite", "required": false, @@ -3363,11 +3363,19 @@ "content": { "application/json-patch+json": { "schema": { + "required": [ + "items" + ], "description": "A list containing the one change to make, to\nupdate the classification label.", "type": "array", "items": { "type": "object", "description": "The operation to perform on the classification\nmetadata template instance. In this case, it use\nused to replace the value stored for the\n`Box__Security__Classification__Key` field with a new\nvalue.", + "required": [ + "op", + "path", + "value" + ], "properties": { "op": { "type": "string", @@ -3380,7 +3388,7 @@ "path": { "type": "string", "example": "/Box__Security__Classification__Key", - "description": "`/Box__Security__Classification__Key`", + "description": "Defines classifications \navailable in the enterprise.", "enum": [ "/Box__Security__Classification__Key" ] @@ -3660,11 +3668,17 @@ "name": "Aaron Levie" }, "additionalProperties": { - "type": "string", - "description": "A value for each of the fields that are present on the metadata\ntemplate.\n\nFor the `global.properties` template this can be an a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored on the template.", - "example": "Aaron Levie", - "x-box-example-key": "name" - } + "allOf": [ + {}, + { + "example": "Aaron Levie" + }, + { + "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template." + } + ] + }, + "x-box-example-key": "name" } } } @@ -3675,7 +3689,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Metadata" + "$ref": "#/components/schemas/Metadata--Full" } } } @@ -3818,7 +3832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Metadata" + "$ref": "#/components/schemas/Metadata--Full" } } } @@ -4809,7 +4823,7 @@ "x-box-tag": "folders", "x-box-enable-explorer": true, "x-box-sanitized": true, - "description": "Retrieves details for a folder, including the first 100 entries\nin the folder.\n\nPassing `sort`, `direction`, `offset`, and `limit`\nparameters in query allows you to manage the\nlist of returned\n[folder items](r://folder--full#param-item-collection).\n\nTo fetch more items within the folder, use the\n[Get items in a folder](#get-folders-id-items) endpoint.", + "description": "Retrieves details for a folder, including the first 100 entries\nin the folder.\n\nPassing `sort`, `direction`, `offset`, and `limit`\nparameters in query allows you to manage the\nlist of returned\n[folder items](r://folder--full#param-item-collection).\n\nTo fetch more items within the folder, use the\n[Get items in a folder](e://get-folders-id-items) endpoint.", "parameters": [ { "name": "folder_id", @@ -4917,7 +4931,7 @@ ], "responses": { "200": { - "description": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items in a folder](#get-folders-id-items) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", + "description": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items in a folder](e://get-folders-id-items)) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "content": { "application/json": { "schema": { @@ -6460,11 +6474,19 @@ "content": { "application/json-patch+json": { "schema": { + "required": [ + "items" + ], "description": "A list containing the one change to make, to\nupdate the classification label.", "type": "array", "items": { "type": "object", "description": "The operation to perform on the classification\nmetadata template instance. In this case, it use\nused to replace the value stored for the\n`Box__Security__Classification__Key` field with a new\nvalue.", + "required": [ + "op", + "path", + "value" + ], "properties": { "op": { "type": "string", @@ -6477,7 +6499,7 @@ "path": { "type": "string", "example": "/Box__Security__Classification__Key", - "description": "`/Box__Security__Classification__Key`", + "description": "Defines classifications \navailable in the enterprise.", "enum": [ "/Box__Security__Classification__Key" ] @@ -6761,11 +6783,17 @@ "name": "Aaron Levie" }, "additionalProperties": { - "type": "string", - "description": "A value for each of the fields that are present on the metadata\ntemplate.\n\nFor the `global.properties` template this can be an a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored on the template.", - "example": "Aaron Levie", - "x-box-example-key": "name" - } + "allOf": [ + {}, + { + "example": "Aaron Levie" + }, + { + "description": "A value for each of the fields that are present on the metadata\ntemplate.\nFor the `global.properties` template this can be a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored in the template." + } + ] + }, + "x-box-example-key": "name" } } } @@ -6776,7 +6804,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Metadata" + "$ref": "#/components/schemas/Metadata--Full" } } } @@ -6920,7 +6948,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Metadata" + "$ref": "#/components/schemas/Metadata--Full" } } } @@ -7728,31 +7756,6 @@ } } } - }, - "delete": { - "operationId": "delete_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema", - "summary": "Delete all classifications", - "tags": [ - "Classifications" - ], - "x-box-tag": "classifications", - "x-box-sanitized": true, - "description": "Delete all classifications by deleting the classification\nmetadata template.", - "responses": { - "204": { - "description": "Returns an empty response when the metadata\ntemplate for classifications is successfully deleted." - }, - "default": { - "description": "An unexpected client error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - } - } } }, "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add": { @@ -7763,12 +7766,14 @@ "Classifications" ], "x-box-tag": "classifications", - "x-box-sanitized": true, "description": "Adds one or more new classifications to the list of classifications\navailable to the enterprise.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.", "requestBody": { "content": { - "application/json-patch+json": { + "application/json": { "schema": { + "required": [ + "items" + ], "description": "An array that contains one or more classifications to add to\nthe enterprise's list of classifications.", "type": "array", "items": { @@ -7783,38 +7788,51 @@ "op": { "type": "string", "example": "addEnumOption", - "description": "`addEnumOption`" + "description": "The type of change to perform on the classification\nobject.", + "enum": [ + "addEnumOption" + ] }, "fieldKey": { "type": "string", "example": "Box__Security__Classification__Key", - "description": "`Box__Security__Classification__Key`" + "description": "Defines classifications \navailable in the enterprise.", + "enum": [ + "Box__Security__Classification__Key" + ] }, "data": { "type": "object", - "description": "The details of the classification to add.", "required": [ "key" ], + "description": "The details of the classification to add.", "properties": { "key": { "type": "string", "example": "Sensitive", "description": "The label of the classification as shown in the web and\nmobile interfaces. This is the only field required to\nadd a classification." }, - "classification": { + "staticConfig": { "type": "object", - "description": "Additional details for the classification.", + "description": "A static configuration for the classification.", "properties": { - "classificationDefinition": { - "type": "string", - "example": "Sensitive information that must not be shared.", - "description": "A longer description of the classification." - }, - "colorID": { - "type": "number", - "example": 4, - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray" + "classification": { + "type": "object", + "description": "Additional details for the classification.", + "properties": { + "classificationDefinition": { + "type": "string", + "example": "Sensitive information that must not be shared.", + "description": "A longer description of the classification." + }, + "colorID": { + "type": "integer", + "format": "int64", + "example": 4, + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray" + } + } } } } @@ -7886,6 +7904,9 @@ "schema": { "description": "An array that contains one or more classifications to update.", "type": "array", + "required": [ + "items" + ], "items": { "type": "object", "description": "A single classification to update.", @@ -7899,12 +7920,18 @@ "op": { "type": "string", "example": "editEnumOption", - "description": "`editEnumOption`" + "description": "The type of change to perform on the classification\nobject.", + "enum": [ + "editEnumOption" + ] }, "fieldKey": { "type": "string", "example": "Box__Security__Classification__Key", - "description": "`Box__Security__Classification__Key`" + "description": "Defines classifications \navailable in the enterprise.", + "enum": [ + "Box__Security__Classification__Key" + ] }, "enumOptionKey": { "type": "string", @@ -7913,29 +7940,36 @@ }, "data": { "type": "object", - "description": "The details of the updated classification.", "required": [ "key" ], + "description": "The details of the updated classification.", "properties": { "key": { "type": "string", "example": "Very Sensitive", "description": "A new label for the classification, as it will be\nshown in the web and mobile interfaces." }, - "classification": { + "staticConfig": { "type": "object", - "description": "Additional details for the classification.", + "description": "A static configuration for the classification.", "properties": { - "classificationDefinition": { - "type": "string", - "example": "Sensitive information that must not be shared.", - "description": "A longer description of the classification." - }, - "colorID": { - "type": "number", - "example": 4, - "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray" + "classification": { + "type": "object", + "description": "Additional details for the classification.", + "properties": { + "classificationDefinition": { + "type": "string", + "example": "Sensitive information that must not be shared.", + "description": "A longer description of the classification." + }, + "colorID": { + "type": "integer", + "format": "int64", + "example": 4, + "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray" + } + } } } } @@ -7991,96 +8025,6 @@ } } }, - "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete": { - "put": { - "operationId": "put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#delete", - "summary": "Delete classification", - "tags": [ - "Classifications" - ], - "x-box-tag": "classifications", - "x-box-sanitized": true, - "description": "Removes a classification from the list of classifications\navailable to the enterprise.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "description": "An array that contains one or more classifications to remove.", - "type": "array", - "items": { - "type": "object", - "description": "A single classification to remove.", - "required": [ - "op", - "fieldKey", - "enumOptionKey" - ], - "properties": { - "op": { - "type": "string", - "example": "removeEnumOption", - "description": "`removeEnumOption`" - }, - "fieldKey": { - "type": "string", - "example": "Box__Security__Classification__Key", - "description": "`Box__Security__Classification__Key`" - }, - "enumOptionKey": { - "type": "string", - "example": "Sensitive", - "description": "The label of the classification to remove." - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Returns the updated `securityClassification` metadata template, which\ncontains a `Box__Security__Classification__Key` field that lists all\nthe classifications available to this enterprise.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClassificationTemplate" - } - } - } - }, - "400": { - "description": "Returned if any of the request parameters are not valid.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - }, - "404": { - "description": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - }, - "default": { - "description": "An unexpected client error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - } - } - } - }, "/metadata_templates/{scope}/{template_key}/schema": { "get": { "operationId": "get_metadata_templates_id_id_schema", @@ -8236,9 +8180,15 @@ "name": "Aaron Levie" }, "additionalProperties": { - "type": "string", - "description": "The value of a custom data entry.", - "example": "Aaron Levie", + "allOf": [ + {}, + { + "example": "Aaron Levie" + }, + { + "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template." + } + ], "x-box-example-key": "name" } }, @@ -8802,7 +8752,9 @@ "type": "object", "required": [ "scope", - "displayName" + "displayName", + "fields", + "templateKey" ], "properties": { "scope": { @@ -8816,14 +8768,14 @@ "templateKey": { "type": "string", "example": "securityClassification-6VMVochwUWo", - "description": "`securityClassification-6VMVochwUWo`", + "description": "Defines the list of metadata templates.", "enum": [ "securityClassification-6VMVochwUWo" ] }, "displayName": { "type": "string", - "description": "`Classification`", + "description": "The name of the\ntemplate as shown in web and mobile interfaces.", "example": "Classification", "enum": [ "Classification" @@ -8832,24 +8784,30 @@ "hidden": { "type": "boolean", "example": false, - "description": "`false`" + "description": "Determines if the classification template is\nhidden or available on web and mobile\ndevices." }, "copyInstanceOnItemCopy": { "type": "boolean", "example": false, - "description": "`false`" + "description": "Determines if classifications are\ncopied along when the file or folder is\ncopied." }, "fields": { "type": "array", - "description": "The classification template holds one field, which holds\nall the valid classification values.", + "description": "The classification template requires exactly\none field, which holds\nall the valid classification values.", "items": { + "required": [ + "type", + "key", + "displayName", + "options" + ], "type": "object", "description": "The `enum` field which holds all the valid classification\nvalues.", "properties": { "type": { "type": "string", "example": "enum", - "description": "`enum`", + "description": "The type of the field\nthat is always enum.", "enum": [ "enum" ] @@ -8857,7 +8815,7 @@ "key": { "type": "string", "example": "Box__Security__Classification__Key", - "description": "`Box__Security__Classification__Key`", + "description": "Defines classifications \navailable in the enterprise.", "enum": [ "Box__Security__Classification__Key" ] @@ -8865,7 +8823,7 @@ "displayName": { "type": "string", "example": "Classification", - "description": "`Classification`", + "description": "A display name for the classification.", "enum": [ "Classification" ] @@ -8873,12 +8831,15 @@ "hidden": { "type": "boolean", "example": false, - "description": "`false`" + "description": "Determines if the classification\ntemplate is\nhidden or available on\nweb and mobile\ndevices." }, "options": { "type": "array", "description": "The actual list of classifications that are present on\nthis template.", "items": { + "required": [ + "key" + ], "type": "object", "description": "An individual classification.", "properties": { @@ -8901,7 +8862,8 @@ "description": "A longer description of the classification." }, "colorID": { - "type": "number", + "type": "integer", + "format": "int64", "example": 4, "description": "An identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may\nchange without notice. Currently, the color\nmappings are as follows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray" } @@ -9417,87 +9379,6 @@ } } }, - "/metadata_query_indices": { - "get": { - "operationId": "get_metadata_query_indices", - "summary": "List metadata query indices", - "tags": [ - "Search" - ], - "x-box-tag": "search", - "x-box-sanitized": true, - "x-box-enable-explorer": true, - "description": "Retrieves the metadata query indices for a given scope and template key.", - "parameters": [ - { - "name": "scope", - "description": "The scope of the metadata template", - "example": "global", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "global", - "enterprise" - ] - } - }, - { - "name": "template_key", - "description": "The name of the metadata template", - "example": "properties", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Returns a collection of metadata query indices for scope and template key.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MetadataQueryIndices" - } - } - } - }, - "400": { - "description": "Returns an error when any of the parameters are not in a valid format.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - }, - "404": { - "description": "Returns an error when the scope and template combination cannot be found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - }, - "default": { - "description": "An unexpected client error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClientError" - } - } - } - } - } - } - }, "/comments/{comment_id}": { "get": { "operationId": "get_comments_id", @@ -9758,7 +9639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Comment" + "$ref": "#/components/schemas/Comment--Full" } } } @@ -14440,7 +14321,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/User--Full" } } } @@ -14516,7 +14397,7 @@ "operationId": "post_users_terminate_sessions", "summary": "Create jobs to terminate users session", "tags": [ - "Users" + "Session termination" ], "x-box-tag": "session_termination", "description": "Validates the roles and permissions of the user,\nand creates asynchronous jobs\nto terminate the user's sessions.\nReturns the status for the POST request.", @@ -15857,7 +15738,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Group" + "$ref": "#/components/schemas/Group--Full" } } } @@ -15890,7 +15771,7 @@ "operationId": "post_groups_terminate_sessions", "summary": "Create jobs to terminate user group session", "tags": [ - "Groups" + "Session termination" ], "x-box-tag": "session_termination", "description": "Validates the roles and permissions of the group,\nand creates asynchronous jobs\nto terminate the group's sessions.\nReturns the status for the POST request.", @@ -18050,10 +17931,19 @@ ] }, "retention_length": { - "type": "string", - "format": "int32", + "oneOf": [ + { + "type": "string", + "format": "int32", + "nullable": true + }, + { + "type": "number", + "format": "int32", + "nullable": false + } + ], "example": "365", - "minimum": 1, "description": "The length of the retention policy. This value\nspecifies the duration in days that the retention\npolicy will be active for after being assigned to\ncontent. If the policy has a `policy_type` of\n`indefinite`, the `retention_length` will also be\n`indefinite`." }, "retention_type": { @@ -18264,8 +18154,18 @@ "description": "Specifies the retention type:\n\n* `modifiable`: You can modify the retention policy. For example,\nyou can add or remove folders, shorten or lengthen\nthe policy duration, or delete the assignment.\nUse this type if your retention policy\nis not related to any regulatory purposes.\n* `non-modifiable`: You can modify the retention policy\nonly in a limited way: add a folder, lengthen the duration,\nretire the policy, change the disposition action\nor notification settings. You cannot perform other actions,\nsuch as deleting the assignment or shortening the\npolicy duration. Use this type to ensure\ncompliance with regulatory retention policies.\n\nWhen updating a retention policy, you can use\n`non-modifiable` type only. You can convert a\n`modifiable` policy to `non-modifiable`, but\nnot the other way around." }, "retention_length": { - "type": "string", - "format": "int32", + "oneOf": [ + { + "type": "string", + "format": "int32", + "nullable": true + }, + { + "type": "number", + "format": "int32", + "nullable": false + } + ], "example": "365", "description": "The length of the retention policy. This value\nspecifies the duration in days that the retention\npolicy will be active for after being assigned to\ncontent. If the policy has a `policy_type` of\n`indefinite`, the `retention_length` will also be\n`indefinite`." }, @@ -21585,7 +21485,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Task" + "$ref": "#/components/schemas/TermsOfService" } } } @@ -22338,7 +22238,7 @@ "operationId": "get_storage_policies", "summary": "List storage policies", "tags": [ - "Storage policies" + "Standard and Zones Storage Policies" ], "x-box-tag": "storage_policies", "description": "Fetches all the storage policies in the enterprise.", @@ -22413,7 +22313,7 @@ "operationId": "get_storage_policies_id", "summary": "Get storage policy", "tags": [ - "Storage policies" + "Standard and Zones Storage Policies" ], "x-box-tag": "storage_policies", "description": "Fetches a specific storage policy.", @@ -22458,7 +22358,7 @@ "operationId": "get_storage_policy_assignments", "summary": "List storage policy assignments", "tags": [ - "Storage policy assignments" + "Standard and Zones Storage Policy Assignments" ], "x-box-tag": "storage_policy_assignments", "description": "Fetches all the storage policy assignment for an enterprise or user.", @@ -22525,7 +22425,7 @@ "operationId": "post_storage_policy_assignments", "summary": "Assign storage policy", "tags": [ - "Storage policy assignments" + "Standard and Zones Storage Policy Assignments" ], "x-box-tag": "storage_policy_assignments", "description": "Creates a storage policy assignment for an enterprise or user.", @@ -22620,7 +22520,7 @@ "operationId": "get_storage_policy_assignments_id", "summary": "Get storage policy assignment", "tags": [ - "Storage policy assignments" + "Standard and Zones Storage Policy Assignments" ], "x-box-tag": "storage_policy_assignments", "description": "Fetches a specific storage policy assignment.", @@ -22663,7 +22563,7 @@ "operationId": "put_storage_policy_assignments_id", "summary": "Update storage policy assignment", "tags": [ - "Storage policy assignments" + "Standard and Zones Storage Policy Assignments" ], "x-box-tag": "storage_policy_assignments", "description": "Updates a specific storage policy assignment.", @@ -22743,7 +22643,7 @@ "operationId": "delete_storage_policy_assignments_id", "summary": "Unassign storage policy", "tags": [ - "Storage policy assignments" + "Standard and Zones Storage Policy Assignments" ], "x-box-tag": "storage_policy_assignments", "description": "Delete a storage policy assignment.\n\nDeleting a storage policy assignment on a user\nwill have the user inherit the enterprise's default\nstorage policy.\n\nThere is a rate limit for calling this endpoint of only\ntwice per user in a 24 hour time frame.", @@ -23039,7 +22939,7 @@ "operationId": "post_sign_requests_id_cancel", "summary": "Cancel sign request", "tags": [ - "Box Sign" + "Sign requests" ], "x-box-tag": "sign_requests", "description": "Cancels a sign request.", @@ -23094,7 +22994,7 @@ "operationId": "post_sign_requests_id_resend", "summary": "Resend sign request", "tags": [ - "Box Sign" + "Sign requests" ], "x-box-tag": "sign_requests", "description": "Resends a sign request email to all outstanding signers.", @@ -23142,7 +23042,7 @@ "operationId": "get_sign_requests_id", "summary": "Get sign request by ID", "tags": [ - "Box Sign" + "Sign requests" ], "x-box-tag": "sign_requests", "description": "Gets a sign request by ID.", @@ -23197,7 +23097,7 @@ "operationId": "get_sign_requests", "summary": "List sign requests", "tags": [ - "Box Sign" + "Sign requests" ], "x-box-tag": "sign_requests", "description": "Gets sign requests created by a user. If the `sign_files` and/or\n`parent_folder` are deleted, the sign request will not return in the list.", @@ -23252,7 +23152,7 @@ "operationId": "post_sign_requests", "summary": "Create sign request", "tags": [ - "Box Sign" + "Sign requests" ], "x-box-tag": "sign_requests", "description": "Creates a sign request. This involves preparing a document for signing and\nsending the sign request to signers.", @@ -23571,7 +23471,7 @@ "operationId": "get_sign_templates", "summary": "List Box Sign templates", "tags": [ - "templates" + "Sign templates" ], "x-box-tag": "sign_templates", "description": "Gets Box Sign templates created by a user.", @@ -23638,7 +23538,7 @@ "operationId": "get_sign_templates_id", "summary": "Get Box Sign template by ID", "tags": [ - "templates" + "Sign templates" ], "x-box-tag": "sign_templates", "description": "Fetches details of a specific Box Sign template.", @@ -23703,7 +23603,7 @@ "operationId": "get_integration_mappings_slack", "summary": "List Slack integration mappings", "tags": [ - "integrationMappingsSlack" + "Integration mappings" ], "x-box-tag": "integration_mappings", "description": "Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise.\n\nYou need Admin or Co-Admin role to\nuse this endpoint.", @@ -23834,8 +23734,7 @@ "operationId": "post_integration_mappings_slack", "summary": "Create Slack integration mapping", "tags": [ - "integrationMappingsSlack", - "post_integration_mappings_slack" + "Integration mappings" ], "x-box-tag": "integration_mappings", "description": "Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)\nby mapping a Slack channel to a Box item.\n\nYou need Admin or Co-Admin role to\nuse this endpoint.", @@ -23897,7 +23796,7 @@ "operationId": "put_integration_mappings_slack_id", "summary": "Update Slack integration mapping", "tags": [ - "integrationMappingsSlack" + "Integration mappings" ], "x-box-tag": "integration_mappings", "description": "Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).\nSupports updating the Box folder ID and options.\n\nYou need Admin or Co-Admin role to\nuse this endpoint.", @@ -23988,7 +23887,7 @@ "operationId": "delete_integration_mappings_slack_id", "summary": "Delete Slack integration mapping", "tags": [ - "integrationMappingsSlack" + "Integration mappings" ], "x-box-tag": "integration_mappings", "description": "Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).\n\n\nYou need Admin or Co-Admin role to\nuse this endpoint.", @@ -24257,7 +24156,7 @@ "example": "file", "enum": [ "file", - "folder." + "folder" ] }, "id": { @@ -24487,6 +24386,16 @@ "$ref": "#/components/schemas/SignRequestCreateSigner" }, "description": "Array of signers for the sign request. 35 is the max number of signers permitted." + }, + "parent_folder": { + "allOf": [ + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "description": "The destination folder to place final, signed document and signing\nlog. Only `ID` and `type` fields are required. The root folder,\nfolder ID `0`, cannot be used and can also not be null.\n\nWhen this value is not passed in when the signature request, then\nwe will use a default folder which is either the parent folder of\nthe first source file in the payload if we have the permission to\nupload to that folder or a folder called \"My Sign Requests\"." + } + ] } } } @@ -25034,7 +24943,7 @@ "type": "array", "description": "The permissions that this access token permits,\nproviding a list of resources (files, folders, etc)\nand the scopes permitted for each of those resources.", "items": { - "$ref": "#/components/schemas/FileScope" + "$ref": "#/components/schemas/FileOrFolderScope" } }, "refresh_token": { @@ -25113,7 +25022,12 @@ "x-box-tag": "classifications", "description": "A metadata template that holds the security classifications\ndefined by an enterprise.", "required": [ - "type" + "id", + "type", + "scope", + "displayName", + "fields", + "templateKey" ], "properties": { "id": { @@ -25154,12 +25068,12 @@ "hidden": { "type": "boolean", "example": false, - "description": "This template is always available in web and mobile interfaces." + "description": "Determines if the\ntemplate is always available in web and mobile interfaces." }, "copyInstanceOnItemCopy": { "type": "boolean", "example": true, - "description": "Classifications are always copied along when the file or folder is\ncopied." + "description": "Determines if \nclassifications are\ncopied along when the file or folder is\ncopied." }, "fields": { "type": "array", @@ -25168,6 +25082,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" + ], "description": "The metadata template field that represents the available\nclassifications.", "properties": { "id": { @@ -25178,7 +25099,7 @@ "type": { "type": "string", "example": "enum", - "description": "`enum`", + "description": "The array item type.", "enum": [ "enum" ] @@ -25186,7 +25107,7 @@ "key": { "type": "string", "example": "Box__Security__Classification__Key", - "description": "`Box__Security__Classification__Key`", + "description": "Defines classifications \navailable in the enterprise.", "enum": [ "Box__Security__Classification__Key" ] @@ -25209,6 +25130,10 @@ "description": "A list of classifications available in this enterprise.", "minItems": 1, "items": { + "required": [ + "key", + "id" + ], "type": "object", "description": "A single classification available in this enterprise.", "properties": { @@ -25236,7 +25161,8 @@ "description": "A longer description of the classification." }, "colorID": { - "type": "number", + "type": "integer", + "format": "int64", "example": 4, "description": "An internal Box identifier used to assign a color to\na classification label.\n\nMapping between a `colorID` and a color may change\nwithout notice. Currently, the color mappings are as\nfollows.\n\n* `0`: Yellow\n* `1`: Orange\n* `2`: Watermelon red\n* `3`: Purple rain\n* `4`: Light blue\n* `5`: Dark blue\n* `6`: Light green\n* `7`: Gray" } @@ -25258,6 +25184,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" + ], "properties": { "id": { "type": "string", @@ -25619,16 +25549,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -25741,16 +25669,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -26007,7 +25933,7 @@ "type": "array", "description": "A list of comments", "items": { - "$ref": "#/components/schemas/Comment" + "$ref": "#/components/schemas/Comment--Full" } } } @@ -26447,6 +26373,9 @@ }, { "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/GenericSource" } ] }, @@ -26840,7 +26769,7 @@ "type": "array", "description": "A list of files", "items": { - "$ref": "#/components/schemas/File" + "$ref": "#/components/schemas/File--Full" } } } @@ -27112,7 +27041,7 @@ "type": "array", "description": "The permissions that this access token permits,\nproviding a list of resources (files, folders, etc)\nand the scopes permitted for each of those resources.", "items": { - "$ref": "#/components/schemas/FileScope" + "$ref": "#/components/schemas/FileOrFolderScope" } } } @@ -27507,6 +27436,8 @@ "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" @@ -27644,16 +27575,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -27910,7 +27839,7 @@ "type": "array", "description": "A list of file versions", "items": { - "$ref": "#/components/schemas/FileVersion" + "$ref": "#/components/schemas/FileVersion--Full" } } } @@ -27991,16 +27920,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -28101,16 +28028,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -28948,45 +28873,40 @@ "x-box-resource-id": "folder_locks", "x-box-tag": "folder_locks", "description": "A list of folder locks", - "allOf": [ - { - "type": "object", - "description": "The part of an API response that describes marker\nbased pagination", - "properties": { - "limit": { - "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", - "example": 1000, - "type": "integer", - "format": "int64" - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", - "nullable": true - } + "properties": { + "entries": { + "type": "array", + "description": "A list of folder locks", + "items": { + "$ref": "#/components/schemas/FolderLock" } }, - { - "properties": { - "entries": { - "type": "array", - "description": "A list of folder locks", - "items": { - "$ref": "#/components/schemas/FolderLock" - } - } - } + "limit": { + "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.", + "example": "1000", + "type": "string" + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", + "nullable": true } - ] + } + }, + "GenericSource": { + "title": "Generic source", + "type": "object", + "x-box-resource-id": "generic_source", + "description": "A generic event source type.", + "additionalProperties": { + "allOf": [ + {}, + { + "description": "A definition of a generic\nevent source object. The set of\nparameters depends on the\nobject type. For example, a Box Shield\nevent source would have the following\nset of parameters:\n```yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n {\n \"name\": \"8\",\n \"member_count\": 1\n },\n {\n \"name\": \"9\",\n \"member_count\": 1\n }\n ]\n} \n```\n" + } + ] + } }, "IntegrationMapping": { "title": "Integration mapping", @@ -29290,7 +29210,7 @@ "type": "array", "description": "A list of groups", "items": { - "$ref": "#/components/schemas/Group--Mini" + "$ref": "#/components/schemas/Group--Full" } } } @@ -29569,6 +29489,10 @@ "x-box-resource-id": "invite", "x-box-tag": "invites", "description": "An invite for a user to an enterprise.", + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -29696,13 +29620,13 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/File--Mini" + "$ref": "#/components/schemas/File--Full" }, { "$ref": "#/components/schemas/Folder--Mini" }, { - "$ref": "#/components/schemas/WebLink--Mini" + "$ref": "#/components/schemas/WebLink" } ] } @@ -29845,16 +29769,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -29883,6 +29805,10 @@ ], "x-box-variant": "mini", "description": "A mini legal hold policy", + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -30014,16 +29940,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -30034,7 +29958,7 @@ "type": "array", "description": "A list of legal hold\npolicy assignments", "items": { - "$ref": "#/components/schemas/LegalHoldPolicyAssignment--Base" + "$ref": "#/components/schemas/LegalHoldPolicyAssignment" } } } @@ -30092,8 +30016,15 @@ }, { "additionalProperties": { - "type": "string", - "example": "Aaron Levie", + "allOf": [ + {}, + { + "example": "Aaron Levie" + }, + { + "description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template." + } + ], "x-box-example-key": "name" } } @@ -30162,6 +30093,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" + ], "properties": { "id": { "type": "string", @@ -30216,12 +30151,8 @@ }, "scope": { "type": "string", - "example": "global", - "description": "The scope of the of the template that is cascaded down to the folder's\nchildren.", - "enum": [ - "global", - "enterprise_*" - ] + "description": "The scope of the metadata cascade policy can either be `global` or\n`enterprise_*`. The `global` scope is used for policies that are\navailable to any Box enterprise. The `enterprise_*` scope represents\npolicies that have been created within a specific enterprise, where `*`\nwill be the ID of that enterprise.", + "example": "enterprise_123456" }, "templateKey": { "type": "string", @@ -30249,16 +30180,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -30339,34 +30268,6 @@ } } }, - "MetadataQueryIndices": { - "title": "Metadata query indices", - "type": "object", - "x-box-tag": "search", - "x-box-resource-id": "metadata_query_indices", - "description": "A collection of metadata query indices.", - "properties": { - "entries": { - "description": "A collection of metadata query indices.", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetadataQueryIndex" - } - }, - "limit": { - "description": "The limit that was used for this request.", - "default": 100, - "example": 100, - "type": "integer", - "format": "int64" - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "example": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ..", - "type": "string" - } - } - }, "MetadataQueryResults": { "title": "Metadata query search results", "type": "object", @@ -30410,7 +30311,8 @@ "x-box-tag": "metadata_templates", "description": "A template for metadata that can be applied to files and folders", "required": [ - "type" + "type", + "id" ], "properties": { "id": { @@ -30596,16 +30498,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -30695,10 +30595,10 @@ { "oneOf": [ { - "$ref": "#/components/schemas/File" + "$ref": "#/components/schemas/File--Full" }, { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/Folder--Full" }, { "$ref": "#/components/schemas/WebLink" @@ -30791,7 +30691,7 @@ "description": "A list in which each entry represents a retention policy object.", "type": "array", "items": { - "$ref": "#/components/schemas/RetentionPolicy--Mini" + "$ref": "#/components/schemas/RetentionPolicy" } } } @@ -31038,6 +30938,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" + ], "properties": { "id": { "type": "string", @@ -31991,10 +31895,10 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/File" + "$ref": "#/components/schemas/File--Full" }, { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/Folder--Full" }, { "$ref": "#/components/schemas/WebLink" @@ -32079,10 +31983,10 @@ { "oneOf": [ { - "$ref": "#/components/schemas/File" + "$ref": "#/components/schemas/File--Full" }, { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/Folder--Full" }, { "$ref": "#/components/schemas/WebLink" @@ -32111,7 +32015,7 @@ "message": { "type": "string", "description": "The unique identifier for the termination job status", - "example": "Request is successful, please check the admin events for the status of the job" + "example": "Request is successful, please check the admin\nevents for the status of the job" } } }, @@ -32226,16 +32130,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -32264,6 +32166,10 @@ ], "x-box-variant": "mini", "description": "A mini description of a Storage Policy object", + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -32286,7 +32192,24 @@ "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" + ], "properties": { + "id": { + "type": "string", + "description": "The unique identifier for a storage policy assignment.", + "example": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw" + }, + "type": { + "type": "string", + "description": "`storage_policy_assignment`", + "example": "storage_policy_assignment", + "enum": [ + "storage_policy_assignment" + ] + }, "storage_policy": { "allOf": [ { @@ -32342,16 +32265,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -32707,6 +32628,10 @@ ], "x-box-variant": "base", "description": "The root-level record that is supposed to represent a\nsingle Terms of Service.", + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", @@ -32729,6 +32654,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" + ], "properties": { "id": { "type": "string", @@ -33116,6 +33045,12 @@ "description": "Order of the signer", "minimum": 0, "example": 2 + }, + "signer_group_id": { + "type": "string", + "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 Sign Requests created from it.", + "example": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7", + "nullable": true } } } @@ -33242,6 +33177,11 @@ "description": "The label field is used especially for text, attachment, radio, and checkbox type inputs.", "nullable": true, "example": "Legal name" + }, + "read_only": { + "type": "boolean", + "description": "Whether this input was defined as read-only(immutable by signers) or not", + "example": true } } } @@ -34983,17 +34923,17 @@ "small": { "type": "string", "description": "The location of a small-sized avatar.", - "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!7B6R5cZLmurEV_xB-KkycPk8Oi7oENUX2O_qUtIuO4342CG IldyCto9hqiQP7uxqYU5V2w63Ft4ln4UVVLDtDZu903OqzkflY2O-Lq00 ubA29xU-RJ6b_KzJEWRYgUhX1zEl3dzWo12g8eWRE2rStf123DF7AYahNqM 1BmLmviL_nODc7SDQHedTXPAjxURUAra5BvtLe7B05AizbNXdPlCNp-LNh _S-eZ_RjDXcGO-MkRWd_3BOMHnvjf450t5BfKoJ15WhEfiMlfXH1tmouHXrsC 66cT6-pzF9E40Iir_zThqSlrFxzP_xcmXzHapr_k-0E2qr2TXp4iC396TSlEw" + "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!7B6R5cZLmurEV_xB-KkycPk8Oi7oENUX2O_qUtIuO4342CG IldyCto9hqiQP7uxqYU5V2w63Ft4ln4UVVLDtDZu903OqzkflY2O-Lq00 ubA29xU-RJ6b_KzJEWRYgUhX1zEl3dzWo12g8eWRE2rStf123DF7AYahNqM 1BmLmviL_nODc7SDQHedTXPAjxURUAra5BvtLe7B05AizbNXdPlCNp-LNh _S-eZ_RjDXcGO-MkRWd_3BOMHnvjf450t5BfKoJ15WhEfiMlfXH1tmouHXrsC 66cT6-pzF9E40Iir_zThqSlrFxzP_xcmXzHapr_k-0E2qr2TXp4iC396TSlEw\n" }, "large": { "type": "string", "description": "The location of a large-sized avatar.", - "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks pac3kv01!lipGQlQQOtCTCoB6zCOArUjVWLFJtLr5tn6aOZMCybhRx0NNuFQbVI36nw jtEk5YjUUz1KVdVuvU2yDhu_ftK_bvxeKP1Ffrx9vKGVvJ-UJc1z32p6n2CmFzzpc gSoX4pnPhFgydAL-u9jDspXUGElr-htDG_HPMiE9DZjqDueOxXHy8xe22wbaPAheC ao1emv8r_fmufaUgSndeMYmyZj-KqOYsLBrBNgdeiK5tZmPOQggAEUmyQPkrd8W92TQ6sSlIp0r" + "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks\npac3kv01!lipGQlQQOtCTCoB6zCOArUjVWLFJtLr5tn6aOZMCybhRx0NNuFQbVI36nw\njtEk5YjUUz1KVdVuvU2yDhu_ftK_bvxeKP1Ffrx9vKGVvJ-UJc1z32p6n2CmFzzpc\ngSoX4pnPhFgydAL-u9jDspXUGElr-htDG_HPMiE9DZjqDueOxXHy8xe22wbaPAheC\nao1emv8r_fmufaUgSndeMYmyZj-KqOYsLBrBNgdeiK5tZmPOQggAEUmyQPkrd8W92TQ6sSlIp0r" }, "preview": { "type": "string", "description": "The location of the avatar preview.", - "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!8UcNPweOOAWj2DtHk_dCQB4wJpzyPkl7mT5nHj5ZdjY92ejYCBBZc95--403b29CW k-8hSo_uBjh5h9QG42Ihu-cOZ-816sej1kof3SOm5gjn7qjMAx89cHjUaNK-6XasRqSNboenjZ 04laZuV9vSH12BZGAYycIZvvQ5R66Go8xG5GTMARf2nBU84c4H_SL5iws-HeBS4oQJWOJh6FBl sSJDSTI74LGXqeZb3EY_As34VFC95F10uozoTOSubZmPYylPlaKXoKWk2f9wYQso1ZTN7sh-Gc 9Kp43zMLhArIWhok0Im6FlRAuWOQ03KYgL-k4L5EZp4Gw6B7uqVRwcBbsTwMIorWq1g" + "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks!\npac3kv01!8UcNPweOOAWj2DtHk_dCQB4wJpzyPkl7mT5nHj5ZdjY92ejYCBBZc95--403b29CW\nk-8hSo_uBjh5h9QG42Ihu-cOZ-816sej1kof3SOm5gjn7qjMAx89cHjUaNK-6XasRqSNboenjZ\n04laZuV9vSH12BZGAYycIZvvQ5R66Go8xG5GTMARf2nBU84c4H_SL5iws-HeBS4oQJWOJh6FBl\nsSJDSTI74LGXqeZb3EY_As34VFC95F10uozoTOSubZmPYylPlaKXoKWk2f9wYQso1ZTN7sh-Gc\n9Kp43zMLhArIWhok0Im6FlRAuWOQ03KYgL-k4L5EZp4Gw6B7uqVRwcBbsTwMIorWq1g" } } } @@ -35060,7 +35000,7 @@ "type": "array", "description": "A list of users", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/User--Full" } } } @@ -35491,16 +35431,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -36241,16 +36179,14 @@ }, "next_marker": { "description": "The marker for the start of the next page of results.", - "example": 3000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "type": "string", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", - "example": 1000, - "type": "integer", - "format": "int64", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "type": "string", "nullable": true } } @@ -36390,11 +36326,11 @@ "type": "string", "description": "The state of the archive being downloaded.", "default": "in_progress", - "example": "success", + "example": "succeeded", "enum": [ "in_progress", "failed", - "success" + "succeeded" ] } } @@ -36410,9 +36346,6 @@ ], "x-box-variant": "base", "description": "A request to create a sign request object", - "required": [ - "parent_folder" - ], "properties": { "is_document_preparation_needed": { "type": "boolean", @@ -36454,16 +36387,6 @@ "description": "Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.", "example": true }, - "parent_folder": { - "allOf": [ - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "description": "The destination folder to place final, signed document and signing\nlog. Only `ID` and `type` fields are required. The root folder,\nfolder ID `0`, cannot be used." - } - ] - }, "name": { "type": "string", "example": "name", @@ -36612,6 +36535,17 @@ "example": "2021-04-26T08:12:13.982Z", "description": "Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.", "nullable": true + }, + "parent_folder": { + "nullable": false, + "allOf": [ + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "description": "The destination folder to place final, signed document and signing\nlog.\n\nWhen this value was not passed in when the signature request was \ncreated, then we will use a default folder which is either the parent\nfolder of the first source file in the payload if we have the permission\nto upload to that folder or a folder called \"My Sign Requests\"." + } + ] } } } @@ -36655,14 +36589,14 @@ } ] }, - "FileScope": { - "title": "File scope", + "FileOrFolderScope": { + "title": "File or folder scope", "type": "object", - "description": "A relation between a file and the scopes for which the file can be accessed", + "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed", "properties": { "scope": { "type": "string", - "description": "The file scopes for the file access", + "description": "The scopes for the resource access", "example": "item_download", "enum": [ "annotation_edit", @@ -36682,10 +36616,17 @@ "object": { "allOf": [ { - "$ref": "#/components/schemas/File--Mini" + "oneOf": [ + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "$ref": "#/components/schemas/File--Mini" + } + ] }, { - "description": "The file for which the file can be accessed" + "description": "The file or folder resource" } ] } @@ -37447,6 +37388,12 @@ "description": "If set, the signer is required to enter the password before they are able\nto sign a document. This field is write only.", "example": "SecretPassword123", "nullable": true + }, + "signer_group_id": { + "type": "string", + "description": "If set, signers who have the same value will be assigned to the same input and to the same signer group.\nA signer group is not a Box Group. It is an entity that belongs to a Sign Request and can only be\nused/accessed within this Sign Request. A signer group is expected to have more than one signer.\nIf the provided value is only used for one signer, this value will be ignored and request will be handled\nas it was intended for an individual signer. The value provided can be any string and only used to\ndetermine which signers belongs to same group. A successful response will provide a generated UUID value\ninstead for signers in the same signer group.", + "example": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7", + "nullable": true } } }, @@ -37534,6 +37481,11 @@ "type": "integer", "description": "Index of page that the input is on", "example": 4 + }, + "read_only": { + "type": "boolean", + "description": "Whether this input was defined as read-only(immutable by signers) or not", + "example": true } } }