diff --git a/openapi.json b/openapi.json index b8c773b8..5dce086f 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "5132d100e1" + "x-box-commit-hash": "3191f398fb" }, "servers": [ { @@ -868,7 +868,7 @@ "delete": { "operationId": "delete_files_id", "summary": "Delete file", - "description": "Deletes a file, either permanently or by moving it to\nthe trash.\n\nThe the enterprise settings determine whether the item will\nbe permanently deleted from Box or moved to the trash.", + "description": "Deletes a file, either permanently or by moving it to\nthe trash.\n\nThe enterprise settings determine whether the item will\nbe permanently deleted from Box or moved to the trash.", "parameters": [ { "name": "file_id", @@ -3149,7 +3149,7 @@ "post": { "operationId": "post_files_id_versions_current", "summary": "Promote file version", - "description": "Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to\npromote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the\ntop of the versions history. The file will have the exact same contents\nas the older version, with the the same hash digest, `etag`, and\nname as the original.\n\nOther properties such as comments do not get updated to their\nformer values.\n\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar.", + "description": "Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to\npromote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the\ntop of the versions history. The file will have the exact same contents\nas the older version, with the same hash digest, `etag`, and\nname as the original.\n\nOther properties such as comments do not get updated to their\nformer values.\n\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar.", "parameters": [ { "name": "file_id", @@ -10270,7 +10270,7 @@ ] }, "is_access_only": { - "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the the path to the root folder for the\nshared item.", + "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the path to the root folder for the\nshared item.", "type": "boolean", "example": true }, @@ -10385,7 +10385,7 @@ { "name": "created_at_range", "in": "query", - "description": "Limits the search results to any items created within\na given date range.\n\nDate ranges are defined as comma separated RFC3339\ntimestamps.\n\nIf the the start date is omitted (`,2014-05-17T13:35:01-07:00`)\nanything created before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00,`) the\ncurrent date will be used as the end date instead.", + "description": "Limits the search results to any items created within\na given date range.\n\nDate ranges are defined as comma separated RFC3339\ntimestamps.\n\nIf the start date is omitted (`,2014-05-17T13:35:01-07:00`)\nanything created before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00,`) the\ncurrent date will be used as the end date instead.", "required": false, "schema": { "type": "array", @@ -10545,7 +10545,7 @@ { "name": "mdfilters", "in": "query", - "description": "Limits the search results to any items for which the metadata matches the provided filter.\nThis parameter is a list that specifies exactly **one** metadata template used to filter the search results. \nThe parameter is required unless the `query` parameter is provided.", + "description": "Limits the search results to any items for which the metadata matches the provided filter.\nThis parameter is a list that specifies exactly **one** metadata template used to filter the search results.\nThe parameter is required unless the `query` parameter is provided.", "required": false, "schema": { "type": "array", @@ -10674,7 +10674,7 @@ { "name": "deleted_at_range", "in": "query", - "description": "Limits the search results to any items deleted within a given\ndate range.\n\nDate ranges are defined as comma separated RFC3339 timestamps.\n\nIf the the start date is omitted (`2014-05-17T13:35:01-07:00`),\nanything deleted before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00`),\nthe current date will be used as the end date instead.\n\nThe `trash_content` parameter needs to be set to `trashed_only`.\n\nIf searching in trash is not performed, then an empty result\nis returned.\n\nData available from 2023-02-01 onwards.", + "description": "Limits the search results to any items deleted within a given\ndate range.\n\nDate ranges are defined as comma separated RFC3339 timestamps.\n\nIf the start date is omitted (`2014-05-17T13:35:01-07:00`),\nanything deleted before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00`),\nthe current date will be used as the end date instead.\n\nThe `trash_content` parameter needs to be set to `trashed_only`.\n\nIf searching in trash is not performed, then an empty result\nis returned.\n\nData available from 2023-02-01 onwards.", "required": false, "schema": { "type": "array", @@ -10806,7 +10806,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { - "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) 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.", + "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) requires all assignees to review or\napprove the task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the task in order for it to be considered completed.", "type": "string", "example": "all_assignees", "default": "all_assignees", @@ -10978,7 +10978,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { - "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) 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.", + "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) requires all assignees to review or\napprove the task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the task in order for it to be considered completed.", "type": "string", "example": "all_assignees", "enum": [ @@ -25216,7 +25216,7 @@ "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.", "type": "array", "items": { - "$ref": "#/components/schemas/FileOrFolderScope" + "$ref": "#/components/schemas/ResourceScope" } }, "refresh_token": { @@ -25649,7 +25649,7 @@ "type": "object", "properties": { "mode": { - "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, \nwhichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. \nBox AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages \nfor multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will \nbe processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. \nCurrently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only \nprocess the text.", + "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files,\nwhichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed.\nBox AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages\nfor multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will\nbe processed. If you set mode parameter to `single_item_qa`, the items array can have one element only.\nCurrently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only\nprocess the text.", "type": "string", "example": "multiple_item_qa", "enum": [ @@ -25688,14 +25688,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentAsk" - }, - { - "$ref": "#/components/schemas/AiAgentReference" - } - ] + "$ref": "#/components/schemas/AiAskAgent" }, { "description": "The AI agent to be used to handle the request." @@ -25711,6 +25704,19 @@ "title": "AI ask request", "x-box-tag": "ai" }, + "AiAskAgent": { + "description": "The AI agent to be used to handle the AI ask request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentAsk" + } + ], + "title": "AI ask request agent" + }, "AiCitation": { "description": "The citation of the LLM's answer reference.", "type": "object", @@ -25786,14 +25792,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentReference" - }, - { - "$ref": "#/components/schemas/AiAgentExtract" - } - ] + "$ref": "#/components/schemas/AiExtractAgent" }, { "description": "The AI agent to be used for the extraction." @@ -25808,6 +25807,19 @@ "title": "AI metadata freeform extraction request", "x-box-tag": "ai" }, + "AiExtractAgent": { + "description": "The AI agent to be used to handle the AI metadata freeform extraction request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentExtract" + } + ], + "title": "AI metadata freeform extraction request agent" + }, "AiExtractResponse": { "description": "AI extract response.\nThe content of this response may vary depending on\nthe requested configuration.", "type": "object", @@ -25922,14 +25934,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentReference" - }, - { - "$ref": "#/components/schemas/AiAgentExtractStructured" - } - ] + "$ref": "#/components/schemas/AiExtractStructuredAgent" }, { "description": "The AI agent to be used for the structured extraction." @@ -25943,6 +25948,19 @@ "title": "AI Extract Structured Request", "x-box-tag": "ai" }, + "AiExtractStructuredAgent": { + "description": "The AI agent to be used to handle the AI extract structured request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentExtractStructured" + } + ], + "title": "AI Extract Structured Request agent" + }, "AiExtractStructuredResponse": { "description": "AI extract structured response.", "type": "object", @@ -27064,14 +27082,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentReference" - }, - { - "$ref": "#/components/schemas/AiAgentTextGen" - } - ] + "$ref": "#/components/schemas/AiTextGenAgent" }, { "description": "The AI agent to be used for generating text." @@ -27086,6 +27097,19 @@ "title": "AI text gen request", "x-box-tag": "ai" }, + "AiTextGenAgent": { + "description": "The AI agent to be used to handle the AI text generation request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentTextGen" + } + ], + "title": "AI text gen request agent" + }, "AppItem": { "description": "An app item represents an content object owned by an application. It can\ngroup files and folders together from different paths. That set can be shared\nvia a collaboration.", "type": "object", @@ -27118,6 +27142,22 @@ "x-box-resource-id": "app_item", "x-box-tag": "app_item_associations" }, + "AppItemAssociatedItem": { + "description": "The file, folder or web link which is associated with the app item.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Base" + }, + { + "$ref": "#/components/schemas/Folder--Base" + }, + { + "$ref": "#/components/schemas/WebLink--Base" + } + ], + "title": "App item associated item" + }, "AppItemAssociation": { "description": "An app item association represents an association between a file or\nfolder and an app item. Associations between a folder and an app item\ncascade down to all descendants of the folder.", "type": "object", @@ -27149,25 +27189,7 @@ "nullable": false }, "item": { - "allOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Base" - }, - { - "$ref": "#/components/schemas/Folder--Base" - }, - { - "$ref": "#/components/schemas/WebLink--Base" - } - ] - }, - { - "description": "The file or folder which is associated with the app item." - } - ], - "nullable": false + "$ref": "#/components/schemas/AppItemAssociatedItem" } }, "required": [ @@ -27585,17 +27607,7 @@ "item": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File" - }, - { - "$ref": "#/components/schemas/Folder" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/CollaborationItem" }, { "description": "The file or folder to which access is granted. The field is\n`null` when the collaboration `status` is `pending` or the\ncollaboration is created on an app item (see `app_item` field)." @@ -27615,21 +27627,7 @@ "nullable": true }, "accessible_by": { - "allOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/User--Collaborations" - }, - { - "$ref": "#/components/schemas/Group--Mini" - } - ] - }, - { - "description": "The user or group that is granted access." - } - ] + "$ref": "#/components/schemas/CollaborationAccessGrantee" }, "invite_email": { "description": "The email address used to invite an unregistered collaborator, if\nthey are not a registered user.", @@ -27660,7 +27658,7 @@ "nullable": true }, "is_access_only": { - "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the the path to the root folder for the\nshared item.", + "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the path to the root folder for the\nshared item.", "type": "boolean", "example": true }, @@ -27785,6 +27783,19 @@ "x-box-resource-id": "collaboration", "x-box-tag": "user_collaborations" }, + "CollaborationAccessGrantee": { + "description": "The user or group that is granted access.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/User--Collaborations" + }, + { + "$ref": "#/components/schemas/Group--Mini" + } + ], + "title": "Collaboration access grantee" + }, "CollaborationAllowlistEntries": { "description": "A list of allowed domains for collaboration.", "type": "object", @@ -28024,6 +28035,22 @@ "x-box-resource-id": "collaboration_allowlist_exempt_targets", "x-box-tag": "collaboration_allowlist_exempt_targets" }, + "CollaborationItem": { + "description": "A collaboration item.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File" + }, + { + "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Collaboration item" + }, "Collaborations": { "description": "A list of collaborations.", "type": "object", @@ -28958,26 +28985,7 @@ "source": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/User" - }, - { - "$ref": "#/components/schemas/EventSource" - }, - { - "$ref": "#/components/schemas/File" - }, - { - "$ref": "#/components/schemas/Folder" - }, - { - "$ref": "#/components/schemas/GenericSource" - }, - { - "$ref": "#/components/schemas/AppItemEventSource" - } - ] + "$ref": "#/components/schemas/EventSourceResource" }, { "description": "The resource that triggered this event. For more information,\ncheck out the guide on event triggers." @@ -29066,6 +29074,31 @@ "title": "Event source", "x-box-resource-id": "event_source" }, + "EventSourceResource": { + "description": "The resource that triggered an event.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/User" + }, + { + "$ref": "#/components/schemas/EventSource" + }, + { + "$ref": "#/components/schemas/File" + }, + { + "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/GenericSource" + }, + { + "$ref": "#/components/schemas/AppItemEventSource" + } + ], + "title": "Event source resource" + }, "Events": { "description": "A list of event objects.", "type": "object", @@ -29714,7 +29747,7 @@ "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.", "type": "array", "items": { - "$ref": "#/components/schemas/FileOrFolderScope" + "$ref": "#/components/schemas/ResourceScope" } } } @@ -30088,51 +30121,6 @@ "x-box-resource-id": "file_conflict", "x-box-tag": null }, - "FileOrFolderScope": { - "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed.", - "type": "object", - "properties": { - "scope": { - "description": "The scopes for the resource access.", - "type": "string", - "example": "item_download", - "enum": [ - "annotation_edit", - "annotation_view_all", - "annotation_view_self", - "base_explorer", - "base_picker", - "base_preview", - "base_upload", - "item_delete", - "item_download", - "item_preview", - "item_rename", - "item_share", - "item_upload", - "item_read" - ] - }, - "object": { - "allOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "$ref": "#/components/schemas/File--Mini" - } - ] - }, - { - "description": "The file or folder resource." - } - ] - } - }, - "title": "File or folder scope" - }, "FileRequest": { "description": "A standard representation of a file request, as returned\nfrom any file request API endpoints by default.", "type": "object", @@ -32242,7 +32230,7 @@ "type": "channel", "slack_org_id": "E1234567" }, - "oneOf": [ + "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" } @@ -32510,7 +32498,7 @@ "tenant_id": "E1234567", "team_id": "hjgjgjg-bhhj-564a-b643-hghgj685u" }, - "oneOf": [ + "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemTeams" } @@ -32711,6 +32699,22 @@ "x-box-resource-id": "invite", "x-box-tag": "invites" }, + "Item": { + "description": "An item represents a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Item" + }, "Items": { "description": "A list of files, folders, and web links in\ntheir mini representation.", "type": "object", @@ -32793,17 +32797,7 @@ "description": "The items in this collection.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/Item" } } } @@ -32871,17 +32865,7 @@ "description": "The items in this collection.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/Item" } } } @@ -33199,6 +33183,22 @@ "standard" ] }, + "LegalHoldPolicyAssignedItem": { + "description": "The item that the legal hold policy\nis assigned to. Includes type and ID.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File" + }, + { + "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Legal hold policy item" + }, "LegalHoldPolicyAssignment": { "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.", "type": "object", @@ -33221,20 +33221,10 @@ "assigned_to": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File" - }, - { - "$ref": "#/components/schemas/Folder" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/LegalHoldPolicyAssignedItem" }, { - "description": "The item that the the legal hold policy\nis assigned to. Includes type and ID." + "description": "The item that the legal hold policy\nis assigned to. Includes type and ID." } ] }, @@ -33647,32 +33637,7 @@ "additionalProperties": { "allOf": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "title": "Metadata field filter (multi-select)", - "type": "array", - "items": { - "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" - ] - }, - { - "$ref": "#/components/schemas/MetadataFieldFilterFloatRange" - }, - { - "$ref": "#/components/schemas/MetadataFieldFilterDateRange" - } - ] + "$ref": "#/components/schemas/MetadataFilterValue" }, { "example": "online" @@ -33688,6 +33653,36 @@ "x-box-resource-id": "metadata_filter", "x-box-tag": "search" }, + "MetadataFilterValue": { + "description": "A value of metadata filter.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "title": "Metadata field filter (multi-select)", + "type": "array", + "items": { + "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" + ] + }, + { + "$ref": "#/components/schemas/MetadataFieldFilterFloatRange" + }, + { + "$ref": "#/components/schemas/MetadataFieldFilterDateRange" + } + ], + "title": "Metadata filter value" + }, "MetadataInstanceValue": { "description": "The value to be set or tested.\n\nRequired for `add`, `replace`, and `test` operations. For `add`,\nif the value exists already the previous value will be overwritten\nby the new value. For `replace`, the value must exist before\nreplacing.\n\nFor `test`, the existing value at the `path` location must match\nthe specified value.", "example": "reviewed", @@ -33809,6 +33804,19 @@ ], "title": "Metadata query search request" }, + "MetadataQueryResultItem": { + "description": "The mini representation of a file or folder.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + } + ], + "title": "Metadata query search result item" + }, "MetadataQueryResults": { "description": "A page of files and folders that matched the metadata query.", "type": "object", @@ -33817,14 +33825,7 @@ "description": "The mini representation of the files and folders that match the search\nterms.\n\nBy default, this endpoint returns only the most basic info about the\nitems. To get additional fields for each item, including any of the\nmetadata, use the `fields` attribute in the query.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - } - ] + "$ref": "#/components/schemas/MetadataQueryResultItem" }, "x-box-resource-variant": 1 }, @@ -33992,7 +33993,7 @@ { "properties": { "id": { - "description": "The internal unique identifier of the the option.", + "description": "The internal unique identifier of the option.", "type": "string", "example": "45dc2849-a4a7-40a9-a751-4a699a589190" } @@ -34412,17 +34413,7 @@ "item": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/RecentItemResource" }, { "description": "The item that was recently accessed." @@ -34457,6 +34448,22 @@ "x-box-resource-id": "recent_item", "x-box-tag": "recent_items" }, + "RecentItemResource": { + "description": "A recently accessed item resource. This can be a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Recent item resource" + }, "RecentItems": { "description": "A list of recent items.", "type": "object", @@ -34500,6 +34507,50 @@ "title": "Recent items", "x-box-resource-id": "recent_items" }, + "Resource": { + "description": "The file or folder resource.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "$ref": "#/components/schemas/File--Mini" + } + ], + "title": "Resource" + }, + "ResourceScope": { + "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed.", + "type": "object", + "properties": { + "scope": { + "description": "The scopes for the resource access.", + "type": "string", + "example": "item_download", + "enum": [ + "annotation_edit", + "annotation_view_all", + "annotation_view_self", + "base_explorer", + "base_picker", + "base_preview", + "base_upload", + "item_delete", + "item_download", + "item_preview", + "item_rename", + "item_share", + "item_upload", + "item_read" + ] + }, + "object": { + "$ref": "#/components/schemas/Resource" + } + }, + "title": "Resource scope" + }, "RetentionPolicies": { "description": "A list of retention policies.", "type": "object", @@ -34910,6 +34961,22 @@ ], "title": "Role variable" }, + "SearchResultItem": { + "description": "An item in search results. This can be a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Search results item" + }, "SearchResultWithSharedLink": { "description": "A single of files, folder or web link that matched the search query,\nincluding the additional information about the shared link through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the\n`include_recent_shared_links` query parameter has been set to `true`.", "type": "object", @@ -34923,17 +34990,7 @@ "item": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/SearchResultWithSharedLinkItem" }, { "description": "The file, folder or web link that matched the\nsearch query." @@ -34950,6 +35007,22 @@ "x-box-resource-id": "search_result_with_shared_link", "x-box-tag": "search" }, + "SearchResultWithSharedLinkItem": { + "description": "An item in search results with a shared link. This can be a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Search result item" + }, "SearchResults": { "description": "A list of files, folders and web links that matched the search query.", "type": "object", @@ -34992,17 +35065,7 @@ "description": "The search results for the query provided.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/SearchResultItem" } } } @@ -36734,6 +36797,25 @@ "x-box-resource-id": "sign_templates", "x-box-tag": "sign_templates" }, + "SkillCard": { + "description": "Box Skill card.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/KeywordSkillCard" + }, + { + "$ref": "#/components/schemas/TimelineSkillCard" + }, + { + "$ref": "#/components/schemas/TranscriptSkillCard" + }, + { + "$ref": "#/components/schemas/StatusSkillCard" + } + ], + "title": "Box Skill card" + }, "SkillCardsMetadata": { "description": "The metadata assigned to a using for Box skills.", "type": "object", @@ -36784,20 +36866,7 @@ "description": "A list of Box Skill cards that have been applied to this file.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/KeywordSkillCard" - }, - { - "$ref": "#/components/schemas/TimelineSkillCard" - }, - { - "$ref": "#/components/schemas/TranscriptSkillCard" - }, - { - "$ref": "#/components/schemas/StatusSkillCard" - } - ] + "$ref": "#/components/schemas/SkillCard" } } }, @@ -37213,7 +37282,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { - "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.", + "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 task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the task in order for it to be considered completed.", "type": "string", "example": "all_assignees", "enum": [ diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index f7d455be..8d03274c 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "5132d100e1" + "x-box-commit-hash": "3191f398fb" }, "servers": [ { @@ -3950,19 +3950,7 @@ "title": "Hub Action" }, "item": { - "description": "Reference to an item that can be added to a Hub.", - "oneOf": [ - { - "$ref": "#/components/schemas/FileReference" - }, - { - "$ref": "#/components/schemas/FolderReference" - }, - { - "$ref": "#/components/schemas/WeblinkReference" - } - ], - "title": "Hub Item Reference" + "$ref": "#/components/schemas/HubItemReference" } }, "required": [ diff --git a/openapi/openapi.json b/openapi/openapi.json index b8c773b8..5dce086f 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "5132d100e1" + "x-box-commit-hash": "3191f398fb" }, "servers": [ { @@ -868,7 +868,7 @@ "delete": { "operationId": "delete_files_id", "summary": "Delete file", - "description": "Deletes a file, either permanently or by moving it to\nthe trash.\n\nThe the enterprise settings determine whether the item will\nbe permanently deleted from Box or moved to the trash.", + "description": "Deletes a file, either permanently or by moving it to\nthe trash.\n\nThe enterprise settings determine whether the item will\nbe permanently deleted from Box or moved to the trash.", "parameters": [ { "name": "file_id", @@ -3149,7 +3149,7 @@ "post": { "operationId": "post_files_id_versions_current", "summary": "Promote file version", - "description": "Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to\npromote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the\ntop of the versions history. The file will have the exact same contents\nas the older version, with the the same hash digest, `etag`, and\nname as the original.\n\nOther properties such as comments do not get updated to their\nformer values.\n\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar.", + "description": "Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to\npromote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the\ntop of the versions history. The file will have the exact same contents\nas the older version, with the same hash digest, `etag`, and\nname as the original.\n\nOther properties such as comments do not get updated to their\nformer values.\n\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar.", "parameters": [ { "name": "file_id", @@ -10270,7 +10270,7 @@ ] }, "is_access_only": { - "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the the path to the root folder for the\nshared item.", + "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the path to the root folder for the\nshared item.", "type": "boolean", "example": true }, @@ -10385,7 +10385,7 @@ { "name": "created_at_range", "in": "query", - "description": "Limits the search results to any items created within\na given date range.\n\nDate ranges are defined as comma separated RFC3339\ntimestamps.\n\nIf the the start date is omitted (`,2014-05-17T13:35:01-07:00`)\nanything created before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00,`) the\ncurrent date will be used as the end date instead.", + "description": "Limits the search results to any items created within\na given date range.\n\nDate ranges are defined as comma separated RFC3339\ntimestamps.\n\nIf the start date is omitted (`,2014-05-17T13:35:01-07:00`)\nanything created before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00,`) the\ncurrent date will be used as the end date instead.", "required": false, "schema": { "type": "array", @@ -10545,7 +10545,7 @@ { "name": "mdfilters", "in": "query", - "description": "Limits the search results to any items for which the metadata matches the provided filter.\nThis parameter is a list that specifies exactly **one** metadata template used to filter the search results. \nThe parameter is required unless the `query` parameter is provided.", + "description": "Limits the search results to any items for which the metadata matches the provided filter.\nThis parameter is a list that specifies exactly **one** metadata template used to filter the search results.\nThe parameter is required unless the `query` parameter is provided.", "required": false, "schema": { "type": "array", @@ -10674,7 +10674,7 @@ { "name": "deleted_at_range", "in": "query", - "description": "Limits the search results to any items deleted within a given\ndate range.\n\nDate ranges are defined as comma separated RFC3339 timestamps.\n\nIf the the start date is omitted (`2014-05-17T13:35:01-07:00`),\nanything deleted before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00`),\nthe current date will be used as the end date instead.\n\nThe `trash_content` parameter needs to be set to `trashed_only`.\n\nIf searching in trash is not performed, then an empty result\nis returned.\n\nData available from 2023-02-01 onwards.", + "description": "Limits the search results to any items deleted within a given\ndate range.\n\nDate ranges are defined as comma separated RFC3339 timestamps.\n\nIf the start date is omitted (`2014-05-17T13:35:01-07:00`),\nanything deleted before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00`),\nthe current date will be used as the end date instead.\n\nThe `trash_content` parameter needs to be set to `trashed_only`.\n\nIf searching in trash is not performed, then an empty result\nis returned.\n\nData available from 2023-02-01 onwards.", "required": false, "schema": { "type": "array", @@ -10806,7 +10806,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { - "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) 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.", + "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) requires all assignees to review or\napprove the task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the task in order for it to be considered completed.", "type": "string", "example": "all_assignees", "default": "all_assignees", @@ -10978,7 +10978,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { - "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) 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.", + "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` (default) requires all assignees to review or\napprove the task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the task in order for it to be considered completed.", "type": "string", "example": "all_assignees", "enum": [ @@ -25216,7 +25216,7 @@ "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.", "type": "array", "items": { - "$ref": "#/components/schemas/FileOrFolderScope" + "$ref": "#/components/schemas/ResourceScope" } }, "refresh_token": { @@ -25649,7 +25649,7 @@ "type": "object", "properties": { "mode": { - "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, \nwhichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. \nBox AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages \nfor multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will \nbe processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. \nCurrently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only \nprocess the text.", + "description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files,\nwhichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed.\nBox AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages\nfor multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will\nbe processed. If you set mode parameter to `single_item_qa`, the items array can have one element only.\nCurrently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only\nprocess the text.", "type": "string", "example": "multiple_item_qa", "enum": [ @@ -25688,14 +25688,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentAsk" - }, - { - "$ref": "#/components/schemas/AiAgentReference" - } - ] + "$ref": "#/components/schemas/AiAskAgent" }, { "description": "The AI agent to be used to handle the request." @@ -25711,6 +25704,19 @@ "title": "AI ask request", "x-box-tag": "ai" }, + "AiAskAgent": { + "description": "The AI agent to be used to handle the AI ask request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentAsk" + } + ], + "title": "AI ask request agent" + }, "AiCitation": { "description": "The citation of the LLM's answer reference.", "type": "object", @@ -25786,14 +25792,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentReference" - }, - { - "$ref": "#/components/schemas/AiAgentExtract" - } - ] + "$ref": "#/components/schemas/AiExtractAgent" }, { "description": "The AI agent to be used for the extraction." @@ -25808,6 +25807,19 @@ "title": "AI metadata freeform extraction request", "x-box-tag": "ai" }, + "AiExtractAgent": { + "description": "The AI agent to be used to handle the AI metadata freeform extraction request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentExtract" + } + ], + "title": "AI metadata freeform extraction request agent" + }, "AiExtractResponse": { "description": "AI extract response.\nThe content of this response may vary depending on\nthe requested configuration.", "type": "object", @@ -25922,14 +25934,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentReference" - }, - { - "$ref": "#/components/schemas/AiAgentExtractStructured" - } - ] + "$ref": "#/components/schemas/AiExtractStructuredAgent" }, { "description": "The AI agent to be used for the structured extraction." @@ -25943,6 +25948,19 @@ "title": "AI Extract Structured Request", "x-box-tag": "ai" }, + "AiExtractStructuredAgent": { + "description": "The AI agent to be used to handle the AI extract structured request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentExtractStructured" + } + ], + "title": "AI Extract Structured Request agent" + }, "AiExtractStructuredResponse": { "description": "AI extract structured response.", "type": "object", @@ -27064,14 +27082,7 @@ "ai_agent": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/AiAgentReference" - }, - { - "$ref": "#/components/schemas/AiAgentTextGen" - } - ] + "$ref": "#/components/schemas/AiTextGenAgent" }, { "description": "The AI agent to be used for generating text." @@ -27086,6 +27097,19 @@ "title": "AI text gen request", "x-box-tag": "ai" }, + "AiTextGenAgent": { + "description": "The AI agent to be used to handle the AI text generation request.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/AiAgentReference" + }, + { + "$ref": "#/components/schemas/AiAgentTextGen" + } + ], + "title": "AI text gen request agent" + }, "AppItem": { "description": "An app item represents an content object owned by an application. It can\ngroup files and folders together from different paths. That set can be shared\nvia a collaboration.", "type": "object", @@ -27118,6 +27142,22 @@ "x-box-resource-id": "app_item", "x-box-tag": "app_item_associations" }, + "AppItemAssociatedItem": { + "description": "The file, folder or web link which is associated with the app item.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Base" + }, + { + "$ref": "#/components/schemas/Folder--Base" + }, + { + "$ref": "#/components/schemas/WebLink--Base" + } + ], + "title": "App item associated item" + }, "AppItemAssociation": { "description": "An app item association represents an association between a file or\nfolder and an app item. Associations between a folder and an app item\ncascade down to all descendants of the folder.", "type": "object", @@ -27149,25 +27189,7 @@ "nullable": false }, "item": { - "allOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Base" - }, - { - "$ref": "#/components/schemas/Folder--Base" - }, - { - "$ref": "#/components/schemas/WebLink--Base" - } - ] - }, - { - "description": "The file or folder which is associated with the app item." - } - ], - "nullable": false + "$ref": "#/components/schemas/AppItemAssociatedItem" } }, "required": [ @@ -27585,17 +27607,7 @@ "item": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File" - }, - { - "$ref": "#/components/schemas/Folder" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/CollaborationItem" }, { "description": "The file or folder to which access is granted. The field is\n`null` when the collaboration `status` is `pending` or the\ncollaboration is created on an app item (see `app_item` field)." @@ -27615,21 +27627,7 @@ "nullable": true }, "accessible_by": { - "allOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/User--Collaborations" - }, - { - "$ref": "#/components/schemas/Group--Mini" - } - ] - }, - { - "description": "The user or group that is granted access." - } - ] + "$ref": "#/components/schemas/CollaborationAccessGrantee" }, "invite_email": { "description": "The email address used to invite an unregistered collaborator, if\nthey are not a registered user.", @@ -27660,7 +27658,7 @@ "nullable": true }, "is_access_only": { - "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the the path to the root folder for the\nshared item.", + "description": "If set to `true`, collaborators have access to\nshared items, but such items won't be visible in the\nAll Files list. Additionally, collaborators won't\nsee the path to the root folder for the\nshared item.", "type": "boolean", "example": true }, @@ -27785,6 +27783,19 @@ "x-box-resource-id": "collaboration", "x-box-tag": "user_collaborations" }, + "CollaborationAccessGrantee": { + "description": "The user or group that is granted access.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/User--Collaborations" + }, + { + "$ref": "#/components/schemas/Group--Mini" + } + ], + "title": "Collaboration access grantee" + }, "CollaborationAllowlistEntries": { "description": "A list of allowed domains for collaboration.", "type": "object", @@ -28024,6 +28035,22 @@ "x-box-resource-id": "collaboration_allowlist_exempt_targets", "x-box-tag": "collaboration_allowlist_exempt_targets" }, + "CollaborationItem": { + "description": "A collaboration item.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File" + }, + { + "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Collaboration item" + }, "Collaborations": { "description": "A list of collaborations.", "type": "object", @@ -28958,26 +28985,7 @@ "source": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/User" - }, - { - "$ref": "#/components/schemas/EventSource" - }, - { - "$ref": "#/components/schemas/File" - }, - { - "$ref": "#/components/schemas/Folder" - }, - { - "$ref": "#/components/schemas/GenericSource" - }, - { - "$ref": "#/components/schemas/AppItemEventSource" - } - ] + "$ref": "#/components/schemas/EventSourceResource" }, { "description": "The resource that triggered this event. For more information,\ncheck out the guide on event triggers." @@ -29066,6 +29074,31 @@ "title": "Event source", "x-box-resource-id": "event_source" }, + "EventSourceResource": { + "description": "The resource that triggered an event.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/User" + }, + { + "$ref": "#/components/schemas/EventSource" + }, + { + "$ref": "#/components/schemas/File" + }, + { + "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/GenericSource" + }, + { + "$ref": "#/components/schemas/AppItemEventSource" + } + ], + "title": "Event source resource" + }, "Events": { "description": "A list of event objects.", "type": "object", @@ -29714,7 +29747,7 @@ "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.", "type": "array", "items": { - "$ref": "#/components/schemas/FileOrFolderScope" + "$ref": "#/components/schemas/ResourceScope" } } } @@ -30088,51 +30121,6 @@ "x-box-resource-id": "file_conflict", "x-box-tag": null }, - "FileOrFolderScope": { - "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed.", - "type": "object", - "properties": { - "scope": { - "description": "The scopes for the resource access.", - "type": "string", - "example": "item_download", - "enum": [ - "annotation_edit", - "annotation_view_all", - "annotation_view_self", - "base_explorer", - "base_picker", - "base_preview", - "base_upload", - "item_delete", - "item_download", - "item_preview", - "item_rename", - "item_share", - "item_upload", - "item_read" - ] - }, - "object": { - "allOf": [ - { - "oneOf": [ - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "$ref": "#/components/schemas/File--Mini" - } - ] - }, - { - "description": "The file or folder resource." - } - ] - } - }, - "title": "File or folder scope" - }, "FileRequest": { "description": "A standard representation of a file request, as returned\nfrom any file request API endpoints by default.", "type": "object", @@ -32242,7 +32230,7 @@ "type": "channel", "slack_org_id": "E1234567" }, - "oneOf": [ + "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" } @@ -32510,7 +32498,7 @@ "tenant_id": "E1234567", "team_id": "hjgjgjg-bhhj-564a-b643-hghgj685u" }, - "oneOf": [ + "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemTeams" } @@ -32711,6 +32699,22 @@ "x-box-resource-id": "invite", "x-box-tag": "invites" }, + "Item": { + "description": "An item represents a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Item" + }, "Items": { "description": "A list of files, folders, and web links in\ntheir mini representation.", "type": "object", @@ -32793,17 +32797,7 @@ "description": "The items in this collection.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/Item" } } } @@ -32871,17 +32865,7 @@ "description": "The items in this collection.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Mini" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/Item" } } } @@ -33199,6 +33183,22 @@ "standard" ] }, + "LegalHoldPolicyAssignedItem": { + "description": "The item that the legal hold policy\nis assigned to. Includes type and ID.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File" + }, + { + "$ref": "#/components/schemas/Folder" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Legal hold policy item" + }, "LegalHoldPolicyAssignment": { "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.", "type": "object", @@ -33221,20 +33221,10 @@ "assigned_to": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File" - }, - { - "$ref": "#/components/schemas/Folder" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/LegalHoldPolicyAssignedItem" }, { - "description": "The item that the the legal hold policy\nis assigned to. Includes type and ID." + "description": "The item that the legal hold policy\nis assigned to. Includes type and ID." } ] }, @@ -33647,32 +33637,7 @@ "additionalProperties": { "allOf": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "title": "Metadata field filter (multi-select)", - "type": "array", - "items": { - "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" - ] - }, - { - "$ref": "#/components/schemas/MetadataFieldFilterFloatRange" - }, - { - "$ref": "#/components/schemas/MetadataFieldFilterDateRange" - } - ] + "$ref": "#/components/schemas/MetadataFilterValue" }, { "example": "online" @@ -33688,6 +33653,36 @@ "x-box-resource-id": "metadata_filter", "x-box-tag": "search" }, + "MetadataFilterValue": { + "description": "A value of metadata filter.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "title": "Metadata field filter (multi-select)", + "type": "array", + "items": { + "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" + ] + }, + { + "$ref": "#/components/schemas/MetadataFieldFilterFloatRange" + }, + { + "$ref": "#/components/schemas/MetadataFieldFilterDateRange" + } + ], + "title": "Metadata filter value" + }, "MetadataInstanceValue": { "description": "The value to be set or tested.\n\nRequired for `add`, `replace`, and `test` operations. For `add`,\nif the value exists already the previous value will be overwritten\nby the new value. For `replace`, the value must exist before\nreplacing.\n\nFor `test`, the existing value at the `path` location must match\nthe specified value.", "example": "reviewed", @@ -33809,6 +33804,19 @@ ], "title": "Metadata query search request" }, + "MetadataQueryResultItem": { + "description": "The mini representation of a file or folder.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + } + ], + "title": "Metadata query search result item" + }, "MetadataQueryResults": { "description": "A page of files and folders that matched the metadata query.", "type": "object", @@ -33817,14 +33825,7 @@ "description": "The mini representation of the files and folders that match the search\nterms.\n\nBy default, this endpoint returns only the most basic info about the\nitems. To get additional fields for each item, including any of the\nmetadata, use the `fields` attribute in the query.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - } - ] + "$ref": "#/components/schemas/MetadataQueryResultItem" }, "x-box-resource-variant": 1 }, @@ -33992,7 +33993,7 @@ { "properties": { "id": { - "description": "The internal unique identifier of the the option.", + "description": "The internal unique identifier of the option.", "type": "string", "example": "45dc2849-a4a7-40a9-a751-4a699a589190" } @@ -34412,17 +34413,7 @@ "item": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/RecentItemResource" }, { "description": "The item that was recently accessed." @@ -34457,6 +34448,22 @@ "x-box-resource-id": "recent_item", "x-box-tag": "recent_items" }, + "RecentItemResource": { + "description": "A recently accessed item resource. This can be a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Recent item resource" + }, "RecentItems": { "description": "A list of recent items.", "type": "object", @@ -34500,6 +34507,50 @@ "title": "Recent items", "x-box-resource-id": "recent_items" }, + "Resource": { + "description": "The file or folder resource.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/Folder--Mini" + }, + { + "$ref": "#/components/schemas/File--Mini" + } + ], + "title": "Resource" + }, + "ResourceScope": { + "description": "A relation between a resource (file or folder) and the scopes for which the resource can be accessed.", + "type": "object", + "properties": { + "scope": { + "description": "The scopes for the resource access.", + "type": "string", + "example": "item_download", + "enum": [ + "annotation_edit", + "annotation_view_all", + "annotation_view_self", + "base_explorer", + "base_picker", + "base_preview", + "base_upload", + "item_delete", + "item_download", + "item_preview", + "item_rename", + "item_share", + "item_upload", + "item_read" + ] + }, + "object": { + "$ref": "#/components/schemas/Resource" + } + }, + "title": "Resource scope" + }, "RetentionPolicies": { "description": "A list of retention policies.", "type": "object", @@ -34910,6 +34961,22 @@ ], "title": "Role variable" }, + "SearchResultItem": { + "description": "An item in search results. This can be a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Search results item" + }, "SearchResultWithSharedLink": { "description": "A single of files, folder or web link that matched the search query,\nincluding the additional information about the shared link through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the\n`include_recent_shared_links` query parameter has been set to `true`.", "type": "object", @@ -34923,17 +34990,7 @@ "item": { "allOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/SearchResultWithSharedLinkItem" }, { "description": "The file, folder or web link that matched the\nsearch query." @@ -34950,6 +35007,22 @@ "x-box-resource-id": "search_result_with_shared_link", "x-box-tag": "search" }, + "SearchResultWithSharedLinkItem": { + "description": "An item in search results with a shared link. This can be a file, folder, or web link.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/File--Full" + }, + { + "$ref": "#/components/schemas/Folder--Full" + }, + { + "$ref": "#/components/schemas/WebLink" + } + ], + "title": "Search result item" + }, "SearchResults": { "description": "A list of files, folders and web links that matched the search query.", "type": "object", @@ -34992,17 +35065,7 @@ "description": "The search results for the query provided.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/File--Full" - }, - { - "$ref": "#/components/schemas/Folder--Full" - }, - { - "$ref": "#/components/schemas/WebLink" - } - ] + "$ref": "#/components/schemas/SearchResultItem" } } } @@ -36734,6 +36797,25 @@ "x-box-resource-id": "sign_templates", "x-box-tag": "sign_templates" }, + "SkillCard": { + "description": "Box Skill card.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/KeywordSkillCard" + }, + { + "$ref": "#/components/schemas/TimelineSkillCard" + }, + { + "$ref": "#/components/schemas/TranscriptSkillCard" + }, + { + "$ref": "#/components/schemas/StatusSkillCard" + } + ], + "title": "Box Skill card" + }, "SkillCardsMetadata": { "description": "The metadata assigned to a using for Box skills.", "type": "object", @@ -36784,20 +36866,7 @@ "description": "A list of Box Skill cards that have been applied to this file.", "type": "array", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/KeywordSkillCard" - }, - { - "$ref": "#/components/schemas/TimelineSkillCard" - }, - { - "$ref": "#/components/schemas/TranscriptSkillCard" - }, - { - "$ref": "#/components/schemas/StatusSkillCard" - } - ] + "$ref": "#/components/schemas/SkillCard" } } }, @@ -37213,7 +37282,7 @@ "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { - "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.", + "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 task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the task in order for it to be considered completed.", "type": "string", "example": "all_assignees", "enum": [