@schematichq/schematic-typescript-node 1.2.1 → 1.2.3

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

@@ -4,7 +4,16 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         monetizedSubscriptions: true,
+ *         q: "q",
+ *         withoutPlan: true,
+ *         withoutSubscription: true,
+ *         sortOrderColumn: "sort_order_column",
+ *         sortOrderDirection: "asc",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountCompaniesForAdvancedFilterRequest {
     /**
@@ -19,6 +28,10 @@ export interface CountCompaniesForAdvancedFilterRequest {
      * Filter companies by one or more feature IDs (each ID starts with feat_)
      */
     featureIds?: string | string[];
+    /**
+     * Filter companies by one or more credit type IDs (each ID starts with bcrd_)
+     */
+    creditTypeIds?: string | string[];
     /**
      * Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid)
      */
@@ -52,7 +65,7 @@ export interface CountCompaniesForAdvancedFilterRequest {
      */
     sortOrderDirection?: Schematic.CountCompaniesForAdvancedFilterRequestSortOrderDirection;
     /**
-     * Select the display columns to return (e.g. plan, subscription, users, last_seen)
+     * Select the display columns to return (e.g. plan, subscription, users, last_seen_at)
      */
     displayProperties?: string | string[];
     /**

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

@@ -3,7 +3,15 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         planId: "plan_id",
+ *         q: "q",
+ *         withoutFeatureOverrideFor: "without_feature_override_for",
+ *         withoutPlan: true,
+ *         withSubscription: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountCompaniesRequest {
     /**

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

@@ -4,7 +4,12 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         entityType: "company",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountEntityKeyDefinitionsRequest {
     entityType?: Schematic.CountEntityKeyDefinitionsRequestEntityType;

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

@@ -4,7 +4,13 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         entityType: "company",
+ *         q: "q",
+ *         traitType: "boolean",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountEntityTraitDefinitionsRequest {
     entityType?: Schematic.CountEntityTraitDefinitionsRequestEntityType;

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

@@ -3,7 +3,12 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         planId: "plan_id",
+ *         traitId: "trait_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountPlanTraitsRequest {
     ids?: string | string[];

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

@@ -3,7 +3,13 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         planId: "plan_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountUsersRequest {
     /**

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

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface GetActiveCompanySubscriptionRequest {
     companyId?: string;

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

@@ -5,7 +5,9 @@
  * @example
  *     {
  *         companyId: "company_id",
- *         dealStage: "deal_stage"
+ *         dealStage: "deal_stage",
+ *         limit: 1,
+ *         offset: 1
  *     }
  */
 export interface GetActiveDealsRequest {

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

@@ -4,7 +4,10 @@
 /**
  * @example
  *     {
- *         definitionId: "definition_id"
+ *         definitionId: "definition_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
  *     }
  */
 export interface GetEntityTraitValuesRequest {

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

@@ -4,7 +4,16 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         monetizedSubscriptions: true,
+ *         q: "q",
+ *         withoutPlan: true,
+ *         withoutSubscription: true,
+ *         sortOrderColumn: "sort_order_column",
+ *         sortOrderDirection: "asc",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListCompaniesForAdvancedFilterRequest {
     /**
@@ -19,6 +28,10 @@ export interface ListCompaniesForAdvancedFilterRequest {
      * Filter companies by one or more feature IDs (each ID starts with feat_)
      */
     featureIds?: string | string[];
+    /**
+     * Filter companies by one or more credit type IDs (each ID starts with bcrd_)
+     */
+    creditTypeIds?: string | string[];
     /**
      * Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid)
      */
@@ -52,7 +65,7 @@ export interface ListCompaniesForAdvancedFilterRequest {
      */
     sortOrderDirection?: Schematic.ListCompaniesForAdvancedFilterRequestSortOrderDirection;
     /**
-     * Select the display columns to return (e.g. plan, subscription, users, last_seen)
+     * Select the display columns to return (e.g. plan, subscription, users, last_seen_at)
      */
     displayProperties?: string | string[];
     /**

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

@@ -3,7 +3,15 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         planId: "plan_id",
+ *         q: "q",
+ *         withoutFeatureOverrideFor: "without_feature_override_for",
+ *         withoutPlan: true,
+ *         withSubscription: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListCompaniesRequest {
     /**

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

@@ -3,7 +3,12 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         userId: "user_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListCompanyMembershipsRequest {
     companyId?: string;

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

@@ -4,7 +4,12 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         entityType: "company",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListEntityKeyDefinitionsRequest {
     entityType?: Schematic.ListEntityKeyDefinitionsRequestEntityType;

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

@@ -4,7 +4,13 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         entityType: "company",
+ *         q: "q",
+ *         traitType: "boolean",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListEntityTraitDefinitionsRequest {
     entityType?: Schematic.ListEntityTraitDefinitionsRequestEntityType;

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

@@ -3,7 +3,12 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         planId: "plan_id",
+ *         traitId: "trait_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListPlanTraitsRequest {
     ids?: string | string[];

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

@@ -3,7 +3,13 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         planId: "plan_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListUsersRequest {
     /**

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         planId: "plan_id",
+ *         traits: [{
+ *                 traitId: "trait_id",
+ *                 traitValue: "trait_value"
+ *             }]
+ *     }
+ */
+export interface UpdatePlanTraitBulkRequestBody {
+    planId: string;
+    traits: Schematic.UpdatePlanTraitTraitRequestBody[];
+}

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

@@ -17,6 +17,7 @@ export { type GetEntityTraitValuesRequest } from "./GetEntityTraitValuesRequest"
 export { type ListPlanTraitsRequest } from "./ListPlanTraitsRequest";
 export { type CreatePlanTraitRequestBody } from "./CreatePlanTraitRequestBody";
 export { type UpdatePlanTraitRequestBody } from "./UpdatePlanTraitRequestBody";
+export { type UpdatePlanTraitBulkRequestBody } from "./UpdatePlanTraitBulkRequestBody";
 export { type CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
 export { type ListUsersRequest } from "./ListUsersRequest";
 export { type CountUsersRequest } from "./CountUsersRequest";

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

@@ -6,7 +6,9 @@ import * as Schematic from "../../../index";
  * Input parameters
  */
 export interface CountCompaniesForAdvancedFilterParams {
-    /** Select the display columns to return (e.g. plan, subscription, users, last_seen) */
+    /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
+    creditTypeIds?: string[];
+    /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
     displayProperties?: string[];
     /** Filter companies by one or more feature IDs (each ID starts with feat_) */
     featureIds?: string[];

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface GetActiveCompanySubscriptionResponse {
-    /** The returned resources */
     data: Schematic.CompanySubscriptionResponseData[];
     /** Input parameters */
     params: Schematic.GetActiveCompanySubscriptionParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface GetActiveDealsResponse {
-    /** The returned resources */
     data: Schematic.CompanyCrmDealsResponseData[];
     /** Input parameters */
     params: Schematic.GetActiveDealsParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface GetEntityTraitValuesResponse {
-    /** The returned resources */
     data: Schematic.EntityTraitValue[];
     /** Input parameters */
     params: Schematic.GetEntityTraitValuesParams;

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

@@ -6,7 +6,9 @@ import * as Schematic from "../../../index";
  * Input parameters
  */
 export interface ListCompaniesForAdvancedFilterParams {
-    /** Select the display columns to return (e.g. plan, subscription, users, last_seen) */
+    /** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
+    creditTypeIds?: string[];
+    /** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
     displayProperties?: string[];
     /** Filter companies by one or more feature IDs (each ID starts with feat_) */
     featureIds?: string[];

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListCompaniesForAdvancedFilterResponse {
-    /** The returned resources */
     data: Schematic.CompanyViewWithFeatureUsageResponseData[];
     /** Input parameters */
     params: Schematic.ListCompaniesForAdvancedFilterParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListCompaniesResponse {
-    /** The returned resources */
     data: Schematic.CompanyDetailResponseData[];
     /** Input parameters */
     params: Schematic.ListCompaniesParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListCompanyMembershipsResponse {
-    /** The returned resources */
     data: Schematic.CompanyMembershipDetailResponseData[];
     /** Input parameters */
     params: Schematic.ListCompanyMembershipsParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListEntityKeyDefinitionsResponse {
-    /** The returned resources */
     data: Schematic.EntityKeyDefinitionResponseData[];
     /** Input parameters */
     params: Schematic.ListEntityKeyDefinitionsParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListEntityTraitDefinitionsResponse {
-    /** The returned resources */
     data: Schematic.EntityTraitDefinitionResponseData[];
     /** Input parameters */
     params: Schematic.ListEntityTraitDefinitionsParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListPlanTraitsResponse {
-    /** The returned resources */
     data: Schematic.PlanTraitResponseData[];
     /** Input parameters */
     params: Schematic.ListPlanTraitsParams;

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

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListUsersResponse {
-    /** The returned resources */
     data: Schematic.UserDetailResponseData[];
     /** Input parameters */
     params: Schematic.ListUsersParams;

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../index";
+export interface UpdatePlanTraitsBulkResponse {
+    data: Schematic.PlanTraitResponseData[];
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -60,6 +60,7 @@ export * from "./CreatePlanTraitResponse";
 export * from "./GetPlanTraitResponse";
 export * from "./UpdatePlanTraitResponse";
 export * from "./DeletePlanTraitResponse";
+export * from "./UpdatePlanTraitsBulkResponse";
 export * from "./CountPlanTraitsParams";
 export * from "./CountPlanTraitsResponse";
 export * from "./UpsertUserTraitResponse";

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

@@ -9,7 +9,7 @@ export declare namespace Components {
         environment?: core.Supplier<environments.SchematicEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -25,7 +25,7 @@ export declare namespace Components {
 }
 export declare class Components {
     protected readonly _options: Components.Options;
-    constructor(_options: Components.Options);
+    constructor(_options?: Components.Options);
     /**
      * @param {Schematic.ListComponentsRequest} request
      * @param {Components.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,11 @@ export declare class Components {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.components.listComponents()
+     *     await client.components.listComponents({
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listComponents(request?: Schematic.ListComponentsRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.ListComponentsResponse>;
     private __listComponents;
@@ -115,7 +119,11 @@ export declare class Components {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.components.countComponents()
+     *     await client.components.countComponents({
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countComponents(request?: Schematic.CountComponentsRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.CountComponentsResponse>;
     private __countComponents;
@@ -129,11 +137,14 @@ export declare class Components {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.components.previewComponentData()
+     *     await client.components.previewComponentData({
+     *         companyId: "company_id",
+     *         componentId: "component_id"
+     *     })
      */
     previewComponentData(request?: Schematic.PreviewComponentDataRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.PreviewComponentDataResponse>;
     private __previewComponentData;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Schematic-Api-Key": string;
+        "X-Schematic-Api-Key": string | undefined;
     }>;
 }

package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountComponentsRequest {
     q?: string;

package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListComponentsRequest {
     q?: string;

package/dist/api/resources/components/client/requests/PreviewComponentDataRequest.d.ts

@@ -3,7 +3,10 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         componentId: "component_id"
+ *     }
  */
 export interface PreviewComponentDataRequest {
     companyId?: string;

package/dist/api/resources/components/types/ListComponentsResponse.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListComponentsResponse {
-    /** The returned resources */
     data: Schematic.ComponentResponseData[];
     /** Input parameters */
     params: Schematic.ListComponentsParams;