daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
5.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminReservationsResource
Hierarchy
-
default↳
AdminReservationsResource
Methods
create
▸ create(payload, customHeaders?): ResponsePromise<AdminReservationsRes>
create a reservation
Parameters
| Name | Type |
|---|---|
payload |
AdminPostReservationsReq |
customHeaders |
Record<string, unknown> |
Returns
ResponsePromise<AdminReservationsRes>
the created reservation
Description
create a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory
Defined in
packages/medusa-js/src/resources/admin/reservations.ts:57
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
remove a reservation
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, unknown> |
Returns
ResponsePromise<DeleteResponse>
reservation removal confirmation
Description
remove a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory
Defined in
packages/medusa-js/src/resources/admin/reservations.ts:88
list
▸ list(query?, customHeaders?): ResponsePromise<AdminReservationsListRes>
List reservations This feature is under development and may change in the future. To use this feature please install @medusajs/inventory
Parameters
| Name | Type |
|---|---|
query? |
AdminGetReservationsParams |
customHeaders |
Record<string, unknown> |
Returns
ResponsePromise<AdminReservationsListRes>
A list of reservations matching the provided query
Description
Lists reservations
Defined in
packages/medusa-js/src/resources/admin/reservations.ts:36
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminReservationsRes>
Get a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, unknown> |
Returns
ResponsePromise<AdminReservationsRes>
The reservation with the provided id
Description
gets a reservation
Defined in
packages/medusa-js/src/resources/admin/reservations.ts:21
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminReservationsRes>
update a reservation
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostReservationsReservationReq |
customHeaders |
Record<string, unknown> |
Returns
ResponsePromise<AdminReservationsRes>
The updated reservation
Description
update a reservation This feature is under development and may change in the future. To use this feature please install @medusajs/inventory