@notiflows/node 0.0.1

package/src/resources/users/users.ts

@@ -0,0 +1,324 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ChannelSettingsAPI from './channel-settings';
+import {
+  ChannelSettingDeleteParams,
+  ChannelSettingRetrieveParams,
+  ChannelSettingUpdateParams,
+  ChannelSettings,
+  MobilePushSettings,
+  SlackSettings,
+} from './channel-settings';
+import * as DeliveriesAPI from './deliveries';
+import { Deliveries, DeliveryListParams, DeliveryRetrieveParams } from './deliveries';
+import * as NotificationsAPI from './notifications';
+import { NotificationListParams, NotificationRetrieveParams, Notifications } from './notifications';
+import * as PreferencesAPI from './preferences';
+import { PreferenceUpdateParams, Preferences, UpdatePreferencesRequest } from './preferences';
+import * as SubscriptionsAPI from './subscriptions';
+import {
+  Subscription,
+  SubscriptionListParams,
+  SubscriptionRetrieveParams,
+  SubscriptionSubscribeParams,
+  SubscriptionUnsubscribeParams,
+  Subscriptions,
+  SubscriptionsCursorPage,
+} from './subscriptions';
+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 Users extends APIResource {
+  channelSettings: ChannelSettingsAPI.ChannelSettings = new ChannelSettingsAPI.ChannelSettings(this._client);
+  deliveries: DeliveriesAPI.Deliveries = new DeliveriesAPI.Deliveries(this._client);
+  notifications: NotificationsAPI.Notifications = new NotificationsAPI.Notifications(this._client);
+  preferences: PreferencesAPI.Preferences = new PreferencesAPI.Preferences(this._client);
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
+
+  /**
+   * Retrieve a single user by their external ID. The external ID is the identifier
+   * you assigned when creating the user.
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.retrieve('user_12345');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<User> {
+    return this._client.get(path`/users/${id}`, options);
+  }
+
+  /**
+   * Retrieve a paginated list of users in your project. Users are sorted by creation
+   * date (newest first).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const user of client.users.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: UserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<UsersCursorPage, User> {
+    return this._client.getAPIList('/users', CursorPage<User>, { query, ...options });
+  }
+
+  /**
+   * Permanently delete a user and all their associated data including:
+   *
+   * - Subscriptions
+   * - Preferences
+   * - Channel settings
+   * - Notifications and deliveries
+   *
+   * **This action cannot be undone.**
+   *
+   * @example
+   * ```ts
+   * await client.users.delete('user_12345');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/users/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Create a new user or update an existing user by external ID (upsert operation).
+   *
+   * - If the user doesn't exist, they will be created with the provided attributes.
+   * - If the user exists, their attributes will be updated (merge behavior).
+   * - `custom_fields` are deep-merged with existing values.
+   *
+   * **Returns:**
+   *
+   * - `201 Created` when a new user is created
+   * - `200 OK` when an existing user is updated
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.upsert('user_12345', {
+   *   external_id: 'user_12345',
+   * });
+   * ```
+   */
+  upsert(id: string, body: UserUpsertParams, options?: RequestOptions): APIPromise<User> {
+    return this._client.put(path`/users/${id}`, { body, ...options });
+  }
+}
+
+export type UsersCursorPage = CursorPage<User>;
+
+/**
+ * A user (recipient) in your project
+ */
+export interface User {
+  /**
+   * Internal Notiflows user ID (UUIDv7)
+   */
+  id: string;
+
+  /**
+   * When the user was created (ISO 8601)
+   */
+  created_at: string;
+
+  /**
+   * Your system's unique identifier for this user
+   */
+  external_id: string;
+
+  /**
+   * When the user was last updated (ISO 8601)
+   */
+  updated_at: string;
+
+  /**
+   * URL to user's avatar image (must be https://)
+   */
+  avatar?: string | null;
+
+  /**
+   * Arbitrary JSON object for additional user attributes. Accessible in templates as
+   * `recipient.custom_fields.*`
+   */
+  custom_fields?: unknown | null;
+
+  /**
+   * User's email address for email notifications
+   */
+  email?: string | null;
+
+  /**
+   * User's first name for personalization
+   */
+  first_name?: string | null;
+
+  /**
+   * User's last name for personalization
+   */
+  last_name?: string | null;
+
+  /**
+   * BCP 47 locale code for localized notifications
+   */
+  locale?: string | null;
+
+  /**
+   * User's phone number in E.164 format for SMS notifications
+   */
+  phone?: string | null;
+
+  /**
+   * IANA timezone for time-sensitive notifications
+   */
+  timezone?: string | null;
+}
+
+export interface UserListParams extends CursorPageParams {
+  /**
+   * Cursor for fetching the previous page
+   */
+  before?: string;
+
+  /**
+   * Filter users created after this datetime (ISO 8601)
+   */
+  created_after?: string;
+
+  /**
+   * Filter users created before this datetime (ISO 8601)
+   */
+  created_before?: string;
+}
+
+export interface UserUpsertParams {
+  /**
+   * Your system's unique identifier for this user. Required for creating new users.
+   */
+  external_id: string;
+
+  /**
+   * URL to user's avatar image (must start with http:// or https://)
+   */
+  avatar?: string;
+
+  /**
+   * Initial channel settings (e.g., device tokens for push)
+   */
+  channel_settings?: Array<UserUpsertParams.ChannelSetting>;
+
+  /**
+   * Custom attributes. Deep-merged with existing values on update.
+   */
+  custom_fields?: unknown;
+
+  /**
+   * User's email address
+   */
+  email?: string;
+
+  /**
+   * User's first name
+   */
+  first_name?: string;
+
+  /**
+   * User's last name
+   */
+  last_name?: string;
+
+  /**
+   * BCP 47 locale code (e.g., en-US, es-ES, fr-FR)
+   */
+  locale?: string;
+
+  /**
+   * User's phone number in E.164 format
+   */
+  phone?: string;
+
+  /**
+   * Request body for updating user preferences. Only provided fields are updated.
+   */
+  preferences?: PreferencesAPI.UpdatePreferencesRequest;
+
+  /**
+   * IANA timezone (e.g., America/New_York, Europe/London)
+   */
+  timezone?: string;
+}
+
+export namespace UserUpsertParams {
+  export interface ChannelSetting {
+    /**
+     * Channel ID
+     */
+    channel_id: string;
+
+    /**
+     * Provider-specific settings
+     */
+    settings: unknown;
+  }
+}
+
+Users.Deliveries = Deliveries;
+Users.Notifications = Notifications;
+Users.Subscriptions = Subscriptions;
+
+export declare namespace Users {
+  export {
+    type User as User,
+    type UsersCursorPage as UsersCursorPage,
+    type UserListParams as UserListParams,
+    type UserUpsertParams as UserUpsertParams,
+  };
+
+  export {
+    type ChannelSettings as ChannelSettings,
+    type MobilePushSettings as MobilePushSettings,
+    type SlackSettings as SlackSettings,
+    type ChannelSettingRetrieveParams as ChannelSettingRetrieveParams,
+    type ChannelSettingUpdateParams as ChannelSettingUpdateParams,
+    type ChannelSettingDeleteParams as ChannelSettingDeleteParams,
+  };
+
+  export {
+    Deliveries as Deliveries,
+    type DeliveryRetrieveParams as DeliveryRetrieveParams,
+    type DeliveryListParams as DeliveryListParams,
+  };
+
+  export {
+    Notifications as Notifications,
+    type NotificationRetrieveParams as NotificationRetrieveParams,
+    type NotificationListParams as NotificationListParams,
+  };
+
+  export {
+    type Preferences as Preferences,
+    type UpdatePreferencesRequest as UpdatePreferencesRequest,
+    type PreferenceUpdateParams as PreferenceUpdateParams,
+  };
+
+  export {
+    Subscriptions as Subscriptions,
+    type Subscription as Subscription,
+    type SubscriptionsCursorPage as SubscriptionsCursorPage,
+    type SubscriptionRetrieveParams as SubscriptionRetrieveParams,
+    type SubscriptionListParams as SubscriptionListParams,
+    type SubscriptionSubscribeParams as SubscriptionSubscribeParams,
+    type SubscriptionUnsubscribeParams as SubscriptionUnsubscribeParams,
+  };
+}

package/src/resources/users.ts

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

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.0.1';

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

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

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

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

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.0.1';
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}