dodopayments 2.39.0 → 2.40.0

package/resources/credit-entitlements/balances.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"balances.d.ts","sourceRoot":"","sources":["../../src/resources/credit-entitlements/balances.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,iCAA8B;AAC/B,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,mBAAmB,EAAE,MAAM,EAC3B,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iDAAiD,EAAE,qBAAqB,CAAC;IAQxF;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qDAAqD,EAAE,yBAAyB,CAAC;IAShG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,iBAAiB,CAAC;IASjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAOhD;AAED,MAAM,MAAM,iDAAiD,GAC3D,2BAA2B,CAAC,qBAAqB,CAAC,CAAC;AAErD,MAAM,MAAM,qDAAqD,GAC/D,2BAA2B,CAAC,yBAAyB,CAAC,CAAC;AAEzD,MAAM,MAAM,8CAA8C,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;AAE5G;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,OAAO,CAAC;IAEnB,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB,gBAAgB,EACZ,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,QAAQ,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,eAAe,CAAC;IAE5B,SAAS,EAAE,OAAO,CAAC;IAEnB,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,OAAO,CAAC;IAEpB,cAAc,EAAE,OAAO,CAAC;IAExB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,cAAc,EAAE,MAAM,CAAC;IAEvB,WAAW,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,UAAU,CAAC;IAExE,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAkB,SAAQ,iCAAiC;IAC1E;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAwB,SAAQ,iCAAiC;IAChF;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;CAC5C;AAED,MAAM,WAAW,uBAAwB,SAAQ,iCAAiC;IAChF;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,eAAe,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"balances.d.ts","sourceRoot":"","sources":["../../src/resources/credit-entitlements/balances.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,OAAO,mBAAgB;AACnC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,iCAA8B;AAC/B,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,IAAI,CACF,mBAAmB,EAAE,MAAM,EAC3B,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iDAAiD,EAAE,qBAAqB,CAAC;IAQxF;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qDAAqD,EAAE,yBAAyB,CAAC;IAShG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8CAA8C,EAAE,iBAAiB,CAAC;IASjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAOhD;AAED,MAAM,MAAM,iDAAiD,GAC3D,2BAA2B,CAAC,qBAAqB,CAAC,CAAC;AAErD,MAAM,MAAM,qDAAqD,GAC/D,2BAA2B,CAAC,yBAAyB,CAAC,CAAC;AAEzD,MAAM,MAAM,8CAA8C,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;AAE5G;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAE3B,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB,gBAAgB,EACZ,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,QAAQ,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,eAAe,CAAC;IAE5B,SAAS,EAAE,OAAO,CAAC;IAEnB,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,qBAAqB,EAAE,MAAM,CAAC;IAE9B,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,OAAO,CAAC;IAEpB,cAAc,EAAE,OAAO,CAAC;IAExB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,cAAc,EAAE,MAAM,CAAC;IAEvB,WAAW,EAAE,cAAc,GAAG,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,UAAU,CAAC;IAExE,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAkB,SAAQ,iCAAiC;IAC1E;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAwB,SAAQ,iCAAiC;IAChF;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;CAC5C;AAED,MAAM,WAAW,uBAAwB,SAAQ,iCAAiC;IAChF;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,eAAe,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/credit-entitlements/balances.js

@@ -29,6 +29,16 @@ class Balances extends resource_1.APIResource {
      * - `200 OK` - Returns list of customer balances
      * - `404 Not Found` - Credit entitlement not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerCreditBalance of client.creditEntitlements.balances.list(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(creditEntitlementID, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/credit-entitlements/${creditEntitlementID}/balances`, (pagination_1.DefaultPageNumberPagination), { query, ...options });
@@ -51,6 +61,15 @@ class Balances extends resource_1.APIResource {
      * - `200 OK` - Returns the customer's balance
      * - `404 Not Found` - Credit entitlement or customer balance not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * const customerCreditBalance =
+     *   await client.creditEntitlements.balances.retrieve(
+     *     'cus_TV52uJWWXt2yIoBBxpjaa',
+     *     { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
+     *   );
+     * ```
      */
     retrieve(customerID, params, options) {
         const { credit_entitlement_id } = params;
@@ -79,6 +98,17 @@ class Balances extends resource_1.APIResource {
      * - `200 OK` - Returns list of grants
      * - `404 Not Found` - Credit entitlement not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const balanceListGrantsResponse of client.creditEntitlements.balances.listGrants(
+     *   'cus_TV52uJWWXt2yIoBBxpjaa',
+     *   { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listGrants(customerID, params, options) {
         const { credit_entitlement_id, ...query } = params;
@@ -109,6 +139,17 @@ class Balances extends resource_1.APIResource {
      * - `200 OK` - Returns list of ledger entries
      * - `404 Not Found` - Credit entitlement not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditLedgerEntry of client.creditEntitlements.balances.listLedger(
+     *   'cus_TV52uJWWXt2yIoBBxpjaa',
+     *   { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listLedger(customerID, params, options) {
         const { credit_entitlement_id, ...query } = params;
@@ -142,6 +183,19 @@ class Balances extends resource_1.APIResource {
      * - `404 Not Found` - Credit entitlement or customer not found
      * - `409 Conflict` - Idempotency key already exists
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.creditEntitlements.balances.createLedgerEntry(
+     *     'cus_TV52uJWWXt2yIoBBxpjaa',
+     *     {
+     *       credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM',
+     *       amount: 'amount',
+     *       entry_type: 'credit',
+     *     },
+     *   );
+     * ```
      */
     createLedgerEntry(customerID, params, options) {
         const { credit_entitlement_id, ...body } = params;

package/resources/credit-entitlements/balances.js.map

@@ -1 +1 @@
-{"version":3,"file":"balances.js","sourceRoot":"","sources":["../../src/resources/credit-entitlements/balances.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAI+B;AAE/B,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,mBAA2B,EAC3B,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,wBAAwB,mBAAmB,WAAW,EAC1D,CAAA,wCAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,EAAE,EAC1E,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,wCAAsD,CAAA,EACtD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,wCAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,iBAAiB,CACf,UAAkB,EAClB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,iBAAiB,EACzF,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF;AAxLD,4BAwLC"}
+{"version":3,"file":"balances.js","sourceRoot":"","sources":["../../src/resources/credit-entitlements/balances.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAI+B;AAE/B,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,IAAI,CACF,mBAA2B,EAC3B,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,wBAAwB,mBAAmB,WAAW,EAC1D,CAAA,wCAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CACN,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,EAAE,EAC1E,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,wCAAsD,CAAA,EACtD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,wCAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,iBAAiB,CACf,UAAkB,EAClB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,WAAI,EAAA,wBAAwB,qBAAqB,aAAa,UAAU,iBAAiB,EACzF,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF;AA9OD,4BA8OC"}

package/resources/credit-entitlements/balances.mjs

@@ -26,6 +26,16 @@ export class Balances extends APIResource {
      * - `200 OK` - Returns list of customer balances
      * - `404 Not Found` - Credit entitlement not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerCreditBalance of client.creditEntitlements.balances.list(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(creditEntitlementID, query = {}, options) {
         return this._client.getAPIList(path `/credit-entitlements/${creditEntitlementID}/balances`, (DefaultPageNumberPagination), { query, ...options });
@@ -48,6 +58,15 @@ export class Balances extends APIResource {
      * - `200 OK` - Returns the customer's balance
      * - `404 Not Found` - Credit entitlement or customer balance not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * const customerCreditBalance =
+     *   await client.creditEntitlements.balances.retrieve(
+     *     'cus_TV52uJWWXt2yIoBBxpjaa',
+     *     { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
+     *   );
+     * ```
      */
     retrieve(customerID, params, options) {
         const { credit_entitlement_id } = params;
@@ -76,6 +95,17 @@ export class Balances extends APIResource {
      * - `200 OK` - Returns list of grants
      * - `404 Not Found` - Credit entitlement not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const balanceListGrantsResponse of client.creditEntitlements.balances.listGrants(
+     *   'cus_TV52uJWWXt2yIoBBxpjaa',
+     *   { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listGrants(customerID, params, options) {
         const { credit_entitlement_id, ...query } = params;
@@ -106,6 +136,17 @@ export class Balances extends APIResource {
      * - `200 OK` - Returns list of ledger entries
      * - `404 Not Found` - Credit entitlement not found
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditLedgerEntry of client.creditEntitlements.balances.listLedger(
+     *   'cus_TV52uJWWXt2yIoBBxpjaa',
+     *   { credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listLedger(customerID, params, options) {
         const { credit_entitlement_id, ...query } = params;
@@ -139,6 +180,19 @@ export class Balances extends APIResource {
      * - `404 Not Found` - Credit entitlement or customer not found
      * - `409 Conflict` - Idempotency key already exists
      * - `500 Internal Server Error` - Database or server error
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.creditEntitlements.balances.createLedgerEntry(
+     *     'cus_TV52uJWWXt2yIoBBxpjaa',
+     *     {
+     *       credit_entitlement_id: 'cde_ztxm5XJsKxWucRWA3rjdM',
+     *       amount: 'amount',
+     *       entry_type: 'credit',
+     *     },
+     *   );
+     * ```
      */
     createLedgerEntry(customerID, params, options) {
         const { credit_entitlement_id, ...body } = params;

package/resources/credit-entitlements/balances.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"balances.mjs","sourceRoot":"","sources":["../../src/resources/credit-entitlements/balances.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EACL,2BAA2B,GAG5B,kCAA8B;AAE/B,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,mBAA2B,EAC3B,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,wBAAwB,mBAAmB,WAAW,EAC1D,CAAA,2BAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,EAAE,EAC1E,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,2BAAsD,CAAA,EACtD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,2BAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,iBAAiB,CACf,UAAkB,EAClB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,iBAAiB,EACzF,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"balances.mjs","sourceRoot":"","sources":["../../src/resources/credit-entitlements/balances.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EACL,2BAA2B,GAG5B,kCAA8B;AAE/B,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,IAAI,CACF,mBAA2B,EAC3B,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,wBAAwB,mBAAmB,WAAW,EAC1D,CAAA,2BAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CACN,UAAkB,EAClB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,EAAE,EAC1E,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,2BAAsD,CAAA,EACtD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,UAAU,CACR,UAAkB,EAClB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,SAAS,EACjF,CAAA,2BAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,iBAAiB,CACf,UAAkB,EAClB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAA,wBAAwB,qBAAqB,aAAa,UAAU,iBAAiB,EACzF,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF"}

package/resources/credit-entitlements/credit-entitlements.d.mts

@@ -35,6 +35,14 @@ export declare class CreditEntitlements extends APIResource {
      * - Only entitlements belonging to the authenticated business are returned
      * - The `deleted` parameter controls visibility of soft-deleted entitlements
      * - Pagination uses offset-based pagination (offset = page_number \* page_size)
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditEntitlement of client.creditEntitlements.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CreditEntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<CreditEntitlementsDefaultPageNumberPagination, CreditEntitlement>;
     /**
@@ -81,6 +89,18 @@ export declare class CreditEntitlements extends APIResource {
      * - price_per_unit is required when overage_enabled is true
      * - rollover_timeframe_count and rollover_timeframe_interval must both be set or
      *   both be null
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.create({
+     *     name: 'name',
+     *     overage_enabled: true,
+     *     precision: 0,
+     *     rollover_enabled: true,
+     *     unit: 'unit',
+     *   });
+     * ```
      */
     create(body: CreditEntitlementCreateParams, options?: RequestOptions): APIPromise<CreditEntitlement>;
     /**
@@ -108,8 +128,24 @@ export declare class CreditEntitlements extends APIResource {
      * - The entitlement must belong to the authenticated business (business_id check)
      * - Deleted entitlements return a 404 error and must be retrieved via the list
      *   endpoint with `deleted=true`
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.retrieve(
+     *     'cde_ztxm5XJsKxWucRWA3rjdM',
+     *   );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<CreditEntitlement>;
+    /**
+     * @example
+     * ```ts
+     * await client.creditEntitlements.delete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
+     */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Allows partial updates to a credit entitlement's configuration. Only the fields
@@ -168,6 +204,13 @@ export declare class CreditEntitlements extends APIResource {
      *   credit grants
      * - The merged state is validated: currency required with price, rollover
      *   timeframe fields together, price required for overage
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.update(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     update(id: string, body: CreditEntitlementUpdateParams, options?: RequestOptions): APIPromise<void>;
     /**
@@ -211,6 +254,13 @@ export declare class CreditEntitlements extends APIResource {
      *
      * Callers should verify the entitlement exists and is deleted before calling this
      * endpoint.
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.undelete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     undelete(id: string, options?: RequestOptions): APIPromise<void>;
 }

package/resources/credit-entitlements/credit-entitlements.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"credit-entitlements.d.mts","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,OAAO,oBAAgB;AACnC,OAAO,KAAK,gBAAgB,6BAAyB;AACrD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,8BAA8B,EAC9B,gCAAgC,EAChC,uBAAuB,EACvB,yBAAyB,EACzB,qDAAqD,EACrD,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,QAAQ,EACR,8CAA8C,EAC9C,iBAAiB,EACjB,qBAAqB,EACrB,iDAAiD,EACjD,eAAe,EAChB,uBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,kCAA8B;AAE/B,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,CACF,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,iBAAiB,CAAC;IAOhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIpG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7E,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,MAAM,6CAA6C,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;AAE3G;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,oBAAoB,GACpB,eAAe,GACf,0BAA0B,CAAC;AAE/B,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAC;IAErC,eAAe,EAAE,OAAO,CAAC;IAEzB,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,2BAA4B,SAAQ,iCAAiC;IACpF;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"credit-entitlements.d.mts","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,OAAO,oBAAgB;AACnC,OAAO,KAAK,gBAAgB,6BAAyB;AACrD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,8BAA8B,EAC9B,gCAAgC,EAChC,uBAAuB,EACvB,yBAAyB,EACzB,qDAAqD,EACrD,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,QAAQ,EACR,8CAA8C,EAC9C,iBAAiB,EACjB,qBAAqB,EACrB,iDAAiD,EACjD,eAAe,EAChB,uBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,kCAA8B;AAE/B,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,iBAAiB,CAAC;IAOhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,MAAM,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIpG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7E;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,MAAM,6CAA6C,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;AAE3G;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,oBAAoB,GACpB,eAAe,GACf,0BAA0B,CAAC;AAE/B,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAC;IAErC,eAAe,EAAE,OAAO,CAAC;IAEzB,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,2BAA4B,SAAQ,iCAAiC;IACpF;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/credit-entitlements/credit-entitlements.d.ts

@@ -35,6 +35,14 @@ export declare class CreditEntitlements extends APIResource {
      * - Only entitlements belonging to the authenticated business are returned
      * - The `deleted` parameter controls visibility of soft-deleted entitlements
      * - Pagination uses offset-based pagination (offset = page_number \* page_size)
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditEntitlement of client.creditEntitlements.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CreditEntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<CreditEntitlementsDefaultPageNumberPagination, CreditEntitlement>;
     /**
@@ -81,6 +89,18 @@ export declare class CreditEntitlements extends APIResource {
      * - price_per_unit is required when overage_enabled is true
      * - rollover_timeframe_count and rollover_timeframe_interval must both be set or
      *   both be null
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.create({
+     *     name: 'name',
+     *     overage_enabled: true,
+     *     precision: 0,
+     *     rollover_enabled: true,
+     *     unit: 'unit',
+     *   });
+     * ```
      */
     create(body: CreditEntitlementCreateParams, options?: RequestOptions): APIPromise<CreditEntitlement>;
     /**
@@ -108,8 +128,24 @@ export declare class CreditEntitlements extends APIResource {
      * - The entitlement must belong to the authenticated business (business_id check)
      * - Deleted entitlements return a 404 error and must be retrieved via the list
      *   endpoint with `deleted=true`
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.retrieve(
+     *     'cde_ztxm5XJsKxWucRWA3rjdM',
+     *   );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<CreditEntitlement>;
+    /**
+     * @example
+     * ```ts
+     * await client.creditEntitlements.delete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
+     */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Allows partial updates to a credit entitlement's configuration. Only the fields
@@ -168,6 +204,13 @@ export declare class CreditEntitlements extends APIResource {
      *   credit grants
      * - The merged state is validated: currency required with price, rollover
      *   timeframe fields together, price required for overage
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.update(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     update(id: string, body: CreditEntitlementUpdateParams, options?: RequestOptions): APIPromise<void>;
     /**
@@ -211,6 +254,13 @@ export declare class CreditEntitlements extends APIResource {
      *
      * Callers should verify the entitlement exists and is deleted before calling this
      * endpoint.
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.undelete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     undelete(id: string, options?: RequestOptions): APIPromise<void>;
 }

package/resources/credit-entitlements/credit-entitlements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"credit-entitlements.d.ts","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,OAAO,mBAAgB;AACnC,OAAO,KAAK,gBAAgB,4BAAyB;AACrD,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EACL,8BAA8B,EAC9B,gCAAgC,EAChC,uBAAuB,EACvB,yBAAyB,EACzB,qDAAqD,EACrD,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,QAAQ,EACR,8CAA8C,EAC9C,iBAAiB,EACjB,qBAAqB,EACrB,iDAAiD,EACjD,eAAe,EAChB,sBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,iCAA8B;AAE/B,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,CACF,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,iBAAiB,CAAC;IAOhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIpG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7E,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,MAAM,6CAA6C,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;AAE3G;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,oBAAoB,GACpB,eAAe,GACf,0BAA0B,CAAC;AAE/B,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAC;IAErC,eAAe,EAAE,OAAO,CAAC;IAEzB,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,2BAA4B,SAAQ,iCAAiC;IACpF;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"credit-entitlements.d.ts","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,OAAO,mBAAgB;AACnC,OAAO,KAAK,gBAAgB,4BAAyB;AACrD,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EACL,8BAA8B,EAC9B,gCAAgC,EAChC,uBAAuB,EACvB,yBAAyB,EACzB,qDAAqD,EACrD,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,QAAQ,EACR,8CAA8C,EAC9C,iBAAiB,EACjB,qBAAqB,EACrB,iDAAiD,EACjD,eAAe,EAChB,sBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ,iCAA8B;AAE/B,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,iBAAiB,CAAC;IAOhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,MAAM,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIpG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7E;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,MAAM,6CAA6C,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;AAE3G;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,GAClB,oBAAoB,GACpB,eAAe,GACf,0BAA0B,CAAC;AAE/B,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAC;IAErC,eAAe,EAAE,OAAO,CAAC;IAEzB,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,2BAA4B,SAAQ,iCAAiC;IACpF;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,2BAA2B,CAAC,EAAE,gBAAgB,CAAC,YAAY,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,8CAA8C,IAAI,8CAA8C,EACrG,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/credit-entitlements/credit-entitlements.js

@@ -41,6 +41,14 @@ class CreditEntitlements extends resource_1.APIResource {
      * - Only entitlements belonging to the authenticated business are returned
      * - The `deleted` parameter controls visibility of soft-deleted entitlements
      * - Pagination uses offset-based pagination (offset = page_number \* page_size)
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditEntitlement of client.creditEntitlements.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/credit-entitlements', (pagination_1.DefaultPageNumberPagination), {
@@ -92,6 +100,18 @@ class CreditEntitlements extends resource_1.APIResource {
      * - price_per_unit is required when overage_enabled is true
      * - rollover_timeframe_count and rollover_timeframe_interval must both be set or
      *   both be null
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.create({
+     *     name: 'name',
+     *     overage_enabled: true,
+     *     precision: 0,
+     *     rollover_enabled: true,
+     *     unit: 'unit',
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/credit-entitlements', { body, ...options });
@@ -121,10 +141,26 @@ class CreditEntitlements extends resource_1.APIResource {
      * - The entitlement must belong to the authenticated business (business_id check)
      * - Deleted entitlements return a 404 error and must be retrieved via the list
      *   endpoint with `deleted=true`
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.retrieve(
+     *     'cde_ztxm5XJsKxWucRWA3rjdM',
+     *   );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/credit-entitlements/${id}`, options);
     }
+    /**
+     * @example
+     * ```ts
+     * await client.creditEntitlements.delete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
+     */
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/credit-entitlements/${id}`, {
             ...options,
@@ -188,6 +224,13 @@ class CreditEntitlements extends resource_1.APIResource {
      *   credit grants
      * - The merged state is validated: currency required with price, rollover
      *   timeframe fields together, price required for overage
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.update(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     update(id, body, options) {
         return this._client.patch((0, path_1.path) `/credit-entitlements/${id}`, {
@@ -237,6 +280,13 @@ class CreditEntitlements extends resource_1.APIResource {
      *
      * Callers should verify the entitlement exists and is deleted before calling this
      * endpoint.
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.undelete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     undelete(id, options) {
         return this._client.post((0, path_1.path) `/credit-entitlements/${id}/undelete`, {

package/resources/credit-entitlements/credit-entitlements.js.map

@@ -1 +1 @@
-{"version":3,"file":"credit-entitlements.js","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,mEAA0C;AAC1C,4CAeoB;AAEpB,yDAI+B;AAC/B,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,kBAAmB,SAAQ,sBAAW;IAAnD;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgP1E,CAAC;IA9OC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,CACF,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAA,wCAA8C,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,IAAmC,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,MAAM,CAAC,EAAU,EAAE,IAAmC,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE;YAC1D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,WAAW,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAjPD,gDAiPC;AA+ND,kBAAkB,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
+{"version":3,"file":"credit-entitlements.js","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,mEAA0C;AAC1C,4CAeoB;AAEpB,yDAI+B;AAC/B,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,kBAAmB,SAAQ,sBAAW;IAAnD;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkS1E,CAAC;IAhSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAA,wCAA8C,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,MAAM,CAAC,IAAmC,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,EAAU,EAAE,IAAmC,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,EAAE,EAAE;YAC1D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,WAAW,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAnSD,gDAmSC;AA+ND,kBAAkB,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}

package/resources/credit-entitlements/credit-entitlements.mjs

@@ -37,6 +37,14 @@ export class CreditEntitlements extends APIResource {
      * - Only entitlements belonging to the authenticated business are returned
      * - The `deleted` parameter controls visibility of soft-deleted entitlements
      * - Pagination uses offset-based pagination (offset = page_number \* page_size)
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditEntitlement of client.creditEntitlements.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/credit-entitlements', (DefaultPageNumberPagination), {
@@ -88,6 +96,18 @@ export class CreditEntitlements extends APIResource {
      * - price_per_unit is required when overage_enabled is true
      * - rollover_timeframe_count and rollover_timeframe_interval must both be set or
      *   both be null
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.create({
+     *     name: 'name',
+     *     overage_enabled: true,
+     *     precision: 0,
+     *     rollover_enabled: true,
+     *     unit: 'unit',
+     *   });
+     * ```
      */
     create(body, options) {
         return this._client.post('/credit-entitlements', { body, ...options });
@@ -117,10 +137,26 @@ export class CreditEntitlements extends APIResource {
      * - The entitlement must belong to the authenticated business (business_id check)
      * - Deleted entitlements return a 404 error and must be retrieved via the list
      *   endpoint with `deleted=true`
+     *
+     * @example
+     * ```ts
+     * const creditEntitlement =
+     *   await client.creditEntitlements.retrieve(
+     *     'cde_ztxm5XJsKxWucRWA3rjdM',
+     *   );
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(path `/credit-entitlements/${id}`, options);
     }
+    /**
+     * @example
+     * ```ts
+     * await client.creditEntitlements.delete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
+     */
     delete(id, options) {
         return this._client.delete(path `/credit-entitlements/${id}`, {
             ...options,
@@ -184,6 +220,13 @@ export class CreditEntitlements extends APIResource {
      *   credit grants
      * - The merged state is validated: currency required with price, rollover
      *   timeframe fields together, price required for overage
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.update(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     update(id, body, options) {
         return this._client.patch(path `/credit-entitlements/${id}`, {
@@ -233,6 +276,13 @@ export class CreditEntitlements extends APIResource {
      *
      * Callers should verify the entitlement exists and is deleted before calling this
      * endpoint.
+     *
+     * @example
+     * ```ts
+     * await client.creditEntitlements.undelete(
+     *   'cde_ztxm5XJsKxWucRWA3rjdM',
+     * );
+     * ```
      */
     undelete(id, options) {
         return this._client.post(path `/credit-entitlements/${id}/undelete`, {

package/resources/credit-entitlements/credit-entitlements.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"credit-entitlements.mjs","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EASL,QAAQ,GAMT,uBAAmB;AAEpB,OAAO,EACL,2BAA2B,GAG5B,kCAA8B;AAC/B,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAAnD;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgP1E,CAAC;IA9OC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,CACF,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAA,2BAA8C,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,IAAmC,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,MAAM,CAAC,EAAU,EAAE,IAAmC,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE;YAC1D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,EAAE,WAAW,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA+ND,kBAAkB,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"credit-entitlements.mjs","sourceRoot":"","sources":["../../src/resources/credit-entitlements/credit-entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EASL,QAAQ,GAMT,uBAAmB;AAEpB,OAAO,EACL,2BAA2B,GAG5B,kCAA8B;AAC/B,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAAnD;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkS1E,CAAC;IAhSC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,IAAI,CACF,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAA,2BAA8C,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,MAAM,CAAC,IAAmC,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,EAAU,EAAE,IAAmC,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE;YAC1D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,EAAE,WAAW,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA+ND,kBAAkB,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/resources/customers/customer-portal.d.mts

@@ -3,6 +3,15 @@ import * as CustomersAPI from "./customers.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class CustomerPortal extends APIResource {
+    /**
+     * @example
+     * ```ts
+     * const customerPortalSession =
+     *   await client.customers.customerPortal.create(
+     *     'cus_TV52uJWWXt2yIoBBxpjaa',
+     *   );
+     * ```
+     */
     create(customerID: string, params?: CustomerPortalCreateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.CustomerPortalSession>;
 }
 export interface CustomerPortalCreateParams {