@stigg/typescript 0.1.0-beta.55 → 0.1.0-beta.57

package/resources/v1/usage.d.ts

@@ -225,7 +225,10 @@ export declare namespace UsageReportResponse {
          */
         nextResetDate?: string | null;
         /**
-         * Resource id
+         * The customer resource this usage applies to. Optional — only required if the
+         * customer has multiple resources (for example, one subscription per workspace or
+         * site) and usage needs to be tracked separately per resource; omit it to report
+         * usage at the customer level.
          */
         resourceId?: string | null;
         /**
@@ -289,7 +292,10 @@ export interface UsageEstimateParams {
      */
     featureId: string;
     /**
-     * Body param: The value to report for usage
+     * Body param: The value to report for usage. Must be a whole number — the REST API
+     * does not accept fractional (float) usage values; scale up (e.g. report cents
+     * instead of dollars, or milliseconds instead of seconds) if you need sub-unit
+     * precision.
      */
     value: number;
     /**
@@ -299,11 +305,16 @@ export interface UsageEstimateParams {
         [key: string]: string | number | boolean;
     };
     /**
-     * Body param: Resource id
+     * Body param: The customer resource this usage applies to. Optional — only
+     * required if the customer has multiple resources (for example, one subscription
+     * per workspace or site) and usage needs to be tracked separately per resource;
+     * omit it to report usage at the customer level.
      */
     resourceId?: string | null;
     /**
-     * Body param: The method by which the usage value should be updated
+     * Body param: How the reported value is applied: DELTA (default) adds it to the
+     * feature's current usage; SET treats it as the new absolute usage total, and
+     * Stigg computes the delta internally.
      */
     updateBehavior?: 'DELTA' | 'SET';
     /**
@@ -336,7 +347,10 @@ export interface UsageHistoryParams {
      */
     groupBy?: string;
     /**
-     * Query param: Resource id
+     * Query param: The customer resource this usage applies to. Optional — only
+     * required if the customer has multiple resources (for example, one subscription
+     * per workspace or site) and usage needs to be tracked separately per resource;
+     * omit it to report usage at the customer level.
      */
     resourceId?: string | null;
     /**
@@ -382,7 +396,9 @@ export declare namespace UsageReportParams {
          */
         featureId: string;
         /**
-         * The value to report for usage
+         * The value to report for usage. Must be a whole number — the REST API does not
+         * accept fractional (float) usage values; scale up (e.g. report cents instead of
+         * dollars, or milliseconds instead of seconds) if you need sub-unit precision.
          */
         value: number;
         /**
@@ -396,15 +412,22 @@ export declare namespace UsageReportParams {
             [key: string]: string | number | boolean;
         };
         /**
-         * Idempotency key
+         * A key you provide to safely retry the same usage report without double-counting
+         * it. Reports with a previously-seen idempotency key are deduplicated for 7 days;
+         * after that window a retry is treated as new usage.
          */
         idempotencyKey?: string;
         /**
-         * Resource id
+         * The customer resource this usage applies to. Optional — only required if the
+         * customer has multiple resources (for example, one subscription per workspace or
+         * site) and usage needs to be tracked separately per resource; omit it to report
+         * usage at the customer level.
          */
         resourceId?: string | null;
         /**
-         * The method by which the usage value should be updated
+         * How the reported value is applied: DELTA (default) adds it to the feature's
+         * current usage; SET treats it as the new absolute usage total, and Stigg computes
+         * the delta internally.
          */
         updateBehavior?: 'DELTA' | 'SET';
     }

