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

package/dist/esm/admin/promotion.js

@@ -14,6 +14,39 @@ export class Promotion {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a promotion by its ID. It sends a request to the
+     * [Retrieve Promotion](https://docs.medusajs.com/api/admin#promotions_getpromotionsid)
+     * API route.
+     *
+     * @param id - The promotion's ID.
+     * @param query - Configure the fields to retrieve in the promotion.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's details.
+     *
+     * @example
+     * To retrieve a promotion by its ID:
+     *
+     * ```ts
+     * sdk.admin.promotion.retrieve("promo_123")
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.promotion.retrieve("promo_123", {
+     *   fields: "id,*application_method"
+     * })
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     * ```
+     *
+     * 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/promotions/${id}`, {
@@ -22,6 +55,53 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method retrieves a list of promotions. It sends a request to the
+     * [List Promotions](https://docs.medusajs.com/api/admin#promotions_getpromotions)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of promotions.
+     *
+     * @example
+     * To retrieve the list of promotions:
+     *
+     * ```ts
+     * sdk.admin.promotion.list()
+     * .then(({ promotions, count, limit, offset }) => {
+     *   console.log(promotions)
+     * })
+     * ```
+     *
+     * 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.promotion.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ promotions, count, limit, offset }) => {
+     *   console.log(promotions)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each promotion:
+     *
+     * ```ts
+     * sdk.admin.promotion.list({
+     *   fields: "id,*application_method"
+     * })
+     * .then(({ promotions, count, limit, offset }) => {
+     *   console.log(promotions)
+     * })
+     * ```
+     *
+     * 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/promotions`, {
@@ -30,6 +110,27 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method creates a new promotion. It sends a request to the
+     * [Create Promotion](https://docs.medusajs.com/api/admin#promotions_postpromotions)
+     * API route.
+     *
+     * @param payload - The promotion to create.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's details.
+     *
+     * @example
+     * sdk.admin.promotion.create({
+     *   name: "My Promotion",
+     *   description: "This is a test promotion",
+     *   code: "PROMO123",
+     *   starts_at: "2021-01-01",
+     *   ends_at: "2021-01-01",
+     * })
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     */
     create(payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions`, {
@@ -39,6 +140,24 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method updates a promotion. It sends a request to the
+     * [Update Promotion](https://docs.medusajs.com/api/admin#promotions_postpromotionsid)
+     * API route.
+     *
+     * @param id - The promotion's ID.
+     * @param payload - The details to update in the promotion.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's details.
+     *
+     * @example
+     * sdk.admin.promotion.update("promo_123", {
+     *   code: "PROMO123",
+     * })
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     */
     update(id, payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions/${id}`, {
@@ -48,6 +167,21 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method deletes a promotion. It sends a request to the
+     * [Delete Promotion](https://docs.medusajs.com/api/admin#promotions_deletepromotionsid)
+     * API route.
+     *
+     * @param id - The promotion's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deleted promotion's details.
+     *
+     * @example
+     * sdk.admin.promotion.delete("promo_123")
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions/${id}`, {
@@ -56,6 +190,38 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method creates and adds rules to a promotion. It can be the promotion's rules,
+     * or its application method's buy or target rules. That depends on the rule type
+     * you specify as a parameter.
+     *
+     * - If you set the `ruleType` to `rules`, the method sends a request to the
+     * [Manage Promotion's Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidrulesbatch).
+     * - If you set the `ruleType` to `buy-rules`, the method sends a request to the
+     * [Manage Promotion's Buy Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidbuyrulesbatch).
+     * - If you set the `ruleType` to `target-rules`, the method sends a request to the
+     * [Manage Promotion's Target Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidtargetrulesbatch).
+     *
+     * @param id - The promotion's ID.
+     * @param ruleType - The type of rules to create.
+     * @param payload - The rules to create.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's details.
+     *
+     * @example
+     * sdk.admin.promotion.addRules("promo_123", "rules", {
+     *   rules: [
+     *     {
+     *       operator: "eq",
+     *       attribute: "product_id",
+     *       values: ["prod_123"]
+     *     }
+     *   ]
+     * })
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     */
     addRules(id, ruleType, payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions/${id}/${ruleType}/batch`, {
@@ -65,6 +231,37 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method updates the rules of a promotion. It can be the promotion's rules,
+     * or its application method's buy or target rules. That depends on the rule type
+     * you specify as a parameter.
+     *
+     * - If you set the `ruleType` to `rules`, the method sends a request to the
+     * [Manage Promotion's Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidrulesbatch).
+     * - If you set the `ruleType` to `buy-rules`, the method sends a request to the
+     * [Manage Promotion's Buy Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidbuyrulesbatch).
+     * - If you set the `ruleType` to `target-rules`, the method sends a request to the
+     * [Manage Promotion's Target Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidtargetrulesbatch).
+     *
+     * @param id - The promotion's ID.
+     * @param ruleType - The type of rules to update.
+     * @param payload - The rules to update.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's details.
+     *
+     * @example
+     * sdk.admin.promotion.updateRules("promo_123", "rules", {
+     *   rules: [
+     *     {
+     *       id: "rule_123",
+     *       operator: "ne",
+     *     }
+     *   ]
+     * })
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     */
     updateRules(id, ruleType, payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions/${id}/${ruleType}/batch`, {
@@ -74,6 +271,32 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method removes rules from a promotion. It can be the promotion's rules,
+     * or its application method's buy or target rules. That depends on the rule type
+     * you specify as a parameter.
+     *
+     * - If you set the `ruleType` to `rules`, the method sends a request to the
+     * [Manage Promotion's Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidrulesbatch).
+     * - If you set the `ruleType` to `buy-rules`, the method sends a request to the
+     * [Manage Promotion's Buy Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidbuyrulesbatch).
+     * - If you set the `ruleType` to `target-rules`, the method sends a request to the
+     * [Manage Promotion's Target Rules API Route](https://docs.medusajs.com/api/admin#promotions_postpromotionsidtargetrulesbatch).
+     *
+     * @param id - The promotion's ID.
+     * @param ruleType - The type of rules to remove.
+     * @param payload - The rules to remove.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's details.
+     *
+     * @example
+     * sdk.admin.promotion.removeRules("promo_123", "rules", {
+     *   rule_ids: ["rule_123"]
+     * })
+     * .then(({ promotion }) => {
+     *   console.log(promotion)
+     * })
+     */
     removeRules(id, ruleType, payload, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions/${id}/${ruleType}/batch`, {
@@ -83,6 +306,26 @@ export class Promotion {
             });
         });
     }
+    /**
+     * This method retrieves the rules of a promotion. It can be the promotion's rules,
+     * or its application method's buy or target rules. That depends on the rule type
+     * you specify as a parameter.
+     *
+     * This method sends a request to the
+     * [List Rules of a Promotion API Route](https://docs.medusajs.com/api/admin#promotions_getpromotionsidrule_type)
+     *
+     * @param id - The promotion's ID.
+     * @param ruleType - The type of rules to retrieve. Can be `rules`, `buy-rules`, or `target-rules`.
+     * @param query - Configure the fields to retrieve in the rules.
+     * @param headers - Headers to pass in the request.
+     * @returns The promotion's rules.
+     *
+     * @example
+     * sdk.admin.promotion.listRules("promo_123", "rules")
+     * .then(({ rules }) => {
+     *   console.log(rules)
+     * })
+     */
     listRules(id, ruleType, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             // eslint-disable-next-line max-len
@@ -92,6 +335,27 @@ export class Promotion {
             });
         });
     }
+    /**
+     * Retrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters. Only the attributes of the rule type specified in the path parameter are retrieved:
+     *
+     * - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved.
+     * - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved.
+     * - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved.
+     *
+     * This method sends a request to the
+     * [List Rule Attribute Options API Route](https://docs.medusajs.com/api/admin#promotions_getpromotionsruleattributeoptionsrule_type)
+     *
+     * @param ruleType - The type of rules to retrieve the attributes for. Can be `rules`, `buy-rules`, or `target-rules`.
+     * @param promotionType - The type of promotion to retrieve the attributes for. It can be `standard` or `buyget`.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of rule attributes.
+     *
+     * @example
+     * sdk.admin.promotion.listRuleAttributes("rules", "standard")
+     * .then(({ attributes }) => {
+     *   console.log(attributes)
+     * })
+     */
     listRuleAttributes(ruleType, promotionType, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             // eslint-disable-next-line max-len
@@ -101,6 +365,26 @@ export class Promotion {
             });
         });
     }
+    /**
+     * Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type.
+     * For example, if you provide the ID of the `currency_code` rule attribute, and set `rule_type` to rules,
+     * a list of currencies are retrieved in label-value pairs.
+     *
+     * This method sends a request to the
+     * [List Rule Values API Route](https://docs.medusajs.com/api/admin#promotions_getpromotionsrulevalueoptionsrule_typerule_attribute_id)
+     *
+     * @param ruleType - The type of rules to retrieve the values for. Can be `rules`, `buy-rules`, or `target-rules`.
+     * @param ruleValue - The ID of the rule attribute to retrieve the values for.
+     * @param query - Configure the fields to retrieve in the rule values.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of rule values.
+     *
+     * @example
+     * sdk.admin.promotion.listRuleValues("rules", "attr_123")
+     * .then(({ values }) => {
+     *   console.log(values)
+     * })
+     */
     listRuleValues(ruleType, ruleValue, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/promotions/rule-value-options/${ruleType}/${ruleValue}`, {

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

@@ -1 +1 @@
-{"version":3,"file":"promotion.js","sourceRoot":"","sources":["../../../src/admin/promotion.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,EAAE,EACzB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EACnB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,OAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EACnB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,OAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,EAAE,EACzB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,EAAE,EACzB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,QAAgB,EAChB,OAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,QAAQ,EAC3C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE;aAChC,CACF,CAAA;QACH,CAAC;KAAA;IAEK,WAAW,CACf,EAAU,EACV,QAAgB,EAChB,OAA+C,EAC/C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,QAAQ,EAC3C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE;aAChC,CACF,CAAA;QACH,CAAC;KAAA;IAEK,WAAW,CACf,EAAU,EACV,QAAgB,EAChB,OAA+C,EAC/C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,QAAQ,EAC3C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE;aACnC,CACF,CAAA;QACH,CAAC;KAAA;IAEK,SAAS,CACb,EAAiB,EACjB,QAAgB,EAChB,KAA6C,EAC7C,OAAuB;;YAEvB,mCAAmC;YACnC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,EAAE,EACrC;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,QAAgB,EAChB,aAAsB,EACtB,OAAuB;;YAEvB,mCAAmC;YACnC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4CAA4C,QAAQ,EAAE,EACtD;gBACE,OAAO;gBACP,KAAK,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE;aACzC,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,QAAgB,EAChB,SAAiB,EACjB,KAAmD,EACnD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wCAAwC,QAAQ,IAAI,SAAS,EAAE,EAC/D;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"promotion.js","sourceRoot":"","sources":["../../../src/admin/promotion.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,EAAE,EACzB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EACnB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,OAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EACnB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAU,EACV,OAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,EAAE,EACzB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,OAAO;aACd,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,EAAE,EACzB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,QAAgB,EAChB,OAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,QAAQ,EAC3C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE;aAChC,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,WAAW,CACf,EAAU,EACV,QAAgB,EAChB,OAA+C,EAC/C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,QAAQ,EAC3C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE;aAChC,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,EAAU,EACV,QAAgB,EAChB,OAA+C,EAC/C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,QAAQ,EAC3C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE;aACnC,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CACb,EAAiB,EACjB,QAAgB,EAChB,KAA6C,EAC7C,OAAuB;;YAEvB,mCAAmC;YACnC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EAAE,IAAI,QAAQ,EAAE,EACrC;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CACtB,QAAgB,EAChB,aAAsB,EACtB,OAAuB;;YAEvB,mCAAmC;YACnC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4CAA4C,QAAQ,EAAE,EACtD;gBACE,OAAO;gBACP,KAAK,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE;aACzC,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAClB,QAAgB,EAChB,SAAiB,EACjB,KAAmD,EACnD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wCAAwC,QAAQ,IAAI,SAAS,EAAE,EAC/D;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/refund-reasons.d.ts

@@ -10,6 +10,54 @@ export declare class RefundReason {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a list of refund reasons. It sends a request to the
+     * [List Refund Reasons](https://docs.medusajs.com/api/admin#refund-reasons_getrefundreasons)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of refund reasons.
+     *
+     * @example
+     * To retrieve the list of refund reasons:
+     *
+     * ```ts
+     * sdk.admin.refundReason.list()
+     * .then(({ refund_reasons, count, limit, offset }) => {
+     *   console.log(refund_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.refundReason.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ refund_reasons, count, limit, offset }) => {
+     *   console.log(refund_reasons)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each refund reason:
+     *
+     * ```ts
+     * sdk.admin.refundReason.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ refund_reasons, count, limit, offset }) => {
+     *   console.log(refund_reasons)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     *
+     */
     list(query?: HttpTypes.RefundReasonFilters, headers?: ClientHeaders): Promise<HttpTypes.RefundReasonsResponse>;
 }
 //# sourceMappingURL=refund-reasons.d.ts.map

package/dist/esm/admin/refund-reasons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/admin/refund-reasons.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,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,aAAa;CAS1E"}
+{"version":3,"file":"refund-reasons.d.ts","sourceRoot":"","sources":["../../../src/admin/refund-reasons.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,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,aAAa;CAS1E"}

package/dist/esm/admin/refund-reasons.js

@@ -14,6 +14,54 @@ export class RefundReason {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a list of refund reasons. It sends a request to the
+     * [List Refund Reasons](https://docs.medusajs.com/api/admin#refund-reasons_getrefundreasons)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of refund reasons.
+     *
+     * @example
+     * To retrieve the list of refund reasons:
+     *
+     * ```ts
+     * sdk.admin.refundReason.list()
+     * .then(({ refund_reasons, count, limit, offset }) => {
+     *   console.log(refund_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.refundReason.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ refund_reasons, count, limit, offset }) => {
+     *   console.log(refund_reasons)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each refund reason:
+     *
+     * ```ts
+     * sdk.admin.refundReason.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ refund_reasons, count, limit, offset }) => {
+     *   console.log(refund_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/refund-reasons`, {

package/dist/esm/admin/refund-reasons.js.map

@@ -1 +1 @@
-{"version":3,"file":"refund-reasons.js","sourceRoot":"","sources":["../../../src/admin/refund-reasons.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CAAC,KAAqC,EAAE,OAAuB;;YACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"refund-reasons.js","sourceRoot":"","sources":["../../../src/admin/refund-reasons.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,IAAI,CAAC,KAAqC,EAAE,OAAuB;;YACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

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

@@ -10,18 +10,143 @@ export declare class Region {
      * @ignore
      */
     constructor(client: Client);
-    create(body: HttpTypes.AdminCreateRegion, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        region: HttpTypes.AdminRegion;
-    }>;
-    update(id: string, body: HttpTypes.AdminUpdateRegion, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        region: HttpTypes.AdminRegion;
-    }>;
-    list(queryParams?: FindParams & HttpTypes.AdminRegionFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<{
-        regions: HttpTypes.AdminRegion[];
-    }>>;
-    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        region: HttpTypes.AdminRegion;
-    }>;
+    /**
+     * 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: HttpTypes.AdminCreateRegion, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionResponse>;
+    /**
+     * 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: string, body: HttpTypes.AdminUpdateRegion, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionResponse>;
+    /**
+     * 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?: FindParams & HttpTypes.AdminRegionFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionListResponse>;
+    /**
+     * 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: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionResponse>;
+    /**
+     * 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: string, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionDeleteResponse>;
 }
 //# sourceMappingURL=region.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"region.d.ts","sourceRoot":"","sources":["../../../src/admin/region.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EAET,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;gBAEkB,SAAS,CAAC,WAAW;;IAW1D,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;gBAEkB,SAAS,CAAC,WAAW;;IAW1D,IAAI,CACR,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,kBAAkB,EACvD,OAAO,CAAC,EAAE,aAAa;iBAGQ,SAAS,CAAC,WAAW,EAAE;;IAOlD,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;gBAC7B,SAAS,CAAC,WAAW;;IAS1D,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"region.d.ts","sourceRoot":"","sources":["../../../src/admin/region.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,kBAAkB,EACvD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}