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

package/dist/promotion/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/promotion/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,4BAA4B,EAC5B,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAElE,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,aAAa,CAAC,eAAe,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/D,cAAc,CACZ,qBAAqB,EAAE,MAAM,EAAE,EAC/B,kBAAkB,EAAE,oBAAoB,EACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B,MAAM,CACJ,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B,MAAM,CACJ,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB,MAAM,CACJ,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B,MAAM,CACJ,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB,IAAI,CACF,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B,YAAY,CACV,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpC,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7D,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3D,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C,iBAAiB,CACf,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,0BAA0B,CACxB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB,kBAAkB,CAChB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B,oBAAoB,CAClB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B,aAAa,CACX,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB,qBAAqB,CACnB,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEnC,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtE,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE,mBAAmB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACjE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C,gBAAgB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC9D,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/promotion/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,4BAA4B,EAC5B,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAElE;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,aAAa,CAAC,eAAe,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,cAAc,CACZ,qBAAqB,EAAE,MAAM,EAAE,EAC/B,kBAAkB,EAAE,oBAAoB,EACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7D;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iBAAiB,CACf,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,0BAA0B,CACxB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;OAaG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAClB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtE;;;;;;;;;OASG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAAmB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACjE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC9D,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}

package/dist/region/common.d.ts

@@ -23,8 +23,17 @@ export interface RegionDTO {
      * The countries of the region.
      */
     countries: RegionCountryDTO[];
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, any>;
+    /**
+     * The date the region was created.
+     */
     created_at: string;
+    /**
+     * The date the region was updated.
+     */
     updated_at: string;
 }
 /**

package/dist/region/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/region/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAEpD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,gBAAgB,EAAE,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBACf,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC7C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CACjC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/region/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAEpD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,gBAAgB,EAAE,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBACf,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC7C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAEzE;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CACjC"}

package/dist/region/mutations.d.ts

@@ -23,21 +23,26 @@ export interface CreateRegionDTO {
      */
     metadata?: Record<string, unknown>;
 }
+/**
+ * The attributes in the region to be created or updated.
+ */
 export interface UpsertRegionDTO {
     /**
      * The id of the region in the case of an update
      */
     id?: string;
     /**
-     * The target name of the region
+     * The target name of the region. Required when
+     * creating a region.
      */
     name?: string;
     /**
-     * The currency code of the region.
+     * The currency code of the region. Required when
+     * creating a region.
      */
     currency_code?: string;
     /**
-     * Setting to indicate whether taxes need to be applied automatically
+     * Setting to indicate whether taxes need to be applied automatically.
      */
     automatic_taxes?: boolean;
     /**
@@ -49,6 +54,9 @@ export interface UpsertRegionDTO {
      */
     metadata?: Record<string, unknown>;
 }
