@novu/api 0.0.1-alpha.10 → 0.0.1-alpha.25

package/src/sdk/subscribers.ts

@@ -21,118 +21,147 @@ import { Preferences } from "./preferences.js";
 import { Properties } from "./properties.js";
 
 export class Subscribers extends ClientSDK {
-    private _credentials?: Credentials;
-    get credentials(): Credentials {
-        return (this._credentials ??= new Credentials(this.options$));
-    }
+  private _credentials?: Credentials;
+  get credentials(): Credentials {
+    return (this._credentials ??= new Credentials(this._options));
+  }
 
-    private _authentication?: Authentication;
-    get authentication(): Authentication {
-        return (this._authentication ??= new Authentication(this.options$));
-    }
+  private _properties?: Properties;
+  get properties(): Properties {
+    return (this._properties ??= new Properties(this._options));
+  }
 
-    private _messages?: NovuMessages;
-    get messages(): NovuMessages {
-        return (this._messages ??= new NovuMessages(this.options$));
-    }
+  private _preferences?: Preferences;
+  get preferences(): Preferences {
+    return (this._preferences ??= new Preferences(this._options));
+  }
 
-    private _notifications?: NovuNotifications;
-    get notifications(): NovuNotifications {
-        return (this._notifications ??= new NovuNotifications(this.options$));
-    }
+  private _notifications?: NovuNotifications;
+  get notifications(): NovuNotifications {
+    return (this._notifications ??= new NovuNotifications(this._options));
+  }
 
-    private _properties?: Properties;
-    get properties(): Properties {
-        return (this._properties ??= new Properties(this.options$));
-    }
+  private _messages?: NovuMessages;
+  get messages(): NovuMessages {
+    return (this._messages ??= new NovuMessages(this._options));
+  }
 
-    private _preferences?: Preferences;
-    get preferences(): Preferences {
-        return (this._preferences ??= new Preferences(this.options$));
-    }
+  private _authentication?: Authentication;
+  get authentication(): Authentication {
+    return (this._authentication ??= new Authentication(this._options));
+  }
 
-    /**
-     * Create subscriber
-     *
-     * @remarks
-     * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
-     */
-    async create(
-        request: components.CreateSubscriberRequestDto,
-        options?: RequestOptions
-    ): Promise<components.SubscriberResponseDto> {
-        return unwrapAsync(subscribersCreate(this, request, options));
-    }
+  /**
+   * Get subscribers
+   *
+   * @remarks
+   * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
+   */
+  async list(
+    page?: number | undefined,
+    limit?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.SubscribersControllerListSubscribersResponse>
+  > {
+    return unwrapResultIterator(subscribersList(
+      this,
+      page,
+      limit,
+      options,
+    ));
+  }
 
-    /**
-     * Bulk create subscribers
-     *
-     * @remarks
-     *
-     *       Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
-     *       The bulk API is limited to 500 subscribers per request.
-     *
-     */
-    async createBulk(
-        request: components.BulkSubscriberCreateDto,
-        options?: RequestOptions
-    ): Promise<void> {
-        return unwrapAsync(subscribersCreateBulk(this, request, options));
-    }
+  /**
+   * Create subscriber
+   *
+   * @remarks
+   * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
+   */
+  async create(
+    request: components.CreateSubscriberRequestDto,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerCreateSubscriberResponse> {
+    return unwrapAsync(subscribersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Delete subscriber
-     *
-     * @remarks
-     * Deletes a subscriber entity from the Novu platform
-     */
-    async delete(
-        subscriberId: string,
-        options?: RequestOptions
-    ): Promise<components.DeleteSubscriberResponseDto> {
-        return unwrapAsync(subscribersDelete(this, subscriberId, options));
-    }
+  /**
+   * Get subscriber
+   *
+   * @remarks
+   * Get subscriber by your internal id used to identify the subscriber
+   */
+  async retrieve(
+    subscriberId: string,
+    includeTopics?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerGetSubscriberResponse> {
+    return unwrapAsync(subscribersRetrieve(
+      this,
+      subscriberId,
+      includeTopics,
+      options,
+    ));
+  }
 
-    /**
-     * Get subscribers
-     *
-     * @remarks
-     * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
-     */
-    async list(
-        page?: number | undefined,
-        limit?: number | undefined,
-        options?: RequestOptions
-    ): Promise<PageIterator<operations.SubscribersControllerListSubscribersResponse>> {
-        return unwrapResultIterator(subscribersList(this, page, limit, options));
-    }
+  /**
+   * Update subscriber
+   *
+   * @remarks
+   * Used to update the subscriber entity with new information
+   */
+  async update(
+    updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
+    subscriberId: string,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerUpdateSubscriberResponse> {
+    return unwrapAsync(subscribersUpdate(
+      this,
+      updateSubscriberRequestDto,
+      subscriberId,
+      options,
+    ));
+  }
 
-    /**
-     * Get subscriber
-     *
-     * @remarks
-     * Get subscriber by your internal id used to identify the subscriber
-     */
-    async retrieve(
-        subscriberId: string,
-        options?: RequestOptions
-    ): Promise<components.SubscriberResponseDto> {
-        return unwrapAsync(subscribersRetrieve(this, subscriberId, options));
-    }
+  /**
+   * Delete subscriber
+   *
+   * @remarks
+   * Deletes a subscriber entity from the Novu platform
+   */
+  async delete(
+    subscriberId: string,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerRemoveSubscriberResponse> {
+    return unwrapAsync(subscribersDelete(
+      this,
+      subscriberId,
+      options,
+    ));
+  }
 
-    /**
-     * Update subscriber
-     *
-     * @remarks
-     * Used to update the subscriber entity with new information
-     */
-    async update(
-        subscriberId: string,
-        updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
-        options?: RequestOptions
-    ): Promise<components.SubscriberResponseDto> {
-        return unwrapAsync(
-            subscribersUpdate(this, subscriberId, updateSubscriberRequestDto, options)
-        );
-    }
+  /**
+   * Bulk create subscribers
+   *
+   * @remarks
+   *
+   *       Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
+   *       The bulk API is limited to 500 subscribers per request.
+   */
+  async createBulk(
+    request: components.BulkSubscriberCreateDto,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerBulkCreateSubscribersResponse | undefined
+  > {
+    return unwrapAsync(subscribersCreateBulk(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/topics.ts

@@ -14,71 +14,95 @@ import { unwrapAsync } from "../types/fp.js";
 import { NovuSubscribers } from "./novusubscribers.js";
 
 export class Topics extends ClientSDK {
-    private _subscribers?: NovuSubscribers;
-    get subscribers(): NovuSubscribers {
-        return (this._subscribers ??= new NovuSubscribers(this.options$));
-    }
+  private _subscribers?: NovuSubscribers;
+  get subscribers(): NovuSubscribers {
+    return (this._subscribers ??= new NovuSubscribers(this._options));
+  }
 
-    /**
-     * Topic creation
-     *
-     * @remarks
-     * Create a topic
-     */
-    async create(
-        request: components.CreateTopicRequestDto,
-        options?: RequestOptions
-    ): Promise<components.CreateTopicResponseDto> {
-        return unwrapAsync(topicsCreate(this, request, options));
-    }
+  /**
+   * Topic creation
+   *
+   * @remarks
+   * Create a topic
+   */
+  async create(
+    request: components.CreateTopicRequestDto,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerCreateTopicResponse> {
+    return unwrapAsync(topicsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Delete topic
-     *
-     * @remarks
-     * Delete a topic by its topic key if it has no subscribers
-     */
-    async delete(topicKey: string, options?: RequestOptions): Promise<void> {
-        return unwrapAsync(topicsDelete(this, topicKey, options));
-    }
+  /**
+   * Filter topics
+   *
+   * @remarks
+   * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter
+   */
+  async list(
+    request: operations.TopicsControllerListTopicsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerListTopicsResponse> {
+    return unwrapAsync(topicsList(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Filter topics
-     *
-     * @remarks
-     * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter
-     */
-    async list(
-        request: operations.TopicsControllerListTopicsRequest,
-        options?: RequestOptions
-    ): Promise<components.FilterTopicsResponseDto> {
-        return unwrapAsync(topicsList(this, request, options));
-    }
+  /**
+   * Delete topic
+   *
+   * @remarks
+   * Delete a topic by its topic key if it has no subscribers
+   */
+  async delete(
+    topicKey: string,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerDeleteTopicResponse | undefined> {
+    return unwrapAsync(topicsDelete(
+      this,
+      topicKey,
+      options,
+    ));
+  }
 
-    /**
-     * Rename a topic
-     *
-     * @remarks
-     * Rename a topic by providing a new name
-     */
-    async rename(
-        topicKey: string,
-        renameTopicRequestDto: components.RenameTopicRequestDto,
-        options?: RequestOptions
-    ): Promise<components.RenameTopicResponseDto> {
-        return unwrapAsync(topicsRename(this, topicKey, renameTopicRequestDto, options));
-    }
+  /**
+   * Get topic
+   *
+   * @remarks
+   * Get a topic by its topic key
+   */
+  async retrieve(
+    topicKey: string,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerGetTopicResponse> {
+    return unwrapAsync(topicsRetrieve(
+      this,
+      topicKey,
+      options,
+    ));
+  }
 
-    /**
-     * Get topic
-     *
-     * @remarks
-     * Get a topic by its topic key
-     */
-    async retrieve(
-        topicKey: string,
-        options?: RequestOptions
-    ): Promise<components.GetTopicResponseDto> {
-        return unwrapAsync(topicsRetrieve(this, topicKey, options));
-    }
+  /**
+   * Rename a topic
+   *
+   * @remarks
+   * Rename a topic by providing a new name
+   */
+  async rename(
+    renameTopicRequestDto: components.RenameTopicRequestDto,
+    topicKey: string,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerRenameTopicResponse> {
+    return unwrapAsync(topicsRename(
+      this,
+      renameTopicRequestDto,
+      topicKey,
+      options,
+    ));
+  }
 }

package/src/sdk/webhooks.ts

@@ -4,16 +4,24 @@
 
 import { integrationsWebhooksRetrieve } from "../funcs/integrationsWebhooksRetrieve.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Webhooks extends ClientSDK {
-    /**
-     * Get webhook support status for provider
-     *
-     * @remarks
-     * Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value
-     */
-    async retrieve(providerOrIntegrationId: string, options?: RequestOptions): Promise<boolean> {
-        return unwrapAsync(integrationsWebhooksRetrieve(this, providerOrIntegrationId, options));
-    }
+  /**
+   * Get webhook support status for provider
+   *
+   * @remarks
+   * Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value
+   */
+  async retrieve(
+    providerOrIntegrationId: string,
+    options?: RequestOptions,
+  ): Promise<operations.IntegrationsControllerGetWebhookSupportStatusResponse> {
+    return unwrapAsync(integrationsWebhooksRetrieve(
+      this,
+      providerOrIntegrationId,
+      options,
+    ));
+  }
 }

package/src/sdk/workflowgroups.ts

@@ -9,71 +9,103 @@ import { workflowGroupsRetrieve } from "../funcs/workflowGroupsRetrieve.js";
 import { workflowGroupsUpdate } from "../funcs/workflowGroupsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class WorkflowGroups extends ClientSDK {
-    /**
-     * Create workflow group
-     *
-     * @remarks
-     * workflow group was previously named notification group
-     */
-    async create(
-        request: components.CreateNotificationGroupRequestDto,
-        options?: RequestOptions
-    ): Promise<components.NotificationGroupResponseDto> {
-        return unwrapAsync(workflowGroupsCreate(this, request, options));
-    }
+  /**
+   * Create workflow group
+   *
+   * @remarks
+   * workflow group was previously named notification group
+   */
+  async create(
+    request: components.CreateNotificationGroupRequestDto,
+    options?: RequestOptions,
+  ): Promise<
+    operations.NotificationGroupsControllerCreateNotificationGroupResponse
+  > {
+    return unwrapAsync(workflowGroupsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Delete workflow group
-     *
-     * @remarks
-     * workflow group was previously named notification group
-     */
-    async delete(
-        id: string,
-        options?: RequestOptions
-    ): Promise<components.DeleteNotificationGroupResponseDto> {
-        return unwrapAsync(workflowGroupsDelete(this, id, options));
-    }
+  /**
+   * Get workflow groups
+   *
+   * @remarks
+   * workflow group was previously named notification group
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<
+    operations.NotificationGroupsControllerListNotificationGroupsResponse
+  > {
+    return unwrapAsync(workflowGroupsList(
+      this,
+      options,
+    ));
+  }
 
-    /**
-     * Get workflow groups
-     *
-     * @remarks
-     * workflow group was previously named notification group
-     */
-    async list(options?: RequestOptions): Promise<Array<components.NotificationGroupResponseDto>> {
-        return unwrapAsync(workflowGroupsList(this, options));
-    }
+  /**
+   * Get workflow group
+   *
+   * @remarks
+   * workflow group was previously named notification group
+   */
+  async retrieve(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<
+    operations.NotificationGroupsControllerGetNotificationGroupResponse
+  > {
+    return unwrapAsync(workflowGroupsRetrieve(
+      this,
+      id,
+      options,
+    ));
+  }
 
-    /**
-     * Get workflow group
-     *
-     * @remarks
-     * workflow group was previously named notification group
-     */
-    async retrieve(
-        id: string,
-        options?: RequestOptions
-    ): Promise<components.NotificationGroupResponseDto> {
-        return unwrapAsync(workflowGroupsRetrieve(this, id, options));
-    }
+  /**
+   * Update workflow group
+   *
+   * @remarks
+   * workflow group was previously named notification group
+   */
+  async update(
+    createNotificationGroupRequestDto:
+      components.CreateNotificationGroupRequestDto,
+    id: string,
+    options?: RequestOptions,
+  ): Promise<
+    operations.NotificationGroupsControllerUpdateNotificationGroupResponse
+  > {
+    return unwrapAsync(workflowGroupsUpdate(
+      this,
+      createNotificationGroupRequestDto,
+      id,
+      options,
+    ));
+  }
 
-    /**
-     * Update workflow group
-     *
-     * @remarks
-     * workflow group was previously named notification group
-     */
-    async update(
-        id: string,
-        createNotificationGroupRequestDto: components.CreateNotificationGroupRequestDto,
-        options?: RequestOptions
-    ): Promise<components.NotificationGroupResponseDto> {
-        return unwrapAsync(
-            workflowGroupsUpdate(this, id, createNotificationGroupRequestDto, options)
-        );
-    }
+  /**
+   * Delete workflow group
+   *
+   * @remarks
+   * workflow group was previously named notification group
+   */
+  async delete(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<
+    operations.NotificationGroupsControllerDeleteNotificationGroupResponse
+  > {
+    return unwrapAsync(workflowGroupsDelete(
+      this,
+      id,
+      options,
+    ));
+  }
 }

package/src/types/index.ts

@@ -2,10 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export { RFCDate } from "./rfcdate.js";
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export type { Paginator, PageIterator } from "./operations.js";
-export { createPageIterator } from "./operations.js";
 export { catchUnrecognizedEnum } from "./enums.js";
-export type { OpenEnum, ClosedEnum, Unrecognized } from "./enums.js";
+export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";

package/src/types/streams.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export function isReadableStream<T = Uint8Array>(
+  val: unknown,
+): val is ReadableStream<T> {
+  if (typeof val !== "object" || val === null) {
+    return false;
+  }
+
+  // Check for the presence of methods specific to ReadableStream
+  const stream = val as ReadableStream<Uint8Array>;
+
+  // ReadableStream has methods like getReader, cancel, and tee
+  return (
+    typeof stream.getReader === "function" &&
+    typeof stream.cancel === "function" &&
+    typeof stream.tee === "function"
+  );
+}

package/types/index.d.ts

@@ -1,8 +1,8 @@
-export { RFCDate } from "./rfcdate.js";
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export type { Paginator, PageIterator } from "./operations.js";
-export { createPageIterator } from "./operations.js";
 export { catchUnrecognizedEnum } from "./enums.js";
-export type { OpenEnum, ClosedEnum, Unrecognized } from "./enums.js";
+export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";
 //# sourceMappingURL=index.d.ts.map