@novu/api 0.2.0 → 0.3.0

package/src/funcs/subscribersNotificationsUnseenCount.ts

@@ -21,16 +21,17 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
  * Get the unseen in-app notifications count for subscribers feed
  */
-export async function subscribersNotificationsUnseenCount(
+export function subscribersNotificationsUnseenCount(
   client: NovuCore,
   request: operations.SubscribersV1ControllerGetUnseenCountRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersV1ControllerGetUnseenCountResponse,
     | errors.ErrorDto
@@ -45,6 +46,36 @@ export async function subscribersNotificationsUnseenCount(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersV1ControllerGetUnseenCountResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -54,7 +85,7 @@ export async function subscribersNotificationsUnseenCount(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -89,6 +120,7 @@ export async function subscribersNotificationsUnseenCount(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "SubscribersV1Controller_getUnseenCount",
     oAuth2Scopes: [],
 
@@ -122,7 +154,7 @@ export async function subscribersNotificationsUnseenCount(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -149,7 +181,7 @@ export async function subscribersNotificationsUnseenCount(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -190,8 +222,8 @@ export async function subscribersNotificationsUnseenCount(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/subscribersPatch.ts

@@ -22,6 +22,7 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -30,13 +31,13 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Patch subscriber by your internal id used to identify the subscriber
  */
-export async function subscribersPatch(
+export function subscribersPatch(
   client: NovuCore,
   patchSubscriberRequestDto: components.PatchSubscriberRequestDto,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersControllerPatchSubscriberResponse,
     | errors.ErrorDto
@@ -51,6 +52,40 @@ export async function subscribersPatch(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    patchSubscriberRequestDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  patchSubscriberRequestDto: components.PatchSubscriberRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersControllerPatchSubscriberResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.SubscribersControllerPatchSubscriberRequest = {
     patchSubscriberRequestDto: patchSubscriberRequestDto,
@@ -66,7 +101,7 @@ export async function subscribersPatch(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.PatchSubscriberRequestDto, {
@@ -97,6 +132,7 @@ export async function subscribersPatch(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "SubscribersController_patchSubscriber",
     oAuth2Scopes: [],
 
@@ -129,7 +165,7 @@ export async function subscribersPatch(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -156,7 +192,7 @@ export async function subscribersPatch(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -197,8 +233,8 @@ export async function subscribersPatch(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/subscribersPreferencesList.ts

@@ -21,6 +21,7 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -29,12 +30,12 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Get subscriber global and workflow specific preferences
  */
-export async function subscribersPreferencesList(
+export function subscribersPreferencesList(
   client: NovuCore,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersControllerGetSubscriberPreferencesResponse,
     | errors.ErrorDto
@@ -49,6 +50,38 @@ export async function subscribersPreferencesList(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersControllerGetSubscriberPreferencesResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.SubscribersControllerGetSubscriberPreferencesRequest =
     {
@@ -65,7 +98,7 @@ export async function subscribersPreferencesList(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -95,6 +128,7 @@ export async function subscribersPreferencesList(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "SubscribersController_getSubscriberPreferences",
     oAuth2Scopes: [],
 
@@ -127,7 +161,7 @@ export async function subscribersPreferencesList(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -154,7 +188,7 @@ export async function subscribersPreferencesList(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -196,8 +230,8 @@ export async function subscribersPreferencesList(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/subscribersPreferencesUpdate.ts

@@ -22,6 +22,7 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -30,13 +31,13 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Update subscriber global or workflow specific preferences
  */
-export async function subscribersPreferencesUpdate(
+export function subscribersPreferencesUpdate(
   client: NovuCore,
   patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersControllerUpdateSubscriberPreferencesResponse,
     | errors.ErrorDto
@@ -51,6 +52,40 @@ export async function subscribersPreferencesUpdate(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    patchSubscriberPreferencesDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersControllerUpdateSubscriberPreferencesResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input:
     operations.SubscribersControllerUpdateSubscriberPreferencesRequest = {
@@ -68,7 +103,7 @@ export async function subscribersPreferencesUpdate(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.PatchSubscriberPreferencesDto, {
@@ -101,6 +136,7 @@ export async function subscribersPreferencesUpdate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "SubscribersController_updateSubscriberPreferences",
     oAuth2Scopes: [],
 
@@ -133,7 +169,7 @@ export async function subscribersPreferencesUpdate(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -160,7 +196,7 @@ export async function subscribersPreferencesUpdate(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -202,8 +238,8 @@ export async function subscribersPreferencesUpdate(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts

@@ -22,6 +22,7 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -30,14 +31,14 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Used to update the subscriber isOnline flag.
  */
-export async function subscribersPropertiesUpdateOnlineFlag(
+export function subscribersPropertiesUpdateOnlineFlag(
   client: NovuCore,
   updateSubscriberOnlineFlagRequestDto:
     components.UpdateSubscriberOnlineFlagRequestDto,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersV1ControllerUpdateSubscriberOnlineFlagResponse,
     | errors.ErrorDto
@@ -52,6 +53,41 @@ export async function subscribersPropertiesUpdateOnlineFlag(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    updateSubscriberOnlineFlagRequestDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  updateSubscriberOnlineFlagRequestDto:
+    components.UpdateSubscriberOnlineFlagRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersV1ControllerUpdateSubscriberOnlineFlagResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input:
     operations.SubscribersV1ControllerUpdateSubscriberOnlineFlagRequest = {
@@ -70,7 +106,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON(
@@ -105,6 +141,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "SubscribersV1Controller_updateSubscriberOnlineFlag",
     oAuth2Scopes: [],
 
@@ -137,7 +174,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -164,7 +201,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -206,8 +243,8 @@ export async function subscribersPropertiesUpdateOnlineFlag(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/subscribersRetrieve.ts

@@ -21,6 +21,7 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
@@ -29,12 +30,12 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Get subscriber by your internal id used to identify the subscriber
  */
-export async function subscribersRetrieve(
+export function subscribersRetrieve(
   client: NovuCore,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersControllerGetSubscriberResponse,
     | errors.ErrorDto
@@ -49,6 +50,38 @@ export async function subscribersRetrieve(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersControllerGetSubscriberResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.SubscribersControllerGetSubscriberRequest = {
     subscriberId: subscriberId,
@@ -64,7 +97,7 @@ export async function subscribersRetrieve(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -92,6 +125,7 @@ export async function subscribersRetrieve(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "SubscribersController_getSubscriber",
     oAuth2Scopes: [],
 
@@ -124,7 +158,7 @@ export async function subscribersRetrieve(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -151,7 +185,7 @@ export async function subscribersRetrieve(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -192,8 +226,8 @@ export async function subscribersRetrieve(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }