@medusajs/js-sdk 2.0.0-preview-20241022094107 → 2.0.0-rc-20241022183311

package/dist/esm/admin/fulfillment-provider.js

@@ -14,6 +14,53 @@ export class FulfillmentProvider {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a paginated list of fulfillment providers. It sends a request to the
+     * [List Fulfillment Providers](https://docs.medusajs.com/v2/api/admin#fulfillment-providers_getfulfillmentproviders)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of providers.
+     *
+     * @example
+     * To retrieve the list of fulfillment providers:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentProvider.list()
+     * .then(({ fulfillment_providers, count, limit, offset }) => {
+     *   console.log(fulfillment_providers)
+     * })
+     * ```
+     *
+     * 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.fulfillmentProvider.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ fulfillment_providers, count, limit, offset }) => {
+     *   console.log(fulfillment_providers)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each fulfillment provider:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentProvider.list({
+     *   fields: "id"
+     * })
+     * .then(({ fulfillment_providers, count, limit, offset }) => {
+     *   console.log(fulfillment_providers)
+     * })
+     * ```
+     *
+     * 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/fulfillment-providers`, {

package/dist/esm/admin/fulfillment-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider.js","sourceRoot":"","sources":["../../../src/admin/fulfillment-provider.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,mBAAmB;IAK9B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,KAAoD,EACpD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"fulfillment-provider.js","sourceRoot":"","sources":["../../../src/admin/fulfillment-provider.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,mBAAmB;IAK9B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAoD,EACpD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/fulfillment-set.d.ts

@@ -10,10 +10,132 @@ export declare class FulfillmentSet {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method deletes a fulfillment set. It sends a request to the
+     * [Delete Fulfillment Set](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_deletefulfillmentsetsid)
+     * API route.
+     *
+     * @param id - The fulfillment set's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.delete("fset_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetDeleteResponse>;
+    /**
+     * This method adds a service zone to a fulfillment set. It uses the
+     * [Add Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones)
+     * API route.
+     *
+     * @param id - The fulfillment set's ID.
+     * @param body - The service zone's details.
+     * @param query - Configure the fields to retrieve in the fulfillment set.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment set's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.createServiceZone("fset_123", {
+     *   name: "Europe Service Zone",
+     *   geo_zones: [{
+     *     type: "country",
+     *     country_code: "us"
+     *   }]
+     * })
+     * .then(({ fulfillment_set }) => {
+     *   console.log(fulfillment_set)
+     * })
+     */
     createServiceZone(id: string, body: HttpTypes.AdminCreateFulfillmentSetServiceZone, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetResponse>;
+    /**
+     * This method retrieves a fulfillment set's service zone's details. It sends a request to the
+     * [Get Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_getfulfillmentsetsidservicezoneszone_id)
+     * API route.
+     *
+     * @param fulfillmentSetId - The fulfillment set's ID.
+     * @param serviceZoneId - The service zone's ID.
+     * @param query - Configure the fields to retrieve in the service zone.
+     * @param headers - Headers to pass in the request.
+     * @returns The service zone's details.
+     *
+     * @example
+     * To retrieve a fulfillment set's service zone by its ID:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentSet.retrieveServiceZone(
+     *   "fset_123",
+     *   "serzo_123"
+     * )
+     * .then(({ service_zone }) => {
+     *   console.log(service_zone)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentSet.retrieveServiceZone(
+     *   "fset_123",
+     *   "serzo_123",
+     *   {
+     *     fields: "id,*geo_zones"
+     *   }
+     * )
+     * .then(({ service_zone }) => {
+     *   console.log(service_zone)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieveServiceZone(fulfillmentSetId: string, serviceZoneId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminServiceZoneResponse>;
+    /**
+     * This method updates a service zone in a fulfillment set. It sends a request to the
+     * [Update Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_postfulfillmentsetsidservicezoneszone_id)
+     * API route.
+     *
+     * @param fulfillmentSetId - The fulfillment set's ID.
+     * @param serviceZoneId - The service zone's ID.
+     * @param body - The data to update in the service zone.
+     * @param query - Configure the fields to retrieve in the fulfillment set.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment set's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.updateServiceZone(
+     *   "fset_123",
+     *   "serzo_123",
+     *   {
+     *     name: "Europe Service Zone",
+     *   }
+     * )
+     * .then(({ fulfillment_set }) => {
+     *   console.log(fulfillment_set)
+     * })
+     */
     updateServiceZone(fulfillmentSetId: string, serviceZoneId: string, body: HttpTypes.AdminUpdateFulfillmentSetServiceZone, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetResponse>;
+    /**
+     * This method deletes a service zone in a fulfillment set. It sends a request to the
+     * [Remove Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_deletefulfillmentsetsidservicezoneszone_id)
+     * API route.
+     *
+     * @param fulfillmentSetId - The fulfullment set's ID.
+     * @param serviceZoneId - The service zone's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.deleteServiceZone(
+     *   "fset_123",
+     *   "serzo_123",
+     * )
+     * .then(({ deleted, parent: fulfillmentSet }) => {
+     *   console.log(deleted, fulfillmentSet)
+     * })
+     */
     deleteServiceZone(fulfillmentSetId: string, serviceZoneId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminServiceZoneDeleteResponse>;
 }
 //# sourceMappingURL=fulfillment-set.d.ts.map

package/dist/esm/admin/fulfillment-set.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-set.d.ts","sourceRoot":"","sources":["../../../src/admin/fulfillment-set.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,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oCAAoC,EACpD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,mBAAmB,CACvB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,oCAAoC,EACpD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,aAAa;CAU1B"}
+{"version":3,"file":"fulfillment-set.d.ts","sourceRoot":"","sources":["../../../src/admin/fulfillment-set.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,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oCAAoC,EACpD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,mBAAmB,CACvB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,SAAS,CAAC,oCAAoC,EACpD,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,aAAa;CAU1B"}

package/dist/esm/admin/fulfillment-set.js

@@ -14,6 +14,21 @@ export class FulfillmentSet {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method deletes a fulfillment set. It sends a request to the
+     * [Delete Fulfillment Set](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_deletefulfillmentsetsid)
+     * API route.
+     *
+     * @param id - The fulfillment set's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.delete("fset_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillment-sets/${id}`, {
@@ -22,6 +37,29 @@ export class FulfillmentSet {
             });
         });
     }
