@augstash/sdk 0.2.0 → 0.3.0

package/dist/generated/src/apis/NotificationApi.d.ts

@@ -208,7 +208,7 @@ export interface NotificationApiInterface {
     /**
      * Writes < 300ms. Requires API-key scope: notifications:write.
      * @summary Update the caller\'s own notification preference for one event type
-     * @param {'WALLET_LOW_BALANCE' | 'TOPUP_SUCCEEDED' | 'TOPUP_FAILED' | 'BUDGET_EXCEEDED' | 'SENDS_PAUSED_NO_FUNDS' | 'QUALITY_DOWNGRADED' | 'LIMIT_TIER_CHANGED' | 'NUMBER_FLAGGED' | 'TEMPLATE_APPROVED' | 'TEMPLATE_REJECTED' | 'WABA_DISCONNECTED' | 'WABA_REAUTH_REQUIRED' | 'BROADCAST_STARTED' | 'BROADCAST_FINISHED' | 'FLOW_ERROR' | 'ABTEST_WINNER_READY' | 'SCHEDULE_REMINDER' | 'CONVERSATION_ASSIGNED' | 'NOTE_MENTION' | 'SLA_BREACH' | 'QUEUE_BACKLOG' | 'BOT_HANDOFF_REQUESTED' | 'INBOX_MESSAGE_RECEIVED' | 'IVR_CALLBACK_REQUESTED' | 'ORDER_RECEIVED' | 'PAYMENT_RECEIVED' | 'ORDER_STATUS_CHANGED' | 'CART_ABANDONED' | 'INVOICE_ISSUED' | 'INVOICE_PAYMENT_FAILED' | 'VERIFICATION_DECISION' | 'GREENTICK_DECISION' | 'DOMAIN_VERIFIED' | 'SYNC_FAILED' | 'INVITE_ACCEPTED' | 'ROLE_CHANGED' | 'APPROVAL_PENDING' | 'CHANNEL_DELIVERY_FAILED' | 'CHANNEL_FALLBACK_USED' | 'DLT_REGISTRATION_EXPIRING' | 'DATA_EXPORT_READY' | 'API_KEY_IP_BLOCKED' | 'API_KEY_LEAK_DETECTED' | 'API_KEY_ANOMALY_DETECTED'} eventType
+     * @param {'WALLET_LOW_BALANCE' | 'TOPUP_SUCCEEDED' | 'TOPUP_FAILED' | 'BUDGET_EXCEEDED' | 'SENDS_PAUSED_NO_FUNDS' | 'QUALITY_DOWNGRADED' | 'LIMIT_TIER_CHANGED' | 'NUMBER_FLAGGED' | 'TEMPLATE_APPROVED' | 'TEMPLATE_REJECTED' | 'WABA_DISCONNECTED' | 'WABA_REAUTH_REQUIRED' | 'BROADCAST_STARTED' | 'BROADCAST_FINISHED' | 'FLOW_ERROR' | 'ABTEST_WINNER_READY' | 'SCHEDULE_REMINDER' | 'CONVERSATION_ASSIGNED' | 'NOTE_MENTION' | 'SLA_BREACH' | 'QUEUE_BACKLOG' | 'BOT_HANDOFF_REQUESTED' | 'INBOX_MESSAGE_RECEIVED' | 'IVR_CALLBACK_REQUESTED' | 'CALL_MISSED' | 'ORDER_RECEIVED' | 'PAYMENT_RECEIVED' | 'ORDER_STATUS_CHANGED' | 'CART_ABANDONED' | 'INVOICE_ISSUED' | 'INVOICE_PAYMENT_FAILED' | 'VERIFICATION_DECISION' | 'GREENTICK_DECISION' | 'DOMAIN_VERIFIED' | 'SYNC_FAILED' | 'INVITE_ACCEPTED' | 'ROLE_CHANGED' | 'APPROVAL_PENDING' | 'CHANNEL_DELIVERY_FAILED' | 'CHANNEL_FALLBACK_USED' | 'DLT_REGISTRATION_EXPIRING' | 'DATA_EXPORT_READY' | 'INTEGRATION_DEGRADED' | 'API_KEY_IP_BLOCKED' | 'API_KEY_LEAK_DETECTED' | 'API_KEY_ANOMALY_DETECTED' | 'PLAN_LIMIT_WARNING'} eventType
      * @param {UpdateNotificationPreferenceRequest} updateNotificationPreferenceRequest
      * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
      * @param {*} [options] Override http request option.
@@ -225,7 +225,7 @@ export interface NotificationApiInterface {
      * Writes < 300ms. OWNER-only; standalone tenants only. Requires API-key scope: notifications:write.
      * @summary Set one role\'s default notification preference for one event type
      * @param {string} role
-     * @param {'WALLET_LOW_BALANCE' | 'TOPUP_SUCCEEDED' | 'TOPUP_FAILED' | 'BUDGET_EXCEEDED' | 'SENDS_PAUSED_NO_FUNDS' | 'QUALITY_DOWNGRADED' | 'LIMIT_TIER_CHANGED' | 'NUMBER_FLAGGED' | 'TEMPLATE_APPROVED' | 'TEMPLATE_REJECTED' | 'WABA_DISCONNECTED' | 'WABA_REAUTH_REQUIRED' | 'BROADCAST_STARTED' | 'BROADCAST_FINISHED' | 'FLOW_ERROR' | 'ABTEST_WINNER_READY' | 'SCHEDULE_REMINDER' | 'CONVERSATION_ASSIGNED' | 'NOTE_MENTION' | 'SLA_BREACH' | 'QUEUE_BACKLOG' | 'BOT_HANDOFF_REQUESTED' | 'INBOX_MESSAGE_RECEIVED' | 'IVR_CALLBACK_REQUESTED' | 'ORDER_RECEIVED' | 'PAYMENT_RECEIVED' | 'ORDER_STATUS_CHANGED' | 'CART_ABANDONED' | 'INVOICE_ISSUED' | 'INVOICE_PAYMENT_FAILED' | 'VERIFICATION_DECISION' | 'GREENTICK_DECISION' | 'DOMAIN_VERIFIED' | 'SYNC_FAILED' | 'INVITE_ACCEPTED' | 'ROLE_CHANGED' | 'APPROVAL_PENDING' | 'CHANNEL_DELIVERY_FAILED' | 'CHANNEL_FALLBACK_USED' | 'DLT_REGISTRATION_EXPIRING' | 'DATA_EXPORT_READY' | 'API_KEY_IP_BLOCKED' | 'API_KEY_LEAK_DETECTED' | 'API_KEY_ANOMALY_DETECTED'} eventType
+     * @param {'WALLET_LOW_BALANCE' | 'TOPUP_SUCCEEDED' | 'TOPUP_FAILED' | 'BUDGET_EXCEEDED' | 'SENDS_PAUSED_NO_FUNDS' | 'QUALITY_DOWNGRADED' | 'LIMIT_TIER_CHANGED' | 'NUMBER_FLAGGED' | 'TEMPLATE_APPROVED' | 'TEMPLATE_REJECTED' | 'WABA_DISCONNECTED' | 'WABA_REAUTH_REQUIRED' | 'BROADCAST_STARTED' | 'BROADCAST_FINISHED' | 'FLOW_ERROR' | 'ABTEST_WINNER_READY' | 'SCHEDULE_REMINDER' | 'CONVERSATION_ASSIGNED' | 'NOTE_MENTION' | 'SLA_BREACH' | 'QUEUE_BACKLOG' | 'BOT_HANDOFF_REQUESTED' | 'INBOX_MESSAGE_RECEIVED' | 'IVR_CALLBACK_REQUESTED' | 'CALL_MISSED' | 'ORDER_RECEIVED' | 'PAYMENT_RECEIVED' | 'ORDER_STATUS_CHANGED' | 'CART_ABANDONED' | 'INVOICE_ISSUED' | 'INVOICE_PAYMENT_FAILED' | 'VERIFICATION_DECISION' | 'GREENTICK_DECISION' | 'DOMAIN_VERIFIED' | 'SYNC_FAILED' | 'INVITE_ACCEPTED' | 'ROLE_CHANGED' | 'APPROVAL_PENDING' | 'CHANNEL_DELIVERY_FAILED' | 'CHANNEL_FALLBACK_USED' | 'DLT_REGISTRATION_EXPIRING' | 'DATA_EXPORT_READY' | 'INTEGRATION_DEGRADED' | 'API_KEY_IP_BLOCKED' | 'API_KEY_LEAK_DETECTED' | 'API_KEY_ANOMALY_DETECTED' | 'PLAN_LIMIT_WARNING'} eventType
      * @param {UpdateNotificationPreferenceRequest} updateNotificationPreferenceRequest
      * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
      * @param {*} [options] Override http request option.
@@ -392,6 +392,7 @@ export declare const UpdatePreferenceEventTypeEnum: {
     readonly BotHandoffRequested: "BOT_HANDOFF_REQUESTED";
     readonly InboxMessageReceived: "INBOX_MESSAGE_RECEIVED";
     readonly IvrCallbackRequested: "IVR_CALLBACK_REQUESTED";
+    readonly CallMissed: "CALL_MISSED";
     readonly OrderReceived: "ORDER_RECEIVED";
     readonly PaymentReceived: "PAYMENT_RECEIVED";
     readonly OrderStatusChanged: "ORDER_STATUS_CHANGED";
@@ -409,9 +410,11 @@ export declare const UpdatePreferenceEventTypeEnum: {
     readonly ChannelFallbackUsed: "CHANNEL_FALLBACK_USED";
     readonly DltRegistrationExpiring: "DLT_REGISTRATION_EXPIRING";
     readonly DataExportReady: "DATA_EXPORT_READY";
+    readonly IntegrationDegraded: "INTEGRATION_DEGRADED";
     readonly ApiKeyIpBlocked: "API_KEY_IP_BLOCKED";
     readonly ApiKeyLeakDetected: "API_KEY_LEAK_DETECTED";
     readonly ApiKeyAnomalyDetected: "API_KEY_ANOMALY_DETECTED";
+    readonly PlanLimitWarning: "PLAN_LIMIT_WARNING";
 };
 export type UpdatePreferenceEventTypeEnum = typeof UpdatePreferenceEventTypeEnum[keyof typeof UpdatePreferenceEventTypeEnum];
 /**
@@ -442,6 +445,7 @@ export declare const UpdateRoleDefaultEventTypeEnum: {
     readonly BotHandoffRequested: "BOT_HANDOFF_REQUESTED";
     readonly InboxMessageReceived: "INBOX_MESSAGE_RECEIVED";
     readonly IvrCallbackRequested: "IVR_CALLBACK_REQUESTED";
+    readonly CallMissed: "CALL_MISSED";
     readonly OrderReceived: "ORDER_RECEIVED";
     readonly PaymentReceived: "PAYMENT_RECEIVED";
     readonly OrderStatusChanged: "ORDER_STATUS_CHANGED";
@@ -459,8 +463,10 @@ export declare const UpdateRoleDefaultEventTypeEnum: {
     readonly ChannelFallbackUsed: "CHANNEL_FALLBACK_USED";
     readonly DltRegistrationExpiring: "DLT_REGISTRATION_EXPIRING";
     readonly DataExportReady: "DATA_EXPORT_READY";
+    readonly IntegrationDegraded: "INTEGRATION_DEGRADED";
     readonly ApiKeyIpBlocked: "API_KEY_IP_BLOCKED";
     readonly ApiKeyLeakDetected: "API_KEY_LEAK_DETECTED";
     readonly ApiKeyAnomalyDetected: "API_KEY_ANOMALY_DETECTED";
+    readonly PlanLimitWarning: "PLAN_LIMIT_WARNING";
 };
 export type UpdateRoleDefaultEventTypeEnum = typeof UpdateRoleDefaultEventTypeEnum[keyof typeof UpdateRoleDefaultEventTypeEnum];

package/dist/generated/src/apis/NotificationApi.js

@@ -574,6 +574,7 @@ exports.UpdatePreferenceEventTypeEnum = {
     BotHandoffRequested: 'BOT_HANDOFF_REQUESTED',
     InboxMessageReceived: 'INBOX_MESSAGE_RECEIVED',
     IvrCallbackRequested: 'IVR_CALLBACK_REQUESTED',
+    CallMissed: 'CALL_MISSED',
     OrderReceived: 'ORDER_RECEIVED',
     PaymentReceived: 'PAYMENT_RECEIVED',
     OrderStatusChanged: 'ORDER_STATUS_CHANGED',
@@ -591,9 +592,11 @@ exports.UpdatePreferenceEventTypeEnum = {
     ChannelFallbackUsed: 'CHANNEL_FALLBACK_USED',
     DltRegistrationExpiring: 'DLT_REGISTRATION_EXPIRING',
     DataExportReady: 'DATA_EXPORT_READY',
+    IntegrationDegraded: 'INTEGRATION_DEGRADED',
     ApiKeyIpBlocked: 'API_KEY_IP_BLOCKED',
     ApiKeyLeakDetected: 'API_KEY_LEAK_DETECTED',
-    ApiKeyAnomalyDetected: 'API_KEY_ANOMALY_DETECTED'
+    ApiKeyAnomalyDetected: 'API_KEY_ANOMALY_DETECTED',
+    PlanLimitWarning: 'PLAN_LIMIT_WARNING'
 };
 /**
  * @export
@@ -623,6 +626,7 @@ exports.UpdateRoleDefaultEventTypeEnum = {
     BotHandoffRequested: 'BOT_HANDOFF_REQUESTED',
     InboxMessageReceived: 'INBOX_MESSAGE_RECEIVED',
     IvrCallbackRequested: 'IVR_CALLBACK_REQUESTED',
+    CallMissed: 'CALL_MISSED',
     OrderReceived: 'ORDER_RECEIVED',
     PaymentReceived: 'PAYMENT_RECEIVED',
     OrderStatusChanged: 'ORDER_STATUS_CHANGED',
@@ -640,7 +644,9 @@ exports.UpdateRoleDefaultEventTypeEnum = {
     ChannelFallbackUsed: 'CHANNEL_FALLBACK_USED',
     DltRegistrationExpiring: 'DLT_REGISTRATION_EXPIRING',
     DataExportReady: 'DATA_EXPORT_READY',
+    IntegrationDegraded: 'INTEGRATION_DEGRADED',
     ApiKeyIpBlocked: 'API_KEY_IP_BLOCKED',
     ApiKeyLeakDetected: 'API_KEY_LEAK_DETECTED',
-    ApiKeyAnomalyDetected: 'API_KEY_ANOMALY_DETECTED'
+    ApiKeyAnomalyDetected: 'API_KEY_ANOMALY_DETECTED',
+    PlanLimitWarning: 'PLAN_LIMIT_WARNING'
 };

package/dist/generated/src/apis/OrderNotificationApi.d.ts

@@ -12,7 +12,7 @@
 import * as runtime from '../runtime';
 import type { OrderNotificationDefaultResponse, OrderNotificationRuleResponse, PageResponseOrderNotificationLogResponse, Pageable, UpsertOrderNotificationRuleRequest } from '../models/index';
 export interface DeleteRuleCatalogRequest {
-    status: DeleteRuleCatalogStatusEnum;
+    trigger: string;
     xIdempotencyKey?: string;
 }
 export interface ListLogsRequest {
@@ -20,7 +20,7 @@ export interface ListLogsRequest {
     orderId?: string;
 }
 export interface UpsertRuleRequest {
-    status: UpsertRuleStatusEnum;
+    trigger: string;
     upsertOrderNotificationRuleRequest: UpsertOrderNotificationRuleRequest;
     xIdempotencyKey?: string;
 }
@@ -32,7 +32,7 @@ export interface UpsertRuleRequest {
  */
 export interface OrderNotificationApiInterface {
     /**
-     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable trigger — four order statuses and six shipment statuses — each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
      * @summary The shipped default notification set
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -40,14 +40,14 @@ export interface OrderNotificationApiInterface {
      */
     defaultsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OrderNotificationDefaultResponse>>>;
     /**
-     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable trigger — four order statuses and six shipment statuses — each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
      * The shipped default notification set
      */
     defaults(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationDefaultResponse>>;
     /**
      * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
-     * @summary Delete the notification rule for an order status
-     * @param {'RECEIVED' | 'ACKNOWLEDGED' | 'SHOPIFY_SYNCED' | 'SHOPIFY_FAILED' | 'FULFILLED' | 'CANCELLED'} status
+     * @summary Delete the notification rule for one trigger
+     * @param {string} trigger
      * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -56,7 +56,7 @@ export interface OrderNotificationApiInterface {
     deleteRuleCatalogRaw(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
      * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
-     * Delete the notification rule for an order status
+     * Delete the notification rule for one trigger
      */
     deleteRuleCatalog(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
@@ -88,9 +88,9 @@ export interface OrderNotificationApiInterface {
      */
     listRulesCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationRuleResponse>>;
     /**
-     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
-     * @summary Create or replace the notification rule for an order status
-     * @param {'RECEIVED' | 'ACKNOWLEDGED' | 'SHOPIFY_SYNCED' | 'SHOPIFY_FAILED' | 'FULFILLED' | 'CANCELLED'} status
+     * Writes < 300ms. The trigger in the path is the rule\'s identity, so this is an upsert. It is either an order status NAME (RECEIVED, ACKNOWLEDGED, FULFILLED, CANCELLED) or a shipment status KEY (label_created, in_transit, out_for_delivery, delivered, exception, returned). The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. The shipment_* variables are only valid on a shipment trigger. Requires API-key scope: catalog:write.
+     * @summary Create or replace the notification rule for one trigger
+     * @param {string} trigger
      * @param {UpsertOrderNotificationRuleRequest} upsertOrderNotificationRuleRequest
      * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
      * @param {*} [options] Override http request option.
@@ -99,8 +99,8 @@ export interface OrderNotificationApiInterface {
      */
     upsertRuleRaw(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderNotificationRuleResponse>>;
     /**
-     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
-     * Create or replace the notification rule for an order status
+     * Writes < 300ms. The trigger in the path is the rule\'s identity, so this is an upsert. It is either an order status NAME (RECEIVED, ACKNOWLEDGED, FULFILLED, CANCELLED) or a shipment status KEY (label_created, in_transit, out_for_delivery, delivered, exception, returned). The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. The shipment_* variables are only valid on a shipment trigger. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for one trigger
      */
     upsertRule(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderNotificationRuleResponse>;
 }
@@ -109,23 +109,23 @@ export interface OrderNotificationApiInterface {
  */
 export declare class OrderNotificationApi extends runtime.BaseAPI implements OrderNotificationApiInterface {
     /**
-     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable trigger — four order statuses and six shipment statuses — each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
      * The shipped default notification set
      */
     defaultsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OrderNotificationDefaultResponse>>>;
     /**
-     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable trigger — four order statuses and six shipment statuses — each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
      * The shipped default notification set
      */
     defaults(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationDefaultResponse>>;
     /**
      * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
-     * Delete the notification rule for an order status
+     * Delete the notification rule for one trigger
      */
     deleteRuleCatalogRaw(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
      * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
-     * Delete the notification rule for an order status
+     * Delete the notification rule for one trigger
      */
     deleteRuleCatalog(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
@@ -149,37 +149,13 @@ export declare class OrderNotificationApi extends runtime.BaseAPI implements Ord
      */
     listRulesCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationRuleResponse>>;
     /**
-     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
-     * Create or replace the notification rule for an order status
+     * Writes < 300ms. The trigger in the path is the rule\'s identity, so this is an upsert. It is either an order status NAME (RECEIVED, ACKNOWLEDGED, FULFILLED, CANCELLED) or a shipment status KEY (label_created, in_transit, out_for_delivery, delivered, exception, returned). The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. The shipment_* variables are only valid on a shipment trigger. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for one trigger
      */
     upsertRuleRaw(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderNotificationRuleResponse>>;
     /**
-     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
-     * Create or replace the notification rule for an order status
+     * Writes < 300ms. The trigger in the path is the rule\'s identity, so this is an upsert. It is either an order status NAME (RECEIVED, ACKNOWLEDGED, FULFILLED, CANCELLED) or a shipment status KEY (label_created, in_transit, out_for_delivery, delivered, exception, returned). The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. The shipment_* variables are only valid on a shipment trigger. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for one trigger
      */
     upsertRule(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderNotificationRuleResponse>;
 }
-/**
- * @export
- */
-export declare const DeleteRuleCatalogStatusEnum: {
-    readonly Received: "RECEIVED";
-    readonly Acknowledged: "ACKNOWLEDGED";
-    readonly ShopifySynced: "SHOPIFY_SYNCED";
-    readonly ShopifyFailed: "SHOPIFY_FAILED";
-    readonly Fulfilled: "FULFILLED";
-    readonly Cancelled: "CANCELLED";
-};
-export type DeleteRuleCatalogStatusEnum = typeof DeleteRuleCatalogStatusEnum[keyof typeof DeleteRuleCatalogStatusEnum];
-/**
- * @export
- */
-export declare const UpsertRuleStatusEnum: {
-    readonly Received: "RECEIVED";
-    readonly Acknowledged: "ACKNOWLEDGED";
-    readonly ShopifySynced: "SHOPIFY_SYNCED";
-    readonly ShopifyFailed: "SHOPIFY_FAILED";
-    readonly Fulfilled: "FULFILLED";
-    readonly Cancelled: "CANCELLED";
-};
-export type UpsertRuleStatusEnum = typeof UpsertRuleStatusEnum[keyof typeof UpsertRuleStatusEnum];

package/dist/generated/src/apis/OrderNotificationApi.js

@@ -46,7 +46,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpsertRuleStatusEnum = exports.DeleteRuleCatalogStatusEnum = exports.OrderNotificationApi = void 0;
+exports.OrderNotificationApi = void 0;
 const runtime = __importStar(require("../runtime"));
 const index_1 = require("../models/index");
 /**
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class OrderNotificationApi extends runtime.BaseAPI {
     /**
-     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable trigger — four order statuses and six shipment statuses — each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
      * The shipped default notification set
      */
     async defaultsRaw(initOverrides) {
@@ -80,7 +80,7 @@ class OrderNotificationApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.OrderNotificationDefaultResponseFromJSON));
     }
     /**
-     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable trigger — four order statuses and six shipment statuses — each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
      * The shipped default notification set
      */
     async defaults(initOverrides) {
@@ -89,11 +89,11 @@ class OrderNotificationApi extends runtime.BaseAPI {
     }
     /**
      * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
-     * Delete the notification rule for an order status
+     * Delete the notification rule for one trigger
      */
     async deleteRuleCatalogRaw(requestParameters, initOverrides) {
-        if (requestParameters['status'] == null) {
-            throw new runtime.RequiredError('status', 'Required parameter "status" was null or undefined when calling deleteRuleCatalog().');
+        if (requestParameters['trigger'] == null) {
+            throw new runtime.RequiredError('trigger', 'Required parameter "trigger" was null or undefined when calling deleteRuleCatalog().');
         }
         const queryParameters = {};
         const headerParameters = {};
@@ -110,8 +110,8 @@ class OrderNotificationApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/api/v1/catalog/notification-rules/{status}`;
-        urlPath = urlPath.replace(`{${"status"}}`, encodeURIComponent(String(requestParameters['status'])));
+        let urlPath = `/api/v1/catalog/notification-rules/{trigger}`;
+        urlPath = urlPath.replace(`{${"trigger"}}`, encodeURIComponent(String(requestParameters['trigger'])));
         const response = await this.request({
             path: urlPath,
             method: 'DELETE',
@@ -122,7 +122,7 @@ class OrderNotificationApi extends runtime.BaseAPI {
     }
     /**
      * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
-     * Delete the notification rule for an order status
+     * Delete the notification rule for one trigger
      */
     async deleteRuleCatalog(requestParameters, initOverrides) {
         await this.deleteRuleCatalogRaw(requestParameters, initOverrides);
@@ -205,12 +205,12 @@ class OrderNotificationApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
-     * Create or replace the notification rule for an order status
+     * Writes < 300ms. The trigger in the path is the rule\'s identity, so this is an upsert. It is either an order status NAME (RECEIVED, ACKNOWLEDGED, FULFILLED, CANCELLED) or a shipment status KEY (label_created, in_transit, out_for_delivery, delivered, exception, returned). The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. The shipment_* variables are only valid on a shipment trigger. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for one trigger
      */
     async upsertRuleRaw(requestParameters, initOverrides) {
-        if (requestParameters['status'] == null) {
-            throw new runtime.RequiredError('status', 'Required parameter "status" was null or undefined when calling upsertRule().');
+        if (requestParameters['trigger'] == null) {
+            throw new runtime.RequiredError('trigger', 'Required parameter "trigger" was null or undefined when calling upsertRule().');
         }
         if (requestParameters['upsertOrderNotificationRuleRequest'] == null) {
             throw new runtime.RequiredError('upsertOrderNotificationRuleRequest', 'Required parameter "upsertOrderNotificationRuleRequest" was null or undefined when calling upsertRule().');
@@ -231,8 +231,8 @@ class OrderNotificationApi extends runtime.BaseAPI {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
         }
-        let urlPath = `/api/v1/catalog/notification-rules/{status}`;
-        urlPath = urlPath.replace(`{${"status"}}`, encodeURIComponent(String(requestParameters['status'])));
+        let urlPath = `/api/v1/catalog/notification-rules/{trigger}`;
+        urlPath = urlPath.replace(`{${"trigger"}}`, encodeURIComponent(String(requestParameters['trigger'])));
         const response = await this.request({
             path: urlPath,
             method: 'PUT',
@@ -243,8 +243,8 @@ class OrderNotificationApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.OrderNotificationRuleResponseFromJSON)(jsonValue));
     }
     /**
-     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
-     * Create or replace the notification rule for an order status
+     * Writes < 300ms. The trigger in the path is the rule\'s identity, so this is an upsert. It is either an order status NAME (RECEIVED, ACKNOWLEDGED, FULFILLED, CANCELLED) or a shipment status KEY (label_created, in_transit, out_for_delivery, delivered, exception, returned). The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. The shipment_* variables are only valid on a shipment trigger. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for one trigger
      */
     async upsertRule(requestParameters, initOverrides) {
         const response = await this.upsertRuleRaw(requestParameters, initOverrides);
@@ -252,25 +252,3 @@ class OrderNotificationApi extends runtime.BaseAPI {
     }
 }
 exports.OrderNotificationApi = OrderNotificationApi;
-/**
- * @export
- */
-exports.DeleteRuleCatalogStatusEnum = {
-    Received: 'RECEIVED',
-    Acknowledged: 'ACKNOWLEDGED',
-    ShopifySynced: 'SHOPIFY_SYNCED',
-    ShopifyFailed: 'SHOPIFY_FAILED',
-    Fulfilled: 'FULFILLED',
-    Cancelled: 'CANCELLED'
-};
-/**
- * @export
- */
-exports.UpsertRuleStatusEnum = {
-    Received: 'RECEIVED',
-    Acknowledged: 'ACKNOWLEDGED',
-    ShopifySynced: 'SHOPIFY_SYNCED',
-    ShopifyFailed: 'SHOPIFY_FAILED',
-    Fulfilled: 'FULFILLED',
-    Cancelled: 'CANCELLED'
-};

package/dist/generated/src/apis/PlanUsageApi.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { PlanUsageResponse } from '../models/index';
+/**
+ * PlanUsageApi - interface
+ *
+ * @export
+ * @interface PlanUsageApiInterface
+ */
+export interface PlanUsageApiInterface {
+    /**
+     * Reads < 300ms. One row per limit: WHATSAPP_NUMBERS, USERS, CONTACTS, AUTOMATION_FLOWS, CHATBOTS and IVR_MENUS carry a ceiling and a used count; ANALYTICS_HISTORY_DAYS and AUDIT_HISTORY_DAYS are read windows in days with no used count. A null ceiling is unlimited and a ceiling of 0 means the feature is not on the plan. status is WARNING from 80% of the ceiling and AT_LIMIT at it; USERS goes to OVERAGE past it because an extra seat is billed, never blocked. upgradeTo names the plan that would lift a limit that is reached. A tenant that predates plans is LEGACY and unlimited. Requires API-key scope: settings:read.
+     * @summary Get the tenant\'s plan limits and how much of each is used
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlanUsageApiInterface
+     */
+    usageSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanUsageResponse>>;
+    /**
+     * Reads < 300ms. One row per limit: WHATSAPP_NUMBERS, USERS, CONTACTS, AUTOMATION_FLOWS, CHATBOTS and IVR_MENUS carry a ceiling and a used count; ANALYTICS_HISTORY_DAYS and AUDIT_HISTORY_DAYS are read windows in days with no used count. A null ceiling is unlimited and a ceiling of 0 means the feature is not on the plan. status is WARNING from 80% of the ceiling and AT_LIMIT at it; USERS goes to OVERAGE past it because an extra seat is billed, never blocked. upgradeTo names the plan that would lift a limit that is reached. A tenant that predates plans is LEGACY and unlimited. Requires API-key scope: settings:read.
+     * Get the tenant\'s plan limits and how much of each is used
+     */
+    usageSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanUsageResponse>;
+}
+/**
+ *
+ */
+export declare class PlanUsageApi extends runtime.BaseAPI implements PlanUsageApiInterface {
+    /**
+     * Reads < 300ms. One row per limit: WHATSAPP_NUMBERS, USERS, CONTACTS, AUTOMATION_FLOWS, CHATBOTS and IVR_MENUS carry a ceiling and a used count; ANALYTICS_HISTORY_DAYS and AUDIT_HISTORY_DAYS are read windows in days with no used count. A null ceiling is unlimited and a ceiling of 0 means the feature is not on the plan. status is WARNING from 80% of the ceiling and AT_LIMIT at it; USERS goes to OVERAGE past it because an extra seat is billed, never blocked. upgradeTo names the plan that would lift a limit that is reached. A tenant that predates plans is LEGACY and unlimited. Requires API-key scope: settings:read.
+     * Get the tenant\'s plan limits and how much of each is used
+     */
+    usageSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanUsageResponse>>;
+    /**
+     * Reads < 300ms. One row per limit: WHATSAPP_NUMBERS, USERS, CONTACTS, AUTOMATION_FLOWS, CHATBOTS and IVR_MENUS carry a ceiling and a used count; ANALYTICS_HISTORY_DAYS and AUDIT_HISTORY_DAYS are read windows in days with no used count. A null ceiling is unlimited and a ceiling of 0 means the feature is not on the plan. status is WARNING from 80% of the ceiling and AT_LIMIT at it; USERS goes to OVERAGE past it because an extra seat is billed, never blocked. upgradeTo names the plan that would lift a limit that is reached. A tenant that predates plans is LEGACY and unlimited. Requires API-key scope: settings:read.
+     * Get the tenant\'s plan limits and how much of each is used
+     */
+    usageSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanUsageResponse>;
+}

package/dist/generated/src/apis/PlanUsageApi.js

@@ -0,0 +1,91 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlanUsageApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class PlanUsageApi extends runtime.BaseAPI {
+    /**
+     * Reads < 300ms. One row per limit: WHATSAPP_NUMBERS, USERS, CONTACTS, AUTOMATION_FLOWS, CHATBOTS and IVR_MENUS carry a ceiling and a used count; ANALYTICS_HISTORY_DAYS and AUDIT_HISTORY_DAYS are read windows in days with no used count. A null ceiling is unlimited and a ceiling of 0 means the feature is not on the plan. status is WARNING from 80% of the ceiling and AT_LIMIT at it; USERS goes to OVERAGE past it because an extra seat is billed, never blocked. upgradeTo names the plan that would lift a limit that is reached. A tenant that predates plans is LEGACY and unlimited. Requires API-key scope: settings:read.
+     * Get the tenant\'s plan limits and how much of each is used
+     */
+    async usageSettingsRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/settings/plan/usage`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PlanUsageResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Reads < 300ms. One row per limit: WHATSAPP_NUMBERS, USERS, CONTACTS, AUTOMATION_FLOWS, CHATBOTS and IVR_MENUS carry a ceiling and a used count; ANALYTICS_HISTORY_DAYS and AUDIT_HISTORY_DAYS are read windows in days with no used count. A null ceiling is unlimited and a ceiling of 0 means the feature is not on the plan. status is WARNING from 80% of the ceiling and AT_LIMIT at it; USERS goes to OVERAGE past it because an extra seat is billed, never blocked. upgradeTo names the plan that would lift a limit that is reached. A tenant that predates plans is LEGACY and unlimited. Requires API-key scope: settings:read.
+     * Get the tenant\'s plan limits and how much of each is used
+     */
+    async usageSettings(initOverrides) {
+        const response = await this.usageSettingsRaw(initOverrides);
+        return await response.value();
+    }
+}
+exports.PlanUsageApi = PlanUsageApi;