fix(js-sdk): add missing admin order archive and complete methods (#12944)
* fix(js-sdk): add missing admin order archive and complete methods * Create cuddly-rice-shave.md --------- Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
Oli Juhl
parent
1ef70755c7
commit
0db5bf6f8c
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
"@medusajs/js-sdk": patch
|
||||||
|
---
|
||||||
|
|
||||||
|
fix(js-sdk): add missing admin order archive and complete methods
|
||||||
@@ -194,6 +194,37 @@ export class Order {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method archives an order. It sends a request to the
|
||||||
|
* [Archive Order](https://docs.medusajs.com/api/admin#orders_postordersidarchive)
|
||||||
|
* API route.
|
||||||
|
*
|
||||||
|
* @param id - The order's ID.
|
||||||
|
* @param queryParams - Configure the fields to retrieve in the order.
|
||||||
|
* @param headers - Headers to pass in the request
|
||||||
|
* @returns The order's details.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* sdk.admin.order.archive("order_123")
|
||||||
|
* .then(({ order }) => {
|
||||||
|
* console.log(order)
|
||||||
|
* })
|
||||||
|
*/
|
||||||
|
async archive(
|
||||||
|
id: string,
|
||||||
|
queryParams?: SelectParams,
|
||||||
|
headers?: ClientHeaders
|
||||||
|
) {
|
||||||
|
return await this.client.fetch<HttpTypes.AdminOrderResponse>(
|
||||||
|
`/admin/orders/${id}/archive`,
|
||||||
|
{
|
||||||
|
method: "POST",
|
||||||
|
query: queryParams,
|
||||||
|
headers,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method cancels an order. It sends a request to the
|
* This method cancels an order. It sends a request to the
|
||||||
* [Cancel Order](https://docs.medusajs.com/api/admin#orders_postordersidcancel)
|
* [Cancel Order](https://docs.medusajs.com/api/admin#orders_postordersidcancel)
|
||||||
@@ -219,6 +250,38 @@ export class Order {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method completes an order. It sends a request to the
|
||||||
|
* [Complete Order](https://docs.medusajs.com/api/admin#orders_postordersidcomplete)
|
||||||
|
* API route.
|
||||||
|
*
|
||||||
|
* @param id - The order's ID.
|
||||||
|
* @param headers - Headers to pass in the request.
|
||||||
|
* @returns The order's details.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* sdk.admin.order.complete("order_123")
|
||||||
|
* .then(({ order }) => {
|
||||||
|
* console.log(order)
|
||||||
|
* })
|
||||||
|
*/
|
||||||
|
async complete(
|
||||||
|
id: string,
|
||||||
|
body: HttpTypes.AdditionalData,
|
||||||
|
queryParams?: SelectParams,
|
||||||
|
headers?: ClientHeaders
|
||||||
|
) {
|
||||||
|
return await this.client.fetch<HttpTypes.AdminOrderResponse>(
|
||||||
|
`/admin/orders/${id}/complete`,
|
||||||
|
{
|
||||||
|
method: "POST",
|
||||||
|
body,
|
||||||
|
query: queryParams,
|
||||||
|
headers,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method requests an order transfer. It sends a request to the
|
* This method requests an order transfer. It sends a request to the
|
||||||
* [Request Order Transfer](https://docs.medusajs.com/api/admin#orders_postordersidrequesttransfer)
|
* [Request Order Transfer](https://docs.medusajs.com/api/admin#orders_postordersidrequesttransfer)
|
||||||
@@ -504,13 +567,13 @@ export class Order {
|
|||||||
/**
|
/**
|
||||||
* This method creates a credit line for an order. It sends a request to the
|
* This method creates a credit line for an order. It sends a request to the
|
||||||
* [Create Credit Line](https://docs.medusajs.com/api/admin#orders_postordersidcredit-lines) API route.
|
* [Create Credit Line](https://docs.medusajs.com/api/admin#orders_postordersidcredit-lines) API route.
|
||||||
*
|
*
|
||||||
* @param orderId - The order's ID.
|
* @param orderId - The order's ID.
|
||||||
* @param body - The credit line's details.
|
* @param body - The credit line's details.
|
||||||
* @param query - Configure the fields to retrieve in the order.
|
* @param query - Configure the fields to retrieve in the order.
|
||||||
* @param headers - Headers to pass in the request
|
* @param headers - Headers to pass in the request
|
||||||
* @returns The order's details.
|
* @returns The order's details.
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* sdk.admin.order.createCreditLine(
|
* sdk.admin.order.createCreditLine(
|
||||||
* "order_123",
|
* "order_123",
|
||||||
|
|||||||
Reference in New Issue
Block a user