Skip to content

Commit 042af36

Browse files
github-actions[bot]speakeasybotspeakeasy-github[bot]
authored
chore: 🐝 Update SDK - Generate 1.8.0 (#91)
* ## Typescript SDK Changes Detected: * `novu.notifications.list()`: `request` **Changed** **Breaking** ⚠️ * `novu.triggerBulk()`: * `request.bulktriggereventdto.events.[].context` **Added** * `novu.integrations.list()`: `response.[].credentials.appIoBaseUrl` **Added** * `novu.contexts.retrieve()`: **Added** * `novu.contexts.delete()`: **Added** * `novu.activity.track()`: **Added** * `novu.inboundWebhooksControllerHandleWebhook()`: **Deleted** **Breaking** ⚠️ * `novu.trigger()`: * `request.triggereventrequestdto.context` **Added** * `novu.contexts.create()`: **Added** * `novu.contexts.update()`: **Added** * `novu.subscribers.messages.updateAsSeen()`: `response.contextkeys` **Added** * `novu.subscribers.messages.markAllAs()`: `response.[].contextKeys` **Added** * `novu.integrations.create()`: * `request.createintegrationrequestdto.credentials.appIoBaseUrl` **Added** * `response.credentials.appIoBaseUrl` **Added** * `novu.integrations.update()`: * `request.updateintegrationrequestdto.credentials.appIoBaseUrl` **Added** * `response.credentials.appIoBaseUrl` **Added** * `novu.integrations.delete()`: `response.[].credentials.appIoBaseUrl` **Added** * `novu.integrations.setAsPrimary()`: `response.credentials.appIoBaseUrl` **Added** * `novu.integrations.listActive()`: `response.[].credentials.appIoBaseUrl` **Added** * `novu.messages.retrieve()`: * `request.contextKeys` **Added** * `response.data.[].contextKeys` **Added** * `novu.contexts.list()`: **Added** * empty commit to trigger [run-tests] workflow --------- Co-authored-by: speakeasybot <[email protected]> Co-authored-by: speakeasy-github[bot] <128539517+speakeasy-github[bot]@users.noreply.github.com>
1 parent 0bc8cfb commit 042af36

File tree

579 files changed

+9959
-2408
lines changed

Some content is hidden

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

579 files changed

+9959
-2408
lines changed

.speakeasy/gen.lock

Lines changed: 150 additions & 13 deletions
Large diffs are not rendered by default.

.speakeasy/gen.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,14 @@ generation:
1717
oAuth2ClientCredentialsEnabled: false
1818
oAuth2PasswordEnabled: false
1919
hoistGlobalSecurity: true
20+
schemas:
21+
allOfMergeStrategy: shallowMerge
2022
tests:
2123
generateTests: true
2224
generateNewTests: false
2325
skipResponseBodyAssertions: false
2426
typescript:
25-
version: 1.7.1
27+
version: 1.8.0
2628
acceptHeaderEnum: true
2729
additionalDependencies:
2830
dependencies: {}
@@ -63,3 +65,4 @@ typescript:
6365
templateVersion: v2
6466
usageSDKInitImports: []
6567
useIndexModules: true
68+
zodVersion: v3

.speakeasy/workflow.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.634.2
1+
speakeasyVersion: 1.642.1
22
sources:
33
json-development:
44
sourceNamespace: json-development
5-
sourceRevisionDigest: sha256:a48383d199a6f3baed1183a8f5425366e417acf21da1f721e35f8a7f20ff61a7
6-
sourceBlobDigest: sha256:29d5f43a125b6f4d3f62d5eeb0f014bd4a49720b077f78db9acf83893a47ef36
5+
sourceRevisionDigest: sha256:d15b443c068ef5937cddfaf9bd41e7efe624509fa740a93e35e358dc3e9fcc87
6+
sourceBlobDigest: sha256:7f209f4d3444a18f21d5fa7fdf82f8cae269978345de3c1f288375c593f1b2e8
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1759767821
9+
- speakeasy-sdk-regen-1759882744
1010
- 3.9.0
1111
targets:
1212
my-first-target:
1313
source: json-development
1414
sourceNamespace: json-development
15-
sourceRevisionDigest: sha256:a48383d199a6f3baed1183a8f5425366e417acf21da1f721e35f8a7f20ff61a7
16-
sourceBlobDigest: sha256:29d5f43a125b6f4d3f62d5eeb0f014bd4a49720b077f78db9acf83893a47ef36
15+
sourceRevisionDigest: sha256:d15b443c068ef5937cddfaf9bd41e7efe624509fa740a93e35e358dc3e9fcc87
16+
sourceBlobDigest: sha256:7f209f4d3444a18f21d5fa7fdf82f8cae269978345de3c1f288375c593f1b2e8
1717
codeSamplesNamespace: code-samples-typescript
18-
codeSamplesRevisionDigest: sha256:1a5be3f8633e6ef4b97903c37610481a934e1e65ba6e7536adb65776bb2c4bf8
18+
codeSamplesRevisionDigest: sha256:130bb50912b8012844e2ff4e5a65bda23baf19c0a2525b312fc049b488798c34
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

FUNCTIONS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ async function run() {
3939
},
4040
overrides: {},
4141
to: "SUBSCRIBER_ID",
42+
context: {
43+
"key": "org-acme",
44+
},
4245
});
4346
if (res.ok) {
4447
const { value: result } = res;

README.md

Lines changed: 111 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,9 @@ async function run() {
201201
},
202202
overrides: {},
203203
to: "SUBSCRIBER_ID",
204+
context: {
205+
"key": "org-acme",
206+
},
204207
});
205208

