@novu/api 0.0.1-alpha.10

package/src/sdk/preferences.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscribersPreferencesList } from "../funcs/subscribersPreferencesList.js";
+import { subscribersPreferencesRetrieveByLevel } from "../funcs/subscribersPreferencesRetrieveByLevel.js";
+import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
+import { subscribersPreferencesUpdateGlobal } from "../funcs/subscribersPreferencesUpdateGlobal.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 Preferences extends ClientSDK {
+    /**
+     * Get subscriber preferences
+     */
+    async list(
+        subscriberId: string,
+        options?: RequestOptions
+    ): Promise<Array<components.UpdateSubscriberPreferenceResponseDto>> {
+        return unwrapAsync(subscribersPreferencesList(this, subscriberId, options));
+    }
+
+    /**
+     * Get subscriber preferences by level
+     */
+    async retrieveByLevel(
+        parameter: operations.Parameter,
+        subscriberId: string,
+        options?: RequestOptions
+    ): Promise<Array<components.GetSubscriberPreferencesResponseDto>> {
+        return unwrapAsync(
+            subscribersPreferencesRetrieveByLevel(this, parameter, subscriberId, options)
+        );
+    }
+
+    /**
+     * Update subscriber preference
+     */
+    async update(
+        request: operations.SubscribersControllerUpdateSubscriberPreferenceRequest,
+        options?: RequestOptions
+    ): Promise<components.UpdateSubscriberPreferenceResponseDto> {
+        return unwrapAsync(subscribersPreferencesUpdate(this, request, options));
+    }
+
+    /**
+     * Update subscriber global preferences
+     */
+    async updateGlobal(
+        subscriberId: string,
+        updateSubscriberGlobalPreferencesRequestDto: components.UpdateSubscriberGlobalPreferencesRequestDto,
+        options?: RequestOptions
+    ): Promise<components.UpdateSubscriberPreferenceResponseDto> {
+        return unwrapAsync(
+            subscribersPreferencesUpdateGlobal(
+                this,
+                subscriberId,
+                updateSubscriberGlobalPreferencesRequestDto,
+                options
+            )
+        );
+    }
+}

