Skip to content

Commit 6c2d637

Browse files
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.531.4
1 parent 2560a29 commit 6c2d637

File tree

188 files changed

+4052
-1268
lines changed

Some content is hidden

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

188 files changed

+4052
-1268
lines changed

Diff for: .speakeasy/gen.lock

+366-598
Large diffs are not rendered by default.

Diff for: .speakeasy/gen.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ generation:
1515
oAuth2ClientCredentialsEnabled: true
1616
oAuth2PasswordEnabled: true
1717
php:
18-
version: 0.1.0
18+
version: 0.1.1
1919
additionalDependencies:
2020
autoload: {}
2121
autoload-dev: {}

Diff for: .speakeasy/workflow.lock

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.521.0
1+
speakeasyVersion: 1.531.4
22
sources:
33
novu-OAS:
44
sourceNamespace: novu-oas
5-
sourceRevisionDigest: sha256:db132a7c0fa4fa7afc85a30c791f67ecb7c9db21611342c55d4b76fefb1b3e8d
6-
sourceBlobDigest: sha256:1ad751b8cc9aa8375333d9cf6bdf630c8ffa7a26b388d27aa13f75b942971b16
5+
sourceRevisionDigest: sha256:ea398de4163338a3ac34f7740baf15835b350d8382bf9ebc36495c77b4380730
6+
sourceBlobDigest: sha256:02c834482ce72ee81ee64d30093526c110b1be9d841de711f2448f652c2f3228
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1738887190
9+
- speakeasy-sdk-regen-1742516022
1010
- "1.0"
1111
targets:
1212
novu:
1313
source: novu-OAS
1414
sourceNamespace: novu-oas
15-
sourceRevisionDigest: sha256:db132a7c0fa4fa7afc85a30c791f67ecb7c9db21611342c55d4b76fefb1b3e8d
16-
sourceBlobDigest: sha256:1ad751b8cc9aa8375333d9cf6bdf630c8ffa7a26b388d27aa13f75b942971b16
15+
sourceRevisionDigest: sha256:ea398de4163338a3ac34f7740baf15835b350d8382bf9ebc36495c77b4380730
16+
sourceBlobDigest: sha256:02c834482ce72ee81ee64d30093526c110b1be9d841de711f2448f652c2f3228
1717
codeSamplesNamespace: novu-oas-php-code-samples
18-
codeSamplesRevisionDigest: sha256:bd86287151037d649bb2e639b261b377edb4092d12b12422a2b184c616cbee56
18+
codeSamplesRevisionDigest: sha256:2da61a35b964a6b9ceb7ddab1ed5ee42f49108e303000f328487b8c9d3cb4b43
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

Diff for: README.md

+116-50
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
6363
<!-- Start Table of Contents [toc] -->
6464
## Table of Contents
6565
<!-- $toc-max-depth=2 -->
66+
* [Novu PHP SDK](#novu-php-sdk)
6667
* [SDK Installation](#sdk-installation)
6768
* [SDK Example Usage](#sdk-example-usage)
6869
* [Authentication](#authentication)
@@ -109,9 +110,6 @@ $sdk = novu\Novu::builder()
109110

110111
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
111112
workflowId: 'workflow_identifier',
112-
to: new Components\SubscriberPayloadDto(
113-
subscriberId: '<id>',
114-
),
115113
payload: [
116114
'comment_id' => 'string',
117115
'post' => [
@@ -125,6 +123,9 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
125123
],
126124
],
127125
],
126+
to: new Components\SubscriberPayloadDto(
127+
subscriberId: '<id>',
128+
),
128129
);
129130

130131
$response = $sdk->trigger(
@@ -224,10 +225,6 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
224225
events: [
225226
new Components\TriggerEventRequestDto(
226227
workflowId: 'workflow_identifier',
227-
to: new Components\TopicPayloadDto(
228-
topicKey: '<value>',
229-
type: Components\TriggerRecipientsTypeEnum::Topic,
230-
),
231228
payload: [
232229
'comment_id' => 'string',
233230
'post' => [
@@ -241,6 +238,10 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
241238
],
242239
],
243240
],
241+
to: new Components\TopicPayloadDto(
242+
topicKey: '<value>',
243+
type: Components\TriggerRecipientsTypeEnum::Topic,
244+
),
244245
),
245246
],
246247
);
@@ -283,19 +284,28 @@ $sdk = novu\Novu::builder()
283284
)
284285
->build();
285286

286-
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
287-
name: '<value>',
287+
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
288+
workflowId: 'workflow_identifier',
288289
payload: [
289290
'comment_id' => 'string',
290291
'post' => [
291292
'text' => 'string',
292293
],
293294
],
294-
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
295+
overrides: [
296+
'fcm' => [
297+
'data' => [
298+
'key' => 'value',
299+
],
300+
],
301+
],
302+
to: new Components\SubscriberPayloadDto(
303+
subscriberId: '<id>',
304+
),
295305
);
296306

