diff --git a/openapi.json b/openapi.json index a514498f..3f97dff2 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "dfe9629b78" + "x-box-commit-hash": "3d705a6550" }, "servers": [ { @@ -30544,6 +30544,41 @@ "x-box-resource-id": "event", "x-box-tag": "events" }, + "Events": { + "description": "A list of event objects.", + "type": "object", + "properties": { + "chunk_size": { + "description": "The number of events returned in this response.", + "type": "integer", + "format": "int64", + "example": 2 + }, + "next_stream_position": { + "description": "The stream position of the start of the next page (chunk)\nof events.", + "example": "1152922976252290886", + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer", + "format": "int64" + } + ] + }, + "entries": { + "description": "A list of events.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + } + } + }, + "title": "Events", + "x-box-resource-id": "events", + "x-box-tag": "events" + }, "EventSource": { "description": "The source file or folder that triggered an event in\nthe event stream.", "type": "object", @@ -30639,41 +30674,6 @@ ], "title": "Event source resource" }, - "Events": { - "description": "A list of event objects.", - "type": "object", - "properties": { - "chunk_size": { - "description": "The number of events returned in this response.", - "type": "integer", - "format": "int64", - "example": 2 - }, - "next_stream_position": { - "description": "The stream position of the start of the next page (chunk)\nof events.", - "example": "1152922976252290886", - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer", - "format": "int64" - } - ] - }, - "entries": { - "description": "A list of events.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } - } - }, - "title": "Events", - "x-box-resource-id": "events", - "x-box-tag": "events" - }, "File": { "description": "A standard representation of a file, as returned from any\nfile API endpoints by default.", "type": "object", @@ -31890,6 +31890,116 @@ }, "title": "File Request (Update)" }, + "Files": { + "description": "A list of files.", + "type": "object", + "properties": { + "total_count": { + "description": "The number of files.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "entries": { + "description": "A list of files.", + "type": "array", + "items": { + "$ref": "#/components/schemas/File--Full" + } + } + }, + "title": "Files", + "x-box-resource-id": "files", + "x-box-tag": "files" + }, + "FilesOnHold": { + "description": "A list of files on hold for legal policy assignment.", + "type": "object", + "allOf": [ + { + "type": "object", + "description": "The part of an API response that describes marker\nbased pagination.", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + }, + "prev_marker": { + "description": "The marker for the start of the previous page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of files.", + "type": "array", + "items": { + "$ref": "#/components/schemas/File--Mini" + } + } + } + } + ], + "title": "Files on hold", + "x-box-resource-id": "files_on_hold", + "x-box-tag": "legal_hold_policy_assignments" + }, + "FilesUnderRetention": { + "description": "A list of files under retention.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + }, + "prev_marker": { + "description": "The marker for the start of the previous page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of files.", + "type": "array", + "items": { + "$ref": "#/components/schemas/File--Mini" + } + } + } + } + ], + "title": "Files under retention", + "x-box-resource-id": "files_under_retention", + "x-box-tag": "retention_policy_assignments" + }, "FileVersion": { "description": "A standard representation of a file version.", "type": "object", @@ -32386,116 +32496,6 @@ "x-box-resource-id": "file_versions_on_hold", "x-box-tag": "legal_hold_policy_assignments" }, - "Files": { - "description": "A list of files.", - "type": "object", - "properties": { - "total_count": { - "description": "The number of files.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "entries": { - "description": "A list of files.", - "type": "array", - "items": { - "$ref": "#/components/schemas/File--Full" - } - } - }, - "title": "Files", - "x-box-resource-id": "files", - "x-box-tag": "files" - }, - "FilesOnHold": { - "description": "A list of files on hold for legal policy assignment.", - "type": "object", - "allOf": [ - { - "type": "object", - "description": "The part of an API response that describes marker\nbased pagination.", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of files.", - "type": "array", - "items": { - "$ref": "#/components/schemas/File--Mini" - } - } - } - } - ], - "title": "Files on hold", - "x-box-resource-id": "files_on_hold", - "x-box-tag": "legal_hold_policy_assignments" - }, - "FilesUnderRetention": { - "description": "A list of files under retention.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of files.", - "type": "array", - "items": { - "$ref": "#/components/schemas/File--Mini" - } - } - } - } - ], - "title": "Files under retention", - "x-box-resource-id": "files_under_retention", - "x-box-tag": "retention_policy_assignments" - }, "Folder": { "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default.", "type": "object", @@ -34008,6 +34008,44 @@ ], "title": "Integration mapping mapped item schema for type Teams" }, + "IntegrationMappings": { + "description": "A list of integration mapping\nobjects.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of integration mappings.", + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationMapping" + } + } + } + } + ], + "title": "Integration mappings Slack", + "x-box-resource-id": "integration_mappings_slack", + "x-box-tag": "integration_mappings" + }, "IntegrationMappingSlackCreateRequest": { "description": "A request to create a Slack Integration Mapping object.", "type": "object", @@ -34053,6 +34091,26 @@ }, "title": "Integration mapping options for type Slack" }, + "IntegrationMappingsTeams": { + "description": "A list of integration mapping\nobjects.", + "type": "object", + "allOf": [ + { + "properties": { + "entries": { + "description": "A list of integration mappings.", + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationMappingTeams" + } + } + } + } + ], + "title": "Integration mappings Teams", + "x-box-resource-id": "integration_mappings_teams", + "x-box-tag": "integration_mappings" + }, "IntegrationMappingTeams": { "description": "A Microsoft Teams specific representation of an integration\nmapping object.", "type": "object", @@ -34152,64 +34210,6 @@ "title": "Create teams integration mapping request", "x-box-resource-id": "integration_mapping_teams_create_request" }, - "IntegrationMappings": { - "description": "A list of integration mapping\nobjects.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of integration mappings.", - "type": "array", - "items": { - "$ref": "#/components/schemas/IntegrationMapping" - } - } - } - } - ], - "title": "Integration mappings Slack", - "x-box-resource-id": "integration_mappings_slack", - "x-box-tag": "integration_mappings" - }, - "IntegrationMappingsTeams": { - "description": "A list of integration mapping\nobjects.", - "type": "object", - "allOf": [ - { - "properties": { - "entries": { - "description": "A list of integration mappings.", - "type": "array", - "items": { - "$ref": "#/components/schemas/IntegrationMappingTeams" - } - } - } - } - ], - "title": "Integration mappings Teams", - "x-box-resource-id": "integration_mappings_teams", - "x-box-tag": "integration_mappings" - }, "Invite": { "description": "An invite for a user to an enterprise.", "type": "object", @@ -35445,6 +35445,27 @@ "x-box-resource-id": "metadata_query_results", "x-box-tag": "search" }, + "Metadatas": { + "description": "A list of metadata instances that have been applied to a file or folder.", + "type": "object", + "properties": { + "entries": { + "description": "A list of metadata instances, as applied to this file or folder.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Metadata" + } + }, + "limit": { + "description": "The limit that was used for this page of results.", + "type": "integer", + "example": 100 + } + }, + "title": "Metadata instances", + "x-box-resource-id": "metadatas", + "x-box-tag": "file_metadata" + }, "MetadataTaxonomies": { "description": "A list of metadata taxonomies.", "type": "object", @@ -35916,27 +35937,6 @@ "x-box-resource-id": "metadata_templates", "x-box-tag": "metadata_templates" }, - "Metadatas": { - "description": "A list of metadata instances that have been applied to a file or folder.", - "type": "object", - "properties": { - "entries": { - "description": "A list of metadata instances, as applied to this file or folder.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Metadata" - } - }, - "limit": { - "description": "The limit that was used for this page of results.", - "type": "integer", - "example": 100 - } - }, - "title": "Metadata instances", - "x-box-resource-id": "metadatas", - "x-box-tag": "file_metadata" - }, "OAuth2Error": { "description": "An OAuth 2.0 error.", "type": "object", @@ -36829,6 +36829,129 @@ ], "title": "Search results item" }, + "SearchResults": { + "description": "A list of files, folders and web links that matched the search query.", + "type": "object", + "allOf": [ + { + "type": "object", + "properties": { + "total_count": { + "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", + "type": "integer", + "format": "int64", + "example": 5000 + }, + "limit": { + "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "offset": { + "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", + "type": "integer", + "format": "int64", + "example": 2000 + } + } + }, + { + "properties": { + "type": { + "description": "Specifies the response as search result items without shared links.", + "type": "string", + "example": "search_results_items", + "enum": [ + "search_results_items" + ], + "nullable": false + }, + "entries": { + "description": "The search results for the query provided.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchResultItem" + } + } + } + } + ], + "required": [ + "type" + ], + "title": "Search Results", + "x-box-resource-id": "search_results", + "x-box-tag": "search" + }, + "SearchResultsResponse": { + "description": "Search result from the content search endpoint.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/SearchResults" + }, + { + "$ref": "#/components/schemas/SearchResultsWithSharedLinks" + } + ], + "title": "Search results response" + }, + "SearchResultsWithSharedLinks": { + "description": "A list of files, folders and web links that matched the search query,\nincluding the additional information about any shared links through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the `include_recent_shared_links`\nquery parameter has been set to `true`.", + "type": "object", + "allOf": [ + { + "type": "object", + "properties": { + "total_count": { + "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", + "type": "integer", + "format": "int64", + "example": 5000 + }, + "limit": { + "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "offset": { + "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", + "type": "integer", + "format": "int64", + "example": 2000 + } + } + }, + { + "properties": { + "type": { + "description": "Specifies the response as search result items with shared links.", + "type": "string", + "example": "search_results_with_shared_links", + "enum": [ + "search_results_with_shared_links" + ], + "nullable": false + }, + "entries": { + "description": "The search results for the query provided, including the\nadditional information about any shared links through\nwhich the item has been shared with the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchResultWithSharedLink" + } + } + } + } + ], + "required": [ + "type" + ], + "title": "Search Results (including Shared Links)", + "x-box-resource-id": "search_results_with_shared_links", + "x-box-tag": "search" + }, "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", @@ -36875,129 +36998,6 @@ ], "title": "Search result item" }, - "SearchResults": { - "description": "A list of files, folders and web links that matched the search query.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "total_count": { - "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", - "type": "integer", - "format": "int64", - "example": 5000 - }, - "limit": { - "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "offset": { - "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", - "type": "integer", - "format": "int64", - "example": 2000 - } - } - }, - { - "properties": { - "type": { - "description": "Specifies the response as search result items without shared links.", - "type": "string", - "example": "search_results_items", - "enum": [ - "search_results_items" - ], - "nullable": false - }, - "entries": { - "description": "The search results for the query provided.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchResultItem" - } - } - } - } - ], - "required": [ - "type" - ], - "title": "Search Results", - "x-box-resource-id": "search_results", - "x-box-tag": "search" - }, - "SearchResultsResponse": { - "description": "Search result from the content search endpoint.", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/SearchResults" - }, - { - "$ref": "#/components/schemas/SearchResultsWithSharedLinks" - } - ], - "title": "Search results response" - }, - "SearchResultsWithSharedLinks": { - "description": "A list of files, folders and web links that matched the search query,\nincluding the additional information about any shared links through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the `include_recent_shared_links`\nquery parameter has been set to `true`.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "total_count": { - "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", - "type": "integer", - "format": "int64", - "example": 5000 - }, - "limit": { - "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "offset": { - "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", - "type": "integer", - "format": "int64", - "example": 2000 - } - } - }, - { - "properties": { - "type": { - "description": "Specifies the response as search result items with shared links.", - "type": "string", - "example": "search_results_with_shared_links", - "enum": [ - "search_results_with_shared_links" - ], - "nullable": false - }, - "entries": { - "description": "The search results for the query provided, including the\nadditional information about any shared links through\nwhich the item has been shared with the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchResultWithSharedLink" - } - } - } - } - ], - "required": [ - "type" - ], - "title": "Search Results (including Shared Links)", - "x-box-resource-id": "search_results_with_shared_links", - "x-box-tag": "search" - }, "SessionTerminationMessage": { "description": "A message informing about the\ntermination job status.", "type": "object", @@ -37294,6 +37294,44 @@ "x-box-resource-id": "shield_information_barrier_reports", "x-box-tag": "shield_information_barrier_reports" }, + "ShieldInformationBarriers": { + "description": "List of Shield Information Barrier objects.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of shield information barrier objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShieldInformationBarrier" + } + } + } + } + ], + "title": "List of Shield Information Barriers", + "x-box-resource-id": "shield_information_barriers", + "x-box-tag": "shield_information_barriers" + }, "ShieldInformationBarrierSegment": { "description": "A shield information barrier segment object.", "type": "object", @@ -37778,44 +37816,6 @@ "x-box-resource-id": "shield_information_barrier_segments", "x-box-tag": "shield_information_barrier_segments" }, - "ShieldInformationBarriers": { - "description": "List of Shield Information Barrier objects.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of shield information barrier objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShieldInformationBarrier" - } - } - } - } - ], - "title": "List of Shield Information Barriers", - "x-box-resource-id": "shield_information_barriers", - "x-box-tag": "shield_information_barriers" - }, "SignRequest": { "description": "A Box Sign request object.", "type": "object", @@ -38248,6 +38248,44 @@ }, "title": "Sign request prefill tag" }, + "SignRequests": { + "description": "A standard representation of a signature request, as returned from any Box Sign\nAPI endpoints by default.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of Box Sign requests.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SignRequest" + } + } + } + } + ], + "title": "Box Sign requests", + "x-box-resource-id": "sign_requests", + "x-box-tag": "sign_requests" + }, "SignRequestSigner": { "description": "The schema for a Signer object used\non the body of a Box Sign request object.", "type": "object", @@ -38659,44 +38697,6 @@ ], "title": "Sign Request Signer Input ZIP Validation" }, - "SignRequests": { - "description": "A standard representation of a signature request, as returned from any Box Sign\nAPI endpoints by default.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of Box Sign requests.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SignRequest" - } - } - } - } - ], - "title": "Box Sign requests", - "x-box-resource-id": "sign_requests", - "x-box-tag": "sign_requests" - }, "SignTemplate": { "description": "A Box Sign template object.", "type": "object", @@ -39938,6 +39938,28 @@ "standard" ] }, + "TermsOfServices": { + "description": "A list of terms of services.", + "type": "object", + "properties": { + "total_count": { + "description": "The total number of objects.", + "type": "integer", + "format": "int64", + "example": 2 + }, + "entries": { + "description": "A list of terms of service objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/TermsOfService" + } + } + }, + "title": "Terms of services", + "x-box-resource-id": "terms_of_services", + "x-box-tag": "terms_of_services" + }, "TermsOfServiceUserStatus": { "description": "The association between a Terms of Service and a user.", "type": "object", @@ -40023,28 +40045,6 @@ "x-box-resource-id": "terms_of_services_user_statuses", "x-box-tag": "terms_of_service_user_statuses" }, - "TermsOfServices": { - "description": "A list of terms of services.", - "type": "object", - "properties": { - "total_count": { - "description": "The total number of objects.", - "type": "integer", - "format": "int64", - "example": 2 - }, - "entries": { - "description": "A list of terms of service objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/TermsOfService" - } - } - }, - "title": "Terms of services", - "x-box-resource-id": "terms_of_services", - "x-box-tag": "terms_of_services" - }, "TimelineSkillCard": { "description": "A Box Skill metadata card that places a list of images on a\ntimeline.", "type": "object", @@ -41736,6 +41736,18 @@ "x-box-resource-id": "trash_web_link_restored", "x-box-tag": "trashed_web_links" }, + "UploadedPart": { + "description": "A chunk of a file uploaded as part of\nan upload session, as returned by some endpoints.", + "type": "object", + "properties": { + "part": { + "$ref": "#/components/schemas/UploadPart" + } + }, + "title": "Uploaded part", + "x-box-resource-id": "uploaded_part", + "x-box-tag": "chunked_uploads" + }, "UploadPart": { "description": "The representation of an upload\nsession chunk.", "type": "object", @@ -41966,18 +41978,6 @@ "x-box-resource-id": "upload_url", "x-box-tag": "uploads" }, - "UploadedPart": { - "description": "A chunk of a file uploaded as part of\nan upload session, as returned by some endpoints.", - "type": "object", - "properties": { - "part": { - "$ref": "#/components/schemas/UploadPart" - } - }, - "title": "Uploaded part", - "x-box-resource-id": "uploaded_part", - "x-box-tag": "chunked_uploads" - }, "User": { "description": "A standard representation of a user, as returned from any\nuser API endpoints by default.", "type": "object", @@ -42481,6 +42481,193 @@ "x-box-resource-id": "watermark", "x-box-tag": "file_watermarks" }, + "Webhook": { + "description": "Represents a configured webhook.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/Webhook--Mini" + }, + { + "properties": { + "created_by": { + "allOf": [ + { + "$ref": "#/components/schemas/User--Mini" + }, + { + "description": "The user who created the webhook." + } + ] + }, + "created_at": { + "description": "A timestamp identifying the time that\nthe webhook was created.", + "type": "string", + "format": "date-time", + "example": "2012-12-12T10:53:43-08:00" + }, + "address": { + "description": "The URL that is notified by this webhook.", + "type": "string", + "example": "https://example.com/webhooks" + }, + "triggers": { + "description": "An array of event names that this webhook is\nto be triggered for.", + "type": "array", + "items": { + "title": "Webhook Trigger", + "example": "FILE.UPLOADED", + "type": "string", + "description": "The event name that triggered this webhook.", + "enum": [ + "FILE.UPLOADED", + "FILE.PREVIEWED", + "FILE.DOWNLOADED", + "FILE.TRASHED", + "FILE.DELETED", + "FILE.RESTORED", + "FILE.COPIED", + "FILE.MOVED", + "FILE.LOCKED", + "FILE.UNLOCKED", + "FILE.RENAMED", + "COMMENT.CREATED", + "COMMENT.UPDATED", + "COMMENT.DELETED", + "TASK_ASSIGNMENT.CREATED", + "TASK_ASSIGNMENT.UPDATED", + "METADATA_INSTANCE.CREATED", + "METADATA_INSTANCE.UPDATED", + "METADATA_INSTANCE.DELETED", + "FOLDER.CREATED", + "FOLDER.RENAMED", + "FOLDER.DOWNLOADED", + "FOLDER.RESTORED", + "FOLDER.DELETED", + "FOLDER.COPIED", + "FOLDER.MOVED", + "FOLDER.TRASHED", + "WEBHOOK.DELETED", + "COLLABORATION.CREATED", + "COLLABORATION.ACCEPTED", + "COLLABORATION.REJECTED", + "COLLABORATION.REMOVED", + "COLLABORATION.UPDATED", + "SHARED_LINK.DELETED", + "SHARED_LINK.CREATED", + "SHARED_LINK.UPDATED", + "SIGN_REQUEST.COMPLETED", + "SIGN_REQUEST.DECLINED", + "SIGN_REQUEST.EXPIRED", + "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", + "SIGN_REQUEST.SIGN_SIGNER_SIGNED", + "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", + "SIGN_REQUEST.SIGN_ERROR_FINALIZING" + ] + }, + "example": [ + "FILE.UPLOADED" + ] + } + } + } + ], + "title": "Webhook", + "x-box-resource-id": "webhook", + "x-box-tag": "webhooks", + "x-box-variant": "standard" + }, + "Webhook--Mini": { + "description": "Represents a configured webhook.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier for this webhook.", + "type": "string", + "example": "11446498" + }, + "type": { + "description": "The value will always be `webhook`.", + "type": "string", + "example": "webhook", + "enum": [ + "webhook" + ] + }, + "target": { + "description": "The item that will trigger the webhook.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the item to trigger a webhook.", + "type": "string", + "example": "1231232" + }, + "type": { + "description": "The type of item to trigger a webhook.", + "type": "string", + "example": "file", + "enum": [ + "file", + "folder" + ] + } + } + } + }, + "title": "Webhook (Mini)", + "x-box-resource-id": "webhook--mini", + "x-box-tag": "webhooks", + "x-box-variant": "mini", + "x-box-variants": [ + "mini", + "standard" + ] + }, + "Webhooks": { + "description": "A list of webhooks.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + }, + "prev_marker": { + "description": "The marker for the start of the previous page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of webhooks.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook--Mini" + } + } + } + } + ], + "title": "Webhooks", + "x-box-resource-id": "webhooks", + "x-box-tag": "webhooks" + }, "WebLink": { "description": "Web links are objects that point to URLs. These objects\nare also known as bookmarks within the Box web application.\n\nWeb link objects are treated similarly to file objects,\nthey will also support most actions that apply to regular files.", "type": "object", @@ -42834,193 +43021,6 @@ "x-box-tag": "web_links", "x-box-variant": "mini" }, - "Webhook": { - "description": "Represents a configured webhook.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/Webhook--Mini" - }, - { - "properties": { - "created_by": { - "allOf": [ - { - "$ref": "#/components/schemas/User--Mini" - }, - { - "description": "The user who created the webhook." - } - ] - }, - "created_at": { - "description": "A timestamp identifying the time that\nthe webhook was created.", - "type": "string", - "format": "date-time", - "example": "2012-12-12T10:53:43-08:00" - }, - "address": { - "description": "The URL that is notified by this webhook.", - "type": "string", - "example": "https://example.com/webhooks" - }, - "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for.", - "type": "array", - "items": { - "title": "Webhook Trigger", - "example": "FILE.UPLOADED", - "type": "string", - "description": "The event name that triggered this webhook.", - "enum": [ - "FILE.UPLOADED", - "FILE.PREVIEWED", - "FILE.DOWNLOADED", - "FILE.TRASHED", - "FILE.DELETED", - "FILE.RESTORED", - "FILE.COPIED", - "FILE.MOVED", - "FILE.LOCKED", - "FILE.UNLOCKED", - "FILE.RENAMED", - "COMMENT.CREATED", - "COMMENT.UPDATED", - "COMMENT.DELETED", - "TASK_ASSIGNMENT.CREATED", - "TASK_ASSIGNMENT.UPDATED", - "METADATA_INSTANCE.CREATED", - "METADATA_INSTANCE.UPDATED", - "METADATA_INSTANCE.DELETED", - "FOLDER.CREATED", - "FOLDER.RENAMED", - "FOLDER.DOWNLOADED", - "FOLDER.RESTORED", - "FOLDER.DELETED", - "FOLDER.COPIED", - "FOLDER.MOVED", - "FOLDER.TRASHED", - "WEBHOOK.DELETED", - "COLLABORATION.CREATED", - "COLLABORATION.ACCEPTED", - "COLLABORATION.REJECTED", - "COLLABORATION.REMOVED", - "COLLABORATION.UPDATED", - "SHARED_LINK.DELETED", - "SHARED_LINK.CREATED", - "SHARED_LINK.UPDATED", - "SIGN_REQUEST.COMPLETED", - "SIGN_REQUEST.DECLINED", - "SIGN_REQUEST.EXPIRED", - "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", - "SIGN_REQUEST.SIGN_SIGNER_SIGNED", - "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", - "SIGN_REQUEST.SIGN_ERROR_FINALIZING" - ] - }, - "example": [ - "FILE.UPLOADED" - ] - } - } - } - ], - "title": "Webhook", - "x-box-resource-id": "webhook", - "x-box-tag": "webhooks", - "x-box-variant": "standard" - }, - "Webhook--Mini": { - "description": "Represents a configured webhook.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for this webhook.", - "type": "string", - "example": "11446498" - }, - "type": { - "description": "The value will always be `webhook`.", - "type": "string", - "example": "webhook", - "enum": [ - "webhook" - ] - }, - "target": { - "description": "The item that will trigger the webhook.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the item to trigger a webhook.", - "type": "string", - "example": "1231232" - }, - "type": { - "description": "The type of item to trigger a webhook.", - "type": "string", - "example": "file", - "enum": [ - "file", - "folder" - ] - } - } - } - }, - "title": "Webhook (Mini)", - "x-box-resource-id": "webhook--mini", - "x-box-tag": "webhooks", - "x-box-variant": "mini", - "x-box-variants": [ - "mini", - "standard" - ] - }, - "Webhooks": { - "description": "A list of webhooks.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of webhooks.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook--Mini" - } - } - } - } - ], - "title": "Webhooks", - "x-box-resource-id": "webhooks", - "x-box-tag": "webhooks" - }, "Workflow": { "description": "Box Relay Workflows are objects that represent a named collection of flows.\n\nYour application must be authorized to use the `Manage Box Relay` application\nscope within the developer console in order to use this resource.", "type": "object", diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index c27e4d6f..db085b6d 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "dfe9629b78" + "x-box-commit-hash": "3d705a6550" }, "servers": [ { @@ -2468,7 +2468,7 @@ "delete": { "operationId": "delete_archives_id_v2025.0", "summary": "Delete archive", - "description": "Permanently deletes an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).", + "description": "Permanently deletes an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).\n\n\nThis endpoint is currently unavailable. Please contact support for assistance.\n", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" @@ -5717,6 +5717,44 @@ ], "title": "Box Hub Collaboration Create Request" }, + "HubCollaborations": { + "description": "A list of Box Hub collaborations.", + "type": "object", + "allOf": [ + { + "properties": { + "entries": { + "description": "A list of Box Hub collaborations.", + "type": "array", + "items": { + "$ref": "#/components/schemas/HubCollaboration" + } + } + } + }, + { + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + } + ], + "title": "Box Hub Collaborations", + "x-box-resource-id": "hub_collaborations_v2025.0", + "x-box-tag": "hub_collaborations" + }, "HubCollaborationUpdateRequest": { "description": "Request body for updating an existing Box Hub collaboration.", "type": "object", @@ -5757,44 +5795,6 @@ ], "title": "Box Hub Collaboration User" }, - "HubCollaborations": { - "description": "A list of Box Hub collaborations.", - "type": "object", - "allOf": [ - { - "properties": { - "entries": { - "description": "A list of Box Hub collaborations.", - "type": "array", - "items": { - "$ref": "#/components/schemas/HubCollaboration" - } - } - } - }, - { - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - } - ], - "title": "Box Hub Collaborations", - "x-box-resource-id": "hub_collaborations_v2025.0", - "x-box-tag": "hub_collaborations" - }, "HubCopyRequest": { "description": "Request schema for copying a Box Hub.", "type": "object", @@ -6004,44 +6004,6 @@ "x-box-resource-id": "hub_items_manage_response_v2025.0", "x-box-tag": "hub_items" }, - "HubUpdateRequest": { - "description": "Request schema for updating an existing Box Hub.", - "type": "object", - "properties": { - "title": { - "description": "Title of the Box Hub. It cannot be empty and should be less than 50 characters.", - "type": "string", - "example": "Hub Title", - "maxLength": 50 - }, - "description": { - "description": "Description of the Box Hub.", - "type": "string", - "example": "This is a description of the Box Hub." - }, - "is_ai_enabled": { - "description": "Indicates if AI features are enabled for the Box Hub.", - "type": "boolean", - "example": true - }, - "is_collaboration_restricted_to_enterprise": { - "description": "Indicates if collaboration is restricted to the enterprise.", - "type": "boolean", - "example": true - }, - "can_non_owners_invite": { - "description": "Indicates if non-owners can invite others to the Box Hub.", - "type": "boolean", - "example": true - }, - "can_shared_link_be_created": { - "description": "Indicates if a shared link can be created for the Box Hub.", - "type": "boolean", - "example": true - } - }, - "title": "Box Hub Update Request" - }, "Hubs": { "description": "A paginated list of hubs.", "type": "object", @@ -6080,6 +6042,44 @@ "x-box-resource-id": "hubs_v2025.0", "x-box-tag": "hubs" }, + "HubUpdateRequest": { + "description": "Request schema for updating an existing Box Hub.", + "type": "object", + "properties": { + "title": { + "description": "Title of the Box Hub. It cannot be empty and should be less than 50 characters.", + "type": "string", + "example": "Hub Title", + "maxLength": 50 + }, + "description": { + "description": "Description of the Box Hub.", + "type": "string", + "example": "This is a description of the Box Hub." + }, + "is_ai_enabled": { + "description": "Indicates if AI features are enabled for the Box Hub.", + "type": "boolean", + "example": true + }, + "is_collaboration_restricted_to_enterprise": { + "description": "Indicates if collaboration is restricted to the enterprise.", + "type": "boolean", + "example": true + }, + "can_non_owners_invite": { + "description": "Indicates if non-owners can invite others to the Box Hub.", + "type": "boolean", + "example": true + }, + "can_shared_link_be_created": { + "description": "Indicates if a shared link can be created for the Box Hub.", + "type": "boolean", + "example": true + } + }, + "title": "Box Hub Update Request" + }, "KeysafeSettings": { "description": "The KeySafe settings.", "type": "object", diff --git a/openapi/openapi.json b/openapi/openapi.json index a514498f..3f97dff2 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "dfe9629b78" + "x-box-commit-hash": "3d705a6550" }, "servers": [ { @@ -30544,6 +30544,41 @@ "x-box-resource-id": "event", "x-box-tag": "events" }, + "Events": { + "description": "A list of event objects.", + "type": "object", + "properties": { + "chunk_size": { + "description": "The number of events returned in this response.", + "type": "integer", + "format": "int64", + "example": 2 + }, + "next_stream_position": { + "description": "The stream position of the start of the next page (chunk)\nof events.", + "example": "1152922976252290886", + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer", + "format": "int64" + } + ] + }, + "entries": { + "description": "A list of events.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + } + } + }, + "title": "Events", + "x-box-resource-id": "events", + "x-box-tag": "events" + }, "EventSource": { "description": "The source file or folder that triggered an event in\nthe event stream.", "type": "object", @@ -30639,41 +30674,6 @@ ], "title": "Event source resource" }, - "Events": { - "description": "A list of event objects.", - "type": "object", - "properties": { - "chunk_size": { - "description": "The number of events returned in this response.", - "type": "integer", - "format": "int64", - "example": 2 - }, - "next_stream_position": { - "description": "The stream position of the start of the next page (chunk)\nof events.", - "example": "1152922976252290886", - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer", - "format": "int64" - } - ] - }, - "entries": { - "description": "A list of events.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } - } - }, - "title": "Events", - "x-box-resource-id": "events", - "x-box-tag": "events" - }, "File": { "description": "A standard representation of a file, as returned from any\nfile API endpoints by default.", "type": "object", @@ -31890,6 +31890,116 @@ }, "title": "File Request (Update)" }, + "Files": { + "description": "A list of files.", + "type": "object", + "properties": { + "total_count": { + "description": "The number of files.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "entries": { + "description": "A list of files.", + "type": "array", + "items": { + "$ref": "#/components/schemas/File--Full" + } + } + }, + "title": "Files", + "x-box-resource-id": "files", + "x-box-tag": "files" + }, + "FilesOnHold": { + "description": "A list of files on hold for legal policy assignment.", + "type": "object", + "allOf": [ + { + "type": "object", + "description": "The part of an API response that describes marker\nbased pagination.", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + }, + "prev_marker": { + "description": "The marker for the start of the previous page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of files.", + "type": "array", + "items": { + "$ref": "#/components/schemas/File--Mini" + } + } + } + } + ], + "title": "Files on hold", + "x-box-resource-id": "files_on_hold", + "x-box-tag": "legal_hold_policy_assignments" + }, + "FilesUnderRetention": { + "description": "A list of files under retention.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + }, + "prev_marker": { + "description": "The marker for the start of the previous page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of files.", + "type": "array", + "items": { + "$ref": "#/components/schemas/File--Mini" + } + } + } + } + ], + "title": "Files under retention", + "x-box-resource-id": "files_under_retention", + "x-box-tag": "retention_policy_assignments" + }, "FileVersion": { "description": "A standard representation of a file version.", "type": "object", @@ -32386,116 +32496,6 @@ "x-box-resource-id": "file_versions_on_hold", "x-box-tag": "legal_hold_policy_assignments" }, - "Files": { - "description": "A list of files.", - "type": "object", - "properties": { - "total_count": { - "description": "The number of files.", - "type": "integer", - "format": "int64", - "example": 1 - }, - "entries": { - "description": "A list of files.", - "type": "array", - "items": { - "$ref": "#/components/schemas/File--Full" - } - } - }, - "title": "Files", - "x-box-resource-id": "files", - "x-box-tag": "files" - }, - "FilesOnHold": { - "description": "A list of files on hold for legal policy assignment.", - "type": "object", - "allOf": [ - { - "type": "object", - "description": "The part of an API response that describes marker\nbased pagination.", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of files.", - "type": "array", - "items": { - "$ref": "#/components/schemas/File--Mini" - } - } - } - } - ], - "title": "Files on hold", - "x-box-resource-id": "files_on_hold", - "x-box-tag": "legal_hold_policy_assignments" - }, - "FilesUnderRetention": { - "description": "A list of files under retention.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of files.", - "type": "array", - "items": { - "$ref": "#/components/schemas/File--Mini" - } - } - } - } - ], - "title": "Files under retention", - "x-box-resource-id": "files_under_retention", - "x-box-tag": "retention_policy_assignments" - }, "Folder": { "description": "A standard representation of a folder, as returned from any\nfolder API endpoints by default.", "type": "object", @@ -34008,6 +34008,44 @@ ], "title": "Integration mapping mapped item schema for type Teams" }, + "IntegrationMappings": { + "description": "A list of integration mapping\nobjects.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of integration mappings.", + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationMapping" + } + } + } + } + ], + "title": "Integration mappings Slack", + "x-box-resource-id": "integration_mappings_slack", + "x-box-tag": "integration_mappings" + }, "IntegrationMappingSlackCreateRequest": { "description": "A request to create a Slack Integration Mapping object.", "type": "object", @@ -34053,6 +34091,26 @@ }, "title": "Integration mapping options for type Slack" }, + "IntegrationMappingsTeams": { + "description": "A list of integration mapping\nobjects.", + "type": "object", + "allOf": [ + { + "properties": { + "entries": { + "description": "A list of integration mappings.", + "type": "array", + "items": { + "$ref": "#/components/schemas/IntegrationMappingTeams" + } + } + } + } + ], + "title": "Integration mappings Teams", + "x-box-resource-id": "integration_mappings_teams", + "x-box-tag": "integration_mappings" + }, "IntegrationMappingTeams": { "description": "A Microsoft Teams specific representation of an integration\nmapping object.", "type": "object", @@ -34152,64 +34210,6 @@ "title": "Create teams integration mapping request", "x-box-resource-id": "integration_mapping_teams_create_request" }, - "IntegrationMappings": { - "description": "A list of integration mapping\nobjects.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of integration mappings.", - "type": "array", - "items": { - "$ref": "#/components/schemas/IntegrationMapping" - } - } - } - } - ], - "title": "Integration mappings Slack", - "x-box-resource-id": "integration_mappings_slack", - "x-box-tag": "integration_mappings" - }, - "IntegrationMappingsTeams": { - "description": "A list of integration mapping\nobjects.", - "type": "object", - "allOf": [ - { - "properties": { - "entries": { - "description": "A list of integration mappings.", - "type": "array", - "items": { - "$ref": "#/components/schemas/IntegrationMappingTeams" - } - } - } - } - ], - "title": "Integration mappings Teams", - "x-box-resource-id": "integration_mappings_teams", - "x-box-tag": "integration_mappings" - }, "Invite": { "description": "An invite for a user to an enterprise.", "type": "object", @@ -35445,6 +35445,27 @@ "x-box-resource-id": "metadata_query_results", "x-box-tag": "search" }, + "Metadatas": { + "description": "A list of metadata instances that have been applied to a file or folder.", + "type": "object", + "properties": { + "entries": { + "description": "A list of metadata instances, as applied to this file or folder.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Metadata" + } + }, + "limit": { + "description": "The limit that was used for this page of results.", + "type": "integer", + "example": 100 + } + }, + "title": "Metadata instances", + "x-box-resource-id": "metadatas", + "x-box-tag": "file_metadata" + }, "MetadataTaxonomies": { "description": "A list of metadata taxonomies.", "type": "object", @@ -35916,27 +35937,6 @@ "x-box-resource-id": "metadata_templates", "x-box-tag": "metadata_templates" }, - "Metadatas": { - "description": "A list of metadata instances that have been applied to a file or folder.", - "type": "object", - "properties": { - "entries": { - "description": "A list of metadata instances, as applied to this file or folder.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Metadata" - } - }, - "limit": { - "description": "The limit that was used for this page of results.", - "type": "integer", - "example": 100 - } - }, - "title": "Metadata instances", - "x-box-resource-id": "metadatas", - "x-box-tag": "file_metadata" - }, "OAuth2Error": { "description": "An OAuth 2.0 error.", "type": "object", @@ -36829,6 +36829,129 @@ ], "title": "Search results item" }, + "SearchResults": { + "description": "A list of files, folders and web links that matched the search query.", + "type": "object", + "allOf": [ + { + "type": "object", + "properties": { + "total_count": { + "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", + "type": "integer", + "format": "int64", + "example": 5000 + }, + "limit": { + "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "offset": { + "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", + "type": "integer", + "format": "int64", + "example": 2000 + } + } + }, + { + "properties": { + "type": { + "description": "Specifies the response as search result items without shared links.", + "type": "string", + "example": "search_results_items", + "enum": [ + "search_results_items" + ], + "nullable": false + }, + "entries": { + "description": "The search results for the query provided.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchResultItem" + } + } + } + } + ], + "required": [ + "type" + ], + "title": "Search Results", + "x-box-resource-id": "search_results", + "x-box-tag": "search" + }, + "SearchResultsResponse": { + "description": "Search result from the content search endpoint.", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/SearchResults" + }, + { + "$ref": "#/components/schemas/SearchResultsWithSharedLinks" + } + ], + "title": "Search results response" + }, + "SearchResultsWithSharedLinks": { + "description": "A list of files, folders and web links that matched the search query,\nincluding the additional information about any shared links through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the `include_recent_shared_links`\nquery parameter has been set to `true`.", + "type": "object", + "allOf": [ + { + "type": "object", + "properties": { + "total_count": { + "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", + "type": "integer", + "format": "int64", + "example": 5000 + }, + "limit": { + "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "offset": { + "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", + "type": "integer", + "format": "int64", + "example": 2000 + } + } + }, + { + "properties": { + "type": { + "description": "Specifies the response as search result items with shared links.", + "type": "string", + "example": "search_results_with_shared_links", + "enum": [ + "search_results_with_shared_links" + ], + "nullable": false + }, + "entries": { + "description": "The search results for the query provided, including the\nadditional information about any shared links through\nwhich the item has been shared with the user.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SearchResultWithSharedLink" + } + } + } + } + ], + "required": [ + "type" + ], + "title": "Search Results (including Shared Links)", + "x-box-resource-id": "search_results_with_shared_links", + "x-box-tag": "search" + }, "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", @@ -36875,129 +36998,6 @@ ], "title": "Search result item" }, - "SearchResults": { - "description": "A list of files, folders and web links that matched the search query.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "total_count": { - "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", - "type": "integer", - "format": "int64", - "example": 5000 - }, - "limit": { - "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "offset": { - "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", - "type": "integer", - "format": "int64", - "example": 2000 - } - } - }, - { - "properties": { - "type": { - "description": "Specifies the response as search result items without shared links.", - "type": "string", - "example": "search_results_items", - "enum": [ - "search_results_items" - ], - "nullable": false - }, - "entries": { - "description": "The search results for the query provided.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchResultItem" - } - } - } - } - ], - "required": [ - "type" - ], - "title": "Search Results", - "x-box-resource-id": "search_results", - "x-box-tag": "search" - }, - "SearchResultsResponse": { - "description": "Search result from the content search endpoint.", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/SearchResults" - }, - { - "$ref": "#/components/schemas/SearchResultsWithSharedLinks" - } - ], - "title": "Search results response" - }, - "SearchResultsWithSharedLinks": { - "description": "A list of files, folders and web links that matched the search query,\nincluding the additional information about any shared links through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the `include_recent_shared_links`\nquery parameter has been set to `true`.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "total_count": { - "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.", - "type": "integer", - "format": "int64", - "example": 5000 - }, - "limit": { - "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "offset": { - "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.", - "type": "integer", - "format": "int64", - "example": 2000 - } - } - }, - { - "properties": { - "type": { - "description": "Specifies the response as search result items with shared links.", - "type": "string", - "example": "search_results_with_shared_links", - "enum": [ - "search_results_with_shared_links" - ], - "nullable": false - }, - "entries": { - "description": "The search results for the query provided, including the\nadditional information about any shared links through\nwhich the item has been shared with the user.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchResultWithSharedLink" - } - } - } - } - ], - "required": [ - "type" - ], - "title": "Search Results (including Shared Links)", - "x-box-resource-id": "search_results_with_shared_links", - "x-box-tag": "search" - }, "SessionTerminationMessage": { "description": "A message informing about the\ntermination job status.", "type": "object", @@ -37294,6 +37294,44 @@ "x-box-resource-id": "shield_information_barrier_reports", "x-box-tag": "shield_information_barrier_reports" }, + "ShieldInformationBarriers": { + "description": "List of Shield Information Barrier objects.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of shield information barrier objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShieldInformationBarrier" + } + } + } + } + ], + "title": "List of Shield Information Barriers", + "x-box-resource-id": "shield_information_barriers", + "x-box-tag": "shield_information_barriers" + }, "ShieldInformationBarrierSegment": { "description": "A shield information barrier segment object.", "type": "object", @@ -37778,44 +37816,6 @@ "x-box-resource-id": "shield_information_barrier_segments", "x-box-tag": "shield_information_barrier_segments" }, - "ShieldInformationBarriers": { - "description": "List of Shield Information Barrier objects.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of shield information barrier objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShieldInformationBarrier" - } - } - } - } - ], - "title": "List of Shield Information Barriers", - "x-box-resource-id": "shield_information_barriers", - "x-box-tag": "shield_information_barriers" - }, "SignRequest": { "description": "A Box Sign request object.", "type": "object", @@ -38248,6 +38248,44 @@ }, "title": "Sign request prefill tag" }, + "SignRequests": { + "description": "A standard representation of a signature request, as returned from any Box Sign\nAPI endpoints by default.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of Box Sign requests.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SignRequest" + } + } + } + } + ], + "title": "Box Sign requests", + "x-box-resource-id": "sign_requests", + "x-box-tag": "sign_requests" + }, "SignRequestSigner": { "description": "The schema for a Signer object used\non the body of a Box Sign request object.", "type": "object", @@ -38659,44 +38697,6 @@ ], "title": "Sign Request Signer Input ZIP Validation" }, - "SignRequests": { - "description": "A standard representation of a signature request, as returned from any Box Sign\nAPI endpoints by default.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of Box Sign requests.", - "type": "array", - "items": { - "$ref": "#/components/schemas/SignRequest" - } - } - } - } - ], - "title": "Box Sign requests", - "x-box-resource-id": "sign_requests", - "x-box-tag": "sign_requests" - }, "SignTemplate": { "description": "A Box Sign template object.", "type": "object", @@ -39938,6 +39938,28 @@ "standard" ] }, + "TermsOfServices": { + "description": "A list of terms of services.", + "type": "object", + "properties": { + "total_count": { + "description": "The total number of objects.", + "type": "integer", + "format": "int64", + "example": 2 + }, + "entries": { + "description": "A list of terms of service objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/TermsOfService" + } + } + }, + "title": "Terms of services", + "x-box-resource-id": "terms_of_services", + "x-box-tag": "terms_of_services" + }, "TermsOfServiceUserStatus": { "description": "The association between a Terms of Service and a user.", "type": "object", @@ -40023,28 +40045,6 @@ "x-box-resource-id": "terms_of_services_user_statuses", "x-box-tag": "terms_of_service_user_statuses" }, - "TermsOfServices": { - "description": "A list of terms of services.", - "type": "object", - "properties": { - "total_count": { - "description": "The total number of objects.", - "type": "integer", - "format": "int64", - "example": 2 - }, - "entries": { - "description": "A list of terms of service objects.", - "type": "array", - "items": { - "$ref": "#/components/schemas/TermsOfService" - } - } - }, - "title": "Terms of services", - "x-box-resource-id": "terms_of_services", - "x-box-tag": "terms_of_services" - }, "TimelineSkillCard": { "description": "A Box Skill metadata card that places a list of images on a\ntimeline.", "type": "object", @@ -41736,6 +41736,18 @@ "x-box-resource-id": "trash_web_link_restored", "x-box-tag": "trashed_web_links" }, + "UploadedPart": { + "description": "A chunk of a file uploaded as part of\nan upload session, as returned by some endpoints.", + "type": "object", + "properties": { + "part": { + "$ref": "#/components/schemas/UploadPart" + } + }, + "title": "Uploaded part", + "x-box-resource-id": "uploaded_part", + "x-box-tag": "chunked_uploads" + }, "UploadPart": { "description": "The representation of an upload\nsession chunk.", "type": "object", @@ -41966,18 +41978,6 @@ "x-box-resource-id": "upload_url", "x-box-tag": "uploads" }, - "UploadedPart": { - "description": "A chunk of a file uploaded as part of\nan upload session, as returned by some endpoints.", - "type": "object", - "properties": { - "part": { - "$ref": "#/components/schemas/UploadPart" - } - }, - "title": "Uploaded part", - "x-box-resource-id": "uploaded_part", - "x-box-tag": "chunked_uploads" - }, "User": { "description": "A standard representation of a user, as returned from any\nuser API endpoints by default.", "type": "object", @@ -42481,6 +42481,193 @@ "x-box-resource-id": "watermark", "x-box-tag": "file_watermarks" }, + "Webhook": { + "description": "Represents a configured webhook.", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/Webhook--Mini" + }, + { + "properties": { + "created_by": { + "allOf": [ + { + "$ref": "#/components/schemas/User--Mini" + }, + { + "description": "The user who created the webhook." + } + ] + }, + "created_at": { + "description": "A timestamp identifying the time that\nthe webhook was created.", + "type": "string", + "format": "date-time", + "example": "2012-12-12T10:53:43-08:00" + }, + "address": { + "description": "The URL that is notified by this webhook.", + "type": "string", + "example": "https://example.com/webhooks" + }, + "triggers": { + "description": "An array of event names that this webhook is\nto be triggered for.", + "type": "array", + "items": { + "title": "Webhook Trigger", + "example": "FILE.UPLOADED", + "type": "string", + "description": "The event name that triggered this webhook.", + "enum": [ + "FILE.UPLOADED", + "FILE.PREVIEWED", + "FILE.DOWNLOADED", + "FILE.TRASHED", + "FILE.DELETED", + "FILE.RESTORED", + "FILE.COPIED", + "FILE.MOVED", + "FILE.LOCKED", + "FILE.UNLOCKED", + "FILE.RENAMED", + "COMMENT.CREATED", + "COMMENT.UPDATED", + "COMMENT.DELETED", + "TASK_ASSIGNMENT.CREATED", + "TASK_ASSIGNMENT.UPDATED", + "METADATA_INSTANCE.CREATED", + "METADATA_INSTANCE.UPDATED", + "METADATA_INSTANCE.DELETED", + "FOLDER.CREATED", + "FOLDER.RENAMED", + "FOLDER.DOWNLOADED", + "FOLDER.RESTORED", + "FOLDER.DELETED", + "FOLDER.COPIED", + "FOLDER.MOVED", + "FOLDER.TRASHED", + "WEBHOOK.DELETED", + "COLLABORATION.CREATED", + "COLLABORATION.ACCEPTED", + "COLLABORATION.REJECTED", + "COLLABORATION.REMOVED", + "COLLABORATION.UPDATED", + "SHARED_LINK.DELETED", + "SHARED_LINK.CREATED", + "SHARED_LINK.UPDATED", + "SIGN_REQUEST.COMPLETED", + "SIGN_REQUEST.DECLINED", + "SIGN_REQUEST.EXPIRED", + "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", + "SIGN_REQUEST.SIGN_SIGNER_SIGNED", + "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", + "SIGN_REQUEST.SIGN_ERROR_FINALIZING" + ] + }, + "example": [ + "FILE.UPLOADED" + ] + } + } + } + ], + "title": "Webhook", + "x-box-resource-id": "webhook", + "x-box-tag": "webhooks", + "x-box-variant": "standard" + }, + "Webhook--Mini": { + "description": "Represents a configured webhook.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier for this webhook.", + "type": "string", + "example": "11446498" + }, + "type": { + "description": "The value will always be `webhook`.", + "type": "string", + "example": "webhook", + "enum": [ + "webhook" + ] + }, + "target": { + "description": "The item that will trigger the webhook.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the item to trigger a webhook.", + "type": "string", + "example": "1231232" + }, + "type": { + "description": "The type of item to trigger a webhook.", + "type": "string", + "example": "file", + "enum": [ + "file", + "folder" + ] + } + } + } + }, + "title": "Webhook (Mini)", + "x-box-resource-id": "webhook--mini", + "x-box-tag": "webhooks", + "x-box-variant": "mini", + "x-box-variants": [ + "mini", + "standard" + ] + }, + "Webhooks": { + "description": "A list of webhooks.", + "type": "object", + "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.", + "type": "integer", + "format": "int64", + "example": 1000 + }, + "next_marker": { + "description": "The marker for the start of the next page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", + "nullable": true + }, + "prev_marker": { + "description": "The marker for the start of the previous page of results.", + "type": "string", + "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", + "nullable": true + } + } + }, + { + "properties": { + "entries": { + "description": "A list of webhooks.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook--Mini" + } + } + } + } + ], + "title": "Webhooks", + "x-box-resource-id": "webhooks", + "x-box-tag": "webhooks" + }, "WebLink": { "description": "Web links are objects that point to URLs. These objects\nare also known as bookmarks within the Box web application.\n\nWeb link objects are treated similarly to file objects,\nthey will also support most actions that apply to regular files.", "type": "object", @@ -42834,193 +43021,6 @@ "x-box-tag": "web_links", "x-box-variant": "mini" }, - "Webhook": { - "description": "Represents a configured webhook.", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/Webhook--Mini" - }, - { - "properties": { - "created_by": { - "allOf": [ - { - "$ref": "#/components/schemas/User--Mini" - }, - { - "description": "The user who created the webhook." - } - ] - }, - "created_at": { - "description": "A timestamp identifying the time that\nthe webhook was created.", - "type": "string", - "format": "date-time", - "example": "2012-12-12T10:53:43-08:00" - }, - "address": { - "description": "The URL that is notified by this webhook.", - "type": "string", - "example": "https://example.com/webhooks" - }, - "triggers": { - "description": "An array of event names that this webhook is\nto be triggered for.", - "type": "array", - "items": { - "title": "Webhook Trigger", - "example": "FILE.UPLOADED", - "type": "string", - "description": "The event name that triggered this webhook.", - "enum": [ - "FILE.UPLOADED", - "FILE.PREVIEWED", - "FILE.DOWNLOADED", - "FILE.TRASHED", - "FILE.DELETED", - "FILE.RESTORED", - "FILE.COPIED", - "FILE.MOVED", - "FILE.LOCKED", - "FILE.UNLOCKED", - "FILE.RENAMED", - "COMMENT.CREATED", - "COMMENT.UPDATED", - "COMMENT.DELETED", - "TASK_ASSIGNMENT.CREATED", - "TASK_ASSIGNMENT.UPDATED", - "METADATA_INSTANCE.CREATED", - "METADATA_INSTANCE.UPDATED", - "METADATA_INSTANCE.DELETED", - "FOLDER.CREATED", - "FOLDER.RENAMED", - "FOLDER.DOWNLOADED", - "FOLDER.RESTORED", - "FOLDER.DELETED", - "FOLDER.COPIED", - "FOLDER.MOVED", - "FOLDER.TRASHED", - "WEBHOOK.DELETED", - "COLLABORATION.CREATED", - "COLLABORATION.ACCEPTED", - "COLLABORATION.REJECTED", - "COLLABORATION.REMOVED", - "COLLABORATION.UPDATED", - "SHARED_LINK.DELETED", - "SHARED_LINK.CREATED", - "SHARED_LINK.UPDATED", - "SIGN_REQUEST.COMPLETED", - "SIGN_REQUEST.DECLINED", - "SIGN_REQUEST.EXPIRED", - "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", - "SIGN_REQUEST.SIGN_SIGNER_SIGNED", - "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", - "SIGN_REQUEST.SIGN_ERROR_FINALIZING" - ] - }, - "example": [ - "FILE.UPLOADED" - ] - } - } - } - ], - "title": "Webhook", - "x-box-resource-id": "webhook", - "x-box-tag": "webhooks", - "x-box-variant": "standard" - }, - "Webhook--Mini": { - "description": "Represents a configured webhook.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for this webhook.", - "type": "string", - "example": "11446498" - }, - "type": { - "description": "The value will always be `webhook`.", - "type": "string", - "example": "webhook", - "enum": [ - "webhook" - ] - }, - "target": { - "description": "The item that will trigger the webhook.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the item to trigger a webhook.", - "type": "string", - "example": "1231232" - }, - "type": { - "description": "The type of item to trigger a webhook.", - "type": "string", - "example": "file", - "enum": [ - "file", - "folder" - ] - } - } - } - }, - "title": "Webhook (Mini)", - "x-box-resource-id": "webhook--mini", - "x-box-tag": "webhooks", - "x-box-variant": "mini", - "x-box-variants": [ - "mini", - "standard" - ] - }, - "Webhooks": { - "description": "A list of webhooks.", - "type": "object", - "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.", - "type": "integer", - "format": "int64", - "example": 1000 - }, - "next_marker": { - "description": "The marker for the start of the next page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", - "nullable": true - }, - "prev_marker": { - "description": "The marker for the start of the previous page of results.", - "type": "string", - "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", - "nullable": true - } - } - }, - { - "properties": { - "entries": { - "description": "A list of webhooks.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook--Mini" - } - } - } - } - ], - "title": "Webhooks", - "x-box-resource-id": "webhooks", - "x-box-tag": "webhooks" - }, "Workflow": { "description": "Box Relay Workflows are objects that represent a named collection of flows.\n\nYour application must be authorized to use the `Manage Box Relay` application\nscope within the developer console in order to use this resource.", "type": "object",