@novu/api 0.1.1 → 0.1.5

package/src/funcs/subscribersCreate.ts

@@ -37,7 +37,7 @@ export async function subscribersCreate(
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersControllerCreateSubscriberResponse,
+    operations.SubscribersV1ControllerCreateSubscriberResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -51,7 +51,7 @@ export async function subscribersCreate(
     | ConnectionError
   >
 > {
-  const input: operations.SubscribersControllerCreateSubscriberRequest = {
+  const input: operations.SubscribersV1ControllerCreateSubscriberRequest = {
     createSubscriberRequestDto: createSubscriberRequestDto,
     idempotencyKey: idempotencyKey,
   };
@@ -59,7 +59,7 @@ export async function subscribersCreate(
   const parsed = safeParse(
     input,
     (value) =>
-      operations.SubscribersControllerCreateSubscriberRequest$outboundSchema
+      operations.SubscribersV1ControllerCreateSubscriberRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -83,17 +83,17 @@ export async function subscribersCreate(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.apiKey);
-  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersController_createSubscriber",
+    operationID: "SubscribersV1Controller_createSubscriber",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.apiKey,
+    securitySource: client._options.secretKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -156,7 +156,7 @@ export async function subscribersCreate(
   };
 
   const [result] = await M.match<
-    operations.SubscribersControllerCreateSubscriberResponse,
+    operations.SubscribersV1ControllerCreateSubscriberResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -171,15 +171,15 @@ export async function subscribersCreate(
   >(
     M.json(
       201,
-      operations.SubscribersControllerCreateSubscriberResponse$inboundSchema,
+      operations.SubscribersV1ControllerCreateSubscriberResponse$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(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
     M.fail(429),
     M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),

package/src/funcs/subscribersCreateBulk.ts

@@ -39,7 +39,7 @@ export async function subscribersCreateBulk(
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersControllerBulkCreateSubscribersResponse,
+    operations.SubscribersV1ControllerBulkCreateSubscribersResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -53,18 +53,18 @@ export async function subscribersCreateBulk(
     | ConnectionError
   >
 > {
-  const input: operations.SubscribersControllerBulkCreateSubscribersRequest = {
-    bulkSubscriberCreateDto: bulkSubscriberCreateDto,
-    idempotencyKey: idempotencyKey,
-  };
+  const input: operations.SubscribersV1ControllerBulkCreateSubscribersRequest =
+    {
+      bulkSubscriberCreateDto: bulkSubscriberCreateDto,
+      idempotencyKey: idempotencyKey,
+    };
 
   const parsed = safeParse(
     input,
     (value) =>
       operations
-        .SubscribersControllerBulkCreateSubscribersRequest$outboundSchema.parse(
-          value,
-        ),
+        .SubscribersV1ControllerBulkCreateSubscribersRequest$outboundSchema
+        .parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -87,17 +87,17 @@ export async function subscribersCreateBulk(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.apiKey);
-  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersController_bulkCreateSubscribers",
+    operationID: "SubscribersV1Controller_bulkCreateSubscribers",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.apiKey,
+    securitySource: client._options.secretKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -160,7 +160,7 @@ export async function subscribersCreateBulk(
   };
 
   const [result] = await M.match<
-    operations.SubscribersControllerBulkCreateSubscribersResponse,
+    operations.SubscribersV1ControllerBulkCreateSubscribersResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -176,15 +176,15 @@ export async function subscribersCreateBulk(
     M.json(
       201,
       operations
-        .SubscribersControllerBulkCreateSubscribersResponse$inboundSchema,
+        .SubscribersV1ControllerBulkCreateSubscribersResponse$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(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
     M.fail(429),
     M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),

package/src/funcs/subscribersCredentialsAppend.ts

@@ -40,7 +40,7 @@ export async function subscribersCredentialsAppend(
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersControllerModifySubscriberChannelResponse,
+    operations.SubscribersV1ControllerModifySubscriberChannelResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -54,8 +54,8 @@ export async function subscribersCredentialsAppend(
     | ConnectionError
   >
 > {
-  const input: operations.SubscribersControllerModifySubscriberChannelRequest =
-    {
+  const input:
+    operations.SubscribersV1ControllerModifySubscriberChannelRequest = {
       updateSubscriberChannelRequestDto: updateSubscriberChannelRequestDto,
       subscriberId: subscriberId,
       idempotencyKey: idempotencyKey,
@@ -65,7 +65,7 @@ export async function subscribersCredentialsAppend(
     input,
     (value) =>
       operations
-        .SubscribersControllerModifySubscriberChannelRequest$outboundSchema
+        .SubscribersV1ControllerModifySubscriberChannelRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -98,17 +98,17 @@ export async function subscribersCredentialsAppend(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.apiKey);
-  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersController_modifySubscriberChannel",
+    operationID: "SubscribersV1Controller_modifySubscriberChannel",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.apiKey,
+    securitySource: client._options.secretKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -171,7 +171,7 @@ export async function subscribersCredentialsAppend(
   };
 
   const [result] = await M.match<
-    operations.SubscribersControllerModifySubscriberChannelResponse,
+    operations.SubscribersV1ControllerModifySubscriberChannelResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -187,15 +187,15 @@ export async function subscribersCredentialsAppend(
     M.json(
       200,
       operations
-        .SubscribersControllerModifySubscriberChannelResponse$inboundSchema,
+        .SubscribersV1ControllerModifySubscriberChannelResponse$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(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
     M.fail(429),
     M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),

package/src/funcs/subscribersCredentialsDelete.ts

@@ -37,7 +37,7 @@ export async function subscribersCredentialsDelete(
   options?: RequestOptions,
 ): Promise<
   Result<
-    | operations.SubscribersControllerDeleteSubscriberCredentialsResponse
+    | operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse
     | undefined,
     | errors.ErrorDto
     | errors.ErrorDto
@@ -53,7 +53,7 @@ export async function subscribersCredentialsDelete(
   >
 > {
   const input:
-    operations.SubscribersControllerDeleteSubscriberCredentialsRequest = {
+    operations.SubscribersV1ControllerDeleteSubscriberCredentialsRequest = {
       subscriberId: subscriberId,
       providerId: providerId,
       idempotencyKey: idempotencyKey,
@@ -63,7 +63,7 @@ export async function subscribersCredentialsDelete(
     input,
     (value) =>
       operations
-        .SubscribersControllerDeleteSubscriberCredentialsRequest$outboundSchema
+        .SubscribersV1ControllerDeleteSubscriberCredentialsRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -97,17 +97,17 @@ export async function subscribersCredentialsDelete(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.apiKey);
-  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersController_deleteSubscriberCredentials",
+    operationID: "SubscribersV1Controller_deleteSubscriberCredentials",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.apiKey,
+    securitySource: client._options.secretKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -170,7 +170,7 @@ export async function subscribersCredentialsDelete(
   };
 
   const [result] = await M.match<
-    | operations.SubscribersControllerDeleteSubscriberCredentialsResponse
+    | operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse
     | undefined,
     | errors.ErrorDto
     | errors.ErrorDto
@@ -187,16 +187,16 @@ export async function subscribersCredentialsDelete(
     M.nil(
       204,
       operations
-        .SubscribersControllerDeleteSubscriberCredentialsResponse$inboundSchema
+        .SubscribersV1ControllerDeleteSubscriberCredentialsResponse$inboundSchema
         .optional(),
       { hdrs: true },
     ),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
       [400, 401, 403, 404, 405, 409, 413, 415],
       errors.ErrorDto$inboundSchema,
       { hdrs: true },
     ),
-    M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
     M.fail(429),
     M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),

package/src/funcs/subscribersCredentialsUpdate.ts

@@ -39,7 +39,7 @@ export async function subscribersCredentialsUpdate(
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersControllerUpdateSubscriberChannelResponse,
+    operations.SubscribersV1ControllerUpdateSubscriberChannelResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -53,8 +53,8 @@ export async function subscribersCredentialsUpdate(
     | ConnectionError
   >
 > {
-  const input: operations.SubscribersControllerUpdateSubscriberChannelRequest =
-    {
+  const input:
+    operations.SubscribersV1ControllerUpdateSubscriberChannelRequest = {
       updateSubscriberChannelRequestDto: updateSubscriberChannelRequestDto,
       subscriberId: subscriberId,
       idempotencyKey: idempotencyKey,
@@ -64,7 +64,7 @@ export async function subscribersCredentialsUpdate(
     input,
     (value) =>
       operations
-        .SubscribersControllerUpdateSubscriberChannelRequest$outboundSchema
+        .SubscribersV1ControllerUpdateSubscriberChannelRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -97,17 +97,17 @@ export async function subscribersCredentialsUpdate(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.apiKey);
-  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersController_updateSubscriberChannel",
+    operationID: "SubscribersV1Controller_updateSubscriberChannel",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.apiKey,
+    securitySource: client._options.secretKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -170,7 +170,7 @@ export async function subscribersCredentialsUpdate(
   };
 
   const [result] = await M.match<
-    operations.SubscribersControllerUpdateSubscriberChannelResponse,
+    operations.SubscribersV1ControllerUpdateSubscriberChannelResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -186,15 +186,15 @@ export async function subscribersCredentialsUpdate(
     M.json(
       200,
       operations
-        .SubscribersControllerUpdateSubscriberChannelResponse$inboundSchema,
+        .SubscribersV1ControllerUpdateSubscriberChannelResponse$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(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
     M.fail(429),
     M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),

package/src/funcs/subscribersDelete.ts

@@ -75,7 +75,7 @@ export async function subscribersDelete(
     }),
   };
 
-  const path = pathToFunc("/v1/subscribers/{subscriberId}")(pathParams);
+  const path = pathToFunc("/v2/subscribers/{subscriberId}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -86,8 +86,8 @@ export async function subscribersDelete(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.apiKey);
-  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -96,7 +96,7 @@ export async function subscribersDelete(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.apiKey,
+    securitySource: client._options.secretKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -177,12 +177,12 @@ export async function subscribersDelete(
       operations.SubscribersControllerRemoveSubscriberResponse$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(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
     M.fail(429),
     M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),

package/src/funcs/subscribersDeleteLegacy.ts

@@ -0,0 +1,200 @@
+/*
+ * 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 { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Delete subscriber
+ *
+ * @remarks
+ * Deletes a subscriber entity from the Novu platform
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export async function subscribersDeleteLegacy(
+  client: NovuCore,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.SubscribersV1ControllerRemoveSubscriberResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const input: operations.SubscribersV1ControllerRemoveSubscriberRequest = {
+    subscriberId: subscriberId,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.SubscribersV1ControllerRemoveSubscriberRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/subscribers/{subscriberId}")(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 = {
+    operationID: "SubscribersV1Controller_removeSubscriber",
+    oAuth2Scopes: [],
+
+    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: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  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;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.SubscribersV1ControllerRemoveSubscriberResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations.SubscribersV1ControllerRemoveSubscriberResponse$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, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}