Merge pull request #881 from novuhq/feature/environment-and-workflow-apis

feat: add environment and workflows apis

Author: jainpawan21

content/docs/api-reference/api-types.ts

@@ -12,6 +12,7 @@ import {
   StepFilterDto,
   TopicSubscriptionResponseDto,
   SubscriberPayloadDto,
+  EnvironmentResponseDto,
 } from '@novu/api/models/components';
 
 // subscriber
@@ -24,7 +25,6 @@ export type TopicSubscription = TopicSubscriptionResponseDto;
 
 // message
 export type Message = MessageResponseDto;
-export type Workflow = WorkflowResponse;
 export type Actor = SubscriberPayloadDto | string;
 export type MessageCTA = MessageCTAType;
 
@@ -36,3 +36,9 @@ export type ActivityJob = ActivityNotificationJobResponseDto;
 export type Integration = IntegrationResponseDto;
 export type Credentials = CredentialsDto;
 export type StepFilter = StepFilterDto;
+
+// environment
+export type Environment = EnvironmentResponseDto;
+
+// workflow
+export type Workflow = WorkflowResponse;

content/docs/api-reference/environments/create-an-environment.mdx

@@ -0,0 +1,23 @@
+---
+title: Create an environment
+full: true
+_openapi:
+  method: POST
+  route: /v1/environments
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: |-
+          Creates a new environment within the current organization. 
+              Environments allow you to manage different stages of your application development lifecycle.
+              Each environment has its own set of API keys and configurations.
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Creates a new environment within the current organization. 
+    Environments allow you to manage different stages of your application development lifecycle.
+    Each environment has its own set of API keys and configurations.
+
+<APIPage document={"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"} operations={[{"path":"/v1/environments","method":"post"}]} webhooks={[]} hasHead={false} />

content/docs/api-reference/environments/delete-an-environment.mdx

@@ -0,0 +1,21 @@
+---
+title: Delete an environment
+full: true
+_openapi:
+  method: DELETE
+  route: /v1/environments/{environmentId}
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: |-
+          Delete an environment by its unique identifier **environmentId**. 
+              This action is irreversible and will remove the environment and all its associated data.
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Delete an environment by its unique identifier **environmentId**. 
+    This action is irreversible and will remove the environment and all its associated data.
+
+<APIPage document={"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"} operations={[{"path":"/v1/environments/{environmentId}","method":"delete"}]} webhooks={[]} hasHead={false} />

content/docs/api-reference/environments/environment-schema.mdx

@@ -0,0 +1,38 @@
+---
+title: Environment schema
+---
+
+### Environment
+
+Environment is a collection of resources that are used to send notifications. For example, an environment can have a set of integrations, workflows, and subscribers. Read more about environments on [environments concept page](/platform/concepts/environments). 
+
+<TypeTable name="Environment" type={{
+  "id": {
+    "description": "Unique identifier of the environment",
+    "type": "string"
+  },
+  "name": {
+    "description": "Name of the environment",
+    "type": "string"
+  },
+  "organizationId": {
+    "description": "Organization ID associated with the environment",
+    "type": "string"
+  },
+  "identifier": {
+    "description": "Unique identifier for the environment",
+    "type": "string"
+  },
+  "apiKeys": {
+    "description": "List of API keys associated with the environment",
+    "type": "ApiKeyDto[]"
+  },
+  "parentId": {
+    "description": "Parent environment ID",
+    "type": "string"
+  },
+  "slug": {
+    "description": "URL-friendly slug for the environment",
+    "type": "string"
+  }
+}} />

content/docs/api-reference/environments/environment-schema.model.mdx

@@ -0,0 +1,11 @@
+---
+title: Environment schema
+---
+
+### Environment
+
+Environment is a collection of resources that are used to send notifications. For example, an environment can have a set of integrations, workflows, and subscribers. Read more about environments on [environments concept page](/platform/concepts/environments). 
+
+---type-table---
+../api-types.ts#Environment
+---end---

content/docs/api-reference/environments/list-all-environments.mdx

@@ -0,0 +1,21 @@
+---
+title: List all environments
+full: true
+_openapi:
+  method: GET
+  route: /v1/environments
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: |-
+          This API returns a list of environments for the current organization. 
+              Each environment contains its configuration, API keys (if user has access), and metadata.
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+This API returns a list of environments for the current organization. 
+    Each environment contains its configuration, API keys (if user has access), and metadata.
+
+<APIPage document={"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"} operations={[{"path":"/v1/environments","method":"get"}]} webhooks={[]} hasHead={false} />

