@medusajs/js-sdk 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406180144

package/dist/esm/admin/region.js

@@ -14,6 +14,25 @@ export class Region {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a new region. It sends a request to the
+     * [Create Region](https://docs.medusajs.com/api/admin#regions_postregions)
+     * API route.
+     *
+     * @param body - The details of the region to create.
+     * @param query - Configure the fields and relations to retrieve in the region.
+     * @param headers - Headers to pass in the request.
+     * @returns The created region's details.
+     *
+     * @example
+     * sdk.admin.region.create({
+     *   name: "United States",
+     *   currency_code: "usd",
+     * })
+     * .then(({ region }) => {
+     *   console.log(region)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/regions`, {
@@ -24,6 +43,25 @@ export class Region {
             });
         });
     }
+    /**
+     * This method updates a region. It sends a request to the
+     * [Update Region](https://docs.medusajs.com/api/admin#regions_postregionsid)
+     * API route.
+     *
+     * @param id - The ID of the region to update.
+     * @param body - The details of the region to update.
+     * @param query - Configure the fields and relations to retrieve in the region.
+     * @param headers - Headers to pass in the request.
+     * @returns The updated region's details.
+     *
+     * @example
+     * sdk.admin.region.update("region_123", {
+     *   name: "United States",
+     * })
+     * .then(({ region }) => {
+     *   console.log(region)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/regions/${id}`, {
@@ -34,6 +72,53 @@ export class Region {
             });
         });
     }
+    /**
+     * This method retrieves a list of regions. It sends a request to the
+     * [List Regions](https://docs.medusajs.com/api/admin#regions_getregions)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of regions.
+     *
+     * @example
+     * To retrieve the list of regions:
+     *
+     * ```ts
+     * sdk.admin.region.list()
+     * .then(({ regions, count, limit, offset }) => {
+     *   console.log(regions)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.region.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ regions, count, limit, offset }) => {
+     *   console.log(regions)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each region:
+     *
+     * ```ts
+     * sdk.admin.region.list({
+     *   fields: "id,*countries"
+     * })
+     * .then(({ regions, count, limit, offset }) => {
+     *   console.log(regions)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(queryParams, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/regions`, {
@@ -42,6 +127,39 @@ export class Region {
             });
         });
     }
+    /**
+     * This method retrieves a region by ID. It sends a request to the
+     * [Get Region](https://docs.medusajs.com/api/admin#regions_getregionsid)
+     * API route.
+     *
+     * @param id - The ID of the region to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the region.
+     * @param headers - Headers to pass in the request.
+     * @returns The region's details.
+     *
+     * @example
+     * To retrieve a region by its ID:
+     *
+     * ```ts
+     * sdk.admin.region.retrieve("region_123")
+     * .then(({ region }) => {
+     *   console.log(region)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.region.retrieve("region_123", {
+     *   fields: "id,*countries"
+     * })
+     * .then(({ region }) => {
+     *   console.log(region)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/regions/${id}`, {
@@ -50,6 +168,21 @@ export class Region {
             });
         });
     }
+    /**
+     * This method deletes a region by ID. It sends a request to the
+     * [Delete Region](https://docs.medusajs.com/api/admin#regions_deleteregionsid)
+     * API route.
+     *
+     * @param id - The ID of the region to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.region.delete("region_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/regions/${id}`, {

package/dist/esm/admin/region.js.map

@@ -1 +1 @@
-{"version":3,"file":"region.js","sourceRoot":"","sources":["../../../src/admin/region.ts"],"names":[],"mappings":";;;;;;;;;AASA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,WAAuD,EACvD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,gBAAgB,EAAE;gBAClB,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"region.js","sourceRoot":"","sources":["../../../src/admin/region.ts"],"names":[],"mappings":";;;;;;;;;AAQA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAuD,EACvD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/reservation.d.ts

@@ -10,10 +10,144 @@ declare class Reservation {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a reservation by ID. It sends a request to the
+     * [Get Reservation](https://docs.medusajs.com/api/admin#reservations_getreservationsid)
+     * API route.
+     *
+     * @param id - The reservation's ID.
+     * @param query - Configure the fields and relations to retrieve in the reservation.
+     * @param headers - Headers to pass in the request.
+     * @returns The reservation's details.
+     *
+     * @example
+     * To retrieve a reservation by its ID:
+     *
+     * ```ts
+     * sdk.admin.reservation.retrieve("res_123")
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.reservation.retrieve("res_123", {
+     *   fields: "id,name"
+     * })
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminReservationParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReservationResponse>;
+    /**
+     * This method retrieves a list of reservations. It sends a request to the
+     * [List Reservations](https://docs.medusajs.com/api/admin#reservations_getreservations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of reservations.
+     *
+     * @example
+     * To retrieve the list of reservations:
+     *
+     * ```ts
+     * sdk.admin.reservation.list()
+     * .then(({ reservations, count, limit, offset }) => {
+     *   console.log(reservations)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.reservation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ reservations, count, limit, offset }) => {
+     *   console.log(reservations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each reservation:
+     *
+     * ```ts
+     * sdk.admin.reservation.list({
+     *   fields: "id,*inventory_item"
+     * })
+     * .then(({ reservations, count, limit, offset }) => {
+     *   console.log(reservations)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminGetReservationsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReservationListResponse>;
+    /**
+     * This method creates a reservation. It sends a request to the
+     * [Create Reservation](https://docs.medusajs.com/api/admin#reservations_postreservations)
+     * API route.
+     *
+     * @param body - The details of the reservation to create.
+     * @param query - Configure the fields and relations to retrieve in the reservation.
+     * @param headers - Headers to pass in the request.
+     * @returns The reservation's details.
+     *
+     * @example
+     * sdk.admin.reservation.create({
+     *   inventory_item_id: "iitem_123",
+     *   location_id: "sloc_123",
+     *   quantity: 10,
+     * })
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     */
     create(body: HttpTypes.AdminCreateReservation, query?: HttpTypes.AdminGetReservationsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReservationResponse>;
+    /**
+     * This method updates a reservation. It sends a request to the
+     * [Update Reservation](https://docs.medusajs.com/api/admin#reservations_postreservationsid)
+     * API route.
+     *
+     * @param id - The reservation's ID.
+     * @param body - The details of the reservation to update.
+     * @param query - Configure the fields and relations to retrieve in the reservation.
+     * @param headers - Headers to pass in the request.
+     * @returns The reservation's details.
+     *
+     * @example
+     * sdk.admin.reservation.update("res_123", {
+     *   quantity: 20,
+     * })
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateReservation, query?: HttpTypes.AdminGetReservationsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReservationResponse>;
+    /**
+     * This method deletes a reservation by ID. It sends a request to the
+     * [Delete Reservation](https://docs.medusajs.com/api/admin#reservations_deletereservationsid)
+     * API route.
+     *
+     * @param id - The reservation's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.reservation.delete("res_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminReservationDeleteResponse>;
 }
 export default Reservation;

package/dist/esm/admin/reservation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reservation.d.ts","sourceRoot":"","sources":["../../../src/admin/reservation.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,cAAM,WAAW;IACf;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD;AAED,eAAe,WAAW,CAAA"}
+{"version":3,"file":"reservation.d.ts","sourceRoot":"","sources":["../../../src/admin/reservation.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,cAAM,WAAW;IACf;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD;AAED,eAAe,WAAW,CAAA"}

package/dist/esm/admin/reservation.js

@@ -14,6 +14,39 @@ class Reservation {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a reservation by ID. It sends a request to the
+     * [Get Reservation](https://docs.medusajs.com/api/admin#reservations_getreservationsid)
+     * API route.
+     *
+     * @param id - The reservation's ID.
+     * @param query - Configure the fields and relations to retrieve in the reservation.
+     * @param headers - Headers to pass in the request.
+     * @returns The reservation's details.
+     *
+     * @example
+     * To retrieve a reservation by its ID:
+     *
+     * ```ts
+     * sdk.admin.reservation.retrieve("res_123")
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.reservation.retrieve("res_123", {
+     *   fields: "id,name"
+     * })
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/reservations/${id}`, {
@@ -23,6 +56,53 @@ class Reservation {
             });
         });
     }
+    /**
+     * This method retrieves a list of reservations. It sends a request to the
+     * [List Reservations](https://docs.medusajs.com/api/admin#reservations_getreservations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of reservations.
+     *
+     * @example
+     * To retrieve the list of reservations:
+     *
+     * ```ts
+     * sdk.admin.reservation.list()
+     * .then(({ reservations, count, limit, offset }) => {
+     *   console.log(reservations)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.reservation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ reservations, count, limit, offset }) => {
+     *   console.log(reservations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each reservation:
+     *
+     * ```ts
+     * sdk.admin.reservation.list({
+     *   fields: "id,*inventory_item"
+     * })
+     * .then(({ reservations, count, limit, offset }) => {
+     *   console.log(reservations)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch("/admin/reservations", {
@@ -32,6 +112,26 @@ class Reservation {
             });
         });
     }
+    /**
+     * This method creates a reservation. It sends a request to the
+     * [Create Reservation](https://docs.medusajs.com/api/admin#reservations_postreservations)
+     * API route.
+     *
+     * @param body - The details of the reservation to create.
+     * @param query - Configure the fields and relations to retrieve in the reservation.
+     * @param headers - Headers to pass in the request.
+     * @returns The reservation's details.
+     *
+     * @example
+     * sdk.admin.reservation.create({
+     *   inventory_item_id: "iitem_123",
+     *   location_id: "sloc_123",
+     *   quantity: 10,
+     * })
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch("/admin/reservations", {
@@ -42,6 +142,25 @@ class Reservation {
             });
         });
     }
+    /**
+     * This method updates a reservation. It sends a request to the
+     * [Update Reservation](https://docs.medusajs.com/api/admin#reservations_postreservationsid)
+     * API route.
+     *
+     * @param id - The reservation's ID.
+     * @param body - The details of the reservation to update.
+     * @param query - Configure the fields and relations to retrieve in the reservation.
+     * @param headers - Headers to pass in the request.
+     * @returns The reservation's details.
+     *
+     * @example
+     * sdk.admin.reservation.update("res_123", {
+     *   quantity: 20,
+     * })
+     * .then(({ reservation }) => {
+     *   console.log(reservation)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/reservations/${id}`, {
@@ -52,6 +171,21 @@ class Reservation {
             });
         });
     }
+    /**
+     * This method deletes a reservation by ID. It sends a request to the
+     * [Delete Reservation](https://docs.medusajs.com/api/admin#reservations_deletereservationsid)
+     * API route.
+     *
+     * @param id - The reservation's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.reservation.delete("res_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/reservations/${id}`, {

package/dist/esm/admin/reservation.js.map

@@ -1 +1 @@
-{"version":3,"file":"reservation.js","sourceRoot":"","sources":["../../../src/admin/reservation.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,WAAW;IAKf;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAAwC,EACxC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,IAAsC,EACtC,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAsC,EACtC,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF;AAED,eAAe,WAAW,CAAA"}
+{"version":3,"file":"reservation.js","sourceRoot":"","sources":["../../../src/admin/reservation.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,WAAW;IAKf;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAwC,EACxC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,IAAsC,EACtC,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAsC,EACtC,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF;AAED,eAAe,WAAW,CAAA"}

package/dist/esm/admin/return-reason.d.ts

@@ -10,10 +10,145 @@ export declare class ReturnReason {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a list of return reasons. It sends a request to the
+     * [List Return Reasons](https://docs.medusajs.com/api/admin#return-reasons_returnreason_schema)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of return reasons.
+     *
+     * @example
+     * To retrieve the list of return reasons:
+     *
+     * ```ts
+     * sdk.admin.returnReason.list()
+     * .then(({ return_reasons, count, limit, offset }) => {
+     *   console.log(return_reasons)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.returnReason.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ return_reasons, count, limit, offset }) => {
+     *   console.log(return_reasons)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each return reason:
+     *
+     * ```ts
+     * sdk.admin.returnReason.list({
+     *   fields: "id,value"
+     * })
+     * .then(({ return_reasons, count, limit, offset }) => {
+     *   console.log(return_reasons)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminReturnReasonListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReturnReasonListResponse>;
+    /**
+     * This method retrieves a return reason by ID. It sends a request to the
+     * [Get Return Reason](https://docs.medusajs.com/api/admin#return-reasons_getreturnreasonsid)
+     * API route.
+     *
+     * @param id - The return reason's ID.
+     * @param query - Configure the fields and relations to retrieve in the return reason.
+     * @param headers - Headers to pass in the request.
+     * @returns The return reason's details.
+     *
+     * @example
+     * To retrieve a return reason by its ID:
+     *
+     * ```ts
+     * sdk.admin.returnReason.retrieve("ret_123")
+     * .then(({ return_reason }) => {
+     *   console.log(return_reason)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.returnReason.retrieve("ret_123", {
+     *   fields: "id,value"
+     * })
+     * .then(({ return_reason }) => {
+     *   console.log(return_reason)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminReturnReasonParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReturnReasonResponse>;
+    /**
+     * This method creates a return reason. It sends a request to the
+     * [Create Return Reason](https://docs.medusajs.com/api/admin#return-reasons_postreturnreasons)
+     * API route.
+     *
+     * @param body - The details of the return reason to create.
+     * @param query - Configure the fields and relations to retrieve in the return reason.
+     * @param headers - Headers to pass in the request.
+     * @returns The return reason's details.
+     *
+     * @example
+     * sdk.admin.returnReason.create({
+     *   value: "refund",
+     *   label: "Refund",
+     * })
+     * .then(({ return_reason }) => {
+     *   console.log(return_reason)
+     * })
+     */
     create(body: HttpTypes.AdminCreateReturnReason, query?: HttpTypes.AdminReturnReasonParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReturnReasonResponse>;
+    /**
+     * This method updates a return reason. It sends a request to the
+     * [Update Return Reason](https://docs.medusajs.com/api/admin#return-reasons_postreturnreasonsid)
+     * API route.
+     *
+     * @param id - The return reason's ID.
+     * @param body - The details of the return reason to update.
+     * @param query - Configure the fields and relations to retrieve in the return reason.
+     * @param headers - Headers to pass in the request.
+     * @returns The return reason's details.
+     *
+     * @example
+     * sdk.admin.returnReason.update("ret_123", {
+     *   value: "refund",
+     *   label: "Refund",
+     * })
+     * .then(({ return_reason }) => {
+     *   console.log(return_reason)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateReturnReason, query?: HttpTypes.AdminReturnReasonParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReturnReasonResponse>;
+    /**
+     * This method deletes a return reason. It sends a request to the
+     * [Delete Return Reason](https://docs.medusajs.com/api/admin#return-reasons_deletereturnreasonsid)
+     * API route.
+     *
+     * @param id - The return reason's ID.
+     * @param query - Query parameters to pass to the request.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.returnReason.delete("ret_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, query?: HttpTypes.AdminReturnReasonParams, headers?: ClientHeaders): Promise<HttpTypes.AdminReturnReasonDeleteResponse>;
 }
 //# sourceMappingURL=return-reason.d.ts.map

package/dist/esm/admin/return-reason.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"return-reason.d.ts","sourceRoot":"","sources":["../../../src/admin/return-reason.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"return-reason.d.ts","sourceRoot":"","sources":["../../../src/admin/return-reason.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;CAW1B"}