206209
console.log(result);
@@ -327,6 +330,18 @@ run();
327330
<details open>
328331
<summary>Available methods</summary>
329332

333+
### [activity](docs/sdks/activity/README.md)
334+
335+
* [track](docs/sdks/activity/README.md#track) - Track activity and engagement events
336+
337+
### [contexts](docs/sdks/contexts/README.md)
338+
339+
* [create](docs/sdks/contexts/README.md#create) - Create a context
340+
* [list](docs/sdks/contexts/README.md#list) - List all contexts
341+
* [update](docs/sdks/contexts/README.md#update) - Update a context
342+
* [retrieve](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
343+
* [delete](docs/sdks/contexts/README.md#delete) - Delete a context
344+
330345
### [environments](docs/sdks/environments/README.md)
331346

332347
* [getTags](docs/sdks/environments/README.md#gettags) - Get environment tags
@@ -369,7 +384,6 @@ run();
369384

370385
### [Novu SDK](docs/sdks/novu/README.md)
371386

372-
* [inboundWebhooksControllerHandleWebhook](docs/sdks/novu/README.md#inboundwebhookscontrollerhandlewebhook)
373387
* [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
374388
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
375389
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
@@ -386,8 +400,8 @@ run();
386400

387401
#### [subscribers.credentials](docs/sdks/credentials/README.md)
388402

389-
* [update](docs/sdks/credentials/README.md#update) - Upsert provider credentials
390-
* [append](docs/sdks/credentials/README.md#append) - Update provider credentials
403+
* [update](docs/sdks/credentials/README.md#update) - Update provider credentials
404+
* [append](docs/sdks/credentials/README.md#append) - Upsert provider credentials
391405
* [delete](docs/sdks/credentials/README.md#delete) - Delete provider credentials
392406

393407
#### [subscribers.messages](docs/sdks/novumessages/README.md)
@@ -483,13 +497,18 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
483497

484498
<summary>Available standalone functions</summary>
485499

500+
- [`activityTrack`](docs/sdks/activity/README.md#track) - Track activity and engagement events
486501
- [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
502+
- [`contextsCreate`](docs/sdks/contexts/README.md#create) - Create a context
503+
- [`contextsDelete`](docs/sdks/contexts/README.md#delete) - Delete a context
504+
- [`contextsList`](docs/sdks/contexts/README.md#list) - List all contexts
505+
- [`contextsRetrieve`](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
506+
- [`contextsUpdate`](docs/sdks/contexts/README.md#update) - Update a context
487507
- [`environmentsCreate`](docs/sdks/environments/README.md#create) - Create an environment
488508
- [`environmentsDelete`](docs/sdks/environments/README.md#delete) - Delete an environment
489509
- [`environmentsGetTags`](docs/sdks/environments/README.md#gettags) - Get environment tags
490510
- [`environmentsList`](docs/sdks/environments/README.md#list) - List all environments
491511
- [`environmentsUpdate`](docs/sdks/environments/README.md#update) - Update an environment
492-
- [`inboundWebhooksControllerHandleWebhook`](docs/sdks/novu/README.md#inboundwebhookscontrollerhandlewebhook)
493512
- [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create an integration
494513
- [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete an integration
495514
- [`integrationsIntegrationsControllerAutoConfigureIntegration`](docs/sdks/integrations/README.md#integrationscontrollerautoconfigureintegration) - Auto-configure an integration for inbound webhooks
@@ -512,9 +531,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
512531
- [`notificationsRetrieve`](docs/sdks/notifications/README.md#retrieve) - Retrieve an event
513532
- [`subscribersCreate`](docs/sdks/subscribers/README.md#create) - Create a subscriber
514533
- [`subscribersCreateBulk`](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
515-
- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Update provider credentials
534+
- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Upsert provider credentials
516535
- [`subscribersCredentialsDelete`](docs/sdks/credentials/README.md#delete) - Delete provider credentials
517-
- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Upsert provider credentials
536+
- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Update provider credentials
518537
- [`subscribersDelete`](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
519538
- [`subscribersMessagesMarkAll`](docs/sdks/novumessages/README.md#markall) - Update all notifications state
520539
- [`subscribersMessagesMarkAllAs`](docs/sdks/novumessages/README.md#markallas) - Update notifications state
@@ -597,6 +616,9 @@ async function run() {
597616
},
598617
overrides: {},
599618
to: "SUBSCRIBER_ID",
619+
context: {
620+
"key": "org-acme",
621+
},
600622
});
601623

602624
console.log(result);
@@ -643,9 +665,9 @@ run();
643665

644666

645667
**Inherit from [`NovuError`](./src/models/errors/novuerror.ts)**:
646-
* [`PayloadValidationExceptionDto`](./src/models/errors/payloadvalidationexceptiondto.ts): Status code `400`. Applicable to 3 of 75 methods.*
647-
* [`SubscriberResponseDto`](./src/models/errors/subscriberresponsedto.ts): Created. Status code `409`. Applicable to 1 of 75 methods.*
648-
* [`TopicResponseDto`](./src/models/errors/topicresponsedto.ts): OK. Status code `409`. Applicable to 1 of 75 methods.*
668+
* [`PayloadValidationExceptionDto`](./src/models/errors/payloadvalidationexceptiondto.ts): Status code `400`. Applicable to 3 of 80 methods.*
669+
* [`SubscriberResponseDto`](./src/models/errors/subscriberresponsedto.ts): Created. Status code `409`. Applicable to 1 of 80 methods.*
670+
* [`TopicResponseDto`](./src/models/errors/topicresponsedto.ts): OK. Status code `409`. Applicable to 1 of 80 methods.*
649671
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
650672

651673
</details>
@@ -676,7 +698,22 @@ const novu = new Novu({
676698
});
677699

678700
async function run() {
679-
await novu.inboundWebhooksControllerHandleWebhook("<id>", "<id>");
701+
const result = await novu.trigger({
702+
workflowId: "workflow_identifier",
703+
payload: {
704+
"comment_id": "string",
705+
"post": {
706+
"text": "string",
707+
},
708+
},
709+
overrides: {},
710+
to: "SUBSCRIBER_ID",
711+
context: {
712+
"key": "org-acme",
713+
},
714+
});
715+
716+
console.log(result);
680717
}
681718

682719
run();
@@ -695,7 +732,22 @@ const novu = new Novu({
695732
});
696733

697734
async function run() {
698-
await novu.inboundWebhooksControllerHandleWebhook("<id>", "<id>");
735+
const result = await novu.trigger({
736+
workflowId: "workflow_identifier",
737+
payload: {
738+
"comment_id": "string",
739+
"post": {
740+
"text": "string",
741+
},
742+
},
743+
overrides: {},
744+
to: "SUBSCRIBER_ID",
745+
context: {
746+
"key": "org-acme",
747+
},
748+
});
749+
750+
console.log(result);
699751
}
700752

701753
run();
@@ -772,7 +824,22 @@ const novu = new Novu({
772824
});
773825

774826
async function run() {
775-
await novu.inboundWebhooksControllerHandleWebhook("<id>", "<id>");
827+
const result = await novu.trigger({
828+
workflowId: "workflow_identifier",
829+
payload: {
830+
"comment_id": "string",
831+
"post": {
832+
"text": "string",
833+
},
834+
},
835+
overrides: {},
836+
to: "SUBSCRIBER_ID",
837+
context: {
838+
"key": "org-acme",
839+
},
840+
});
841+
842+
console.log(result);
776843
}
777844

778845
run();
@@ -794,7 +861,20 @@ const novu = new Novu({
794861
});
795862

796863
async function run() {
797-
await novu.inboundWebhooksControllerHandleWebhook("<id>", "<id>", {
864+
const result = await novu.trigger({
865+
workflowId: "workflow_identifier",
866+
payload: {
867+
"comment_id": "string",
868+
"post": {
869+
"text": "string",
870+
},
871+
},
872+
overrides: {},
873+
to: "SUBSCRIBER_ID",
874+
context: {
875+
"key": "org-acme",
876+
},
877+
}, {
798878
retries: {
799879
strategy: "backoff",
800880
backoff: {
@@ -806,6 +886,8 @@ async function run() {
806886
retryConnectionErrors: false,
807887
},
808888
});
889+
890+
console.log(result);
809891
}
810892

811893
run();
@@ -831,7 +913,22 @@ const novu = new Novu({
831913
});
832914

833915
async function run() {
834-
await novu.inboundWebhooksControllerHandleWebhook("<id>", "<id>");
916+
const result = await novu.trigger({
917+
workflowId: "workflow_identifier",
918+
payload: {
919+
"comment_id": "string",
920+
"post": {
921+
"text": "string",
922+
},
923+
},
924+
overrides: {},
925+
to: "SUBSCRIBER_ID",
926+
context: {
927+
"key": "org-acme",
928+
},
929+
});
930+
931+
console.log(result);
835932
}
836933

837934
run();

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,4 +258,14 @@ Based on:
258258
### Generated
259259
- [typescript v1.7.1] .
260260
### Releases
261-
- [NPM v1.7.1] https://www.npmjs.com/package/@novu/api/v/1.7.1 - .
261+
- [NPM v1.7.1] https://www.npmjs.com/package/@novu/api/v/1.7.1 - .
262+
263+
## 2025-10-28 18:00:19
264+
### Changes
265+
Based on:
266+
- OpenAPI Doc
267+
- Speakeasy CLI 1.642.1 (2.731.4) https://github.com/speakeasy-api/speakeasy
268+
### Generated
269+
- [typescript v1.8.0] .
270+
### Releases
271+
- [NPM v1.8.0] https://www.npmjs.com/package/@novu/api/v/1.8.0 - .

RUNTIMES.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
44

5-
* [Web Fetch API][web-fetch]
6-
* [Web Streams API][web-streams] and in particular `ReadableStream`
7-
* [Async iterables][async-iter] using `Symbol.asyncIterator`
5+
- [Web Fetch API][web-fetch]
6+
- [Web Streams API][web-streams] and in particular `ReadableStream`
7+
- [Async iterables][async-iter] using `Symbol.asyncIterator`
88

99
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
1010
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
2525

2626
The following `tsconfig.json` options are recommended for projects using this
2727
SDK in order to get static type support for features like async iterables,
28-
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
28+
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
2929
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
3030
so on):
3131

@@ -38,11 +38,11 @@ so on):
3838
{
3939
"compilerOptions": {
4040
"target": "es2020", // or higher
41-
"lib": ["es2020", "dom", "dom.iterable"],
41+
"lib": ["es2020", "dom", "dom.iterable"]
4242
}
4343
}
4444
```
4545

4646
While `target` can be set to older ECMAScript versions, it may result in extra,
4747
unnecessary compatibility code being generated if you are not targeting old
48-
runtimes.
48+
runtimes.

USAGE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ async function run() {
1919
},
2020
overrides: {},
2121
to: "SUBSCRIBER_ID",
22+
context: {
23+
"key": "org-acme",
24+
},
2225
});
2326

2427
console.log(result);

docs/models/components/bulktriggereventdto.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ let value: BulkTriggerEventDto = {
1717
},
1818
overrides: {},
1919
to: "SUBSCRIBER_ID",
20+
context: {
21+
"key": "org-acme",
22+
},
2023
},
2124
],
2225
};

docs/models/components/channelsettingsdto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import { ChannelSettingsDto } from "@novu/api/models/components";
77

88
let value: ChannelSettingsDto = {
9-
providerId: "rocket-chat",
9+
providerId: "whatsapp-business",
1010
credentials: {
1111
webhookUrl: "https://example.com/webhook",
1212
channel: "general",

0 commit comments

Comments
 (0)