@medusajs/js-sdk 2.18.0 → 2.19.0-preview-20260811102316

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 (233) hide show
  1. package/dist/admin/api-key.d.ts +8 -8
  2. package/dist/admin/api-key.js +8 -8
  3. package/dist/admin/campaign.d.ts +8 -8
  4. package/dist/admin/campaign.js +8 -8
  5. package/dist/admin/claim.d.ts +22 -22
  6. package/dist/admin/claim.js +22 -22
  7. package/dist/admin/currency.d.ts +4 -4
  8. package/dist/admin/currency.js +4 -4
  9. package/dist/admin/customer-group.d.ts +8 -8
  10. package/dist/admin/customer-group.js +8 -8
  11. package/dist/admin/customer.d.ts +13 -13
  12. package/dist/admin/customer.js +13 -13
  13. package/dist/admin/draft-order.d.ts +23 -23
  14. package/dist/admin/draft-order.js +23 -23
  15. package/dist/admin/exchange.d.ts +21 -21
  16. package/dist/admin/exchange.js +21 -21
  17. package/dist/admin/fulfillment-provider.d.ts +3 -3
  18. package/dist/admin/fulfillment-provider.js +3 -3
  19. package/dist/admin/fulfillment-set.d.ts +6 -6
  20. package/dist/admin/fulfillment-set.js +6 -6
  21. package/dist/admin/fulfillment.d.ts +3 -3
  22. package/dist/admin/fulfillment.js +3 -3
  23. package/dist/admin/index.d.ts +5 -0
  24. package/dist/admin/index.d.ts.map +1 -1
  25. package/dist/admin/index.js +2 -0
  26. package/dist/admin/index.js.map +1 -1
  27. package/dist/admin/inventory-item.d.ts +34 -13
  28. package/dist/admin/inventory-item.d.ts.map +1 -1
  29. package/dist/admin/inventory-item.js +41 -13
  30. package/dist/admin/inventory-item.js.map +1 -1
  31. package/dist/admin/invite.d.ts +8 -8
  32. package/dist/admin/invite.js +8 -8
  33. package/dist/admin/locale.d.ts +4 -4
  34. package/dist/admin/locale.js +4 -4
  35. package/dist/admin/notification.d.ts +4 -4
  36. package/dist/admin/notification.js +4 -4
  37. package/dist/admin/order-edit.d.ts +12 -9
  38. package/dist/admin/order-edit.d.ts.map +1 -1
  39. package/dist/admin/order-edit.js +13 -9
  40. package/dist/admin/order-edit.js.map +1 -1
  41. package/dist/admin/order.d.ts +22 -22
  42. package/dist/admin/order.js +22 -22
  43. package/dist/admin/payment-collection.d.ts +4 -4
  44. package/dist/admin/payment-collection.js +4 -4
  45. package/dist/admin/payment.d.ts +8 -8
  46. package/dist/admin/payment.js +8 -8
  47. package/dist/admin/price-list.d.ts +10 -10
  48. package/dist/admin/price-list.js +10 -10
  49. package/dist/admin/price-preference.d.ts +7 -7
  50. package/dist/admin/price-preference.js +7 -7
  51. package/dist/admin/product-category.d.ts +8 -8
  52. package/dist/admin/product-category.js +8 -8
  53. package/dist/admin/product-collection.d.ts +8 -8
  54. package/dist/admin/product-collection.js +8 -8
  55. package/dist/admin/product-option.d.ts +7 -7
  56. package/dist/admin/product-option.js +7 -7
  57. package/dist/admin/product-tag.d.ts +7 -7
  58. package/dist/admin/product-tag.js +7 -7
  59. package/dist/admin/product-type.d.ts +7 -7
  60. package/dist/admin/product-type.js +7 -7
  61. package/dist/admin/product-variant.d.ts +2 -2
  62. package/dist/admin/product-variant.js +2 -2
  63. package/dist/admin/product.d.ts +26 -134
  64. package/dist/admin/product.d.ts.map +1 -1
  65. package/dist/admin/product.js +26 -158
  66. package/dist/admin/product.js.map +1 -1
  67. package/dist/admin/promotion.d.ts +19 -19
  68. package/dist/admin/promotion.js +19 -19
  69. package/dist/admin/refund-reasons.d.ts +7 -7
  70. package/dist/admin/refund-reasons.js +7 -7
  71. package/dist/admin/region.d.ts +7 -7
  72. package/dist/admin/region.js +7 -7
  73. package/dist/admin/reservation.d.ts +7 -7
  74. package/dist/admin/reservation.js +7 -7
  75. package/dist/admin/return-reason.d.ts +7 -7
  76. package/dist/admin/return-reason.js +7 -7
  77. package/dist/admin/return.d.ts +25 -25
  78. package/dist/admin/return.js +25 -25
  79. package/dist/admin/sales-channel.d.ts +9 -9
  80. package/dist/admin/sales-channel.js +9 -9
  81. package/dist/admin/search.d.ts +40 -0
  82. package/dist/admin/search.d.ts.map +1 -0
  83. package/dist/admin/search.js +44 -0
  84. package/dist/admin/search.js.map +1 -0
  85. package/dist/admin/shipping-option-type.d.ts +7 -7
  86. package/dist/admin/shipping-option-type.js +7 -7
  87. package/dist/admin/shipping-option.d.ts +8 -8
  88. package/dist/admin/shipping-option.js +8 -8
  89. package/dist/admin/shipping-profile.d.ts +7 -7
  90. package/dist/admin/shipping-profile.js +7 -7
  91. package/dist/admin/stock-location.d.ts +10 -10
  92. package/dist/admin/stock-location.js +10 -10
  93. package/dist/admin/store.d.ts +5 -5
  94. package/dist/admin/store.js +5 -5
  95. package/dist/admin/tax-provider.d.ts +2 -2
  96. package/dist/admin/tax-provider.js +2 -2
  97. package/dist/admin/tax-rate.d.ts +7 -7
  98. package/dist/admin/tax-rate.js +7 -7
  99. package/dist/admin/tax-region.d.ts +7 -7
  100. package/dist/admin/tax-region.js +7 -7
  101. package/dist/admin/translation.d.ts +7 -7
  102. package/dist/admin/translation.js +7 -7
  103. package/dist/admin/upload.d.ts +3 -3
  104. package/dist/admin/upload.js +3 -3
  105. package/dist/admin/user.d.ts +8 -8
  106. package/dist/admin/user.js +8 -8
  107. package/dist/admin/views.d.ts +174 -1
  108. package/dist/admin/views.d.ts.map +1 -1
  109. package/dist/admin/views.js +174 -1
  110. package/dist/admin/views.js.map +1 -1
  111. package/dist/admin/workflow-execution.d.ts +3 -3
  112. package/dist/admin/workflow-execution.js +3 -3
  113. package/dist/auth/index.d.ts +14 -14
  114. package/dist/auth/index.js +14 -14
  115. package/dist/esm/admin/api-key.d.ts +8 -8
  116. package/dist/esm/admin/api-key.js +8 -8
  117. package/dist/esm/admin/campaign.d.ts +8 -8
  118. package/dist/esm/admin/campaign.js +8 -8
  119. package/dist/esm/admin/claim.d.ts +22 -22
  120. package/dist/esm/admin/claim.js +22 -22
  121. package/dist/esm/admin/currency.d.ts +4 -4
  122. package/dist/esm/admin/currency.js +4 -4
  123. package/dist/esm/admin/customer-group.d.ts +8 -8
  124. package/dist/esm/admin/customer-group.js +8 -8
  125. package/dist/esm/admin/customer.d.ts +13 -13
  126. package/dist/esm/admin/customer.js +13 -13
  127. package/dist/esm/admin/draft-order.d.ts +23 -23
  128. package/dist/esm/admin/draft-order.js +23 -23
  129. package/dist/esm/admin/exchange.d.ts +21 -21
  130. package/dist/esm/admin/exchange.js +21 -21
  131. package/dist/esm/admin/fulfillment-provider.d.ts +3 -3
  132. package/dist/esm/admin/fulfillment-provider.js +3 -3
  133. package/dist/esm/admin/fulfillment-set.d.ts +6 -6
  134. package/dist/esm/admin/fulfillment-set.js +6 -6
  135. package/dist/esm/admin/fulfillment.d.ts +3 -3
  136. package/dist/esm/admin/fulfillment.js +3 -3
  137. package/dist/esm/admin/index.d.ts +5 -0
  138. package/dist/esm/admin/index.d.ts.map +1 -1
  139. package/dist/esm/admin/index.js +2 -0
  140. package/dist/esm/admin/index.js.map +1 -1
  141. package/dist/esm/admin/inventory-item.d.ts +34 -13
  142. package/dist/esm/admin/inventory-item.d.ts.map +1 -1
  143. package/dist/esm/admin/inventory-item.js +43 -13
  144. package/dist/esm/admin/inventory-item.js.map +1 -1
  145. package/dist/esm/admin/invite.d.ts +8 -8
  146. package/dist/esm/admin/invite.js +8 -8
  147. package/dist/esm/admin/locale.d.ts +4 -4
  148. package/dist/esm/admin/locale.js +4 -4
  149. package/dist/esm/admin/notification.d.ts +4 -4
  150. package/dist/esm/admin/notification.js +4 -4
  151. package/dist/esm/admin/order-edit.d.ts +12 -9
  152. package/dist/esm/admin/order-edit.d.ts.map +1 -1
  153. package/dist/esm/admin/order-edit.js +13 -9
  154. package/dist/esm/admin/order-edit.js.map +1 -1
  155. package/dist/esm/admin/order.d.ts +22 -22
  156. package/dist/esm/admin/order.js +22 -22
  157. package/dist/esm/admin/payment-collection.d.ts +4 -4
  158. package/dist/esm/admin/payment-collection.js +4 -4
  159. package/dist/esm/admin/payment.d.ts +8 -8
  160. package/dist/esm/admin/payment.js +8 -8
  161. package/dist/esm/admin/price-list.d.ts +10 -10
  162. package/dist/esm/admin/price-list.js +10 -10
  163. package/dist/esm/admin/price-preference.d.ts +7 -7
  164. package/dist/esm/admin/price-preference.js +7 -7
  165. package/dist/esm/admin/product-category.d.ts +8 -8
  166. package/dist/esm/admin/product-category.js +8 -8
  167. package/dist/esm/admin/product-collection.d.ts +8 -8
  168. package/dist/esm/admin/product-collection.js +8 -8
  169. package/dist/esm/admin/product-option.d.ts +7 -7
  170. package/dist/esm/admin/product-option.js +7 -7
  171. package/dist/esm/admin/product-tag.d.ts +7 -7
  172. package/dist/esm/admin/product-tag.js +7 -7
  173. package/dist/esm/admin/product-type.d.ts +7 -7
  174. package/dist/esm/admin/product-type.js +7 -7
  175. package/dist/esm/admin/product-variant.d.ts +2 -2
  176. package/dist/esm/admin/product-variant.js +2 -2
  177. package/dist/esm/admin/product.d.ts +26 -134
  178. package/dist/esm/admin/product.d.ts.map +1 -1
  179. package/dist/esm/admin/product.js +26 -166
  180. package/dist/esm/admin/product.js.map +1 -1
  181. package/dist/esm/admin/promotion.d.ts +19 -19
  182. package/dist/esm/admin/promotion.js +19 -19
  183. package/dist/esm/admin/refund-reasons.d.ts +7 -7
  184. package/dist/esm/admin/refund-reasons.js +7 -7
  185. package/dist/esm/admin/region.d.ts +7 -7
  186. package/dist/esm/admin/region.js +7 -7
  187. package/dist/esm/admin/reservation.d.ts +7 -7
  188. package/dist/esm/admin/reservation.js +7 -7
  189. package/dist/esm/admin/return-reason.d.ts +7 -7
  190. package/dist/esm/admin/return-reason.js +7 -7
  191. package/dist/esm/admin/return.d.ts +25 -25
  192. package/dist/esm/admin/return.js +25 -25
  193. package/dist/esm/admin/sales-channel.d.ts +9 -9
  194. package/dist/esm/admin/sales-channel.js +9 -9
  195. package/dist/esm/admin/search.d.ts +40 -0
  196. package/dist/esm/admin/search.d.ts.map +1 -0
  197. package/dist/esm/admin/search.js +51 -0
  198. package/dist/esm/admin/search.js.map +1 -0
  199. package/dist/esm/admin/shipping-option-type.d.ts +7 -7
  200. package/dist/esm/admin/shipping-option-type.js +7 -7
  201. package/dist/esm/admin/shipping-option.d.ts +8 -8
  202. package/dist/esm/admin/shipping-option.js +8 -8
  203. package/dist/esm/admin/shipping-profile.d.ts +7 -7
  204. package/dist/esm/admin/shipping-profile.js +7 -7
  205. package/dist/esm/admin/stock-location.d.ts +10 -10
  206. package/dist/esm/admin/stock-location.js +10 -10
  207. package/dist/esm/admin/store.d.ts +5 -5
  208. package/dist/esm/admin/store.js +5 -5
  209. package/dist/esm/admin/tax-provider.d.ts +2 -2
  210. package/dist/esm/admin/tax-provider.js +2 -2
  211. package/dist/esm/admin/tax-rate.d.ts +7 -7
  212. package/dist/esm/admin/tax-rate.js +7 -7
  213. package/dist/esm/admin/tax-region.d.ts +7 -7
  214. package/dist/esm/admin/tax-region.js +7 -7
  215. package/dist/esm/admin/translation.d.ts +7 -7
  216. package/dist/esm/admin/translation.js +7 -7
  217. package/dist/esm/admin/upload.d.ts +3 -3
  218. package/dist/esm/admin/upload.js +3 -3
  219. package/dist/esm/admin/user.d.ts +8 -8
  220. package/dist/esm/admin/user.js +8 -8
  221. package/dist/esm/admin/views.d.ts +174 -1
  222. package/dist/esm/admin/views.d.ts.map +1 -1
  223. package/dist/esm/admin/views.js +174 -1
  224. package/dist/esm/admin/views.js.map +1 -1
  225. package/dist/esm/admin/workflow-execution.d.ts +3 -3
  226. package/dist/esm/admin/workflow-execution.js +3 -3
  227. package/dist/esm/auth/index.d.ts +14 -14
  228. package/dist/esm/auth/index.js +14 -14
  229. package/dist/esm/store/index.d.ts +52 -52
  230. package/dist/esm/store/index.js +52 -52
  231. package/dist/store/index.d.ts +52 -52
  232. package/dist/store/index.js +52 -52
  233. package/package.json +2 -2
