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

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

@@ -2,22 +2,74 @@ import { FilterableFulfillmentSetProps, FulfillmentSetDTO } from "./fulfillment-
 import { FilterableGeoZoneProps, GeoZoneDTO } from "./geo-zone";
 import { ShippingOptionDTO } from "./shipping-option";
 import { BaseFilterable, OperatorMap } from "../../dal";
+/**
+ * The service zone details.
+ */
 export interface ServiceZoneDTO {
+    /**
+     * The ID of the service zone.
+     */
     id: string;
+    /**
+     * The name of the service zone.
+     */
     name: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The fulfillment sets assoiated with the service zone.
+     */
     fulfillment_sets: FulfillmentSetDTO[];
+    /**
+     * The geo zones assoiated with the service zone.
+     */
     geo_zones: GeoZoneDTO[];
+    /**
+     * The shipping options assoiated with the service zone.
+     */
     shipping_options: ShippingOptionDTO[];
+    /**
+     * The creation date of the service zone.
+     */
     created_at: Date;
+    /**
+     * The update date of the service zone.
+     */
     updated_at: Date;
+    /**
+     * The deletion date of the service zone.
+     */
     deleted_at: Date | null;
 }
+/**
+ * The filters to apply on the retrieved service zones.
+ */
 export interface FilterableServiceZoneProps extends BaseFilterable<FilterableServiceZoneProps> {
+    /**
+     * The IDs to filter the service zones by.
+     */
     id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the service zones by their name.
+     */
     name?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * The filters to apply on the associated geo zones.
+     */
     geo_zones?: FilterableGeoZoneProps;
+    /**
+     * The filters to apply on the associated fulfillment sets.
+     */
     fulfillment_set?: FilterableFulfillmentSetProps;
+    /**
+     * @ignore
+     *
+     * @privateRemarks
+     * Added the `@\ignore` because of the `TODO`. Once implemented, the
+     * `@\ignore` (and this comment) should be removed.
+     */
     shipping_options?: any;
 }
 //# sourceMappingURL=service-zone.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IACrC,SAAS,EAAE,UAAU,EAAE,CAAA;IACvB,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IACrC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzD,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAClC,eAAe,CAAC,EAAE,6BAA6B,CAAA;IAC/C,gBAAgB,CAAC,EAAE,GAAG,CAAA;CACvB"}
+{"version":3,"file":"service-zone.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/service-zone.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IAErC;;OAEG;IACH,SAAS,EAAE,UAAU,EAAE,CAAA;IAEvB;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IAErC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAElC;;OAEG;IACH,eAAe,CAAC,EAAE,6BAA6B,CAAA;IAE/C;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,GAAG,CAAA;CACvB"}

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

@@ -1,22 +1,73 @@
 import { ShippingOptionDTO } from "./shipping-option";
 import { BaseFilterable, OperatorMap } from "../../dal";
+/**
+ * The shipping option rule details.
+ */
 export interface ShippingOptionRuleDTO {
+    /**
+     * The ID of the shipping option rule.
+     */
     id: string;
+    /**
+     * The attribute of the shipping option rule.
+     */
     attribute: string;
+    /**
+     * The operator of the shipping option rule.
+     *
+     * @example
+     * in
+     */
     operator: string;
+    /**
+     * The values of the shipping option rule.
+     */
     value: {
+        /**
+         * The values of the shipping option rule.
+         */
         value: string | string[];
     } | null;
+    /**
+     * The associated shipping option's ID.
+     */
     shipping_option_id: string;
+    /**
+     * The associated shipping option.
+     */
     shipping_option: ShippingOptionDTO;
+    /**
+     * The creation date of the shipping option rule.
+     */
     created_at: Date;
+    /**
+     * The update date of the shipping option rule.
+     */
     updated_at: Date;
+    /**
+     * The deletion date of the shipping option rule.
+     */
     deleted_at: Date | null;
 }
+/**
+ * The filters to apply on the retrieved shipping option rules.
+ */
 export interface FilterableShippingOptionRuleProps extends BaseFilterable<FilterableShippingOptionRuleProps> {
+    /**
+     * The IDs to filter the shipping option rules by.
+     */
     id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping option rules by their attribute.
+     */
     attribute?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping option rules by their operator.
+     */
     operator?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping option rules by their values.
+     */
     value?: string | string[] | OperatorMap<string | string[]>;
 }
 //# sourceMappingURL=shipping-option-rule.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,GAAG,IAAI,CAAA;IAC1C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,iBAAiB,CAAA;IAClC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC9D,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC7D,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC3D"}
+{"version":3,"file":"shipping-option-rule.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KACzB,GAAG,IAAI,CAAA;IAER;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,eAAe,EAAE,iBAAiB,CAAA;IAElC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAE7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC3D"}

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

