@notiflows/node 0.0.1

package/src/resources/users/deliveries.ts

@@ -0,0 +1,103 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as DeliveriesAPI from '../deliveries';
+import { DeliveriesCursorPage } from '../deliveries';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Deliveries extends APIResource {
+  /**
+   * Retrieve details of a specific delivery attempt for a user.
+   *
+   * @example
+   * ```ts
+   * const delivery = await client.users.deliveries.retrieve(
+   *   '01HQXYZ123456789ABCDEFGHIJ',
+   *   { user_id: 'user_12345' },
+   * );
+   * ```
+   */
+  retrieve(
+    deliveryID: string,
+    params: DeliveryRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<DeliveriesAPI.Delivery> {
+    const { user_id } = params;
+    return this._client.get(path`/users/${user_id}/deliveries/${deliveryID}`, options);
+  }
+
+  /**
+   * Retrieve all delivery attempts for a user across all channels.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const delivery of client.users.deliveries.list(
+   *   'user_12345',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    userID: string,
+    query: DeliveryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DeliveriesCursorPage, DeliveriesAPI.Delivery> {
+    return this._client.getAPIList(path`/users/${userID}/deliveries`, CursorPage<DeliveriesAPI.Delivery>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export interface DeliveryRetrieveParams {
+  /**
+   * User external ID
+   */
+  user_id: string;
+}
+
+export interface DeliveryListParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter by channel ID (UUID)
+   */
+  channel_id?: string;
+
+  /**
+   * Filter by created after (ISO 8601 datetime)
+   */
+  created_after?: string;
+
+  /**
+   * Filter by created before (ISO 8601 datetime)
+   */
+  created_before?: string;
+
+  /**
+   * Filter by status (pending, sent, failed)
+   */
+  status?: string;
+
+  /**
+   * Filter by topic name
+   */
+  topic?: string;
+}
+
+export declare namespace Deliveries {
+  export {
+    type DeliveryRetrieveParams as DeliveryRetrieveParams,
+    type DeliveryListParams as DeliveryListParams,
+  };
+}
+
+export { type DeliveriesCursorPage };

package/src/resources/users/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ChannelSettings,
+  type MobilePushSettings,
+  type SlackSettings,
+  type ChannelSettingRetrieveParams,
+  type ChannelSettingUpdateParams,
+  type ChannelSettingDeleteParams,
+} from './channel-settings';
+export { Deliveries, type DeliveryRetrieveParams, type DeliveryListParams } from './deliveries';
+export { Notifications, type NotificationRetrieveParams, type NotificationListParams } from './notifications';
+export { Preferences, type UpdatePreferencesRequest, type PreferenceUpdateParams } from './preferences';
+export {
+  Subscriptions,
+  type Subscription,
+  type SubscriptionRetrieveParams,
+  type SubscriptionListParams,
+  type SubscriptionSubscribeParams,
+  type SubscriptionUnsubscribeParams,
+  type SubscriptionsCursorPage,
+} from './subscriptions';
+export { Users, type User, type UserListParams, type UserUpsertParams, type UsersCursorPage } from './users';

package/src/resources/users/notifications.ts

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as NotificationsAPI from '../notifications';
+import { NotificationsCursorPage } from '../notifications';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Notifications extends APIResource {
+  /**
+   * Retrieve a specific notification for a user, including all delivery attempts.
+   *
+   * @example
+   * ```ts
+   * const notification =
+   *   await client.users.notifications.retrieve(
+   *     '01HQXYZ123456789ABCDEFGHIJ',
+   *     { user_id: 'user_12345' },
+   *   );
+   * ```
+   */
+  retrieve(
+    notificationID: string,
+    params: NotificationRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<NotificationsAPI.Notification> {
+    const { user_id } = params;
+    return this._client.get(path`/users/${user_id}/notifications/${notificationID}`, options);
+  }
+
+  /**
+   * Retrieve all notifications sent to a specific user.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const notification of client.users.notifications.list(
+   *   'user_12345',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    userID: string,
+    query: NotificationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<NotificationsCursorPage, NotificationsAPI.Notification> {
+    return this._client.getAPIList(
+      path`/users/${userID}/notifications`,
+      CursorPage<NotificationsAPI.Notification>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface NotificationRetrieveParams {
+  /**
+   * User external ID
+   */
+  user_id: string;
+}
+
+export interface NotificationListParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter by created after (ISO 8601 datetime)
+   */
+  created_after?: string;
+
+  /**
+   * Filter by created before (ISO 8601 datetime)
+   */
+  created_before?: string;
+
+  /**
+   * Filter by status
+   */
+  status?: string;
+
+  /**
+   * Filter by topic
+   */
+  topic?: string;
+}
+
+export declare namespace Notifications {
+  export {
+    type NotificationRetrieveParams as NotificationRetrieveParams,
+    type NotificationListParams as NotificationListParams,
+  };
+}
+
+export { type NotificationsCursorPage };