package/src/sdk/properties.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscribersPropertiesUpdateOnlineFlag } from "../funcs/subscribersPropertiesUpdateOnlineFlag.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Properties extends ClientSDK {
+    /**
+     * Update subscriber online status
+     *
+     * @remarks
+     * Used to update the subscriber isOnline flag.
+     */
+    async updateOnlineFlag(
+        subscriberId: string,
+        updateSubscriberOnlineFlagRequestDto: components.UpdateSubscriberOnlineFlagRequestDto,
+        options?: RequestOptions
+    ): Promise<components.SubscriberResponseDto> {
+        return unwrapAsync(
+            subscribersPropertiesUpdateOnlineFlag(
+                this,
+                subscriberId,
+                updateSubscriberOnlineFlagRequestDto,
+                options
+            )
+        );
+    }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,160 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { cancel } from "../funcs/cancel.js";
+import { trigger } from "../funcs/trigger.js";
+import { triggerBroadcast } from "../funcs/triggerBroadcast.js";
+import { triggerBulk } from "../funcs/triggerBulk.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Changes } from "./changes.js";
+import { Environments } from "./environments.js";
+import { ExecutionDetails } from "./executiondetails.js";
+import { Feeds } from "./feeds.js";
+import { Integrations } from "./integrations.js";
+import { Layouts } from "./layouts.js";
+import { Messages } from "./messages.js";
+import { Notifications } from "./notifications.js";
+import { Organizations } from "./organizations.js";
+import { Subscribers } from "./subscribers.js";
+import { Tenants } from "./tenants.js";
+import { Topics } from "./topics.js";
+import { WorkflowGroups } from "./workflowgroups.js";
+import { Workflows } from "./workflows.js";
+
+export class Novu extends ClientSDK {
+    private _changes?: Changes;
+    get changes(): Changes {
+        return (this._changes ??= new Changes(this.options$));
+    }
+
+    private _environments?: Environments;
+    get environments(): Environments {
+        return (this._environments ??= new Environments(this.options$));
+    }
+
+    private _executionDetails?: ExecutionDetails;
+    get executionDetails(): ExecutionDetails {
+        return (this._executionDetails ??= new ExecutionDetails(this.options$));
+    }
+
+    private _feeds?: Feeds;
+    get feeds(): Feeds {
+        return (this._feeds ??= new Feeds(this.options$));
+    }
+
+    private _integrations?: Integrations;
+    get integrations(): Integrations {
+        return (this._integrations ??= new Integrations(this.options$));
+    }
+
+    private _layouts?: Layouts;
+    get layouts(): Layouts {
+        return (this._layouts ??= new Layouts(this.options$));
+    }
+
+    private _messages?: Messages;
+    get messages(): Messages {
+        return (this._messages ??= new Messages(this.options$));
+    }
+
+    private _workflowGroups?: WorkflowGroups;
+    get workflowGroups(): WorkflowGroups {
+        return (this._workflowGroups ??= new WorkflowGroups(this.options$));
+    }
+
+    private _notifications?: Notifications;
+    get notifications(): Notifications {
+        return (this._notifications ??= new Notifications(this.options$));
+    }
+
+    private _organizations?: Organizations;
+    get organizations(): Organizations {
+        return (this._organizations ??= new Organizations(this.options$));
+    }
+
+    private _subscribers?: Subscribers;
+    get subscribers(): Subscribers {
+        return (this._subscribers ??= new Subscribers(this.options$));
+    }
+
+    private _tenants?: Tenants;
+    get tenants(): Tenants {
+        return (this._tenants ??= new Tenants(this.options$));
+    }
+
+    private _topics?: Topics;
+    get topics(): Topics {
+        return (this._topics ??= new Topics(this.options$));
+    }
+
+    private _workflows?: Workflows;
+    get workflows(): Workflows {
+        return (this._workflows ??= new Workflows(this.options$));
+    }
+
+    /**
+     * Cancel triggered event
+     *
+     * @remarks
+     *
+     *     Using a previously generated transactionId during the event trigger,
+     *      will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
+     *
+     */
+    async cancel(
+        transactionId: string,
+        options?: RequestOptions
+    ): Promise<components.DataBooleanDto> {
+        return unwrapAsync(cancel(this, transactionId, options));
+    }
+
+    /**
+     * Trigger event
+     *
+     * @remarks
+     *
+     *     Trigger event is the main (and only) way to send notifications to subscribers.
+     *     The trigger identifier is used to match the particular workflow associated with it.
+     *     Additional information can be passed according the body interface below.
+     *
+     */
+    async trigger(
+        request: components.TriggerEventRequestDto,
+        options?: RequestOptions
+    ): Promise<components.TriggerEventResponseDto> {
+        return unwrapAsync(trigger(this, request, options));
+    }
+
+    /**
+     * Broadcast event to all
+     *
+     * @remarks
+     * Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
+     *       In the future could be used to trigger events to a subset of subscribers based on defined filters.
+     */
+    async triggerBroadcast(
+        request: components.TriggerEventToAllRequestDto,
+        options?: RequestOptions
+    ): Promise<components.TriggerEventResponseDto> {
+        return unwrapAsync(triggerBroadcast(this, request, options));
+    }
+
+    /**
+     * Bulk trigger event
+     *
+     * @remarks
+     *
+     *       Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
+     *       The bulk API is limited to 100 events per request.
+     *
+     */
+    async triggerBulk(
+        request: components.BulkTriggerEventDto,
+        options?: RequestOptions
+    ): Promise<Array<components.TriggerEventResponseDto>> {
+        return unwrapAsync(triggerBulk(this, request, options));
+    }
+}

package/src/sdk/stats.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { notificationsStatsGraph } from "../funcs/notificationsStatsGraph.js";
+import { notificationsStatsRetrieve } from "../funcs/notificationsStatsRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Stats extends ClientSDK {
+    /**
+     * Get notification graph statistics
+     */
+    async graph(
+        days?: number | undefined,
+        options?: RequestOptions
+    ): Promise<Array<components.ActivityGraphStatesResponse>> {
+        return unwrapAsync(notificationsStatsGraph(this, days, options));
+    }
+
+    /**
+     * Get notification statistics
+     */
+    async retrieve(options?: RequestOptions): Promise<components.ActivityStatsResponseDto> {
+        return unwrapAsync(notificationsStatsRetrieve(this, options));
+    }
+}

package/src/sdk/status.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { workflowsStatusUpdate } from "../funcs/workflowsStatusUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Status extends ClientSDK {
+    /**
+     * Update workflow status
+     *
+     * @remarks
+     * Workflow was previously named notification template
+     */
+    async update(
+        workflowId: string,
+        changeWorkflowStatusRequestDto: components.ChangeWorkflowStatusRequestDto,
+        options?: RequestOptions
+    ): Promise<components.WorkflowResponse> {
+        return unwrapAsync(
+            workflowsStatusUpdate(this, workflowId, changeWorkflowStatusRequestDto, options)
+        );
+    }
+}

