Skip to content

Commit

Permalink
relaunch (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
tatarco authored Dec 3, 2024
1 parent d3cd202 commit 977621f
Show file tree
Hide file tree
Showing 57 changed files with 191 additions and 113 deletions.
6 changes: 3 additions & 3 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: 6bff3a53-3f0b-40b4-942f-ff70dc583ae5
management:
docChecksum: b6e46829fb520744ea65b1c45ef2bce9
docChecksum: 2f63e7a28d45a69a946a65b5de961615
docVersion: "1.0"
speakeasyVersion: 1.449.0
generationVersion: 2.467.4
releaseVersion: 0.0.1-alpha.42
configChecksum: 6a25a5114091f4816e621709b800f29a
releaseVersion: 0.0.1-alpha.46
configChecksum: be65e72460544cf2e1ca212f663f1107
published: true
features:
typescript:
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
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.42
version: 0.0.1-alpha.46
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down
10 changes: 5 additions & 5 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ speakeasyVersion: 1.449.0
sources:
json-development:
sourceNamespace: json-development
sourceRevisionDigest: sha256:86a158f796f57429efdd5438c69c17f49dca67b83af0eb57305b5d2b8d573f34
sourceBlobDigest: sha256:8dd172d8ac26758b29cd2a0ddcef8539cd88c6feb348d9bd8dcae2630b5c00b1
sourceRevisionDigest: sha256:72a779f529dcca0cf0e23b9fd90b0bd8da416581ca003242eca913ac16d72105
sourceBlobDigest: sha256:ddb838bbd4b9c767e41bd9dba4c68ab76fd296ce42c0643b3c674210c98df815
tags:
- latest
- "1.0"
targets:
my-first-target:
source: json-development
sourceNamespace: json-development
sourceRevisionDigest: sha256:86a158f796f57429efdd5438c69c17f49dca67b83af0eb57305b5d2b8d573f34
sourceBlobDigest: sha256:8dd172d8ac26758b29cd2a0ddcef8539cd88c6feb348d9bd8dcae2630b5c00b1
sourceRevisionDigest: sha256:72a779f529dcca0cf0e23b9fd90b0bd8da416581ca003242eca913ac16d72105
sourceBlobDigest: sha256:ddb838bbd4b9c767e41bd9dba4c68ab76fd296ce42c0643b3c674210c98df815
codeSamplesNamespace: code-samples-typescript
codeSamplesRevisionDigest: sha256:cf1a4fa57d675a69332bc1689ced8081d868d24f5fbdea7de5216d43476afe30
codeSamplesRevisionDigest: sha256:b6f1aad469f106f778ba3cb9221750fb467b85ee23ce5012884e574920f5c5c4
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
4 changes: 2 additions & 2 deletions docs/models/components/activitiesresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ let value: ActivitiesResponseDto = {
transactionId: "<id>",
},
],
pageSize: 9764.59,
page: 4686.51,
pageSize: 4686.51,
page: 9767.61,
};
```

Expand Down
4 changes: 2 additions & 2 deletions docs/models/components/activitygraphstatesresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import { ActivityGraphStatesResponse } from "@novu/api/models/components";

let value: ActivityGraphStatesResponse = {
id: "<id>",
count: 2828.07,
count: 1201.97,
templates: [
"<value>",
],
channels: [
"in_app",
"email",
],
};
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { ActivityGraphStatesResponseChannels } from "@novu/api/models/components";

let value: ActivityGraphStatesResponseChannels = "in_app";
let value: ActivityGraphStatesResponseChannels = "email";
```

## Values
Expand Down
4 changes: 2 additions & 2 deletions docs/models/components/activitystatsresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
import { ActivityStatsResponseDto } from "@novu/api/models/components";

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

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/backoffunit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { BackoffUnit } from "@novu/api/models/components";

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

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { Channel } from "@novu/api/models/components";

let value: Channel = "email";
let value: Channel = "chat";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/channelcredentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import { ChannelCredentials } from "@novu/api/models/components";

