@schematichq/schematic-typescript-node 1.3.1 → 1.4.0

package/README.md

@@ -30,7 +30,7 @@ client.close();
 By default, the client will do some local caching for flag checks. If you would like to change this behavior, you can do so using an initialization option to specify the max size of the cache (in terms of number of records) and the max age of the cache (in milliseconds):
 
 ```ts
-import { LocalCache, SchematicClient } from "@schematichq/schematic-typescript-node";
+import { LocalCache, SchematicClient, type CheckFlagWithEntitlementResponse } from "@schematichq/schematic-typescript-node";
 
 const apiKey = process.env.SCHEMATIC_API_KEY;
 const cacheSize = 100;
@@ -38,7 +38,7 @@ const cacheTTL = 1000; // in milliseconds
 const client = new SchematicClient({
     apiKey,
     cacheProviders: {
-        flagChecks: [new LocalCache<boolean>({ maxItems: cacheSize, ttl: cacheTTL })],
+        flagChecks: [new LocalCache<CheckFlagWithEntitlementResponse>({ maxItems: cacheSize, ttl: cacheTTL })],
     },
 });
 
@@ -340,6 +340,40 @@ client
 client.close();
 ```
 
+### Checking flags with entitlement details
+
+If you need more detail about how a flag check was resolved, including any entitlement associated with the check, use `checkFlagWithEntitlement`. This returns a response object with the flag value, the reason for the evaluation result, and entitlement details such as usage, allocation, and credit balances when applicable.
+
+```ts
+import { SchematicClient } from "@schematichq/schematic-typescript-node";
+
+const apiKey = process.env.SCHEMATIC_API_KEY;
+const client = new SchematicClient({ apiKey });
+
+const evaluationCtx = {
+    company: { id: "your-company-id" },
+    user: {
+        email: "wcoyote@acme.net",
+        userId: "your-user-id",
+    },
+};
+
+client
+    .checkFlagWithEntitlement(evaluationCtx, "some-flag-key")
+    .then((resp) => {
+        console.log(`Flag: ${resp.flagKey}, Value: ${resp.value}, Reason: ${resp.reason}`);
+
+        if (resp.entitlement) {
+            console.log(`Entitlement type: ${resp.entitlement.valueType}`);
+            console.log(`Usage: ${resp.entitlement.usage}, Allocation: ${resp.entitlement.allocation}`);
+            console.log(`Credit remaining: ${resp.entitlement.creditRemaining}`);
+        }
+    })
+    .catch(console.error);
+
+client.close();
+```
+
 ### Checking multiple flags
 
 The `checkFlags` method allows you to efficiently check multiple feature flags in a single operation. When you provide specific flag keys, it will only return the flag values for those flags, leveraging intelligent caching to minimize API calls.

package/dist/Client.d.ts

@@ -4,6 +4,7 @@ import { BillingClient } from "./api/resources/billing/client/Client";
 import { CheckoutClient } from "./api/resources/checkout/client/Client";
 import { CompaniesClient } from "./api/resources/companies/client/Client";
 import { ComponentsClient } from "./api/resources/components/client/Client";
+import { ComponentspublicClient } from "./api/resources/componentspublic/client/Client";
 import { CreditsClient } from "./api/resources/credits/client/Client";
 import { DataexportsClient } from "./api/resources/dataexports/client/Client";
 import { EntitlementsClient } from "./api/resources/entitlements/client/Client";
@@ -11,7 +12,9 @@ import { EventsClient } from "./api/resources/events/client/Client";
 import { FeaturesClient } from "./api/resources/features/client/Client";
 import { PlanbundleClient } from "./api/resources/planbundle/client/Client";
 import { PlangroupsClient } from "./api/resources/plangroups/client/Client";
+import { PlanmigrationsClient } from "./api/resources/planmigrations/client/Client";
 import { PlansClient } from "./api/resources/plans/client/Client";
+import { ScheduledcheckoutClient } from "./api/resources/scheduledcheckout/client/Client";
 import { WebhooksClient } from "./api/resources/webhooks/client/Client";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient";
 import { type NormalizedClientOptionsWithAuth } from "./BaseClient";
