@schematichq/schematic-typescript-node 1.5.7 → 1.5.8

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

@@ -344,6 +344,21 @@ export declare class CompaniesClient {
      */
     listEntityKeyDefinitions(request?: Schematic.ListEntityKeyDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityKeyDefinitionsResponse>;
     private __listEntityKeyDefinitions;
+    /**
+     * @param {string} entity_key_definition_id - entity_key_definition_id
+     * @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.deleteEntityKeyDefinition("entity_key_definition_id")
+     */
+    deleteEntityKeyDefinition(entity_key_definition_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteEntityKeyDefinitionResponse>;
+    private __deleteEntityKeyDefinition;
     /**
      * @param {Schematic.CountEntityKeyDefinitionsRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -365,6 +380,26 @@ export declare class CompaniesClient {
      */
     countEntityKeyDefinitions(request?: Schematic.CountEntityKeyDefinitionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeyDefinitionsResponse>;
     private __countEntityKeyDefinitions;
+    /**
+     * @param {Schematic.CountEntityKeysRequest} 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.countEntityKeys({
+     *         definitionId: "definition_id",
+     *         entityType: "company",
+     *         limit: 1000000,
+     *         offset: 1000000
+     *     })
+     */
+    countEntityKeys(request?: Schematic.CountEntityKeysRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeysResponse>;
+    private __countEntityKeys;
     /**
      * @param {Schematic.ListEntityTraitDefinitionsRequest} request
      * @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         definitionId: "definition_id",
+ *         entityType: "company",
+ *         limit: 1000000,
+ *         offset: 1000000
+ *     }
+ */
+export interface CountEntityKeysRequest {
+    definitionId?: string;
+    entityType?: Schematic.EntityType;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

@@ -1,5 +1,6 @@
 export type { CountCompaniesRequest } from "./CountCompaniesRequest";
 export type { CountEntityKeyDefinitionsRequest } from "./CountEntityKeyDefinitionsRequest";
+export type { CountEntityKeysRequest } from "./CountEntityKeysRequest";
 export type { CountEntityTraitDefinitionsRequest } from "./CountEntityTraitDefinitionsRequest";
 export type { CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
 export type { CountUsersRequest } from "./CountUsersRequest";

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

@@ -0,0 +1,12 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface CountEntityKeysParams {
+    definitionId?: string;
+    entityType?: Schematic.EntityType;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

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

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

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

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

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

@@ -2,6 +2,8 @@ export * from "./CountCompaniesParams";
 export * from "./CountCompaniesResponse";
 export * from "./CountEntityKeyDefinitionsParams";
 export * from "./CountEntityKeyDefinitionsResponse";
+export * from "./CountEntityKeysParams";
+export * from "./CountEntityKeysResponse";
 export * from "./CountEntityTraitDefinitionsParams";
 export * from "./CountEntityTraitDefinitionsResponse";
 export * from "./CountPlanTraitsParams";
@@ -14,6 +16,7 @@ export * from "./DeleteCompanyByKeysResponse";
 export * from "./DeleteCompanyMembershipResponse";
 export * from "./DeleteCompanyParams";
 export * from "./DeleteCompanyResponse";
+export * from "./DeleteEntityKeyDefinitionResponse";
 export * from "./DeleteUserByKeysResponse";
 export * from "./DeleteUserResponse";
 export * from "./GetActiveCompanySubscriptionParams";

package/dist/api/types/BillingCreditView.d.ts

@@ -18,7 +18,7 @@ export interface BillingCreditView {
     price?: Schematic.BillingPriceView;
     pricePerUnit?: number;
     pricePerUnitDecimal?: string;
-    product?: Schematic.BillingProductResponseData;
+    product?: Schematic.BillingProductRecordResponseData;
     singularName?: string;
     updatedAt: Date;
 }

package/dist/api/types/BillingProductRecordResponseData.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../index";
+export interface BillingProductRecordResponseData {
+    accountId: string;
+    createdAt: Date;
+    environmentId: string;
+    externalId: string;
+    id: string;
+    isActive: boolean;
+    name: string;
+    providerType: Schematic.BillingProviderType;
+    updatedAt: Date;
+}

package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts

@@ -1,10 +1,11 @@
+import type * as Schematic from "../index";
 export interface CompanyFeatureUsageExportMetadata {
     /** Restrict the export to these Schematic company IDs (starting with 'comp_') */
     companyIds?: string[];
     /** Restrict the export to companies with these billing credit type IDs */
     creditTypeIds?: string[];
-    /** Schematic feature IDs (starting with 'feat_') to include as usage columns; at least one is required */
-    featureIds: string[];
+    /** Schematic feature IDs (starting with 'feat_') to include as usage columns; empty means no usage columns */
+    featureIds?: string[];
     /** Restrict the export to companies that do (or do not) have a scheduled downgrade */
     hasScheduledDowngrade?: boolean;
     /** Restrict the export to companies with (or without) a monetized subscription */
@@ -19,10 +20,16 @@ export interface CompanyFeatureUsageExportMetadata {
     planVersionId?: string;
     /** Free-text search over company name and keys */
     q?: string;
+    /** Column to sort the exported rows by (e.g. name, created_at, plan); defaults to name */
+    sortOrderColumn?: string;
+    /** Direction to sort the exported rows by; defaults to asc */
+    sortOrderDirection?: Schematic.CompanyFeatureUsageExportMetadataSortOrderDirection;
     /** Restrict the export to companies whose subscription has one of these statuses */
     subscriptionStatuses?: string[];
     /** Restrict the export to companies whose subscription has one of these types */
     subscriptionTypes?: string[];
+    /** Company columns to include, mirroring the companies list; omit to include the plan column only */
+    visibleColumns?: Schematic.CompanyFeatureUsageExportMetadataVisibleColumnsItem[];
     /** Restrict the export to companies that have an entitlement for this feature ID */
     withEntitlementFor?: string;
     /** Restrict the export to companies with a subscription */

package/dist/api/types/CompanyFeatureUsageExportMetadataSortOrderDirection.d.ts

@@ -0,0 +1,6 @@
+/** Direction to sort the exported rows by; defaults to asc */
+export declare const CompanyFeatureUsageExportMetadataSortOrderDirection: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type CompanyFeatureUsageExportMetadataSortOrderDirection = (typeof CompanyFeatureUsageExportMetadataSortOrderDirection)[keyof typeof CompanyFeatureUsageExportMetadataSortOrderDirection];

package/dist/api/types/CompanyFeatureUsageExportMetadataVisibleColumnsItem.d.ts

@@ -0,0 +1,7 @@
+export declare const CompanyFeatureUsageExportMetadataVisibleColumnsItem: {
+    readonly Plan: "plan";
+    readonly Subscription: "subscription";
+    readonly Users: "users";
+    readonly LastSeenAt: "last_seen_at";
+};
+export type CompanyFeatureUsageExportMetadataVisibleColumnsItem = (typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem)[keyof typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem];

package/dist/api/types/DataExportMetadata.d.ts

@@ -1,5 +1,5 @@
 import type * as Schematic from "../index";
-export type DataExportMetadata = Schematic.DataExportMetadata.AuditLog | Schematic.DataExportMetadata.CompanyFeatureUsage;
+export type DataExportMetadata = Schematic.DataExportMetadata.AuditLog | Schematic.DataExportMetadata.CompanyFeatureUsage | Schematic.DataExportMetadata.Event;
 export declare namespace DataExportMetadata {
     interface AuditLog extends Schematic.AuditLogExportMetadata {
         exportType: "audit-log";
@@ -7,4 +7,7 @@ export declare namespace DataExportMetadata {
     interface CompanyFeatureUsage extends Schematic.CompanyFeatureUsageExportMetadata {
         exportType: "company-feature-usage";
     }
+    interface Event extends Schematic.EventExportMetadata {
+        exportType: "event";
+    }
 }

package/dist/api/types/DataExportType.d.ts

@@ -1,5 +1,6 @@
 export declare const DataExportType: {
     readonly AuditLog: "audit-log";
     readonly CompanyFeatureUsage: "company-feature-usage";
+    readonly Event: "event";
 };
 export type DataExportType = (typeof DataExportType)[keyof typeof DataExportType];

package/dist/api/types/EventExportMetadata.d.ts

@@ -0,0 +1,19 @@
+import type * as Schematic from "../index";
+export interface EventExportMetadata {
+    /** Restrict the export to events for this company ID (starting with 'comp_') */
+    companyId?: string;
+    /** Restrict the export to events captured at or before this time */
+    endTime?: Date;
+    /** Restrict the export to track events with this subtype */
+    eventSubtype?: string;
+    /** Restrict the export to these event types (e.g. "track", "identify"); defaults to track, identify and inference events. Flag check events are only exported when requested here explicitly, and require a flag_id. */
+    eventTypes?: Schematic.EventExportMetadataEventTypesItem[];
+    /** Restrict the export to flag-check events for this flag ID (starting with 'flag_') */
+    flagId?: string;
+    /** Account member emails to notify when the export completes; empty means the artifact is only retrievable via the API */
+    notificationEmailRecipientEmailAddresses?: string[];
+    /** Restrict the export to events captured at or after this time */
+    startTime?: Date;
+    /** Restrict the export to events for this user ID (starting with 'user_') */
+    userId?: string;
+}

package/dist/api/types/EventExportMetadataEventTypesItem.d.ts

@@ -0,0 +1,7 @@
+export declare const EventExportMetadataEventTypesItem: {
+    readonly FlagCheck: "flag_check";
+    readonly Identify: "identify";
+    readonly Inference: "inference";
+    readonly Track: "track";
+};
+export type EventExportMetadataEventTypesItem = (typeof EventExportMetadataEventTypesItem)[keyof typeof EventExportMetadataEventTypesItem];

package/dist/api/types/FeatureView.d.ts

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface FeatureView {
     accountId: string;
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
-    billingProduct?: Schematic.BillingProductResponseData;
+    billingProduct?: Schematic.BillingProductRecordResponseData;
     createdAt: Date;
     description: string;
     eventSubtype?: string;

package/dist/api/types/TestWebhookResponseData.d.ts

@@ -1,4 +1,5 @@
 export interface TestWebhookResponseData {
+    failureReason?: string;
     responseCode: number;
     success: boolean;
 }

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

@@ -49,6 +49,7 @@ export * from "./BillingProductPriceInterval";
 export * from "./BillingProductPriceResponseData";
 export * from "./BillingProductPriceTierResponseData";
 export * from "./BillingProductPricing";
+export * from "./BillingProductRecordResponseData";
 export * from "./BillingProductResponseData";
 export * from "./BillingProviderType";
 export * from "./BillingStrategy";
@@ -98,6 +99,8 @@ export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
 export * from "./CompanyEventPeriodMetricsResponseData";
 export * from "./CompanyFeatureUsageExportMetadata";
+export * from "./CompanyFeatureUsageExportMetadataSortOrderDirection";
+export * from "./CompanyFeatureUsageExportMetadataVisibleColumnsItem";
 export * from "./CompanyLedgerResponseData";
 export * from "./CompanyMatchingCriteria";
 export * from "./CompanyMembershipDetailResponseData";
@@ -218,6 +221,8 @@ export * from "./EventBodyIdentifyCompany";
 export * from "./EventBodyInference";
 export * from "./EventBodyTrack";
 export * from "./EventDetailResponseData";
+export * from "./EventExportMetadata";
+export * from "./EventExportMetadataEventTypesItem";
 export * from "./EventResponseData";
 export * from "./EventStatus";
 export * from "./EventSummaryResponseData";