postgrid-node 0.1.0-alpha.3 → 0.1.0-alpha.5

package/resources/reports/reports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,OAAO,EACR,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAItG;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI5F;;;OAGG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxC;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAWlG;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxF;;;;OAIG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAI/C;;;;;OAKG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED,qBAAa,uBAAwB,SAAQ,IAAI,CAAC,kBAAkB,CAAC;CAAG;AAExE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,OAAO,EACR,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAItG;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI5F;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAWlG;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxF;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAI/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED,qBAAa,uBAAwB,SAAQ,IAAI,CAAC,kBAAkB,CAAC;CAAG;AAExE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE3C;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE3C;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/reports/reports.js

@@ -41,12 +41,27 @@ class Reports extends resource_1.APIResource {
      *
      * If you just want to do ad-hoc queries, you should use the `/reports/samples`
      * endpoint.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.create({
+     *   sqlQuery:
+     *     'SELECT id, status FROM orders WHERE created_at > ?',
+     *   description: 'Recent Orders',
+     *   metadata: { team: 'Sales' },
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/reports/', { body, ...options });
     }
     /**
      * Retrieve the details of a specific saved report by its ID.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.retrieve('id');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(`/reports/${id}`, options);
@@ -54,6 +69,13 @@ class Reports extends resource_1.APIResource {
     /**
      * Update an existing saved report definition. You can change the query,
      * description, or metadata.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.update('id', {
+     *   description: 'Recent Orders (Updated)',
+     * });
+     * ```
      */
     update(id, body, options) {
         return this._client.post(`/reports/${id}`, { body, ...options });
@@ -67,6 +89,11 @@ class Reports extends resource_1.APIResource {
     /**
      * Delete a saved report definition. This action cannot be undone. Associated
      * exports are not automatically deleted.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete(`/reports/${id}`, options);
@@ -75,6 +102,15 @@ class Reports extends resource_1.APIResource {
      * Run an ad-hoc SQL query against your data lake and get a sample of the results.
      * This is useful for quickly testing queries without saving them as a report. The
      * query execution time and result size are limited.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.runAdHocQuery({
+     *   sqlQuery: 'SELECT id FROM contacts LIMIT 5',
+     *   limit: 5,
+     *   params: [],
+     * });
+     * ```
      */
     runAdHocQuery(body, options) {
         return this._client.post('/reports/samples', { body, ...options });
@@ -84,6 +120,14 @@ class Reports extends resource_1.APIResource {
      * This allows getting up to 1000 rows of resutls but the runtime of the query is
      * limited to 30 seconds. If you need more rows or longer runtime, you should
      * create an export from this report.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.sample('id', {
+     *   limit: 10,
+     *   params: ['2023-10-01T00:00:00Z'],
+     * });
+     * ```
      */
     sample(id, body, options) {
         return this._client.post(`/reports/${id}/samples`, { body, ...options });

package/resources/reports/reports.js.map

@@ -1 +1 @@
-{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,yDAAwC;AACxC,0CAMmB;AACnB,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmFrE,CAAC;IAjFC;;;;;;OAMG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAUD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AApFD,0BAoFC;AAED,MAAa,uBAAwB,SAAQ,iBAAwB;CAAG;AAAxE,0DAAwE;AAyTxE,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,yDAAwC;AACxC,0CAMmB;AACnB,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuIrE,CAAC;IArIC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAkBD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAxID,0BAwIC;AAED,MAAa,uBAAwB,SAAQ,iBAAwB;CAAG;AAAxE,0DAAwE;AAyTxE,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}

package/resources/reports/reports.mjs

@@ -15,12 +15,27 @@ export class Reports extends APIResource {
      *
      * If you just want to do ad-hoc queries, you should use the `/reports/samples`
      * endpoint.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.create({
+     *   sqlQuery:
+     *     'SELECT id, status FROM orders WHERE created_at > ?',
+     *   description: 'Recent Orders',
+     *   metadata: { team: 'Sales' },
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/reports/', { body, ...options });
     }
     /**
      * Retrieve the details of a specific saved report by its ID.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.retrieve('id');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(`/reports/${id}`, options);
@@ -28,6 +43,13 @@ export class Reports extends APIResource {
     /**
      * Update an existing saved report definition. You can change the query,
      * description, or metadata.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.update('id', {
+     *   description: 'Recent Orders (Updated)',
+     * });
+     * ```
      */
     update(id, body, options) {
         return this._client.post(`/reports/${id}`, { body, ...options });
@@ -41,6 +63,11 @@ export class Reports extends APIResource {
     /**
      * Delete a saved report definition. This action cannot be undone. Associated
      * exports are not automatically deleted.
+     *
+     * @example
+     * ```ts
+     * const report = await client.reports.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete(`/reports/${id}`, options);
@@ -49,6 +76,15 @@ export class Reports extends APIResource {
      * Run an ad-hoc SQL query against your data lake and get a sample of the results.
      * This is useful for quickly testing queries without saving them as a report. The
      * query execution time and result size are limited.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.runAdHocQuery({
+     *   sqlQuery: 'SELECT id FROM contacts LIMIT 5',
+     *   limit: 5,
+     *   params: [],
+     * });
+     * ```
      */
     runAdHocQuery(body, options) {
         return this._client.post('/reports/samples', { body, ...options });
@@ -58,6 +94,14 @@ export class Reports extends APIResource {
      * This allows getting up to 1000 rows of resutls but the runtime of the query is
      * limited to 30 seconds. If you need more rows or longer runtime, you should
      * create an export from this report.
+     *
+     * @example
+     * ```ts
+     * const response = await client.reports.sample('id', {
+     *   limit: 10,
+     *   params: ['2023-10-01T00:00:00Z'],
+     * });
+     * ```
      */
     sample(id, body, options) {
         return this._client.post(`/reports/${id}/samples`, { body, ...options });

package/resources/reports/reports.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,UAAU;OACf,EAKL,OAAO,GACR;OACM,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmFrE,CAAC;IAjFC;;;;;;OAMG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAUD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,IAAwB;CAAG;AAyTxE,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../../src/resources/reports/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,UAAU;OACf,EAKL,OAAO,GACR;OACM,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuIrE,CAAC;IArIC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAkBD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,IAAwB;CAAG;AAyTxE,OAAO,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC1D,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/resources/self-mailers.d.ts

@@ -12,21 +12,65 @@ export declare class SelfMailers extends APIResource {
      * - A URL or file for a 2 page PDF where the first page is the outside of the
      *   self-mailer and the second page is the inside
      * - Upload the aforementioned PDF file via a multipart form upload request
+     *
+     * @example
+     * ```ts
+     * const selfMailer = await client.selfMailers.create({
+     *   from: 'contact_123',
+     *   insideHTML: '<html>Inside</html>',
+     *   outsideHTML: '<html>Outside</html>',
+     *   size: '8.5x11_bifold',
+     *   to: 'contact_456',
+     * });
+     * ```
      */
     create(body: SelfMailerCreateParams, options?: Core.RequestOptions): Core.APIPromise<SelfMailerCreateResponse>;
     /**
      * Retrieve a self-mailer by ID.
+     *
+     * @example
+     * ```ts
+     * const selfMailer = await client.selfMailers.retrieve('id');
+     * ```
      */
     retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<SelfMailerRetrieveResponse>;
     /**
      * Get a list of self-mailers.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const selfMailerListResponse of client.selfMailers.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: SelfMailerListParams, options?: Core.RequestOptions): Core.PagePromise<SelfMailerListResponsesList, SelfMailerListResponse>;
     list(options?: Core.RequestOptions): Core.PagePromise<SelfMailerListResponsesList, SelfMailerListResponse>;
     /**
      * Cancel a self-mailer by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const response = await client.selfMailers.cancel('id');
+     * ```
      */
     cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<SelfMailerCancelResponse>;
+    /**
+     * Retrieve a self-mailer preview URL.
+     *
+     * This is only available for customers with our document management addon, which
+     * offers document generation and hosting capabilities. This endpoint has a much
+     * higher rate limit than the regular order retrieval endpoint, so it is suitable
+     * for customer-facing use-cases.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.selfMailers.retrievePreviewURL('id');
+     * ```
+     */
+    retrievePreviewURL(id: string, options?: Core.RequestOptions): Core.APIPromise<SelfMailerRetrievePreviewURLResponse>;
 }
 export declare class SelfMailerListResponsesList extends List<SelfMailerListResponse> {
 }
@@ -110,11 +154,15 @@ export interface SelfMailerCreateResponse {
      * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
      * PDFs uploaded with the order.
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        [key: string]: unknown;
+    };
     /**
      * The tracking number of this order. Populated after an express/certified order
      * has been processed for delivery.
@@ -212,11 +260,15 @@ export interface SelfMailerRetrieveResponse {
      * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
      * PDFs uploaded with the order.
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        [key: string]: unknown;
+    };
     /**
      * The tracking number of this order. Populated after an express/certified order
      * has been processed for delivery.
@@ -314,11 +366,15 @@ export interface SelfMailerListResponse {
      * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
      * PDFs uploaded with the order.
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        [key: string]: unknown;
+    };
     /**
      * The tracking number of this order. Populated after an express/certified order
      * has been processed for delivery.
@@ -416,11 +472,15 @@ export interface SelfMailerCancelResponse {
      * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
      * PDFs uploaded with the order.
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        [key: string]: unknown;
+    };
     /**
      * The tracking number of this order. Populated after an express/certified order
      * has been processed for delivery.
@@ -438,6 +498,18 @@ export interface SelfMailerCancelResponse {
      */
     url?: string;
 }
+export interface SelfMailerRetrievePreviewURLResponse {
+    /**
+     * A unique ID prefixed with self*mailer*
+     */
+    id: string;
+    object: string;
+    /**
+     * A signed URL linking to the order preview PDF. The link remains valid for 15
+     * minutes from the time of the API call.
+     */
+    url: string;
+}
 export type SelfMailerCreateParams = SelfMailerCreateParams.SelfMailerCreateWithHTML | SelfMailerCreateParams.SelfMailerCreateWithTemplate | SelfMailerCreateParams.SelfMailerCreateWithPdfurl | SelfMailerCreateParams.SelfMailerCreateWithPdfFile;
 export declare namespace SelfMailerCreateParams {
     interface SelfMailerCreateWithHTML {
@@ -483,11 +555,15 @@ export declare namespace SelfMailerCreateParams {
          * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
          * PDFs uploaded with the order.
          */
-        mergeVariables?: Record<string, unknown>;
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
         /**
          * See the section on Metadata.
          */
-        metadata?: Record<string, unknown>;
+        metadata?: {
+            [key: string]: unknown;
+        };
         /**
          * This order will transition from `ready` to `printing` on the day after this
          * date. You can use this parameter to schedule orders for a future date.
@@ -545,11 +621,15 @@ export declare namespace SelfMailerCreateParams {
          * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
          * PDFs uploaded with the order.
          */
-        mergeVariables?: Record<string, unknown>;
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
         /**
          * See the section on Metadata.
          */
-        metadata?: Record<string, unknown>;
+        metadata?: {
+            [key: string]: unknown;
+        };
         /**
          * This order will transition from `ready` to `printing` on the day after this
          * date. You can use this parameter to schedule orders for a future date.
@@ -594,11 +674,15 @@ export declare namespace SelfMailerCreateParams {
          * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
          * PDFs uploaded with the order.
          */
-        mergeVariables?: Record<string, unknown>;
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
         /**
          * See the section on Metadata.
          */
-        metadata?: Record<string, unknown>;
+        metadata?: {
+            [key: string]: unknown;
+        };
         /**
          * This order will transition from `ready` to `printing` on the day after this
          * date. You can use this parameter to schedule orders for a future date.
@@ -617,6 +701,6 @@ export interface SelfMailerListParams extends ListParams {
     search?: string;
 }
 export declare namespace SelfMailers {
-    export { type SelfMailerCreateResponse as SelfMailerCreateResponse, type SelfMailerRetrieveResponse as SelfMailerRetrieveResponse, type SelfMailerListResponse as SelfMailerListResponse, type SelfMailerCancelResponse as SelfMailerCancelResponse, SelfMailerListResponsesList as SelfMailerListResponsesList, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerListParams as SelfMailerListParams, };
+    export { type SelfMailerCreateResponse as SelfMailerCreateResponse, type SelfMailerRetrieveResponse as SelfMailerRetrieveResponse, type SelfMailerListResponse as SelfMailerListResponse, type SelfMailerCancelResponse as SelfMailerCancelResponse, type SelfMailerRetrievePreviewURLResponse as SelfMailerRetrievePreviewURLResponse, SelfMailerListResponsesList as SelfMailerListResponsesList, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerListParams as SelfMailerListParams, };
 }
 //# sourceMappingURL=self-mailers.d.ts.map

package/resources/self-mailers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.d.ts","sourceRoot":"","sources":["../src/resources/self-mailers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;OAQG;IACH,MAAM,CACJ,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;IAW1G;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED,qBAAa,2BAA4B,SAAQ,IAAI,CAAC,sBAAsB,CAAC;CAAG;AAEhF,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,4BAA4B,GACnD,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,4BAA4B;QAC3C;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;;WAIG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"self-mailers.d.ts","sourceRoot":"","sources":["../src/resources/self-mailers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;IAW1G;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oCAAoC,CAAC;CAGzD;AAED,qBAAa,2BAA4B,SAAQ,IAAI,CAAC,sBAAsB,CAAC;CAAG;AAEhF,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,4BAA4B,GACnD,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,4BAA4B;QAC3C;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;;WAIG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/self-mailers.js

@@ -14,12 +14,28 @@ class SelfMailers extends resource_1.APIResource {
      * - A URL or file for a 2 page PDF where the first page is the outside of the
      *   self-mailer and the second page is the inside
      * - Upload the aforementioned PDF file via a multipart form upload request
+     *
+     * @example
+     * ```ts
+     * const selfMailer = await client.selfMailers.create({
+     *   from: 'contact_123',
+     *   insideHTML: '<html>Inside</html>',
+     *   outsideHTML: '<html>Outside</html>',
+     *   size: '8.5x11_bifold',
+     *   to: 'contact_456',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/self_mailers', { body, ...options });
     }
     /**
      * Retrieve a self-mailer by ID.
+     *
+     * @example
+     * ```ts
+     * const selfMailer = await client.selfMailers.retrieve('id');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(`/self_mailers/${id}`, options);
@@ -32,10 +48,32 @@ class SelfMailers extends resource_1.APIResource {
     }
     /**
      * Cancel a self-mailer by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const response = await client.selfMailers.cancel('id');
+     * ```
      */
     cancel(id, options) {
         return this._client.delete(`/self_mailers/${id}`, options);
     }
+    /**
+     * Retrieve a self-mailer preview URL.
+     *
+     * This is only available for customers with our document management addon, which
+     * offers document generation and hosting capabilities. This endpoint has a much
+     * higher rate limit than the regular order retrieval endpoint, so it is suitable
+     * for customer-facing use-cases.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.selfMailers.retrievePreviewURL('id');
+     * ```
+     */
+    retrievePreviewURL(id, options) {
+        return this._client.get(`/self_mailers/${id}/url`, options);
+    }
 }
 exports.SelfMailers = SelfMailers;
 class SelfMailerListResponsesList extends pagination_1.List {

package/resources/self-mailers.js.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.js","sourceRoot":"","sources":["../src/resources/self-mailers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;OAQG;IACH,MAAM,CACJ,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAUD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAhDD,kCAgDC;AAED,MAAa,2BAA4B,SAAQ,iBAA4B;CAAG;AAAhF,kEAAgF;AAs3BhF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"self-mailers.js","sourceRoot":"","sources":["../src/resources/self-mailers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAkBD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,EAAU,EACV,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAlGD,kCAkGC;AAED,MAAa,2BAA4B,SAAQ,iBAA4B;CAAG;AAAhF,kEAAgF;AAq4BhF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}

package/resources/self-mailers.mjs

@@ -11,12 +11,28 @@ export class SelfMailers extends APIResource {
      * - A URL or file for a 2 page PDF where the first page is the outside of the
      *   self-mailer and the second page is the inside
      * - Upload the aforementioned PDF file via a multipart form upload request
+     *
+     * @example
+     * ```ts
+     * const selfMailer = await client.selfMailers.create({
+     *   from: 'contact_123',
+     *   insideHTML: '<html>Inside</html>',
+     *   outsideHTML: '<html>Outside</html>',
+     *   size: '8.5x11_bifold',
+     *   to: 'contact_456',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/self_mailers', { body, ...options });
     }
     /**
      * Retrieve a self-mailer by ID.
+     *
+     * @example
+     * ```ts
+     * const selfMailer = await client.selfMailers.retrieve('id');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(`/self_mailers/${id}`, options);
@@ -29,10 +45,32 @@ export class SelfMailers extends APIResource {
     }
     /**
      * Cancel a self-mailer by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const response = await client.selfMailers.cancel('id');
+     * ```
      */
     cancel(id, options) {
         return this._client.delete(`/self_mailers/${id}`, options);
     }
+    /**
+     * Retrieve a self-mailer preview URL.
+     *
+     * This is only available for customers with our document management addon, which
+     * offers document generation and hosting capabilities. This endpoint has a much
+     * higher rate limit than the regular order retrieval endpoint, so it is suitable
+     * for customer-facing use-cases.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.selfMailers.retrievePreviewURL('id');
+     * ```
+     */
+    retrievePreviewURL(id, options) {
+        return this._client.get(`/self_mailers/${id}/url`, options);
+    }
 }
 export class SelfMailerListResponsesList extends List {
 }

package/resources/self-mailers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.mjs","sourceRoot":"","sources":["../src/resources/self-mailers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;OAQG;IACH,MAAM,CACJ,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAUD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,IAA4B;CAAG;AAs3BhF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"self-mailers.mjs","sourceRoot":"","sources":["../src/resources/self-mailers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAkBD,IAAI,CACF,QAAoD,EAAE,EACtD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,EAAU,EACV,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,IAA4B;CAAG;AAq4BhF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}

package/resources/shared.d.ts

@@ -59,7 +59,9 @@ export interface ContactCreateWithCompanyName {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        [key: string]: unknown;
+    };
     /**
      * Phone number of the contact.
      */
@@ -125,7 +127,9 @@ export interface ContactCreateWithFirstName {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: {
+        [key: string]: unknown;
+    };
     /**
      * Phone number of the contact.
      */

package/resources/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,6BAA6B,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,6BAA6B,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}