feat(medusa-js): Add Collection batch (remove, add) endpoints (#1958)

This commit is contained in:
Richard Ward
2022-08-07 13:22:36 +02:00
committed by GitHub
parent 11fab121f4
commit a88bf3c76e
2 changed files with 37 additions and 0 deletions

View File

@@ -0,0 +1,5 @@
---
"@medusajs/medusa-js": patch
---
Add batch endpoints (remove, add) for Collections to medusa-js

View File

@@ -5,6 +5,8 @@ import {
AdminCollectionsDeleteRes,
AdminCollectionsListRes,
AdminGetCollectionsParams,
AdminPostProductsToCollectionReq,
AdminDeleteProductsFromCollectionReq,
} from "@medusajs/medusa"
import qs from "qs"
import { ResponsePromise } from "../../typings"
@@ -88,6 +90,36 @@ class AdminCollectionsResource extends BaseResource {
return this.client.request("GET", path, undefined, {}, customHeaders)
}
/**
* @description Updates products associated with a Product Collection
* @param id the id of the Collection
* @param payload - an object which contains an array of Product IDs to add to the Product Collection
* @param customHeaders
*/
addProducts(
id: string,
payload: AdminPostProductsToCollectionReq,
customHeaders: Record<string, any> = {}
): ResponsePromise<AdminCollectionsRes> {
const path = `/admin/collections/${id}/products/batch`
return this.client.request("POST", path, payload, {}, customHeaders)
}
/**
* @description Removes products associated with a Product Collection
* @param id - the id of the Collection
* @param payload - an object which contains an array of Product IDs to add to the Product Collection
* @param customHeaders
*/
removeProducts(
id: string,
payload: AdminDeleteProductsFromCollectionReq,
customHeaders: Record<string, any> = {}
): ResponsePromise<AdminCollectionsDeleteRes> {
const path = `/admin/collections/${id}/products/batch`
return this.client.request("DELETE", path, payload, {}, customHeaders)
}
}
export default AdminCollectionsResource