README.md

Translations.Groups

Overview

Available Operations

• delete - Delete a translation group
• retrieve - Retrieve a translation group

delete

Delete an entire translation group and all its translations

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->translations->groups->delete(
    resourceType: Operations\TranslationControllerDeleteTranslationGroupEndpointPathParamResourceType::Workflow,
    resourceId: 'welcome-email'

);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
resourceType	Operations\TranslationControllerDeleteTranslationGroupEndpointPathParamResourceType	✔️	Resource type	workflow
resourceId	string	✔️	Resource ID	welcome-email
idempotencyKey	?string	➖	A header for idempotency purposes

Response

?Operations\TranslationControllerDeleteTranslationGroupEndpointResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

retrieve

Retrieves a single translation group by resource type (workflow, layout) and resource ID (workflowId, layoutId)

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->translations->groups->retrieve(
    resourceType: Operations\TranslationControllerGetTranslationGroupEndpointPathParamResourceType::Workflow,
    resourceId: 'welcome-email'

);

if ($response->translationGroupDto !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description	Example
resourceType	Operations\TranslationControllerGetTranslationGroupEndpointPathParamResourceType	✔️	Resource type	workflow
resourceId	string	✔️	Resource ID	welcome-email
idempotencyKey	?string	➖	A header for idempotency purposes

Response

?Operations\TranslationControllerGetTranslationGroupEndpointResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*