+    /**
+     * This method adds a service zone to a fulfillment set. It uses the
+     * [Add Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones)
+     * API route.
+     *
+     * @param id - The fulfillment set's ID.
+     * @param body - The service zone's details.
+     * @param query - Configure the fields to retrieve in the fulfillment set.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment set's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.createServiceZone("fset_123", {
+     *   name: "Europe Service Zone",
+     *   geo_zones: [{
+     *     type: "country",
+     *     country_code: "us"
+     *   }]
+     * })
+     * .then(({ fulfillment_set }) => {
+     *   console.log(fulfillment_set)
+     * })
+     */
     createServiceZone(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillment-sets/${id}/service-zones`, {
@@ -32,6 +70,47 @@ export class FulfillmentSet {
             });
         });
     }
+    /**
+     * This method retrieves a fulfillment set's service zone's details. It sends a request to the
+     * [Get Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_getfulfillmentsetsidservicezoneszone_id)
+     * API route.
+     *
+     * @param fulfillmentSetId - The fulfillment set's ID.
+     * @param serviceZoneId - The service zone's ID.
+     * @param query - Configure the fields to retrieve in the service zone.
+     * @param headers - Headers to pass in the request.
+     * @returns The service zone's details.
+     *
+     * @example
+     * To retrieve a fulfillment set's service zone by its ID:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentSet.retrieveServiceZone(
+     *   "fset_123",
+     *   "serzo_123"
+     * )
+     * .then(({ service_zone }) => {
+     *   console.log(service_zone)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.fulfillmentSet.retrieveServiceZone(
+     *   "fset_123",
+     *   "serzo_123",
+     *   {
+     *     fields: "id,*geo_zones"
+     *   }
+     * )
+     * .then(({ service_zone }) => {
+     *   console.log(service_zone)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieveServiceZone(fulfillmentSetId, serviceZoneId, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillment-sets/${fulfillmentSetId}/service-zones/${serviceZoneId}`, {
@@ -41,6 +120,30 @@ export class FulfillmentSet {
             });
         });
     }