package/src/resources/users/preferences.ts

@@ -0,0 +1,182 @@
+// 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 Preferences extends APIResource {
+  /**
+   * Retrieve a user's notification preferences.
+   *
+   * Preferences control which notifications the user receives:
+   *
+   * - `channel_types`: Global opt-in/opt-out per channel type (email, sms, push,
+   *   etc.)
+   * - `notiflows`: Per-notiflow preferences with optional channel overrides
+   *
+   * @example
+   * ```ts
+   * const preferences = await client.users.preferences.retrieve(
+   *   'user_12345',
+   * );
+   * ```
+   */
+  retrieve(userID: string, options?: RequestOptions): APIPromise<Preferences> {
+    return this._client.get(path`/users/${userID}/preferences`, options);
+  }
+
+  /**
+   * Update a user's notification preferences. Only provided fields are updated
+   * (partial update).
+   *
+   * **Channel types:** Set to `false` to opt the user out of a channel globally.
+   *
+   * **Notiflow preferences:** Override settings for specific notiflows:
+   *
+   * ```json
+   * {
+   *   "notiflows": {
+   *     "notiflow_uuid": {
+   *       "enabled": true,
+   *       "channel_types": {
+   *         "email": false
+   *       }
+   *     }
+   *   }
+   * }
+   * ```
+   *
+   * @example
+   * ```ts
+   * const preferences = await client.users.preferences.update(
+   *   'user_12345',
+   * );
+   * ```
+   */
+  update(userID: string, body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<Preferences> {
+    return this._client.put(path`/users/${userID}/preferences`, { body, ...options });
+  }
+}
+
+/**
+ * User notification preferences
+ */
+export interface Preferences {
+  /**
+   * Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+   * opted out.
+   */
+  channel_types?: Preferences.ChannelTypes;
+
+  /**
+   * Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+   */
+  notiflows?: { [key: string]: Preferences.Notiflows };
+}
+
+export namespace Preferences {
+  /**
+   * Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+   * opted out.
+   */
+  export interface ChannelTypes {
+    /**
+     * Chat notifications (Slack, etc.)
+     */
+    chat?: boolean;
+
+    /**
+     * Email notifications
+     */
+    email?: boolean;
+
+    /**
+     * In-app feed notifications
+     */
+    in_app?: boolean;
+
+    /**
+     * Mobile push notifications (iOS/Android)
+     */
+    mobile_push?: boolean;
+
+    /**
+     * SMS notifications
+     */
+    sms?: boolean;
+
+    /**
+     * Web push notifications
+     */
+    web_push?: boolean;
+  }
+
+  export interface Notiflows {
+    /**
+     * Channel-specific overrides for this notiflow
+     */
+    channel_types?: { [key: string]: boolean };
+
+    /**
+     * Whether this notiflow is enabled for the user
+     */
+    enabled?: boolean;
+
+    /**
+     * Notiflow name (read-only, for display)
+     */
+    name?: string;
+  }
+}
+
+/**
+ * Request body for updating user preferences. Only provided fields are updated.
+ */
+export interface UpdatePreferencesRequest {
+  /**
+   * Global channel type preferences
+   */
+  channel_types?: { [key: string]: boolean };
+
+  /**
+   * Per-notiflow preferences (keyed by notiflow ID)
+   */
+  notiflows?: { [key: string]: UpdatePreferencesRequest.Notiflows };
+}
+
+export namespace UpdatePreferencesRequest {
+  export interface Notiflows {
+    channel_types?: { [key: string]: boolean };
+
+    enabled?: boolean;
+  }
+}
+
+export interface PreferenceUpdateParams {
+  /**
+   * Global channel type preferences
+   */
+  channel_types?: { [key: string]: boolean };
+
+  /**
+   * Per-notiflow preferences (keyed by notiflow ID)
+   */
+  notiflows?: { [key: string]: PreferenceUpdateParams.Notiflows };
+}
+
+export namespace PreferenceUpdateParams {
+  export interface Notiflows {
+    channel_types?: { [key: string]: boolean };
+
+    enabled?: boolean;
+  }
+}
+
+export declare namespace Preferences {
+  export {
+    type Preferences as Preferences,
+    type UpdatePreferencesRequest as UpdatePreferencesRequest,
+    type PreferenceUpdateParams as PreferenceUpdateParams,
+  };
+}

