@medusajs/medusa 1.3.3 → 1.3.6-next.0

package/dist/models/shipping-method.js

@@ -11,14 +11,14 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShippingMethod = void 0;
 var typeorm_1 = require("typeorm");
-var db_aware_column_1 = require("../utils/db-aware-column");
+var cart_1 = require("./cart");
 var claim_order_1 = require("./claim-order");
+var db_aware_column_1 = require("../utils/db-aware-column");
 var order_1 = require("./order");
-var cart_1 = require("./cart");
-var swap_1 = require("./swap");
 var return_1 = require("./return");
-var shipping_option_1 = require("./shipping-option");
 var shipping_method_tax_line_1 = require("./shipping-method-tax-line");
+var shipping_option_1 = require("./shipping-option");
+var swap_1 = require("./swap");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ShippingMethod = /** @class */ (function () {
     function ShippingMethod() {
@@ -123,37 +123,68 @@ exports.ShippingMethod = ShippingMethod;
  * title: "Shipping Method"
  * description: "Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment."
  * x-resourceId: shipping_method
+ * required:
+ *   - shipping_option_id
+ *   - price
  * properties:
  *   id:
- *     description: "The id of the Shipping Method. This value will be prefixed with `sm_`."
  *     type: string
+ *     description: The shipping method's ID
+ *     example: sm_01F0YET7DR2E7CYVSDHM593QG2
  *   shipping_option_id:
  *     description: "The id of the Shipping Option that the Shipping Method is built from."
  *     type: string
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
  *   shipping_option:
- *     description: "The Shipping Option that the Shipping Method is built from."
- *     anyOf:
- *       - $ref: "#/components/schemas/shipping_option"
+ *     description: Available if the relation `shipping_option` is expanded.
+ *     $ref: "#/components/schemas/shipping_option"
  *   order_id:
  *     description: "The id of the Order that the Shipping Method is used on."
  *     type: string
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ *   order:
+ *     description: An order object. Available if the relation `order` is expanded.
+ *     type: object
  *   return_id:
  *     description: "The id of the Return that the Shipping Method is used on."
  *     type: string
+ *     example: null
+ *   return_order:
+ *     description: A return object. Available if the relation `return_order` is expanded.
+ *     type: object
  *   swap_id:
  *     description: "The id of the Swap that the Shipping Method is used on."
  *     type: string
+ *     example: null
+ *   swap:
+ *     description: A swap object. Available if the relation `swap` is expanded.
+ *     type: object
  *   cart_id:
  *     description: "The id of the Cart that the Shipping Method is used on."
  *     type: string
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
  *   claim_order_id:
  *     description: "The id of the Claim that the Shipping Method is used on."
  *     type: string
+ *     example: null
+ *   claim_order:
+ *     description: A claim order object. Available if the relation `claim_order` is expanded.
+ *     type: object
+ *   tax_lines:
+ *     type: array
+ *     description: Available if the relation `tax_lines` is expanded.
+ *     items:
+ *       $ref: "#/components/schemas/tax_line"
  *   price:
  *     description: "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of."
  *     type: integer
+ *     example: 200
  *   data:
  *     description: "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id."
  *     type: object
+ *     example: {}
  */
 //# sourceMappingURL=shipping-method.js.map

package/dist/models/shipping-method.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-method.js","sourceRoot":"","sources":["../../src/models/shipping-method.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAWgB;AAChB,4DAAwD;AAExD,6CAA0C;AAC1C,iCAA+B;AAC/B,+BAA6B;AAC7B,+BAA6B;AAC7B,mCAAiC;AACjC,qDAAkD;AAClD,uEAAkE;AAClE,kEAA8D;AAO9D;IAAA;IAmEA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAhED;QADC,IAAA,uBAAa,GAAE;;8CACN;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;8DACiB;IAI1B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACtB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;iDAAA;IAIZ;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACE;IAI7B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,CAAC;QAC3B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;uDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;gDAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;gDAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACV;IAIjB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,eAAe,EAAnB,CAAmB,CAAC;QACpD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCACpB,eAAM;wDAAA;IAIpB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAChD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,gCAAc;2DAAA;IAK/B;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gDAAqB,EAArB,CAAqB,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,eAAe,EAAlB,CAAkB,EAAE;YAClE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;qDACgC;IAGlC;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;iDACX;IAGb;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;gDACJ;IAG7B;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAlEU,cAAc;QAL1B,IAAA,eAAK,EACJ,+IAAqI,CACtI;QACA,IAAA,eAAK,EAAC,gBAAc,CAAC;QACrB,IAAA,gBAAM,GAAE;OACI,cAAc,CAmE1B;IAAD,qBAAC;CAAA,AAnED,IAmEC;AAnEY,wCAAc;AAqE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG"}
+{"version":3,"file":"shipping-method.js","sourceRoot":"","sources":["../../src/models/shipping-method.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAWgB;AAEhB,+BAA6B;AAC7B,6CAA0C;AAC1C,4DAAwD;AACxD,iCAA+B;AAC/B,mCAAiC;AACjC,uEAAkE;AAClE,qDAAkD;AAClD,+BAA6B;AAC7B,kEAA8D;AAO9D;IAAA;IAmEA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAhED;QADC,IAAA,uBAAa,GAAE;;8CACN;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;8DACiB;IAI1B;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACX;IAIhB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,aAAK,EAAL,CAAK,CAAC;QACtB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;kCAC1B,aAAK;iDAAA;IAIZ;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACE;IAI7B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,wBAAU,EAAV,CAAU,CAAC;QAC3B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;kCAC1B,wBAAU;uDAAA;IAIvB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;gDAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACZ;IAIf;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,WAAI,EAAJ,CAAI,CAAC;QACrB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;kCAC1B,WAAI;gDAAA;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACV;IAIjB;QAFC,IAAA,kBAAQ,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,eAAe,EAAnB,CAAmB,CAAC;QACpD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCACpB,eAAM;wDAAA;IAIpB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAChD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,gCAAc;2DAAA;IAK/B;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,gDAAqB,EAArB,CAAqB,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,eAAe,EAAlB,CAAkB,EAAE;YAClE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;qDACgC;IAGlC;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;iDACX;IAGb;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;gDACJ;IAG7B;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAlEU,cAAc;QAL1B,IAAA,eAAK,EACJ,+IAAqI,CACtI;QACA,IAAA,eAAK,EAAC,gBAAc,CAAC;QACrB,IAAA,gBAAM,GAAE;OACI,cAAc,CAmE1B;IAAD,qBAAC;CAAA,AAnED,IAmEC;AAnEY,wCAAc;AAqE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG"}

package/dist/models/shipping-option-requirement.d.ts

@@ -17,20 +17,35 @@ export declare class ShippingOptionRequirement {
  * title: "Shipping Option Requirement"
  * description: "A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart."
  * x-resourceId: shipping_option_requirement
+ * required:
+ *   - shipping_option_id
+ *   - type
+ *   - amount
  * properties:
  *   id:
- *     description: "The id of the Shipping Option Requirement. This value will be prefixed with `sor_`."
  *     type: string
+ *     description: The shipping option requirement's ID
+ *     example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
  *   shipping_option_id:
- *     description: "The id of the Shipping Option that the Shipping Option Requirement belongs to."
+ *     description: "The id of the Shipping Option that the hipping option requirement belongs to"
  *     type: string
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
+ *   shipping_option:
+ *     description: Available if the relation `shipping_option` is expanded.
+ *     $ref: "#/components/schemas/shipping_option"
  *   type:
  *     description: "The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available."
  *     type: string
  *     enum:
  *       - min_subtotal
  *       - max_subtotal
+ *     example: min_subtotal
  *   amount:
  *     description: "The amount to compare the Cart subtotal to."
  *     type: integer
+ *     example: 100
+ *   deleted_at:
+ *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
+ *     format: date-time
  */

package/dist/models/shipping-option-requirement.js

@@ -68,21 +68,36 @@ exports.ShippingOptionRequirement = ShippingOptionRequirement;
  * title: "Shipping Option Requirement"
  * description: "A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart."
  * x-resourceId: shipping_option_requirement
+ * required:
+ *   - shipping_option_id
+ *   - type
+ *   - amount
  * properties:
  *   id:
- *     description: "The id of the Shipping Option Requirement. This value will be prefixed with `sor_`."
  *     type: string
+ *     description: The shipping option requirement's ID
+ *     example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
  *   shipping_option_id:
- *     description: "The id of the Shipping Option that the Shipping Option Requirement belongs to."
+ *     description: "The id of the Shipping Option that the hipping option requirement belongs to"
  *     type: string
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
+ *   shipping_option:
+ *     description: Available if the relation `shipping_option` is expanded.
+ *     $ref: "#/components/schemas/shipping_option"
  *   type:
  *     description: "The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available."
  *     type: string
  *     enum:
  *       - min_subtotal
  *       - max_subtotal
+ *     example: min_subtotal
  *   amount:
  *     description: "The amount to compare the Cart subtotal to."
  *     type: integer
+ *     example: 100
+ *   deleted_at:
+ *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
+ *     format: date-time
  */
 //# sourceMappingURL=shipping-option-requirement.js.map

package/dist/models/shipping-option-requirement.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option-requirement.js","sourceRoot":"","sources":["../../src/models/shipping-option-requirement.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCASgB;AAChB,4DAAuE;AAEvE,qDAAkD;AAClD,kEAA8D;AAE9D,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gDAA6B,CAAA;IAC7B,gDAA6B,CAAA;AAC/B,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AAGD;IAAA;IAyBA,CAAC;IAHS,gDAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAtBD;QADC,IAAA,uBAAa,GAAE;;yDACN;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;yEACiB;IAI1B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,CAAC;QAC/B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,gCAAc;sEAAA;IAG/B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;;2DAClC;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;6DACV;IAGd;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;iEAAA;IAGhB;QADC,IAAA,sBAAY,GAAE;;;;iEAGd;IAxBU,yBAAyB;QADrC,IAAA,gBAAM,GAAE;OACI,yBAAyB,CAyBrC;IAAD,gCAAC;CAAA,AAzBD,IAyBC;AAzBY,8DAAyB;AA2BtC;;;;;;;;;;;;;;;;;;;;;GAqBG"}
+{"version":3,"file":"shipping-option-requirement.js","sourceRoot":"","sources":["../../src/models/shipping-option-requirement.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCASgB;AAChB,4DAAuE;AAEvE,qDAAkD;AAClD,kEAA8D;AAE9D,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gDAA6B,CAAA;IAC7B,gDAA6B,CAAA;AAC/B,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AAGD;IAAA;IAyBA,CAAC;IAHS,gDAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAtBD;QADC,IAAA,uBAAa,GAAE;;yDACN;IAIV;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;yEACiB;IAI1B;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,CAAC;QAC/B,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;kCAC1B,gCAAc;sEAAA;IAG/B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;;2DAClC;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;6DACV;IAGd;QADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,IAAA,+BAAa,EAAC,aAAa,CAAC,EAAE,CAAC;kCAC7C,IAAI;iEAAA;IAGhB;QADC,IAAA,sBAAY,GAAE;;;;iEAGd;IAxBU,yBAAyB;QADrC,IAAA,gBAAM,GAAE;OACI,yBAAyB,CAyBrC;IAAD,gCAAC;CAAA,AAzBD,IAyBC;AAzBY,8DAAyB;AA2BtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG"}

package/dist/models/shipping-option.d.ts

@@ -1,7 +1,7 @@
-import { ShippingProfile } from "./shipping-profile";
-import { Region } from "./region";
 import { FulfillmentProvider } from "./fulfillment-provider";
+import { Region } from "./region";
 import { ShippingOptionRequirement } from "./shipping-option-requirement";
+import { ShippingProfile } from "./shipping-profile";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
 export declare enum ShippingOptionPriceType {
     FLAT_RATE = "flat_rate",
@@ -29,59 +29,80 @@ export declare class ShippingOption extends SoftDeletableEntity {
  * title: "Shipping Option"
  * description: "Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information."
  * x-resourceId: shipping_option
+ * required:
+ *   - name
+ *   - region_id
+ *   - profile_id
+ *   - provider_id
+ *   - price_type
  * properties:
  *   id:
- *     description: "The id of the Shipping Option. This value will be prefixed with `so_`."
  *     type: string
+ *     description: The shipping option's ID
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
  *   name:
  *     description: "The name given to the Shipping Option - this may be displayed to the Customer."
  *     type: string
+ *     example: PostFake Standard
  *   region_id:
- *     description: "The id of the Region that the Shipping Option belongs to."
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     description: "The id of the Region that the Shipping Option belongs to."
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  *   profile_id:
- *     description: "The id of the Shipping Profile that the Shipping Option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
+ *     description: "The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
  *     type: string
+ *     example: sp_01G1G5V239ENSZ5MV4JAR737BM
+ *   profile:
+ *     description: Available if the relation `profile` is expanded.
+ *     $ref: "#/components/schemas/shipping_profile"
  *   provider_id:
  *     description: "The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option."
  *     type: string
+ *     example: manual
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/fulfillment_provider"
  *   price_type:
  *     description: "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations."
  *     type: string
  *     enum:
  *       - flat_rate
  *       - calculated
+ *     example: flat_rate
  *   amount:
  *     description: "The amount to charge for shipping when the Shipping Option price type is `flat_rate`."
  *     type: integer
+ *     example: 200
  *   is_return:
  *     description: "Flag to indicate if the Shipping Option can be used for Return shipments."
  *     type: boolean
+ *     default: false
  *   requirements:
- *     description: "The requirements that must be satisfied for the Shipping Option to be available for a Cart."
+ *     description: The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/shipping_option_requirement"
  *   data:
  *     description: "The data needed for the Fulfillment Provider to identify the Shipping Option."
  *     type: object
+ *     example: {}
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/shipping-option.js

@@ -27,10 +27,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShippingOption = exports.ShippingOptionPriceType = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var shipping_profile_1 = require("./shipping-profile");
-var region_1 = require("./region");
 var fulfillment_provider_1 = require("./fulfillment-provider");
+var region_1 = require("./region");
 var shipping_option_requirement_1 = require("./shipping-option-requirement");
+var shipping_profile_1 = require("./shipping-profile");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ShippingOptionPriceType;
@@ -128,60 +128,81 @@ exports.ShippingOption = ShippingOption;
  * title: "Shipping Option"
  * description: "Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information."
  * x-resourceId: shipping_option
+ * required:
+ *   - name
+ *   - region_id
+ *   - profile_id
+ *   - provider_id
+ *   - price_type
  * properties:
  *   id:
- *     description: "The id of the Shipping Option. This value will be prefixed with `so_`."
  *     type: string
+ *     description: The shipping option's ID
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
  *   name:
  *     description: "The name given to the Shipping Option - this may be displayed to the Customer."
  *     type: string
+ *     example: PostFake Standard
  *   region_id:
- *     description: "The id of the Region that the Shipping Option belongs to."
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     description: "The id of the Region that the Shipping Option belongs to."
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
  *   profile_id:
- *     description: "The id of the Shipping Profile that the Shipping Option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
+ *     description: "The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products."
  *     type: string
+ *     example: sp_01G1G5V239ENSZ5MV4JAR737BM
+ *   profile:
+ *     description: Available if the relation `profile` is expanded.
+ *     $ref: "#/components/schemas/shipping_profile"
  *   provider_id:
  *     description: "The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option."
  *     type: string
+ *     example: manual
+ *   provider:
+ *     description: Available if the relation `provider` is expanded.
+ *     $ref: "#/components/schemas/fulfillment_provider"
  *   price_type:
  *     description: "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations."
  *     type: string
  *     enum:
  *       - flat_rate
  *       - calculated
+ *     example: flat_rate
  *   amount:
  *     description: "The amount to charge for shipping when the Shipping Option price type is `flat_rate`."
  *     type: integer
+ *     example: 200
  *   is_return:
  *     description: "Flag to indicate if the Shipping Option can be used for Return shipments."
  *     type: boolean
+ *     default: false
  *   requirements:
- *     description: "The requirements that must be satisfied for the Shipping Option to be available for a Cart."
+ *     description: The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded.
  *     type: array
  *     items:
  *       $ref: "#/components/schemas/shipping_option_requirement"
  *   data:
  *     description: "The data needed for the Fulfillment Provider to identify the Shipping Option."
  *     type: object
+ *     example: {}
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=shipping-option.js.map

package/dist/models/shipping-option.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../src/models/shipping-option.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCASgB;AAChB,4DAAwD;AAExD,uDAAoD;AACpD,mCAAiC;AACjC,+DAA4D;AAC5D,6EAAyE;AACzE,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,oDAAyB,CAAA;AAC3B,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC;AAID;IAAoC,kCAAmB;IAAvD;;IAuDA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IApDD;QADC,IAAA,gBAAM,GAAE;;gDACG;IAIZ;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;qDACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;kDAAA;IAId;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;sDACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,kCAAe,EAAf,CAAe,CAAC;QAChC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,kCAAe;mDAAA;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;uDACU;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,0CAAmB,EAAnB,CAAmB,CAAC;QACpC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,0CAAmB;oDAAA;IAG7B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;;sDAC5B;IAGnC;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;qDACT;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;sDACR;IAKnB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,uDAAyB,EAAzB,CAAyB,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,eAAe,EAAnB,CAAmB,EAAE;YACxE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;wDACuC;IAGzC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;gDACJ;IAG7B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAtDU,cAAc;QAF1B,IAAA,eAAK,EAAC,iBAAe,CAAC;QACtB,IAAA,gBAAM,GAAE;OACI,cAAc,CAuD1B;IAAD,qBAAC;CAAA,AAvDD,CAAoC,2CAAmB,GAuDtD;AAvDY,wCAAc;AAyD3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG"}
+{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../src/models/shipping-option.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCASgB;AAEhB,4DAAwD;AACxD,+DAA4D;AAC5D,mCAAiC;AACjC,6EAAyE;AACzE,uDAAoD;AACpD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,oDAAyB,CAAA;AAC3B,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC;AAID;IAAoC,kCAAmB;IAAvD;;IAuDA,CAAC;IAHS,qCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IApDD;QADC,IAAA,gBAAM,GAAE;;gDACG;IAIZ;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;qDACQ;IAIjB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,eAAM,EAAN,CAAM,CAAC;QACvB,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;kCAC1B,eAAM;kDAAA;IAId;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;sDACS;IAIlB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,kCAAe,EAAf,CAAe,CAAC;QAChC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;kCAC1B,kCAAe;mDAAA;IAIxB;QAFC,IAAA,eAAK,GAAE;QACP,IAAA,gBAAM,GAAE;;uDACU;IAInB;QAFC,IAAA,mBAAS,EAAC,cAAM,OAAA,0CAAmB,EAAnB,CAAmB,CAAC;QACpC,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;kCAC1B,0CAAmB;oDAAA;IAG7B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;;sDAC5B;IAGnC;QADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACnB;IAGrB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;qDACT;IAGlB;QADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;sDACR;IAKnB;QAHC,IAAA,mBAAS,EAAC,cAAM,OAAA,uDAAyB,EAAzB,CAAyB,EAAE,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,eAAe,EAAnB,CAAmB,EAAE;YACxE,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;;wDACuC;IAGzC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;gDACJ;IAG7B;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;sDAGd;IAtDU,cAAc;QAF1B,IAAA,eAAK,EAAC,iBAAe,CAAC;QACtB,IAAA,gBAAM,GAAE;OACI,cAAc,CAuD1B;IAAD,qBAAC;CAAA,AAvDD,CAAoC,2CAAmB,GAuDtD;AAvDY,wCAAc;AAyD3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG"}

package/dist/models/shipping-profile.d.ts

@@ -1,5 +1,5 @@
-import { ShippingOption } from "./shipping-option";
 import { Product } from "./product";
+import { ShippingOption } from "./shipping-option";
 import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity";
 export declare enum ShippingProfileType {
     DEFAULT = "default",
@@ -19,13 +19,18 @@ export declare class ShippingProfile extends SoftDeletableEntity {
  * title: "Shipping Profile"
  * description: "Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products."
  * x-resourceId: shipping_profile
+ * required:
+ *   - name
+ *   - type
  * properties:
  *   id:
- *     description: "The id of the Shipping Profile. This value will be prefixed with `sp_`."
  *     type: string
+ *     description: The shipping profile's ID
+ *     example: sp_01G1G5V239ENSZ5MV4JAR737BM
  *   name:
  *     description: "The name given to the Shipping profile - this may be displayed to the Customer."
  *     type: string
+ *     example: Default Shipping Profile
  *   type:
  *     description: "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`."
  *     type: string
@@ -33,30 +38,32 @@ export declare class ShippingProfile extends SoftDeletableEntity {
  *       - default
  *       - gift_card
  *       - custom
+ *     example: default
  *   products:
- *     description: "The Products that the Shipping Profile defines Shipping Options for."
+ *     description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.
  *     type: array
  *     items:
- *       $ref: "#/components/schemas/product"
+ *       type: object
+ *       description: A product object.
  *   shipping_options:
- *     description: "The Shipping Options that can be used to fulfill the Products in the Shipping Profile."
+ *     description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded.
  *     type: array
  *     items:
- *       anyOf:
- *         - $ref: "#/components/schemas/shipping_option"
+ *       $ref: "#/components/schemas/shipping_option"
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */

package/dist/models/shipping-profile.js

@@ -27,8 +27,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShippingProfile = exports.ShippingProfileType = void 0;
 var typeorm_1 = require("typeorm");
 var db_aware_column_1 = require("../utils/db-aware-column");
-var shipping_option_1 = require("./shipping-option");
 var product_1 = require("./product");
+var shipping_option_1 = require("./shipping-option");
 var soft_deletable_entity_1 = require("../interfaces/models/soft-deletable-entity");
 var generate_entity_id_1 = require("../utils/generate-entity-id");
 var ShippingProfileType;
@@ -82,13 +82,18 @@ exports.ShippingProfile = ShippingProfile;
  * title: "Shipping Profile"
  * description: "Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products."
  * x-resourceId: shipping_profile
+ * required:
+ *   - name
+ *   - type
  * properties:
  *   id:
- *     description: "The id of the Shipping Profile. This value will be prefixed with `sp_`."
  *     type: string
+ *     description: The shipping profile's ID
+ *     example: sp_01G1G5V239ENSZ5MV4JAR737BM
  *   name:
  *     description: "The name given to the Shipping profile - this may be displayed to the Customer."
  *     type: string
+ *     example: Default Shipping Profile
  *   type:
  *     description: "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`."
  *     type: string
@@ -96,31 +101,33 @@ exports.ShippingProfile = ShippingProfile;
  *       - default
  *       - gift_card
  *       - custom
+ *     example: default
  *   products:
- *     description: "The Products that the Shipping Profile defines Shipping Options for."
+ *     description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.
  *     type: array
  *     items:
- *       $ref: "#/components/schemas/product"
+ *       type: object
+ *       description: A product object.
  *   shipping_options:
- *     description: "The Shipping Options that can be used to fulfill the Products in the Shipping Profile."
+ *     description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded.
  *     type: array
  *     items:
- *       anyOf:
- *         - $ref: "#/components/schemas/shipping_option"
+ *       $ref: "#/components/schemas/shipping_option"
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was deleted."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */
 //# sourceMappingURL=shipping-profile.js.map

package/dist/models/shipping-profile.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-profile.js","sourceRoot":"","sources":["../../src/models/shipping-profile.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAiE;AACjE,4DAAwD;AAExD,qDAAkD;AAClD,qCAAmC;AACnC,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8CAAuB,CAAA;IACvB,wCAAiB,CAAA;AACnB,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAGD;IAAqC,mCAAmB;IAAxD;;IAoBA,CAAC;IAHS,sCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAjBD;QADC,IAAA,gBAAM,GAAE;;iDACG;IAGZ;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;;iDAClC;IAGzB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,OAAO,EAAf,CAAe,CAAC;;qDACpC;IAGnB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,OAAO,EAAV,CAAU,CAAC;;6DAClB;IAGlC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;uDAGd;IAnBU,eAAe;QAD3B,IAAA,gBAAM,GAAE;OACI,eAAe,CAoB3B;IAAD,sBAAC;CAAA,AApBD,CAAqC,2CAAmB,GAoBvD;AApBY,0CAAe;AAsB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG"}
+{"version":3,"file":"shipping-profile.js","sourceRoot":"","sources":["../../src/models/shipping-profile.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAiE;AAEjE,4DAAwD;AACxD,qCAAmC;AACnC,qDAAkD;AAClD,oFAAgF;AAChF,kEAA8D;AAE9D,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8CAAuB,CAAA;IACvB,wCAAiB,CAAA;AACnB,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAGD;IAAqC,mCAAmB;IAAxD;;IAoBA,CAAC;IAHS,sCAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAjBD;QADC,IAAA,gBAAM,GAAE;;iDACG;IAGZ;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;;iDAClC;IAGzB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,iBAAO,EAAP,CAAO,EAAE,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,OAAO,EAAf,CAAe,CAAC;;qDACpC;IAGnB;QADC,IAAA,mBAAS,EAAC,cAAM,OAAA,gCAAc,EAAd,CAAc,EAAE,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,OAAO,EAAV,CAAU,CAAC;;6DAClB;IAGlC;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDAChB;IAGjC;QADC,IAAA,sBAAY,GAAE;;;;uDAGd;IAnBU,eAAe;QAD3B,IAAA,gBAAM,GAAE;OACI,eAAe,CAoB3B;IAAD,sBAAC;CAAA,AApBD,CAAqC,2CAAmB,GAoBvD;AApBY,0CAAe;AAsB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG"}

package/dist/models/shipping-tax-rate.d.ts

@@ -14,26 +14,34 @@ export declare class ShippingTaxRate {
  * title: "Shipping Tax Rate"
  * description: "Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way"
  * x-resourceId: shipping_tax_rate
+ * required:
+ *   - shipping_option_id
+ *   - rate_id
  * properties:
  *   shipping_option_id:
- *     description: "The id of the Shipping Option"
+ *     description: "The ID of the Shipping Option"
  *     type: string
+ *     example: so_01G1G5V27GYX4QXNARRQCW1N8T
+ *   shipping_option:
+ *     description: Available if the relation `shipping_option` is expanded.
+ *     $ref: "#/components/schemas/shipping_option"
  *   rate_id:
- *     description: "The id of the Tax Rate"
+ *     description: "The ID of the Tax Rate"
  *     type: string
+ *     example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
+ *   tax_rate:
+ *     description: Available if the relation `tax_rate` is expanded.
+ *     $ref: "#/components/schemas/tax_rate"
  *   created_at:
- *     description: "The date with timezone at which the resource was created."
  *     type: string
+ *     description: "The date with timezone at which the resource was created."
  *     format: date-time
  *   updated_at:
- *     description: "The date with timezone at which the resource was last updated."
- *     type: string
- *     format: date-time
- *   deleted_at:
- *     description: "The date with timezone at which the resource was deleted."
  *     type: string
+ *     description: "The date with timezone at which the resource was updated."
  *     format: date-time
  *   metadata:
- *     description: "An optional key-value map with additional information."
  *     type: object
+ *     description: An optional key-value map with additional details
+ *     example: {car: "white"}
  */