Skip to content

Commit 4e3934f

Browse files
github-actions[bot]github-actions[bot]
authored
Merge pull request #13 from novuhq/speakeasy-sdk-regen-1747959299
chore: 🐝 Update SDK - Generate 1.2.0
1 parent 1b2b8ed commit 4e3934f

File tree

368 files changed

+14239
-420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

368 files changed

+14239
-420
lines changed

‎.speakeasy/gen.lock‎

Lines changed: 561 additions & 11 deletions
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ generation:
44
maintainOpenAPIOrder: true
55
usageSnippets:
66
optionalPropertyRendering: withExample
7+
sdkInitStyle: constructor
78
useClassNamesForArrayFields: true
89
fixes:
910
nameResolutionDec2023: true
@@ -16,12 +17,13 @@ generation:
1617
oAuth2ClientCredentialsEnabled: true
1718
oAuth2PasswordEnabled: true
1819
php:
19-
version: 1.1.0
20+
version: 1.2.0
2021
additionalDependencies:
2122
autoload: {}
2223
autoload-dev: {}
2324
require: {}
2425
require-dev: {}
26+
baseErrorName: NovuError
2527
clientServerStatusCodesAsErrors: true
2628
defaultErrorName: APIException
2729
flattenGlobalSecurity: true

‎.speakeasy/workflow.lock‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.548.4
1+
speakeasyVersion: 1.563.4
22
sources:
33
novu-OAS:
44
sourceNamespace: novu-oas
5-
sourceRevisionDigest: sha256:1415cd8417773fba0d8abd2182c6217c68da03543a41959f44dc62c5a9300f7b
6-
sourceBlobDigest: sha256:b09c07f4d596f62186737a367aa3a5ac68dbc1ab5718e2c51d794dd962eae3b4
5+
sourceRevisionDigest: sha256:f39ea58a452ec040460282bcb6750ce6d356076028a7bc1bd66d5b249f319404
6+
sourceBlobDigest: sha256:3a71375477c3e1053ffbe3de9ace82274d20b9e3332fd655caef08828c5c8ed4
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1747181684
9+
- speakeasy-sdk-regen-1747959299
1010
- 2.2.0
1111
targets:
1212
novu:
1313
source: novu-OAS
1414
sourceNamespace: novu-oas
15-
sourceRevisionDigest: sha256:1415cd8417773fba0d8abd2182c6217c68da03543a41959f44dc62c5a9300f7b
16-
sourceBlobDigest: sha256:b09c07f4d596f62186737a367aa3a5ac68dbc1ab5718e2c51d794dd962eae3b4
15+
sourceRevisionDigest: sha256:f39ea58a452ec040460282bcb6750ce6d356076028a7bc1bd66d5b249f319404
16+
sourceBlobDigest: sha256:3a71375477c3e1053ffbe3de9ace82274d20b9e3332fd655caef08828c5c8ed4
1717
codeSamplesNamespace: novu-oas-php-code-samples
18-
codeSamplesRevisionDigest: sha256:f5c43e3a77ccba9dcccd0683471bb27c1a9eb9a4575d9f09ea45935f50a3bd94
18+
codeSamplesRevisionDigest: sha256:f76c05067ecb97da0ed6feb7eb4f010a320c6c554e813846d1b2b326c40776de
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

‎README.md‎

Lines changed: 64 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
120120
);
121121

122122
$response = $sdk->trigger(
123-
triggerEventRequestDto: $triggerEventRequestDto,
124-
idempotencyKey: '<value>'
125-
123+
triggerEventRequestDto: $triggerEventRequestDto
126124
);
127125