297-
$response = $sdk->triggerBroadcast(
298-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
307+
$response = $sdk->trigger(
308+
triggerEventRequestDto: $triggerEventRequestDto,
299309
idempotencyKey: '<value>'
300310

301311
);
@@ -314,27 +324,27 @@ if ($response->triggerEventResponseDto !== null) {
314324

315325
### [integrations](docs/sdks/integrations/README.md)
316326

317-
* [create](docs/sdks/integrations/README.md#create) - Create integration
318-
* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations
319327
* [list](docs/sdks/integrations/README.md#list) - Get integrations
328+
* [create](docs/sdks/integrations/README.md#create) - Create integration
329+
* [update](docs/sdks/integrations/README.md#update) - Update integration
320330
* [delete](docs/sdks/integrations/README.md#delete) - Delete integration
321331
* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
322-
* [update](docs/sdks/integrations/README.md#update) - Update integration
332+
* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations
323333

324334
#### [integrations->webhooks](docs/sdks/webhooks/README.md)
325335

326336
* [getSupportStatus](docs/sdks/webhooks/README.md#getsupportstatus) - Get webhook support status for provider
327337

328338
### [messages](docs/sdks/messages/README.md)
329339

340+
* [get](docs/sdks/messages/README.md#get) - Get messages
330341
* [delete](docs/sdks/messages/README.md#delete) - Delete message
331342
* [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
332-
* [get](docs/sdks/messages/README.md#get) - Get messages
333343

334344
### [notifications](docs/sdks/notifications/README.md)
335345

336-
* [get](docs/sdks/notifications/README.md#get) - Get notification
337346
* [list](docs/sdks/notifications/README.md#list) - Get notifications
347+
* [get](docs/sdks/notifications/README.md#get) - Get notification
338348

339349
#### [notifications->stats](docs/sdks/stats/README.md)
340350

@@ -346,21 +356,22 @@ if ($response->triggerEventResponseDto !== null) {
346356

347357
### [Novu SDK](docs/sdks/novu/README.md)
348358

349-
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
350-
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
351359
* [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
360+
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
361+
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
352362
* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
353363

354364
### [subscribers](docs/sdks/subscribers/README.md)
355365

366+
* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
356367
* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
357368
* [get](docs/sdks/subscribers/README.md#get) - Get subscriber
358369
* [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
359370
* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
360-
* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
361-
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber global or workflow specific preferences
362-
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
363371
* [list](docs/sdks/subscribers/README.md#list) - Get subscribers
372+
* [update](docs/sdks/subscribers/README.md#update) - Upsert subscriber
373+
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
374+
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber global or workflow specific preferences
364375
* [updateCredentials](docs/sdks/subscribers/README.md#updatecredentials) - Update subscriber credentials
365376
* [updateOnlineStatus](docs/sdks/subscribers/README.md#updateonlinestatus) - Update subscriber online status
366377

@@ -383,8 +394,8 @@ if ($response->triggerEventResponseDto !== null) {
383394

384395
### [subscribersCredentials](docs/sdks/subscriberscredentials/README.md)
385396

386-
* [deleteProvider](docs/sdks/subscriberscredentials/README.md#deleteprovider) - Delete subscriber credentials by providerId
387397
* [append](docs/sdks/subscriberscredentials/README.md#append) - Modify subscriber credentials
398+
* [deleteProvider](docs/sdks/subscriberscredentials/README.md#deleteprovider) - Delete subscriber credentials by providerId
388399

389400
### [subscribersMessages](docs/sdks/subscribersmessages/README.md)
390401

@@ -401,9 +412,9 @@ if ($response->triggerEventResponseDto !== null) {
401412
### [topics](docs/sdks/topics/README.md)
402413

403414
* [create](docs/sdks/topics/README.md#create) - Topic creation
415+
* [list](docs/sdks/topics/README.md#list) - Get topic list filtered
404416
* [delete](docs/sdks/topics/README.md#delete) - Delete topic
405417
* [get](docs/sdks/topics/README.md#get) - Get topic
406-
* [list](docs/sdks/topics/README.md#list) - Get topic list filtered
407418
* [rename](docs/sdks/topics/README.md#rename) - Rename a topic
408419

409420
#### [topics->subscribers](docs/sdks/novutopicssubscribers/README.md)
@@ -415,6 +426,16 @@ if ($response->triggerEventResponseDto !== null) {
415426

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

429+
### [workflows](docs/sdks/workflows/README.md)
430+
431+
* [create](docs/sdks/workflows/README.md#create)
432+
* [workflowControllerSearchWorkflows](docs/sdks/workflows/README.md#workflowcontrollersearchworkflows)
433+
* [update](docs/sdks/workflows/README.md#update)
434+
* [retrieve](docs/sdks/workflows/README.md#retrieve)
435+
* [delete](docs/sdks/workflows/README.md#delete)
436+
* [workflowControllerPatchWorkflow](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflow)
437+
* [workflowControllerSync](docs/sdks/workflows/README.md#workflowcontrollersync)
438+
418439
</details>
419440
<!-- End Available Resources and Operations [operations] -->
420441

@@ -477,19 +498,28 @@ $sdk = novu\Novu::builder()
477498
)
478499
->build();
479500

480-
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
481-
name: '<value>',
501+
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
502+
workflowId: 'workflow_identifier',
482503
payload: [
483504
'comment_id' => 'string',
484505
'post' => [
485506
'text' => 'string',
486507
],
487508
],
488-
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
509+
overrides: [
510+
'fcm' => [
511+
'data' => [
512+
'key' => 'value',
513+
],
514+
],
515+
],
516+
to: new Components\SubscriberPayloadDto(
517+
subscriberId: '<id>',
518+
),
489519
);
490520

491-
$response = $sdk->triggerBroadcast(
492-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
521+
$response = $sdk->trigger(
522+
triggerEventRequestDto: $triggerEventRequestDto,
493523
idempotencyKey: '<value>',
494524
options: Utils\Options->builder()->setRetryConfig(
495525
new Retry\RetryConfigBackoff(
@@ -532,19 +562,28 @@ $sdk = novu\Novu::builder()
532562
)
533563
->build();
534564

535-
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
536-
name: '<value>',
565+
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
566+
workflowId: 'workflow_identifier',
537567
payload: [
538568
'comment_id' => 'string',
539569
'post' => [
540570
'text' => 'string',
541571
],
542572
],
543-
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
573+
overrides: [
574+
'fcm' => [
575+
'data' => [
576+
'key' => 'value',
577+
],
578+
],
579+
],
580+
to: new Components\SubscriberPayloadDto(
581+
subscriberId: '<id>',
582+
),
544583
);
545584

546-
$response = $sdk->triggerBroadcast(
547-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
585+
$response = $sdk->trigger(
586+
triggerEventRequestDto: $triggerEventRequestDto,
548587
idempotencyKey: '<value>'
549588

550589
);
@@ -569,7 +608,7 @@ By default an API error will raise a `Errors\APIException` exception, which has
569608
| `$rawResponse` | *?\Psr\Http\Message\ResponseInterface* | The raw HTTP response |
570609
| `$body` | *string* | The response content |
571610

572-
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 `triggerBroadcast` method throws the following exceptions:
611+
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:
573612

574613
| Error Type | Status Code | Content Type |
575614
| ------------------------- | -------------------------------------- | ---------------- |
@@ -597,19 +636,28 @@ $sdk = novu\Novu::builder()
597636
->build();
598637

599638
try {
600-
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
601-
name: '<value>',
639+
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
640+
workflowId: 'workflow_identifier',
602641
payload: [
603642
'comment_id' => 'string',
604643
'post' => [
605644
'text' => 'string',
606645
],
607646
],
608-
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
647+
overrides: [
648+
'fcm' => [
649+
'data' => [
650+
'key' => 'value',
651+
],
652+
],
653+
],
654+
to: new Components\SubscriberPayloadDto(
655+
subscriberId: '<id>',
656+
),
609657
);
610658

611-
$response = $sdk->triggerBroadcast(
612-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
659+
$response = $sdk->trigger(
660+
triggerEventRequestDto: $triggerEventRequestDto,
613661
idempotencyKey: '<value>'
614662

615663
);
@@ -665,19 +713,28 @@ $sdk = novu\Novu::builder()
665713
)
666714
->build();
667715

668-
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
669-
name: '<value>',
716+
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
717+
workflowId: 'workflow_identifier',
670718
payload: [
671719
'comment_id' => 'string',
672720
'post' => [
673721
'text' => 'string',
674722
],
675723
],
676-
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
724+
overrides: [
725+
'fcm' => [
726+
'data' => [
727+
'key' => 'value',
728+
],
729+
],
730+
],
731+
to: new Components\SubscriberPayloadDto(
732+
subscriberId: '<id>',
733+
),
677734
);
678735

679-
$response = $sdk->triggerBroadcast(
680-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
736+
$response = $sdk->trigger(
737+
triggerEventRequestDto: $triggerEventRequestDto,
681738
idempotencyKey: '<value>'
682739

683740
);
@@ -705,19 +762,28 @@ $sdk = novu\Novu::builder()
705762
)
706763
->build();
707764

708-
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
709-
name: '<value>',
765+
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
766+
workflowId: 'workflow_identifier',
710767
payload: [
711768
'comment_id' => 'string',
712769
'post' => [
713770
'text' => 'string',
714771
],
715772
],
716-
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
773+
overrides: [
774+
'fcm' => [
775+
'data' => [
776+
'key' => 'value',
777+
],
778+
],
779+
],
780+
to: new Components\SubscriberPayloadDto(
781+
subscriberId: '<id>',
782+
),
717783
);
718784

719-
$response = $sdk->triggerBroadcast(
720-
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
785+
$response = $sdk->trigger(
786+
triggerEventRequestDto: $triggerEventRequestDto,
721787
idempotencyKey: '<value>'
722788

723789
);

0 commit comments

Comments
 (0)