@notiflows/node 0.0.1 → 0.0.2

package/src/resources/notifications.ts

@@ -104,9 +104,9 @@ export interface Notification {
   notiflow_run_id: string;
 
   /**
-   * Internal ID of the recipient user
+   * A user (recipient) in your project
    */
-  recipient_id: string;
+  recipient: UsersAPI.User;
 
   /**
    * Notification processing status:
@@ -128,25 +128,20 @@ export interface Notification {
    */
   actor?: UsersAPI.User | null;
 
-  /**
-   * Internal ID of the actor (user who triggered the notification)
-   */
-  actor_id?: string | null;
-
   /**
    * Delivery attempts for this notification (when expanded)
    */
   deliveries?: Array<DeliveriesAPI.Delivery>;
 
   /**
-   * When the notification was processed
+   * Handle of the notiflow that generated this notification
    */
-  processed_at?: string | null;
+  notiflow_handle?: string;
 
   /**
-   * A user (recipient) in your project
+   * When the notification was processed
    */
-  recipient?: UsersAPI.User;
+  processed_at?: string | null;
 
   /**
    * Topic name if triggered via topic

package/src/resources/notiflows.ts

@@ -25,16 +25,16 @@ export class NotiflowsResource extends APIResource {
    * @example
    * ```ts
    * const response = await client.notiflows.run(
-   *   '01HQXYZ123456789ABCDEFGHIJ',
+   *   'welcome-email',
    * );
    * ```
    */
   run(
-    notiflowID: string,
+    notiflowHandle: string,
     body: NotiflowRunParams,
     options?: RequestOptions,
   ): APIPromise<NotiflowRunResponse> {
-    return this._client.post(path`/notiflows/${notiflowID}/run`, { body, ...options });
+    return this._client.post(path`/notiflows/${notiflowHandle}/run`, { body, ...options });
   }
 }
 

package/src/resources/users/channel-settings.ts

