Skip to content

Commit

Permalink
change add error definition
Browse files Browse the repository at this point in the history
  • Loading branch information
tatarco committed Dec 19, 2024
1 parent c04e581 commit 228e42d
Show file tree
Hide file tree
Showing 62 changed files with 304 additions and 176 deletions.
8 changes: 5 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: 838446a9e5c749ec862a43ada4a50f9c
docChecksum: e90510d550621b4e7b02b40827acdbb0
docVersion: "1.0"
speakeasyVersion: 1.456.1
generationVersion: 2.481.0
releaseVersion: 0.0.1-alpha.129
configChecksum: 83e84c46494734a1755097c9c21dd905
releaseVersion: 0.0.1-alpha.131
configChecksum: 6204c50ddf1671ac5cbfea57ead36d40
published: true
features:
typescript:
Expand Down Expand Up @@ -152,6 +152,7 @@ generatedFiles:
- docs/models/components/preference.md
- docs/models/components/preferencechannels.md
- docs/models/components/providerid.md
- docs/models/components/providersidenum.md
- docs/models/components/removesubscribersrequestdto.md
- docs/models/components/renametopicrequestdto.md
- docs/models/components/renametopicresponsedto.md
Expand Down Expand Up @@ -440,6 +441,7 @@ generatedFiles:
- src/models/components/notificationtriggervariable.ts
- src/models/components/preference.ts
- src/models/components/preferencechannels.ts
- src/models/components/providersidenum.ts
- src/models/components/removesubscribersrequestdto.ts
- src/models/components/renametopicrequestdto.ts
- src/models/components/renametopicresponsedto.ts
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.129
version: 0.0.1-alpha.131
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.456.1
sources:
json-development:
sourceNamespace: json-development
sourceRevisionDigest: sha256:06f0aae3aade1f80547e92e741bed22f880ff5899999dc7cc3dcd588d7848b82
sourceBlobDigest: sha256:1ddc8af0e9b0d9ea14e4ad82cebaa97c2e5a0d0bed3011370ed7a5e16a0802e9
sourceRevisionDigest: sha256:576de934cd68713922be5d5cce81e7a84e330bfd9a2ea2bb3ffba9489106299b
sourceBlobDigest: sha256:d611ef4ad0fd47f7b13bd8ed8aa43d7ecb32910c465e12efcc6f333892ab57e1
tags:
- latest
- "1.0"
targets:
my-first-target:
source: json-development
sourceNamespace: json-development
sourceRevisionDigest: sha256:06f0aae3aade1f80547e92e741bed22f880ff5899999dc7cc3dcd588d7848b82
sourceBlobDigest: sha256:1ddc8af0e9b0d9ea14e4ad82cebaa97c2e5a0d0bed3011370ed7a5e16a0802e9
sourceRevisionDigest: sha256:576de934cd68713922be5d5cce81e7a84e330bfd9a2ea2bb3ffba9489106299b
sourceBlobDigest: sha256:d611ef4ad0fd47f7b13bd8ed8aa43d7ecb32910c465e12efcc6f333892ab57e1
codeSamplesNamespace: code-samples-typescript
codeSamplesRevisionDigest: sha256:05a9c0fc21a9fffd8be538147153755bfdf39168d010f42fa723b076fc23c3f0
codeSamplesRevisionDigest: sha256:e4e305dde473e8260e78dfec59a4973d04313daf81f17cdbda43dbc878f6b1cf
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
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: 1201.97,
count: 2961.40,
templates: [
"<value>",
],
channels: [
"email",
"in_app",
],
};
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ import { ActivityNotificationExecutionDetailResponseDto } from "@novu/api/models
let value: ActivityNotificationExecutionDetailResponseDto = {
id: "<id>",
jobId: "<id>",
status: "Success",
status: "ReadConfirmation",
detail: "<value>",
isRetry: false,
isTest: false,
providerId: 9764.59,
source: "Internal",
providerId: "bulk-sms",
source: "Webhook",
};
```

Expand All @@ -27,6 +27,6 @@ let value: ActivityNotificationExecutionDetailResponseDto = {
| `detail` | *string* | :heavy_check_mark: | Detailed information about the execution |
| `isRetry` | *boolean* | :heavy_check_mark: | Whether the execution is a retry or not |
| `isTest` | *boolean* | :heavy_check_mark: | Whether the execution is a test or not |
| `providerId` | *number* | :heavy_check_mark: | Provider ID of the job |
| `providerId` | [components.ProvidersIdEnum](../../models/components/providersidenum.md) | :heavy_check_mark: | Provider ID of the job |
| `raw` | *string* | :heavy_minus_sign: | Raw data of the execution |
| `source` | [components.Source](../../models/components/source.md) | :heavy_check_mark: | Source of the execution detail |
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Status of the execution detail
```typescript
import { ActivityNotificationExecutionDetailResponseDtoStatus } from "@novu/api/models/components";

