Skip to content

Commit

Permalink
relaunch
Browse files Browse the repository at this point in the history
  • Loading branch information
@tatarco
tatarco committed Nov 25, 2024
1 parent 8c77510 commit 2cdba1e
Show file tree
Hide file tree
Showing 527 changed files with 43,089 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/lib/utils/retryconfig.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# RetryConfig

Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.

## Fields

| Name | Type | Description | Example |
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |

## BackoffStrategy

The backoff strategy allows retrying a request with an exponential backoff between each retry.

### Fields

| Name | Type | Description | Example |
| ------------------ | ------------ | ----------------------------------------- | -------- |
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
25 changes: 25 additions & 0 deletions docs/models/components/activitiesresponsedto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ActivitiesResponseDto

## Example Usage

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

let value: ActivitiesResponseDto = {
hasMore: false,
data: [
"<value>",
],
pageSize: 9767.61,
page: 6048.46,
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `hasMore` | *boolean* | :heavy_check_mark: | N/A |
| `data` | *string*[] | :heavy_check_mark: | N/A |
| `pageSize` | *number* | :heavy_check_mark: | N/A |
| `page` | *number* | :heavy_check_mark: | N/A |
27 changes: 27 additions & 0 deletions docs/models/components/activitygraphstatesresponse.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# ActivityGraphStatesResponse

## Example Usage

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

let value: ActivityGraphStatesResponse = {
id: "<id>",
count: 2961.40,
templates: [
"<value>",
],
channels: [
"in_app",
],
};
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `id` | *string* | :heavy_check_mark: | N/A |
| `count` | *number* | :heavy_check_mark: | N/A |
| `templates` | *string*[] | :heavy_check_mark: | N/A |
| `channels` | [components.Channels](../../models/components/channels.md)[] | :heavy_check_mark: | N/A |
27 changes: 27 additions & 0 deletions docs/models/components/activitynotificationresponsedto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# ActivityNotificationResponseDto

## Example Usage

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

let value: ActivityNotificationResponseDto = {
environmentId: "<id>",
organizationId: "<id>",
transactionId: "<id>",
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | N/A |
| `environmentId` | *string* | :heavy_check_mark: | N/A |
| `organizationId` | *string* | :heavy_check_mark: | N/A |
| `transactionId` | *string* | :heavy_check_mark: | N/A |
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
| `channels` | [components.ActivityNotificationResponseDtoChannels](../../models/components/activitynotificationresponsedtochannels.md) | :heavy_minus_sign: | N/A |
| `subscriber` | [components.ActivityNotificationSubscriberResponseDto](../../models/components/activitynotificationsubscriberresponsedto.md) | :heavy_minus_sign: | N/A |
| `template` | [components.ActivityNotificationTemplateResponseDto](../../models/components/activitynotificationtemplateresponsedto.md) | :heavy_minus_sign: | N/A |
| `jobs` | *string*[] | :heavy_minus_sign: | N/A |
15 changes: 15 additions & 0 deletions docs/models/components/activitynotificationresponsedtochannels.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ActivityNotificationResponseDtoChannels

## Example Usage

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

let value: ActivityNotificationResponseDtoChannels = "trigger";
```

## Values

```typescript
"in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom"
```
21 changes: 21 additions & 0 deletions docs/models/components/activitynotificationsubscriberresponsedto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ActivityNotificationSubscriberResponseDto

## Example Usage

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

let value: ActivityNotificationSubscriberResponseDto = {
id: "<id>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `firstName` | *string* | :heavy_minus_sign: | N/A |
| `id` | *string* | :heavy_check_mark: | N/A |
| `lastName` | *string* | :heavy_minus_sign: | N/A |
| `email` | *string* | :heavy_minus_sign: | N/A |
| `phone` | *string* | :heavy_minus_sign: | N/A |
22 changes: 22 additions & 0 deletions docs/models/components/activitynotificationtemplateresponsedto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# ActivityNotificationTemplateResponseDto

## Example Usage

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

let value: ActivityNotificationTemplateResponseDto = {
name: "<value>",
triggers: [
"<value>",
],
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *string* | :heavy_minus_sign: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `triggers` | *string*[] | :heavy_check_mark: | N/A |
19 changes: 19 additions & 0 deletions docs/models/components/activitystatsresponsedto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ActivityStatsResponseDto

## Example Usage

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

let value: ActivityStatsResponseDto = {
weeklySent: 391.88,
monthlySent: 2828.07,
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `weeklySent` | *number* | :heavy_check_mark: | N/A |
| `monthlySent` | *number* | :heavy_check_mark: | N/A |
23 changes: 23 additions & 0 deletions docs/models/components/actor.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Actor

It is used to display the Avatar of the provided actor's subscriber id or actor object.
If a new actor object is provided, we will create a new subscriber in our system



## Supported Types

### `string`

```typescript
const value: string = "<value>";
```

### `components.SubscriberPayloadDto`

```typescript
const value: components.SubscriberPayloadDto = {
subscriberId: "<id>",
};
```

19 changes: 19 additions & 0 deletions docs/models/components/addsubscribersrequestdto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AddSubscribersRequestDto

## Example Usage

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

let value: AddSubscribersRequestDto = {
subscribers: [
"<value>",
],
};
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `subscribers` | *string*[] | :heavy_check_mark: | List of subscriber identifiers that will be associated to the topic |
19 changes: 19 additions & 0 deletions docs/models/components/apikey.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ApiKey

## Example Usage

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

let value: ApiKey = {
key: "<key>",
userId: "<id>",
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *string* | :heavy_check_mark: | N/A |
| `userId` | *string* | :heavy_check_mark: | N/A |
15 changes: 15 additions & 0 deletions docs/models/components/backoffunit.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# BackoffUnit

## Example Usage

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

let value: BackoffUnit = "weeks";
```

## Values

```typescript
"seconds" | "minutes" | "hours" | "days" | "weeks" | "months"
```
19 changes: 19 additions & 0 deletions docs/models/components/bulksubscribercreatedto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# BulkSubscriberCreateDto

## Example Usage

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

let value: BulkSubscriberCreateDto = {
subscribers: [
"<value>",
],
};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `subscribers` | *string*[] | :heavy_check_mark: | N/A |
26 changes: 26 additions & 0 deletions docs/models/components/bulktriggereventdto.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# BulkTriggerEventDto

## Example Usage

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

let value: BulkTriggerEventDto = {
events: [
{
name: "workflow_identifier",
payload: {},
overrides: {},
to: [
"SUBSCRIBER_ID",
],
},
],
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `events` | [components.TriggerEventRequestDto](../../models/components/triggereventrequestdto.md)[] | :heavy_check_mark: | N/A |
15 changes: 15 additions & 0 deletions docs/models/components/channel.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Channel

## Example Usage

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

let value: Channel = "delay";
```

## Values

```typescript
"in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom"
```
Loading

0 comments on commit 2cdba1e

Please sign in to comment.