Skip to content

Commit 23e458e

Browse files
speakeasybotspeakeasybot
committed
## Typescript SDK Changes:
* `novu.channelConnections.list()`: * `request.providerId` **Changed** * `response.data[].providerId` **Changed** (Breaking ⚠️) * `novu.channelConnections.retrieve()`: `response.providerId` **Changed** (Breaking ⚠️) * `novu.notifications.retrieve()`: `response.jobs[].executionDetails[].providerId` **Changed** (Breaking ⚠️) * `novu.layouts.generatePreview()`: * `request.layoutPreviewRequestDto.previewPayload.subscriber.channels[].providerId.enum(telegram)` **Added** * `response.previewPayloadExample.subscriber.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.search()`: `response.data[].channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.create()`: * `response.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `error.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.retrieve()`: `response.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.patch()`: `response.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.credentials.update()`: * `request.updateSubscriberChannelRequestDto.providerId.enum(telegram)` **Added** * `response.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.credentials.append()`: * `request.updateSubscriberChannelRequestDto.providerId.enum(telegram)` **Added** * `response.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.messages.updateAsSeen()`: `response.subscriber.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.messages.markAllAs()`: `response.[].subscriber.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.subscribers.properties.updateOnlineFlag()`: `response.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.workflows.steps.generatePreview()`: * `request.generatePreviewRequestDto.previewPayload.subscriber.channels[].providerId.enum(telegram)` **Added** * `response.previewPayloadExample.subscriber.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.notifications.list()`: `response.data[].jobs[].executionDetails[].providerId` **Changed** (Breaking ⚠️) * `novu.messages.retrieve()`: `response.data[].subscriber.channels[].providerId.enum(telegram)` **Added** (Breaking ⚠️) * `novu.channelEndpoints.list()`: * `request.providerId` **Changed** * `response.data[]` **Changed** (Breaking ⚠️) * `novu.channelConnections.update()`: `response.providerId` **Changed** (Breaking ⚠️) * `novu.channelConnections.create()`: `response.providerId` **Changed** (Breaking ⚠️) * `novu.channelEndpoints.create()`: * `requestBody.union(telegram_chat)` **Added** * `response` **Changed** (Breaking ⚠️) * `novu.channelEndpoints.retrieve()`: `response` **Changed** (Breaking ⚠️) * `novu.channelEndpoints.update()`: `response` **Changed** (Breaking ⚠️) * `novu.integrations.list()`: `response.[].credentials` **Changed** * `novu.integrations.create()`: * `request.createIntegrationRequestDto.credentials` **Changed** * `response.credentials` **Changed** * `novu.integrations.update()`: * `request.updateIntegrationRequestDto.credentials` **Changed** * `response.credentials` **Changed** * `novu.integrations.delete()`: `response.[].credentials` **Changed** * `novu.integrations.setAsPrimary()`: `response.credentials` **Changed** * `novu.integrations.listActive()`: `response.[].credentials` **Changed** * `novu.trigger()`: * `request.triggerEventRequestDto.to.union(SubscriberPayloadDto).channels[].providerId.enum(telegram)` **Added** * `novu.triggerBroadcast()`: * `request.triggerEventToAllRequestDto.actor.union(SubscriberPayloadDto).channels[].providerId.enum(telegram)` **Added** * `novu.triggerBulk()`: * `request.bulkTriggerEventDto.events[].to.union(SubscriberPayloadDto).channels[].providerId.enum(telegram)` **Added**
1 parent 9e6540e commit 23e458e

43 files changed

Lines changed: 805 additions & 171 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.speakeasy/gen.lock‎

Lines changed: 95 additions & 71 deletions
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ generation:
2929
generateNewTests: false
3030
skipResponseBodyAssertions: false
3131
typescript:
32-
version: 3.16.0
32+
version: 3.17.0
3333
acceptHeaderEnum: true
3434
additionalDependencies:
3535
dependencies: {}
@@ -79,6 +79,7 @@ typescript:
7979
packageName: '@novu/api'
8080
preApplyUnionDiscriminators: true
8181
preserveModelFieldNames: false
82+
privateIdentifierPrefix: '#'
8283
responseFormat: flat
8384
sseFlatResponse: false
8485
templateVersion: v2

‎.speakeasy/workflow.lock‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
speakeasyVersion: 1.763.0
1+
speakeasyVersion: 1.768.2
22
sources:
33
json-development:
44
sourceNamespace: json-development
5-
sourceRevisionDigest: sha256:991addf624526a11f6e5a7f8a5681ebb6fbd4cbcbd0e9b92a92acec3a17a71aa
6-
sourceBlobDigest: sha256:4ff00edb81e67b48de4874e1348ed2df30d816b14f13306d912008d989529b38
5+
sourceRevisionDigest: sha256:2440e15ebae2ced0858eca3c9255dd4de8fc2108dbd7adcc66434437ecd142e6
6+
sourceBlobDigest: sha256:cf0dd6a0677c896ae1786db15393848d4aab6e211b9a388da853d17d9135952c
77
tags:
88
- latest
99
- 3.15.0
1010
targets:
1111
my-first-target:
1212
source: json-development
1313
sourceNamespace: json-development
14-
sourceRevisionDigest: sha256:991addf624526a11f6e5a7f8a5681ebb6fbd4cbcbd0e9b92a92acec3a17a71aa
15-
sourceBlobDigest: sha256:4ff00edb81e67b48de4874e1348ed2df30d816b14f13306d912008d989529b38
14+
sourceRevisionDigest: sha256:2440e15ebae2ced0858eca3c9255dd4de8fc2108dbd7adcc66434437ecd142e6
15+
sourceBlobDigest: sha256:cf0dd6a0677c896ae1786db15393848d4aab6e211b9a388da853d17d9135952c
1616
codeSamplesNamespace: code-samples-typescript
17-
codeSamplesRevisionDigest: sha256:1574cfa4a731795dd32e83ac9cc44546b043d535e46a946a79c9f8bdde469efc
17+
codeSamplesRevisionDigest: sha256:2d2a71fcd300f3e836c052d0ef85ef88a8d3ae7f584499049cd74dcb1a8d8340
1818
workflow:
1919
workflowVersion: 1.0.0
2020
speakeasyVersion: latest

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,4 +428,14 @@ Based on:
428428
### Generated
429429
- [typescript v3.16.0] .
430430
### Releases
431-
- [NPM v3.16.0] https://www.npmjs.com/package/@novu/api/v/3.16.0 - .
431+
- [NPM v3.16.0] https://www.npmjs.com/package/@novu/api/v/3.16.0 - .
432+
433+
## 2026-05-29 00:51:31
434+
### Changes
435+
Based on:
436+
- OpenAPI Doc
437+
- Speakeasy CLI 1.768.2 (2.889.1) https://github.com/speakeasy-api/speakeasy
438+
### Generated
439+
- [typescript v3.17.0] .
440+
### Releases
441+
- [NPM v3.17.0] https://www.npmjs.com/package/@novu/api/v/3.17.0 - .

‎docs/models/components/actorfeeditemdto.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ let value: ActorFeedItemDto = {
1515

1616
| Field | Type | Required | Description | Example |
1717
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
18-
| `data` | *string* | :heavy_check_mark: | The data associated with the actor, can be null if not applicable. | <nil> |
18+
| `data` | *string* | :heavy_check_mark: | The data associated with the actor, can be null if not applicable. | null |
1919
| `type` | [components.ActorTypeEnum](../../models/components/actortypeenum.md) | :heavy_check_mark: | The type of the actor, indicating the role in the notification process. | |

‎docs/models/components/chatorpushproviderenum.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ let value: ChatOrPushProviderEnum = "novu-slack";
1313
## Values
1414

1515
```typescript
16-
"slack" | "discord" | "msteams" | "mattermost" | "ryver" | "zulip" | "grafana-on-call" | "getstream" | "rocket-chat" | "whatsapp-business" | "chat-webhook" | "novu-slack" | "fcm" | "apns" | "expo" | "one-signal" | "pushpad" | "push-webhook" | "pusher-beams" | "appio"
16+
"slack" | "discord" | "msteams" | "mattermost" | "ryver" | "zulip" | "grafana-on-call" | "getstream" | "rocket-chat" | "whatsapp-business" | "chat-webhook" | "novu-slack" | "telegram" | "fcm" | "apns" | "expo" | "one-signal" | "pushpad" | "push-webhook" | "pusher-beams" | "appio"
1717
```

‎docs/models/components/createtelegramchatendpointdto.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# CreateTelegramChatEndpointDto
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CreateTelegramChatEndpointDto } from "@novu/api/models/components";
7+
8+
let value: CreateTelegramChatEndpointDto = {
9+
identifier: "slack-channel-user123-abc4",
10+
subscriberId: "subscriber-123",
11+
context: {
12+
"key": "org-acme",
13+
},
14+
integrationIdentifier: "slack-prod",
15+
connectionIdentifier: "slack-connection-abc123",
16+
type: "telegram_chat",
17+
endpoint: {
18+
chatId: "123456789",
19+
},
20+
};
21+
```
22+
23+
## Fields
24+
25+
| Field | Type | Required | Description | Example |
26+
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
27+
| `identifier` | *string* | :heavy_minus_sign: | The unique identifier for the channel endpoint. If not provided, one will be generated automatically. | slack-channel-user123-abc4 |
28+
| `subscriberId` | *string* | :heavy_check_mark: | The subscriber ID to which the channel endpoint is linked | subscriber-123 |
29+
| `context` | Record<string, *components.CreateTelegramChatEndpointDtoContext*> | :heavy_minus_sign: | N/A | |
30+
| `integrationIdentifier` | *string* | :heavy_check_mark: | The identifier of the integration to use for this channel endpoint. | slack-prod |
31+
| `connectionIdentifier` | *string* | :heavy_minus_sign: | The identifier of the channel connection to use for this channel endpoint. | slack-connection-abc123 |
32+
| `type` | *"telegram_chat"* | :heavy_check_mark: | Type of channel endpoint | telegram_chat |
33+
| `endpoint` | [components.TelegramChatEndpointDto](../../models/components/telegramchatendpointdto.md) | :heavy_check_mark: | Telegram chat endpoint data | |

