Skip to content

Commit

Permalink
sdk move trigger
Browse files Browse the repository at this point in the history
  • Loading branch information
tatarco committed Jun 14, 2024
1 parent 1653a5a commit e676c03
Show file tree
Hide file tree
Showing 39 changed files with 139 additions and 139 deletions.
4 changes: 2 additions & 2 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ management:
docVersion: "1.0"
speakeasyVersion: 1.308.1
generationVersion: 2.342.6
releaseVersion: 0.0.1-alpha.4
configChecksum: 2487c39ae14ab48451fa732721232820
releaseVersion: 0.0.1-alpha.5
configChecksum: f8e0d4a259ae276c499fe9feabfacd64
repoURL: https://github.com/novuhq/novu-node.git
installationURL: https://github.com/novuhq/novu-node
published: true
Expand Down
4 changes: 2 additions & 2 deletions .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
typescript:
version: 0.0.1-alpha.4
version: 0.0.1-alpha.5
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand All @@ -33,6 +33,6 @@ typescript:
maxMethodParams: 2
methodArguments: require-security-and-request
outputModelSuffix: output
packageName: novu/api
packageName: '@novu/api'
responseFormat: flat
templateVersion: v2
8 changes: 4 additions & 4 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ speakeasyVersion: 1.308.1
sources:
json-development:
sourceNamespace: json-development
sourceRevisionDigest: sha256:f3fa83a0170bcc2eece2bdf2262c6815c86e1a5ee8aeaaeef8486d43534bd2bc
sourceBlobDigest: sha256:e1784189284148c99c2d4e1b7dbc7f5ed69ae1d588267794b8185470d33b9082
sourceRevisionDigest: sha256:7875c1202d72ff33c9b2ef0b5525a3228dbc6eef1370a4909d040c39be32769c
sourceBlobDigest: sha256:d2b7aee3cfd92f49214772ab896a1906265fa2972f025b5b2e60cb50d9e9d8b1
tags:
- latest
targets:
my-first-target:
source: json-development
sourceNamespace: json-development
sourceRevisionDigest: sha256:f3fa83a0170bcc2eece2bdf2262c6815c86e1a5ee8aeaaeef8486d43534bd2bc
sourceBlobDigest: sha256:e1784189284148c99c2d4e1b7dbc7f5ed69ae1d588267794b8185470d33b9082
sourceRevisionDigest: sha256:7875c1202d72ff33c9b2ef0b5525a3228dbc6eef1370a4909d040c39be32769c
sourceBlobDigest: sha256:d2b7aee3cfd92f49214772ab896a1906265fa2972f025b5b2e60cb50d9e9d8b1
outLocation: /Users/galtidhar/Documents/GitHub/novu-ts-sdk
workflow:
workflowVersion: 1.0.0
Expand Down
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
### NPM

```bash
npm add novu/api
npm add @novu/api
```

### Yarn

```bash
yarn add novu/api
yarn add @novu/api
```
<!-- End SDK Installation [installation] -->

Expand All @@ -36,8 +36,8 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
### Trigger Notification Event

```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -261,7 +261,7 @@ syntax.
Here's an example of one such pagination call:

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -293,9 +293,9 @@ Validation errors can also occur when either method arguments or data returned f


```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import * as errors from "novu/api/models/errors";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";
import * as errors from "@novu/api/models/errors";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -352,8 +352,8 @@ You can override the default server globally by passing a server index to the `s
| 1 | `https://eu.api.novu.co` | None |

```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
serverIdx: 1,
Expand Down Expand Up @@ -387,8 +387,8 @@ run();
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:

```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
serverURL: "https://api.novu.co",
Expand Down Expand Up @@ -435,8 +435,8 @@ custom header and a timeout to requests and how to use the `"requestError"` hook
to log errors:

```typescript
import { Novu } from "novu/api";
import { HTTPClient } from "novu/api/lib/http";
import { Novu } from "@novu/api";
import { HTTPClient } from "@novu/api/lib/http";

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
Expand Down Expand Up @@ -479,8 +479,8 @@ This SDK supports the following security scheme globally:

To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -515,8 +515,8 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -559,8 +559,8 @@ run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
retryConfig: {
Expand Down
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
### Trigger Notification Event

```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/apikeys/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Get api keys
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -54,7 +54,7 @@ Regenerate api keys
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/authentication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Handle chat oauth
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -59,7 +59,7 @@ Handle providers oauth redirect
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/branding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Update organization branding details
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
8 changes: 4 additions & 4 deletions docs/sdks/changes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Apply change
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -62,7 +62,7 @@ Apply changes
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -108,7 +108,7 @@ Get changes count
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -149,7 +149,7 @@ Get changes
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
10 changes: 5 additions & 5 deletions docs/sdks/credentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Subscriber credentials associated to the delivery methods such as slack and push
### Example Usage

```typescript
import { Novu } from "novu/api";
import { UpdateSubscriberChannelRequestDtoProviderId } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -64,7 +64,7 @@ Delete subscriber credentials such as slack and expo tokens.
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -106,8 +106,8 @@ Subscriber credentials associated to the delivery methods such as slack and push
### Example Usage

```typescript
import { Novu } from "novu/api";
import { UpdateSubscriberChannelRequestDtoProviderId } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/environments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Get environments
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -59,7 +59,7 @@ Get current environment
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
8 changes: 4 additions & 4 deletions docs/sdks/events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Events represent a change in state of a subscriber. They are used to trigger wor
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -65,7 +65,7 @@ Trigger a broadcast event to all existing subscribers, could be used to send ann
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -114,8 +114,8 @@ run();
### Example Usage

```typescript
import { Novu } from "novu/api";
import { TopicPayloadDtoType } from "novu/api/models/components";
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/executiondetails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get execution details
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/feeds/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Create feed
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -63,7 +63,7 @@ Delete feed
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down Expand Up @@ -105,7 +105,7 @@ Get feeds
### Example Usage

```typescript
import { Novu } from "novu/api";
import { Novu } from "@novu/api";

const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
Expand Down
Loading

0 comments on commit e676c03

Please sign in to comment.