Skip to content

Latest commit

 

History

History
91 lines (51 loc) · 2.14 KB

collections.md

File metadata and controls

91 lines (51 loc) · 2.14 KB

CollectionsManager

List all collections

Retrieves all collections for a given user.

Currently, only the favorites collection is supported.

This operation is performed by calling function getCollections.

See the endpoint docs at API Reference.

Currently we don't have an example for calling getCollections in integration tests

Arguments

  • queryParams GetCollectionsQueryParams
    • Query parameters of getCollections method
  • headers GetCollectionsHeaders
    • Headers of getCollections method

Returns

This function returns a value of type Collections.

Returns all collections for the given user

List collection items

Retrieves the files and/or folders contained within this collection.

This operation is performed by calling function getCollectionItems.

See the endpoint docs at API Reference.

Currently we don't have an example for calling getCollectionItems in integration tests

Arguments

  • collectionId String
    • The ID of the collection. Example: "926489"
  • queryParams GetCollectionItemsQueryParams
    • Query parameters of getCollectionItems method
  • headers GetCollectionItemsHeaders
    • Headers of getCollectionItems method

Returns

This function returns a value of type ItemsOffsetPaginated.

Returns an array of items in the collection.

Get collection by ID

Retrieves a collection by its ID.

This operation is performed by calling function getCollectionById.

See the endpoint docs at API Reference.

Currently we don't have an example for calling getCollectionById in integration tests

Arguments

  • collectionId String
    • The ID of the collection. Example: "926489"
  • headers GetCollectionByIdHeaders
    • Headers of getCollectionById method

Returns

This function returns a value of type Collection.

Returns an array of items in the collection.