@schematichq/schematic-typescript-node 1.6.2 → 1.6.4

package/README.md

@@ -781,12 +781,27 @@ const client = new SchematicClient({
     dataStream: {
         replicatorMode: true,
         redisClient,
-        replicatorHealthURL: "http://localhost:8080/health",
-        replicatorHealthCheck: 30000, // 30 seconds
     },
 });
 ```
 
+In replicator mode the SDK polls the replicator's health endpoint to learn when it is ready and which cache version it is writing. The health URL defaults to `http://localhost:8090/ready` and the polling interval defaults to 30 seconds, matching the other Schematic SDKs. If your replicator runs elsewhere, set `replicatorHealthURL` explicitly:
+
+```ts
+const client = new SchematicClient({
+    apiKey: process.env.SCHEMATIC_API_KEY,
+    useDataStream: true,
+    dataStream: {
+        replicatorMode: true,
+        redisClient,
+        replicatorHealthURL: "http://my-replicator:8090/ready",
+        replicatorHealthCheck: 60000, // 60 seconds
+    },
+});
+```
+
+Until a health check succeeds, the SDK treats the replicator as not ready: bulk flag checks bypass the shared cache, `track` skips local metric updates, and cache keys use the SDK's own rules engine version rather than the replicator's cache version.
+
 ### Configuration options
 
 | Option | Type | Default | Description |