@@ -1,20 +1,65 @@
 import { ShippingOptionDTO } from "./shipping-option";
 import { BaseFilterable, OperatorMap } from "../../dal";
+/**
+ * The shipping option type details.
+ */
 export interface ShippingOptionTypeDTO {
+    /**
+     * The ID of the shipping option type.
+     */
     id: string;
+    /**
+     * 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 associated shipping option.
+     */
     shipping_option: ShippingOptionDTO;
+    /**
+     * The creation date of the shipping option type.
+     */
     created_at: Date;
+    /**
+     * The update date of the shipping option type.
+     */
     updated_at: Date;
+    /**
+     * The deletion date of the shipping option type.
+     */
     deleted_at: Date | null;
 }
+/**
+ * The filters to apply on the retrieved shipping option types.
+ */
 export interface FilterableShippingOptionTypeProps extends BaseFilterable<FilterableShippingOptionTypeProps> {
+    /**
+     * The IDs to filter the shipping option types by.
+     */
     id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping option types by their label.
+     */
     label?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping option types by their description.
+     */
     description?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping option types by their code.
+     */
     code?: string | string[] | OperatorMap<string | string[]>;
 }
 //# sourceMappingURL=shipping-option-type.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipping-option-type.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,iBAAiB,CAAA;IAClC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC1D,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAChE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC1D"}
+{"version":3,"file":"shipping-option-type.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;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;IAE1B;;OAEG;IACH,eAAe,EAAE,iBAAiB,CAAA;IAElC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAE1D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEhE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;CAC1D"}

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

@@ -5,50 +5,167 @@ import { FilterableServiceZoneProps, ServiceZoneDTO } from "./service-zone";
 import { FilterableShippingOptionRuleProps, ShippingOptionRuleDTO } from "./shipping-option-rule";
 import { FilterableShippingOptionTypeProps, ShippingOptionTypeDTO } from "./shipping-option-type";
 import { ShippingProfileDTO } from "./shipping-profile";
+/**
+ * The shipping option's price type.
+ *
+ * - Use `calculated` if the shipping option's price amount is calculated by the fulfillment provider.
+ * - Use `flat_rate` if the shipping option's price is always the same amount.
+ *
+ */
 export type ShippingOptionPriceType = "calculated" | "flat";
+/**
+ * The shipping option details.
+ */
 export interface ShippingOptionDTO {
+    /**
+     * 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 fulfillment provider's ID.
+     */
     provider_id: string;
+    /**
+     * The associated shipping option type's ID.
+     */
     shipping_option_type_id: string | null;
+    /**
+     * The data necessary for the associated fulfillment provider to process the shipping option
+     * and, later, its associated fulfillments.
+     */
     data: Record<string, unknown> | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The associated service zone.
+     */
     service_zone: ServiceZoneDTO;
+    /**
+     * The associated shipping profile.
+     */
     shipping_profile: ShippingProfileDTO;
+    /**
+     * The associated fulfillment provider.
+     */
     fulfillment_provider: FulfillmentProviderDTO;
+    /**
+     * The associated shipping option type.
+     */
     type: ShippingOptionTypeDTO;
+    /**
+     * The rules associated with the shipping option.
+     */
     rules: ShippingOptionRuleDTO[];
+    /**
+     * The fulfillments associated with the shipping option.
+     */
     fulfillments: FulfillmentDTO[];
+    /**
+     * The creation date of the shipping option.
+     */
     created_at: Date;
+    /**
+     * The update date of the shipping option.
+     */
     updated_at: Date;
+    /**
+     * The deletion date of the shipping option.
+     */
     deleted_at: Date | null;
 }
+/**
+ * The filters to apply on the retrieved shipping options.
+ */
 export interface FilterableShippingOptionProps extends BaseFilterable<FilterableShippingOptionProps> {
+    /**
+     * The IDs to filter the shipping options by.
+     */
     id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping options by their name.
+     */
     name?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping options by the ID of their associated shipping profile.
+     */
     shipping_profile_id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping options by their price type.
+     */
     price_type?: ShippingOptionPriceType | ShippingOptionPriceType[] | OperatorMap<ShippingOptionPriceType | ShippingOptionPriceType[]>;
+    /**
+     * The filters to apply on the retrieved service zones.
+     */
     service_zone?: FilterableServiceZoneProps;
+    /**
+     * The filters to apply on the retrieved shipping option types.
+     */
     shipping_option_type?: FilterableShippingOptionTypeProps;
+    /**
+     * The filters to apply on the retrieved shipping option rules.
+     */
     rules?: FilterableShippingOptionRuleProps;
 }
