Class Collections

Collections resource handler

Index

Constructors

Methods

addProduct count createCustomCollection createSmartCollection deleteCustomCollection deleteSmartCollection get list removeProduct setProductOrder updateCustomCollection updateSmartCollection

Constructors

constructor

new Collections(client): Collections
Parameters
- client: SapoClient
Returns Collections
- Defined in resources/collections.ts:15

Methods

addProduct

addProduct(collectionId, productId): Promise<void>
Add a product to a custom collection
Parameters
- collectionId: number
  Collection ID
- productId: number
  Product ID
Returns Promise<void>
- Defined in resources/collections.ts:146

count

count(params?): Promise<number>
Get total collection count
Parameters
- Optional params: Partial<CollectionListParams>
  Filter parameters
Returns Promise<number>
Total number of collections matching filters
- Defined in resources/collections.ts:119

createCustomCollection

createCustomCollection(data): Promise<Collection>
Create a custom collection
Parameters
- data: CreateCollectionData
  Collection data
Returns Promise<Collection>
Created collection
- Defined in resources/collections.ts:43

createSmartCollection

createSmartCollection(data): Promise<Collection>
Create a smart collection
Parameters
- data: CreateSmartCollectionData
  Smart collection data
Returns Promise<Collection>
Created collection
- Defined in resources/collections.ts:56

deleteCustomCollection

deleteCustomCollection(id): Promise<void>
Delete a custom collection
Parameters
- id: number
  Collection ID
Returns Promise<void>
- Defined in resources/collections.ts:102

deleteSmartCollection

deleteSmartCollection(id): Promise<void>
Delete a smart collection
Parameters
- id: number
  Collection ID
Returns Promise<void>
- Defined in resources/collections.ts:110

get

get(id): Promise<Collection>
Get a single collection by ID
Parameters
- id: number
  Collection ID
Returns Promise<Collection>
Collection details
- Defined in resources/collections.ts:31

list

list(params?): Promise<PaginatedResponse<Collection>>
Get a list of collections
Parameters
- Optional params: CollectionListParams
  Query parameters for filtering and pagination
Returns Promise<PaginatedResponse<Collection>>
Paginated list of collections
- Defined in resources/collections.ts:22

removeProduct

removeProduct(collectionId, productId): Promise<void>
Remove a product from a custom collection
Parameters
- collectionId: number
  Collection ID
- productId: number
  Product ID
Returns Promise<void>
- Defined in resources/collections.ts:155

setProductOrder

setProductOrder(collectionId, productIds): Promise<Collection>
Update products order in a custom collection
Parameters
- collectionId: number
  Collection ID
- productIds: number[]
  Ordered list of product IDs
Returns Promise<Collection>
Updated collection
- Defined in resources/collections.ts:133

updateCustomCollection

updateCustomCollection(id, data): Promise<Collection>
Update a custom collection
Parameters
- id: number
  Collection ID
- data: Partial<CreateCollectionData>
  Collection update data
Returns Promise<Collection>
Updated collection
- Defined in resources/collections.ts:70

updateSmartCollection

updateSmartCollection(id, data): Promise<Collection>
Update a smart collection
Parameters
- id: number
  Collection ID
- data: Partial<CreateSmartCollectionData>
  Smart collection update data
Returns Promise<Collection>
Updated collection
- Defined in resources/collections.ts:87