Merge pull request #5 from novuhq/speakeasy-sdk-regen-1738714375

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 4286f3ad-fa54-4c63-a599-e5773b27ae7b
 management:
-  docChecksum: d1632819398aa0f78d5e472d361f69ef
+  docChecksum: a4242f993b10b703f4f3e5eb570c8398
   docVersion: "1.0"
-  speakeasyVersion: 1.483.0
-  generationVersion: 2.502.0
-  releaseVersion: 0.0.9
-  configChecksum: 22b02057f95fab96c064d85d41d48c9f
+  speakeasyVersion: 1.484.1
+  generationVersion: 2.503.2
+  releaseVersion: 0.0.10
+  configChecksum: 39ceac7298bfcb02e6a11cabe8c5a95f
   repoURL: https://github.com/novuhq/php-novu.git
   installationURL: https://github.com/novuhq/php-novu
   published: true
@@ -18,7 +18,7 @@ features:
     examples: 2.81.5
     flattening: 2.81.1
     globalSecurity: 2.81.7
-    globalSecurityFlattening: 0.1.1
+    globalSecurityFlattening: 0.1.2
     globalServerURLs: 2.82.1
     groups: 2.81.2
     methodArguments: 0.1.0

.speakeasy/gen.yaml

@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
 php:
-  version: 0.0.9
+  version: 0.0.10
   additionalDependencies:
     autoload: {}
     autoload-dev: {}

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.483.0
+speakeasyVersion: 1.484.1
 sources:
     novu-OAS:
         sourceNamespace: novu-oas
-        sourceRevisionDigest: sha256:9ba8150c482bf407b7ee8c72d6aa6e18eb7f0102099784081fd1b60738a60aaa
-        sourceBlobDigest: sha256:94dc96203886bdb1449550da72edec8a90de8bb2bb1f382ce2e43078cb14c371
+        sourceRevisionDigest: sha256:2b78c81442796b4ed8956f50645319b3ff08d23207e6f0eb7c61f7259eaf4b7f
+        sourceBlobDigest: sha256:f6d6bbf4d990b215b5676ab879d3a2dd445686ee2f65f2cffeffd119f4cdde74
         tags:
             - latest
-            - speakeasy-sdk-regen-1738671594
+            - speakeasy-sdk-regen-1738714375
             - "1.0"
 targets:
     novu:
         source: novu-OAS
         sourceNamespace: novu-oas
-        sourceRevisionDigest: sha256:9ba8150c482bf407b7ee8c72d6aa6e18eb7f0102099784081fd1b60738a60aaa
-        sourceBlobDigest: sha256:94dc96203886bdb1449550da72edec8a90de8bb2bb1f382ce2e43078cb14c371
+        sourceRevisionDigest: sha256:2b78c81442796b4ed8956f50645319b3ff08d23207e6f0eb7c61f7259eaf4b7f
+        sourceBlobDigest: sha256:f6d6bbf4d990b215b5676ab879d3a2dd445686ee2f65f2cffeffd119f4cdde74
         codeSamplesNamespace: novu-oas-php-code-samples
-        codeSamplesRevisionDigest: sha256:38cb09195dbcd72473e7020e985989793d0d55ad35e2ec49cd017ce52cb54a5f
+        codeSamplesRevisionDigest: sha256:dfd706acb58b30636dbf75bf0cd650ca326759d2cd5cac4fbfb2e09772034a13
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -39,5 +39,5 @@ workflow:
                 registry:
                     location: registry.speakeasyapi.dev/novu/novu/novu-oas-php-code-samples
                 labelOverride:
-                    fixedValue: Php (SDK)
+                    fixedValue: PHP
                 blocking: false

README.md