+    /**
+     * This method updates a service zone in a fulfillment set. It sends a request to the
+     * [Update Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_postfulfillmentsetsidservicezoneszone_id)
+     * API route.
+     *
+     * @param fulfillmentSetId - The fulfillment set's ID.
+     * @param serviceZoneId - The service zone's ID.
+     * @param body - The data to update in the service zone.
+     * @param query - Configure the fields to retrieve in the fulfillment set.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment set's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.updateServiceZone(
+     *   "fset_123",
+     *   "serzo_123",
+     *   {
+     *     name: "Europe Service Zone",
+     *   }
+     * )
+     * .then(({ fulfillment_set }) => {
+     *   console.log(fulfillment_set)
+     * })
+     */
     updateServiceZone(fulfillmentSetId, serviceZoneId, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillment-sets/${fulfillmentSetId}/service-zones/${serviceZoneId}`, {
@@ -51,6 +154,25 @@ export class FulfillmentSet {
             });
         });
     }
+    /**
+     * This method deletes a service zone in a fulfillment set. It sends a request to the
+     * [Remove Service Zone](https://docs.medusajs.com/v2/api/admin#fulfillment-sets_deletefulfillmentsetsidservicezoneszone_id)
+     * API route.
+     *
+     * @param fulfillmentSetId - The fulfullment set's ID.
+     * @param serviceZoneId - The service zone's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.fulfillmentSet.deleteServiceZone(
+     *   "fset_123",
+     *   "serzo_123",
+     * )
+     * .then(({ deleted, parent: fulfillmentSet }) => {
+     *   console.log(deleted, fulfillmentSet)
+     * })
+     */
     deleteServiceZone(fulfillmentSetId, serviceZoneId, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillment-sets/${fulfillmentSetId}/service-zones/${serviceZoneId}`, {

package/dist/esm/admin/fulfillment-set.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-set.js","sourceRoot":"","sources":["../../../src/admin/fulfillment-set.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,IAAoD,EACpD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,gBAAgB,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,mBAAmB,CACvB,gBAAwB,EACxB,aAAqB,EACrB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,gBAAgB,kBAAkB,aAAa,EAAE,EAC5E;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,gBAAwB,EACxB,aAAqB,EACrB,IAAoD,EACpD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,gBAAgB,kBAAkB,aAAa,EAAE,EAC5E;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,gBAAwB,EACxB,aAAqB,EACrB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,gBAAgB,kBAAkB,aAAa,EAAE,EAC5E;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"fulfillment-set.js","sourceRoot":"","sources":["../../../src/admin/fulfillment-set.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAU,EACV,IAAoD,EACpD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,gBAAgB,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,mBAAmB,CACvB,gBAAwB,EACxB,aAAqB,EACrB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,gBAAgB,kBAAkB,aAAa,EAAE,EAC5E;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,gBAAwB,EACxB,aAAqB,EACrB,IAAoD,EACpD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,gBAAgB,kBAAkB,aAAa,EAAE,EAC5E;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,iBAAiB,CACrB,gBAAwB,EACxB,aAAqB,EACrB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,gBAAgB,kBAAkB,aAAa,EAAE,EAC5E;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

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

@@ -10,8 +10,82 @@ export declare class Fulfillment {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a fulfillment. It sends a request to the
+     * [Create Fulfillment](https://docs.medusajs.com/v2/api/admin#fulfillments_postfulfillments)
+     * API route.
+     *
+     * @param body - The fulfillment's details.
+     * @param query - Configure the fields to retrieve in the fulfillment.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment's details.
+     *
+     * @example
+     * sdk.admin.fulfillment.create({
+     *   location_id: "sloc_123",
+     *   provider_id: "my_fulfillment",
+     *   delivery_address: {
+     *     country_code: "us"
+     *   },
+     *   items: [
+     *     {
+     *       title: "Shirt",
+     *       sku: "SHIRT",
+     *       quantity: 1,
+     *       barcode: "123"
+     *     }
+     *   ],
+     *   labels: [],
+     *   order: {},
+     *   order_id: "order_123"
+     * })
+     * .then(({ fulfillment }) => {
+     *   console.log(fulfillment)
+     * })
+     */
     create(body: HttpTypes.AdminCreateFulfillment, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
+    /**
+     * This method cancels a fulfillment. It sends a request to the
+     * [Cancel Fulfillment](https://docs.medusajs.com/v2/api/admin#fulfillments_postfulfillmentsidcancel)
+     * API route.
+     *
+     * @param id - The fulfillment's ID.
+     * @param query - Configure the fields to retrieve in the fulfillment.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment's details.
+     *
+     * @example
+     * sdk.admin.fulfillment.cancel("ful_123")
+     * .then(({ fulfillment }) => {
+     *   console.log(fulfillment)
+     * })
+     */
     cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
+    /**
+     * This method creates a shipment for a fulfillment. It sends a request to the
+     * [Create Shipment](https://docs.medusajs.com/v2/api/admin#fulfillments_postfulfillmentsidshipment)
+     * API route.
+     *
+     * @param id - The fulfillment's ID.
+     * @param body - The shipment's details.
+     * @param query - Configure the fields to retrieve in the fulfillment.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment's details.
+     *
+     * @example
+     * sdk.admin.fulfillment.createShipment("ful_123", {
+     *   labels: [
+     *     {
+     *       tracking_number: "123",
+     *       tracking_url: "example.com",
+     *       label_url: "example.com"
+     *     }
+     *   ]
+     * })
+     * .then(({ fulfillment }) => {
+     *   console.log(fulfillment)
+     * })
+     */
     createShipment(id: string, body: HttpTypes.AdminCreateFulfillmentShipment, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
 }
 //# sourceMappingURL=fulfillment.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment.d.ts","sourceRoot":"","sources":["../../../src/admin/fulfillment.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,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAY1B"}
+{"version":3,"file":"fulfillment.d.ts","sourceRoot":"","sources":["../../../src/admin/fulfillment.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,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAY1B"}

package/dist/esm/admin/fulfillment.js

@@ -14,6 +14,39 @@ export class Fulfillment {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a fulfillment. It sends a request to the
+     * [Create Fulfillment](https://docs.medusajs.com/v2/api/admin#fulfillments_postfulfillments)
+     * API route.
+     *
+     * @param body - The fulfillment's details.
+     * @param query - Configure the fields to retrieve in the fulfillment.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment's details.
+     *
+     * @example
+     * sdk.admin.fulfillment.create({
+     *   location_id: "sloc_123",
+     *   provider_id: "my_fulfillment",
+     *   delivery_address: {
+     *     country_code: "us"
+     *   },
+     *   items: [
+     *     {
+     *       title: "Shirt",
+     *       sku: "SHIRT",
+     *       quantity: 1,
+     *       barcode: "123"
+     *     }
+     *   ],
+     *   labels: [],
+     *   order: {},
+     *   order_id: "order_123"
+     * })
+     * .then(({ fulfillment }) => {
+     *   console.log(fulfillment)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillments`, {
@@ -24,15 +57,57 @@ export class Fulfillment {
             });
         });
     }
+    /**
+     * This method cancels a fulfillment. It sends a request to the
+     * [Cancel Fulfillment](https://docs.medusajs.com/v2/api/admin#fulfillments_postfulfillmentsidcancel)
+     * API route.
+     *
+     * @param id - The fulfillment's ID.
+     * @param query - Configure the fields to retrieve in the fulfillment.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment's details.
+     *
+     * @example
+     * sdk.admin.fulfillment.cancel("ful_123")
+     * .then(({ fulfillment }) => {
+     *   console.log(fulfillment)
+     * })
+     */
     cancel(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillments/${id}`, {
                 method: "POST",
                 body: {},
                 headers,
+                query
             });
         });
     }
+    /**
+     * This method creates a shipment for a fulfillment. It sends a request to the
+     * [Create Shipment](https://docs.medusajs.com/v2/api/admin#fulfillments_postfulfillmentsidshipment)
+     * API route.
+     *
+     * @param id - The fulfillment's ID.
+     * @param body - The shipment's details.
+     * @param query - Configure the fields to retrieve in the fulfillment.
+     * @param headers - Headers to pass in the request.
+     * @returns The fulfillment's details.
+     *
+     * @example
+     * sdk.admin.fulfillment.createShipment("ful_123", {
+     *   labels: [
+     *     {
+     *       tracking_number: "123",
+     *       tracking_url: "example.com",
+     *       label_url: "example.com"
+     *     }
+     *   ]
+     * })
+     * .then(({ fulfillment }) => {
+     *   console.log(fulfillment)
+     * })
+     */
     createShipment(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/fulfillments/${id}/shipment`, {

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment.js","sourceRoot":"","sources":["../../../src/admin/fulfillment.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,WAAW;IAKtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAE;gBACR,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAA8C,EAC9C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,WAAW,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"fulfillment.js","sourceRoot":"","sources":["../../../src/admin/fulfillment.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,WAAW;IAKtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,MAAM,CACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,EAAE,EAC3B;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAE;gBACR,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,cAAc,CAClB,EAAU,EACV,IAA8C,EAC9C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EAAE,WAAW,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}