@schematichq/schematic-typescript-node 1.1.10 → 1.1.12

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

@@ -33,12 +33,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.listCompanyOverrides()
      */
-    listCompanyOverrides(request?: Schematic.ListCompanyOverridesRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.ListCompanyOverridesResponse>;
+    listCompanyOverrides(request?: Schematic.ListCompanyOverridesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyOverridesResponse>;
+    private __listCompanyOverrides;
     /**
      * @param {Schematic.CreateCompanyOverrideRequestBody} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,6 +48,7 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -55,7 +58,8 @@ export declare class Entitlements {
      *         valueType: "boolean"
      *     })
      */
-    createCompanyOverride(request: Schematic.CreateCompanyOverrideRequestBody, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CreateCompanyOverrideResponse>;
+    createCompanyOverride(request: Schematic.CreateCompanyOverrideRequestBody, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CreateCompanyOverrideResponse>;
+    private __createCompanyOverride;
     /**
      * @param {string} companyOverrideId - company_override_id
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -68,7 +72,8 @@ export declare class Entitlements {
      * @example
      *     await client.entitlements.getCompanyOverride("company_override_id")
      */
-    getCompanyOverride(companyOverrideId: string, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.GetCompanyOverrideResponse>;
+    getCompanyOverride(companyOverrideId: string, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyOverrideResponse>;
+    private __getCompanyOverride;
     /**
      * @param {string} companyOverrideId - company_override_id
      * @param {Schematic.UpdateCompanyOverrideRequestBody} request
@@ -85,7 +90,8 @@ export declare class Entitlements {
      *         valueType: "boolean"
      *     })
      */
-    updateCompanyOverride(companyOverrideId: string, request: Schematic.UpdateCompanyOverrideRequestBody, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.UpdateCompanyOverrideResponse>;
+    updateCompanyOverride(companyOverrideId: string, request: Schematic.UpdateCompanyOverrideRequestBody, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyOverrideResponse>;
+    private __updateCompanyOverride;
     /**
      * @param {string} companyOverrideId - company_override_id
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -93,12 +99,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.deleteCompanyOverride("company_override_id")
      */
-    deleteCompanyOverride(companyOverrideId: string, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.DeleteCompanyOverrideResponse>;
+    deleteCompanyOverride(companyOverrideId: string, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCompanyOverrideResponse>;
+    private __deleteCompanyOverride;
     /**
      * @param {Schematic.CountCompanyOverridesRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -106,12 +114,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.countCompanyOverrides()
      */
-    countCompanyOverrides(request?: Schematic.CountCompanyOverridesRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CountCompanyOverridesResponse>;
+    countCompanyOverrides(request?: Schematic.CountCompanyOverridesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyOverridesResponse>;
+    private __countCompanyOverrides;
     /**
      * @param {Schematic.ListFeatureCompaniesRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -119,6 +129,7 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -126,7 +137,8 @@ export declare class Entitlements {
      *         featureId: "feature_id"
      *     })
      */
-    listFeatureCompanies(request: Schematic.ListFeatureCompaniesRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.ListFeatureCompaniesResponse>;
+    listFeatureCompanies(request: Schematic.ListFeatureCompaniesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureCompaniesResponse>;
+    private __listFeatureCompanies;
     /**
      * @param {Schematic.CountFeatureCompaniesRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -134,6 +146,7 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -141,7 +154,8 @@ export declare class Entitlements {
      *         featureId: "feature_id"
      *     })
      */
-    countFeatureCompanies(request: Schematic.CountFeatureCompaniesRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CountFeatureCompaniesResponse>;
+    countFeatureCompanies(request: Schematic.CountFeatureCompaniesRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountFeatureCompaniesResponse>;
+    private __countFeatureCompanies;
     /**
      * @param {Schematic.ListFeatureUsageRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -149,12 +163,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.listFeatureUsage()
      */
-    listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.ListFeatureUsageResponse>;
+    listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageResponse>;
+    private __listFeatureUsage;
     /**
      * @param {Schematic.CountFeatureUsageRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -162,12 +178,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.countFeatureUsage()
      */
-    countFeatureUsage(request?: Schematic.CountFeatureUsageRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CountFeatureUsageResponse>;
+    countFeatureUsage(request?: Schematic.CountFeatureUsageRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountFeatureUsageResponse>;
+    private __countFeatureUsage;
     /**
      * @param {Schematic.ListFeatureUsersRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -175,6 +193,7 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -182,7 +201,8 @@ export declare class Entitlements {
      *         featureId: "feature_id"
      *     })
      */
-    listFeatureUsers(request: Schematic.ListFeatureUsersRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.ListFeatureUsersResponse>;
+    listFeatureUsers(request: Schematic.ListFeatureUsersRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsersResponse>;
+    private __listFeatureUsers;
     /**
      * @param {Schematic.CountFeatureUsersRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -190,6 +210,7 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
@@ -197,7 +218,8 @@ export declare class Entitlements {
      *         featureId: "feature_id"
      *     })
      */
-    countFeatureUsers(request: Schematic.CountFeatureUsersRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CountFeatureUsersResponse>;
+    countFeatureUsers(request: Schematic.CountFeatureUsersRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountFeatureUsersResponse>;
+    private __countFeatureUsers;
     /**
      * @param {Schematic.ListPlanEntitlementsRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -205,12 +227,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.listPlanEntitlements()
      */
-    listPlanEntitlements(request?: Schematic.ListPlanEntitlementsRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.ListPlanEntitlementsResponse>;
+    listPlanEntitlements(request?: Schematic.ListPlanEntitlementsRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanEntitlementsResponse>;
+    private __listPlanEntitlements;
     /**
      * @param {Schematic.CreatePlanEntitlementRequestBody} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -218,16 +242,20 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.createPlanEntitlement({
      *         featureId: "feature_id",
      *         planId: "plan_id",
+     *         priceTiers: [{}],
+     *         tierMode: "tier_mode",
      *         valueType: "boolean"
      *     })
      */
-    createPlanEntitlement(request: Schematic.CreatePlanEntitlementRequestBody, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CreatePlanEntitlementResponse>;
+    createPlanEntitlement(request: Schematic.CreatePlanEntitlementRequestBody, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanEntitlementResponse>;
+    private __createPlanEntitlement;
     /**
      * @param {string} planEntitlementId - plan_entitlement_id
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -240,7 +268,8 @@ export declare class Entitlements {
      * @example
      *     await client.entitlements.getPlanEntitlement("plan_entitlement_id")
      */
-    getPlanEntitlement(planEntitlementId: string, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.GetPlanEntitlementResponse>;
+    getPlanEntitlement(planEntitlementId: string, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.GetPlanEntitlementResponse>;
+    private __getPlanEntitlement;
     /**
      * @param {string} planEntitlementId - plan_entitlement_id
      * @param {Schematic.UpdatePlanEntitlementRequestBody} request
@@ -254,10 +283,13 @@ export declare class Entitlements {
      *
      * @example
      *     await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
+     *         priceTiers: [{}],
+     *         tierMode: "tier_mode",
      *         valueType: "boolean"
      *     })
      */
-    updatePlanEntitlement(planEntitlementId: string, request: Schematic.UpdatePlanEntitlementRequestBody, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.UpdatePlanEntitlementResponse>;
+    updatePlanEntitlement(planEntitlementId: string, request: Schematic.UpdatePlanEntitlementRequestBody, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanEntitlementResponse>;
+    private __updatePlanEntitlement;
     /**
      * @param {string} planEntitlementId - plan_entitlement_id
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -265,12 +297,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.deletePlanEntitlement("plan_entitlement_id")
      */
-    deletePlanEntitlement(planEntitlementId: string, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.DeletePlanEntitlementResponse>;
+    deletePlanEntitlement(planEntitlementId: string, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanEntitlementResponse>;
+    private __deletePlanEntitlement;
     /**
      * @param {Schematic.CountPlanEntitlementsRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -278,12 +312,14 @@ export declare class Entitlements {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.entitlements.countPlanEntitlements()
      */
-    countPlanEntitlements(request?: Schematic.CountPlanEntitlementsRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.CountPlanEntitlementsResponse>;
+    countPlanEntitlements(request?: Schematic.CountPlanEntitlementsRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.CountPlanEntitlementsResponse>;
+    private __countPlanEntitlements;
     /**
      * @param {Schematic.GetFeatureUsageByCompanyRequest} request
      * @param {Entitlements.RequestOptions} requestOptions - Request-specific configuration.
@@ -296,13 +332,12 @@ export declare class Entitlements {
      * @example
      *     await client.entitlements.getFeatureUsageByCompany({
      *         keys: {
-     *             "keys": {
-     *                 "key": "value"
-     *             }
+     *             "keys": "keys"
      *         }
      *     })
      */
-    getFeatureUsageByCompany(request: Schematic.GetFeatureUsageByCompanyRequest, requestOptions?: Entitlements.RequestOptions): Promise<Schematic.GetFeatureUsageByCompanyResponse>;
+    getFeatureUsageByCompany(request: Schematic.GetFeatureUsageByCompanyRequest, requestOptions?: Entitlements.RequestOptions): core.HttpResponsePromise<Schematic.GetFeatureUsageByCompanyResponse>;
+    private __getFeatureUsageByCompany;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;