box-node-sdk

UserCollaborationsManager

• Get collaboration
• Update collaboration
• Remove collaboration
• Create collaboration

Get collaboration

Retrieves a single collaboration.

This operation is performed by calling function getCollaborationById.

See the endpoint docs at API Reference.

await client.userCollaborations.getCollaborationById(collaborationId);

Arguments

• collaborationId string
  • The ID of the collaboration. Example: “1234”
• optionalsInput GetCollaborationByIdOptionalsInput

Returns

This function returns a value of type Collaboration.

Returns a collaboration object.

Update collaboration

Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.

This operation is performed by calling function updateCollaborationById.

See the endpoint docs at API Reference.

await client.userCollaborations.updateCollaborationById(collaborationId, {
  requestBody: {
    role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
  } satisfies UpdateCollaborationByIdRequestBody,
} satisfies UpdateCollaborationByIdOptionalsInput);

Arguments

• collaborationId string
  • The ID of the collaboration. Example: “1234”
• optionalsInput UpdateCollaborationByIdOptionalsInput

Returns

This function returns a value of type undefined | Collaboration.

Returns an updated collaboration object unless the owner has changed.If the role is changed to owner, the collaboration is deleted and a new collaboration is created. The previous owner of the old collaboration will be a co-owner on the new collaboration.

Remove collaboration

Deletes a single collaboration.

This operation is performed by calling function deleteCollaborationById.

See the endpoint docs at API Reference.

await client.userCollaborations.deleteCollaborationById(collaborationId);

Arguments

• collaborationId string
  • The ID of the collaboration. Example: “1234”
• optionalsInput DeleteCollaborationByIdOptionalsInput

Returns

This function returns a value of type undefined.

A blank response is returned if the collaboration was successfully deleted.

Create collaboration

Adds a collaboration for a single user or a single group to a file or folder.

Collaborations can be created using email address, user IDs, or a group IDs.

If a collaboration is being created with a group, access to this endpoint is dependent on the group’s ability to be invited.

If collaboration is in pending status, the following fields are redacted:

• login and name are hidden if a collaboration was created using user_id,
• name is hidden if a collaboration was created using login.

This operation is performed by calling function createCollaboration.

See the endpoint docs at API Reference.

await client.userCollaborations.createCollaboration({
  item: {
    type: 'folder' as CreateCollaborationRequestBodyItemTypeField,
    id: folder.id,
  } satisfies CreateCollaborationRequestBodyItemField,
  accessibleBy: {
    type: 'user' as CreateCollaborationRequestBodyAccessibleByTypeField,
    id: user.id,
  } satisfies CreateCollaborationRequestBodyAccessibleByField,
  role: 'editor' as CreateCollaborationRequestBodyRoleField,
} satisfies CreateCollaborationRequestBody);

Arguments

• requestBody CreateCollaborationRequestBody
  • Request body of createCollaboration method
• optionalsInput CreateCollaborationOptionalsInput

Returns

This function returns a value of type Collaboration.

Returns a new collaboration object.

This site is open source. Improve this page.