@medusajs/types 1.12.0-snapshot-20240406075900 → 1.12.0-snapshot-20240408084642

package/dist/fulfillment/mutations/fulfillment-set.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-set.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,EAAE,CAAA;CACnE;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;CACtF"}
+{"version":3,"file":"fulfillment-set.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,EAAE,CAAA;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,CACZ,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAChD;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CACJ,EAAE,CAAA;CACJ"}

package/dist/fulfillment/mutations/fulfillment.d.ts

@@ -1,29 +1,95 @@
 import { CreateFulfillmentAddressDTO } from "./fulfillment-address";
 import { CreateFulfillmentItemDTO } from "./fulfillment-item";
 import { CreateFulfillmentLabelDTO } from "./fulfillment-label";
+/**
+ * The fulfillment order to be created.
+ */
 export interface CreateFulfillmentOrderDTO {
 }
+/**
+ * The fulfillment to be created.
+ */
 export interface CreateFulfillmentDTO {
+    /**
+     * The associated location's ID.
+     */
     location_id: string;
+    /**
+     * The date the fulfillment was packed.
+     */
     packed_at?: Date | null;
+    /**
+     * The date the fulfillment was shipped.
+     */
     shipped_at?: Date | null;
+    /**
+     * The date the fulfillment was delivered.
+     */
     delivered_at?: Date | null;
+    /**
+     * The date the fulfillment was canceled.
+     */
     canceled_at?: Date | null;
+    /**
+     * The data necessary for the associated fulfillment provider to process the fulfillment.
+     */
     data?: Record<string, unknown> | null;
+    /**
+     * The associated fulfillment provider's ID.
+     */
     provider_id: string;
+    /**
+     * The associated shipping option's ID.
+     */
     shipping_option_id?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The address associated with the fulfillment. It's used for delivery.
+     */
     delivery_address: Omit<CreateFulfillmentAddressDTO, "fulfillment_id">;
+    /**
+     * The items associated with the fulfillment.
+     */
     items: Omit<CreateFulfillmentItemDTO, "fulfillment_id">[];
+    /**
+     * The labels associated with the fulfillment.
+     */
     labels: Omit<CreateFulfillmentLabelDTO, "fulfillment_id">[];
+    /**
+     * The associated fulfillment order.
+     */
     order: CreateFulfillmentOrderDTO;
 }
+/**
+ * The attributes to update in the fulfillment.
+ */
 export interface UpdateFulfillmentDTO {
+    /**
+     * The associated location's ID.
+     */
     location_id?: string;
+    /**
+     * The date the fulfillment was packed.
+     */
     packed_at?: Date | null;
+    /**
+     * The date the fulfillment was shipped.
+     */
     shipped_at?: Date | null;
+    /**
+     * The date the fulfillment was delivered.
+     */
     delivered_at?: Date | null;
+    /**
+     * The data necessary for the associated fulfillment provider to process the fulfillment.
+     */
     data?: Record<string, unknown> | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
 }
 //# sourceMappingURL=fulfillment.d.ts.map

package/dist/fulfillment/mutations/fulfillment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAE/D,MAAM,WAAW,yBAAyB;CAAG;AAE7C,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAC1B,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,gBAAgB,EAAE,IAAI,CAAC,2BAA2B,EAAE,gBAAgB,CAAC,CAAA;IACrE,KAAK,EAAE,IAAI,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IACzD,MAAM,EAAE,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IAC3D,KAAK,EAAE,yBAAyB,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
+{"version":3,"file":"fulfillment.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AAE/D;;GAEG;AACH,MAAM,WAAW,yBAAyB;CAAG;AAE7C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,gBAAgB,EAAE,IAAI,CAAC,2BAA2B,EAAE,gBAAgB,CAAC,CAAA;IAErE;;OAEG;IACH,KAAK,EAAE,IAAI,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IAEzD;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EAAE,CAAA;IAE3D;;OAEG;IACH,KAAK,EAAE,yBAAyB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}

package/dist/fulfillment/mutations/geo-zone.d.ts

@@ -1,50 +1,173 @@
 import { GeoZoneType } from "../common";
+/**
+ * The geo zone to be created.
+ */
 interface CreateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     */
     type: GeoZoneType;
+    /**
+     * The associated service zone's ID.
+     */
     service_zone_id: string;
+    /**
+     * The ISO 2 character country code of the geo zone.
+     */
     country_code: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, any> | null;
 }
