Skip to content

README.md

Latest commit

 

History

History
88 lines (59 loc) · 10.9 KB

README.md

File metadata and controls

88 lines (59 loc) · 10.9 KB

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

using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

var res = await sdk.Translations.Groups.DeleteAsync(
    resourceType: TranslationControllerDeleteTranslationGroupEndpointPathParamResourceType.Workflow,
    resourceId: "welcome-email"
);

// handle response

Parameters

Parameter Type Required Description Example
ResourceType TranslationControllerDeleteTranslationGroupEndpointPathParamResourceType ✔️ Resource type workflow
ResourceId string ✔️ Resource ID welcome-email
IdempotencyKey string ➖ A header for idempotency purposes

Response

TranslationControllerDeleteTranslationGroupEndpointResponse

Errors

Error Type Status Code Content Type
Novu.Models.Errors.APIException 4XX, 5XX */*

Retrieve

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

Example Usage

using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

var res = await sdk.Translations.Groups.RetrieveAsync(
    resourceType: TranslationControllerGetTranslationGroupEndpointPathParamResourceType.Workflow,
    resourceId: "welcome-email"
);

// handle response

Parameters

Parameter Type Required Description Example
ResourceType TranslationControllerGetTranslationGroupEndpointPathParamResourceType ✔️ Resource type workflow
ResourceId string ✔️ Resource ID welcome-email
IdempotencyKey string ➖ A header for idempotency purposes

Response

TranslationControllerGetTranslationGroupEndpointResponse

Errors

Error Type Status Code Content Type
Novu.Models.Errors.APIException 4XX, 5XX */*