+/**
+ * A context's details used to filter the shipping option.
+ */
 export interface FilterableShippingOptionForContextProps extends FilterableShippingOptionProps {
+    /**
+     * The fulfillment set's ID used in the context.
+     */
     fulfillment_set_id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * The fulfillment set's type used in the context.
+     */
     fulfillment_set_type?: string | string[] | OperatorMap<string | string[]>;
     /**
+     * The address used in the context. It filters the shipping options based on
+     * the geo zones of their associated service zone.
+     *
+     * @privateRemarks
      * The address is a shortcut to filter through geo_zones
      * and build opinionated validation and filtering around the geo_zones.
      * For custom filtering you can go through the service_zone.geo_zones directly.
      */
     address?: {
+        /**
+         * The ISO 2 character country code.
+         */
         country_code?: string;
+        /**
+         * The province code.
+         */
         province_code?: string;
+        /**
+         * The city.
+         */
         city?: string;
+        /**
+         * The postal expression
+         */
         postal_expression?: string;
     };
+    /**
+     * The shipping option's context to filter directly.
+     */
     context?: Record<string, any>;
 }
 //# sourceMappingURL=shipping-option.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC3E,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD,MAAM,MAAM,uBAAuB,GAAG,YAAY,GAAG,MAAM,CAAA;AAE3D,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,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,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,YAAY,EAAE,cAAc,CAAA;IAC5B,gBAAgB,EAAE,kBAAkB,CAAA;IACpC,oBAAoB,EAAE,sBAAsB,CAAA;IAC5C,IAAI,EAAE,qBAAqB,CAAA;IAC3B,KAAK,EAAE,qBAAqB,EAAE,CAAA;IAC9B,YAAY,EAAE,cAAc,EAAE,CAAA;IAC9B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IACrD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzD,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACxE,UAAU,CAAC,EACP,uBAAuB,GACvB,uBAAuB,EAAE,GACzB,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,EAAE,CAAC,CAAA;IACpE,YAAY,CAAC,EAAE,0BAA0B,CAAA;IACzC,oBAAoB,CAAC,EAAE,iCAAiC,CAAA;IACxD,KAAK,CAAC,EAAE,iCAAiC,CAAA;CAC1C;AAED,MAAM,WAAW,uCACf,SAAQ,6BAA6B;IACrC,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvE,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzE;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B"}