@@ -36,6 +39,9 @@ export declare class SchematicClient {
     protected _features: FeaturesClient | undefined;
     protected _planbundle: PlanbundleClient | undefined;
     protected _plangroups: PlangroupsClient | undefined;
+    protected _planmigrations: PlanmigrationsClient | undefined;
+    protected _componentspublic: ComponentspublicClient | undefined;
+    protected _scheduledcheckout: ScheduledcheckoutClient | undefined;
     protected _accesstokens: AccesstokensClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
     constructor(options: SchematicClient.Options);
@@ -52,6 +58,9 @@ export declare class SchematicClient {
     get features(): FeaturesClient;
     get planbundle(): PlanbundleClient;
     get plangroups(): PlangroupsClient;
+    get planmigrations(): PlanmigrationsClient;
+    get componentspublic(): ComponentspublicClient;
+    get scheduledcheckout(): ScheduledcheckoutClient;
     get accesstokens(): AccesstokensClient;
     get webhooks(): WebhooksClient;
     /**

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

@@ -113,7 +113,7 @@ export declare class AccountsClient {
     countApiKeys(request: Schematic.CountApiKeysRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountApiKeysResponse>;
     private __countApiKeys;
     /**
-     * @param {Schematic.ListApiRequestsRequest} request
+     * @param {Schematic.ListAuditLogsRequest} request
      * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -123,18 +123,20 @@ export declare class AccountsClient {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.accounts.listApiRequests({
-     *         q: "q",
-     *         requestType: "request_type",
+     *     await client.accounts.listAuditLogs({
+     *         actorType: "api_key",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
      *         environmentId: "environment_id",
+     *         q: "q",
+     *         startTime: new Date("2024-01-15T09:30:00.000Z"),
      *         limit: 1,
      *         offset: 1
      *     })
      */
-    listApiRequests(request?: Schematic.ListApiRequestsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListApiRequestsResponse>;
-    private __listApiRequests;
+    listAuditLogs(request?: Schematic.ListAuditLogsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListAuditLogsResponse>;
+    private __listAuditLogs;
     /**
-     * @param {string} api_request_id - api_request_id
+     * @param {string} audit_log_id - audit_log_id
      * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.UnauthorizedError}
@@ -143,12 +145,12 @@ export declare class AccountsClient {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.accounts.getApiRequest("api_request_id")
+     *     await client.accounts.getAuditLog("audit_log_id")
      */
-    getApiRequest(api_request_id: string, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetApiRequestResponse>;
-    private __getApiRequest;
+    getAuditLog(audit_log_id: string, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetAuditLogResponse>;
+    private __getAuditLog;
     /**
-     * @param {Schematic.CountApiRequestsRequest} request
+     * @param {Schematic.CountAuditLogsRequest} request
      * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -158,16 +160,18 @@ export declare class AccountsClient {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.accounts.countApiRequests({
-     *         q: "q",
-     *         requestType: "request_type",
+     *     await client.accounts.countAuditLogs({
+     *         actorType: "api_key",
+     *         endTime: new Date("2024-01-15T09:30:00.000Z"),
      *         environmentId: "environment_id",
+     *         q: "q",
+     *         startTime: new Date("2024-01-15T09:30:00.000Z"),
      *         limit: 1,
      *         offset: 1
      *     })
      */
-    countApiRequests(request?: Schematic.CountApiRequestsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountApiRequestsResponse>;
-    private __countApiRequests;
+    countAuditLogs(request?: Schematic.CountAuditLogsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountAuditLogsResponse>;
+    private __countAuditLogs;
     /**
      * @param {Schematic.ListEnvironmentsRequest} request
      * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -263,4 +267,17 @@ export declare class AccountsClient {
      */
     quickstart(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.QuickstartResponse>;
     private __quickstart;
+    /**
+     * @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     *
+     * @example
+     *     await client.accounts.getWhoAmI()
+     */
+    getWhoAmI(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetWhoAmIResponse>;
+    private __getWhoAmI;
 }

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

@@ -0,0 +1,24 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         actorType: "api_key",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         environmentId: "environment_id",
+ *         q: "q",
+ *         startTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface CountAuditLogsRequest {
+    actorType?: Schematic.ActorType;
+    endTime?: Date;
+    environmentId?: string;
+    q?: string;
+    startTime?: Date;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -8,4 +8,5 @@ export interface CreateApiKeyRequestBody {
     description?: string;
     environmentId?: string;
     name: string;
+    readonly?: boolean;
 }

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

@@ -0,0 +1,24 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         actorType: "api_key",
+ *         endTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         environmentId: "environment_id",
+ *         q: "q",
+ *         startTime: new Date("2024-01-15T09:30:00.000Z"),
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface ListAuditLogsRequest {
+    actorType?: Schematic.ActorType;
+    endTime?: Date;
+    environmentId?: string;
+    q?: string;
+    startTime?: Date;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -1,9 +1,9 @@
 export type { CountApiKeysRequest } from "./CountApiKeysRequest";
-export type { CountApiRequestsRequest } from "./CountApiRequestsRequest";
+export type { CountAuditLogsRequest } from "./CountAuditLogsRequest";
 export type { CreateApiKeyRequestBody } from "./CreateApiKeyRequestBody";
 export type { CreateEnvironmentRequestBody } from "./CreateEnvironmentRequestBody";
 export type { ListApiKeysRequest } from "./ListApiKeysRequest";
-export type { ListApiRequestsRequest } from "./ListApiRequestsRequest";
+export type { ListAuditLogsRequest } from "./ListAuditLogsRequest";
 export type { ListEnvironmentsRequest } from "./ListEnvironmentsRequest";
 export type { UpdateApiKeyRequestBody } from "./UpdateApiKeyRequestBody";
 export type { UpdateEnvironmentRequestBody } from "./UpdateEnvironmentRequestBody";

package/dist/api/resources/accounts/types/{ListApiRequestsParams.d.ts → CountAuditLogsParams.d.ts}

@@ -1,12 +1,15 @@
+import type * as Schematic from "../../../index";
 /**
  * Input parameters
  */
-export interface ListApiRequestsParams {
+export interface CountAuditLogsParams {
+    actorType?: Schematic.ActorType;
+    endTime?: Date;
     environmentId?: string;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
     q?: string;
-    requestType?: string;
+    startTime?: Date;
 }

package/dist/api/resources/accounts/types/{CountApiRequestsResponse.d.ts → CountAuditLogsResponse.d.ts}

@@ -1,6 +1,6 @@
 import type * as Schematic from "../../../index";
-export interface CountApiRequestsResponse {
+export interface CountAuditLogsResponse {
     data: Schematic.CountResponse;
     /** Input parameters */
-    params: Schematic.CountApiRequestsParams;
+    params: Schematic.CountAuditLogsParams;
 }

package/dist/api/resources/accounts/types/{GetApiRequestResponse.d.ts → GetAuditLogResponse.d.ts}

@@ -1,6 +1,6 @@
 import type * as Schematic from "../../../index";
-export interface GetApiRequestResponse {
-    data: Schematic.ApiKeyRequestResponseData;
+export interface GetAuditLogResponse {
+    data: Schematic.AuditLogResponseData;
     /** Input parameters */
     params: Record<string, unknown>;
 }

package/dist/api/resources/accounts/types/GetWhoAmIResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetWhoAmIResponse {
+    data: Schematic.WhoAmIResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/accounts/types/{CountApiRequestsParams.d.ts → ListAuditLogsParams.d.ts}

@@ -1,12 +1,15 @@
+import type * as Schematic from "../../../index";
 /**
  * Input parameters
  */
-export interface CountApiRequestsParams {
+export interface ListAuditLogsParams {
+    actorType?: Schematic.ActorType;
+    endTime?: Date;
     environmentId?: string;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
     q?: string;
-    requestType?: string;
+    startTime?: Date;
 }

package/dist/api/resources/accounts/types/ListAuditLogsResponse.d.ts

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

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

@@ -1,18 +1,19 @@
 export * from "./CountApiKeysParams";
 export * from "./CountApiKeysResponse";
-export * from "./CountApiRequestsParams";
-export * from "./CountApiRequestsResponse";
+export * from "./CountAuditLogsParams";
+export * from "./CountAuditLogsResponse";
 export * from "./CreateApiKeyResponse";
 export * from "./CreateEnvironmentResponse";
 export * from "./DeleteApiKeyResponse";
 export * from "./DeleteEnvironmentResponse";
 export * from "./GetApiKeyResponse";
-export * from "./GetApiRequestResponse";
+export * from "./GetAuditLogResponse";
 export * from "./GetEnvironmentResponse";
+export * from "./GetWhoAmIResponse";
 export * from "./ListApiKeysParams";
 export * from "./ListApiKeysResponse";
-export * from "./ListApiRequestsParams";
-export * from "./ListApiRequestsResponse";
+export * from "./ListAuditLogsParams";
+export * from "./ListAuditLogsResponse";
 export * from "./ListEnvironmentsParams";
 export * from "./ListEnvironmentsResponse";
 export * from "./QuickstartResponse";

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

@@ -1,3 +1,4 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
@@ -20,6 +21,7 @@ export interface CreateInvoiceRequestBody {
     dueDate?: Date;
     externalId?: string;
     paymentMethodExternalId?: string;
+    status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
     url?: string;

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

@@ -22,10 +22,16 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.listCompanies({
+     *         monetizedSubscriptions: true,
      *         planId: "plan_id",
+     *         planVersionId: "plan_version_id",
      *         q: "q",
+     *         sortOrderColumn: "sort_order_column",
+     *         sortOrderDirection: "asc",
+     *         withEntitlementFor: "with_entitlement_for",
      *         withoutFeatureOverrideFor: "without_feature_override_for",
      *         withoutPlan: true,
+     *         withoutSubscription: true,
      *         withSubscription: true,
      *         limit: 1,
      *         offset: 1
@@ -97,10 +103,16 @@ export declare class CompaniesClient {
      *
      * @example
      *     await client.companies.countCompanies({
+     *         monetizedSubscriptions: true,
      *         planId: "plan_id",
+     *         planVersionId: "plan_version_id",
      *         q: "q",
+     *         sortOrderColumn: "sort_order_column",
+     *         sortOrderDirection: "asc",
+     *         withEntitlementFor: "with_entitlement_for",
      *         withoutFeatureOverrideFor: "without_feature_override_for",
      *         withoutPlan: true,
+     *         withoutSubscription: true,
      *         withSubscription: true,
      *         limit: 1,
      *         offset: 1
@@ -108,30 +120,6 @@ export declare class CompaniesClient {
      */
     countCompanies(request?: Schematic.CountCompaniesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesResponse>;
     private __countCompanies;
-    /**
-     * @param {Schematic.CountCompaniesForAdvancedFilterRequest} request
-     * @param {CompaniesClient.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}
-     *
-     * @example
-     *     await client.companies.countCompaniesForAdvancedFilter({
-     *         monetizedSubscriptions: true,
-     *         q: "q",
-     *         withoutPlan: true,
-     *         withoutSubscription: true,
-     *         sortOrderColumn: "sort_order_column",
-     *         sortOrderDirection: "asc",
-     *         limit: 1,
-     *         offset: 1
-     *     })
-     */
-    countCompaniesForAdvancedFilter(request?: Schematic.CountCompaniesForAdvancedFilterRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesForAdvancedFilterResponse>;
-    private __countCompaniesForAdvancedFilter;
     /**
      * @param {Schematic.UpsertCompanyRequestBody} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -170,30 +158,6 @@ export declare class CompaniesClient {
      */
     deleteCompanyByKeys(request: Schematic.KeysRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCompanyByKeysResponse>;
     private __deleteCompanyByKeys;
-    /**
-     * @param {Schematic.ListCompaniesForAdvancedFilterRequest} request
-     * @param {CompaniesClient.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}
-     *
-     * @example
-     *     await client.companies.listCompaniesForAdvancedFilter({
-     *         monetizedSubscriptions: true,
-     *         q: "q",
-     *         withoutPlan: true,
-     *         withoutSubscription: true,
-     *         sortOrderColumn: "sort_order_column",
-     *         sortOrderDirection: "asc",
-     *         limit: 1,
-     *         offset: 1
-     *     })
-     */
-    listCompaniesForAdvancedFilter(request?: Schematic.ListCompaniesForAdvancedFilterRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesForAdvancedFilterResponse>;
-    private __listCompaniesForAdvancedFilter;
     /**
      * @param {Schematic.LookupCompanyRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts

@@ -1,26 +1,53 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         monetizedSubscriptions: true,
  *         planId: "plan_id",
+ *         planVersionId: "plan_version_id",
  *         q: "q",
+ *         sortOrderColumn: "sort_order_column",
+ *         sortOrderDirection: "asc",
+ *         withEntitlementFor: "with_entitlement_for",
  *         withoutFeatureOverrideFor: "without_feature_override_for",
  *         withoutPlan: true,
+ *         withoutSubscription: true,
  *         withSubscription: true,
  *         limit: 1,
  *         offset: 1
  *     }
  */
 export interface CountCompaniesRequest {
+    /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
+    creditTypeIds?: string | string[];
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string | string[];
+    /** Filter companies that have monetized subscriptions */
+    monetizedSubscriptions?: boolean;
     /** Filter companies by plan ID (starts with plan_) */
     planId?: string;
+    /** Filter companies by one or more plan IDs (each ID starts with plan_) */
+    planIds?: string | string[];
+    /** Filter companies by plan version ID (starts with plvr_) */
+    planVersionId?: string;
     /** Search for companies by name, keys or string traits */
     q?: string;
+    /** Column to sort by (e.g. name, created_at, last_seen_at) */
+    sortOrderColumn?: string;
+    /** Direction to sort by (asc or desc) */
+    sortOrderDirection?: Schematic.SortDirection;
+    /** Filter companies by one or more subscription statuses */
+    subscriptionStatuses?: Schematic.SubscriptionStatus | Schematic.SubscriptionStatus[];
+    /** Filter companies by one or more subscription types */
+    subscriptionTypes?: Schematic.SubscriptionType | Schematic.SubscriptionType[];
+    /** Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID */
+    withEntitlementFor?: string;
     /** Filter out companies that already have a company override for the specified feature ID */
     withoutFeatureOverrideFor?: string;
     /** Filter out companies that have a plan */
     withoutPlan?: boolean;
+    /** Filter out companies that have a subscription */
+    withoutSubscription?: boolean;
     /** Filter companies that have a subscription */
     withSubscription?: boolean;
     /** Page limit (default 100) */

package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts

@@ -1,26 +1,53 @@
+import type * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         monetizedSubscriptions: true,
  *         planId: "plan_id",
+ *         planVersionId: "plan_version_id",
  *         q: "q",
+ *         sortOrderColumn: "sort_order_column",
+ *         sortOrderDirection: "asc",
+ *         withEntitlementFor: "with_entitlement_for",
  *         withoutFeatureOverrideFor: "without_feature_override_for",
  *         withoutPlan: true,
+ *         withoutSubscription: true,
  *         withSubscription: true,
  *         limit: 1,
  *         offset: 1
  *     }
  */
 export interface ListCompaniesRequest {
+    /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
+    creditTypeIds?: string | string[];
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string | string[];
+    /** Filter companies that have monetized subscriptions */
+    monetizedSubscriptions?: boolean;
     /** Filter companies by plan ID (starts with plan_) */
     planId?: string;
+    /** Filter companies by one or more plan IDs (each ID starts with plan_) */
+    planIds?: string | string[];
+    /** Filter companies by plan version ID (starts with plvr_) */
+    planVersionId?: string;
     /** Search for companies by name, keys or string traits */
     q?: string;
+    /** Column to sort by (e.g. name, created_at, last_seen_at) */
+    sortOrderColumn?: string;
+    /** Direction to sort by (asc or desc) */
+    sortOrderDirection?: Schematic.SortDirection;
+    /** Filter companies by one or more subscription statuses */
+    subscriptionStatuses?: Schematic.SubscriptionStatus | Schematic.SubscriptionStatus[];
+    /** Filter companies by one or more subscription types */
+    subscriptionTypes?: Schematic.SubscriptionType | Schematic.SubscriptionType[];
+    /** Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID */
+    withEntitlementFor?: string;
     /** Filter out companies that already have a company override for the specified feature ID */
     withoutFeatureOverrideFor?: string;
     /** Filter out companies that have a plan */
     withoutPlan?: boolean;
+    /** Filter out companies that have a subscription */
+    withoutSubscription?: boolean;
     /** Filter companies that have a subscription */
     withSubscription?: boolean;
     /** Page limit (default 100) */

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

@@ -1,4 +1,3 @@
-export type { CountCompaniesForAdvancedFilterRequest } from "./CountCompaniesForAdvancedFilterRequest";
 export type { CountCompaniesRequest } from "./CountCompaniesRequest";
 export type { CountEntityKeyDefinitionsRequest } from "./CountEntityKeyDefinitionsRequest";
 export type { CountEntityTraitDefinitionsRequest } from "./CountEntityTraitDefinitionsRequest";
@@ -10,7 +9,6 @@ export type { DeleteCompanyRequest } from "./DeleteCompanyRequest";
 export type { GetActiveCompanySubscriptionRequest } from "./GetActiveCompanySubscriptionRequest";
 export type { GetEntityTraitValuesRequest } from "./GetEntityTraitValuesRequest";
 export type { GetOrCreateCompanyMembershipRequestBody } from "./GetOrCreateCompanyMembershipRequestBody";
-export type { ListCompaniesForAdvancedFilterRequest } from "./ListCompaniesForAdvancedFilterRequest";
 export type { ListCompaniesRequest } from "./ListCompaniesRequest";
 export type { ListCompanyMembershipsRequest } from "./ListCompanyMembershipsRequest";
 export type { ListEntityKeyDefinitionsRequest } from "./ListEntityKeyDefinitionsRequest";

package/dist/api/resources/companies/types/CountCompaniesParams.d.ts

@@ -1,21 +1,42 @@
+import type * as Schematic from "../../../index";
 /**
  * Input parameters
  */
 export interface CountCompaniesParams {
+    /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
+    creditTypeIds?: string[];
     /** Filter companies by multiple company IDs (starts with comp_) */
     ids?: string[];
     /** Page limit (default 100) */
     limit?: number;
+    /** Filter companies that have monetized subscriptions */
+    monetizedSubscriptions?: boolean;
     /** Page offset (default 0) */
     offset?: number;
     /** Filter companies by plan ID (starts with plan_) */
     planId?: string;
+    /** Filter companies by one or more plan IDs (each ID starts with plan_) */
+    planIds?: string[];
+    /** Filter companies by plan version ID (starts with plvr_) */
+    planVersionId?: string;
     /** Search for companies by name, keys or string traits */
     q?: string;
+    /** Column to sort by (e.g. name, created_at, last_seen_at) */
+    sortOrderColumn?: string;
+    /** Direction to sort by (asc or desc) */
+    sortOrderDirection?: Schematic.SortDirection;
+    /** Filter companies by one or more subscription statuses */
+    subscriptionStatuses?: Schematic.SubscriptionStatus[];
+    /** Filter companies by one or more subscription types */
+    subscriptionTypes?: Schematic.SubscriptionType[];
+    /** Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID */
+    withEntitlementFor?: string;
     /** Filter companies that have a subscription */
     withSubscription?: boolean;
     /** Filter out companies that already have a company override for the specified feature ID */
     withoutFeatureOverrideFor?: string;
     /** Filter out companies that have a plan */
     withoutPlan?: boolean;
+    /** Filter out companies that have a subscription */
+    withoutSubscription?: boolean;
 }