+/**
+ * The geo zone to be created of type `country`.
+ */
 export interface CreateCountryGeoZoneDTO extends CreateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"country"`
+     */
     type: "country";
 }
+/**
+ * The geo zone to be created of type `province`.
+ */
 export interface CreateProvinceGeoZoneDTO extends CreateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"province"`
+     */
     type: "province";
+    /**
+     * The province code of the geo zone.
+     */
     province_code: string;
 }
+/**
+ * The geo zone to be created of type `city`.
+ */
 export interface CreateCityGeoZoneDTO extends CreateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"city"`
+     */
     type: "city";
+    /**
+     * The province code of the geo zone.
+     */
     province_code: string;
+    /**
+     * The city of the geo zone.
+     */
     city: string;
 }
+/**
+ * The geo zone to be created of type `zip`.
+ */
 export interface CreateZipGeoZoneDTO extends CreateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"zip"`
+     */
     type: "zip";
+    /**
+     * The province code of the geo zone.
+     */
     province_code: string;
+    /**
+     * The city of the geo zone.
+     */
     city: string;
+    /**
+     * The postal expression of the geo zone.
+     */
     postal_expression: Record<string, any>;
 }
+/**
+ * @interface
+ *
+ * The geo zone to be created. The value of the `type` attributes allows for passing more attributes.
+ */
 export type CreateGeoZoneDTO = CreateCountryGeoZoneDTO | CreateProvinceGeoZoneDTO | CreateCityGeoZoneDTO | CreateZipGeoZoneDTO;
+/**
+ * The attributes to update in the geo zone.
+ */
 export interface UpdateGeoZoneBaseDTO extends Partial<CreateGeoZoneBaseDTO> {
+    /**
+     * The ID of the geo zone.
+     */
     id: string;
 }
+/**
+ * The attributes to update in the geo zone of type `country`.
+ */
 export interface UpdateCountryGeoZoneDTO extends UpdateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"country"`
+     */
     type: "country";
 }
+/**
+ * The attributes to update in the geo zone of type `province`.
+ */
 export interface UpdateProvinceGeoZoneDTO extends UpdateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"province"`
+     */
     type: "province";
+    /**
+     * The province code of the geo zone.
+     */
     province_code: string;
 }