package/resources/v1/usage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAelG;;OAEG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAenC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAc7F;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,qCAAqC,GAAG,mBAAmB,GAAG,0BAA0B,CAAC,CAAC;KAC3G;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,QAAQ;YACvB;;eAEG;YACH,oBAAoB,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAErC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,cAAc,EAAE,OAAO,CAAC;SACzB;QAED,UAAiB,QAAQ,CAAC;YACxB,UAAiB,SAAS;gBACxB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,WAAW,EAAE,yBAAyB,GAAG,IAAI,CAAC;aAC/C;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,gBAAgB,GAAG,2BAA2B,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,YAAY,EAAE,OAAO,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;YAED;;eAEG;YACH,UAAiB,GAAG;gBAClB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;;;;eAKG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE1D;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;KAClC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAelG;;OAEG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAenC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAc7F;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,qCAAqC,GAAG,mBAAmB,GAAG,0BAA0B,CAAC,CAAC;KAC3G;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,QAAQ;YACvB;;eAEG;YACH,oBAAoB,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAErC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,cAAc,EAAE,OAAO,CAAC;SACzB;QAED,UAAiB,QAAQ,CAAC;YACxB,UAAiB,SAAS;gBACxB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,WAAW,EAAE,yBAAyB,GAAG,IAAI,CAAC;aAC/C;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,gBAAgB,GAAG,2BAA2B,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,YAAY,EAAE,OAAO,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;YAED;;eAEG;YACH,UAAiB,GAAG;gBAClB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;;;;eAKG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1D;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE1D;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;;;WAKG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;WAIG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;KAClC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/src/resources/v1/addons/addons.ts