@@ -12,7 +12,7 @@ export declare class ApiKey {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This methods retrieves a paginated list of API keys. It sends a request to the
15
- * [List API Keys](https://docs.medusajs.com/api/admin#api-keys_getapikeys) API route.
15
+ * [List API Keys](https://docs.medusajs.com/api/admin/api-keys/list-api-keys) API route.
16
16
  *
17
17
  * @param queryParams - Filters and pagination configurations.
18
18
  * @param headers - Headers to pass in the request.
@@ -54,11 +54,11 @@ export declare class ApiKey {
54
54
  * })
55
55
  * ```
56
56
  *
57
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
57
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
58
58
  */
59
59
  list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyListResponse>;
60
60
  /**
61
- * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeys)
61
+ * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin/api-keys/create-api-key)
62
62
  * API route.
63
63
  *
64
64
  * @param body - The API key's details.
@@ -78,7 +78,7 @@ export declare class ApiKey {
78
78
  create(body: HttpTypes.AdminCreateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
79
79
  /**
80
80
  * This method revokes an API key. It sends a request to the
81
- * [Revoke API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke) API route.
81
+ * [Revoke API Key](https://docs.medusajs.com/api/admin/api-keys/revoke-api-key) API route.
82
82
  *
83
83
  * @param id - The API key's ID.
84
84
  * @param headers - Headers to pass in the request.
@@ -93,7 +93,7 @@ export declare class ApiKey {
93
93
  revoke(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
94
94
  /**
95
95
  * This method retrieves an API key's details. It sends a request to the
96
- * [Get API key](https://docs.medusajs.com/api/admin#api-keys_getapikeysid) API route.
96
+ * [Get API key](https://docs.medusajs.com/api/admin/api-keys/get-api-key) API route.
97
97
  *
98
98
  * @param id - The API key's ID.
99
99
  * @param headers - Headers to pass in the request.
@@ -108,7 +108,7 @@ export declare class ApiKey {
108
108
  retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
109
109
  /**
110
110
  * This method updates an API key's details. It sends a request to the
111
- * [Update API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysid) API route.
111
+ * [Update API Key](https://docs.medusajs.com/api/admin/api-keys/update-an-api-key) API route.
112
112
  *
113
113
  * @param id - The API key's ID.
114
114
  * @param body - The data to update in the API key.
@@ -127,7 +127,7 @@ export declare class ApiKey {
127
127
  update(id: string, body: HttpTypes.AdminUpdateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
128
128
  /**
129
129
  * This method deletes an API key by its ID. It sends a request to the
130
- * [Delete API Key](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid) API route.
130
+ * [Delete API Key](https://docs.medusajs.com/api/admin/api-keys/delete-an-api-key) API route.
131
131
  *
132
132
  * @param id - The API key's ID.
133
133
  * @param headers - Headers to pass in the request.
@@ -142,7 +142,7 @@ export declare class ApiKey {
142
142
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyDeleteResponse>;
143
143
  /**
144
144
  * This method manages the sales channels associated with a publishable API key to either add
145
- * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels)
145
+ * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin/api-keys/manage-sales-channels)
146
146
  * API route.
147
147
  *
148
148
  * @param id - The API key's ID.
@@ -10,7 +10,7 @@ class ApiKey {
10
10
  }
11
11
  /**
12
12
  * This methods retrieves a paginated list of API keys. It sends a request to the
13
- * [List API Keys](https://docs.medusajs.com/api/admin#api-keys_getapikeys) API route.
13
+ * [List API Keys](https://docs.medusajs.com/api/admin/api-keys/list-api-keys) API route.
14
14
  *
15
15
  * @param queryParams - Filters and pagination configurations.
16
16
  * @param headers - Headers to pass in the request.
@@ -52,7 +52,7 @@ class ApiKey {
52
52
  * })
53
53
  * ```
54
54
  *
55
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
55
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
56
56
  */
57
57
  async list(queryParams, headers) {
58
58
  return await this.client.fetch(`/admin/api-keys`, {
@@ -61,7 +61,7 @@ class ApiKey {
61
61
  });
62
62
  }
63
63
  /**
64
- * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeys)
64
+ * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/api/admin/api-keys/create-api-key)
65
65
  * API route.
66
66
  *
67
67
  * @param body - The API key's details.
@@ -88,7 +88,7 @@ class ApiKey {
88
88
  }
89
89
  /**
90
90
  * This method revokes an API key. It sends a request to the
91
- * [Revoke API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysidrevoke) API route.
91
+ * [Revoke API Key](https://docs.medusajs.com/api/admin/api-keys/revoke-api-key) API route.
92
92
  *
93
93
  * @param id - The API key's ID.
94
94
  * @param headers - Headers to pass in the request.
@@ -108,7 +108,7 @@ class ApiKey {
108
108
  }
109
109
  /**
110
110
  * This method retrieves an API key's details. It sends a request to the
111
- * [Get API key](https://docs.medusajs.com/api/admin#api-keys_getapikeysid) API route.
111
+ * [Get API key](https://docs.medusajs.com/api/admin/api-keys/get-api-key) API route.
112
112
  *
113
113
  * @param id - The API key's ID.
114
114
  * @param headers - Headers to pass in the request.
@@ -127,7 +127,7 @@ class ApiKey {
127
127
  }
128
128
  /**
129
129
  * This method updates an API key's details. It sends a request to the
130
- * [Update API Key](https://docs.medusajs.com/api/admin#api-keys_postapikeysid) API route.
130
+ * [Update API Key](https://docs.medusajs.com/api/admin/api-keys/update-an-api-key) API route.
131
131
  *
132
132
  * @param id - The API key's ID.
133
133
  * @param body - The data to update in the API key.
@@ -153,7 +153,7 @@ class ApiKey {
153
153
  }
154
154
  /**
155
155
  * This method deletes an API key by its ID. It sends a request to the
156
- * [Delete API Key](https://docs.medusajs.com/api/admin#api-keys_deleteapikeysid) API route.
156
+ * [Delete API Key](https://docs.medusajs.com/api/admin/api-keys/delete-an-api-key) API route.
157
157
  *
158
158
  * @param id - The API key's ID.
159
159
  * @param headers - Headers to pass in the request.
@@ -173,7 +173,7 @@ class ApiKey {
173
173
  }
174
174
  /**
175
175
  * This method manages the sales channels associated with a publishable API key to either add
176
- * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin#api-keys_postapikeysidsaleschannels)
176
+ * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/api/admin/api-keys/manage-sales-channels)
177
177
  * API route.
178
178
  *
179
179
  * @param id - The API key's ID.
@@ -12,7 +12,7 @@ export declare class Campaign {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a campaign by its ID. It sends a request to the
15
- * [Get Campaign](https://docs.medusajs.com/api/admin#campaigns_getcampaignsid) API route.
15
+ * [Get Campaign](https://docs.medusajs.com/api/admin/campaigns/get-a-campaign) API route.
16
16
  *
17
17
  * @param id - The campaign's ID.
18
18
  * @param query - Configure the fields to retrieve in the campaign.
@@ -40,12 +40,12 @@ export declare class Campaign {
40
40
  * })
41
41
  * ```
42
42
  *
43
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
43
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
44
44
  */
45
45
  retrieve(id: string, query?: HttpTypes.AdminGetCampaignParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
46
46
  /**
47
47
  * This method retrieves a paginated list of campaigns. It sends a request to the
48
- * [List Campaigns](https://docs.medusajs.com/api/admin#campaigns_getcampaigns) API route.
48
+ * [List Campaigns](https://docs.medusajs.com/api/admin/campaigns/list-campaigns) API route.
49
49
  *
50
50
  * @param query - Filters and pagination configurations.
51
51
  * @param headers - Headers to pass in the request.
@@ -87,12 +87,12 @@ export declare class Campaign {
87
87
  * })
88
88
  * ```
89
89
  *
90
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
90
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
91
91
  */
92
92
  list(query?: HttpTypes.AdminGetCampaignsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignListResponse>;
93
93
  /**
94
94
  * This method creates a campaign. It sends a request to the
95
- * [Create Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaigns) API route.
95
+ * [Create Campaign](https://docs.medusajs.com/api/admin/campaigns/create-campaign) API route.
96
96
  *
97
97
  * @param payload - The details of the campaign to create.
98
98
  * @param headers - Headers to pass in the request
@@ -109,7 +109,7 @@ export declare class Campaign {
109
109
  create(payload: HttpTypes.AdminCreateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
110
110
  /**
111
111
  * This method updates a campaign. It sends a request to the
112
- * [Update Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaignsid) API route.
112
+ * [Update Campaign](https://docs.medusajs.com/api/admin/campaigns/update-a-campaign) API route.
113
113
  *
114
114
  * @param id - The campaign's ID.
115
115
  * @param payload - The data to update in the campaign.
@@ -127,7 +127,7 @@ export declare class Campaign {
127
127
  update(id: string, payload: HttpTypes.AdminUpdateCampaign, headers?: ClientHeaders): Promise<HttpTypes.AdminCampaignResponse>;
128
128
  /**
129
129
  * This method deletes a campaign by its ID. It sends a request to the
130
- * [Delete Campaign](https://docs.medusajs.com/api/admin#campaigns_deletecampaignsid) API route.
130
+ * [Delete Campaign](https://docs.medusajs.com/api/admin/campaigns/delete-a-campaign) API route.
131
131
  *
132
132
  * @param id - The campaign's ID.
133
133
  * @param headers - Headers to pass in the request
@@ -142,7 +142,7 @@ export declare class Campaign {
142
142
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.DeleteResponse<"campaign">>;
143
143
  /**
144
144
  * This method manages the promotions of a campaign to either add or remove the association between them.
145
- * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin#campaigns_postcampaignsidpromotions)
145
+ * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin/campaigns/manage-promotions)
146
146
  * API route.
147
147
  *
148
148
  * @param id - The campaign's ID.
@@ -10,7 +10,7 @@ class Campaign {
10
10
  }
11
11
  /**
12
12
  * This method retrieves a campaign by its ID. It sends a request to the
13
- * [Get Campaign](https://docs.medusajs.com/api/admin#campaigns_getcampaignsid) API route.
13
+ * [Get Campaign](https://docs.medusajs.com/api/admin/campaigns/get-a-campaign) API route.
14
14
  *
15
15
  * @param id - The campaign's ID.
16
16
  * @param query - Configure the fields to retrieve in the campaign.
@@ -38,7 +38,7 @@ class Campaign {
38
38
  * })
39
39
  * ```
40
40
  *
41
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
41
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
42
42
  */
43
43
  async retrieve(id, query, headers) {
44
44
  return await this.client.fetch(`/admin/campaigns/${id}`, {
@@ -48,7 +48,7 @@ class Campaign {
48
48
  }
49
49
  /**
50
50
  * This method retrieves a paginated list of campaigns. It sends a request to the
51
- * [List Campaigns](https://docs.medusajs.com/api/admin#campaigns_getcampaigns) API route.
51
+ * [List Campaigns](https://docs.medusajs.com/api/admin/campaigns/list-campaigns) API route.
52
52
  *
53
53
  * @param query - Filters and pagination configurations.
54
54
  * @param headers - Headers to pass in the request.
@@ -90,7 +90,7 @@ class Campaign {
90
90
  * })
91
91
  * ```
92
92
  *
93
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
93
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
94
94
  */
95
95
  async list(query, headers) {
96
96
  return await this.client.fetch(`/admin/campaigns`, {
@@ -100,7 +100,7 @@ class Campaign {
100
100
  }
101
101
  /**
102
102
  * This method creates a campaign. It sends a request to the
103
- * [Create Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaigns) API route.
103
+ * [Create Campaign](https://docs.medusajs.com/api/admin/campaigns/create-campaign) API route.
104
104
  *
105
105
  * @param payload - The details of the campaign to create.
106
106
  * @param headers - Headers to pass in the request
@@ -123,7 +123,7 @@ class Campaign {
123
123
  }
124
124
  /**
125
125
  * This method updates a campaign. It sends a request to the
126
- * [Update Campaign](https://docs.medusajs.com/api/admin#campaigns_postcampaignsid) API route.
126
+ * [Update Campaign](https://docs.medusajs.com/api/admin/campaigns/update-a-campaign) API route.
127
127
  *
128
128
  * @param id - The campaign's ID.
129
129
  * @param payload - The data to update in the campaign.
@@ -147,7 +147,7 @@ class Campaign {
147
147
  }
148
148
  /**
149
149
  * This method deletes a campaign by its ID. It sends a request to the
150
- * [Delete Campaign](https://docs.medusajs.com/api/admin#campaigns_deletecampaignsid) API route.
150
+ * [Delete Campaign](https://docs.medusajs.com/api/admin/campaigns/delete-a-campaign) API route.
151
151
  *
152
152
  * @param id - The campaign's ID.
153
153
  * @param headers - Headers to pass in the request
@@ -167,7 +167,7 @@ class Campaign {
167
167
  }
168
168
  /**
169
169
  * This method manages the promotions of a campaign to either add or remove the association between them.
170
- * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin#campaigns_postcampaignsidpromotions)
170
+ * It sends a request to the [Manage Promotions](https://docs.medusajs.com/api/admin/campaigns/manage-promotions)
171
171
  * API route.
172
172
  *
173
173
  * @param id - The campaign's ID.
@@ -12,7 +12,7 @@ export declare class Claim {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a paginated list of claims. It sends a request to the
15
- * [List Claims](https://docs.medusajs.com/api/admin#claims_getclaims) API route.
15
+ * [List Claims](https://docs.medusajs.com/api/admin/claims/list-claims) API route.
16
16
  *
17
17
  * @param query - Filters and pagination configurations.
18
18
  * @param headers - Headers to pass in the request.
@@ -54,12 +54,12 @@ export declare class Claim {
54
54
  * })
55
55
  * ```
56
56
  *
57
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
57
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
58
58
  */
59
59
  list(query?: HttpTypes.AdminClaimListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimListResponse>;
60
60
  /**
61
61
  * This method retrieves a claim. It sends a request to the
62
- * [Get Claim](https://docs.medusajs.com/api/admin#claims_getclaimsid) API route.
62
+ * [Get Claim](https://docs.medusajs.com/api/admin/claims/get-a-claim) API route.
63
63
  *
64
64
  * @param id - The claim's ID.
65
65
  * @param query - Configure the fields to retrieve in the claim.
@@ -87,12 +87,12 @@ export declare class Claim {
87
87
  * })
88
88
  * ```
89
89
  *
90
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
90
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store/select-fields-and-relations).
91
91
  */
92
92
  retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimResponse>;
93
93
  /**
94
94
  * This method creates a claim. It sends a request to the
95
- * [Create Claim](https://docs.medusajs.com/api/admin#claims_postclaims) API route.
95
+ * [Create Claim](https://docs.medusajs.com/api/admin/claims/create-a-claim) API route.
96
96
  *
97
97
  * @param body - The claim's details.
98
98
  * @param query - Configure the fields to retrieve in the claim.
@@ -111,7 +111,7 @@ export declare class Claim {
111
111
  create(body: HttpTypes.AdminCreateClaim, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimOrderResponse>;
112
112
  /**
113
113
  * This method cancels a claim. It sends a request to the
114
- * [Cancel Claim](https://docs.medusajs.com/api/admin#claims_postclaimsidcancel) API route.
114
+ * [Cancel Claim](https://docs.medusajs.com/api/admin/claims/cancel-a-claim) API route.
115
115
  *
116
116
  * @param id - The claim's ID.
117
117
  * @param query - Configure the fields to retrieve in the claim.
@@ -127,7 +127,7 @@ export declare class Claim {
127
127
  cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimResponse>;
128
128
  /**
129
129
  * This method adds items to the claim. It sends a request to the
130
- * [Add Items](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitems) API route.
130
+ * [Add Items](https://docs.medusajs.com/api/admin/claims/add-claim-items) API route.
131
131
  *
132
132
  * @param id - The ID of the claim to add the items to.
133
133
  * @param body - The items' details.
@@ -151,7 +151,7 @@ export declare class Claim {
151
151
  addItems(id: string, body: HttpTypes.AdminAddClaimItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
152
152
  /**
153
153
  * This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It
154
- * sends a request to the [Update Claim Item](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
154
+ * sends a request to the [Update Claim Item](https://docs.medusajs.com/api/admin/claims/update-a-claim-item) API route.
155
155
  *
156
156
  * Every item has an `actions` property, whose value is an array of actions.
157
157
  * You can check the action's name using its `action` property, and use the value of the `id` property.
@@ -178,7 +178,7 @@ export declare class Claim {
178
178
  updateItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
179
179
  /**
180
180
  * This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
181
- * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidclaimitemsaction_id)
181
+ * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/api/admin/claims/remove-claim-item)
182
182
  * API route.
183
183
  *
184
184
  * Every item has an `actions` property, whose value is an array of actions.
@@ -203,7 +203,7 @@ export declare class Claim {
203
203
  /**
204
204
  * This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action.
205
205
  *
206
- * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditems)
206
+ * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin/claims/add-inbound-items)
207
207
  * API route.
208
208
  *
209
209
  * @param id - The ID of the claim to add the inbound items to.
@@ -231,7 +231,7 @@ export declare class Claim {
231
231
  addInboundItems(id: string, body: HttpTypes.AdminAddClaimInboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
232
232
  /**
233
233
  * This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action.
234
- * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditemsaction_id)
234
+ * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin/claims/update-inbound-items)
235
235
  * API route.
236
236
  *
237
237
  * Every item has an `actions` property, whose value is an array of actions.
@@ -259,7 +259,7 @@ export declare class Claim {
259
259
  updateInboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimInboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
260
260
  /**
261
261
  * This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action.
262
- * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinbounditemsaction_id)
262
+ * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin/claims/remove-inbound-item)
263
263
  * API route.
264
264
  *
265
265
  * Every item has an `actions` property, whose value is an array of actions.
@@ -285,7 +285,7 @@ export declare class Claim {
285
285
  * This method adds an inbound (or return) shipping method to a claim.
286
286
  * The inbound shipping method will have a `SHIPPING_ADD` action.
287
287
  *
288
- * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethod)
288
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin/claims/add-inbound-shipping)
289
289
  * API route.
290
290
  *
291
291
  * @param id - The claim's ID.
@@ -309,7 +309,7 @@ export declare class Claim {
309
309
  addInboundShipping(id: string, body: HttpTypes.AdminClaimAddInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
310
310
  /**
311
311
  * This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
312
- * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
312
+ * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin/claims/update-inbound-shipping)
313
313
  * API route.
314
314
  *
315
315
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -337,7 +337,7 @@ export declare class Claim {
337
337
  updateInboundShipping(id: string, actionId: string, body: HttpTypes.AdminClaimUpdateInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
338
338
  /**
339
339
  * This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
340
- * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
340
+ * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin/claims/remove-inbound-shipping-method)
341
341
  * API route.
342
342
  *
343
343
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -361,7 +361,7 @@ export declare class Claim {
361
361
  deleteInboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
362
362
  /**
363
363
  * This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.
364
- * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditems)
364
+ * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin/claims/add-outbound-items)
365
365
  * API route.
366
366
  *
367
367
  * @param id - The ID of the claim to add the outbound items to.
@@ -387,7 +387,7 @@ export declare class Claim {
387
387
  addOutboundItems(id: string, body: HttpTypes.AdminAddClaimOutboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
388
388
  /**
389
389
  * This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action.
390
- * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditemsaction_id)
390
+ * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin/claims/update-outbound-item)
391
391
  * API route.
392
392
  *
393
393
  * Every item has an `actions` property, whose value is an array of actions.
@@ -415,7 +415,7 @@ export declare class Claim {
415
415
  updateOutboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimOutboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
416
416
  /**
417
417
  * This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action.
418
- * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
418
+ * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/api/admin/claims/remove-outbound-item)
419
419
  * API route.
420
420
  *
421
421
  * Every item has an `actions` property, whose value is an array of actions.
@@ -442,7 +442,7 @@ export declare class Claim {
442
442
  * The outbound shipping method will have a `SHIPPING_ADD` action.
443
443
  *
444
444
  * This method sends a request to the
445
- * [Add Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethod)
445
+ * [Add Outbound Shipping](https://docs.medusajs.com/api/admin/claims/add-outbound-shipping)
446
446
  * API route.
447
447
  *
448
448
  * @param id - The claim's ID.
@@ -466,7 +466,7 @@ export declare class Claim {
466
466
  addOutboundShipping(id: string, body: HttpTypes.AdminClaimAddOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
467
467
  /**
468
468
  * This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action.
469
- * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
469
+ * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin/claims/update-outbound-shipping)
470
470
  * API route.
471
471
  *
472
472
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -516,7 +516,7 @@ export declare class Claim {
516
516
  deleteOutboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
517
517
  /**
518
518
  * This method confirms a claim request, applying its changes on the associated order.
519
- * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/api/admin#claims_postclaimsidrequest)
519
+ * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/api/admin/claims/confirm-claim)
520
520
  * API route.
521
521
  *
522
522
  * @param id - The claim's ID.
@@ -537,7 +537,7 @@ export declare class Claim {
537
537
  request(id: string, body: HttpTypes.AdminRequestClaim, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimRequestResponse>;
538
538
  /**
539
539
  * This method cancels a requested claim. It sends a request to the
540
- * [Cancel Claim Request](https://docs.medusajs.com/api/admin#claims_deleteclaimsidrequest)
540
+ * [Cancel Claim Request](https://docs.medusajs.com/api/admin/claims/cancel-claim-request)
541
541
  * API route.
542
542
  *
543
543
  * @param id - The claim's ID.