128126
if ($response->triggerEventResponseDto !== null) {
@@ -148,9 +146,7 @@ $sdk = novu\Novu::builder()
148146

149147

150148
$response = $sdk->cancel(
151-
transactionId: '<id>',
152-
idempotencyKey: '<value>'
153-
149+
transactionId: '<id>'
154150
);
155151

156152
if ($response->boolean !== null) {
@@ -194,9 +190,7 @@ $triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
194190
);
195191

196192
$response = $sdk->triggerBroadcast(
197-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
198-
idempotencyKey: '<value>'
199-
193+
triggerEventToAllRequestDto: $triggerEventToAllRequestDto
200194
);
201195

202196
if ($response->triggerEventResponseDto !== null) {
@@ -233,13 +227,33 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
233227
overrides: new Components\Overrides(),
234228
to: 'SUBSCRIBER_ID',
235229
),
230+
new Components\TriggerEventRequestDto(
231+
workflowId: 'workflow_identifier',
232+
payload: [
233+
'comment_id' => 'string',
234+
'post' => [
235+
'text' => 'string',
236+
],
237+
],
238+
overrides: new Components\Overrides(),
239+
to: 'SUBSCRIBER_ID',
240+
),
241+
new Components\TriggerEventRequestDto(
242+
workflowId: 'workflow_identifier',
243+
payload: [
244+
'comment_id' => 'string',
245+
'post' => [
246+
'text' => 'string',
247+
],
248+
],
249+
overrides: new Components\Overrides(),
250+
to: 'SUBSCRIBER_ID',
251+
),
236252
],
237253
);
238254

239255
$response = $sdk->triggerBulk(
240-
bulkTriggerEventDto: $bulkTriggerEventDto,
241-
idempotencyKey: '<value>'
242-
256+
bulkTriggerEventDto: $bulkTriggerEventDto
243257
);
244258

245259
if ($response->triggerEventResponseDtos !== null) {
@@ -287,9 +301,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
287301
);
288302

289303
$response = $sdk->trigger(
290-
triggerEventRequestDto: $triggerEventRequestDto,
291-
idempotencyKey: '<value>'
292-
304+
triggerEventRequestDto: $triggerEventRequestDto
293305
);
294306

