Skip to content

Commit

Permalink
fix list
Browse files Browse the repository at this point in the history
  • Loading branch information
@tatarco
tatarco committed Dec 23, 2024
1 parent d96bc02 commit aec6be8
Show file tree
Hide file tree
Showing 10 changed files with 236 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/models/operations/eventscontrollerbroadcasteventtoallrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# EventsControllerBroadcastEventToAllRequest

## Example Usage

```typescript
import { EventsControllerBroadcastEventToAllRequest } from "@novu/api/models/operations";

let value: EventsControllerBroadcastEventToAllRequest = {
triggerEventToAllRequestDto: {
name: "<value>",
payload: {
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides: {},
},
};
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `triggerEventToAllRequestDto` | [components.TriggerEventToAllRequestDto](../../models/components/triggereventtoallrequestdto.md) | :heavy_check_mark: | N/A |
41 changes: 41 additions & 0 deletions docs/models/operations/eventscontrollertriggerbulkrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# EventsControllerTriggerBulkRequest

## Example Usage

```typescript
import { EventsControllerTriggerBulkRequest } from "@novu/api/models/operations";

let value: EventsControllerTriggerBulkRequest = {
bulkTriggerEventDto: {
events: [
{
name: "workflow_identifier",
payload: {
"comment_id": "string",
"post": {
"text": "string",
},
},
bridgeUrl: "https://example.com/bridge",
overrides: {
"fcm": {
"data": {
"key": "value",
},
},
},
to: {
subscriberId: "<id>",
},
},
],
},
};
```

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `bulkTriggerEventDto` | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.md) | :heavy_check_mark: | N/A |
37 changes: 37 additions & 0 deletions docs/models/operations/eventscontrollertriggerrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# EventsControllerTriggerRequest

## Example Usage

```typescript
import { EventsControllerTriggerRequest } from "@novu/api/models/operations";

let value: EventsControllerTriggerRequest = {
triggerEventRequestDto: {
name: "workflow_identifier",
payload: {
"comment_id": "string",
"post": {
"text": "string",
},
},
bridgeUrl: "https://example.com/bridge",
overrides: {
"fcm": {
"data": {
"key": "value",
},
},
},
to: {
subscriberId: "<id>",
},
},
};
```

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `triggerEventRequestDto` | [components.TriggerEventRequestDto](../../models/components/triggereventrequestdto.md) | :heavy_check_mark: | N/A |
21 changes: 21 additions & 0 deletions docs/models/operations/integrationscontrollercreateintegrationrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# IntegrationsControllerCreateIntegrationRequest

## Example Usage

```typescript
import { IntegrationsControllerCreateIntegrationRequest } from "@novu/api/models/operations";

let value: IntegrationsControllerCreateIntegrationRequest = {
createIntegrationRequestDto: {
providerId: "<id>",
channel: "sms",
},
};
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `createIntegrationRequestDto` | [components.CreateIntegrationRequestDto](../../models/components/createintegrationrequestdto.md) | :heavy_check_mark: | N/A |
15 changes: 15 additions & 0 deletions docs/models/operations/integrationscontrollergetactiveintegrationsrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# IntegrationsControllerGetActiveIntegrationsRequest

## Example Usage

```typescript
import { IntegrationsControllerGetActiveIntegrationsRequest } from "@novu/api/models/operations";

let value: IntegrationsControllerGetActiveIntegrationsRequest = {};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
15 changes: 15 additions & 0 deletions docs/models/operations/integrationscontrollerlistintegrationsrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# IntegrationsControllerListIntegrationsRequest

## Example Usage

```typescript
import { IntegrationsControllerListIntegrationsRequest } from "@novu/api/models/operations";

let value: IntegrationsControllerListIntegrationsRequest = {};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
15 changes: 15 additions & 0 deletions docs/models/operations/notificationscontrollergetactivitystatsrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# NotificationsControllerGetActivityStatsRequest

## Example Usage

```typescript
import { NotificationsControllerGetActivityStatsRequest } from "@novu/api/models/operations";

let value: NotificationsControllerGetActivityStatsRequest = {};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
24 changes: 24 additions & 0 deletions docs/models/operations/subscriberscontrollerbulkcreatesubscribersrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# SubscribersControllerBulkCreateSubscribersRequest

## Example Usage

```typescript
import { SubscribersControllerBulkCreateSubscribersRequest } from "@novu/api/models/operations";

let value: SubscribersControllerBulkCreateSubscribersRequest = {
bulkSubscriberCreateDto: {
subscribers: [
{
subscriberId: "<id>",
},
],
},
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `bulkSubscriberCreateDto` | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md) | :heavy_check_mark: | N/A |
20 changes: 20 additions & 0 deletions docs/models/operations/subscriberscontrollercreatesubscriberrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# SubscribersControllerCreateSubscriberRequest

## Example Usage

```typescript
import { SubscribersControllerCreateSubscriberRequest } from "@novu/api/models/operations";

let value: SubscribersControllerCreateSubscriberRequest = {
createSubscriberRequestDto: {
subscriberId: "<id>",
},
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `createSubscriberRequestDto` | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md) | :heavy_check_mark: | N/A |
21 changes: 21 additions & 0 deletions docs/models/operations/topicscontrollercreatetopicrequest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# TopicsControllerCreateTopicRequest

## Example Usage

```typescript
import { TopicsControllerCreateTopicRequest } from "@novu/api/models/operations";

let value: TopicsControllerCreateTopicRequest = {
createTopicRequestDto: {
key: "<key>",
name: "<value>",
},
};
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
| `createTopicRequestDto` | [components.CreateTopicRequestDto](../../models/components/createtopicrequestdto.md) | :heavy_check_mark: | N/A |

0 comments on commit aec6be8

Please sign in to comment.