Function CollectionApiAxiosParamCreator

Returns {
    addToCollection: ((collectionId: string, ids: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    createCollection: ((name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    removeFromCollection: ((collectionId: string, ids: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• addToCollection: ((collectionId: string, ids: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Adds items to a collection.

  Throws

  • • (collectionId, ids, options?): Promise<RequestArgs>

    • Parameters

      • collectionId: string

        The collection id.
      • ids: string[]

        Item ids, comma delimited.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createCollection: ((name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Creates a new collection.

  Throws

  • • (name?, ids?, parentId?, isLocked?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalname: string

        The name of the collection.
      • Optionalids: string[]

        Item Ids to add to the collection.
      • OptionalparentId: string

        Optional. Create the collection within a specific folder.
      • OptionalisLocked: boolean

        Whether or not to lock the new collection.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• removeFromCollection: ((collectionId: string, ids: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Removes items from a collection.

  Throws

  • • (collectionId, ids, options?): Promise<RequestArgs>

    • Parameters

      • collectionId: string

        The collection id.
      • ids: string[]

        Item ids, comma delimited.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>