@medusajs/js-sdk 1.0.0-rc-20241016093905 → 1.0.0-rc-20241022152047

package/dist/esm/admin/claim.js

@@ -8,9 +8,58 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 export class Claim {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a paginated list of claims. It sends a request to the
+     * [List Claims](https://docs.medusajs.com/v2/api/admin#claims_getclaims) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of claims.
+     *
+     * @example
+     * To retrieve the list of claims:
+     *
+     * ```ts
+     * sdk.admin.claim.list()
+     * .then(({ claims, count, limit, offset }) => {
+     *   console.log(claims)
+     * })
+     * ```
+     *
+     * 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.claim.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ claims, count, limit, offset }) => {
+     *   console.log(claims)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each claim:
+     *
+     * ```ts
+     * sdk.admin.claim.list({
+     *   fields: "id,*additional_items"
+     * })
+     * .then(({ claims, count, limit, offset }) => {
+     *   console.log(claims)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims`, {
@@ -19,6 +68,38 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method retrieves a claim. It sends a request to the
+     * [Get Claim](https://docs.medusajs.com/v2/api/admin#claims_getclaimsid) API route.
+     *
+     * @param id - The claim's ID.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The claim's details.
+     *
+     * @example
+     * To retrieve a claim by its ID:
+     *
+     * ```ts
+     * sdk.admin.claim.retrieve("claim_123")
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.claim.retrieve("claim_123", {
+     *   fields: "id,*additional_items"
+     * })
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}`, {
@@ -27,6 +108,24 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method creates a claim. It sends a request to the
+     * [Create Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaims) API route.
+     *
+     * @param body - The claim's details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The claim and order's details.
+     *
+     * @example
+     * sdk.admin.claim.create({
+     *   type: "refund",
+     *   order_id: "order_123",
+     * })
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims`, {
@@ -37,6 +136,21 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method cancels a claim. It sends a request to the
+     * [Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidcancel) API route.
+     *
+     * @param id - The claim's ID.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The claim's details.
+     *
+     * @example
+     * sdk.admin.claim.cancel("claim_123")
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     cancel(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/cancel`, {
@@ -46,15 +160,29 @@ export class Claim {
             });
         });
     }
-    delete(id, query, headers) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.client.fetch(`/admin/claims/${id}`, {
-                method: "DELETE",
-                headers,
-                query,
-            });
-        });
-    }
+    /**
+     * This method adds items to the claim. It sends a request to the
+     * [Add Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitems) API route.
+     *
+     * @param id - The ID of the claim to add the items to.
+     * @param body - The items' details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The claim's details with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.addItems("claim_123", {
+     *   items: [
+     *     {
+     *       id: "orli_123",
+     *       quantity: 1
+     *     }
+     *   ]
+     * })
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     addItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/claim-items`, {
@@ -65,6 +193,32 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It
+     * sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the order item's `WRITE_OFF_ITEM` action.
+     * @param body - The details to update.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The claim's details with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.updateItem(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   {
+     *     quantity: 1
+     *   }
+     *   )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     updateItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/claim-items/${actionId}`, {
@@ -75,6 +229,29 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
+     * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidclaimitemsaction_id)
+     * API route.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the order item's `WRITE_OFF_ITEM` action.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The claim's details with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.removeItem(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     removeItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/claim-items/${actionId}`, {
@@ -84,6 +261,34 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action.
+     *
+     * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditems)
+     * API route.
+     *
+     * @param id - The ID of the claim to add the inbound items to.
+     * @param body - The inbound items' details.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the return associated with the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.addInboundItems(
+     *   "claim_123",
+     *   {
+     *     items: [
+     *       {
+     *         id: "orli_123",
+     *         quantity: 1
+     *       }
+     *     ]
+     *   },
+     *   )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     addInboundItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/inbound/items`, {
@@ -94,6 +299,33 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action.
+     * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditemsaction_id)
+     * API route.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the return item's `RETURN_ITEM` action.
+     * @param body - The details to update in the inbound item.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the return associated wth the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.updateInboundItem(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   {
+     *     quantity: 1
+     *   },
+     *   )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     updateInboundItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/inbound/items/${actionId}`, {
@@ -104,6 +336,29 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action.
+     * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinbounditemsaction_id)
+     * API route.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The ID of the return item's `RETURN_ITEM` action.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the return associated wth the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.removeInboundItem(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     removeInboundItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/inbound/items/${actionId}`, {
@@ -113,6 +368,31 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method adds an inbound (or return) shipping method to a claim.
+     * The inbound shipping method will have a `SHIPPING_ADD` action.
+     *
+     * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethod)
+     * API route.
+     *
+     * @param id - The claim's ID.
+     * @param body - The shipping method's details.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the return associated wth the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.addInboundShipping(
+     *   "claim_123",
+     *   {
+     *     shipping_option_id: "so_123",
+     *     custom_amount: 10
+     *   },
+     *   )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     addInboundShipping(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/inbound/shipping-method`, {
@@ -123,6 +403,33 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
+     * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
+     * API route.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param body - The details to update in the shipping method
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.updateInboundShipping(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   {
+     *     custom_amount: 10
+     *   },
+     *   )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     updateInboundShipping(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/inbound/shipping-method/${actionId}`, {
@@ -133,6 +440,29 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
+     * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
+     * API route.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param query - Configure the fields to retrieve in the return.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the return associated wth the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.deleteInboundShipping(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   )
+     * .then(({ return: returnData }) => {
+     *   console.log(returnData)
+     * })
+     */
     deleteInboundShipping(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/inbound/shipping-method/${actionId}`, {
@@ -142,6 +472,31 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.
+     * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditems)
+     * API route.
+     *
+     * @param id - The ID of the claim to add the outbound items to.
+     * @param body - The items' details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.addOutboundItems(
+     *   "claim_123",
+     *   {
+     *     items: [{
+     *       id: "orli_123",
+     *       quantity: 1
+     *     }]
+     *   },
+     *   )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     addOutboundItems(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/outbound/items`, {
@@ -152,6 +507,33 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action.
+     * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditemsaction_id)
+     * API route.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the new claim item's `ITEM_ADD` action.
+     * @param body - The item's details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.updateOutboundItem(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   {
+     *     quantity: 1
+     *   },
+     *   )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     updateOutboundItem(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/outbound/items/${actionId}`, {
@@ -162,6 +544,29 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action.
+     * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
+     * API route.
+     *
+     * Every item has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the new claim item's `ITEM_ADD` action.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.removeOutboundItem(
+     *   "claim_123",
+     *   "ordchact_123",
+     * )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     removeOutboundItem(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/outbound/items/${actionId}`, {
@@ -171,6 +576,32 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method adds outbound an outbound shipping method to a claim.
+     * The outbound shipping method will have a `SHIPPING_ADD` action.
+     *
+     * This method sends a request to the
+     * [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethod)
+     * API route.
+     *
+     * @param id - The claim's ID.
+     * @param body - The shipping method's details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     *    * sdk.admin.claim.addOutboundShipping(
+     *   "claim_123",
+     *   {
+     *     shipping_option_id: "so_123",
+     *     custom_amount: 10
+     *   },
+     * )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     addOutboundShipping(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/outbound/shipping-method`, {
@@ -181,6 +612,33 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action.
+     * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
+     * API route.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param body - The shipping method's details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.updateOutboundShipping(
+     *   "claim_123",
+     *   "ordchact_123",
+     *   {
+     *     custom_amount: 10
+     *   },
+     * )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     updateOutboundShipping(id, actionId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/outbound/shipping-method/${actionId}`, {
@@ -191,6 +649,27 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method deletes the shipping method for delivering outbound items in the claim using the ID of the method's `SHIPPING_ADD` action.
+     *
+     * Every shipping method has an `actions` property, whose value is an array of actions.
+     * You can check the action's name using its `action` property, and use the value of the `id` property.
+     *
+     * @param id - The claim's ID.
+     * @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.deleteOutboundShipping(
+     *   "claim_123",
+     *   "ordchact_123",
+     * )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     deleteOutboundShipping(id, actionId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/outbound/shipping-method/${actionId}`, {
@@ -200,6 +679,26 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method confirms a claim request, applying its changes on the associated order.
+     * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidrequest)
+     * API route.
+     *
+     * @param id - The claim's ID.
+     * @param body - The confirmation details.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The details of the claim and its associated return, with a preview of the order when the claim is applied.
+     *
+     * @example
+     * sdk.admin.claim.request(
+     *   "claim_123",
+     *   {},
+     * )
+     * .then(({ claim }) => {
+     *   console.log(claim)
+     * })
+     */
     request(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/request`, {
@@ -210,6 +709,24 @@ export class Claim {
             });
         });
     }
+    /**
+     * This method cancels a requested claim. It sends a request to the
+     * [Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidrequest)
+     * API route.
+     *
+     * @param id - The claim's ID.
+     * @param query - Configure the fields to retrieve in the claim.
+     * @param headers - Headers to pass in the request
+     * @returns The cancelation's details.
+     *
+     * @example
+     * sdk.admin.claim.cancelRequest(
+     *   "claim_123",
+     * )
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     cancelRequest(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/claims/${id}/request`, {