@usehercules/sdk 1.3.0 → 1.5.0

package/src/resources/beta/push-notifications/push-notifications.ts

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as SubscriptionsAPI from './subscriptions';
+import {
+  SubscriptionCreateParams,
+  SubscriptionCreateResponse,
+  SubscriptionDeleteResponse,
+  Subscriptions,
+} from './subscriptions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class PushNotifications extends APIResource {
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+
+  /**
+   * Enables push notifications for the app by generating VAPID keys. Idempotent -
+   * returns existing keys if already enabled. Hercules recommends calling this
+   * during app initialization.
+   */
+  enable(options?: RequestOptions): APIPromise<PushNotificationEnableResponse> {
+    return this._client.post('/v1/push-notifications/enable', options);
+  }
+
+  /**
+   * Sends push notifications to specified visitors. Omit visitorIds to broadcast to
+   * all subscribers. Returns the count of successful and failed deliveries.
+   */
+  send(body: PushNotificationSendParams, options?: RequestOptions): APIPromise<PushNotificationSendResponse> {
+    return this._client.post('/v1/push-notifications/send', { body, ...options });
+  }
+}
+
+/**
+ * Response containing the VAPID public key for push subscriptions.
+ */
+export interface PushNotificationEnableResponse {
+  /**
+   * VAPID public key for push subscription (base64url encoded)
+   */
+  vapidPublicKey: string;
+}
+
+/**
+ * Result of the send operation with success and failure counts.
+ */
+export interface PushNotificationSendResponse {
+  /**
+   * Number of notifications that failed to send
+   */
+  failed: number;
+
+  /**
+   * Number of notifications successfully sent
+   */
+  sent: number;
+}
+
+export interface PushNotificationSendParams {
+  /**
+   * Notification title
+   */
+  title: string;
+
+  /**
+   * Badge URL for mobile devices
+   */
+  badge?: string;
+
+  /**
+   * Notification body text
+   */
+  body?: string;
+
+  /**
+   * Custom data payload to include with the notification
+   */
+  data?: { [key: string]: unknown };
+
+  /**
+   * Icon URL
+   */
+  icon?: string;
+
+  /**
+   * URL to open when notification is clicked
+   */
+  url?: string;
+
+  /**
+   * Visitor IDs to send to. Omit to broadcast to all subscribers.
+   */
+  visitorIds?: Array<string>;
+}
+
+PushNotifications.Subscriptions = Subscriptions;
+
+export declare namespace PushNotifications {
+  export {
+    type PushNotificationEnableResponse as PushNotificationEnableResponse,
+    type PushNotificationSendResponse as PushNotificationSendResponse,
+    type PushNotificationSendParams as PushNotificationSendParams,
+  };
+
+  export {
+    Subscriptions as Subscriptions,
+    type SubscriptionCreateResponse as SubscriptionCreateResponse,
+    type SubscriptionDeleteResponse as SubscriptionDeleteResponse,
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+  };
+}

package/src/resources/beta/push-notifications/subscriptions.ts

@@ -0,0 +1,96 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Subscriptions extends APIResource {
+  /**
+   * Registers a push subscription for a visitor. Upserts by endpoint to handle
+   * re-subscriptions gracefully.
+   */
+  create(body: SubscriptionCreateParams, options?: RequestOptions): APIPromise<SubscriptionCreateResponse> {
+    return this._client.post('/v1/push-notifications/subscriptions', { body, ...options });
+  }
+
+  /**
+   * Removes a push subscription by ID.
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<SubscriptionDeleteResponse> {
+    return this._client.delete(path`/v1/push-notifications/subscriptions/${id}`, options);
+  }
+}
+
+/**
+ * The created or updated subscription.
+ */
+export interface SubscriptionCreateResponse {
+  /**
+   * Subscription ID
+   */
+  id: string;
+}
+
+/**
+ * Result of the unsubscribe operation.
+ */
+export interface SubscriptionDeleteResponse {
+  /**
+   * Whether the subscription was removed
+   */
+  success: boolean;
+}
+
+export interface SubscriptionCreateParams {
+  /**
+   * Web Push subscription object from pushManager.subscribe()
+   */
+  subscription: SubscriptionCreateParams.Subscription;
+
+  /**
+   * Unique identifier for the subscriber (e.g., userId)
+   */
+  visitorId: string;
+}
+
+export namespace SubscriptionCreateParams {
+  /**
+   * Web Push subscription object from pushManager.subscribe()
+   */
+  export interface Subscription {
+    /**
+     * Push service endpoint URL
+     */
+    endpoint: string;
+
+    keys: Subscription.Keys;
+
+    /**
+     * Subscription expiration timestamp
+     */
+    expirationTime?: number | null;
+  }
+
+  export namespace Subscription {
+    export interface Keys {
+      /**
+       * Authentication secret (base64url encoded)
+       */
+      auth: string;
+
+      /**
+       * P-256 Diffie-Hellman public key (base64url encoded)
+       */
+      p256dh: string;
+    }
+  }
+}
+
+export declare namespace Subscriptions {
+  export {
+    type SubscriptionCreateResponse as SubscriptionCreateResponse,
+    type SubscriptionDeleteResponse as SubscriptionDeleteResponse,
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+  };
+}

package/src/resources/beta/push-notifications.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './push-notifications/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.3.0'; // x-release-please-version
+export const VERSION = '1.5.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.3.0";
+export declare const VERSION = "1.5.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.3.0";
+export declare const VERSION = "1.5.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.3.0'; // x-release-please-version
+exports.VERSION = '1.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.3.0'; // x-release-please-version
+export const VERSION = '1.5.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map