@schematichq/schematic-typescript-node 1.2.2 → 1.2.3

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

@@ -9,7 +9,7 @@ export declare namespace Entitlements {
         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 Entitlements {
 }
 export declare class Entitlements {
     protected readonly _options: Entitlements.Options;
-    constructor(_options: Entitlements.Options);
+    constructor(_options?: Entitlements.Options);
     /**
      * @param {Schematic.ListCompanyOverridesRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.entitlements.listCompanyOverrides()
+     *     await client.entitlements.listCompanyOverrides({
+     *         companyId: "company_id",
+     *         featureId: "feature_id",
+     *         withoutExpired: true,
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listCompanyOverrides(request?: Schematic.ListCompanyOverridesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyOverridesResponse>;
     private __listCompanyOverrides;
@@ -118,7 +125,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.entitlements.countCompanyOverrides()
+     *     await client.entitlements.countCompanyOverrides({
+     *         companyId: "company_id",
+     *         featureId: "feature_id",
+     *         withoutExpired: true,
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countCompanyOverrides(request?: Schematic.CountCompanyOverridesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyOverridesResponse>;
     private __countCompanyOverrides;
@@ -134,7 +148,10 @@ export declare class Entitlements {
      *
      * @example
      *     await client.entitlements.listFeatureCompanies({
-     *         featureId: "feature_id"
+     *         featureId: "feature_id",
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
      *     })
      */
     listFeatureCompanies(request: Schematic.ListFeatureCompaniesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureCompaniesResponse>;
@@ -151,7 +168,10 @@ export declare class Entitlements {
      *
      * @example
      *     await client.entitlements.countFeatureCompanies({
-     *         featureId: "feature_id"
+     *         featureId: "feature_id",
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
      *     })
      */
     countFeatureCompanies(request: Schematic.CountFeatureCompaniesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountFeatureCompaniesResponse>;
@@ -167,7 +187,13 @@ export declare class Entitlements {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.entitlements.listFeatureUsage()
+     *     await client.entitlements.listFeatureUsage({
+     *         companyId: "company_id",
+     *         q: "q",
+     *         withoutNegativeEntitlements: true,
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageResponse>;
     private __listFeatureUsage;
@@ -182,7 +208,13 @@ export declare class Entitlements {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.entitlements.countFeatureUsage()
+     *     await client.entitlements.countFeatureUsage({
+     *         companyId: "company_id",
+     *         q: "q",
+     *         withoutNegativeEntitlements: true,
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countFeatureUsage(request?: Schematic.CountFeatureUsageRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountFeatureUsageResponse>;
     private __countFeatureUsage;
@@ -198,7 +230,10 @@ export declare class Entitlements {
      *
      * @example
      *     await client.entitlements.listFeatureUsers({
-     *         featureId: "feature_id"
+     *         featureId: "feature_id",
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
      *     })
      */
     listFeatureUsers(request: Schematic.ListFeatureUsersRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsersResponse>;
@@ -215,7 +250,10 @@ export declare class Entitlements {
      *
      * @example
      *     await client.entitlements.countFeatureUsers({
-     *         featureId: "feature_id"
+     *         featureId: "feature_id",
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
      *     })
      */
     countFeatureUsers(request: Schematic.CountFeatureUsersRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountFeatureUsersResponse>;
@@ -231,7 +269,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.entitlements.listPlanEntitlements()
+     *     await client.entitlements.listPlanEntitlements({
+     *         featureId: "feature_id",
+     *         planId: "plan_id",
+     *         q: "q",
+     *         withMeteredProducts: true,
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listPlanEntitlements(request?: Schematic.ListPlanEntitlementsRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanEntitlementsResponse>;
     private __listPlanEntitlements;
@@ -312,7 +357,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.entitlements.countPlanEntitlements()
+     *     await client.entitlements.countPlanEntitlements({
+     *         featureId: "feature_id",
+     *         planId: "plan_id",
+     *         q: "q",
+     *         withMeteredProducts: true,
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countPlanEntitlements(request?: Schematic.CountPlanEntitlementsRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountPlanEntitlementsResponse>;
     private __countPlanEntitlements;
@@ -335,6 +387,6 @@ export declare class Entitlements {
     getFeatureUsageByCompany(request: Schematic.GetFeatureUsageByCompanyRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.GetFeatureUsageByCompanyResponse>;
     private __getFeatureUsageByCompany;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Schematic-Api-Key": string;
+        "X-Schematic-Api-Key": string | undefined;
     }>;
 }

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

@@ -3,7 +3,14 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         featureId: "feature_id",
+ *         withoutExpired: true,
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountCompanyOverridesRequest {
     /**

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

@@ -4,7 +4,10 @@
 /**
  * @example
  *     {
- *         featureId: "feature_id"
+ *         featureId: "feature_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
  *     }
  */
 export interface CountFeatureCompaniesRequest {

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

@@ -3,7 +3,13 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         q: "q",
+ *         withoutNegativeEntitlements: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountFeatureUsageRequest {
     companyId?: string;

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

@@ -4,7 +4,10 @@
 /**
  * @example
  *     {
- *         featureId: "feature_id"
+ *         featureId: "feature_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
  *     }
  */
 export interface CountFeatureUsersRequest {

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

@@ -3,7 +3,14 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         featureId: "feature_id",
+ *         planId: "plan_id",
+ *         q: "q",
+ *         withMeteredProducts: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountPlanEntitlementsRequest {
     /**

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

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

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

@@ -12,6 +12,7 @@ import * as Schematic from "../../../../index";
  */
 export interface CreatePlanEntitlementRequestBody {
     billingProductId?: string;
+    billingThreshold?: number;
     creditConsumptionRate?: number;
     currency?: string;
     featureId: string;

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

@@ -3,7 +3,14 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         featureId: "feature_id",
+ *         withoutExpired: true,
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListCompanyOverridesRequest {
     /**

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

@@ -4,7 +4,10 @@
 /**
  * @example
  *     {
- *         featureId: "feature_id"
+ *         featureId: "feature_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
  *     }
  */
 export interface ListFeatureCompaniesRequest {

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

@@ -3,7 +3,13 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         q: "q",
+ *         withoutNegativeEntitlements: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListFeatureUsageRequest {
     companyId?: string;

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

@@ -4,7 +4,10 @@
 /**
  * @example
  *     {
- *         featureId: "feature_id"
+ *         featureId: "feature_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
  *     }
  */
 export interface ListFeatureUsersRequest {

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

@@ -3,7 +3,14 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         featureId: "feature_id",
+ *         planId: "plan_id",
+ *         q: "q",
+ *         withMeteredProducts: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListPlanEntitlementsRequest {
     /**

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

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

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

@@ -10,6 +10,7 @@ import * as Schematic from "../../../../index";
  */
 export interface UpdatePlanEntitlementRequestBody {
     billingProductId?: string;
+    billingThreshold?: number;
     creditConsumptionRate?: number;
     currency?: string;
     metricPeriod?: Schematic.UpdatePlanEntitlementRequestBodyMetricPeriod;

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

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

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

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

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

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

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

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

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

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

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

@@ -9,7 +9,7 @@ export declare namespace Events {
         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 Events {
 }
 export declare class Events {
     protected readonly _options: Events.Options;
-    constructor(_options: Events.Options);
+    constructor(_options?: Events.Options);
     /**
      * @param {Schematic.CreateEventBatchRequestBody} request
      * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,11 @@ export declare class Events {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.events.getEventSummaries()
+     *     await client.events.getEventSummaries({
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     getEventSummaries(request?: Schematic.GetEventSummariesRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetEventSummariesResponse>;
     private __getEventSummaries;
@@ -71,7 +75,14 @@ export declare class Events {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.events.listEvents()
+     *     await client.events.listEvents({
+     *         companyId: "company_id",
+     *         eventSubtype: "event_subtype",
+     *         flagId: "flag_id",
+     *         userId: "user_id",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listEvents(request?: Schematic.ListEventsRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.ListEventsResponse>;
     private __listEvents;
@@ -120,6 +131,6 @@ export declare class Events {
     getSegmentIntegrationStatus(requestOptions?: Events.RequestOptions): core.HttpResponsePromise<Schematic.GetSegmentIntegrationStatusResponse>;
     private __getSegmentIntegrationStatus;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Schematic-Api-Key": string;
+        "X-Schematic-Api-Key": string | undefined;
     }>;
 }

package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts

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

package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts

@@ -4,7 +4,14 @@
 import * as Schematic from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         companyId: "company_id",
+ *         eventSubtype: "event_subtype",
+ *         flagId: "flag_id",
+ *         userId: "user_id",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListEventsRequest {
     companyId?: string;

package/dist/api/resources/events/types/GetEventSummariesResponse.d.ts

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

package/dist/api/resources/events/types/ListEventsResponse.d.ts

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

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

@@ -9,7 +9,7 @@ export declare namespace Features {
         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 Features {
 }
 export declare class Features {
     protected readonly _options: Features.Options;
-    constructor(_options: Features.Options);
+    constructor(_options?: Features.Options);
     /**
      * @param {Schematic.AudienceRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -149,7 +149,14 @@ export declare class Features {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.features.listFeatures()
+     *     await client.features.listFeatures({
+     *         q: "q",
+     *         withoutCompanyOverrideFor: "without_company_override_for",
+     *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
+     *         booleanRequireEvent: true,
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listFeatures(request?: Schematic.ListFeaturesRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListFeaturesResponse>;
     private __listFeatures;
@@ -228,7 +235,14 @@ export declare class Features {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.features.countFeatures()
+     *     await client.features.countFeatures({
+     *         q: "q",
+     *         withoutCompanyOverrideFor: "without_company_override_for",
+     *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
+     *         booleanRequireEvent: true,
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countFeatures(request?: Schematic.CountFeaturesRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountFeaturesResponse>;
     private __countFeatures;
@@ -243,7 +257,12 @@ export declare class Features {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.features.listFlags()
+     *     await client.features.listFlags({
+     *         featureId: "feature_id",
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     listFlags(request?: Schematic.ListFlagsRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListFlagsResponse>;
     private __listFlags;
@@ -395,11 +414,16 @@ export declare class Features {
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
-     *     await client.features.countFlags()
+     *     await client.features.countFlags({
+     *         featureId: "feature_id",
+     *         q: "q",
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     countFlags(request?: Schematic.CountFlagsRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountFlagsResponse>;
     private __countFlags;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Schematic-Api-Key": string;
+        "X-Schematic-Api-Key": string | undefined;
     }>;
 }

package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts

@@ -3,10 +3,20 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         withoutCompanyOverrideFor: "without_company_override_for",
+ *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
+ *         booleanRequireEvent: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountFeaturesRequest {
     ids?: string | string[];
+    /**
+     * Search by feature name or ID
+     */
     q?: string;
     /**
      * Filter out features that already have a company override for the specified company ID

package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts

@@ -3,11 +3,19 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         featureId: "feature_id",
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface CountFlagsRequest {
     featureId?: string;
     ids?: string | string[];
+    /**
+     * Search by flag name, key, or ID
+     */
     q?: string;
     /**
      * Page limit (default 100)

package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts

@@ -3,10 +3,20 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         withoutCompanyOverrideFor: "without_company_override_for",
+ *         withoutPlanEntitlementFor: "without_plan_entitlement_for",
+ *         booleanRequireEvent: true,
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListFeaturesRequest {
     ids?: string | string[];
+    /**
+     * Search by feature name or ID
+     */
     q?: string;
     /**
      * Filter out features that already have a company override for the specified company ID