@medusajs/js-sdk 1.0.0-rc-20241016093905 → 1.0.0-rc-20241022152047

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

@@ -1 +1 @@
-{"version":3,"file":"claim.js","sourceRoot":"","sources":["../../../src/admin/claim.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,KAAK;IAEhB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CAAC,KAAsC,EAAE,OAAuB;;YACxE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAkC,EAClC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,IAAgC,EAChC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,SAAS,EAC5B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,IAAkC,EAClC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,cAAc,EACjC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,UAAU,CACd,EAAU,EACV,QAAgB,EAChB,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,gBAAgB,QAAQ,EAAE,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,UAAU,CACd,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,gBAAgB,QAAQ,EAAE,EAC7C;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,eAAe,CACnB,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,gBAAgB,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAA2C,EAC3C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,kBAAkB,QAAQ,EAAE,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,kBAAkB,QAAQ,EAAE,EAC/C;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,0BAA0B,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,4BAA4B,QAAQ,EAAE,EACzD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,4BAA4B,QAAQ,EAAE,EACzD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,gBAAgB,CACpB,EAAU,EACV,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,mBAAmB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,mBAAmB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,mBAAmB,CACvB,EAAU,EACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,2BAA2B,EAC9C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,IAAgD,EAChD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,6BAA6B,QAAQ,EAAE,EAC1D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,6BAA6B,QAAQ,EAAE,EAC1D;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,OAAO,CACX,EAAU,EACV,IAAiC,EACjC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"claim.js","sourceRoot":"","sources":["../../../src/admin/claim.ts"],"names":[],"mappings":";;;;;;;;;AAKA,MAAM,OAAO,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CAAC,KAAsC,EAAE,OAAuB;;YACxE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAgC,EAChC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,SAAS,EAC5B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,QAAQ,CACZ,EAAU,EACV,IAAkC,EAClC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,cAAc,EACjC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,UAAU,CACd,EAAU,EACV,QAAgB,EAChB,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,gBAAgB,QAAQ,EAAE,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,UAAU,CACd,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,gBAAgB,QAAQ,EAAE,EAC7C;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,eAAe,CACnB,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,gBAAgB,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAA2C,EAC3C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,kBAAkB,QAAQ,EAAE,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,kBAAkB,QAAQ,EAAE,EAC/C;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,kBAAkB,CACtB,EAAU,EACV,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,0BAA0B,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,4BAA4B,QAAQ,EAAE,EACzD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,4BAA4B,QAAQ,EAAE,EACzD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,gBAAgB,CACpB,EAAU,EACV,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,EACpC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,mBAAmB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,mBAAmB,QAAQ,EAAE,EAChD;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,mBAAmB,CACvB,EAAU,EACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,2BAA2B,EAC9C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,IAAgD,EAChD,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,6BAA6B,QAAQ,EAAE,EAC1D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,6BAA6B,QAAQ,EAAE,EAC1D;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,OAAO,CACX,EAAU,EACV,IAAiC,EACjC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

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

@@ -2,9 +2,94 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class Currency {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
+    /**
+     * This method retrieves a paginated list of currencies. It sends a request to the
+     * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of currencies.
+     *
+     * @example
+     * To retrieve the list of currencies:
+     *
+     * ```ts
+     * sdk.admin.currency.list()
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.currency.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each currency:
+     *
+     * ```ts
+     * sdk.admin.currency.list({
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminCurrencyListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyListResponse>;
-    retrieve(id: string, query?: HttpTypes.AdminCurrencyParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyResponse>;
+    /**
+     * This method retrieves a currency by its code. It sends a request to the
+     * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
+     *
+     * @param code - The currency's code.
+     * @param query - Configure the fields to retrieve in the currency.
+     * @param headers - Headers to pass in the request
+     * @returns The currency's details.
+     *
+     * @example
+     * To retrieve a currency by its code:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd")
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd", {
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    retrieve(code: string, query?: HttpTypes.AdminCurrencyParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyResponse>;
 }
 //# sourceMappingURL=currency.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../src/admin/currency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EACrC,OAAO,CAAC,EAAE,aAAa;CAU1B"}
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../src/admin/currency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,SAAS,CAAC,mBAAmB,EACrC,OAAO,CAAC,EAAE,aAAa;CAU1B"}

package/dist/esm/admin/currency.js

@@ -8,9 +8,59 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 export class Currency {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a paginated list of currencies. It sends a request to the
+     * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of currencies.
+     *
+     * @example
+     * To retrieve the list of currencies:
+     *
+     * ```ts
+     * sdk.admin.currency.list()
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.currency.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each currency:
+     *
+     * ```ts
+     * sdk.admin.currency.list({
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currencies, count, limit, offset }) => {
+     *   console.log(currencies)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/currencies`, {
@@ -19,9 +69,41 @@ export class Currency {
             });
         });
     }
-    retrieve(id, query, headers) {
+    /**
+     * This method retrieves a currency by its code. It sends a request to the
+     * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
+     *
+     * @param code - The currency's code.
+     * @param query - Configure the fields to retrieve in the currency.
+     * @param headers - Headers to pass in the request
+     * @returns The currency's details.
+     *
+     * @example
+     * To retrieve a currency by its code:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd")
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.currency.retrieve("usd", {
+     *   fields: "code,symbol"
+     * })
+     * .then(({ currency }) => {
+     *   console.log(currency)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    retrieve(code, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.client.fetch(`/admin/currencies/${id}`, {
+            return this.client.fetch(`/admin/currencies/${code}`, {
                 headers,
                 query,
             });

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

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/admin/currency.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,QAAQ;IAEnB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,mBAAmB,EACnB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAqC,EACrC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,EAAE,EAAE,EACzB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/admin/currency.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,mBAAmB,EACnB;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,IAAY,EACZ,KAAqC,EACrC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,IAAI,EAAE,EAC3B;gBACE,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/admin/customer-group.d.ts

@@ -2,13 +2,169 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class CustomerGroup {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
+    /**
+     * This method retrieves a customer group by its ID. It sends a request to the
+     * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
+     *
+     * @param id - The customer group's ID.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request
+     * @returns The group's details.
+     *
+     * @example
+     * To retrieve a customer group by its ID:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123")
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123", {
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method retrieves a paginated list of customer groups. It sends a request to the
+     * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of customer groups.
+     *
+     * @example
+     * To retrieve the list of customer groups:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list()
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each customer group:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list({
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupListResponse>;
-    create(body: HttpTypes.AdminCreateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
-    update(id: string, body: HttpTypes.AdminUpdateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method creates a customer group. It sends a request to the
+     * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
+     * API route.
+     *
+     * @param body - The customer group's details.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.create({
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
+    create(body: HttpTypes.AdminCreateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method updates a customer group's details. It sends a request to the
+     * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param body - The details to update in the group.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.update("cusgroup_123", {
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
+    update(id: string, body: HttpTypes.AdminUpdateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
+    /**
+     * This method deletes a customer group. This method sends a request to the
+     * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.delete("cusgroup_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupDeleteResponse>;
+    /**
+     * This method manages customers of a group to add or remove them from the group.
+     * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
+     * API route.
+     *
+     * @param id - The group's ID.
+     * @param body - The customers to add or remove from the group.
+     * @param headers - Headers to pass in the request
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.batchCustomers("cusgroup_123", {
+     *   add: ["cus_123"],
+     *   remove: ["cus_321"]
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     batchCustomers(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
 }
 //# sourceMappingURL=customer-group.d.ts.map

package/dist/esm/admin/customer-group.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customer-group.d.ts","sourceRoot":"","sources":["../../../src/admin/customer-group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"customer-group.d.ts","sourceRoot":"","sources":["../../../src/admin/customer-group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,aAAa;IACxB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,4BAA4B,EAC9C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/esm/admin/customer-group.js

@@ -8,9 +8,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 export class CustomerGroup {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a customer group by its ID. It sends a request to the
+     * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
+     *
+     * @param id - The customer group's ID.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request
+     * @returns The group's details.
+     *
+     * @example
+     * To retrieve a customer group by its ID:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123")
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.retrieve("cusgroup_123", {
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     retrieve(id, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}`, {
@@ -20,6 +55,53 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method retrieves a paginated list of customer groups. It sends a request to the
+     * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of customer groups.
+     *
+     * @example
+     * To retrieve the list of customer groups:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list()
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each customer group:
+     *
+     * ```ts
+     * sdk.admin.customerGroup.list({
+     *   fields: "id,*customer"
+     * })
+     * .then(({ customer_groups, count, limit, offset }) => {
+     *   console.log(customer_groups)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups`, {
@@ -29,6 +111,24 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method creates a customer group. It sends a request to the
+     * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
+     * API route.
+     *
+     * @param body - The customer group's details.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.create({
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups`, {
@@ -39,6 +139,25 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method updates a customer group's details. It sends a request to the
+     * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param body - The details to update in the group.
+     * @param query - Configure the fields to retrieve in the customer group.
+     * @param headers - Headers to pass in the request.
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.update("cusgroup_123", {
+     *   name: "VIP"
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}`, {
@@ -49,6 +168,21 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method deletes a customer group. This method sends a request to the
+     * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
+     * API route.
+     *
+     * @param id - The customer group's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.delete("cusgroup_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}`, {
@@ -57,6 +191,25 @@ export class CustomerGroup {
             });
         });
     }
+    /**
+     * This method manages customers of a group to add or remove them from the group.
+     * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
+     * API route.
+     *
+     * @param id - The group's ID.
+     * @param body - The customers to add or remove from the group.
+     * @param headers - Headers to pass in the request
+     * @returns The customer group's details.
+     *
+     * @example
+     * sdk.admin.customerGroup.batchCustomers("cusgroup_123", {
+     *   add: ["cus_123"],
+     *   remove: ["cus_321"]
+     * })
+     * .then(({ customer_group }) => {
+     *   console.log(customer_group)
+     * })
+     */
     batchCustomers(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/customer-groups/${id}/customers`, {

package/dist/esm/admin/customer-group.js.map

@@ -1 +1 @@
-{"version":3,"file":"customer-group.js","sourceRoot":"","sources":["../../../src/admin/customer-group.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAExB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,QAAQ,CACZ,EAAU,EACV,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,IAAwC,EACxC,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,YAAY,EACxC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"customer-group.js","sourceRoot":"","sources":["../../../src/admin/customer-group.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAwC,EACxC,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,YAAY,EACxC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}