@medusajs/js-sdk 2.0.1-snapshot-20241025090810 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/admin/price-list.d.ts +195 -1
  2. package/dist/admin/price-list.d.ts.map +1 -1
  3. package/dist/admin/price-list.js +194 -0
  4. package/dist/admin/price-list.js.map +1 -1
  5. package/dist/admin/price-preference.d.ts +133 -0
  6. package/dist/admin/price-preference.d.ts.map +1 -1
  7. package/dist/admin/price-preference.js +133 -0
  8. package/dist/admin/price-preference.js.map +1 -1
  9. package/dist/admin/product-category.d.ts +150 -0
  10. package/dist/admin/product-category.d.ts.map +1 -1
  11. package/dist/admin/product-category.js +150 -0
  12. package/dist/admin/product-category.js.map +1 -1
  13. package/dist/admin/product-collection.d.ts +149 -0
  14. package/dist/admin/product-collection.d.ts.map +1 -1
  15. package/dist/admin/product-collection.js +149 -0
  16. package/dist/admin/product-collection.js.map +1 -1
  17. package/dist/esm/admin/price-list.d.ts +195 -1
  18. package/dist/esm/admin/price-list.d.ts.map +1 -1
  19. package/dist/esm/admin/price-list.js +194 -0
  20. package/dist/esm/admin/price-list.js.map +1 -1
  21. package/dist/esm/admin/price-preference.d.ts +133 -0
  22. package/dist/esm/admin/price-preference.d.ts.map +1 -1
  23. package/dist/esm/admin/price-preference.js +133 -0
  24. package/dist/esm/admin/price-preference.js.map +1 -1
  25. package/dist/esm/admin/product-category.d.ts +150 -0
  26. package/dist/esm/admin/product-category.d.ts.map +1 -1
  27. package/dist/esm/admin/product-category.js +150 -0
  28. package/dist/esm/admin/product-category.js.map +1 -1
  29. package/dist/esm/admin/product-collection.d.ts +149 -0
  30. package/dist/esm/admin/product-collection.d.ts.map +1 -1
  31. package/dist/esm/admin/product-collection.js +149 -0
  32. package/dist/esm/admin/product-collection.js.map +1 -1
  33. package/package.json +2 -2
