Skip to content

Commit 1b2b8ed

Browse files
github-actions[bot]speakeasybotspeakeasy-github[bot]
authored
chore: 🐝 Update SDK - Generate 1.1.0 (#12)
* ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.548.4 * empty commit to trigger [run-tests] workflow --------- Co-authored-by: speakeasybot <[email protected]> Co-authored-by: speakeasy-github[bot] <128539517+speakeasy-github[bot]@users.noreply.github.com>
1 parent 922edf9 commit 1b2b8ed

File tree

87 files changed

+515
-3930
lines changed

Some content is hidden

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

87 files changed

+515
-3930
lines changed

.speakeasy/gen.lock

Lines changed: 184 additions & 495 deletions
Large diffs are not rendered by default.

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ generation:
1616
oAuth2ClientCredentialsEnabled: true
1717
oAuth2PasswordEnabled: true
1818
php:
19-
version: 1.0.0
19+
version: 1.1.0
2020
additionalDependencies:
2121
autoload: {}
2222
autoload-dev: {}

.speakeasy/workflow.lock

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.544.0
1+
speakeasyVersion: 1.548.4
22
sources:
33
novu-OAS:
44
sourceNamespace: novu-oas
5-
sourceRevisionDigest: sha256:cedc9e210c5289c5870c8d5a98227c0eb2a2c655bb9f71d92f4c56110cb9e4e5
6-
sourceBlobDigest: sha256:0853120683cbad3e5324f2002c294ba9ff3e8e5d74f9750911f8007601da14b2
5+
sourceRevisionDigest: sha256:1415cd8417773fba0d8abd2182c6217c68da03543a41959f44dc62c5a9300f7b
6+
sourceBlobDigest: sha256:b09c07f4d596f62186737a367aa3a5ac68dbc1ab5718e2c51d794dd962eae3b4
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1746749680
10-
- 2.1.13
9+
- speakeasy-sdk-regen-1747181684
10+
- 2.2.0
1111
targets:
1212
novu:
1313
source: novu-OAS
1414
sourceNamespace: novu-oas
15-
sourceRevisionDigest: sha256:cedc9e210c5289c5870c8d5a98227c0eb2a2c655bb9f71d92f4c56110cb9e4e5
16-
sourceBlobDigest: sha256:0853120683cbad3e5324f2002c294ba9ff3e8e5d74f9750911f8007601da14b2
15+
sourceRevisionDigest: sha256:1415cd8417773fba0d8abd2182c6217c68da03543a41959f44dc62c5a9300f7b
16+
sourceBlobDigest: sha256:b09c07f4d596f62186737a367aa3a5ac68dbc1ab5718e2c51d794dd962eae3b4
1717
codeSamplesNamespace: novu-oas-php-code-samples
18-
codeSamplesRevisionDigest: sha256:b0f54d62a2995016757c83994ea9dd532497ba0eee1811f96a8979c8a4094e0f
18+
codeSamplesRevisionDigest: sha256:f5c43e3a77ccba9dcccd0683471bb27c1a9eb9a4575d9f09ea45935f50a3bd94
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

README.md

Lines changed: 40 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
6868
* [SDK Example Usage](#sdk-example-usage)
6969
* [Authentication](#authentication)
7070
* [Available Resources and Operations](#available-resources-and-operations)
71-
* [Pagination](#pagination)
7271
* [Retries](#retries)
7372
* [Error Handling](#error-handling)
7473
* [Server Selection](#server-selection)
@@ -117,9 +116,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
117116
],
118117
],
119118
overrides: new Components\Overrides(),
120-
to: new Components\SubscriberPayloadDto(
121-
subscriberId: '<id>',
122-
),
119+
to: 'SUBSCRIBER_ID',
123120
);
124121

125122
$response = $sdk->trigger(
@@ -234,10 +231,7 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
234231
],
235232
],
236233
overrides: new Components\Overrides(),
237-
to: new Components\TopicPayloadDto(
238-
topicKey: '<value>',
239-
type: Components\TriggerRecipientsTypeEnum::Topic,
240-
),
234+
to: 'SUBSCRIBER_ID',
241235
),
242236
],
243237
);
@@ -289,9 +283,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
289283
],
290284
],
291285
overrides: new Components\Overrides(),
292-
to: new Components\SubscriberPayloadDto(
293-
subscriberId: '<id>',
294-
),
286+
to: 'SUBSCRIBER_ID',
295287
);
296288

