asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: add missing since tag for js sdk (#14325)

Browse Source
This commit is contained in:
Shahed Nasser
2025-12-16 18:26:52 +02:00
committed by GitHub
parent b8c2b9607b
commit bee86bf1d5
2 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/js-sdk/src/admin/order.ts
+5 -2
View File
@@ -676,7 +676,8 @@ export class Order {
} }
/** /**
* This method starts an order export process to retrieve a CSV of exported orders. * This method starts an order export process to retrieve a CSV of exported orders. It sends
* a request to the [Export Orders](https://docs.medusajs.com/api/admin#orders_postordersexport) API route.
* *
* You'll receive in the response the transaction ID of the workflow generating the CSV file. * You'll receive in the response the transaction ID of the workflow generating the CSV file.
* To check the status of the execution, send a `GET` request to * To check the status of the execution, send a `GET` request to
@@ -685,13 +686,15 @@ export class Order {
* Once the execution finishes successfully, a notification is created for the export. * Once the execution finishes successfully, a notification is created for the export.
* You can retrieve the notifications using the `/admin/notification` API route to * You can retrieve the notifications using the `/admin/notification` API route to
* retrieve the file's download URL. * retrieve the file's download URL.
*
* @since 2.12.3
* *
* @param query - Filters to specify which orders to export. * @param query - Filters to specify which orders to export.
* @param headers - Headers to pass in the request. * @param headers - Headers to pass in the request.
* @returns The export's details. * @returns The export's details.
* *
* @example * @example
* sdk.admin.order.export({}) * sdk.admin.order.export()
* .then(({ transaction_id }) => { * .then(({ transaction_id }) => {
* console.log(transaction_id) * console.log(transaction_id)
* }) * })
packages/core/js-sdk/src/admin/price-list.ts
+2
View File
@@ -283,6 +283,8 @@ export class PriceList {
* This method retrieves the prices of a price list. It sends a request to the * This method retrieves the prices of a price list. It sends a request to the
* [Get Prices](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelistsidprices) * [Get Prices](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelistsidprices)
* API route. * API route.
*
* @since 2.12.3
* *
* @param id - The price list's ID. * @param id - The price list's ID.
* @param query - Configure the fields to retrieve in the price list. * @param query - Configure the fields to retrieve in the price list.