@novu/api 0.2.1 → 0.4.0

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,7 +136,7 @@ export async function subscribersPreferencesUpdate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersController_updateSubscriberPreferences",
     oAuth2Scopes: [],
 
@@ -134,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;
 
@@ -161,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;
 
@@ -203,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,7 +141,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersV1Controller_updateSubscriberOnlineFlag",
     oAuth2Scopes: [],
 
@@ -138,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;
 
@@ -165,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;
 
@@ -207,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,7 +125,7 @@ export async function subscribersRetrieve(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersController_getSubscriber",
     oAuth2Scopes: [],
 
@@ -125,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;
 
@@ -152,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;
 
@@ -193,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 }];
 }

package/src/funcs/subscribersSearch.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";
 
 /**
  * Search for subscribers
  */
-export async function subscribersSearch(
+export function subscribersSearch(
   client: NovuCore,
   request: operations.SubscribersControllerSearchSubscribersRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersControllerSearchSubscribersResponse,
     | errors.ErrorDto
@@ -45,6 +46,36 @@ export async function subscribersSearch(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  request: operations.SubscribersControllerSearchSubscribersRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersControllerSearchSubscribersResponse,
+      | 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 subscribersSearch(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -87,7 +118,7 @@ export async function subscribersSearch(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersController_searchSubscribers",
     oAuth2Scopes: [],
 
@@ -121,7 +152,7 @@ export async function subscribersSearch(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -148,7 +179,7 @@ export async function subscribersSearch(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -189,8 +220,8 @@ export async function subscribersSearch(
     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/topicsCreate.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,12 +31,12 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Create a topic
  */
-export async function topicsCreate(
+export function topicsCreate(
   client: NovuCore,
   createTopicRequestDto: components.CreateTopicRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.TopicsControllerCreateTopicResponse,
     | errors.ErrorDto
@@ -50,6 +51,38 @@ export async function topicsCreate(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    createTopicRequestDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  createTopicRequestDto: components.CreateTopicRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerCreateTopicResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.TopicsControllerCreateTopicRequest = {
     createTopicRequestDto: createTopicRequestDto,
@@ -63,7 +96,7 @@ export async function topicsCreate(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.CreateTopicRequestDto, {
@@ -87,7 +120,7 @@ export async function topicsCreate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "TopicsController_createTopic",
     oAuth2Scopes: [],
 
@@ -120,7 +153,7 @@ export async function topicsCreate(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -147,7 +180,7 @@ export async function topicsCreate(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -187,8 +220,8 @@ export async function topicsCreate(
     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/topicsDelete.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
  * Delete a topic by its topic key if it has no subscribers
  */
-export async function topicsDelete(
+export function topicsDelete(
   client: NovuCore,
   topicKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.TopicsControllerDeleteTopicResponse | undefined,
     | errors.ErrorDto
@@ -49,6 +50,38 @@ export async function topicsDelete(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    topicKey,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerDeleteTopicResponse | undefined,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.TopicsControllerDeleteTopicRequest = {
     topicKey: topicKey,
@@ -62,7 +95,7 @@ export async function topicsDelete(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -90,7 +123,7 @@ export async function topicsDelete(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "TopicsController_deleteTopic",
     oAuth2Scopes: [],
 
@@ -123,7 +156,7 @@ export async function topicsDelete(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -150,7 +183,7 @@ export async function topicsDelete(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -191,8 +224,8 @@ export async function topicsDelete(
     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 }];
 }