content/docs/api-reference/environments/update-an-environment.mdx

@@ -0,0 +1,21 @@
+---
+title: Update an environment
+full: true
+_openapi:
+  method: PUT
+  route: /v1/environments/{environmentId}
+  toc: []
+  structuredData:
+    headings: []
+    contents:
+      - content: |-
+          Update an environment by its unique identifier **environmentId**. 
+              You can modify the environment name, identifier, color, and other configuration settings.
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Update an environment by its unique identifier **environmentId**. 
+    You can modify the environment name, identifier, color, and other configuration settings.
+
+<APIPage document={"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"} operations={[{"path":"/v1/environments/{environmentId}","method":"put"}]} webhooks={[]} hasHead={false} />

content/docs/api-reference/events/broadcast-event-to-all.mdx

@@ -11,12 +11,28 @@ _openapi:
       - content: >-
           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.
 ---
 
 {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
 
 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.
 
 <APIPage document={"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"} operations={[{"path":"/v1/events/trigger/broadcast","method":"post"}]} webhooks={[]} hasHead={false} />

content/docs/api-reference/meta.json

@@ -32,11 +32,6 @@
     "...subscribers/retrieve-subscriber-unseen-count",
     "...subscribers/update-subscriber-online-status",
 
-    "---Notifications---",
-    "...notifications/notification-event-schema",
-    "...notifications/list-all-events",
-    "...notifications/retrieve-an-event",
-
     "---Topics---",
     "...topics/topic-schema",
     "...topics/create-a-topic",
@@ -49,6 +44,28 @@
     "...topics/list-topic-subscriptions",
     "...topics/check-topic-subscriber",
 
+    "---Notifications---",
+    "...notifications/notification-event-schema",
+    "...notifications/list-all-events",
+    "...notifications/retrieve-an-event",
+
+    "---Workflows---",
+    "...workflows/workflow-schema",
+    "...workflows/create-a-workflow",
+    "...workflows/retrieve-a-workflow",
+    "...workflows/update-a-workflow",
+    "...workflows/delete-a-workflow",
+    "...workflows/list-all-workflows",
+    "...workflows/sync-a-workflow",
+    "...workflows/retrieve-workflow-step",
+
+    "---Environments---",
+    "...environments/environment-schema",
+    "...environments/create-an-environment",
+    "...environments/update-an-environment",
+    "...environments/delete-an-environment",
+    "...environments/list-all-environments",
+
     "---Messages---",
     "...messages/message-schema",
     "...messages/list-all-messages",

content/docs/api-reference/subscribers/subscriber-schema.mdx

@@ -12,27 +12,27 @@ Subscriber is the end user that receives notifications. Subscriber has subscribe
   },
   "firstName": {
     "description": "The first name of the subscriber.",
-    "type": "string"
+    "type": "string | null"
   },
   "lastName": {
     "description": "The last name of the subscriber.",
-    "type": "string"
+    "type": "string | null"
   },
   "email": {
     "description": "The email address of the subscriber.",
-    "type": "string"
+    "type": "string | null"
   },
   "phone": {
     "description": "The phone number of the subscriber.",
-    "type": "string"
+    "type": "string | null"
   },
   "avatar": {
     "description": "The URL of the subscriber's avatar image.",
-    "type": "string"
+    "type": "string | null"
   },
   "locale": {
     "description": "The locale setting of the subscriber, indicating their preferred language or region.",
-    "type": "string"
+    "type": "string | null"
   },
   "channels": {
     "description": "An array of channel settings associated with the subscriber.",
@@ -44,11 +44,11 @@ Subscriber is the end user that receives notifications. Subscriber has subscribe
   },
   "isOnline": {
     "description": "Indicates whether the subscriber is currently online.",
-    "type": "boolean"
+    "type": "boolean | null"
   },
   "lastOnlineAt": {
     "description": "The timestamp indicating when the subscriber was last online, in ISO 8601 format.",
-    "type": "string"
+    "type": "string | null"
   },
   "v": {
     "description": "The version of the subscriber document.",
@@ -60,7 +60,7 @@ Subscriber is the end user that receives notifications. Subscriber has subscribe
   },
   "timezone": {
     "description": "Timezone of the subscriber",
-    "type": "string"
+    "type": "string | null"
   },
   "subscriberId": {
     "description": "The identifier used to create this subscriber, which typically corresponds to the user ID in your system.",