Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: 🐝 Update SDK - Generate 0.1.1 #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: 🐝 Update SDK - Generate 0.1.1 #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c12701e
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1
speakeasybot Apr 5, 2025
60c79ec
empty commit to trigger [run-tests] workflow
speakeasy-github[bot] Apr 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
981 changes: 298 additions & 683 deletions .speakeasy/gen.lock
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
php:
version: 0.1.0
version: 0.1.1
additionalDependencies:
autoload: {}
autoload-dev: {}
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.521.0
speakeasyVersion: 1.529.1
sources:
novu-OAS:
sourceNamespace: novu-oas
sourceRevisionDigest: sha256:db132a7c0fa4fa7afc85a30c791f67ecb7c9db21611342c55d4b76fefb1b3e8d
sourceBlobDigest: sha256:1ad751b8cc9aa8375333d9cf6bdf630c8ffa7a26b388d27aa13f75b942971b16
sourceRevisionDigest: sha256:21682f8b3f4becf7c5835d0c5969f1a880a8182a4bd2aea164c1ca80451d25e1
sourceBlobDigest: sha256:76193270338fba688a2280909f7fb317729778c98850cb045de3325b5c96469e
tags:
- latest
- speakeasy-sdk-regen-1738887190
- speakeasy-sdk-regen-1742516022
- "1.0"
targets:
novu:
source: novu-OAS
sourceNamespace: novu-oas
sourceRevisionDigest: sha256:db132a7c0fa4fa7afc85a30c791f67ecb7c9db21611342c55d4b76fefb1b3e8d
sourceBlobDigest: sha256:1ad751b8cc9aa8375333d9cf6bdf630c8ffa7a26b388d27aa13f75b942971b16
sourceRevisionDigest: sha256:21682f8b3f4becf7c5835d0c5969f1a880a8182a4bd2aea164c1ca80451d25e1
sourceBlobDigest: sha256:76193270338fba688a2280909f7fb317729778c98850cb045de3325b5c96469e
codeSamplesNamespace: novu-oas-php-code-samples
codeSamplesRevisionDigest: sha256:bd86287151037d649bb2e639b261b377edb4092d12b12422a2b184c616cbee56
codeSamplesRevisionDigest: sha256:ac3ce4b4574e61652e5eb004b5b98342e77a87fb14fbb58c819e818b922b5406
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
156 changes: 106 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [Novu PHP SDK](#novu-php-sdk)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
Expand Down Expand Up @@ -109,9 +110,6 @@ $sdk = novu\Novu::builder()

$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
payload: [
'comment_id' => 'string',
'post' => [
Expand All @@ -125,6 +123,9 @@ $triggerEventRequestDto = new Components\TriggerEventRequestDto(
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->trigger(
Expand Down Expand Up @@ -224,10 +225,6 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
events: [
new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
to: new Components\TopicPayloadDto(
topicKey: '<value>',
type: Components\TriggerRecipientsTypeEnum::Topic,
),
payload: [
'comment_id' => 'string',
'post' => [
Expand All @@ -241,6 +238,10 @@ $bulkTriggerEventDto = new Components\BulkTriggerEventDto(
],
],
],
to: new Components\TopicPayloadDto(
topicKey: '<value>',
type: Components\TriggerRecipientsTypeEnum::Topic,
),
),
],
);
Expand Down Expand Up @@ -283,19 +284,28 @@ $sdk = novu\Novu::builder()
)
->build();

$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
name: '<value>',
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
payload: [
'comment_id' => 'string',
'post' => [
'text' => 'string',
],
],
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
overrides: [
'fcm' => [
'data' => [
'key' => 'value',
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->triggerBroadcast(
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
$response = $sdk->trigger(
triggerEventRequestDto: $triggerEventRequestDto,
idempotencyKey: '<value>'

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

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

* [create](docs/sdks/integrations/README.md#create) - Create integration
* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations
* [list](docs/sdks/integrations/README.md#list) - Get integrations
* [create](docs/sdks/integrations/README.md#create) - Create integration
* [update](docs/sdks/integrations/README.md#update) - Update integration
* [delete](docs/sdks/integrations/README.md#delete) - Delete integration
* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
* [update](docs/sdks/integrations/README.md#update) - Update integration
* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations

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

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

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

* [get](docs/sdks/messages/README.md#get) - Get messages
* [delete](docs/sdks/messages/README.md#delete) - Delete message
* [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
* [get](docs/sdks/messages/README.md#get) - Get messages

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

* [get](docs/sdks/notifications/README.md#get) - Get notification
* [list](docs/sdks/notifications/README.md#list) - Get notifications
* [get](docs/sdks/notifications/README.md#get) - Get notification

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

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

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

* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
* [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event

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

* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
* [get](docs/sdks/subscribers/README.md#get) - Get subscriber
* [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber global or workflow specific preferences
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
* [list](docs/sdks/subscribers/README.md#list) - Get subscribers
* [update](docs/sdks/subscribers/README.md#update) - Upsert subscriber
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
* [updatePreferences](docs/sdks/subscribers/README.md#updatepreferences) - Update subscriber global or workflow specific preferences
* [updateCredentials](docs/sdks/subscribers/README.md#updatecredentials) - Update subscriber credentials
* [updateOnlineStatus](docs/sdks/subscribers/README.md#updateonlinestatus) - Update subscriber online status

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

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

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

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

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

* [create](docs/sdks/topics/README.md#create) - Topic creation
* [list](docs/sdks/topics/README.md#list) - Get topic list filtered
* [delete](docs/sdks/topics/README.md#delete) - Delete topic
* [get](docs/sdks/topics/README.md#get) - Get topic
* [list](docs/sdks/topics/README.md#list) - Get topic list filtered
* [rename](docs/sdks/topics/README.md#rename) - Rename a topic

#### [topics->subscribers](docs/sdks/novutopicssubscribers/README.md)
Expand Down Expand Up @@ -477,19 +488,28 @@ $sdk = novu\Novu::builder()
)
->build();

$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
name: '<value>',
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
payload: [
'comment_id' => 'string',
'post' => [
'text' => 'string',
],
],
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
overrides: [
'fcm' => [
'data' => [
'key' => 'value',
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->triggerBroadcast(
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
$response = $sdk->trigger(
triggerEventRequestDto: $triggerEventRequestDto,
idempotencyKey: '<value>',
options: Utils\Options->builder()->setRetryConfig(
new Retry\RetryConfigBackoff(
Expand Down Expand Up @@ -532,19 +552,28 @@ $sdk = novu\Novu::builder()
)
->build();

$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
name: '<value>',
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
payload: [
'comment_id' => 'string',
'post' => [
'text' => 'string',
],
],
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
overrides: [
'fcm' => [
'data' => [
'key' => 'value',
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->triggerBroadcast(
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
$response = $sdk->trigger(
triggerEventRequestDto: $triggerEventRequestDto,
idempotencyKey: '<value>'

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

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:
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:

| Error Type | Status Code | Content Type |
| ------------------------- | -------------------------------------- | ---------------- |
Expand Down Expand Up @@ -597,19 +626,28 @@ $sdk = novu\Novu::builder()
->build();

try {
$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
name: '<value>',
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
payload: [
'comment_id' => 'string',
'post' => [
'text' => 'string',
],
],
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
overrides: [
'fcm' => [
'data' => [
'key' => 'value',
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->triggerBroadcast(
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
$response = $sdk->trigger(
triggerEventRequestDto: $triggerEventRequestDto,
idempotencyKey: '<value>'

);
Expand Down Expand Up @@ -665,19 +703,28 @@ $sdk = novu\Novu::builder()
)
->build();

$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
name: '<value>',
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
payload: [
'comment_id' => 'string',
'post' => [
'text' => 'string',
],
],
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
overrides: [
'fcm' => [
'data' => [
'key' => 'value',
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->triggerBroadcast(
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
$response = $sdk->trigger(
triggerEventRequestDto: $triggerEventRequestDto,
idempotencyKey: '<value>'

);
Expand Down Expand Up @@ -705,19 +752,28 @@ $sdk = novu\Novu::builder()
)
->build();

$triggerEventToAllRequestDto = new Components\TriggerEventToAllRequestDto(
name: '<value>',
$triggerEventRequestDto = new Components\TriggerEventRequestDto(
workflowId: 'workflow_identifier',
payload: [
'comment_id' => 'string',
'post' => [
'text' => 'string',
],
],
overrides: new Components\TriggerEventToAllRequestDtoOverrides(),
overrides: [
'fcm' => [
'data' => [
'key' => 'value',
],
],
],
to: new Components\SubscriberPayloadDto(
subscriberId: '<id>',
),
);

$response = $sdk->triggerBroadcast(
triggerEventToAllRequestDto: $triggerEventToAllRequestDto,
$response = $sdk->trigger(
triggerEventRequestDto: $triggerEventRequestDto,
idempotencyKey: '<value>'

);
Expand Down
Loading