+{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC3E,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,YAAY,GAAG,MAAM,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;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,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc,CAAA;IAE5B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAA;IAEpC;;OAEG;IACH,oBAAoB,EAAE,sBAAsB,CAAA;IAE5C;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAA;IAE3B;;OAEG;IACH,KAAK,EAAE,qBAAqB,EAAE,CAAA;IAE9B;;OAEG;IACH,YAAY,EAAE,cAAc,EAAE,CAAA;IAE9B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IACrD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAExE;;OAEG;IACH,UAAU,CAAC,EACP,uBAAuB,GACvB,uBAAuB,EAAE,GACzB,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,EAAE,CAAC,CAAA;IAEpE;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,CAAA;IAEzC;;OAEG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAA;IAExD;;OAEG;IACH,KAAK,CAAC,EAAE,iCAAiC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,uCACf,SAAQ,6BAA6B;IACrC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvE;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzE;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAA;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAC3B,CAAA;IAED;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B"}

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

@@ -1,19 +1,61 @@
 import { FilterableShippingOptionProps, ShippingOptionDTO } from "./shipping-option";
 import { BaseFilterable, OperatorMap } from "../../dal";
+/**
+ * The shipping profile details.
+ */
 export interface ShippingProfileDTO {
+    /**
+     * The ID of the shipping profile.
+     */
     id: string;
+    /**
+     * 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> | null;
+    /**
+     * The shipping options associated with the shipping profile.
+     */
     shipping_options: ShippingOptionDTO[];
+    /**
+     * The creation date of the shipping profile.
+     */
     created_at: Date;
+    /**
+     * The update date of the shipping profile.
+     */
     updated_at: Date;
+    /**
+     * The deletion date of the shipping profile.
+     */
     deleted_at: Date | null;
 }
+/**
+ * The filters to apply on the retrieved shipping profiles.
+ */
 export interface FilterableShippingProfileProps extends BaseFilterable<FilterableShippingProfileProps> {
+    /**
+     * The IDs to filter the shipping profiles by.
+     */
     id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping profiles by their name.
+     */
     name?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter the shipping profiles by their type.
+     */
     type?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * The filters to apply on the retrieved shipping options.
+     */
     shipping_options?: FilterableShippingOptionProps;
 }
 //# sourceMappingURL=shipping-profile.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-profile.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IACrC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,8BACf,SAAQ,cAAc,CAAC,8BAA8B,CAAC;IACtD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzD,gBAAgB,CAAC,EAAE,6BAA6B,CAAA;CACjD"}
+{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/shipping-profile.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IAErC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,8BACf,SAAQ,cAAc,CAAC,8BAA8B,CAAC;IACtD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAA;CACjD"}

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

@@ -1,15 +1,54 @@
+/**
+ * The fulfillment address to be created.
+ */
 export interface CreateFulfillmentAddressDTO {
+    /**
+     * The associated fulfillment's ID.
+     */
     fulfillment_id: string;
+    /**
+     * The company of the fulfillment address.
+     */
     company?: string | null;
+    /**
+     * The first name of the fulfillment address.
+     */
     first_name?: string | null;
+    /**
+     * The last name of the fulfillment address.
+     */
     last_name?: string | null;
+    /**
+     * The first line of the fulfillment address.
+     */
     address_1?: string | null;
+    /**
+     * The second line of the fulfillment address.
+     */
     address_2?: string | null;
+    /**
+     * The city of the fulfillment address.
+     */
     city?: string | null;
+    /**
+     * The ISO 2 character country code of the fulfillment address.
+     */
     country_code?: string | null;
+    /**
+     * The province of the fulfillment address.
+     */
     province?: string | null;
+    /**
+     * The postal code of the fulfillment address.
+     */
     postal_code?: string | null;
+    /**
+     * The phone of the fulfillment address.
+     */
     phone?: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
 }
 //# sourceMappingURL=fulfillment-address.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-address.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-address.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
+{"version":3,"file":"fulfillment-address.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-address.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}

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

@@ -1,10 +1,34 @@
+/**
+ * The fulfillment item to be created.
+ */
 export interface CreateFulfillmentItemDTO {
+    /**
+     * The associated fulfillment's ID.
+     */
     fulfillment_id: string;
+    /**
+     * The title of the fulfillment item.
+     */
     title: string;
+    /**
+     * The SKU of the fulfillment item.
+     */
     sku: string;
+    /**
+     * The quantity of the fulfillment item.
+     */
     quantity: number;
+    /**
+     * The barcode of the fulfillment item.
+     */
     barcode: string;
+    /**
+     * The associated line item's ID.
+     */
     line_item_id?: string | null;
+    /**
+     * The associated inventory item's ID.
+     */
     inventory_item_id?: string | null;
 }
 //# sourceMappingURL=fulfillment-item.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-item.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-item.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC"}
+{"version":3,"file":"fulfillment-item.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-item.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC"}

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

@@ -1,7 +1,22 @@
+/**
+ * The fulfillment label to be created.
+ */
 export interface CreateFulfillmentLabelDTO {
+    /**
+     * The tracking number of the fulfillment label.
+     */
     tracking_number: string;
+    /**
+     * The tracking URL of the fulfillment label.
+     */
     tracking_url: string;
+    /**
+     * The URL of the label.
+     */
     label_url: string;
+    /**
+     * The associated fulfillment's ID.
+     */
     fulfillment_id: string;
 }
 //# sourceMappingURL=fulfillment-label.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-label.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-label.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;CACvB"}
+{"version":3,"file":"fulfillment-label.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/fulfillment-label.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;CACvB"}

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

@@ -1,14 +1,44 @@
 import { CreateServiceZoneDTO } from "./service-zone";
+/**
+ * The fulfillment set to be created.
+ */
 export interface CreateFulfillmentSetDTO {
+    /**
+     * The name of the fulfillment set.
+     */
     name: string;
+    /**
+     * The type of the fulfillment set.
+     */
     type: string;
-    service_zones?: Omit<CreateServiceZoneDTO, 'fulfillment_set_id'>[];
+    /**
+     * The service zones associated with the fulfillment set.
+     */
+    service_zones?: Omit<CreateServiceZoneDTO, "fulfillment_set_id">[];
 }
+/**
+ * The attributes to update in the fulfillment set.
+ */
 export interface UpdateFulfillmentSetDTO {
+    /**
+     * The ID of the fulfillment set.
+     */
     id: string;
+    /**
+     * The name of the fulfillment set.
+     */
     name?: string;
+    /**
+     * The type of the fulfillment set.
+     */
     type?: string;
-    service_zones?: (Omit<CreateServiceZoneDTO, 'fulfillment_set_id'> | {
+    /**
+     * The service zones associated with the fulfillment set.
+     */
+    service_zones?: (Omit<CreateServiceZoneDTO, "fulfillment_set_id"> | {
+        /**
+         * The ID of the service zone.
+         */
         id: string;
     })[];
 }