‎docs/models/components/createtelegramchatendpointdtocontext.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# CreateTelegramChatEndpointDtoContext
2+
3+
4+
## Supported Types
5+
6+
### `string`
7+
8+
```typescript
9+
const value: string = "org-acme";
10+
```
11+
12+
### `components.CreateTelegramChatEndpointDtoContext2`
13+
14+
```typescript
15+
const value: components.CreateTelegramChatEndpointDtoContext2 = {
16+
id: "org-acme",
17+
data: {
18+
"name": "Acme Corp",
19+
"region": "us-east-1",
20+
},
21+
};
22+
```
23+

‎docs/models/components/createtelegramchatendpointdtocontext2.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CreateTelegramChatEndpointDtoContext2
2+
3+
Rich context object with id and optional data
4+
5+
## Example Usage
6+
7+
```typescript
8+
import { CreateTelegramChatEndpointDtoContext2 } from "@novu/api/models/components";
9+
10+
let value: CreateTelegramChatEndpointDtoContext2 = {
11+
id: "org-acme",
12+
data: {
13+
"name": "Acme Corp",
14+
"region": "us-east-1",
15+
},
16+
};
17+
```
18+
19+
## Fields
20+
21+
| Field | Type | Required | Description | Example |
22+
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
23+
| `id` | *string* | :heavy_check_mark: | N/A | org-acme |
24+
| `data` | Record<string, *any*> | :heavy_minus_sign: | Optional additional context data | {<br/>"name": "Acme Corp",<br/>"region": "us-east-1"<br/>} |

0 commit comments

Comments
 (0)