Skip to content

Commit

Permalink
relaunch (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tatarco
tatarco authored Dec 4, 2024
1 parent 977621f commit 2351171
Show file tree
Hide file tree
Showing 18 changed files with 98 additions and 150 deletions.
15 changes: 7 additions & 8 deletions .speakeasy/gen.lock
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
lockVersion: 2.0.0
id: 6bff3a53-3f0b-40b4-942f-ff70dc583ae5
management:
docChecksum: 2f63e7a28d45a69a946a65b5de961615
docChecksum: e1adea31658b01c5d6e9575ce6045e31
docVersion: "1.0"
speakeasyVersion: 1.449.0
generationVersion: 2.467.4
releaseVersion: 0.0.1-alpha.46
configChecksum: be65e72460544cf2e1ca212f663f1107
speakeasyVersion: 1.451.1
generationVersion: 2.470.1
releaseVersion: 0.0.1-alpha.48
configChecksum: 6de589a9b1a5c97c83ef26dcf13fd68a
published: true
features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.11
core: 3.18.7
core: 3.18.8
defaultEnabledRetries: 0.1.0
deprecations: 2.81.1
enumUnions: 0.1.0
Expand Down Expand Up @@ -106,7 +106,6 @@ generatedFiles:
- docs/models/components/markallmessageasrequestdtomarkas.md
- docs/models/components/markas.md
- docs/models/components/markmessageactionasseendto.md
- docs/models/components/markmessageactionasseendtopayload.md
- docs/models/components/markmessageactionasseendtostatus.md
- docs/models/components/messageaction.md
- docs/models/components/messageactionresult.md
Expand Down Expand Up @@ -589,7 +588,7 @@ examples:
EventsController_broadcastEventToAll:
speakeasy-default-events-controller-broadcast-event-to-all:
requestBody:
application/json: {"name": "<value>"}
application/json: {"name": "<value>", "payload": {"comment_id": "string", "post": {"text": "string"}}}
responses:
"200":
application/json: {"acknowledged": true, "status": "trigger_not_active"}
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
typescript:
version: 0.0.1-alpha.46
version: 0.0.1-alpha.48
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down
12 changes: 6 additions & 6 deletions .speakeasy/workflow.lock
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
speakeasyVersion: 1.449.0
speakeasyVersion: 1.451.1
sources:
json-development:
sourceNamespace: json-development
sourceRevisionDigest: sha256:72a779f529dcca0cf0e23b9fd90b0bd8da416581ca003242eca913ac16d72105
sourceBlobDigest: sha256:ddb838bbd4b9c767e41bd9dba4c68ab76fd296ce42c0643b3c674210c98df815
sourceRevisionDigest: sha256:82ed770855d952f5b8be8941ae9cce495893b750df4a4626e5d97d33fe6f628b
sourceBlobDigest: sha256:1d018bcee67ea7bebeb9f1e84742f0decb0856da975cbbcfd9e846fe72eac7d1
tags:
- latest
- "1.0"
targets:
my-first-target:
source: json-development
sourceNamespace: json-development
sourceRevisionDigest: sha256:72a779f529dcca0cf0e23b9fd90b0bd8da416581ca003242eca913ac16d72105
sourceBlobDigest: sha256:ddb838bbd4b9c767e41bd9dba4c68ab76fd296ce42c0643b3c674210c98df815
sourceRevisionDigest: sha256:82ed770855d952f5b8be8941ae9cce495893b750df4a4626e5d97d33fe6f628b
sourceBlobDigest: sha256:1d018bcee67ea7bebeb9f1e84742f0decb0856da975cbbcfd9e846fe72eac7d1
codeSamplesNamespace: code-samples-typescript
codeSamplesRevisionDigest: sha256:b6f1aad469f106f778ba3cb9221750fb467b85ee23ce5012884e574920f5c5c4
codeSamplesRevisionDigest: sha256:8e293a502bbfd681a47f782a1393bc32e00659013ed952eb19eaf2b20eba856f
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
7 changes: 6 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,12 @@ const novu = new Novu({
async function run() {
const result = await novu.triggerBroadcast({
name: "<value>",
payload: {},
payload: {
"comment_id": "string",
"post": {
"text": "string",
},
},
});

// Handle the result
Expand Down
7 changes: 6 additions & 1 deletion USAGE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,12 @@ const novu = new Novu({
async function run() {
const result = await novu.triggerBroadcast({
name: "<value>",
payload: {},
payload: {
"comment_id": "string",
"post": {
"text": "string",
},
},
});

// Handle the result
Expand Down
8 changes: 4 additions & 4 deletions docs/models/components/markmessageactionasseendto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ let value: MarkMessageActionAsSeenDto = {

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `status` | [components.MarkMessageActionAsSeenDtoStatus](../../models/components/markmessageactionasseendtostatus.md) | :heavy_check_mark: | Message action status |
| `payload` | [components.MarkMessageActionAsSeenDtoPayload](../../models/components/markmessageactionasseendtopayload.md) | :heavy_minus_sign: | Message action payload |
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `status` | [components.MarkMessageActionAsSeenDtoStatus](../../models/components/markmessageactionasseendtostatus.md) | :heavy_check_mark: | Message action status |
| `payload` | [components.Payload](../../models/components/payload.md) | :heavy_minus_sign: | Message action payload |
16 changes: 0 additions & 16 deletions docs/models/components/markmessageactionasseendtopayload.md
View file

This file was deleted.

3 changes: 1 addition & 2 deletions docs/models/components/payload.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Payload

The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it.
This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
Message action payload

## Example Usage

Expand Down
Loading

0 comments on commit 2351171

Please sign in to comment.