@@ -173,7 +173,11 @@ export class Addons extends APIResource {
   }
 
   /**
-   * Publishes a draft addon, making it available for use in subscriptions.
+   * Publishes a draft addon, making it available for use in subscriptions. The
+   * required `migrationType` field controls whether subscriptions already using this
+   * addon are moved onto the new version immediately (`ALL_CUSTOMERS`) or stay on
+   * the version they were using — grandfathered — until you explicitly migrate them
+   * (`NEW_CUSTOMERS`).
    */
   publish(
     id: string,
@@ -276,7 +280,8 @@ export namespace Addon {
     isLatest: boolean | null;
 
     /**
-     * The maximum quantity of this addon that can be added to a subscription
+     * The maximum quantity of this addon that can be added to a subscription. Leave
+     * unset for no upper bound.
      */
     maxQuantity: number | null;
 
@@ -371,7 +376,8 @@ export interface AddonListResponse {
   isLatest: boolean | null;
 
   /**
-   * The maximum quantity of this addon that can be added to a subscription
+   * The maximum quantity of this addon that can be added to a subscription. Leave
+   * unset for no upper bound.
    */
   maxQuantity: number | null;
 
@@ -452,7 +458,8 @@ export interface AddonListChargesResponse {
   createdAt: string;
 
   /**
-   * ISO country code for localized pricing, if any
+   * ISO country code for localized pricing, or "eu" for the European Union group you
+   * map countries into, if any
    */
   billingCountryCode?: string | null;
 
@@ -1024,7 +1031,7 @@ export interface AddonCreateParams {
 
   /**
    * Body param: The maximum quantity of this addon that can be added to a
-   * subscription
+   * subscription. Leave unset for no upper bound.
    */
   maxQuantity?: number | null;
 
@@ -1079,7 +1086,9 @@ export interface AddonUpdateParams {
   billingId?: string | null;
 
   /**
-   * Body param: Pricing configuration to set on the addon draft
+   * Body param: Pricing configuration to set on the addon draft. Unlike the rest of
+   * this request, this is a full replace of the pricing configuration, not a merge —
+   * see SetPackagePricingRequest.
    */
   charges?: AddonUpdateParams.Charges;
 
@@ -1100,7 +1109,7 @@ export interface AddonUpdateParams {
 
   /**
    * Body param: The maximum quantity of this addon that can be added to a
-   * subscription
+   * subscription. Leave unset for no upper bound.
    */
   maxQuantity?: number | null;
 
@@ -1130,7 +1139,9 @@ export interface AddonUpdateParams {
 
 export namespace AddonUpdateParams {
   /**
-   * Pricing configuration to set on the addon draft
+   * Pricing configuration to set on the addon draft. Unlike the rest of this
+   * request, this is a full replace of the pricing configuration, not a merge — see
+   * SetPackagePricingRequest.
    */
   export interface Charges {
     /**
@@ -1154,12 +1165,14 @@ export namespace AddonUpdateParams {
     overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
 
     /**
-     * Array of overage pricing model configurations
+     * Array of overage pricing model configurations. Replaces all existing overage
+     * pricing models on the draft — omit this to end up with no overage pricing.
      */
     overagePricingModels?: Array<Charges.OveragePricingModel>;
 
     /**
-     * Array of pricing model configurations
+     * Array of pricing model configurations. Replaces all existing base pricing models
+     * on the draft — omit this to end up with no base pricing.
      */
     pricingModels?: Array<Charges.PricingModel>;
   }
@@ -1355,7 +1368,8 @@ export namespace AddonUpdateParams {
         billingPeriod: 'MONTHLY' | 'ANNUALLY';
 
         /**
-         * ISO country code for localized pricing
+         * ISO country code for localized pricing, or "eu" for the European Union group you
+         * map countries into
          */
         billingCountryCode?: string;
 
@@ -2005,7 +2019,8 @@ export namespace AddonUpdateParams {
         billingPeriod: 'MONTHLY' | 'ANNUALLY';
 
         /**
-         * ISO country code for localized pricing
+         * ISO country code for localized pricing, or "eu" for the European Union group you
+         * map countries into
          */
         billingCountryCode?: string;
 
@@ -2618,7 +2633,9 @@ export interface AddonListChargesParams extends MyCursorIDPageParams {
 
 export interface AddonPublishParams {
   /**
-   * Body param: The migration type of the package
+   * Body param: Who the published version applies to: NEW_CUSTOMERS (default) leaves
+   * existing subscribers on their current version, ALL_CUSTOMERS moves them onto the
+   * new version immediately.
    */
   migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
 

package/src/resources/v1/contracts.ts

@@ -78,10 +78,9 @@ export class Contracts extends APIResource {
   }
 
   /**
-   * Retrieves a cursor-paginated list of contracts in the environment, fetched live
-   * from the connected billing provider. Each contract is enriched with a preview of
-   * its upcoming (next) invoice when one is available. Returns an empty list when no
-   * billing provider is connected. Supports filtering by customer external ID,
+   * Retrieves a cursor-paginated list of contracts in the environment. Each contract
+   * that has a billing contract is enriched with a preview of its upcoming (next)
+   * invoice when one is available. Supports filtering by customer external ID,
    * state, and name.
    */
   list(
@@ -301,6 +300,11 @@ export namespace ContractCreateResponse {
        */
       dueDate: string | null;
 
+      /**
+       * The billing provider ID of the draft invoice this preview describes
+       */
+      invoiceId: string | null;
+
       /**
        * The end of the billing period the upcoming invoice covers
        */
@@ -641,6 +645,11 @@ export namespace ContractRetrieveResponse {
        */
       dueDate: string | null;
 
+      /**
+       * The billing provider ID of the draft invoice this preview describes
+       */
+      invoiceId: string | null;
+
       /**
        * The end of the billing period the upcoming invoice covers
        */
@@ -981,6 +990,11 @@ export namespace ContractUpdateResponse {
        */
       dueDate: string | null;
 
+      /**
+       * The billing provider ID of the draft invoice this preview describes
+       */
+      invoiceId: string | null;
+
       /**
        * The end of the billing period the upcoming invoice covers
        */
@@ -1310,6 +1324,11 @@ export namespace ContractListResponse {
      */
     dueDate: string | null;
 
+    /**
+     * The billing provider ID of the draft invoice this preview describes
+     */
+    invoiceId: string | null;
+
     /**
      * The end of the billing period the upcoming invoice covers
      */
@@ -1649,6 +1668,11 @@ export namespace ContractDeleteResponse {
        */
       dueDate: string | null;
 
+      /**
+       * The billing provider ID of the draft invoice this preview describes
+       */
+      invoiceId: string | null;
+
       /**
        * The end of the billing period the upcoming invoice covers
        */
@@ -1821,13 +1845,6 @@ export interface ContractCreateParams {
    */
   customerId: string;
 
-  /**
-   * Body param: The subscriptions to attach to the contract (must be non-empty).
-   * Each entry is either a new subscription to create or a reference to an existing
-   * custom subscription.
-   */
-  subscriptions: Array<ContractCreateParams.Subscription>;
-
   /**
    * Body param: Optional contract activation end date
    */
@@ -1838,6 +1855,15 @@ export interface ContractCreateParams {
    */
   activationStartDate?: string;
 
+  /**
+   * Body param: Your own ID for the contract, which makes this call idempotent:
+   * sending the same one again returns the existing contract instead of creating a
+   * second. Omit it and one is generated for you, but then a retry cannot be told
+   * apart from a new contract — and contracts cannot be deleted. Recommended
+   * whenever a retry is possible, e.g. building a contract from an order form.
+   */
+  contractId?: string;
+
   /**
    * Body param: Optional contract name
    */
@@ -1856,6 +1882,14 @@ export interface ContractCreateParams {
    */
   setupBilling?: boolean;
 
+  /**
+   * Body param: The subscriptions to attach to the contract. Each entry is either a
+   * new subscription to create or a reference to an existing custom subscription.
+   * Optional — omit it (or pass an empty list) to create a contract with no
+   * subscriptions and attach them later.
+   */
+  subscriptions?: Array<ContractCreateParams.Subscription>;
+
   /**
    * Header param: Account ID — optional when authenticating with a user JWT (Bearer
    * token); falls back to the user's first membership. Ignored for API-key auth.
@@ -1922,7 +1956,9 @@ export namespace ContractCreateParams {
       awaitPaymentConfirmation?: boolean;
 
       /**
-       * The ISO 3166-1 alpha-2 country code for billing
+       * The country code used to select a localized price, or "eu" for the European
+       * Union group you map countries into, falling back to the default price when none
+       * matches
        */
       billingCountryCode?: string | null;
 
@@ -1960,7 +1996,8 @@ export namespace ContractCreateParams {
       entitlements?: Array<NewSubscription.Feature | NewSubscription.Credit>;
 
       /**
-       * Additional metadata for the subscription
+       * Additional metadata for the subscription, stored as an arbitrary flat key-value
+       * object.
        */
       metadata?: { [key: string]: string };
 
@@ -2262,7 +2299,8 @@ export namespace ContractCreateParams {
         isInvoicePaid?: boolean;
 
         /**
-         * Additional metadata for the subscription
+         * Additional metadata for the subscription, stored as an arbitrary flat key-value
+         * object.
          */
         metadata?: { [key: string]: string };
 
@@ -2507,6 +2545,11 @@ export namespace ContractCreateParams {
          * SubscriptionCreditEntitlementRequest
          */
         type: 'CREDIT';
+
+        /**
+         * Whether the credit balance is a soft limit
+         */
+        hasSoftLimit?: boolean;
       }
 
       /**
@@ -2657,7 +2700,10 @@ export namespace ContractCreateParams {
         baseCharge?: boolean;
 
         /**
-         * The billing country code of the price
+         * ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
+         * Union group you map countries into. Omit for the default price shown to all
+         * countries; set one or more country-specific price periods on the same currency
+         * to localize the amount by billing country.
          */
         billingCountryCode?: string;
 

package/src/resources/v1/coupons.ts

@@ -135,7 +135,8 @@ export namespace Coupon {
     id: string;
 
     /**
-     * Fixed amount discounts in different currencies
+     * Fixed amount discounts in different currencies. Provide exactly one of
+     * percentOff or amountsOff — not both, not neither.
      */
     amountsOff: Array<Data.AmountsOff> | null;
 
@@ -160,7 +161,9 @@ export namespace Coupon {
     description: string | null;
 
     /**
-     * Duration of the coupon validity in months
+     * How many calendar months the discount applies for once redeemed, counted from
+     * when the coupon is applied (not tied to the subscription's billing period).
+     * Leave unset for a discount that lasts for the lifetime of the subscription.
      */
     durationInMonths: number | null;
 
@@ -175,7 +178,8 @@ export namespace Coupon {
     name: string;
 
     /**
-     * Percentage discount off the original price
+     * Percentage discount off the original price. Provide exactly one of percentOff or
+     * amountsOff — not both, not neither.
      */
     percentOff: number | null;
 
@@ -344,7 +348,8 @@ export interface CouponListResponse {
   id: string;
 
   /**
-   * Fixed amount discounts in different currencies
+   * Fixed amount discounts in different currencies. Provide exactly one of
+   * percentOff or amountsOff — not both, not neither.
    */
   amountsOff: Array<CouponListResponse.AmountsOff> | null;
 
@@ -369,7 +374,9 @@ export interface CouponListResponse {
   description: string | null;
 
   /**
-   * Duration of the coupon validity in months
+   * How many calendar months the discount applies for once redeemed, counted from
+   * when the coupon is applied (not tied to the subscription's billing period).
+   * Leave unset for a discount that lasts for the lifetime of the subscription.
    */
   durationInMonths: number | null;
 
@@ -384,7 +391,8 @@ export interface CouponListResponse {
   name: string;
 
   /**
-   * Percentage discount off the original price
+   * Percentage discount off the original price. Provide exactly one of percentOff or
+   * amountsOff — not both, not neither.
    */
   percentOff: number | null;
 
@@ -549,7 +557,8 @@ export interface CouponCreateParams {
   id: string;
 
   /**
-   * Body param: Fixed amount discounts in different currencies
+   * Body param: Fixed amount discounts in different currencies. Provide exactly one
+   * of percentOff or amountsOff — not both, not neither.
    */
   amountsOff: Array<CouponCreateParams.AmountsOff> | null;
 
@@ -559,7 +568,10 @@ export interface CouponCreateParams {
   description: string | null;
 
   /**
-   * Body param: Duration of the coupon validity in months
+   * Body param: How many calendar months the discount applies for once redeemed,
+   * counted from when the coupon is applied (not tied to the subscription's billing
+   * period). Leave unset for a discount that lasts for the lifetime of the
+   * subscription.
    */
   durationInMonths: number | null;
 
@@ -574,7 +586,8 @@ export interface CouponCreateParams {
   name: string;
 
   /**
-   * Body param: Percentage discount off the original price
+   * Body param: Percentage discount off the original price. Provide exactly one of
+   * percentOff or amountsOff — not both, not neither.
    */
   percentOff: number | null;
 

package/src/resources/v1/credits/grants.ts

@@ -81,14 +81,20 @@ export type GrantListResponsesMyCursorIDPage = MyCursorIDPage<GrantListResponse>
  */
 export interface CreditGrantResponse {
   /**
-   * Credit grant object representing allocated credits for a customer
+   * Credit grant object representing allocated credits for a customer. Credit grants
+   * cannot be edited after creation via this API — void the grant to stop further
+   * consumption from it, then create a new grant with the corrected amount,
+   * priority, or expiration.
    */
   data: CreditGrantResponse.Data;
 }
 
 export namespace CreditGrantResponse {
   /**
-   * Credit grant object representing allocated credits for a customer
+   * Credit grant object representing allocated credits for a customer. Credit grants
+   * cannot be edited after creation via this API — void the grant to stop further
+   * consumption from it, then create a new grant with the corrected amount,
+   * priority, or expiration.
    */
   export interface Data {
     /**
@@ -187,7 +193,11 @@ export namespace CreditGrantResponse {
     sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT' | null;
 
     /**
-     * The effective status of the credit grant
+     * The effective status of the credit grant. A grant with paymentCollectionMethod
+     * NONE or CHARGE becomes ACTIVE (and its credits become usable) as soon as it's
+     * created (or as soon as the charge succeeds). A grant with
+     * paymentCollectionMethod INVOICE stays PAYMENT_PENDING — its credits are not
+     * usable — until the invoice is paid.
      */
     status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED';
 
@@ -305,12 +315,14 @@ export namespace CreditGrantResponse {
       status: 'PENDING' | 'ERROR' | 'SUCCESS' | 'NO_SYNC_REQUIRED';
 
       /**
-       * Synced entity id
+       * The external entity ID this record is linked to in the vendor system (e.g. the
+       * Stripe customer ID). Null until the link has synced; required when creating the
+       * link.
        */
       syncedEntityId: string | null;
 
       /**
-       * The vendor identifier of integration
+       * The vendor identifier of the integration (e.g. STRIPE, SALESFORCE, SNOWFLAKE)
        */
       vendorIdentifier:
         | 'AUTH0'
@@ -332,7 +344,10 @@ export namespace CreditGrantResponse {
 }
 
 /**
- * Credit grant object representing allocated credits for a customer
+ * Credit grant object representing allocated credits for a customer. Credit grants
+ * cannot be edited after creation via this API — void the grant to stop further
+ * consumption from it, then create a new grant with the corrected amount,
+ * priority, or expiration.
  */
 export interface GrantListResponse {
   /**
@@ -431,7 +446,11 @@ export interface GrantListResponse {
   sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT' | null;
 
   /**
-   * The effective status of the credit grant
+   * The effective status of the credit grant. A grant with paymentCollectionMethod
+   * NONE or CHARGE becomes ACTIVE (and its credits become usable) as soon as it's
+   * created (or as soon as the charge succeeds). A grant with
+   * paymentCollectionMethod INVOICE stays PAYMENT_PENDING — its credits are not
+   * usable — until the invoice is paid.
    */
   status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED';
 
@@ -549,12 +568,14 @@ export namespace GrantListResponse {
     status: 'PENDING' | 'ERROR' | 'SUCCESS' | 'NO_SYNC_REQUIRED';
 
     /**
-     * Synced entity id
+     * The external entity ID this record is linked to in the vendor system (e.g. the
+     * Stripe customer ID). Null until the link has synced; required when creating the
+     * link.
      */
     syncedEntityId: string | null;
 
     /**
-     * The vendor identifier of integration
+     * The vendor identifier of the integration (e.g. STRIPE, SALESFORCE, SNOWFLAKE)
      */
     vendorIdentifier:
       | 'AUTH0'
@@ -602,12 +623,16 @@ export interface GrantCreateParams {
 
   /**
    * Body param: Whether to wait for payment confirmation before returning (default:
-   * true)
+   * true). When false, the request returns immediately while payment (if any) is
+   * collected asynchronously; check the returned status to see whether the credits
+   * are already usable.
    */
   awaitPaymentConfirmation?: boolean;
 
   /**
-   * Body param: Billing information for the credit grant
+   * Body param: Billing information for the credit grant, used when the grant has a
+   * payment collection method that requires collecting payment (e.g. invoice due
+   * date, billing address).
    */
   billingInformation?: GrantCreateParams.BillingInformation;
 
@@ -637,12 +662,22 @@ export interface GrantCreateParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param: The payment collection method (CHARGE, INVOICE, NONE)
+   * Body param: The payment collection method (CHARGE, INVOICE, NONE). Optional if
+   * the grant has no `cost`, since there is nothing to collect payment for. With
+   * NONE or CHARGE, the grant is active and its credits are usable right away (or as
+   * soon as the charge succeeds). With INVOICE, the grant stays pending — its
+   * credits are not usable — until the generated invoice is paid.
    */
   paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
 
   /**
-   * Body param: The priority of the credit grant (lower number = higher priority)
+   * Body param: Determines which grant is drawn down first when the customer has
+   * multiple active grants in the same currency (0-100). Lower numbers are consumed
+   * first. Defaults to 50 — the same default used for recurring credits granted by a
+   * plan or price — so without setting this explicitly, draw order against
+   * plan-included credits falls back to expiration date and grant type. To have this
+   * grant consumed before or after plan-included credits, set a lower or higher
+   * priority than the plan/price credit configuration.
    */
   priority?: number;
 
@@ -667,7 +702,9 @@ export interface GrantCreateParams {
 
 export namespace GrantCreateParams {
   /**
-   * Billing information for the credit grant
+   * Billing information for the credit grant, used when the grant has a payment
+   * collection method that requires collecting payment (e.g. invoice due date,
+   * billing address).
    */
   export interface BillingInformation {
     /**