+/**
+ * The attributes to update in the region.
+ */
 export interface UpdateRegionDTO {
     /**
      * The target name of the region

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

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/region/mutations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/region/mutations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}

package/dist/region/service.d.ts

@@ -5,7 +5,7 @@ import { Context } from "../shared-context";
 import { FilterableRegionCountryProps, FilterableRegionProps, RegionCountryDTO, RegionDTO } from "./common";
 import { CreateRegionDTO, UpdateRegionDTO, UpsertRegionDTO } from "./mutations";
 /**
- * The main service interface for the region module.
+ * The main service interface for the Region Module.
  */
 export interface IRegionModuleService extends IModuleService {
     /**
@@ -16,7 +16,18 @@ export interface IRegionModuleService extends IModuleService {
      * @returns {Promise<RegionDTO[]>} The created regions.
      *
      * @example
-     * {example-code}
+     * const region = await regionModuleService.create([
+     *   {
+     *     name: "Europe",
+     *     currency_code: "eur",
+     *     countries: ["dk", "de", "fr"],
+     *   },
+     *   {
+     *     name: "United States of America",
+     *     currency_code: "usd",
+     *     countries: ["us"],
+     *   },
+     * ])
      */
     create(data: CreateRegionDTO[], sharedContext?: Context): Promise<RegionDTO[]>;
     /**
@@ -27,59 +38,89 @@ export interface IRegionModuleService extends IModuleService {
      * @returns {Promise<RegionDTO>} The created region.
      *
      * @example
-     * {example-code}
+     * const region = await regionModuleService.create({
+     *   name: "Europe",
+     *   currency_code: "eur",
+     *   countries: ["dk", "de", "fr"],
+     * })
      */
     create(data: CreateRegionDTO, sharedContext?: Context): Promise<RegionDTO>;
     /**
-     * This method updates existing regions, or creates new ones if they don't exist.
+     * This method updates or creates regions if they don't exist.
      *
-     * @param {UpsertRegionDTO[]} data - The attributes to update or create in each region.
-     * @returns {Promise<RegionDTO[]>} The updated and created regions.
+     * @param {UpsertRegionDTO[]} data - The attributes in the regions to be created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<RegionDTO[]>} The created or updated regions.
      *
      * @example
-     * {example-code}
+     * const region = await regionModuleService.upsert([
+     *   {
+     *     id: "reg_123",
+     *     automatic_taxes: false,
+     *   },
+     *   {
+     *     name: "Europe",
+     *     currency_code: "eur",
+     *   },
+     * ])
      */
     upsert(data: UpsertRegionDTO[], sharedContext?: Context): Promise<RegionDTO[]>;
     /**
-     * This method updates an existing region, or creates a new one if it doesn't exist.
+     * This method updates or creates a region if it doesn't exist.
      *
-     * @param {UpsertRegionDTO} data - The attributes to update or create for the region.
-     * @returns {Promise<RegionDTO>} The updated or created region.
+     * @param {UpsertRegionDTO} data - The attributes in the region to be created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<RegionDTO>} The created or updated region.
      *
      * @example
-     * {example-code}
+     * const region = await regionModuleService.upsert({
+     *   id: "reg_123",
+     *   automatic_taxes: false,
+     * })
      */
     upsert(data: UpsertRegionDTO, sharedContext?: Context): Promise<RegionDTO>;
     /**
      * This method updates an existing region.
      *
-     * @param {string} id - The region's ID.
-     * @param {UpdatableRegionFields} data - The details to update in the region.
+     * @param {string} id - The ID of the region.
+     * @param {UpdateRegionDTO} data - The attributes to update in the region.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<RegionDTO>} The updated region.
+     *
+     * @example
+     * const region = await regionModuleService.update("reg_123", {
+     *   automatic_taxes: false,
+     * })
      */
     update(id: string, data: UpdateRegionDTO, sharedContext?: Context): Promise<RegionDTO>;
     /**
      * This method updates existing regions.
      *
-     * @param {FilterableRegionProps} selector - The filters to specify which regions should be updated.
-     * @param {UpdateRegionDTO} data - The details to update in the regions.
+     * @param {FilterableRegionProps} selector - The filters to apply on the retrieved regions.
+     * @param {UpdateRegionDTO} data - The attributes to update in the region.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<RegionDTO[]>} The updated regions.
      *
      * @example
-     * {example-code}
+     * const region = await regionModuleService.update(
+     *   {
+     *     name: "Europe",
+     *   },
+     *   {
+     *     automatic_taxes: false,
+     *   }
+     * )
      */
     update(selector: FilterableRegionProps, data: UpdateRegionDTO, sharedContext?: Context): Promise<RegionDTO[]>;
     /**
      * This method deletes regions by their IDs.
      *
-     * @param {string[]} ids - The list of IDs of regions to delete.
+     * @param {string[]} ids - The IDs of the region.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<void>} Resolves when the regions are deleted.
      *
      * @example
-     * {example-code}
+     * await regionModuleService.delete(["reg_123", "reg_321"])
      */
     delete(ids: string[], sharedContext?: Context): Promise<void>;
     /**
@@ -90,209 +131,293 @@ export interface IRegionModuleService extends IModuleService {
      * @returns {Promise<void>} Resolves when the region is deleted.
      *
      * @example
-     * {example-code}
+     * await regionModuleService.delete("reg_123")
      */
     delete(id: string, sharedContext?: Context): Promise<void>;
     /**
      * This method retrieves a region by its ID.
      *
-     * @param {string} id - The ID of the retrieve.
+     * @param {string} id - The ID of the region.
      * @param {FindConfig<RegionDTO>} config - The configurations determining how the region is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a region.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<RegionDTO>} The retrieved region.
      *
      * @example
-     * A simple example that retrieves a {type name} by its ID:
+     * A simple example that retrieves a region by its ID:
      *
      * ```ts
-     * {example-code}
+     * const region = await regionModuleService.retrieve("reg_123")
      * ```
      *
      * To specify relations that should be retrieved:
      *
      * ```ts
-     * {example-code}
+     * const region = await regionModuleService.retrieve("reg_123", {
+     *   relations: ["countries"],
+     * })
      * ```
-     *
-     *
      */
     retrieve(id: string, config?: FindConfig<RegionDTO>, sharedContext?: Context): Promise<RegionDTO>;
     /**
      * This method retrieves a paginated list of regions based on optional filters and configuration.
      *
-     * @param {FilterableRegionProps} filters - The filters to apply on the retrieved region.
+     * @param {FilterableRegionProps} filters - The filters to apply on the retrieved regions.
      * @param {FindConfig<RegionDTO>} config - The configurations determining how the region is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a region.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<RegionDTO[]>} The list of regions.
      *
      * @example
-     * To retrieve a list of {type name} using their IDs:
+     * To retrieve a list of regions using their IDs:
      *
      * ```ts
-     * {example-code}
+     * const regions = await regionModuleService.list({
+     *   id: ["reg_123", "reg_321"],
+     * })
      * ```
      *
-     * To specify relations that should be retrieved within the {type name}:
+     * To specify relations that should be retrieved within the regions:
      *
      * ```ts
-     * {example-code}
+     * const regions = await regionModuleService.list(
+     *   {
+     *     id: ["reg_123", "reg_321"],
+     *   },
+     *   {
+     *     relations: ["countries"],
+     *   }
+     * )
      * ```
      *
-     * By default, only the first `{default limit}` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
      *
      * ```ts
-     * {example-code}
+     * const regions = await regionModuleService.list(
+     *   {
+     *     id: ["reg_123", "reg_321"],
+     *   },
+     *   {
+     *     relations: ["countries"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
      * ```
-     *
-     *
      */
     list(filters?: FilterableRegionProps, config?: FindConfig<RegionDTO>, sharedContext?: Context): Promise<RegionDTO[]>;
     /**
      * This method retrieves a paginated list of regions along with the total count of available regions satisfying the provided filters.
      *
-     * @param {FilterableRegionProps} filters - The filters to apply on the retrieved region.
+     * @param {FilterableRegionProps} filters - The filters to apply on the retrieved regions.
      * @param {FindConfig<RegionDTO>} config - The configurations determining how the region is retrieved. Its properties, such as `select` or `relations`, accept the
      * attributes or relations associated with a region.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<[RegionDTO[], number]>} The list of regions along with their total count.
      *
      * @example
-     * To retrieve a list of {type name} using their IDs:
+     * To retrieve a list of regions using their IDs:
      *
      * ```ts
-     * {example-code}
+     * const [regions, count] =
+     *   await regionModuleService.listAndCount({
+     *     id: ["reg_123", "reg_321"],
+     *   })
      * ```
      *
-     * To specify relations that should be retrieved within the {type name}:
+     * To specify relations that should be retrieved within the regions:
      *
      * ```ts
-     * {example-code}
+     * const [regions, count] =
+     *   await regionModuleService.listAndCount(
+     *     {
+     *       id: ["reg_123", "reg_321"],
+     *     },
+     *     {
+     *       relations: ["countries"],
+     *     }
+     *   )
      * ```
      *
-     * By default, only the first `{default limit}` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
      *
      * ```ts
-     * {example-code}
+     * const [regions, count] =
+     * await regionModuleService.listAndCount(
+     *   {
+     *     id: ["reg_123", "reg_321"],
+     *   },
+     *   {
+     *     relations: ["countries"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
      * ```
-     *
-     *
      */
     listAndCount(filters?: FilterableRegionProps, config?: FindConfig<RegionDTO>, sharedContext?: Context): Promise<[RegionDTO[], number]>;
     /**
-     * This method retrieves a country by its ID.
+     * This method retrieves a country by its 2 character ISO code.
      *
-     * @param {string} countryId - The country's ID.
-     * @param {FindConfig<RegionCountryDTO>} config - The configurations determining how the region country is retrieved. Its properties, such as `select` or `relations`, accept the
-     * attributes or relations associated with a region country.
+     * @param {string} countryId - The country's ID, which is the 2 character ISO code.
+     * @param {FindConfig<RegionCountryDTO>} config - The configurations determining how the country is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a country.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<RegionCountryDTO>} The retrieved country.
      *
      * @example
-     * A simple example that retrieves a {type name} by its ID:
+     * A simple example that retrieves a country by its 2 character ISO code:
      *
      * ```ts
-     * {example-code}
+     * const country =
+     *   await regionModuleService.retrieveCountry("us")
      * ```
      *
      * To specify relations that should be retrieved:
      *
      * ```ts
-     * {example-code}
+     * const country = await regionModuleService.retrieveCountry(
+     *   "us",
+     *   {
+     *     relations: ["region"],
+     *   }
+     * )
      * ```
-     *
-     *
      */
     retrieveCountry(countryId: string, config?: FindConfig<RegionCountryDTO>, sharedContext?: Context): Promise<RegionCountryDTO>;
     /**
      * This method retrieves a paginated list of countries based on optional filters and configuration.
      *
-     * @param {FilterableRegionCountryProps} filters - The filters to apply on the retrieved region country.
-     * @param {FindConfig<RegionCountryDTO>} config - The configurations determining how the region country is retrieved. Its properties, such as `select` or `relations`, accept the
-     * attributes or relations associated with a region country.
+     * @param {FilterableRegionCountryProps} filters - The filters to apply on the retrieved countries.
+     * @param {FindConfig<RegionCountryDTO>} config - The configurations determining how the country is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a country.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<RegionCountryDTO[]>} The list of countries.
      *
      * @example
-     * To retrieve a list of {type name} using their IDs:
+     * To retrieve a list of countries using their IDs:
      *
      * ```ts
-     * {example-code}
+     * const countries = await regionModuleService.listCountries({
+     *   iso_2: ["us", "eur"],
+     * })
      * ```
      *
-     * To specify relations that should be retrieved within the {type name}:
+     * To specify relations that should be retrieved within the countries:
      *
      * ```ts
-     * {example-code}
+     * const countries = await regionModuleService.listCountries(
+     *   {
+     *     iso_2: ["us", "eur"],
+     *   },
+     *   {
+     *     relations: ["region"],
+     *   }
+     * )
      * ```
      *
-     * By default, only the first `{default limit}` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
      *
      * ```ts
-     * {example-code}
+     * const countries = await regionModuleService.listCountries(
+     *   {
+     *     iso_2: ["us", "eur"],
+     *   },
+     *   {
+     *     relations: ["region"],
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
      * ```
-     *
-     *
      */
     listCountries(filters?: FilterableRegionCountryProps, config?: FindConfig<RegionCountryDTO>, sharedContext?: Context): Promise<RegionCountryDTO[]>;
     /**
      * This method retrieves a paginated list of countries along with the total count of available countries satisfying the provided filters.
      *
-     * @param {FilterableRegionCountryProps} filters - The filters to apply on the retrieved region country.
-     * @param {FindConfig<RegionCountryDTO>} config - The configurations determining how the region country is retrieved. Its properties, such as `select` or `relations`, accept the
-     * attributes or relations associated with a region country.
+     * @param {FilterableRegionCountryProps} filters - The filters to apply on the retrieved countries.
+     * @param {FindConfig<RegionCountryDTO>} config - The configurations determining how the country is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a country.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
      * @returns {Promise<[RegionCountryDTO[], number]>} The list of countries along with their total count.
      *
      * @example
-     * To retrieve a list of {type name} using their IDs:
+     * To retrieve a list of countries using their IDs:
      *
      * ```ts
-     * {example-code}
+     * const [countries, count] =
+     *   await regionModuleService.listAndCountCountries({
+     *     iso_2: ["us", "eur"],
+     *   })
      * ```
      *
-     * To specify relations that should be retrieved within the {type name}:
+     * To specify relations that should be retrieved within the countries:
      *
      * ```ts
-     * {example-code}
+     * const [countries, count] =
+     *   await regionModuleService.listAndCountCountries(
+     *     {
+     *       iso_2: ["us", "eur"],
+     *     },
+     *     {
+     *       relations: ["region"],
+     *     }
+     *   )
      * ```
      *
-     * By default, only the first `{default limit}` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
      *
      * ```ts
-     * {example-code}
+     * const [countries, count] =
+     *   await regionModuleService.listAndCountCountries(
+     *     {
+     *       iso_2: ["us", "eur"],
+     *     },
+     *     {
+     *       relations: ["region"],
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
      * ```
-     *
-     *
      */
     listAndCountCountries(filters?: FilterableRegionCountryProps, config?: FindConfig<RegionCountryDTO>, sharedContext?: Context): Promise<[RegionCountryDTO[], number]>;
     /**
-     * This method soft deletes regions by their IDs.
+     * This method soft deletes a region by its IDs.
      *
-     * @param {string[]} regionIds - The list of IDs of regions to soft delete.
+     * @param {string[]} regionIds - The regions' IDs.
      * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void | Record<string, string[]>>} Resolves successfully when the regions are soft-deleted.
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated country.
+     * The object's keys are the ID attribute names of the region entity's relations, such as `country_id`, and its value is an array of strings, each being the ID of a record associated
+     * with the region through this relation, such as the IDs of associated countries.
+     *
+     * If there are no related records, the promise resolves to `void`.
      *
      * @example
-     * {example-code}
+     * await regionModuleService.softDelete(["reg_123", "reg_321"], {
+     *   returnLinkableKeys: ["country_id"],
+     * })
      */
     softDelete<TReturnableLinkableKeys extends string = string>(regionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
     /**
      * This method restores soft deleted regions by their IDs.
      *
-     * @param {string[]} regionIds - The list of IDs of regions to restore.
-     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the regions. You can pass to its `returnLinkableKeys`
-     * property any of the regions's relation attribute names, such as `country`.
+     * @param {string[]} regionIds - The regions' IDs.
+     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the region. You can pass to its `returnLinkableKeys`
+     * property any of the region's relation attribute names, such as `countries`.
      * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated country.
-     * The object's keys are the ID attribute names of the regions entity's relations, such as `country`,
+     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated countries.
+     * The object's keys are the ID attribute names of the region entity's relations, such as `country_id`,
      * and its value is an array of strings, each being the ID of the record associated with the region through this relation,
-     * such as the IDs of associated country.
+     * such as the IDs of associated countries.
+     *
+     * If there are no related records restored, the promise resolves to `void`.
      *
      * @example
-     * {example-code}
+     * await regionModuleService.restore(["reg_123", "reg_321"], {
+     *   returnLinkableKeys: ["country_id"],
+     * })
      */
     restore<TReturnableLinkableKeys extends string = string>(regionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
 }

package/dist/region/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/region/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,gBAAgB,EAChB,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAE9E;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAE1E;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAE9E;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAE1E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;OAUG;IACH,MAAM,CACJ,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7D;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/region/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,gBAAgB,EAChB,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAE9E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAE1E;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAE9E;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAE1E;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7D;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACxD,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrD,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}

package/dist/stock-location/common.d.ts

@@ -390,8 +390,22 @@ export type UpdateStockLocationInput = {
      */
     metadata?: Record<string, unknown>;
 };
+/**
+ * @interface
+ *
+ * The attributes to update in a stock location.
+ */
 export type UpdateStockLocationNextInput = UpdateStockLocationInput & {
+    /**
+     * The ID of the stock location.
+     */
     id: string;
 };
+/**
+ * @interface
+ *
+ * A stock location to create or update. If the `id` property isn't provided,
+ * the stock location is created. In that case, the `name` property is required.
+ */
 export type UpsertStockLocationInput = Partial<UpdateStockLocationNextInput>;
 //# sourceMappingURL=common.d.ts.map