297289
$response = $sdk->trigger(
@@ -314,35 +306,23 @@ if ($response->triggerEventResponseDto !== null) {
314306

315307
### [integrations](docs/sdks/integrations/README.md)
316308

317-
* [list](docs/sdks/integrations/README.md#list) - Get integrations
318-
* [create](docs/sdks/integrations/README.md#create) - Create integration
319-
* [update](docs/sdks/integrations/README.md#update) - Update integration
320-
* [delete](docs/sdks/integrations/README.md#delete) - Delete integration
321-
* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
322-
* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations
323-
324-
#### [integrations->webhooks](docs/sdks/webhooks/README.md)
325-
326-
* [getSupportStatus](docs/sdks/webhooks/README.md#getsupportstatus) - Get webhook support status for provider
309+
* [list](docs/sdks/integrations/README.md#list) - List all integrations
310+
* [create](docs/sdks/integrations/README.md#create) - Create an integration
311+
* [update](docs/sdks/integrations/README.md#update) - Update an integration
312+
* [delete](docs/sdks/integrations/README.md#delete) - Delete an integration
313+
* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Update integration as primary
314+
* [listActive](docs/sdks/integrations/README.md#listactive) - List active integrations
327315

328316
### [messages](docs/sdks/messages/README.md)
329317

330-
* [get](docs/sdks/messages/README.md#get) - Get messages
331-
* [delete](docs/sdks/messages/README.md#delete) - Delete message
318+
* [get](docs/sdks/messages/README.md#get) - List all messages
319+
* [delete](docs/sdks/messages/README.md#delete) - Delete a message
332320
* [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
333321

334322
### [notifications](docs/sdks/notifications/README.md)
335323

336-
* [list](docs/sdks/notifications/README.md#list) - Get notifications
337-
* [get](docs/sdks/notifications/README.md#get) - Get notification
338-
339-
#### [notifications->stats](docs/sdks/stats/README.md)
340-
341-
* [get](docs/sdks/stats/README.md#get) - Get notification statistics
342-
343-
### [notificationsStats](docs/sdks/notificationsstats/README.md)
344-
345-
* [getGraph](docs/sdks/notificationsstats/README.md#getgraph) - Get notification graph statistics
324+
* [list](docs/sdks/notifications/README.md#list) - List all events
325+
* [get](docs/sdks/notifications/README.md#get) - Retrieve an event
346326

347327
### [Novu SDK](docs/sdks/novu/README.md)
348328

@@ -353,68 +333,58 @@ if ($response->triggerEventResponseDto !== null) {
353333

354334
### [subscribers](docs/sdks/subscribers/README.md)
355335

356-
* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
357-
* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
358-
* [get](docs/sdks/subscribers/README.md#get) - Get subscriber
359-
* [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
336+
* [search](docs/sdks/subscribers/README.md#search) - Search subscribers
337+
* [create](docs/sdks/subscribers/README.md#create) - Create a subscriber
338+
* [get](docs/sdks/subscribers/README.md#get) - Retrieve a subscriber
339+
* [patch](docs/sdks/subscribers/README.md#patch) - Update a subscriber
360340
* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
361-
* [list](docs/sdks/subscribers/README.md#list) - Get subscribers
362-
* [update](docs/sdks/subscribers/README.md#update) - Upsert subscriber
363341
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
364-
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber global or workflow specific preferences
365-
* [updateCredentials](docs/sdks/subscribers/README.md#updatecredentials) - Update subscriber credentials
342+
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber preferences
343+
* [updateCredentials](docs/sdks/subscribers/README.md#updatecredentials) - Update provider credentials
366344
* [updateOnlineStatus](docs/sdks/subscribers/README.md#updateonlinestatus) - Update subscriber online status
367345

368-
#### [subscribers->authentication](docs/sdks/authentication/README.md)
369-
370-
* [handleOauthCallback](docs/sdks/authentication/README.md#handleoauthcallback) - Handle providers oauth redirect
371-
372346
#### [subscribers->messages](docs/sdks/novumessages/README.md)
373347

374-
* [updateAsSeen](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
375-
* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Mark a subscriber messages as seen, read, unseen or unread
348+
* [updateAsSeen](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status
349+
* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Update notifications state
376350

377-
#### [subscribers->notifications](docs/sdks/novusubscribersnotifications/README.md)
351+
#### [subscribers->notifications](docs/sdks/novunotifications/README.md)
378352

379-
* [getFeed](docs/sdks/novusubscribersnotifications/README.md#getfeed) - Get in-app notification feed for a particular subscriber
353+
* [getFeed](docs/sdks/novunotifications/README.md#getfeed) - Retrieve subscriber notifications
380354

381355
#### [subscribers->topics](docs/sdks/novutopics/README.md)
382356

383-
* [list](docs/sdks/novutopics/README.md#list) - List topics a subscriber is subscribed to
384-
385-
### [subscribersAuthentication](docs/sdks/subscribersauthentication/README.md)
386-
387-
* [chatAccessOauth](docs/sdks/subscribersauthentication/README.md#chataccessoauth) - Handle chat oauth
357+
* [list](docs/sdks/novutopics/README.md#list) - Retrieve subscriber subscriptions
388358

389359
### [subscribersCredentials](docs/sdks/subscriberscredentials/README.md)
390360

391-
* [append](docs/sdks/subscriberscredentials/README.md#append) - Modify subscriber credentials
392-
* [deleteProvider](docs/sdks/subscriberscredentials/README.md#deleteprovider) - Delete subscriber credentials by providerId
361+
* [append](docs/sdks/subscriberscredentials/README.md#append) - Upsert provider credentials
362+
* [deleteProvider](docs/sdks/subscriberscredentials/README.md#deleteprovider) - Delete provider credentials
393363

394364
### [subscribersMessages](docs/sdks/subscribersmessages/README.md)
395365

396-
* [markAll](docs/sdks/subscribersmessages/README.md#markall) - Marks all the subscriber messages as read, unread, seen or unseen.
366+
* [markAll](docs/sdks/subscribersmessages/README.md#markall) - Update all notifications state
397367

398368
### [subscribersNotifications](docs/sdks/subscribersnotifications/README.md)
399369

400-
* [getUnseenCount](docs/sdks/subscribersnotifications/README.md#getunseencount) - Get the unseen in-app notifications count for subscribers feed
370+
* [getUnseenCount](docs/sdks/subscribersnotifications/README.md#getunseencount) - Retrieve unseen notifications count
401371

402372
### [subscribersPreferences](docs/sdks/subscriberspreferences/README.md)
403373

404-
* [list](docs/sdks/subscriberspreferences/README.md#list) - Get subscriber preferences
374+
* [list](docs/sdks/subscriberspreferences/README.md#list) - Retrieve subscriber preferences
405375

406376
### [topics](docs/sdks/topics/README.md)
407377

408-
* [list](docs/sdks/topics/README.md#list) - Get topics list
409-
* [create](docs/sdks/topics/README.md#create) - Create or update a topic
410-
* [get](docs/sdks/topics/README.md#get) - Get topic by key
411-
* [update](docs/sdks/topics/README.md#update) - Update topic by key
412-
* [delete](docs/sdks/topics/README.md#delete) - Delete topic by key
378+
* [list](docs/sdks/topics/README.md#list) - List all topics
379+
* [create](docs/sdks/topics/README.md#create) - Create a topic
380+
* [get](docs/sdks/topics/README.md#get) - Retrieve a topic
381+
* [update](docs/sdks/topics/README.md#update) - Update a topic
382+
* [delete](docs/sdks/topics/README.md#delete) - Delete a topic
413383

414384
#### [topics->subscriptions](docs/sdks/subscriptions/README.md)
415385

416386
* [list](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
417-
* [create](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions, if the topic does not exist, it will be created.
387+
* [create](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
418388
* [delete](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
419389

420390
### [topicsSubscribers](docs/sdks/topicssubscribers/README.md)
@@ -424,44 +394,6 @@ if ($response->triggerEventResponseDto !== null) {
424394
</details>
425395
<!-- End Available Resources and Operations [operations] -->
426396

427-
<!-- Start Pagination [pagination] -->
428-
## Pagination
429-
430-
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
431-
returned object will be a `Generator` instead of an individual response.
432-
433-
Working with generators is as simple as iterating over the responses in a `foreach` loop, and you can see an example below:
434-
```php
435-
declare(strict_types=1);
436-
437-
require 'vendor/autoload.php';
438-
439-
use novu;
440-
441-
$sdk = novu\Novu::builder()
442-
->setSecurity(
443-
'YOUR_SECRET_KEY_HERE'
444-
)
445-
->build();
446-
447-
448-
449-
$responses = $sdk->subscribers->list(
450-
page: 7685.78,
451-
limit: 10,
452-
idempotencyKey: '<value>'
453-
454-
);
455-
456-
457-
foreach ($responses as $response) {
458-
if ($response->statusCode === 200) {
459-
// handle response
460-
}
461-
}
462-
```
463-
<!-- End Pagination [pagination] -->
464-
465397
<!-- Start Retries [retries] -->
466398
## Retries
467399

@@ -492,9 +424,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
492424
],
493425
],
494426
overrides: new Components\Overrides(),
495-
to: new Components\SubscriberPayloadDto(
496-
subscriberId: '<id>',
497-
),
427+
to: 'SUBSCRIBER_ID',
498428
);
499429

500430
$response = $sdk->trigger(
@@ -550,9 +480,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
550480
],
551481
],
552482
overrides: new Components\Overrides(),
553-
to: new Components\SubscriberPayloadDto(
554-
subscriberId: '<id>',
555-
),
483+
to: 'SUBSCRIBER_ID',
556484
);
557485

558486
$response = $sdk->trigger(
@@ -618,9 +546,7 @@ try {
618546
],
619547
],
620548
overrides: new Components\Overrides(),
621-
to: new Components\SubscriberPayloadDto(
622-
subscriberId: '<id>',
623-
),
549+
to: 'SUBSCRIBER_ID',
624550
);
625551

626552
$response = $sdk->trigger(
@@ -689,9 +615,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
689615
],
690616
],
691617
overrides: new Components\Overrides(),
692-
to: new Components\SubscriberPayloadDto(
693-
subscriberId: '<id>',
694-
),
618+
to: 'SUBSCRIBER_ID',
695619
);
696620

697621
$response = $sdk->trigger(
@@ -732,9 +656,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
732656
],
733657
],
734658
overrides: new Components\Overrides(),
735-
to: new Components\SubscriberPayloadDto(
736-
subscriberId: '<id>',
737-
),
659+
to: 'SUBSCRIBER_ID',
738660
);
739661

740662
$response = $sdk->trigger(

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,14 @@ Based on:
4848
### Generated
4949
- [php v1.0.0] .
5050
### Releases
51-
- [Composer v1.0.0] https://packagist.org/packages/novuhq/novu#v1.0.0 - .
51+
- [Composer v1.0.0] https://packagist.org/packages/novuhq/novu#v1.0.0 - .
52+
53+
## 2025-05-22 00:14:36
54+
### Changes
55+
Based on:
56+
- OpenAPI Doc
57+
- Speakeasy CLI 1.548.4 (2.605.6) https://github.com/speakeasy-api/speakeasy
58+
### Generated
59+
- [php v1.1.0] .
60+
### Releases
61+
- [Composer v1.1.0] https://packagist.org/packages/novuhq/novu#v1.1.0 - .

USAGE.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
2424
],
2525
],
2626
overrides: new Components\Overrides(),
27-
to: new Components\SubscriberPayloadDto(
28-
subscriberId: '<id>',
29-
),
27+
to: 'SUBSCRIBER_ID',
3028
);
3129

3230
$response = $sdk->trigger(
@@ -141,10 +139,7 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
141139
],
142140
],
143141
overrides: new Components\Overrides(),
144-
to: new Components\TopicPayloadDto(
145-
topicKey: '<value>',
146-
type: Components\TriggerRecipientsTypeEnum::Topic,
147-
),
142+
to: 'SUBSCRIBER_ID',
148143
),
149144
],
150145
);

docs/Models/Components/ActivityGraphStatesResponse.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/Models/Components/ActivityStatsResponseDto.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/Models/Components/Channels.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)