@@ -345,7 +345,7 @@ if ($response->triggerEventResponseDto !== null) {
 
 #### [subscribers->preferences](docs/sdks/preferences/README.md)
 
-* [getByLevel](docs/sdks/preferences/README.md#getbylevel) - Get subscriber preferences by level
+* [~~getByLevel~~](docs/sdks/preferences/README.md#getbylevel) - Get subscriber preferences by level :warning: **Deprecated**
 * [update](docs/sdks/preferences/README.md#update) - Update subscriber preference
 
 ### [subscribersAuthentication](docs/sdks/subscribersauthentication/README.md)
@@ -368,7 +368,7 @@ if ($response->triggerEventResponseDto !== null) {
 ### [subscribersPreferences](docs/sdks/subscriberspreferences/README.md)
 
 * [retrieve](docs/sdks/subscriberspreferences/README.md#retrieve) - Get subscriber preferences
-* [list](docs/sdks/subscriberspreferences/README.md#list) - Get subscriber preferences
+* [~~listLegacy~~](docs/sdks/subscriberspreferences/README.md#listlegacy) - Get subscriber preferences :warning: **Deprecated**
 * [updateGlobal](docs/sdks/subscriberspreferences/README.md#updateglobal) - Update subscriber global preferences
 
 ### [topics](docs/sdks/topics/README.md)

RELEASES.md

@@ -8,4 +8,14 @@ Based on:
 ### Generated
 - [php v0.0.9] .
 ### Releases
-- [Composer v0.0.9] https://packagist.org/packages/novuhq/novu#v0.0.9 - .
+- [Composer v0.0.9] https://packagist.org/packages/novuhq/novu#v0.0.9 - .
+
+## 2025-02-06 00:12:36
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [php v0.0.10] .
+### Releases
+- [Composer v0.0.10] https://packagist.org/packages/novuhq/novu#v0.0.10 - .

docs/sdks/preferences/README.md

@@ -5,13 +5,15 @@
 
 ### Available Operations
 
-* [getByLevel](#getbylevel) - Get subscriber preferences by level
+* [~~getByLevel~~](#getbylevel) - Get subscriber preferences by level :warning: **Deprecated**
 * [update](#update) - Update subscriber preference
 
-## getByLevel
+## ~~getByLevel~~
 
 Get subscriber preferences by level
 
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```php

docs/sdks/subscriberspreferences/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [retrieve](#retrieve) - Get subscriber preferences
-* [list](#list) - Get subscriber preferences
+* [~~listLegacy~~](#listlegacy) - Get subscriber preferences :warning: **Deprecated**
 * [updateGlobal](#updateglobal) - Update subscriber global preferences
 
 ## retrieve
@@ -62,10 +62,12 @@ if ($response->getSubscriberPreferencesDto !== null) {
 | Errors\ErrorDto                        | 500                                    | application/json                       |
 | Errors\APIException                    | 4XX, 5XX                               | \*/\*                                  |
 
-## list
+## ~~listLegacy~~
 
 Get subscriber preferences
 
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```php
@@ -83,7 +85,7 @@ $sdk = novu\Novu::builder()
 
 
 
-$response = $sdk->subscribersPreferences->list(
+$response = $sdk->subscribersPreferences->listLegacy(
     subscriberId: '<id>',
     includeInactiveChannels: false,
     idempotencyKey: '<value>'

src/Models/Components/ActivitiesResponseDto.php

@@ -49,6 +49,7 @@ class ActivitiesResponseDto
      * @param  array<ActivityNotificationResponseDto>  $data
      * @param  float  $pageSize
      * @param  float  $page
+     * @phpstan-pure
      */
     public function __construct(bool $hasMore, array $data, float $pageSize, float $page)
     {

src/Models/Components/ActivityGraphStatesResponse.php

@@ -48,6 +48,7 @@ class ActivityGraphStatesResponse
      * @param  float  $count
      * @param  array<string>  $templates
      * @param  array<Channels>  $channels
+     * @phpstan-pure
      */
     public function __construct(string $id, float $count, array $templates, array $channels)
     {

src/Models/Components/ActivityNotificationExecutionDetailResponseDto.php

@@ -98,6 +98,7 @@ class ActivityNotificationExecutionDetailResponseDto
      * @param  ExecutionDetailsSourceEnum  $source
      * @param  ?string  $createdAt
      * @param  ?string  $raw
+     * @phpstan-pure
      */
     public function __construct(string $id, ExecutionDetailsStatusEnum $status, string $detail, bool $isRetry, bool $isTest, ProvidersIdEnum $providerId, ExecutionDetailsSourceEnum $source, ?string $createdAt = null, ?string $raw = null)
     {

src/Models/Components/ActivityNotificationJobResponseDto.php

@@ -102,6 +102,7 @@ class ActivityNotificationJobResponseDto
      * @param  ?DigestMetadataDto  $digest
      * @param  ?Payload  $payload
      * @param  ?string  $updatedAt
+     * @phpstan-pure
      */
     public function __construct(string $id, ActivityNotificationJobResponseDtoType $type, array $executionDetails, ActivityNotificationStepResponseDto $step, ProvidersIdEnum $providerId, string $status, ?DigestMetadataDto $digest = null, ?Payload $payload = null, ?string $updatedAt = null)
     {

src/Models/Components/ActivityNotificationResponseDto.php

@@ -186,6 +186,7 @@ class ActivityNotificationResponseDto
      * @param  ?array<string>  $tags
      * @param  ?Controls  $controls
      * @param  ?ActivityNotificationResponseDtoTo  $to
+     * @phpstan-pure
      */
     public function __construct(string $environmentId, string $organizationId, string $subscriberId, string $transactionId, ?string $id = null, ?string $templateId = null, ?string $digestedNotificationId = null, ?string $createdAt = null, ?string $updatedAt = null, ?array $channels = null, ?ActivityNotificationSubscriberResponseDto $subscriber = null, ?ActivityNotificationTemplateResponseDto $template = null, ?array $jobs = null, ?ActivityNotificationResponseDtoPayload $payload = null, ?array $tags = null, ?Controls $controls = null, ?ActivityNotificationResponseDtoTo $to = null)
     {

src/Models/Components/ActivityNotificationStepResponseDto.php

@@ -135,6 +135,7 @@ class ActivityNotificationStepResponseDto
      * @param  ?array<ActivityNotificationStepResponseDto>  $variants
      * @param  ?string  $name
      * @param  ?string  $parentId
+     * @phpstan-pure
      */
     public function __construct(string $id, bool $active, array $filters, string $templateId, ?ActivityNotificationStepResponseDtoReplyCallback $replyCallback = null, ?ControlVariables $controlVariables = null, ?Metadata $metadata = null, ?Issues $issues = null, ?MessageTemplateDto $template = null, ?array $variants = null, ?string $name = null, ?string $parentId = null)
     {

src/Models/Components/ActivityNotificationSubscriberResponseDto.php

@@ -70,6 +70,7 @@ class ActivityNotificationSubscriberResponseDto
      * @param  ?string  $lastName
      * @param  ?string  $email
      * @param  ?string  $phone
+     * @phpstan-pure
      */
     public function __construct(string $subscriberId, string $id, ?string $firstName = null, ?string $lastName = null, ?string $email = null, ?string $phone = null)
     {

src/Models/Components/ActivityNotificationTemplateResponseDto.php

@@ -41,6 +41,7 @@ class ActivityNotificationTemplateResponseDto
      * @param  string  $name
      * @param  array<NotificationTriggerDto>  $triggers
      * @param  ?string  $id
+     * @phpstan-pure
      */
     public function __construct(string $name, array $triggers, ?string $id = null)
     {

src/Models/Components/ActivityStatsResponseDto.php

@@ -28,6 +28,7 @@ class ActivityStatsResponseDto
     /**
      * @param  float  $weeklySent
      * @param  float  $monthlySent
+     * @phpstan-pure
      */
     public function __construct(float $weeklySent, float $monthlySent)
     {

src/Models/Components/ActorFeedItemDto.php

@@ -31,6 +31,7 @@ class ActorFeedItemDto
     /**
      * @param  ActorTypeEnum  $type
      * @param  ?string  $data
+     * @phpstan-pure
      */
     public function __construct(ActorTypeEnum $type, ?string $data = null)
     {

src/Models/Components/AddSubscribersRequestDto.php

@@ -22,6 +22,7 @@ class AddSubscribersRequestDto
 
     /**
      * @param  array<string>  $subscribers
+     * @phpstan-pure
      */
     public function __construct(array $subscribers)
     {

src/Models/Components/AssignSubscriberToTopicDto.php

@@ -33,6 +33,7 @@ class AssignSubscriberToTopicDto
     /**
      * @param  array<string>  $succeeded
      * @param  ?FailedAssignmentsDto  $failed
+     * @phpstan-pure
      */
     public function __construct(array $succeeded, ?FailedAssignmentsDto $failed = null)
     {

src/Models/Components/BulkCreateSubscriberResponseDto.php

@@ -42,6 +42,7 @@ class BulkCreateSubscriberResponseDto
      * @param  array<UpdatedSubscriberDto>  $updated
      * @param  array<CreatedSubscriberDto>  $created
      * @param  array<FailedOperationDto>  $failed
+     * @phpstan-pure
      */
     public function __construct(array $updated, array $created, array $failed)
     {

src/Models/Components/BulkSubscriberCreateDto.php

@@ -22,6 +22,7 @@ class BulkSubscriberCreateDto
 
     /**
      * @param  array<CreateSubscriberRequestDto>  $subscribers
+     * @phpstan-pure
      */
     public function __construct(array $subscribers)
     {

src/Models/Components/BulkTriggerEventDto.php

@@ -22,6 +22,7 @@ class BulkTriggerEventDto
 
     /**
      * @param  array<TriggerEventRequestDto>  $events
+     * @phpstan-pure
      */
     public function __construct(array $events)
     {

src/Models/Components/ChannelCredentials.php

@@ -93,6 +93,7 @@ class ChannelCredentials
      * @param  ?string  $imageUrl
      * @param  ?string  $state
      * @param  ?string  $externalUrl
+     * @phpstan-pure
      */
     public function __construct(?string $webhookUrl = null, ?string $channel = null, ?array $deviceTokens = null, ?string $alertUid = null, ?string $title = null, ?string $imageUrl = null, ?string $state = null, ?string $externalUrl = null)
     {

src/Models/Components/ChannelCredentialsDto.php

@@ -33,6 +33,7 @@ class ChannelCredentialsDto
     /**
      * @param  ?string  $webhookUrl
      * @param  ?array<string>  $deviceTokens
+     * @phpstan-pure
      */
     public function __construct(?string $webhookUrl = null, ?array $deviceTokens = null)
     {

src/Models/Components/ChannelPreference.php

@@ -31,6 +31,7 @@ class ChannelPreference
     /**
      * @param  ChannelTypeEnum  $type
      * @param  bool  $enabled
+     * @phpstan-pure
      */
     public function __construct(ChannelTypeEnum $type, bool $enabled)
     {

src/Models/Components/ChannelSettingsDto.php

@@ -51,6 +51,7 @@ class ChannelSettingsDto
      * @param  ChannelCredentials  $credentials
      * @param  string  $integrationId
      * @param  ?string  $integrationIdentifier
+     * @phpstan-pure
      */
     public function __construct(ChannelSettingsDtoProviderId $providerId, ChannelCredentials $credentials, string $integrationId, ?string $integrationIdentifier = null)
     {

src/Models/Components/CreateIntegrationRequestDto.php

@@ -103,6 +103,7 @@ class CreateIntegrationRequestDto
      * @param  ?bool  $active
      * @param  ?bool  $check
      * @param  ?array<StepFilterDto>  $conditions
+     * @phpstan-pure
      */
     public function __construct(string $providerId, CreateIntegrationRequestDtoChannel $channel, ?string $name = null, ?string $identifier = null, ?string $environmentId = null, ?CredentialsDto $credentials = null, ?bool $active = null, ?bool $check = null, ?array $conditions = null)
     {

src/Models/Components/CreateSubscriberRequestDto.php

@@ -103,6 +103,7 @@ class CreateSubscriberRequestDto
      * @param  ?string  $locale
      * @param  ?array<string, string|array<string>|bool|float>  $data
      * @param  ?array<SubscriberChannelDto>  $channels
+     * @phpstan-pure
      */
     public function __construct(string $subscriberId, ?string $email = null, ?string $firstName = null, ?string $lastName = null, ?string $phone = null, ?string $avatar = null, ?string $locale = null, ?array $data = null, ?array $channels = null)
     {

src/Models/Components/CreateTopicRequestDto.php

@@ -30,6 +30,7 @@ class CreateTopicRequestDto
     /**
      * @param  string  $key
      * @param  string  $name
+     * @phpstan-pure
      */
     public function __construct(string $key, string $name)
     {

src/Models/Components/CreateTopicResponseDto.php

@@ -31,6 +31,7 @@ class CreateTopicResponseDto
     /**
      * @param  string  $key
      * @param  ?string  $id
+     * @phpstan-pure
      */
     public function __construct(string $key, ?string $id = null)
     {

src/Models/Components/CreatedSubscriberDto.php

@@ -21,6 +21,7 @@ class CreatedSubscriberDto
 
     /**
      * @param  string  $subscriberId
+     * @phpstan-pure
      */
     public function __construct(string $subscriberId)
     {

src/Models/Components/CredentialsDto.php

@@ -391,6 +391,7 @@ class CredentialsDto
      * @param  ?string  $channelId
      * @param  ?string  $phoneNumberIdentification
      * @param  ?string  $accessKey
+     * @phpstan-pure
      */
     public function __construct(?string $apiKey = null, ?string $user = null, ?string $secretKey = null, ?string $domain = null, ?string $password = null, ?string $host = null, ?string $port = null, ?bool $secure = null, ?string $region = null, ?string $accountSid = null, ?string $messageProfileId = null, ?string $token = null, ?string $from = null, ?string $senderName = null, ?string $projectName = null, ?string $applicationId = null, ?string $clientId = null, ?bool $requireTls = null, ?bool $ignoreTls = null, ?TlsOptions $tlsOptions = null, ?string $baseUrl = null, ?string $webhookUrl = null, ?string $redirectUrl = null, ?bool $hmac = null, ?string $serviceAccount = null, ?string $ipPoolName = null, ?string $apiKeyRequestHeader = null, ?string $secretKeyRequestHeader = null, ?string $idPath = null, ?string $datePath = null, ?string $apiToken = null, ?bool $authenticateByToken = null, ?string $authenticationTokenKey = null, ?string $instanceId = null, ?string $alertUid = null, ?string $title = null, ?string $imageUrl = null, ?string $state = null, ?string $externalLink = null, ?string $channelId = null, ?string $phoneNumberIdentification = null, ?string $accessKey = null)
     {

src/Models/Components/DataBooleanDto.php

@@ -20,6 +20,7 @@ class DataBooleanDto
 
     /**
      * @param  bool  $data
+     * @phpstan-pure
      */
     public function __construct(bool $data)
     {

src/Models/Components/DelayRegularMetadata.php

@@ -40,6 +40,7 @@ class DelayRegularMetadata
      * @param  DelayRegularMetadataType  $type
      * @param  ?float  $amount
      * @param  ?DelayRegularMetadataUnit  $unit
+     * @phpstan-pure
      */
     public function __construct(DelayRegularMetadataType $type, ?float $amount = null, ?DelayRegularMetadataUnit $unit = null)
     {

src/Models/Components/DelayScheduledMetadata.php

@@ -29,6 +29,7 @@ class DelayScheduledMetadata
     /**
      * @param  DelayScheduledMetadataType  $type
      * @param  string  $delayPath
+     * @phpstan-pure
      */
     public function __construct(DelayScheduledMetadataType $type, string $delayPath)
     {

src/Models/Components/DeleteMessageResponseDto.php

@@ -31,6 +31,7 @@ class DeleteMessageResponseDto
     /**
      * @param  bool  $acknowledged
      * @param  DeleteMessageResponseDtoStatus  $status
+     * @phpstan-pure
      */
     public function __construct(bool $acknowledged, DeleteMessageResponseDtoStatus $status)
     {

src/Models/Components/DeleteSubscriberResponseDto.php

@@ -31,6 +31,7 @@ class DeleteSubscriberResponseDto
     /**
      * @param  bool  $acknowledged
      * @param  DeleteSubscriberResponseDtoStatus  $status
+     * @phpstan-pure
      */
     public function __construct(bool $acknowledged, DeleteSubscriberResponseDtoStatus $status)
     {