-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add Hubs Beta (box/box-openapi#453) (#333)
Co-authored-by: box-sdk-build <[email protected]>
- Loading branch information
1 parent
cfd8988
commit 40359c7
Showing
12 changed files
with
908 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{ "engineHash": "2994c4a", "specHash": "739d87b", "version": "1.5.1" } | ||
{ "engineHash": "2994c4a", "specHash": "6ca858e", "version": "1.5.1" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# AppItemAssociationsManager | ||
|
||
- [List file app item associations](#list-file-app-item-associations) | ||
- [List folder app item associations](#list-folder-app-item-associations) | ||
|
||
## List file app item associations | ||
|
||
**This is a beta feature, which means that its availability might be limited.** | ||
Returns all app items the file is associated with. This includes app items | ||
associated with ancestors of the file. Assuming the context user has access | ||
to the file, the type/ids are revealed even if the context user does not | ||
have **View** permission on the app item. | ||
|
||
This operation is performed by calling function `getFileAppItemAssociations`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/get-files-id-app-item-associations/). | ||
|
||
_Currently we don't have an example for calling `getFileAppItemAssociations` in integration tests_ | ||
|
||
### Arguments | ||
|
||
- fileId `string` | ||
- The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" | ||
- optionalsInput `GetFileAppItemAssociationsOptionalsInput` | ||
- | ||
|
||
### Returns | ||
|
||
This function returns a value of type `AppItemAssociations`. | ||
|
||
Returns a collection of app item objects. If there are no | ||
app items on this file, an empty collection will be returned. | ||
This list includes app items on ancestors of this File. | ||
|
||
## List folder app item associations | ||
|
||
**This is a beta feature, which means that its availability might be limited.** | ||
Returns all app items the folder is associated with. This includes app items | ||
associated with ancestors of the folder. Assuming the context user has access | ||
to the folder, the type/ids are revealed even if the context user does not | ||
have **View** permission on the app item. | ||
|
||
This operation is performed by calling function `getFolderAppItemAssociations`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/get-folders-id-app-item-associations/). | ||
|
||
_Currently we don't have an example for calling `getFolderAppItemAssociations` in integration tests_ | ||
|
||
### Arguments | ||
|
||
- folderId `string` | ||
- The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" | ||
- optionalsInput `GetFolderAppItemAssociationsOptionalsInput` | ||
- | ||
|
||
### Returns | ||
|
||
This function returns a value of type `AppItemAssociations`. | ||
|
||
Returns a collection of app item objects. If there are no | ||
app items on this folder an empty collection will be returned. | ||
This list includes app items on ancestors of this folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.