@plasma-platform/tm-service-collections v3.0.3

Service Collections

Documentation

Table of Contents

• CollectionsService
  • messages
  • get
  • getCollection
  • postCollection
  • postItem
  • delete
• Array
• Post

CollectionsService

• See: //api.templatemonster.com/collection/v2/

collections Micro Service API that you may adopt for your needs

Parameters

• url string service url
• token (string | null) user access tocken if available (optional, default null)

messages

Object with class service messages

get

Get collection items list

Examples

Read collection items list

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const items = await collections.get('mfsgxst31slvddqz0miv');
})();

Returns CollectionItemsList array of items

getCollection

Get collections list or collection by name

Parameters

• name string collection name
• page number page
• perPage number collections per page, 0 for all

Examples

Get Favorites Collection

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const items = await collections.getCollection('Favorites');
})();

Returns CollectionList collections

postCollection

Create collection

Parameters

• name string collection name

Examples

Create collection

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const item = await collections.postCollection('Favorites');
})();

Returns Collection collection object

postItem

Add item to collection

Parameters

• collectionId string collection id
• name string item name

Examples

Favorite item

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  const item = await collections.postItem('mfsgxst31slvddqz0miv', 'template-67020');
})();

Returns CollectionItem record in the collection

delete

Remove item from collection

Parameters

• id number id of the record in the collection

Examples

Remove from collection

(async () => {
  const collections = new CollectionsService('//api.templatemonster.com/collection/v2/');
  await collections.delete(2342);
})();

Array

Collection items list object

Type: CollectionItemsList

Properties

• null-null Array<CollectionItem> array of items

Post

Collection item object

Type: CollectionItem

Properties

• id number collection item id
• collection_id string collection id
• item_name string item name
• description string description
• created_at number creation timestamp
• updated_at number update timestamp