+/**
+ * The attributes to update in the geo zone of type `city`.
+ */
 export interface UpdateCityGeoZoneDTO extends UpdateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"city"`
+     */
     type: "city";
+    /**
+     * The province code of the geo zone.
+     */
     province_code?: string;
+    /**
+     * The city of the geo zone.
+     */
     city?: string;
 }
+/**
+ * The attributes to update in the geo zone of type `zip`.
+ */
 export interface UpdateZipGeoZoneDTO extends UpdateGeoZoneBaseDTO {
+    /**
+     * The type of the geo zone.
+     * @defaultValue `"zip"`
+     */
     type: "zip";
+    /**
+     * The province code of the geo zone.
+     */
     province_code?: string;
+    /**
+     * The city of the geo zone.
+     */
     city?: string;
+    /**
+     * The postal expression of the geo zone.
+     */
     postal_expression?: Record<string, any>;
 }
+/**
+ * @interface
+ *
+ * The attributes to update in the geo zone. The value of the `type` attributes allows for passing more attributes.
+ */
 export type UpdateGeoZoneDTO = UpdateCountryGeoZoneDTO | UpdateProvinceGeoZoneDTO | UpdateCityGeoZoneDTO | UpdateZipGeoZoneDTO;
 export {};
 //# sourceMappingURL=geo-zone.d.ts.map

package/dist/fulfillment/mutations/geo-zone.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geo-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/geo-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,UAAU,oBAAoB;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,IAAI,EAAE,KAAK,CAAA;IACX,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA;AAEvB,MAAM,WAAW,oBAAqB,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IACzE,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,UAAU,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,IAAI,EAAE,KAAK,CAAA;IACX,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxC;AAED,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA"}
+{"version":3,"file":"geo-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/geo-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;GAEG;AACH,UAAU,oBAAoB;IAC5B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAA;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA;AAEvB;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IACzE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAA;IAEX;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACxC;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,CAAA"}

package/dist/fulfillment/mutations/service-zone.d.ts

@@ -1,14 +1,46 @@
 import { CreateCityGeoZoneDTO, CreateCountryGeoZoneDTO, CreateProvinceGeoZoneDTO, CreateZipGeoZoneDTO } from "./geo-zone";
+/**
+ * The service zone to be created.
+ */
 export interface CreateServiceZoneDTO {
+    /**
+     * The name of the service zone.
+     */
     name: string;
+    /**
+     * The associated fulfillment set's ID.
+     */
     fulfillment_set_id: string;
+    /**
+     * The geo zones associated with the service zone.
+     */
     geo_zones?: (Omit<CreateCountryGeoZoneDTO, "service_zone_id"> | Omit<CreateProvinceGeoZoneDTO, "service_zone_id"> | Omit<CreateCityGeoZoneDTO, "service_zone_id"> | Omit<CreateZipGeoZoneDTO, "service_zone_id">)[];
 }
+/**
+ * The attributes to update in the service zone.
+ */
 export interface UpdateServiceZoneDTO {
-    id: string;
+    /**
+     * The ID of the service zone.
+     */
+    id?: string;
+    /**
+     * The name of the service zone.
+     */
     name?: string;
+    /**
+     * The geo zones associated with the service zone.
+     */
     geo_zones?: (Omit<CreateCountryGeoZoneDTO, "service_zone_id"> | Omit<CreateProvinceGeoZoneDTO, "service_zone_id"> | Omit<CreateCityGeoZoneDTO, "service_zone_id"> | Omit<CreateZipGeoZoneDTO, "service_zone_id"> | {
+        /**
+         * The ID of the geo zone.
+         */
         id: string;
     })[];
 }
+/**
+ * A service zone to be created or updated.
+ */
+export interface UpsertServiceZoneDTO extends UpdateServiceZoneDTO {
+}
 //# sourceMappingURL=service-zone.d.ts.map

package/dist/fulfillment/mutations/service-zone.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAC/C,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,GAC5C;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CACjB,EAAE,CAAA;CACJ"}
+{"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,YAAY,CAAA;AAEnB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAC/C,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,CACR,IAAI,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,GAChD,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,GAC5C;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CACJ,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;CAAG"}

package/dist/fulfillment/mutations/shipping-option-rule.d.ts

@@ -1,11 +1,32 @@
 import { RuleOperatorType } from "../../common";
+/**
+ * The shipping option rule to be created.
+ */
 export interface CreateShippingOptionRuleDTO {
+    /**
+     * The attribute of the shipping option rule.
+     */
     attribute: string;
+    /**
+     * The operator of the shipping option rule.
+     */
     operator: RuleOperatorType;
+    /**
+     * The value(s) of the shipping option rule.
+     */
     value: string | string[];
+    /**
+     * The associated shipping option's ID.
+     */
     shipping_option_id: string;
 }
+/**
+ * The attributes to update in the shipping option rule.
+ */
 export interface UpdateShippingOptionRuleDTO extends Partial<CreateShippingOptionRuleDTO> {
+    /**
+     * The ID of the shipping option rule.
+     */
     id: string;
 }
 //# sourceMappingURL=shipping-option-rule.d.ts.map

package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,2BACf,SAAQ,OAAO,CAAC,2BAA2B,CAAC;IAC5C,EAAE,EAAE,MAAM,CAAA;CACX"}
+{"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAExB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,OAAO,CAAC,2BAA2B,CAAC;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX"}

package/dist/fulfillment/mutations/shipping-option-type.d.ts

@@ -1,10 +1,31 @@
+/**
+ * The shipping option type to be created.
+ */
 export interface CreateShippingOptionTypeDTO {
+    /**
+     * The label of the shipping option type.
+     */
     label: string;
+    /**
+     * The description of the shipping option type.
+     */
     description: string;
+    /**
+     * The code of the shipping option type.
+     */
     code: string;
+    /**
+     * The associated shipping option's ID.
+     */
     shipping_option_id: string;
 }
+/**
+ * The attributes to update in the shipping option type.
+ */
 export interface UpdateShippingOptionTypeDTO extends Partial<CreateShippingOptionTypeDTO> {
+    /**
+     * The ID of the shipping option type.
+     */
     id: string;
 }
 //# sourceMappingURL=shipping-option-type.d.ts.map

package/dist/fulfillment/mutations/shipping-option-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option-type.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option-type.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,2BACf,SAAQ,OAAO,CAAC,2BAA2B,CAAC;IAC5C,EAAE,EAAE,MAAM,CAAA;CACX"}
+{"version":3,"file":"shipping-option-type.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,OAAO,CAAC,2BAA2B,CAAC;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX"}

package/dist/fulfillment/mutations/shipping-option.d.ts

@@ -1,29 +1,99 @@
 import { CreateShippingOptionTypeDTO } from "./shipping-option-type";
 import { ShippingOptionPriceType } from "../common";
 import { CreateShippingOptionRuleDTO } from "./shipping-option-rule";
+/**
+ * The shipping option to be created.
+ */
 export interface CreateShippingOptionDTO {
+    /**
+     * The name of the shipping option.
+     */
     name: string;
+    /**
+     * The type of the shipping option's price.
+     */
     price_type: ShippingOptionPriceType;
+    /**
+     * The associated service zone's ID.
+     */
     service_zone_id: string;
+    /**
+     * The associated shipping profile's ID.
+     */
     shipping_profile_id: string;
+    /**
+     * The associated provider's ID.
+     */
     provider_id: string;
+    /**
+     * The shipping option type associated with the shipping option.
+     */
     type: Omit<CreateShippingOptionTypeDTO, "shipping_option_id">;
+    /**
+     * The data necessary for the associated fulfillment provider to process the shipping option
+     * and its associated fulfillments.
+     */
     data?: Record<string, unknown> | null;
+    /**
+     * The shipping option rules associated with the shipping option.
+     */
     rules?: Omit<CreateShippingOptionRuleDTO, "shipping_option_id">[];
 }
+/**
+ * The attributes to update in the shipping option.
+ */
 export interface UpdateShippingOptionDTO {
-    id: string;
+    /**
+     * The ID of the shipping option.
+     */
+    id?: string;
+    /**
+     * The name of the shipping option.
+     */
     name?: string;
+    /**
+     * The type of the shipping option's price.
+     */
     price_type?: ShippingOptionPriceType;
+    /**
+     * The associated service zone's ID.
+     */
     service_zone_id?: string;
+    /**
+     * The associated shipping profile's ID.
+     */
     shipping_profile_id?: string;
+    /**
+     * The associated provider's ID.
+     */
     provider_id?: string;
+    /**
+     * The shipping option type associated with the shipping option.
+     */
     type: Omit<CreateShippingOptionTypeDTO, "shipping_option_id"> | {
+        /**
+         * The ID of the shipping option type.
+         */
         id: string;
     };
+    /**
+     * The data necessary for the associated fulfillment provider to process the shipping option
+     * and its associated fulfillments.
+     */
     data?: Record<string, unknown> | null;
+    /**
+     * The shipping option rules associated with the shipping option.
+     */
     rules?: (Omit<CreateShippingOptionRuleDTO, "shipping_option_id"> | {
+        /**
+         * The ID of the shipping option rule.
+         */
         id: string;
     })[];
 }
+/**
+ * A shipping option to be created or updated.
+ */
+export interface UpsertShippingOptionDTO extends UpdateShippingOptionDTO {
+}
 //# sourceMappingURL=shipping-option.d.ts.map

package/dist/fulfillment/mutations/shipping-option.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AAEpE,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,uBAAuB,CAAA;IACnC,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,CAAA;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,KAAK,CAAC,EAAE,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,EAAE,CAAA;CAClE;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,KAAK,CAAC,EAAE,CACJ,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,GACvD;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CACjB,EAAE,CAAA;CACJ"}
+{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAA;IAEnC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,CAAA;IAE7D;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,EAAE,CAAA;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAA;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,EACA,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,GACvD;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAEL;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,CACJ,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,GACvD;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CACJ,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;CAAG"}

package/dist/fulfillment/mutations/shipping-profile.d.ts

@@ -1,8 +1,23 @@
+/**
+ * The shipping profile to be created.
+ */
 export interface CreateShippingProfileDTO {
+    /**
+     * The name of the shipping profile.
+     */
     name: string;
+    /**
+     * The type of the shipping profile.
+     */
     type?: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * The attributes to update in the shipping profile.
+ */
 export interface UpdateShippingProfileDTO extends Partial<CreateShippingProfileDTO> {
 }
 //# sourceMappingURL=shipping-profile.d.ts.map

package/dist/fulfillment/mutations/shipping-profile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-profile.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,wBACf,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAG"}
+{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-profile.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAG"}