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

package/dist/esm/admin/return-reason.js

@@ -14,6 +14,53 @@ export class ReturnReason {
     constructor(client) {
         this.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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch("/admin/return-reasons", {
@@ -22,6 +69,39 @@ export class ReturnReason {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/return-reasons/${id}`, {
@@ -30,6 +110,25 @@ export class ReturnReason {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/return-reasons`, {
@@ -40,6 +139,26 @@ export class ReturnReason {
             });
         });
     }
+    /**
+     * 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, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/return-reasons/${id}`, {
@@ -50,6 +169,22 @@ export class ReturnReason {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/return-reasons/${id}`, {

package/dist/esm/admin/return-reason.js.map

@@ -1 +1 @@
-{"version":3,"file":"return-reason.js","sourceRoot":"","sources":["../../../src/admin/return-reason.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EACvB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,yBAAyB,EAAE,EAAE,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"return-reason.js","sourceRoot":"","sources":["../../../src/admin/return-reason.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EACvB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,yBAAyB,EAAE,EAAE,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}