@schematichq/schematic-typescript-node 1.1.10 → 1.1.12

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

@@ -17,6 +17,7 @@ export interface CreateCompanyOverrideRequestBody {
     metricPeriod?: Schematic.CreateCompanyOverrideRequestBodyMetricPeriod;
     metricPeriodMonthReset?: Schematic.CreateCompanyOverrideRequestBodyMetricPeriodMonthReset;
     valueBool?: boolean;
+    valueCreditId?: string;
     valueNumeric?: number;
     valueTraitId?: string;
     valueType: Schematic.CreateCompanyOverrideRequestBodyValueType;

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

@@ -7,20 +7,32 @@ import * as Schematic from "../../../../index";
  *     {
  *         featureId: "feature_id",
  *         planId: "plan_id",
+ *         priceTiers: [{}],
+ *         tierMode: "tier_mode",
  *         valueType: "boolean"
  *     }
  */
 export interface CreatePlanEntitlementRequestBody {
+    creditConsumptionRate?: number;
+    currency?: string;
     featureId: string;
     metricPeriod?: Schematic.CreatePlanEntitlementRequestBodyMetricPeriod;
     metricPeriodMonthReset?: Schematic.CreatePlanEntitlementRequestBodyMetricPeriodMonthReset;
     monthlyMeteredPriceId?: string;
+    monthlyUnitPrice?: number;
+    monthlyUnitPriceDecimal?: string;
+    overageBillingProductId?: string;
     planId: string;
-    priceBehavior?: string;
+    priceBehavior?: Schematic.CreatePlanEntitlementRequestBodyPriceBehavior;
+    priceTiers: Schematic.CreatePriceTierRequestBody[];
     softLimit?: number;
+    tierMode: string;
     valueBool?: boolean;
+    valueCreditId?: string;
     valueNumeric?: number;
     valueTraitId?: string;
     valueType: Schematic.CreatePlanEntitlementRequestBodyValueType;
     yearlyMeteredPriceId?: string;
+    yearlyUnitPrice?: number;
+    yearlyUnitPriceDecimal?: string;
 }

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

@@ -5,9 +5,7 @@
  * @example
  *     {
  *         keys: {
- *             "keys": {
- *                 "key": "value"
- *             }
+ *             "keys": "keys"
  *         }
  *     }
  */
@@ -15,5 +13,5 @@ export interface GetFeatureUsageByCompanyRequest {
     /**
      * Key/value pairs
      */
-    keys: Record<string, unknown>;
+    keys: Record<string, string>;
 }

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

@@ -13,6 +13,7 @@ export interface UpdateCompanyOverrideRequestBody {
     metricPeriod?: Schematic.UpdateCompanyOverrideRequestBodyMetricPeriod;
     metricPeriodMonthReset?: Schematic.UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset;
     valueBool?: boolean;
+    valueCreditId?: string;
     valueNumeric?: number;
     valueTraitId?: string;
     valueType: Schematic.UpdateCompanyOverrideRequestBodyValueType;

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

@@ -5,18 +5,30 @@ import * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         priceTiers: [{}],
+ *         tierMode: "tier_mode",
  *         valueType: "boolean"
  *     }
  */
 export interface UpdatePlanEntitlementRequestBody {
+    creditConsumptionRate?: number;
+    currency?: string;
     metricPeriod?: Schematic.UpdatePlanEntitlementRequestBodyMetricPeriod;
     metricPeriodMonthReset?: Schematic.UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset;
     monthlyMeteredPriceId?: string;
-    priceBehavior?: string;
+    monthlyUnitPrice?: number;
+    monthlyUnitPriceDecimal?: string;
+    overageBillingProductId?: string;
+    priceBehavior?: Schematic.UpdatePlanEntitlementRequestBodyPriceBehavior;
+    priceTiers: Schematic.CreatePriceTierRequestBody[];
     softLimit?: number;
+    tierMode: string;
     valueBool?: boolean;
+    valueCreditId?: string;
     valueNumeric?: number;
     valueTraitId?: string;
     valueType: Schematic.UpdatePlanEntitlementRequestBodyValueType;
     yearlyMeteredPriceId?: string;
+    yearlyUnitPrice?: number;
+    yearlyUnitPriceDecimal?: string;
 }

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

@@ -1,9 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreateCompanyOverrideRequestBodyValueType = "boolean" | "numeric" | "trait" | "unlimited";
+export type CreateCompanyOverrideRequestBodyValueType = "boolean" | "credit" | "numeric" | "trait" | "unlimited";
 export declare const CreateCompanyOverrideRequestBodyValueType: {
     readonly Boolean: "boolean";
+    readonly Credit: "credit";
     readonly Numeric: "numeric";
     readonly Trait: "trait";
     readonly Unlimited: "unlimited";

package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateCompanyOverrideRequestBodyValueType = void 0;
 exports.CreateCompanyOverrideRequestBodyValueType = {
     Boolean: "boolean",
+    Credit: "credit",
     Numeric: "numeric",
     Trait: "trait",
     Unlimited: "unlimited",

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreatePlanEntitlementRequestBodyPriceBehavior = "pay_as_you_go" | "pay_in_advance" | "overage" | "credit_burndown" | "tier";
+export declare const CreatePlanEntitlementRequestBodyPriceBehavior: {
+    readonly PayAsYouGo: "pay_as_you_go";
+    readonly PayInAdvance: "pay_in_advance";
+    readonly Overage: "overage";
+    readonly CreditBurndown: "credit_burndown";
+    readonly Tier: "tier";
+};

package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreatePlanEntitlementRequestBodyPriceBehavior = void 0;
+exports.CreatePlanEntitlementRequestBodyPriceBehavior = {
+    PayAsYouGo: "pay_as_you_go",
+    PayInAdvance: "pay_in_advance",
+    Overage: "overage",
+    CreditBurndown: "credit_burndown",
+    Tier: "tier",
+};

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

@@ -1,9 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreatePlanEntitlementRequestBodyValueType = "boolean" | "numeric" | "trait" | "unlimited";
+export type CreatePlanEntitlementRequestBodyValueType = "boolean" | "credit" | "numeric" | "trait" | "unlimited";
 export declare const CreatePlanEntitlementRequestBodyValueType: {
     readonly Boolean: "boolean";
+    readonly Credit: "credit";
     readonly Numeric: "numeric";
     readonly Trait: "trait";
     readonly Unlimited: "unlimited";

package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreatePlanEntitlementRequestBodyValueType = void 0;
 exports.CreatePlanEntitlementRequestBodyValueType = {
     Boolean: "boolean",
+    Credit: "credit",
     Numeric: "numeric",
     Trait: "trait",
     Unlimited: "unlimited",

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

@@ -5,5 +5,5 @@
  * Input parameters
  */
 export interface GetFeatureUsageByCompanyParams {
-    keys?: Record<string, unknown>;
+    keys?: Record<string, string>;
 }

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

@@ -1,9 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type UpdateCompanyOverrideRequestBodyValueType = "boolean" | "numeric" | "trait" | "unlimited";
+export type UpdateCompanyOverrideRequestBodyValueType = "boolean" | "credit" | "numeric" | "trait" | "unlimited";
 export declare const UpdateCompanyOverrideRequestBodyValueType: {
     readonly Boolean: "boolean";
+    readonly Credit: "credit";
     readonly Numeric: "numeric";
     readonly Trait: "trait";
     readonly Unlimited: "unlimited";

package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateCompanyOverrideRequestBodyValueType = void 0;
 exports.UpdateCompanyOverrideRequestBodyValueType = {
     Boolean: "boolean",
+    Credit: "credit",
     Numeric: "numeric",
     Trait: "trait",
     Unlimited: "unlimited",

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UpdatePlanEntitlementRequestBodyPriceBehavior = "pay_as_you_go" | "pay_in_advance" | "overage" | "credit_burndown" | "tier";
+export declare const UpdatePlanEntitlementRequestBodyPriceBehavior: {
+    readonly PayAsYouGo: "pay_as_you_go";
+    readonly PayInAdvance: "pay_in_advance";
+    readonly Overage: "overage";
+    readonly CreditBurndown: "credit_burndown";
+    readonly Tier: "tier";
+};

package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdatePlanEntitlementRequestBodyPriceBehavior = void 0;
+exports.UpdatePlanEntitlementRequestBodyPriceBehavior = {
+    PayAsYouGo: "pay_as_you_go",
+    PayInAdvance: "pay_in_advance",
+    Overage: "overage",
+    CreditBurndown: "credit_burndown",
+    Tier: "tier",
+};

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

@@ -1,9 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type UpdatePlanEntitlementRequestBodyValueType = "boolean" | "numeric" | "trait" | "unlimited";
+export type UpdatePlanEntitlementRequestBodyValueType = "boolean" | "credit" | "numeric" | "trait" | "unlimited";
 export declare const UpdatePlanEntitlementRequestBodyValueType: {
     readonly Boolean: "boolean";
+    readonly Credit: "credit";
     readonly Numeric: "numeric";
     readonly Trait: "trait";
     readonly Unlimited: "unlimited";

package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdatePlanEntitlementRequestBodyValueType = void 0;
 exports.UpdatePlanEntitlementRequestBodyValueType = {
     Boolean: "boolean",
+    Credit: "credit",
     Numeric: "numeric",
     Trait: "trait",
     Unlimited: "unlimited",

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

@@ -28,11 +28,13 @@ export * from "./ListPlanEntitlementsParams";
 export * from "./ListPlanEntitlementsResponse";
 export * from "./CreatePlanEntitlementRequestBodyMetricPeriod";
 export * from "./CreatePlanEntitlementRequestBodyMetricPeriodMonthReset";
+export * from "./CreatePlanEntitlementRequestBodyPriceBehavior";
 export * from "./CreatePlanEntitlementRequestBodyValueType";
 export * from "./CreatePlanEntitlementResponse";
 export * from "./GetPlanEntitlementResponse";
 export * from "./UpdatePlanEntitlementRequestBodyMetricPeriod";
 export * from "./UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset";
+export * from "./UpdatePlanEntitlementRequestBodyPriceBehavior";
 export * from "./UpdatePlanEntitlementRequestBodyValueType";
 export * from "./UpdatePlanEntitlementResponse";
 export * from "./DeletePlanEntitlementResponse";

package/dist/api/resources/entitlements/types/index.js

@@ -44,11 +44,13 @@ __exportStar(require("./ListPlanEntitlementsParams"), exports);
 __exportStar(require("./ListPlanEntitlementsResponse"), exports);
 __exportStar(require("./CreatePlanEntitlementRequestBodyMetricPeriod"), exports);
 __exportStar(require("./CreatePlanEntitlementRequestBodyMetricPeriodMonthReset"), exports);
+__exportStar(require("./CreatePlanEntitlementRequestBodyPriceBehavior"), exports);
 __exportStar(require("./CreatePlanEntitlementRequestBodyValueType"), exports);
 __exportStar(require("./CreatePlanEntitlementResponse"), exports);
 __exportStar(require("./GetPlanEntitlementResponse"), exports);
 __exportStar(require("./UpdatePlanEntitlementRequestBodyMetricPeriod"), exports);
 __exportStar(require("./UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset"), exports);
+__exportStar(require("./UpdatePlanEntitlementRequestBodyPriceBehavior"), exports);
 __exportStar(require("./UpdatePlanEntitlementRequestBodyValueType"), exports);
 __exportStar(require("./UpdatePlanEntitlementResponse"), exports);
 __exportStar(require("./DeletePlanEntitlementResponse"), exports);

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

@@ -33,6 +33,7 @@ export declare class Events {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -42,7 +43,8 @@ export declare class Events {
      *             }]
      *     })
      */
-    createEventBatch(request: Schematic.CreateEventBatchRequestBody, requestOptions?: Events.RequestOptions): Promise<Schematic.CreateEventBatchResponse>;
+    createEventBatch(request: Schematic.CreateEventBatchRequestBody, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.CreateEventBatchResponse>;
+    private __createEventBatch;
     /**
      * @param {Schematic.GetEventSummariesRequest} request
      * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,12 +52,14 @@ export declare class Events {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.events.getEventSummaries()
      */
-    getEventSummaries(request?: Schematic.GetEventSummariesRequest, requestOptions?: Events.RequestOptions): Promise<Schematic.GetEventSummariesResponse>;
+    getEventSummaries(request?: Schematic.GetEventSummariesRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetEventSummariesResponse>;
+    private __getEventSummaries;
     /**
      * @param {Schematic.ListEventsRequest} request
      * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
@@ -63,12 +67,14 @@ export declare class Events {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.events.listEvents()
      */
-    listEvents(request?: Schematic.ListEventsRequest, requestOptions?: Events.RequestOptions): Promise<Schematic.ListEventsResponse>;
+    listEvents(request?: Schematic.ListEventsRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.ListEventsResponse>;
+    private __listEvents;
     /**
      * @param {Schematic.CreateEventRequestBody} request
      * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
@@ -76,6 +82,7 @@ export declare class Events {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -83,7 +90,8 @@ export declare class Events {
      *         eventType: "identify"
      *     })
      */
-    createEvent(request: Schematic.CreateEventRequestBody, requestOptions?: Events.RequestOptions): Promise<Schematic.CreateEventResponse>;
+    createEvent(request: Schematic.CreateEventRequestBody, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.CreateEventResponse>;
+    private __createEvent;
     /**
      * @param {string} eventId - event_id
      * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,7 +104,8 @@ export declare class Events {
      * @example
      *     await client.events.getEvent("event_id")
      */
-    getEvent(eventId: string, requestOptions?: Events.RequestOptions): Promise<Schematic.GetEventResponse>;
+    getEvent(eventId: string, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetEventResponse>;
+    private __getEvent;
     /**
      * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -108,7 +117,8 @@ export declare class Events {
      * @example
      *     await client.events.getSegmentIntegrationStatus()
      */
-    getSegmentIntegrationStatus(requestOptions?: Events.RequestOptions): Promise<Schematic.GetSegmentIntegrationStatusResponse>;
+    getSegmentIntegrationStatus(requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetSegmentIntegrationStatusResponse>;
+    private __getSegmentIntegrationStatus;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;