@@ -18,7 +18,7 @@ export class ChannelSettings extends APIResource {
    * const channelSettings =
    *   await client.users.channelSettings.retrieve(
    *     '01HQXYZ123456789ABCDEFGHIJ',
-   *     { user_id: 'user_12345' },
+   *     { user_external_id: 'user_12345' },
    *   );
    * ```
    */
@@ -27,8 +27,8 @@ export class ChannelSettings extends APIResource {
     params: ChannelSettingRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<ChannelSettings> {
-    const { user_id } = params;
-    return this._client.get(path`/users/${user_id}/channel-settings/${channelID}`, options);
+    const { user_external_id } = params;
+    return this._client.get(path`/users/${user_external_id}/channel-settings/${channelID}`, options);
   }
 
   /**
@@ -66,7 +66,7 @@ export class ChannelSettings extends APIResource {
    *   await client.users.channelSettings.update(
    *     '01HQXYZ123456789ABCDEFGHIJ',
    *     {
-   *       user_id: 'user_12345',
+   *       user_external_id: 'user_12345',
    *       settings: {
    *         device_tokens: ['ExampleTokenABCDEF123456789...'],
    *       },
@@ -79,8 +79,11 @@ export class ChannelSettings extends APIResource {
     params: ChannelSettingUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ChannelSettings> {
-    const { user_id, ...body } = params;
-    return this._client.put(path`/users/${user_id}/channel-settings/${channelID}`, { body, ...options });
+    const { user_external_id, ...body } = params;
+    return this._client.put(path`/users/${user_external_id}/channel-settings/${channelID}`, {
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -93,13 +96,13 @@ export class ChannelSettings extends APIResource {
    * ```ts
    * await client.users.channelSettings.delete(
    *   '01HQXYZ123456789ABCDEFGHIJ',
-   *   { user_id: 'user_12345' },
+   *   { user_external_id: 'user_12345' },
    * );
    * ```
    */
   delete(channelID: string, params: ChannelSettingDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { user_id } = params;
-    return this._client.delete(path`/users/${user_id}/channel-settings/${channelID}`, {
+    const { user_external_id } = params;
+    return this._client.delete(path`/users/${user_external_id}/channel-settings/${channelID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -171,14 +174,14 @@ export interface ChannelSettingRetrieveParams {
   /**
    * User external ID
    */
-  user_id: string;
+  user_external_id: string;
 }
 
 export interface ChannelSettingUpdateParams {
   /**
    * Path param: User external ID
    */
-  user_id: string;
+  user_external_id: string;
 
   /**
    * Body param: Provider-specific settings. Structure depends on channel provider.
@@ -190,7 +193,7 @@ export interface ChannelSettingDeleteParams {
   /**
    * User external ID
    */
-  user_id: string;
+  user_external_id: string;
 }
 
 export declare namespace ChannelSettings {

package/src/resources/users/deliveries.ts

@@ -16,7 +16,7 @@ export class Deliveries extends APIResource {
    * ```ts
    * const delivery = await client.users.deliveries.retrieve(
    *   '01HQXYZ123456789ABCDEFGHIJ',
-   *   { user_id: 'user_12345' },
+   *   { user_external_id: 'user_12345' },
    * );
    * ```
    */
@@ -25,8 +25,8 @@ export class Deliveries extends APIResource {
     params: DeliveryRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<DeliveriesAPI.Delivery> {
-    const { user_id } = params;
-    return this._client.get(path`/users/${user_id}/deliveries/${deliveryID}`, options);
+    const { user_external_id } = params;
+    return this._client.get(path`/users/${user_external_id}/deliveries/${deliveryID}`, options);
   }
 
   /**
@@ -43,14 +43,15 @@ export class Deliveries extends APIResource {
    * ```
    */
   list(
-    userID: string,
+    userExternalID: string,
     query: DeliveryListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<DeliveriesCursorPage, DeliveriesAPI.Delivery> {
-    return this._client.getAPIList(path`/users/${userID}/deliveries`, CursorPage<DeliveriesAPI.Delivery>, {
-      query,
-      ...options,
-    });
+    return this._client.getAPIList(
+      path`/users/${userExternalID}/deliveries`,
+      CursorPage<DeliveriesAPI.Delivery>,
+      { query, ...options },
+    );
   }
 }
 
@@ -58,7 +59,7 @@ export interface DeliveryRetrieveParams {
   /**
    * User external ID
    */
-  user_id: string;
+  user_external_id: string;
 }
 
 export interface DeliveryListParams extends CursorPageParams {

package/src/resources/users/notifications.ts

@@ -17,7 +17,7 @@ export class Notifications extends APIResource {
    * const notification =
    *   await client.users.notifications.retrieve(
    *     '01HQXYZ123456789ABCDEFGHIJ',
-   *     { user_id: 'user_12345' },
+   *     { user_external_id: 'user_12345' },
    *   );
    * ```
    */
@@ -26,8 +26,8 @@ export class Notifications extends APIResource {
     params: NotificationRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<NotificationsAPI.Notification> {
-    const { user_id } = params;
-    return this._client.get(path`/users/${user_id}/notifications/${notificationID}`, options);
+    const { user_external_id } = params;
+    return this._client.get(path`/users/${user_external_id}/notifications/${notificationID}`, options);
   }
 
   /**
@@ -44,12 +44,12 @@ export class Notifications extends APIResource {
    * ```
    */
   list(
-    userID: string,
+    userExternalID: string,
     query: NotificationListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<NotificationsCursorPage, NotificationsAPI.Notification> {
     return this._client.getAPIList(
-      path`/users/${userID}/notifications`,
+      path`/users/${userExternalID}/notifications`,
       CursorPage<NotificationsAPI.Notification>,
       { query, ...options },
     );
@@ -60,7 +60,7 @@ export interface NotificationRetrieveParams {
   /**
    * User external ID
    */
-  user_id: string;
+  user_external_id: string;
 }
 
 export interface NotificationListParams extends CursorPageParams {

package/src/resources/users/preferences.ts

@@ -22,8 +22,8 @@ export class Preferences extends APIResource {
    * );
    * ```
    */
-  retrieve(userID: string, options?: RequestOptions): APIPromise<Preferences> {
-    return this._client.get(path`/users/${userID}/preferences`, options);
+  retrieve(userExternalID: string, options?: RequestOptions): APIPromise<Preferences> {
+    return this._client.get(path`/users/${userExternalID}/preferences`, options);
   }
 
   /**
@@ -32,12 +32,13 @@ export class Preferences extends APIResource {
    *
    * **Channel types:** Set to `false` to opt the user out of a channel globally.
    *
-   * **Notiflow preferences:** Override settings for specific notiflows:
+   * **Notiflow preferences:** Override settings for specific notiflows (keyed by
+   * notiflow handle):
    *
    * ```json
    * {
    *   "notiflows": {
-   *     "notiflow_uuid": {
+   *     "order-updates": {
    *       "enabled": true,
    *       "channel_types": {
    *         "email": false
@@ -54,8 +55,12 @@ export class Preferences extends APIResource {
    * );
    * ```
    */
-  update(userID: string, body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<Preferences> {
-    return this._client.put(path`/users/${userID}/preferences`, { body, ...options });
+  update(
+    userExternalID: string,
+    body: PreferenceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<Preferences> {
+    return this._client.put(path`/users/${userExternalID}/preferences`, { body, ...options });
   }
 }
 
@@ -70,7 +75,7 @@ export interface Preferences {
   channel_types?: Preferences.ChannelTypes;
 
   /**
-   * Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+   * Per-notiflow preferences. Keys are notiflow handles.
    */
   notiflows?: { [key: string]: Preferences.Notiflows };
 }
@@ -140,7 +145,7 @@ export interface UpdatePreferencesRequest {
   channel_types?: { [key: string]: boolean };
 
   /**
-   * Per-notiflow preferences (keyed by notiflow ID)
+   * Per-notiflow preferences (keyed by notiflow handle)
    */
   notiflows?: { [key: string]: UpdatePreferencesRequest.Notiflows };
 }
@@ -160,7 +165,7 @@ export interface PreferenceUpdateParams {
   channel_types?: { [key: string]: boolean };
 
   /**
-   * Per-notiflow preferences (keyed by notiflow ID)
+   * Per-notiflow preferences (keyed by notiflow handle)
    */
   notiflows?: { [key: string]: PreferenceUpdateParams.Notiflows };
 }

package/src/resources/users/subscriptions.ts

@@ -16,7 +16,7 @@ export class Subscriptions extends APIResource {
    * const subscription =
    *   await client.users.subscriptions.retrieve(
    *     'order-updates',
-   *     { user_id: 'user_12345' },
+   *     { user_external_id: 'user_12345' },
    *   );
    * ```
    */
@@ -25,8 +25,8 @@ export class Subscriptions extends APIResource {
     params: SubscriptionRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<Subscription> {
-    const { user_id } = params;
-    return this._client.get(path`/users/${user_id}/subscriptions/${topicName}`, options);
+    const { user_external_id } = params;
+    return this._client.get(path`/users/${user_external_id}/subscriptions/${topicName}`, options);
   }
 
   /**
@@ -43,11 +43,11 @@ export class Subscriptions extends APIResource {
    * ```
    */
   list(
-    userID: string,
+    userExternalID: string,
     query: SubscriptionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<SubscriptionsCursorPage, Subscription> {
-    return this._client.getAPIList(path`/users/${userID}/subscriptions`, CursorPage<Subscription>, {
+    return this._client.getAPIList(path`/users/${userExternalID}/subscriptions`, CursorPage<Subscription>, {
       query,
       ...options,
     });
@@ -69,11 +69,11 @@ export class Subscriptions extends APIResource {
    * ```
    */
   subscribe(
-    userID: string,
+    userExternalID: string,
     body: SubscriptionSubscribeParams,
     options?: RequestOptions,
   ): APIPromise<Subscription> {
-    return this._client.post(path`/users/${userID}/subscriptions`, { body, ...options });
+    return this._client.post(path`/users/${userExternalID}/subscriptions`, { body, ...options });
   }
 
   /**
@@ -84,7 +84,7 @@ export class Subscriptions extends APIResource {
    * ```ts
    * await client.users.subscriptions.unsubscribe(
    *   'order-updates',
-   *   { user_id: 'user_12345' },
+   *   { user_external_id: 'user_12345' },
    * );
    * ```
    */
@@ -93,8 +93,8 @@ export class Subscriptions extends APIResource {
     params: SubscriptionUnsubscribeParams,
     options?: RequestOptions,
   ): APIPromise<void> {
-    const { user_id } = params;
-    return this._client.delete(path`/users/${user_id}/subscriptions/${topicName}`, {
+    const { user_external_id } = params;
+    return this._client.delete(path`/users/${user_external_id}/subscriptions/${topicName}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -132,7 +132,7 @@ export interface SubscriptionRetrieveParams {
   /**
    * User external ID
    */
-  user_id: string;
+  user_external_id: string;
 }
 
 export interface SubscriptionListParams extends CursorPageParams {
@@ -164,7 +164,7 @@ export interface SubscriptionUnsubscribeParams {
   /**
    * User external ID
    */
-  user_id: string;
+  user_external_id: string;
 }
 
 export declare namespace Subscriptions {

package/src/resources/users/users.ts

@@ -48,8 +48,8 @@ export class Users extends APIResource {
    * const user = await client.users.retrieve('user_12345');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<User> {
-    return this._client.get(path`/users/${id}`, options);
+  retrieve(userExternalID: string, options?: RequestOptions): APIPromise<User> {
+    return this._client.get(path`/users/${userExternalID}`, options);
   }
 
   /**
@@ -86,8 +86,8 @@ export class Users extends APIResource {
    * await client.users.delete('user_12345');
    * ```
    */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/users/${id}`, {
+  delete(userExternalID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/users/${userExternalID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -107,13 +107,11 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const user = await client.users.upsert('user_12345', {
-   *   external_id: 'user_12345',
-   * });
+   * const user = await client.users.upsert('user_12345');
    * ```
    */
-  upsert(id: string, body: UserUpsertParams, options?: RequestOptions): APIPromise<User> {
-    return this._client.put(path`/users/${id}`, { body, ...options });
+  upsert(userExternalID: string, body: UserUpsertParams, options?: RequestOptions): APIPromise<User> {
+    return this._client.put(path`/users/${userExternalID}`, { body, ...options });
   }
 }
 
@@ -203,11 +201,6 @@ export interface UserListParams extends CursorPageParams {
 }
 
 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://)
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.1';
+export const VERSION = '0.0.2';

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.1";
+export declare const VERSION = "0.0.2";
 //# 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 = '0.0.1';
+exports.VERSION = '0.0.2';
 //# sourceMappingURL=version.js.map

package/version.mjs

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