package/src/resources/users/subscriptions.ts

@@ -0,0 +1,179 @@
+// 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 { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Subscriptions extends APIResource {
+  /**
+   * Check if a user is subscribed to a specific topic.
+   *
+   * @example
+   * ```ts
+   * const subscription =
+   *   await client.users.subscriptions.retrieve(
+   *     'order-updates',
+   *     { user_id: 'user_12345' },
+   *   );
+   * ```
+   */
+  retrieve(
+    topicName: string,
+    params: SubscriptionRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<Subscription> {
+    const { user_id } = params;
+    return this._client.get(path`/users/${user_id}/subscriptions/${topicName}`, options);
+  }
+
+  /**
+   * Retrieve all topic subscriptions for a user.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const subscription of client.users.subscriptions.list(
+   *   'user_12345',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    userID: string,
+    query: SubscriptionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SubscriptionsCursorPage, Subscription> {
+    return this._client.getAPIList(path`/users/${userID}/subscriptions`, CursorPage<Subscription>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Subscribe a user to a topic. Topics are created automatically if they don't
+   * exist.
+   *
+   * **Idempotent:** If the user is already subscribed, returns the existing
+   * subscription with `200 OK`.
+   *
+   * @example
+   * ```ts
+   * const subscription =
+   *   await client.users.subscriptions.subscribe('user_12345', {
+   *     topic_name: 'order-updates',
+   *   });
+   * ```
+   */
+  subscribe(
+    userID: string,
+    body: SubscriptionSubscribeParams,
+    options?: RequestOptions,
+  ): APIPromise<Subscription> {
+    return this._client.post(path`/users/${userID}/subscriptions`, { body, ...options });
+  }
+
+  /**
+   * Remove a user's subscription from a topic. The user will no longer receive
+   * notifications triggered for this topic.
+   *
+   * @example
+   * ```ts
+   * await client.users.subscriptions.unsubscribe(
+   *   'order-updates',
+   *   { user_id: 'user_12345' },
+   * );
+   * ```
+   */
+  unsubscribe(
+    topicName: string,
+    params: SubscriptionUnsubscribeParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { user_id } = params;
+    return this._client.delete(path`/users/${user_id}/subscriptions/${topicName}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type SubscriptionsCursorPage = CursorPage<Subscription>;
+
+/**
+ * A user's subscription to a topic
+ */
+export interface Subscription {
+  /**
+   * Subscription ID
+   */
+  id: string;
+
+  /**
+   * When the subscription was created
+   */
+  created_at: string;
+
+  /**
+   * Name of the subscribed topic
+   */
+  topic_name: string;
+
+  /**
+   * User's internal ID
+   */
+  user_id: string;
+}
+
+export interface SubscriptionRetrieveParams {
+  /**
+   * User external ID
+   */
+  user_id: string;
+}
+
+export interface SubscriptionListParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter by created after (ISO 8601 datetime)
+   */
+  created_after?: string;
+
+  /**
+   * Filter by created before (ISO 8601 datetime)
+   */
+  created_before?: string;
+}
+
+export interface SubscriptionSubscribeParams {
+  /**
+   * Name of the topic to subscribe to. Topics are created automatically if they
+   * don't exist.
+   */
+  topic_name: string;
+}
+
+export interface SubscriptionUnsubscribeParams {
+  /**
+   * User external ID
+   */
+  user_id: string;
+}
+
+export declare namespace Subscriptions {
+  export {
+    type Subscription as Subscription,
+    type SubscriptionsCursorPage as SubscriptionsCursorPage,
+    type SubscriptionRetrieveParams as SubscriptionRetrieveParams,
+    type SubscriptionListParams as SubscriptionListParams,
+    type SubscriptionSubscribeParams as SubscriptionSubscribeParams,
+    type SubscriptionUnsubscribeParams as SubscriptionUnsubscribeParams,
+  };
+}