@@ -68,7 +68,6 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
68
68
* [ SDK Example Usage] ( #sdk-example-usage )
69
69
* [ Authentication] ( #authentication )
70
70
* [ Available Resources and Operations] ( #available-resources-and-operations )
71
- * [ Pagination] ( #pagination )
72
71
* [ Retries] ( #retries )
73
72
* [ Error Handling] ( #error-handling )
74
73
* [ Server Selection] ( #server-selection )
@@ -117,9 +116,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
117
116
],
118
117
],
119
118
overrides: new Components\Overrides(),
120
- to: new Components\SubscriberPayloadDto(
121
- subscriberId: '<id >',
122
- ),
119
+ to: 'SUBSCRIBER_ID',
123
120
);
124
121
125
122
$response = $sdk->trigger(
@@ -234,10 +231,7 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
234
231
],
235
232
],
236
233
overrides: new Components\Overrides(),
237
- to: new Components\TopicPayloadDto(
238
- topicKey: '<value >',
239
- type: Components\TriggerRecipientsTypeEnum::Topic,
240
- ),
234
+ to: 'SUBSCRIBER_ID',
241
235
),
242
236
],
243
237
);
@@ -289,9 +283,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
289
283
],
290
284
],
291
285
overrides: new Components\Overrides(),
292
- to: new Components\SubscriberPayloadDto(
293
- subscriberId: '<id >',
294
- ),
286
+ to: 'SUBSCRIBER_ID',
295
287
);
296
288
297
289
$response = $sdk->trigger(
@@ -314,35 +306,23 @@ if ($response->triggerEventResponseDto !== null) {
314
306
315
307
### [ integrations] ( docs/sdks/integrations/README.md )
316
308
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
327
315
328
316
### [ messages] ( docs/sdks/messages/README.md )
329
317
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
332
320
* [ deleteByTransactionId] ( docs/sdks/messages/README.md#deletebytransactionid ) - Delete messages by transactionId
333
321
334
322
### [ notifications] ( docs/sdks/notifications/README.md )
335
323
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
346
326
347
327
### [ Novu SDK] ( docs/sdks/novu/README.md )
348
328
@@ -353,68 +333,58 @@ if ($response->triggerEventResponseDto !== null) {
353
333
354
334
### [ subscribers] ( docs/sdks/subscribers/README.md )
355
335
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
360
340
* [ 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
363
341
* [ 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
366
344
* [ updateOnlineStatus] ( docs/sdks/subscribers/README.md#updateonlinestatus ) - Update subscriber online status
367
345
368
- #### [ subscribers->authentication] ( docs/sdks/authentication/README.md )
369
-
370
- * [ handleOauthCallback] ( docs/sdks/authentication/README.md#handleoauthcallback ) - Handle providers oauth redirect
371
-
372
346
#### [ subscribers->messages] ( docs/sdks/novumessages/README.md )
373
347
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
376
350
377
- #### [ subscribers->notifications] ( docs/sdks/novusubscribersnotifications /README.md )
351
+ #### [ subscribers->notifications] ( docs/sdks/novunotifications /README.md )
378
352
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
380
354
381
355
#### [ subscribers->topics] ( docs/sdks/novutopics/README.md )
382
356
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
388
358
389
359
### [ subscribersCredentials] ( docs/sdks/subscriberscredentials/README.md )
390
360
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
393
363
394
364
### [ subscribersMessages] ( docs/sdks/subscribersmessages/README.md )
395
365
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
397
367
398
368
### [ subscribersNotifications] ( docs/sdks/subscribersnotifications/README.md )
399
369
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
401
371
402
372
### [ subscribersPreferences] ( docs/sdks/subscriberspreferences/README.md )
403
373
404
- * [ list] ( docs/sdks/subscriberspreferences/README.md#list ) - Get subscriber preferences
374
+ * [ list] ( docs/sdks/subscriberspreferences/README.md#list ) - Retrieve subscriber preferences
405
375
406
376
### [ topics] ( docs/sdks/topics/README.md )
407
377
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
413
383
414
384
#### [ topics->subscriptions] ( docs/sdks/subscriptions/README.md )
415
385
416
386
* [ 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
418
388
* [ delete] ( docs/sdks/subscriptions/README.md#delete ) - Delete topic subscriptions
419
389
420
390
### [ topicsSubscribers] ( docs/sdks/topicssubscribers/README.md )
@@ -424,44 +394,6 @@ if ($response->triggerEventResponseDto !== null) {
424
394
</details >
425
395
<!-- End Available Resources and Operations [operations] -->
426
396
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
-
465
397
<!-- Start Retries [retries] -->
466
398
## Retries
467
399
@@ -492,9 +424,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
492
424
],
493
425
],
494
426
overrides: new Components\Overrides(),
495
- to: new Components\SubscriberPayloadDto(
496
- subscriberId: '<id >',
497
- ),
427
+ to: 'SUBSCRIBER_ID',
498
428
);
499
429
500
430
$response = $sdk->trigger(
@@ -550,9 +480,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
550
480
],
551
481
],
552
482
overrides: new Components\Overrides(),
553
- to: new Components\SubscriberPayloadDto(
554
- subscriberId: '<id >',
555
- ),
483
+ to: 'SUBSCRIBER_ID',
556
484
);
557
485
558
486
$response = $sdk->trigger(
@@ -618,9 +546,7 @@ try {
618
546
],
619
547
],
620
548
overrides: new Components\Overrides(),
621
- to: new Components\SubscriberPayloadDto(
622
- subscriberId: '<id >',
623
- ),
549
+ to: 'SUBSCRIBER_ID',
624
550
);
625
551
626
552
$response = $sdk->trigger(
@@ -689,9 +615,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
689
615
],
690
616
],
691
617
overrides: new Components\Overrides(),
692
- to: new Components\SubscriberPayloadDto(
693
- subscriberId: '<id >',
694
- ),
618
+ to: 'SUBSCRIBER_ID',
695
619
);
696
620
697
621
$response = $sdk->trigger(
@@ -732,9 +656,7 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
732
656
],
733
657
],
734
658
overrides: new Components\Overrides(),
735
- to: new Components\SubscriberPayloadDto(
736
- subscriberId: '<id >',
737
- ),
659
+ to: 'SUBSCRIBER_ID',
738
660
);
739
661
740
662
$response = $sdk->trigger(
0 commit comments