let value: ChannelCredentials = {
webhookUrl: "https://accomplished-planula.biz",
webhookUrl: "https://remarkable-dream.net/",
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/channelpreferencetype.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The type of channel that is enabled or not
```typescript
import { ChannelPreferenceType } from "@novu/api/models/components";

let value: ChannelPreferenceType = "email";
let value: ChannelPreferenceType = "sms";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { Channels } from "@novu/api/models/components";

let value: Channels = "custom";
let value: Channels = "digest";
```

## Values
Expand Down
4 changes: 2 additions & 2 deletions docs/models/components/channelsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
import { ChannelSettings } from "@novu/api/models/components";

let value: ChannelSettings = {
providerId: "expo",
providerId: "ryver",
credentials: {
webhookUrl: "https://dental-morbidity.com/",
webhookUrl: "https://outrageous-agreement.net/",
},
integrationId: "<id>",
};
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/channelsettingsproviderid.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The provider identifier for the credentials
```typescript
import { ChannelSettingsProviderId } from "@novu/api/models/components";

let value: ChannelSettingsProviderId = "msteams";
let value: ChannelSettingsProviderId = "expo";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/createintegrationrequestdto.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { CreateIntegrationRequestDto } from "@novu/api/models/components";

let value: CreateIntegrationRequestDto = {
providerId: "<id>",
channel: "chat",
channel: "in_app",
};
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { CreateIntegrationRequestDtoChannel } from "@novu/api/models/components";

let value: CreateIntegrationRequestDtoChannel = "email";
let value: CreateIntegrationRequestDtoChannel = "chat";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/createsubscriberrequestdto.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ let value: CreateSubscriberRequestDto = {
| `phone` | *string* | :heavy_minus_sign: | N/A |
| `avatar` | *string* | :heavy_minus_sign: | An http url to the profile image of your subscriber |
| `locale` | *string* | :heavy_minus_sign: | N/A |
| `data` | [components.CreateSubscriberRequestDtoData](../../models/components/createsubscriberrequestdtodata.md) | :heavy_minus_sign: | Optional custom data for the subscriber |
| `data` | Record<string, *components.CreateSubscriberRequestDtoData*> | :heavy_minus_sign: | An optional payload object that can contain any properties |
| `channels` | [components.SubscriberChannelDto](../../models/components/subscriberchanneldto.md)[] | :heavy_minus_sign: | N/A |
29 changes: 22 additions & 7 deletions docs/models/components/createsubscriberrequestdtodata.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
# CreateSubscriberRequestDtoData

Optional custom data for the subscriber

## Example Usage
## Supported Types

### `string`

```typescript
import { CreateSubscriberRequestDtoData } from "@novu/api/models/components";
const value: string = "<value>";
```

### `string[]`

let value: CreateSubscriberRequestDtoData = {};
```typescript
const value: string[] = [
"<value>",
];
```

## Fields
### `boolean`

```typescript
const value: boolean = false;
```

### `number`

```typescript
const value: number = 9621.89;
```

| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
29 changes: 22 additions & 7 deletions docs/models/components/data.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
# Data

Optional custom data for the subscriber

## Example Usage
## Supported Types

### `string`

```typescript
import { Data } from "@novu/api/models/components";
const value: string = "<value>";
```

### `string[]`

let value: Data = {};
```typescript
const value: string[] = [
"<value>",
];
```

## Fields
### `boolean`

```typescript
const value: boolean = false;
```

### `number`

```typescript
const value: number = 1381.83;
```

| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
2 changes: 1 addition & 1 deletion docs/models/components/delayregularmetadataunit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { DelayRegularMetadataUnit } from "@novu/api/models/components";

let value: DelayRegularMetadataUnit = "minutes";
let value: DelayRegularMetadataUnit = "hours";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/emailblockstyles.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import { EmailBlockStyles } from "@novu/api/models/components";

let value: EmailBlockStyles = {
textAlign: "left",
textAlign: "center",
};
```

Expand Down
6 changes: 3 additions & 3 deletions docs/models/components/executiondetailsresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ let value: ExecutionDetailsResponseDto = {
notificationTemplateId: "<id>",
subscriberId: "<id>",
transactionId: "<id>",
channel: "in_app",
channel: "delay",
detail: "<value>",
source: "Webhook",
status: "Success",
source: "Credentials",
status: "ReadConfirmation",
isTest: false,
isRetry: false,
};
Expand Down
4 changes: 2 additions & 2 deletions docs/models/components/feedresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ let value: FeedResponseDto = {
data: [
"<value>",
],
pageSize: 4471.25,
page: 8464.09,
pageSize: 6994.79,
page: 2974.37,
};
```

Expand Down
4 changes: 2 additions & 2 deletions docs/models/components/fieldfilterpart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import { FieldFilterPart } from "@novu/api/models/components";
let value: FieldFilterPart = {
field: "<value>",
value: "<value>",
operator: "NOT_IN",
on: "payload",
operator: "IN",
on: "subscriber",
};
```

Expand Down
6 changes: 3 additions & 3 deletions docs/models/components/filtertopicsresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ let value: FilterTopicsResponseDto = {
],
},
],
page: 2239.25,
pageSize: 3453.52,
totalCount: 9280.81,
page: 580.29,
pageSize: 4344.17,
totalCount: 3117.96,
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/integrationresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ let value: IntegrationResponseDto = {
name: "<value>",
identifier: "<value>",
providerId: "<id>",
channel: "in_app",
channel: "email",
credentials: {},
active: false,
deleted: false,
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/integrationresponsedtochannel.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { IntegrationResponseDtoChannel } from "@novu/api/models/components";

let value: IntegrationResponseDtoChannel = "email";
let value: IntegrationResponseDtoChannel = "in_app";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/markmessageactionasseendto.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import { MarkMessageActionAsSeenDto } from "@novu/api/models/components";

let value: MarkMessageActionAsSeenDto = {
status: "done",
status: "pending",
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/messageactionresulttype.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { MessageActionResultType } from "@novu/api/models/components";

let value: MessageActionResultType = "secondary";
let value: MessageActionResultType = "primary";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/messagebuttontype.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```typescript
import { MessageButtonType } from "@novu/api/models/components";

let value: MessageButtonType = "primary";
let value: MessageButtonType = "secondary";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/messagemarkasrequestdto.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ let value: MessageMarkAsRequestDto = {
messageId: [
"<id>",
],
markAs: "seen",
markAs: "unread",
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/messageresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ let value: MessageResponseDto = {
createdAt: "<value>",
content: "<value>",
transactionId: "<id>",
channel: "push",
channel: "sms",
read: false,
seen: false,
cta: {
Expand Down
Loading

0 comments on commit 977621f

Please sign in to comment.