@@ -10,11 +10,160 @@ export declare class ProductCollection {
10
10
  * @ignore
11
11
  */
12
12
  constructor(client: Client);
13
+ /**
14
+ * This method creates a product collection. It sends a request to the
15
+ * [Create Collection](https://docs.medusajs.com/api/admin#collections_postcollections)
16
+ * API route.
17
+ *
18
+ * @param body - The details of the product collection to create.
19
+ * @param query - Configure the fields to retrieve in the product collection.
20
+ * @param headers - Headers to pass in the request
21
+ * @returns The product collection's details.
22
+ *
23
+ * @example
24
+ * sdk.admin.productCollection.create({
25
+ * title: "Summer Collection"
26
+ * })
27
+ * .then(({ collection }) => {
28
+ * console.log(collection)
29
+ * })
30
+ */
13
31
  create(body: HttpTypes.AdminCreateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
32
+ /**
33
+ * This method updates a collection. It sends a request to the
34
+ * [Update Collection](https://docs.medusajs.com/api/admin#collections_postcollectionsid)
35
+ * API route.
36
+ *
37
+ * @param id - The ID of the collection.
38
+ * @param body - The data to update in the collection.
39
+ * @param query - Configure the fields to retrieve in the product collection.
40
+ * @param headers - Headers to pass in the request
41
+ * @returns The product collection's details.
42
+ *
43
+ * @example
44
+ * sdk.admin.productCollection.update("pcol_123", {
45
+ * title: "Summer Collection"
46
+ * })
47
+ * .then(({ collection }) => {
48
+ * console.log(collection)
49
+ * })
50
+ */
14
51
  update(id: string, body: HttpTypes.AdminUpdateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
52
+ /**
53
+ * This method retrieves a paginated list of collections. It sends a request to the
54
+ * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route.
55
+ *
56
+ * @param query - Filters and pagination configurations.
57
+ * @param headers - Headers to pass in the request.
58
+ * @returns The paginated list of collections.
59
+ *
60
+ * @example
61
+ * To retrieve the list of collections:
62
+ *
63
+ * ```ts
64
+ * sdk.admin.productCollection.list()
65
+ * .then(({ collections, count, limit, offset }) => {
66
+ * console.log(collections)
67
+ * })
68
+ * ```
69
+ *
70
+ * To configure the pagination, pass the `limit` and `offset` query parameters.
71
+ *
72
+ * For example, to retrieve only 10 items and skip 10 items:
73
+ *
74
+ * ```ts
75
+ * sdk.admin.productCollection.list({
76
+ * limit: 10,
77
+ * offset: 10
78
+ * })
79
+ * .then(({ collections, count, limit, offset }) => {
80
+ * console.log(collections)
81
+ * })
82
+ * ```
83
+ *
84
+ * Using the `fields` query parameter, you can specify the fields and relations to retrieve
85
+ * in each collection:
86
+ *
87
+ * ```ts
88
+ * sdk.admin.productCollection.list({
89
+ * fields: "id,*products"
90
+ * })
91
+ * .then(({ collections, count, limit, offset }) => {
92
+ * console.log(collections)
93
+ * })
94
+ * ```
95
+ *
96
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
97
+ */
15
98
  list(queryParams?: HttpTypes.AdminCollectionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionListResponse>;
99
+ /**
100
+ * This method retrieves a collection by its ID. It sends a request to the
101
+ * [Get Collection](https://docs.medusajs.com/api/admin#collections_getcollectionsid) API route.
102
+ *
103
+ * @param id - The collection's ID.
104
+ * @param query - Configure the fields to retrieve in the collection.
105
+ * @param headers - Headers to pass in the request
106
+ * @returns The collection's details.
107
+ *
108
+ * @example
109
+ * To retrieve a collection by its ID:
110
+ *
111
+ * ```ts
112
+ * sdk.admin.productCollection.retrieve("pcol_123")
113
+ * .then(({ collection }) => {
114
+ * console.log(collection)
115
+ * })
116
+ * ```
117
+ *
118
+ * To specify the fields and relations to retrieve:
119
+ *
120
+ * ```ts
121
+ * sdk.admin.productCollection.retrieve("pcol_123", {
122
+ * fields: "id,*products"
123
+ * })
124
+ * .then(({ collection }) => {
125
+ * console.log(collection)
126
+ * })
127
+ * ```
128
+ *
129
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
130
+ */
16
131
  retrieve(id: string, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
132
+ /**
133
+ * This method deletes a product collection. It sends a request to the
134
+ * [Delete Collection](https://docs.medusajs.com/api/admin#collections_deletecollectionsid)
135
+ * API route.
136
+ *
137
+ * @param id - The collection's ID.
138
+ * @param headers - Headers to pass in the request
139
+ * @returns The deletion's details.
140
+ *
141
+ * @example
142
+ * sdk.admin.productCollection.delete("pcol_123")
143
+ * .then(({ deleted }) => {
144
+ * console.log(deleted)
145
+ * })
146
+ */
17
147
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionDeleteResponse>;
148
+ /**
149
+ * This method manages the products of a collection to add or remove them. It sends a request
150
+ * to the [Manage Products](https://docs.medusajs.com/api/admin#collections_postcollectionsidproducts)
151
+ * API route.
152
+ *
153
+ * @param id - The collection's ID.
154
+ * @param body - The products to add or remove.
155
+ * @param headers - Headers to pass in the request
156
+ * @returns The product category's details.
157
+ *
158
+ * @example
159
+ * sdk.admin.productCollection.updateProducts("pcol_123", {
160
+ * add: ["prod_123"],
161
+ * remove: ["prod_321"]
162
+ * })
163
+ * .then(({ collection }) => {
164
+ * console.log(collection)
165
+ * })
166
+ */
18
167
  updateProducts(id: string, body: HttpTypes.AdminUpdateCollectionProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
19
168
  }
20
169
  //# sourceMappingURL=product-collection.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
1
+ {"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
@@ -8,6 +8,24 @@ class ProductCollection {
8
8
  constructor(client) {
9
9
  this.client = client;
10
10
  }
11
+ /**
12
+ * This method creates a product collection. It sends a request to the
13
+ * [Create Collection](https://docs.medusajs.com/api/admin#collections_postcollections)
14
+ * API route.
15
+ *
16
+ * @param body - The details of the product collection to create.
17
+ * @param query - Configure the fields to retrieve in the product collection.
18
+ * @param headers - Headers to pass in the request
19
+ * @returns The product collection's details.
20
+ *
21
+ * @example
22
+ * sdk.admin.productCollection.create({
23
+ * title: "Summer Collection"
24
+ * })
25
+ * .then(({ collection }) => {
26
+ * console.log(collection)
27
+ * })
28
+ */
11
29
  async create(body, query, headers) {
12
30
  return this.client.fetch(`/admin/collections`, {
13
31
  method: "POST",
@@ -16,6 +34,25 @@ class ProductCollection {
16
34
  query,
17
35
  });
18
36
  }
37
+ /**
38
+ * This method updates a collection. It sends a request to the
39
+ * [Update Collection](https://docs.medusajs.com/api/admin#collections_postcollectionsid)
40
+ * API route.
41
+ *
42
+ * @param id - The ID of the collection.
43
+ * @param body - The data to update in the collection.
44
+ * @param query - Configure the fields to retrieve in the product collection.
45
+ * @param headers - Headers to pass in the request
46
+ * @returns The product collection's details.
47
+ *
48
+ * @example
49
+ * sdk.admin.productCollection.update("pcol_123", {
50
+ * title: "Summer Collection"
51
+ * })
52
+ * .then(({ collection }) => {
53
+ * console.log(collection)
54
+ * })
55
+ */
19
56
  async update(id, body, query, headers) {
20
57
  return this.client.fetch(`/admin/collections/${id}`, {
21
58
  method: "POST",
@@ -24,24 +61,136 @@ class ProductCollection {
24
61
  query,
25
62
  });
26
63
  }
64
+ /**
65
+ * This method retrieves a paginated list of collections. It sends a request to the
66
+ * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route.
67
+ *
68
+ * @param query - Filters and pagination configurations.
69
+ * @param headers - Headers to pass in the request.
70
+ * @returns The paginated list of collections.
71
+ *
72
+ * @example
73
+ * To retrieve the list of collections:
74
+ *
75
+ * ```ts
76
+ * sdk.admin.productCollection.list()
77
+ * .then(({ collections, count, limit, offset }) => {
78
+ * console.log(collections)
79
+ * })
80
+ * ```
81
+ *
82
+ * To configure the pagination, pass the `limit` and `offset` query parameters.
83
+ *
84
+ * For example, to retrieve only 10 items and skip 10 items:
85
+ *
86
+ * ```ts
87
+ * sdk.admin.productCollection.list({
88
+ * limit: 10,
89
+ * offset: 10
90
+ * })
91
+ * .then(({ collections, count, limit, offset }) => {
92
+ * console.log(collections)
93
+ * })
94
+ * ```
95
+ *
96
+ * Using the `fields` query parameter, you can specify the fields and relations to retrieve
97
+ * in each collection:
98
+ *
99
+ * ```ts
100
+ * sdk.admin.productCollection.list({
101
+ * fields: "id,*products"
102
+ * })
103
+ * .then(({ collections, count, limit, offset }) => {
104
+ * console.log(collections)
105
+ * })
106
+ * ```
107
+ *
108
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
109
+ */
27
110
  async list(queryParams, headers) {
28
111
  return this.client.fetch(`/admin/collections`, {
29
112
  headers,
30
113
  query: queryParams,
31
114
  });
32
115
  }
116
+ /**
117
+ * This method retrieves a collection by its ID. It sends a request to the
118
+ * [Get Collection](https://docs.medusajs.com/api/admin#collections_getcollectionsid) API route.
119
+ *
120
+ * @param id - The collection's ID.
121
+ * @param query - Configure the fields to retrieve in the collection.
122
+ * @param headers - Headers to pass in the request
123
+ * @returns The collection's details.
124
+ *
125
+ * @example
126
+ * To retrieve a collection by its ID:
127
+ *
128
+ * ```ts
129
+ * sdk.admin.productCollection.retrieve("pcol_123")
130
+ * .then(({ collection }) => {
131
+ * console.log(collection)
132
+ * })
133
+ * ```
134
+ *
135
+ * To specify the fields and relations to retrieve:
136
+ *
137
+ * ```ts
138
+ * sdk.admin.productCollection.retrieve("pcol_123", {
139
+ * fields: "id,*products"
140
+ * })
141
+ * .then(({ collection }) => {
142
+ * console.log(collection)
143
+ * })
144
+ * ```
145
+ *
146
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
147
+ */
33
148
  async retrieve(id, query, headers) {
34
149
  return this.client.fetch(`/admin/collections/${id}`, {
35
150
  query,
36
151
  headers,
37
152
  });
38
153
  }
154
+ /**
155
+ * This method deletes a product collection. It sends a request to the
156
+ * [Delete Collection](https://docs.medusajs.com/api/admin#collections_deletecollectionsid)
157
+ * API route.
158
+ *
159
+ * @param id - The collection's ID.
160
+ * @param headers - Headers to pass in the request
161
+ * @returns The deletion's details.
162
+ *
163
+ * @example
164
+ * sdk.admin.productCollection.delete("pcol_123")
165
+ * .then(({ deleted }) => {
166
+ * console.log(deleted)
167
+ * })
168
+ */
39
169
  async delete(id, headers) {
40
170
  return this.client.fetch(`/admin/collections/${id}`, {
41
171
  method: "DELETE",
42
172
  headers,
43
173
  });
44
174
  }
175
+ /**
176
+ * This method manages the products of a collection to add or remove them. It sends a request
177
+ * to the [Manage Products](https://docs.medusajs.com/api/admin#collections_postcollectionsidproducts)
178
+ * API route.
179
+ *
180
+ * @param id - The collection's ID.
181
+ * @param body - The products to add or remove.
182
+ * @param headers - Headers to pass in the request
183
+ * @returns The product category's details.
184
+ *
185
+ * @example
186
+ * sdk.admin.productCollection.updateProducts("pcol_123", {
187
+ * add: ["prod_123"],
188
+ * remove: ["prod_321"]
189
+ * })
190
+ * .then(({ collection }) => {
191
+ * console.log(collection)
192
+ * })
193
+ */
45
194
  async updateProducts(id, body, headers) {
46
195
  return this.client.fetch(`/admin/collections/${id}/products`, {
47
196
  method: "POST",
@@ -1 +1 @@
1
- {"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IACD,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA/FD,8CA+FC"}
1
+ {"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AArPD,8CAqPC"}
@@ -10,12 +10,206 @@ export declare class PriceList {
10
10
  * @ignore
11
11
  */
12
12
  constructor(client: Client);
13
+ /**
14
+ * This method retrieves a price list. It sends a request to the
15
+ * [Get Price List](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelistsid)
16
+ * API route.
17
+ *
18
+ * @param id - The price list's ID.
19
+ * @param query - Configure the fields to retrieve in the price list.
20
+ * @param headers - Headers to pass in the request
21
+ * @returns The price list's details.
22
+ *
23
+ * @example
24
+ * To retrieve a price list by its ID:
25
+ *
26
+ * ```ts
27
+ * sdk.admin.priceList.retrieve("plist_123")
28
+ * .then(({ price_list }) => {
29
+ * console.log(price_list)
30
+ * })
31
+ * ```
32
+ *
33
+ * To specify the fields and relations to retrieve:
34
+ *
35
+ * ```ts
36
+ * sdk.admin.priceList.retrieve("plist_123", {
37
+ * fields: "id,*prices"
38
+ * })
39
+ * .then(({ price_list }) => {
40
+ * console.log(price_list)
41
+ * })
42
+ * ```
43
+ *
44
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
45
+ */
13
46
  retrieve(id: string, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
47
+ /**
48
+ * This method retrieves a paginated list of price lists. It sends a request to the
49
+ * [List Price Lists](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelists) API route.
50
+ *
51
+ * @param query - Filters and pagination configurations.
52
+ * @param headers - Headers to pass in the request.
53
+ * @returns The paginated list of price lists.
54
+ *
55
+ * @example
56
+ * To retrieve the list of price lists:
57
+ *
58
+ * ```ts
59
+ * sdk.admin.priceList.list()
60
+ * .then(({ price_lists, count, limit, offset }) => {
61
+ * console.log(price_lists)
62
+ * })
63
+ * ```
64
+ *
65
+ * To configure the pagination, pass the `limit` and `offset` query parameters.
66
+ *
67
+ * For example, to retrieve only 10 items and skip 10 items:
68
+ *
69
+ * ```ts
70
+ * sdk.admin.priceList.list({
71
+ * limit: 10,
72
+ * offset: 10
73
+ * })
74
+ * .then(({ price_lists, count, limit, offset }) => {
75
+ * console.log(price_lists)
76
+ * })
77
+ * ```
78
+ *
79
+ * Using the `fields` query parameter, you can specify the fields and relations to retrieve
80
+ * in each price list:
81
+ *
82
+ * ```ts
83
+ * sdk.admin.priceList.list({
84
+ * fields: "id,*prices"
85
+ * })
86
+ * .then(({ price_lists, count, limit, offset }) => {
87
+ * console.log(price_lists)
88
+ * })
89
+ * ```
90
+ *
91
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
92
+ */
14
93
  list(query?: HttpTypes.AdminPriceListListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListListResponse>;
94
+ /**
95
+ * This method creates a price list. It sends a request to the
96
+ * [Create Price List](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelists)
97
+ * API route.
98
+ *
99
+ * @param body - The details of the price list to create.
100
+ * @param query - Configure the fields to retrieve in the price list.
101
+ * @param headers - Headers to pass in the request
102
+ * @returns The price list's details.
103
+ *
104
+ * @example
105
+ * sdk.admin.priceList.create({
106
+ * title: "My Price List",
107
+ * status: "active",
108
+ * type: "sale",
109
+ * prices: [
110
+ * {
111
+ * variant_id: "variant_123",
112
+ * amount: 10,
113
+ * currency_code: "usd",
114
+ * rules: {
115
+ * region_id: "reg_123"
116
+ * }
117
+ * }
118
+ * ]
119
+ * })
120
+ * .then(({ price_list }) => {
121
+ * console.log(price_list)
122
+ * })
123
+ */
15
124
  create(body: HttpTypes.AdminCreatePriceList, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
125
+ /**
126
+ * This method updates a price list. It sends a request to the
127
+ * [Update Price List](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsid)
128
+ * API route.
129
+ *
130
+ * @param id - The price list's ID.
131
+ * @param body - The data to update in the price list.
132
+ * @param query - Configure the fields to retrieve in the price list.
133
+ * @param headers - Headers to pass in the request
134
+ * @returns The price list's details.
135
+ *
136
+ * @example
137
+ * sdk.admin.priceList.update("plist_123", {
138
+ * title: "My Price List",
139
+ * })
140
+ * .then(({ price_list }) => {
141
+ * console.log(price_list)
142
+ * })
143
+ */
16
144
  update(id: string, body: HttpTypes.AdminUpdatePriceList, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
145
+ /**
146
+ * This method deletes a price list. It sends a request to the
147
+ * [Delete Price List](https://docs.medusajs.com/v2/api/admin#price-lists_deletepricelistsid)
148
+ * API route.
149
+ *
150
+ * @param id - The price list's ID.
151
+ * @param headers - Headers to pass in the request
152
+ * @returns The deletion's details.
153
+ *
154
+ * @example
155
+ * sdk.admin.priceList.delete("plist_123")
156
+ * .then(({ deleted }) => {
157
+ * console.log(deleted)
158
+ * })
159
+ */
17
160
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListDeleteResponse>;
18
- batchPrices(id: string, body: HttpTypes.AdminBatchPriceListPrice, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
161
+ /**
162
+ * This method manages the prices of a price list to create, update, or delete them.
163
+ * It sends a request to the [Manage Prices](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsidpricesbatch)
164
+ * API route.
165
+ *
166
+ * @param id - The price list's ID.
167
+ * @param body - The prices to create, update, or delete.
168
+ * @param query - Configure the fields to retrieve in the price list.
169
+ * @param headers - Headers to pass in the request
170
+ * @returns The price list's details.
171
+ *
172
+ * @example
173
+ * sdk.admin.priceList.batchPrices("plist_123", {
174
+ * create: [{
175
+ * variant_id: "variant_123",
176
+ * currency_code: "usd",
177
+ * amount: 10,
178
+ * rules: {
179
+ * region_id: "reg_123"
180
+ * }
181
+ * }],
182
+ * update: [{
183
+ * id: "price_123",
184
+ * variant_id: "variant_123",
185
+ * amount: 20,
186
+ * }],
187
+ * delete: ["price_123"]
188
+ * })
189
+ * .then(({ created, updated, deleted }) => {
190
+ * console.log(created, updated, deleted)
191
+ * })
192
+ */
193
+ batchPrices(id: string, body: HttpTypes.AdminBatchPriceListPrice, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListBatchResponse>;
194
+ /**
195
+ * This method removes products from a price list. It sends a request to the
196
+ * [Remove Product](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsidproducts)
197
+ * API route.
198
+ *
199
+ * @param id - The price list's ID.
200
+ * @param body - The details of the products to remove.
201
+ * @param query - Configure the fields to retrieve in the price list.
202
+ * @param headers - Headers to pass in the request
203
+ * @returns The price list's details.
204
+ *
205
+ * @example
206
+ * sdk.admin.priceList.linkProducts("plist_123", {
207
+ * remove: ["prod_123"]
208
+ * })
209
+ * .then(({ price_list }) => {
210
+ * console.log(price_list)
211
+ * })
212
+ */
19
213
  linkProducts(id: string, body: HttpTypes.AdminLinkPriceListProducts, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
20
214
  }
21
215
  //# sourceMappingURL=price-list.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"price-list.d.ts","sourceRoot":"","sources":["../../../src/admin/price-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAanB,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;CAY1B"}
1
+ {"version":3,"file":"price-list.d.ts","sourceRoot":"","sources":["../../../src/admin/price-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;CAY1B"}