@zuplo/runtime 5.1804.0 → 5.1806.0

package/index.d.ts

@@ -2417,6 +2417,31 @@ export declare class MemoryZoneReadThroughCache<T = unknown> {
 
 /* Excluded from this release type: MeteringPlugin */
 
+declare type MeteringRegions = "us-central1" | "europe-west4";
+
+declare interface MeteringSubscription {
+    status: MeteringSubscriptionStatus;
+    type: "credits" | "periodic";
+    region: MeteringRegions;
+    renewalStrategy: "hourly" | "monthly" | "yearly";
+    customerKey: string;
+    /**
+     * Array of Stripe product ids, they start with "prod_"
+     */
+    planExternalIds: string[];
+    /**
+     * Stripe subscription id, starts with "sub_"
+     */
+    subscriptionExternalId?: string;
+    /**
+     * Stripe customer id, starts with "cus_"
+     */
+    customerExternalId?: string;
+    metadata?: Record<string, string>;
+}
+
+declare type MeteringSubscriptionStatus = "active" | "inactive" | "incomplete" | "incomplete-expired" | "trialing" | "past-due" | "canceled" | "unpaid";
+
 /* Excluded from this release type: MetricsData */
 
 declare abstract class MetricsPlugin extends RuntimePlugin {
@@ -2517,7 +2542,26 @@ export declare interface MoesifInboundPolicyOptions {
     logResponseBody?: boolean;
 }
 
-/* Excluded from this release type: MonetizationInboundPolicy */
+/**
+ * The Monetization policy enables you to track & monetize by your API's usage
+ *
+ * @remarks
+ * The Monetization policy allows you to track and monetize the usage of our API resources,
+ * declaratively and programatically.
+ *
+ * @title Monetization
+ * @public
+ * @param request - The ZuploRequest
+ * @param context - The ZuploContext
+ * @param options - The policy options set in policies.json
+ * @param policyName - The name of the policy as set in policies.json
+ * @returns A Request or a Response
+ */
+export declare class MonetizationInboundPolicy extends InboundPolicy<MonetizationInboundPolicyOptions> {
+    static getSubscription(context: ZuploContext): StoredMeteringSubscriptionWithQuotas | undefined;
+    static setMeters(context: ZuploContext, meters: MonetizationPolicyMeters): void;
+    handler(request: ZuploRequest<RequestGeneric>, context: ZuploContext): Promise<ZuploRequest<RequestGeneric> | Response>;
+}
 
 /**
  * The options for this policy.
@@ -2555,6 +2599,10 @@ export declare interface MonetizationInboundPolicyOptions {
     meterOnStatusCodes?: string | number[];
 }
 
+declare type MonetizationPolicyMeters = {
+    [Key in string]: number;
+};
+
 declare interface NotFoundOptions {
     routesMatchedByPathOnly: RouteConfiguration[];
 }
@@ -3647,6 +3695,22 @@ export declare interface SleepInboundPolicyOptions {
 
 /* Excluded from this release type: StandardEnv */
 
+declare interface StoredMeteringSubscriptionWithQuotas extends MeteringSubscription {
+    /**
+     * Metering subscription id, starts with "sbsc_"
+     */
+    id: string;
+    createdOn: string;
+    updatedOn: string;
+    quotaResetAnchor?: Date;
+    meters: {
+        [Key in string]: {
+            consumed: number;
+            max: number;
+        };
+    };
+}
+
 /* Excluded from this release type: StripeMeteringPlugin */
 
 /* Excluded from this release type: StripeMeteringPluginOptions */