295307
if ($response->triggerEventResponseDto !== null) {
@@ -304,6 +316,13 @@ if ($response->triggerEventResponseDto !== null) {
304316
<details open>
305317
<summary>Available methods</summary>
306318

319+
### [environments](docs/sdks/environments/README.md)
320+
321+
* [create](docs/sdks/environments/README.md#create) - Create an environment
322+
* [list](docs/sdks/environments/README.md#list) - List all environments
323+
* [update](docs/sdks/environments/README.md#update) - Update an environment
324+
* [delete](docs/sdks/environments/README.md#delete) - Delete an environment
325+
307326
### [integrations](docs/sdks/integrations/README.md)
308327

309328
* [list](docs/sdks/integrations/README.md#list) - List all integrations
@@ -337,7 +356,7 @@ if ($response->triggerEventResponseDto !== null) {
337356
* [create](docs/sdks/subscribers/README.md#create) - Create a subscriber
338357
* [get](docs/sdks/subscribers/README.md#get) - Retrieve a subscriber
339358
* [patch](docs/sdks/subscribers/README.md#patch) - Update a subscriber
340-
* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
359+
* [delete](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
341360
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
342361
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber preferences
343362
* [updateCredentials](docs/sdks/subscribers/README.md#updatecredentials) - Update provider credentials
@@ -391,6 +410,20 @@ if ($response->triggerEventResponseDto !== null) {
391410

392411
* [check](docs/sdks/topicssubscribers/README.md#check) - Check topic subscriber
393412

413+
### [workflows](docs/sdks/workflows/README.md)
414+
415+
* [create](docs/sdks/workflows/README.md#create) - Create a workflow
416+
* [list](docs/sdks/workflows/README.md#list) - List all workflows
417+
* [update](docs/sdks/workflows/README.md#update) - Update a workflow
418+
* [get](docs/sdks/workflows/README.md#get) - Retrieve a workflow
419+
* [delete](docs/sdks/workflows/README.md#delete) - Delete a workflow
420+
* [patch](docs/sdks/workflows/README.md#patch) - Update a workflow
421+
* [sync](docs/sdks/workflows/README.md#sync) - Sync a workflow
422+
423+
#### [workflows->steps](docs/sdks/steps/README.md)
424+
425+
* [retrieve](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
426+
394427
</details>
395428
<!-- End Available Resources and Operations [operations] -->
396429

@@ -429,7 +462,6 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
429462

430463
$response = $sdk->trigger(
431464
triggerEventRequestDto: $triggerEventRequestDto,
432-
idempotencyKey: '<value>',
433465
options: Utils\Options->builder()->setRetryConfig(
434466
new Retry\RetryConfigBackoff(
435467
initialInterval: 1,
@@ -484,9 +516,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
484516
);
485517

486518
$response = $sdk->trigger(
487-
triggerEventRequestDto: $triggerEventRequestDto,
488-
idempotencyKey: '<value>'
489-
519+
triggerEventRequestDto: $triggerEventRequestDto
490520
);
491521

492522
if ($response->triggerEventResponseDto !== null) {
@@ -511,13 +541,14 @@ By default an API error will raise a `Errors\APIException` exception, which has
511541

512542
When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `trigger` method throws the following exceptions:
513543

514-
| Error Type | Status Code | Content Type |
515-
| ------------------------- | -------------------------------------- | ---------------- |
516-
| Errors\ErrorDto | 414 | application/json |
517-
| Errors\ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
518-
| Errors\ValidationErrorDto | 422 | application/json |
519-
| Errors\ErrorDto | 500 | application/json |
520-
| Errors\APIException | 4XX, 5XX | \*/\* |
544+
| Error Type | Status Code | Content Type |
545+
| ------------------------------------ | --------------------------------- | ---------------- |
546+
| Errors\PayloadValidationExceptionDto | 400 | application/json |
547+
| Errors\ErrorDto | 414 | application/json |
548+
| Errors\ErrorDto | 401, 403, 404, 405, 409, 413, 415 | application/json |
549+
| Errors\ValidationErrorDto | 422 | application/json |
550+
| Errors\ErrorDto | 500 | application/json |
551+
| Errors\APIException | 4XX, 5XX | \*/\* |
521552

522553
### Example
523554

@@ -550,14 +581,15 @@ try {
550581
);
551582

552583
$response = $sdk->trigger(
553-
triggerEventRequestDto: $triggerEventRequestDto,
554-
idempotencyKey: '<value>'
555-
584+
triggerEventRequestDto: $triggerEventRequestDto
556585
);
557586

558587
if ($response->triggerEventResponseDto !== null) {
559588
// handle response
560589
}
590+
} catch (Errors\PayloadValidationExceptionDtoThrowable $e) {
591+
// handle $e->$container data
592+
throw $e;
561593
} catch (Errors\ErrorDtoThrowable $e) {
562594
// handle $e->$container data
563595
throw $e;
@@ -619,9 +651,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
619651
);
620652

621653
$response = $sdk->trigger(
622-
triggerEventRequestDto: $triggerEventRequestDto,
623-
idempotencyKey: '<value>'
624-
654+
triggerEventRequestDto: $triggerEventRequestDto
625655
);
626656

627657
if ($response->triggerEventResponseDto !== null) {
@@ -660,9 +690,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
660690
);
661691

662692
$response = $sdk->trigger(
663-
triggerEventRequestDto: $triggerEventRequestDto,
664-
idempotencyKey: '<value>'
665-
693+
triggerEventRequestDto: $triggerEventRequestDto
666694
);
667695

668696
if ($response->triggerEventResponseDto !== null) {

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,14 @@ Based on:
5858
### Generated
5959
- [php v1.1.0] .
6060
### Releases
61-
- [Composer v1.1.0] https://packagist.org/packages/novuhq/novu#v1.1.0 - .
61+
- [Composer v1.1.0] https://packagist.org/packages/novuhq/novu#v1.1.0 - .
62+
63+
## 2025-06-17 16:18:11
64+
### Changes
65+
Based on:
66+
- OpenAPI Doc
67+
- Speakeasy CLI 1.563.4 (2.630.6) https://github.com/speakeasy-api/speakeasy
68+
### Generated
69+
- [php v1.2.0] .
70+
### Releases
71+
- [Composer v1.2.0] https://packagist.org/packages/novuhq/novu#v1.2.0 - .

‎USAGE.md‎

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
2828
);
2929

3030
$response = $sdk->trigger(
31-
triggerEventRequestDto: $triggerEventRequestDto,
32-
idempotencyKey: '<value>'
33-
31+
triggerEventRequestDto: $triggerEventRequestDto
3432
);
3533

3634
if ($response->triggerEventResponseDto !== null) {
@@ -56,9 +54,7 @@ $sdk = novu\Novu::builder()
5654

5755

5856
$response = $sdk->cancel(
59-
transactionId: '<id>',
60-
idempotencyKey: '<value>'
61-
57+
transactionId: '<id>'
6258
);
6359

6460
if ($response->boolean !== null) {
@@ -102,9 +98,7 @@ $triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
10298
);
10399

104100
$response = $sdk->triggerBroadcast(
105-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
106-
idempotencyKey: '<value>'
107-
101+
triggerEventToAllRequestDto: $triggerEventToAllRequestDto
108102
);
109103

110104
if ($response->triggerEventResponseDto !== null) {
@@ -141,13 +135,33 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
141135
overrides: new Components\Overrides(),
142136
to: 'SUBSCRIBER_ID',
143137
),
138+
new Components\TriggerEventRequestDto(
139+
workflowId: 'workflow_identifier',
140+
payload: [
141+
'comment_id' => 'string',
142+
'post' => [
143+
'text' => 'string',
144+
],
145+
],
146+
overrides: new Components\Overrides(),
147+
to: 'SUBSCRIBER_ID',
148+
),
149+
new Components\TriggerEventRequestDto(
150+
workflowId: 'workflow_identifier',
151+
payload: [
152+
'comment_id' => 'string',
153+
'post' => [
154+
'text' => 'string',
155+
],
156+
],
157+
overrides: new Components\Overrides(),
158+
to: 'SUBSCRIBER_ID',
159+
),
144160
],
145161
);
146162

147163
$response = $sdk->triggerBulk(
148-
bulkTriggerEventDto: $bulkTriggerEventDto,
149-
idempotencyKey: '<value>'
150-
164+
bulkTriggerEventDto: $bulkTriggerEventDto
151165
);
152166

153167
if ($response->triggerEventResponseDtos !== null) {

‎docs/Models/Components/ActionDto.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ActionDto
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
8+
| `label` | *?string* | :heavy_minus_sign: | Label for the action button. |
9+
| `redirect` | [?Components\RedirectDto](../../Models/Components/RedirectDto.md) | :heavy_minus_sign: | Redirect configuration for the action. |

‎docs/Models/Components/All.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# All
2+
3+
A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
4+
5+
6+
## Supported Types
7+
8+
### `Components\WorkflowPreferenceDto`
9+
10+
```php
11+
/**
12+
* @var Components\WorkflowPreferenceDto
13+
*/
14+
Components\WorkflowPreferenceDto $value = /* values here */
15+
```
16+

‎docs/Models/Components/ApiKeyDto.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ApiKeyDto
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description | Example |
7+
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
8+
| `key` | *string* | :heavy_check_mark: | API key | sk_test_1234567890abcdef |
9+
| `userId` | *string* | :heavy_check_mark: | User ID associated with the API key | 60d5ecb8b3b3a30015f3e1a4 |
10+
| `hash` | *?string* | :heavy_minus_sign: | Hashed representation of the API key | hash_value_here |

‎docs/Models/Components/BridgeConfigurationDto.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# BridgeConfigurationDto
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `url` | *?string* | :heavy_minus_sign: | N/A |

0 commit comments

Comments
 (0)