@novu/api 3.11.0 → 3.11.2

package/src/funcs/topicsSubscriptionsGetSubscription.ts

@@ -0,0 +1,243 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { NovuError } from "../models/errors/novuerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get a topic subscription
+ *
+ * @remarks
+ * Get a subscription by its unique identifier **subscriptionIdOrIdentifier** for a topic.
+ */
+export function topicsSubscriptionsGetSubscription(
+  client: NovuCore,
+  topicKey: string,
+  subscriptionIdOrIdentifier: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.TopicsControllerGetTopicSubscriptionResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    topicKey,
+    subscriptionIdOrIdentifier,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  topicKey: string,
+  subscriptionIdOrIdentifier: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerGetTopicSubscriptionResponse,
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.TopicsControllerGetTopicSubscriptionRequest = {
+    topicKey: topicKey,
+    subscriptionIdOrIdentifier: subscriptionIdOrIdentifier,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.TopicsControllerGetTopicSubscriptionRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    subscriptionIdOrIdentifier: encodeSimple(
+      "subscriptionIdOrIdentifier",
+      payload.subscriptionIdOrIdentifier,
+      { explode: false, charEncoding: "percent" },
+    ),
+    topicKey: encodeSimple("topicKey", payload.topicKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/v2/topics/{topicKey}/subscriptions/{subscriptionIdOrIdentifier}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "TopicsController_getTopicSubscription",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "413",
+      "414",
+      "415",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "503",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.TopicsControllerGetTopicSubscriptionResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.TopicsControllerGetTopicSubscriptionResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 405, 409, 413, 415],
+      errors.ErrorDto$inboundSchema,
+      { hdrs: true },
+    ),
+    M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(429),
+    M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(503),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/topicsSubscriptionsUpdate.ts

@@ -0,0 +1,234 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { NovuError } from "../models/errors/novuerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update a topic subscription
+ *
+ * @remarks
+ * Update a subscription by its unique identifier **subscriptionIdOrIdentifier** for a topic. You can update the preferences and name associated with the subscription.
+ */
+export function topicsSubscriptionsUpdate(
+  client: NovuCore,
+  request: operations.TopicsControllerUpdateTopicSubscriptionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.TopicsControllerUpdateTopicSubscriptionResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  request: operations.TopicsControllerUpdateTopicSubscriptionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerUpdateTopicSubscriptionResponse,
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.TopicsControllerUpdateTopicSubscriptionRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.UpdateTopicSubscriptionRequestDto, {
+    explode: true,
+  });
+
+  const pathParams = {
+    subscriptionIdOrIdentifier: encodeSimple(
+      "subscriptionIdOrIdentifier",
+      payload.subscriptionIdOrIdentifier,
+      { explode: false, charEncoding: "percent" },
+    ),
+    topicKey: encodeSimple("topicKey", payload.topicKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/v2/topics/{topicKey}/subscriptions/{subscriptionIdOrIdentifier}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "TopicsController_updateTopicSubscription",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PATCH",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "413",
+      "414",
+      "415",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "503",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.TopicsControllerUpdateTopicSubscriptionResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.TopicsControllerUpdateTopicSubscriptionResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 405, 409, 413, 415],
+      errors.ErrorDto$inboundSchema,
+      { hdrs: true },
+    ),
+    M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(429),
+    M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(503),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/translationsGroupsDelete.ts

@@ -33,7 +33,8 @@ import { Result } from "../types/fp.js";
  */
 export function translationsGroupsDelete(
   client: NovuCore,
-  resourceType: operations.ResourceType,
+  resourceType:
+    operations.TranslationControllerDeleteTranslationGroupEndpointPathParamResourceType,
   resourceId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
@@ -61,7 +62,8 @@ export function translationsGroupsDelete(
 
 async function $do(
   client: NovuCore,
-  resourceType: operations.ResourceType,
+  resourceType:
+    operations.TranslationControllerDeleteTranslationGroupEndpointPathParamResourceType,
   resourceId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,

package/src/funcs/translationsMasterUpload.ts

@@ -3,7 +3,11 @@
  */
 
 import { NovuCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { appendForm, encodeSimple } from "../lib/encodings.js";
+import {
+  getContentTypeFromFileName,
+  readableStreamToArrayBuffer,
+} from "../lib/files.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -23,7 +27,9 @@ import { ResponseValidationError } from "../models/errors/responsevalidationerro
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
+import { isBlobLike } from "../types/blobs.js";
 import { Result } from "../types/fp.js";
+import { isReadableStream } from "../types/streams.js";
 
 /**
  * Upload master translations JSON file
@@ -33,6 +39,8 @@ import { Result } from "../types/fp.js";
  */
 export function translationsMasterUpload(
   client: NovuCore,
+  requestBody:
+    operations.TranslationControllerUploadMasterJsonEndpointRequestBody,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
@@ -50,6 +58,7 @@ export function translationsMasterUpload(
 > {
   return new APIPromise($do(
     client,
+    requestBody,
     idempotencyKey,
     options,
   ));
@@ -57,6 +66,8 @@ export function translationsMasterUpload(
 
 async function $do(
   client: NovuCore,
+  requestBody:
+    operations.TranslationControllerUploadMasterJsonEndpointRequestBody,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
@@ -77,6 +88,7 @@ async function $do(
 > {
   const input: operations.TranslationControllerUploadMasterJsonEndpointRequest =
     {
+      requestBody: requestBody,
       idempotencyKey: idempotencyKey,
     };
 
@@ -92,7 +104,30 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = null;
+  const body = new FormData();
+
+  if (isBlobLike(payload.RequestBody.file)) {
+    appendForm(body, "file", payload.RequestBody.file);
+  } else if (isReadableStream(payload.RequestBody.file.content)) {
+    const buffer = await readableStreamToArrayBuffer(
+      payload.RequestBody.file.content,
+    );
+    const contentType =
+      getContentTypeFromFileName(payload.RequestBody.file.fileName)
+      || "application/octet-stream";
+    const blob = new Blob([buffer], { type: contentType });
+    appendForm(body, "file", blob, payload.RequestBody.file.fileName);
+  } else {
+    const contentType =
+      getContentTypeFromFileName(payload.RequestBody.file.fileName)
+      || "application/octet-stream";
+    appendForm(
+      body,
+      "file",
+      new Blob([payload.RequestBody.file.content], { type: contentType }),
+      payload.RequestBody.file.fileName,
+    );
+  }
 
   const path = pathToFunc("/v2/translations/master-json/upload")();
 

package/src/funcs/translationsUpload.ts

@@ -4,6 +4,10 @@
 
 import { NovuCore } from "../core.js";
 import { appendForm, encodeSimple } from "../lib/encodings.js";
+import {
+  getContentTypeFromFileName,
+  readableStreamToArrayBuffer,
+} from "../lib/files.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -23,17 +27,20 @@ import { ResponseValidationError } from "../models/errors/responsevalidationerro
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
+import { isBlobLike } from "../types/blobs.js";
 import { Result } from "../types/fp.js";
+import { isReadableStream } from "../types/streams.js";
 
 /**
  * Upload translation files
  *
  * @remarks
- * Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json
+ * Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json. Supports both "files" and "files[]" field names for backwards compatibility.
  */
 export function translationsUpload(
   client: NovuCore,
-  uploadTranslationsRequestDto: components.UploadTranslationsRequestDto,
+  requestBody:
+    operations.TranslationControllerUploadTranslationFilesRequestBody,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
@@ -51,7 +58,7 @@ export function translationsUpload(
 > {
   return new APIPromise($do(
     client,
-    uploadTranslationsRequestDto,
+    requestBody,
     idempotencyKey,
     options,
   ));
@@ -59,7 +66,8 @@ export function translationsUpload(
 
 async function $do(
   client: NovuCore,
-  uploadTranslationsRequestDto: components.UploadTranslationsRequestDto,
+  requestBody:
+    operations.TranslationControllerUploadTranslationFilesRequestBody,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
@@ -79,7 +87,7 @@ async function $do(
   ]
 > {
   const input: operations.TranslationControllerUploadTranslationFilesRequest = {
-    uploadTranslationsRequestDto: uploadTranslationsRequestDto,
+    requestBody: requestBody,
     idempotencyKey: idempotencyKey,
   };
 
@@ -97,16 +105,28 @@ async function $do(
   const payload = parsed.value;
   const body = new FormData();
 
-  appendForm(
-    body,
-    "resourceId",
-    payload.UploadTranslationsRequestDto.resourceId,
-  );
-  appendForm(
-    body,
-    "resourceType",
-    payload.UploadTranslationsRequestDto.resourceType,
-  );
+  for (const fileItem of payload.RequestBody.files) {
+    if (isBlobLike(fileItem)) {
+      appendForm(body, "files[]", fileItem);
+    } else if (isReadableStream(fileItem.content)) {
+      const buffer = await readableStreamToArrayBuffer(fileItem.content);
+      const contentType = getContentTypeFromFileName(fileItem.fileName)
+        || "application/octet-stream";
+      const blob = new Blob([buffer], { type: contentType });
+      appendForm(body, "files[]", blob, fileItem.fileName);
+    } else {
+      const contentType = getContentTypeFromFileName(fileItem.fileName)
+        || "application/octet-stream";
+      appendForm(
+        body,
+        "files[]",
+        new Blob([fileItem.content], { type: contentType }),
+        fileItem.fileName,
+      );
+    }
+  }
+  appendForm(body, "resourceId", payload.RequestBody.resourceId);
+  appendForm(body, "resourceType", payload.RequestBody.resourceType);
 
   const path = pathToFunc("/v2/translations/upload")();
 

package/src/lib/config.ts

@@ -59,7 +59,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "3.11.0",
-  sdkVersion: "3.11.0",
-  genVersion: "2.755.9",
-  userAgent: "speakeasy-sdk/typescript 3.11.0 2.755.9 3.11.0 @novu/api",
+  sdkVersion: "3.11.2",
+  genVersion: "2.788.7",
+  userAgent: "speakeasy-sdk/typescript 3.11.2 2.788.7 3.11.0 @novu/api",
 } as const;