@schematichq/schematic-typescript-node 1.1.9 → 1.1.11

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

@@ -7,6 +7,8 @@ import * as Schematic from "../../../index";
 export declare namespace Features {
     interface Options {
         environment?: core.Supplier<environments.SchematicEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
@@ -17,6 +19,8 @@ export declare namespace Features {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Features {
@@ -29,6 +33,7 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -47,7 +52,8 @@ export declare class Features {
      *             }]
      *     })
      */
-    countAudienceCompanies(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.CountAudienceCompaniesResponse>;
+    countAudienceCompanies(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountAudienceCompaniesResponse>;
+    private __countAudienceCompanies;
     /**
      * @param {Schematic.AudienceRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -55,6 +61,7 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -73,7 +80,8 @@ export declare class Features {
      *             }]
      *     })
      */
-    countAudienceUsers(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.CountAudienceUsersResponse>;
+    countAudienceUsers(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountAudienceUsersResponse>;
+    private __countAudienceUsers;
     /**
      * @param {Schematic.AudienceRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -81,6 +89,7 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -99,7 +108,8 @@ export declare class Features {
      *             }]
      *     })
      */
-    listAudienceCompanies(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.ListAudienceCompaniesResponse>;
+    listAudienceCompanies(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListAudienceCompaniesResponse>;
+    private __listAudienceCompanies;
     /**
      * @param {Schematic.AudienceRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -107,6 +117,7 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -125,7 +136,8 @@ export declare class Features {
      *             }]
      *     })
      */
-    listAudienceUsers(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.ListAudienceUsersResponse>;
+    listAudienceUsers(request: Schematic.AudienceRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListAudienceUsersResponse>;
+    private __listAudienceUsers;
     /**
      * @param {Schematic.ListFeaturesRequest} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -133,12 +145,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.listFeatures()
      */
-    listFeatures(request?: Schematic.ListFeaturesRequest, requestOptions?: Features.RequestOptions): Promise<Schematic.ListFeaturesResponse>;
+    listFeatures(request?: Schematic.ListFeaturesRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListFeaturesResponse>;
+    private __listFeatures;
     /**
      * @param {Schematic.CreateFeatureRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -146,6 +160,7 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -155,7 +170,8 @@ export declare class Features {
      *         name: "name"
      *     })
      */
-    createFeature(request: Schematic.CreateFeatureRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.CreateFeatureResponse>;
+    createFeature(request: Schematic.CreateFeatureRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CreateFeatureResponse>;
+    private __createFeature;
     /**
      * @param {string} featureId - feature_id
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -168,7 +184,8 @@ export declare class Features {
      * @example
      *     await client.features.getFeature("feature_id")
      */
-    getFeature(featureId: string, requestOptions?: Features.RequestOptions): Promise<Schematic.GetFeatureResponse>;
+    getFeature(featureId: string, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.GetFeatureResponse>;
+    private __getFeature;
     /**
      * @param {string} featureId - feature_id
      * @param {Schematic.UpdateFeatureRequestBody} request
@@ -183,7 +200,8 @@ export declare class Features {
      * @example
      *     await client.features.updateFeature("feature_id")
      */
-    updateFeature(featureId: string, request?: Schematic.UpdateFeatureRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.UpdateFeatureResponse>;
+    updateFeature(featureId: string, request?: Schematic.UpdateFeatureRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.UpdateFeatureResponse>;
+    private __updateFeature;
     /**
      * @param {string} featureId - feature_id
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -191,12 +209,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.deleteFeature("feature_id")
      */
-    deleteFeature(featureId: string, requestOptions?: Features.RequestOptions): Promise<Schematic.DeleteFeatureResponse>;
+    deleteFeature(featureId: string, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.DeleteFeatureResponse>;
+    private __deleteFeature;
     /**
      * @param {Schematic.CountFeaturesRequest} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -204,12 +224,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.countFeatures()
      */
-    countFeatures(request?: Schematic.CountFeaturesRequest, requestOptions?: Features.RequestOptions): Promise<Schematic.CountFeaturesResponse>;
+    countFeatures(request?: Schematic.CountFeaturesRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountFeaturesResponse>;
+    private __countFeatures;
     /**
      * @param {Schematic.ListFlagsRequest} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -217,12 +239,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.listFlags()
      */
-    listFlags(request?: Schematic.ListFlagsRequest, requestOptions?: Features.RequestOptions): Promise<Schematic.ListFlagsResponse>;
+    listFlags(request?: Schematic.ListFlagsRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.ListFlagsResponse>;
+    private __listFlags;
     /**
      * @param {Schematic.CreateFlagRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -230,6 +254,7 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -241,7 +266,8 @@ export declare class Features {
      *         name: "name"
      *     })
      */
-    createFlag(request: Schematic.CreateFlagRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.CreateFlagResponse>;
+    createFlag(request: Schematic.CreateFlagRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CreateFlagResponse>;
+    private __createFlag;
     /**
      * @param {string} flagId - flag_id
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -254,7 +280,8 @@ export declare class Features {
      * @example
      *     await client.features.getFlag("flag_id")
      */
-    getFlag(flagId: string, requestOptions?: Features.RequestOptions): Promise<Schematic.GetFlagResponse>;
+    getFlag(flagId: string, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.GetFlagResponse>;
+    private __getFlag;
     /**
      * @param {string} flagId - flag_id
      * @param {Schematic.CreateFlagRequestBody} request
@@ -275,7 +302,8 @@ export declare class Features {
      *         name: "name"
      *     })
      */
-    updateFlag(flagId: string, request: Schematic.CreateFlagRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.UpdateFlagResponse>;
+    updateFlag(flagId: string, request: Schematic.CreateFlagRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.UpdateFlagResponse>;
+    private __updateFlag;
     /**
      * @param {string} flagId - flag_id
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -283,12 +311,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.deleteFlag("flag_id")
      */
-    deleteFlag(flagId: string, requestOptions?: Features.RequestOptions): Promise<Schematic.DeleteFlagResponse>;
+    deleteFlag(flagId: string, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.DeleteFlagResponse>;
+    private __deleteFlag;
     /**
      * @param {string} flagId - flag_id
      * @param {Schematic.UpdateFlagRulesRequestBody} request
@@ -321,7 +351,8 @@ export declare class Features {
      *             }]
      *     })
      */
-    updateFlagRules(flagId: string, request: Schematic.UpdateFlagRulesRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.UpdateFlagRulesResponse>;
+    updateFlagRules(flagId: string, request: Schematic.UpdateFlagRulesRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.UpdateFlagRulesResponse>;
+    private __updateFlagRules;
     /**
      * @param {string} key - key
      * @param {Schematic.CheckFlagRequestBody} request
@@ -330,12 +361,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.checkFlag("key", {})
      */
-    checkFlag(key: string, request: Schematic.CheckFlagRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.CheckFlagResponse>;
+    checkFlag(key: string, request: Schematic.CheckFlagRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CheckFlagResponse>;
+    private __checkFlag;
     /**
      * @param {Schematic.CheckFlagRequestBody} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -343,12 +376,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.checkFlags({})
      */
-    checkFlags(request: Schematic.CheckFlagRequestBody, requestOptions?: Features.RequestOptions): Promise<Schematic.CheckFlagsResponse>;
+    checkFlags(request: Schematic.CheckFlagRequestBody, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CheckFlagsResponse>;
+    private __checkFlags;
     /**
      * @param {Schematic.CountFlagsRequest} request
      * @param {Features.RequestOptions} requestOptions - Request-specific configuration.
@@ -356,12 +391,14 @@ export declare class Features {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.features.countFlags()
      */
-    countFlags(request?: Schematic.CountFlagsRequest, requestOptions?: Features.RequestOptions): Promise<Schematic.CountFlagsResponse>;
+    countFlags(request?: Schematic.CountFlagsRequest, requestOptions?: Features.RequestOptions): core.HttpResponsePromise<Schematic.CountFlagsResponse>;
+    private __countFlags;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;