let value: ActivityNotificationExecutionDetailResponseDtoStatus = "Success";
let value: ActivityNotificationExecutionDetailResponseDtoStatus =
"ReadConfirmation";
```

## Values
Expand Down
10 changes: 6 additions & 4 deletions docs/models/components/activitynotificationjobresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,18 @@ let value: ActivityNotificationJobResponseDto = {
detail: "<value>",
isRetry: false,
isTest: false,
providerId: 1965.82,
providerId: "mailersend",
source: "Internal",
},
],
step: {
id: "<id>",
active: false,
filters: {},
filters: [
{},
],
},
providerId: 8209.93,
providerId: "push-webhook",
status: "<value>",
};
```
Expand All @@ -40,5 +42,5 @@ let value: ActivityNotificationJobResponseDto = {
| `executionDetails` | [components.ActivityNotificationExecutionDetailResponseDto](../../models/components/activitynotificationexecutiondetailresponsedto.md)[] | :heavy_check_mark: | Execution details of the job |
| `step` | [components.ActivityNotificationStepResponseDto](../../models/components/activitynotificationstepresponsedto.md) | :heavy_check_mark: | Step details of the job |
| `payload` | [components.Payload](../../models/components/payload.md) | :heavy_minus_sign: | Optional payload for the job |
| `providerId` | *number* | :heavy_check_mark: | Provider ID of the job |
| `providerId` | [components.ProvidersIdEnum](../../models/components/providersidenum.md) | :heavy_check_mark: | Provider ID of the job |
| `status` | *string* | :heavy_check_mark: | Status of the job |
6 changes: 4 additions & 2 deletions docs/models/components/activitynotificationstepresponsedto.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import { ActivityNotificationStepResponseDto } from "@novu/api/models/components
let value: ActivityNotificationStepResponseDto = {
id: "<id>",
active: false,
filters: {},
filters: [
{},
],
};
```

Expand All @@ -18,5 +20,5 @@ let value: ActivityNotificationStepResponseDto = {
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `id` | *string* | :heavy_check_mark: | Unique identifier of the step |
| `active` | *boolean* | :heavy_check_mark: | Whether the step is active or not |
| `filters` | [components.StepFilter](../../models/components/stepfilter.md) | :heavy_check_mark: | Filter criteria for the step |
| `filters` | [components.StepFilter](../../models/components/stepfilter.md)[] | :heavy_check_mark: | Filter criteria for the step |
| `template` | [components.MessageTemplateDto](../../models/components/messagetemplatedto.md) | :heavy_minus_sign: | Optional template for the step |
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: 7392.64,
monthlySent: 391.88,
weeklySent: 391.88,
monthlySent: 2828.07,
};
```

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

let value: ActorFeedItemDto = {
data: null,
type: "user",
type: "system_custom",
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/actortypeenum.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The type of the actor, indicating the role in the notification process.
```typescript
import { ActorTypeEnum } from "@novu/api/models/components";

let value: ActorTypeEnum = "system_custom";
let value: ActorTypeEnum = "system_icon";
```

## 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 @@ -7,7 +7,7 @@ The channel type for the integration, which defines how the integration communic
```typescript
import { Channel } from "@novu/api/models/components";

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

## 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://glass-pigpen.com",
webhookUrl: "https://raw-ceramic.net/",
};
```

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

let value: ChannelPreference = {
type: "email",
type: "chat",
enabled: false,
};
```
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 = "chat";
let value: ChannelPreferenceType = "email";
```

## 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 = "email";
let value: Channels = "in_app";
```

## 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: "whatsapp-business",
providerId: "ryver",
credentials: {
webhookUrl: "https://moist-bourgeoisie.name/",
webhookUrl: "https://bulky-minister.org",
},
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 = "apns";
let value: ChannelSettingsProviderId = "whatsapp-business";
```

## 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: "in_app",
channel: "chat",
};
```

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

let value: CreateIntegrationRequestDtoChannel = "sms";
let value: CreateIntegrationRequestDtoChannel = "in_app";
```

## Values
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/createsubscriberrequestdtodata.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ const value: boolean = false;
### `number`

```typescript
const value: number = 7163.27;
const value: number = 2894.06;
```

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/digestregularmetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import { DigestRegularMetadata } from "@novu/api/models/components";

let value: DigestRegularMetadata = {
type: "regular",
type: "backoff",
};
```

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

let value: DigestTimedMetadataUnit = "minutes";
let value: DigestTimedMetadataUnit = "seconds";
```

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

let value: EmailBlock = {
type: "text",
type: "button",
content: "<value>",
};
```
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: "center",
textAlign: "left",
};
```

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

let value: EmailBlockType = "button";
let value: EmailBlockType = "text";
```

## Values
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 @@ -23,14 +23,14 @@ let value: FeedResponseDto = {
updatedAt: new Date("2024-12-10T10:10:59.639Z"),
actor: {
data: null,
type: "system_icon",
type: "system_custom",
},
transactionId: "transaction_123456",
templateIdentifier: "template_abcdef",
providerId: "provider_xyz",
content: "This is a test notification content.",
subject: "Test Notification Subject",
channel: "push",
channel: "email",
read: false,
seen: true,
deleted: false,
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: "email",
channel: "sms",
credentials: {},
active: false,
deleted: false,
Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/markallmessageasrequestdto.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import { MarkAllMessageAsRequestDto } from "@novu/api/models/components";

let value: MarkAllMessageAsRequestDto = {
markAs: "unread",
markAs: "unseen",
};
```

Expand Down
2 changes: 1 addition & 1 deletion docs/models/components/markallmessageasrequestdtomarkas.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Mark all subscriber messages as read, unread, seen or unseen
```typescript
import { MarkAllMessageAsRequestDtoMarkAs } from "@novu/api/models/components";

let value: MarkAllMessageAsRequestDtoMarkAs = "unseen";
let value: MarkAllMessageAsRequestDtoMarkAs = "unread";
```

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

let value: MarkAs = "seen";
let value: MarkAs = "unseen";
```

## Values
Expand Down
Loading

0 comments on commit 228e42d

Please sign in to comment.