package/src/sdk/subscribers.ts

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscribersCreate } from "../funcs/subscribersCreate.js";
+import { subscribersCreateBulk } from "../funcs/subscribersCreateBulk.js";
+import { subscribersDelete } from "../funcs/subscribersDelete.js";
+import { subscribersList } from "../funcs/subscribersList.js";
+import { subscribersRetrieve } from "../funcs/subscribersRetrieve.js";
+import { subscribersUpdate } from "../funcs/subscribersUpdate.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { Authentication } from "./authentication.js";
+import { Credentials } from "./credentials.js";
+import { NovuMessages } from "./novumessages.js";
+import { NovuNotifications } from "./novunotifications.js";
+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 _authentication?: Authentication;
+    get authentication(): Authentication {
+        return (this._authentication ??= new Authentication(this.options$));
+    }
+
+    private _messages?: NovuMessages;
+    get messages(): NovuMessages {
+        return (this._messages ??= new NovuMessages(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 _preferences?: Preferences;
+    get preferences(): Preferences {
+        return (this._preferences ??= new Preferences(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));
+    }
+
+    /**
+     * 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));
+    }
+
+    /**
+     * 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 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));
+    }
+
+    /**
+     * 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));
+    }
+
+    /**
+     * 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)
+        );
+    }
+}

package/src/sdk/tenants.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsCreate } from "../funcs/tenantsCreate.js";
+import { tenantsDelete } from "../funcs/tenantsDelete.js";
+import { tenantsList } from "../funcs/tenantsList.js";
+import { tenantsRetrieve } from "../funcs/tenantsRetrieve.js";
+import { tenantsUpdate } from "../funcs/tenantsUpdate.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Tenants extends ClientSDK {
+    /**
+     * Create tenant
+     *
+     * @remarks
+     * Create tenant under the current environment Tenants is not supported in code first version of the API.
+     */
+    async create(
+        request: components.CreateTenantRequestDto,
+        options?: RequestOptions
+    ): Promise<components.CreateTenantResponseDto> {
+        return unwrapAsync(tenantsCreate(this, request, options));
+    }
+
+    /**
+     * Delete tenant
+     *
+     * @remarks
+     * Deletes a tenant entity from the Novu platform. Tenants is not supported in code first version of the API.
+     */
+    async delete(identifier: string, options?: RequestOptions): Promise<void> {
+        return unwrapAsync(tenantsDelete(this, identifier, options));
+    }
+
+    /**
+     * Get tenants
+     *
+     * @remarks
+     * Returns a list of tenants, could paginated using the `page` and `limit` query parameter. Tenants is not supported in code first version of the API.
+     */
+    async list(
+        page?: number | undefined,
+        limit?: number | undefined,
+        options?: RequestOptions
+    ): Promise<PageIterator<operations.TenantControllerListTenantsResponse>> {
+        return unwrapResultIterator(tenantsList(this, page, limit, options));
+    }
+
+    /**
+     * Get tenant
+     *
+     * @remarks
+     * Get tenant by your internal id used to identify the tenant Tenants is not supported in code first version of the API.
+     */
+    async retrieve(
+        identifier: string,
+        options?: RequestOptions
+    ): Promise<components.GetTenantResponseDto> {
+        return unwrapAsync(tenantsRetrieve(this, identifier, options));
+    }
+
+    /**
+     * Update tenant
+     *
+     * @remarks
+     * Update tenant by your internal id used to identify the tenant Tenants is not supported in code first version of the API.
+     */
+    async update(
+        identifier: string,
+        updateTenantRequestDto: components.UpdateTenantRequestDto,
+        options?: RequestOptions
+    ): Promise<components.UpdateTenantResponseDto> {
+        return unwrapAsync(tenantsUpdate(this, identifier, updateTenantRequestDto, options));
+    }
+}

package/src/sdk/topics.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { topicsCreate } from "../funcs/topicsCreate.js";
+import { topicsDelete } from "../funcs/topicsDelete.js";
+import { topicsList } from "../funcs/topicsList.js";
+import { topicsRename } from "../funcs/topicsRename.js";
+import { topicsRetrieve } from "../funcs/topicsRetrieve.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";
+import { NovuSubscribers } from "./novusubscribers.js";
+
+export class Topics extends ClientSDK {
+    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));
+    }
+
+    /**
+     * 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<components.FilterTopicsResponseDto> {
+        return unwrapAsync(topicsList(this, request, 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<components.GetTopicResponseDto> {
+        return unwrapAsync(topicsRetrieve(this, topicKey, options));
+    }
+}

package/src/sdk/variables.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { workflowsVariablesRetrieve } from "../funcs/workflowsVariablesRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Variables extends ClientSDK {
+    /**
+     * Get available variables
+     *
+     * @remarks
+     * Get the variables that can be used in the workflow
+     */
+    async retrieve(options?: RequestOptions): Promise<components.VariablesResponseDto> {
+        return unwrapAsync(workflowsVariablesRetrieve(this, options));
+    }
+}

package/src/sdk/webhooks.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { integrationsWebhooksRetrieve } from "../funcs/integrationsWebhooksRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.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));
+    }
+}