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

package/dist/admin/return-reason.js

@@ -8,18 +8,117 @@ 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).
+     */
     async list(query, headers) {
         return await this.client.fetch("/admin/return-reasons", {
             headers,
             query,
         });
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/return-reasons/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/return-reasons`, {
             method: "POST",
@@ -28,6 +127,26 @@ class ReturnReason {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/return-reasons/${id}`, {
             method: "POST",
@@ -36,6 +155,22 @@ class ReturnReason {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async delete(id, query, headers) {
         return await this.client.fetch(`/admin/return-reasons/${id}`, {
             method: "DELETE",

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

@@ -1 +1 @@
-{"version":3,"file":"return-reason.js","sourceRoot":"","sources":["../../src/admin/return-reason.ts"],"names":[],"mappings":";;;AAKA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EACvB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAtFD,oCAsFC"}
+{"version":3,"file":"return-reason.js","sourceRoot":"","sources":["../../src/admin/return-reason.ts"],"names":[],"mappings":";;;AAKA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EACvB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AA7ND,oCA6NC"}