@@ -794,7 +809,7 @@ const client = new SchematicClient({
 | `replicatorMode` | `boolean` | `false` | Enable replicator mode |
 | `redisClient` | `RedisClient` | — | **Required.** Redis client for reading from the shared cache |
 | `redisKeyPrefix` | `string` | `schematic:` | Key prefix for Redis cache entries |
-| `replicatorHealthURL` | `string` | — | URL to poll for replicator health status |
+| `replicatorHealthURL` | `string` | `http://localhost:8090/ready` | URL to poll for replicator health status (default applies in replicator mode only) |
 | `replicatorHealthCheck` | `number` | 30000 | Health check polling interval in milliseconds |
 | `cacheTTL` | `number` | 24 hours | Cache TTL in milliseconds |
 

package/dist/api/resources/accounts/client/requests/UpdateEnvironmentRequestBody.d.ts

@@ -6,4 +6,5 @@ import type * as Schematic from "../../../../index";
 export interface UpdateEnvironmentRequestBody {
     environmentType?: Schematic.EnvironmentType;
     name?: string;
+    requireContextSignature?: boolean;
 }

package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts

@@ -26,5 +26,6 @@ export interface CreateInvoiceRequestBody {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    total?: number;
     url?: string;
 }

package/dist/api/resources/credits/client/Client.d.ts

@@ -672,8 +672,7 @@ export declare class CreditsClient {
      *
      * @example
      *     await client.credits.createCreditSpendPolicy({
-     *         billingCreditId: "billing_credit_id",
-     *         maxPerDraw: 1.1
+     *         billingCreditId: "billing_credit_id"
      *     })
      */
     createCreditSpendPolicy(request: Schematic.CreateCreditSpendPolicyRequestBody, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCreditSpendPolicyResponse>;
@@ -754,6 +753,27 @@ export declare class CreditsClient {
      */
     countCreditSpendPolicies(request?: Schematic.CountCreditSpendPoliciesRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditSpendPoliciesResponse>;
     private __countCreditSpendPolicies;
+    /**
+     * @param {Schematic.GetCreditSpendPolicyUsageRequest} request
+     * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.credits.getCreditSpendPolicyUsage({
+     *         billingCreditId: "billing_credit_id",
+     *         companyId: "company_id",
+     *         userIds: ["user_ids"]
+     *     })
+     */
+    getCreditSpendPolicyUsage(request: Schematic.GetCreditSpendPolicyUsageRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditSpendPolicyUsageResponse>;
+    private __getCreditSpendPolicyUsage;
     /**
      * @param {Schematic.ListCreditEventLedgerRequest} request
      * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -771,7 +791,7 @@ export declare class CreditsClient {
      *         billingCreditId: "billing_credit_id",
      *         companyId: "company_id",
      *         endTime: "end_time",
-     *         eventType: "grant",
+     *         eventType: "adjustment",
      *         featureId: "feature_id",
      *         startTime: "start_time",
      *         limit: 1000000,
@@ -797,7 +817,7 @@ export declare class CreditsClient {
      *         billingCreditId: "billing_credit_id",
      *         companyId: "company_id",
      *         endTime: "end_time",
-     *         eventType: "grant",
+     *         eventType: "adjustment",
      *         featureId: "feature_id",
      *         startTime: "start_time",
      *         limit: 1000000,

package/dist/api/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts

@@ -12,4 +12,6 @@ export interface AcquireCreditLeaseRequestBody {
     /** When the hold lapses if the lease is never released; defaults to five minutes from now and may be at most one hour out. The unspent hold is refunded on expiry */
     expiresAt?: Date;
     requestedAmount: number;
+    /** The user drawing the hold, so a user-scope spend policy applies to it */
+    userId?: string;
 }

package/dist/api/resources/credits/client/requests/CountCreditEventLedgerRequest.d.ts

@@ -5,7 +5,7 @@ import type * as Schematic from "../../../../index";
  *         billingCreditId: "billing_credit_id",
  *         companyId: "company_id",
  *         endTime: "end_time",
- *         eventType: "grant",
+ *         eventType: "adjustment",
  *         featureId: "feature_id",
  *         startTime: "start_time",
  *         limit: 1000000,

package/dist/api/resources/credits/client/requests/CreateCreditSpendPolicyRequestBody.d.ts

@@ -1,8 +1,8 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
- *         billingCreditId: "billing_credit_id",
- *         maxPerDraw: 1.1
+ *         billingCreditId: "billing_credit_id"
  *     }
  */
 export interface CreateCreditSpendPolicyRequestBody {
@@ -10,8 +10,12 @@ export interface CreateCreditSpendPolicyRequestBody {
     /** The company the cap applies to. Set exactly one of company_id and user_id. */
     companyId?: string;
     label?: string;
-    /** The largest number of credits a single draw may spend. */
-    maxPerDraw: number;
+    /** The largest number of credits a single draw may spend. Set either this or window_amount. */
+    maxPerDraw?: number;
     /** The user the cap applies to. Set exactly one of company_id and user_id. */
     userId?: string;
+    /** The number of credits the company or user may spend in one window. Set either this or max_per_draw. */
+    windowAmount?: number;
+    /** The window that window_amount applies to: one UTC hour or one UTC day. Required with window_amount. */
+    windowUnit?: Schematic.CreditSpendWindowUnit;
 }

package/dist/api/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts

@@ -10,4 +10,6 @@ export interface ExtendCreditLeaseRequestBody {
     expiresAt?: Date;
     /** A caller-chosen key for safe retries: a second request with the same key returns the lease as it stands instead of growing it again. Keys are unique per environment across every extend */
     idempotencyKey?: string;
+    /** The user drawing the top-up, so a user-scope spend policy applies to it */
+    userId?: string;
 }

package/dist/api/resources/credits/client/requests/GetCreditSpendPolicyUsageRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         billingCreditId: "billing_credit_id",
+ *         companyId: "company_id",
+ *         userIds: ["user_ids"]
+ *     }
+ */
+export interface GetCreditSpendPolicyUsageRequest {
+    billingCreditId?: string;
+    companyId: string;
+    userIds?: string | string[];
+}

package/dist/api/resources/credits/client/requests/ListCreditEventLedgerRequest.d.ts

@@ -5,7 +5,7 @@ import type * as Schematic from "../../../../index";
  *         billingCreditId: "billing_credit_id",
  *         companyId: "company_id",
  *         endTime: "end_time",
- *         eventType: "grant",
+ *         eventType: "adjustment",
  *         featureId: "feature_id",
  *         startTime: "start_time",
  *         limit: 1000000,

package/dist/api/resources/credits/client/requests/UpdateCreditSpendPolicyRequestBody.d.ts

@@ -1,3 +1,4 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {}
@@ -5,4 +6,6 @@
 export interface UpdateCreditSpendPolicyRequestBody {
     label?: string;
     maxPerDraw?: number;
+    windowAmount?: number;
+    windowUnit?: Schematic.CreditSpendWindowUnit;
 }

package/dist/api/resources/credits/client/requests/index.d.ts

@@ -12,6 +12,7 @@ export type { CreateCreditBundleRequestBody } from "./CreateCreditBundleRequestB
 export type { CreateCreditSpendPolicyRequestBody } from "./CreateCreditSpendPolicyRequestBody";
 export type { DeleteBillingPlanCreditGrantRequest } from "./DeleteBillingPlanCreditGrantRequest";
 export type { ExtendCreditLeaseRequestBody } from "./ExtendCreditLeaseRequestBody";
+export type { GetCreditSpendPolicyUsageRequest } from "./GetCreditSpendPolicyUsageRequest";
 export type { ListBillingCreditsRequest } from "./ListBillingCreditsRequest";
 export type { ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
 export type { ListCompanyCreditBalancesRequest } from "./ListCompanyCreditBalancesRequest";

package/dist/api/resources/credits/types/GetCreditSpendPolicyUsageParams.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Input parameters
+ */
+export interface GetCreditSpendPolicyUsageParams {
+    billingCreditId?: string;
+    companyId?: string;
+    userIds?: string[];
+}

package/dist/api/resources/credits/types/GetCreditSpendPolicyUsageResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetCreditSpendPolicyUsageResponse {
+    data: Schematic.CreditSpendPolicyResponseData[];
+    /** Input parameters */
+    params: Schematic.GetCreditSpendPolicyUsageParams;
+}

package/dist/api/resources/credits/types/index.d.ts

@@ -24,6 +24,8 @@ export * from "./DeleteCreditSpendPolicyResponse";
 export * from "./ExtendCreditLeaseResponse";
 export * from "./GetCreditBundleResponse";
 export * from "./GetCreditSpendPolicyResponse";
+export * from "./GetCreditSpendPolicyUsageParams";
+export * from "./GetCreditSpendPolicyUsageResponse";
 export * from "./GetSingleBillingCreditResponse";
 export * from "./GetSingleBillingPlanCreditGrantResponse";
 export * from "./GrantBillingCreditsToCompanyResponse";

package/dist/api/resources/entitlements/client/Client.d.ts

@@ -541,6 +541,75 @@ export declare class EntitlementsClient {
      */
     getUserUsageByCompany(request: Schematic.GetUserUsageByCompanyRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetUserUsageByCompanyResponse>;
     private __getUserUsageByCompany;
+    /**
+     * @param {Schematic.GetCompanyUserUsageMetricsRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.entitlements.getCompanyUserUsageMetrics({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    getCompanyUserUsageMetrics(request: Schematic.GetCompanyUserUsageMetricsRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyUserUsageMetricsResponse>;
+    private __getCompanyUserUsageMetrics;
+    /**
+     * @param {Schematic.ListCompanyUserUsageRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.entitlements.listCompanyUserUsage({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         featureId: "feature_id",
+     *         metric: "credits",
+     *         limit: 1000000,
+     *         offset: 1000000,
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    listCompanyUserUsage(request: Schematic.ListCompanyUserUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyUserUsageResponse>;
+    private __listCompanyUserUsage;
+    /**
+     * @param {Schematic.CountCompanyUserUsageRequest} request
+     * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.entitlements.countCompanyUserUsage({
+     *         companyId: "company_id",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+     *         featureId: "feature_id",
+     *         metric: "credits",
+     *         limit: 1000000,
+     *         offset: 1000000,
+     *         startTime: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    countCompanyUserUsage(request: Schematic.CountCompanyUserUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyUserUsageResponse>;
+    private __countCompanyUserUsage;
     /**
      * @param {Schematic.GetUserUsageDetailRequest} request
      * @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/entitlements/client/requests/CountCompanyUserUsageRequest.d.ts

@@ -0,0 +1,29 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         featureId: "feature_id",
+ *         metric: "credits",
+ *         limit: 1000000,
+ *         offset: 1000000,
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface CountCompanyUserUsageRequest {
+    /** Company to break usage down for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Which metric to break usage down by */
+    metric: Schematic.UserUsageMetric;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts

@@ -40,7 +40,7 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts

@@ -36,7 +36,7 @@ export interface CreatePlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/GetCompanyUserUsageMetricsRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface GetCompanyUserUsageMetricsRequest {
+    /** Company to list available metrics for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/client/requests/ListCompanyUserUsageRequest.d.ts

@@ -0,0 +1,29 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         featureId: "feature_id",
+ *         metric: "credits",
+ *         limit: 1000000,
+ *         offset: 1000000,
+ *         startTime: new Date("2024-01-15T09:30:00.000Z")
+ *     }
+ */
+export interface ListCompanyUserUsageRequest {
+    /** Company to break usage down for */
+    companyId: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Which metric to break usage down by */
+    metric: Schematic.UserUsageMetric;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts

@@ -31,7 +31,7 @@ export interface UpdatePlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/index.d.ts

@@ -1,4 +1,5 @@
 export type { CountCompanyOverridesRequest } from "./CountCompanyOverridesRequest";
+export type { CountCompanyUserUsageRequest } from "./CountCompanyUserUsageRequest";
 export type { CountFeatureCompaniesRequest } from "./CountFeatureCompaniesRequest";
 export type { CountFeatureUsageRequest } from "./CountFeatureUsageRequest";
 export type { CountFeatureUsersRequest } from "./CountFeatureUsersRequest";
@@ -7,11 +8,13 @@ export type { CreateBillingLinkedPlanEntitlementRequestBody } from "./CreateBill
 export type { CreateCompanyOverrideRequestBody } from "./CreateCompanyOverrideRequestBody";
 export type { CreatePlanEntitlementRequestBody } from "./CreatePlanEntitlementRequestBody";
 export type { DuplicatePlanEntitlementsRequestBody } from "./DuplicatePlanEntitlementsRequestBody";
+export type { GetCompanyUserUsageMetricsRequest } from "./GetCompanyUserUsageMetricsRequest";
 export type { GetFeatureUsageByCompanyRequest } from "./GetFeatureUsageByCompanyRequest";
 export type { GetFeatureUsageTimeSeriesRequest } from "./GetFeatureUsageTimeSeriesRequest";
 export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyRequest";
 export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
 export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
+export type { ListCompanyUserUsageRequest } from "./ListCompanyUserUsageRequest";
 export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
 export type { ListFeatureUsageHistoryRequest } from "./ListFeatureUsageHistoryRequest";
 export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";

package/dist/api/resources/entitlements/types/CountCompanyUserUsageParams.d.ts

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface CountCompanyUserUsageParams {
+    /** Company to break usage down for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Which metric to break usage down by */
+    metric?: Schematic.UserUsageMetric;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/types/CountCompanyUserUsageResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CountCompanyUserUsageResponse {
+    data: Schematic.CountResponse;
+    /** Input parameters */
+    params: Schematic.CountCompanyUserUsageParams;
+}

package/dist/api/resources/entitlements/types/GetCompanyUserUsageMetricsParams.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Input parameters
+ */
+export interface GetCompanyUserUsageMetricsParams {
+    /** Company to list available metrics for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/types/GetCompanyUserUsageMetricsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetCompanyUserUsageMetricsResponse {
+    data: Schematic.CompanyUserUsageMetricsResponseData;
+    /** Input parameters */
+    params: Schematic.GetCompanyUserUsageMetricsParams;
+}

package/dist/api/resources/entitlements/types/ListCompanyUserUsageParams.d.ts

@@ -0,0 +1,20 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListCompanyUserUsageParams {
+    /** Company to break usage down for */
+    companyId?: string;
+    /** End of the usage window (exclusive); defaults to now */
+    endTime?: Date;
+    /** The event-based feature to break down; required when metric is feature */
+    featureId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Which metric to break usage down by */
+    metric?: Schematic.UserUsageMetric;
+    /** Page offset (default 0) */
+    offset?: number;
+    /** Start of the usage window; defaults to 30 days before the end */
+    startTime?: Date;
+}

package/dist/api/resources/entitlements/types/ListCompanyUserUsageResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListCompanyUserUsageResponse {
+    data: Schematic.CompanyUserUsageResponseData;
+    /** Input parameters */
+    params: Schematic.ListCompanyUserUsageParams;
+}

package/dist/api/resources/entitlements/types/index.d.ts

@@ -1,5 +1,7 @@
 export * from "./CountCompanyOverridesParams";
 export * from "./CountCompanyOverridesResponse";
+export * from "./CountCompanyUserUsageParams";
+export * from "./CountCompanyUserUsageResponse";
 export * from "./CountFeatureCompaniesParams";
 export * from "./CountFeatureCompaniesResponse";
 export * from "./CountFeatureUsageParams";
@@ -14,6 +16,8 @@ export * from "./DeleteCompanyOverrideResponse";
 export * from "./DeletePlanEntitlementResponse";
 export * from "./DuplicatePlanEntitlementsResponse";
 export * from "./GetCompanyOverrideResponse";
+export * from "./GetCompanyUserUsageMetricsParams";
+export * from "./GetCompanyUserUsageMetricsResponse";
 export * from "./GetFeatureUsageByCompanyParams";
 export * from "./GetFeatureUsageByCompanyResponse";
 export * from "./GetFeatureUsageTimeSeriesParams";
@@ -25,6 +29,8 @@ export * from "./GetUserUsageDetailParams";
 export * from "./GetUserUsageDetailResponse";
 export * from "./ListCompanyOverridesParams";
 export * from "./ListCompanyOverridesResponse";
+export * from "./ListCompanyUserUsageParams";
+export * from "./ListCompanyUserUsageResponse";
 export * from "./ListFeatureCompaniesParams";
 export * from "./ListFeatureCompaniesResponse";
 export * from "./ListFeatureUsageHistoryParams";

package/dist/api/resources/plangroups/client/Client.d.ts

@@ -63,6 +63,7 @@ export declare class PlangroupsClient {
      *         prorationBehavior: "create_prorations",
      *         showAsMonthlyPrices: true,
      *         showCredits: true,
+     *         showEstimatedTotal: true,
      *         showFeatureDescription: true,
      *         showHardLimit: true,
      *         showPeriodToggle: true,
@@ -108,6 +109,7 @@ export declare class PlangroupsClient {
      *         prorationBehavior: "create_prorations",
      *         showAsMonthlyPrices: true,
      *         showCredits: true,
+     *         showEstimatedTotal: true,
      *         showFeatureDescription: true,
      *         showHardLimit: true,
      *         showPeriodToggle: true,

package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts

@@ -23,6 +23,7 @@ import type * as Schematic from "../../../../index";
  *         prorationBehavior: "create_prorations",
  *         showAsMonthlyPrices: true,
  *         showCredits: true,
+ *         showEstimatedTotal: true,
  *         showFeatureDescription: true,
  *         showHardLimit: true,
  *         showPeriodToggle: true,
@@ -61,6 +62,7 @@ export interface CreatePlanGroupRequestBody {
     scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts

@@ -23,6 +23,7 @@ import type * as Schematic from "../../../../index";
  *         prorationBehavior: "create_prorations",
  *         showAsMonthlyPrices: true,
  *         showCredits: true,
+ *         showEstimatedTotal: true,
  *         showFeatureDescription: true,
  *         showHardLimit: true,
  *         showPeriodToggle: true,
@@ -61,6 +62,7 @@ export interface UpdatePlanGroupRequestBody {
     scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

package/dist/api/resources/planmigrations/client/Client.d.ts

@@ -88,6 +88,7 @@ export declare class PlanmigrationsClient {
      * @example
      *     await client.planmigrations.listMigrations({
      *         featureId: "feature_id",
+     *         featurePlanRolloutId: "feature_plan_rollout_id",
      *         planVersionId: "plan_version_id",
      *         status: "cancelled",
      *         limit: 1000000,
@@ -204,6 +205,7 @@ export declare class PlanmigrationsClient {
      * @example
      *     await client.planmigrations.countMigrations({
      *         featureId: "feature_id",
+     *         featurePlanRolloutId: "feature_plan_rollout_id",
      *         planVersionId: "plan_version_id",
      *         status: "cancelled",
      *         limit: 1000000,

package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts

@@ -3,6 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         featureId: "feature_id",
+ *         featurePlanRolloutId: "feature_plan_rollout_id",
  *         planVersionId: "plan_version_id",
  *         status: "cancelled",
  *         limit: 1000000,
@@ -11,6 +12,7 @@ import type * as Schematic from "../../../../index";
  */
 export interface CountMigrationsRequest {
     featureId?: string;
+    featurePlanRolloutId?: string;
     planVersionId?: string;
     status?: Schematic.PlanVersionMigrationStatus;
     /** Page limit (default 100) */