@novu/api 0.2.1 → 0.4.0

package/src/funcs/subscribersCredentialsAppend.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";
 
 /**
@@ -31,14 +32,14 @@ import { Result } from "../types/fp.js";
  * Subscriber credentials associated to the delivery methods such as slack and push tokens.
  *     This endpoint appends provided credentials and deviceTokens to the existing ones.
  */
-export async function subscribersCredentialsAppend(
+export function subscribersCredentialsAppend(
   client: NovuCore,
   updateSubscriberChannelRequestDto:
     components.UpdateSubscriberChannelRequestDto,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersV1ControllerModifySubscriberChannelResponse,
     | errors.ErrorDto
@@ -53,6 +54,41 @@ export async function subscribersCredentialsAppend(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    updateSubscriberChannelRequestDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  updateSubscriberChannelRequestDto:
+    components.UpdateSubscriberChannelRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersV1ControllerModifySubscriberChannelResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input:
     operations.SubscribersV1ControllerModifySubscriberChannelRequest = {
@@ -70,7 +106,7 @@ export async function subscribersCredentialsAppend(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.UpdateSubscriberChannelRequestDto, {
@@ -103,7 +139,7 @@ export async function subscribersCredentialsAppend(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersV1Controller_modifySubscriberChannel",
     oAuth2Scopes: [],
 
@@ -136,7 +172,7 @@ export async function subscribersCredentialsAppend(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -163,7 +199,7 @@ export async function subscribersCredentialsAppend(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -205,8 +241,8 @@ export async function subscribersCredentialsAppend(
     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/subscribersCredentialsDelete.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,13 +30,13 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Delete subscriber credentials such as slack and expo tokens.
  */
-export async function subscribersCredentialsDelete(
+export function subscribersCredentialsDelete(
   client: NovuCore,
   subscriberId: string,
   providerId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     | operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse
     | undefined,
@@ -51,6 +52,41 @@ export async function subscribersCredentialsDelete(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    subscriberId,
+    providerId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  subscriberId: string,
+  providerId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      | operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse
+      | undefined,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input:
     operations.SubscribersV1ControllerDeleteSubscriberCredentialsRequest = {
@@ -68,7 +104,7 @@ export async function subscribersCredentialsDelete(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -102,7 +138,7 @@ export async function subscribersCredentialsDelete(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersV1Controller_deleteSubscriberCredentials",
     oAuth2Scopes: [],
 
@@ -135,7 +171,7 @@ export async function subscribersCredentialsDelete(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -162,7 +198,7 @@ export async function subscribersCredentialsDelete(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -206,8 +242,8 @@ export async function subscribersCredentialsDelete(
     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/subscribersCredentialsUpdate.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
  * Subscriber credentials associated to the delivery methods such as slack and push tokens.
  */
-export async function subscribersCredentialsUpdate(
+export function subscribersCredentialsUpdate(
   client: NovuCore,
   updateSubscriberChannelRequestDto:
     components.UpdateSubscriberChannelRequestDto,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersV1ControllerUpdateSubscriberChannelResponse,
     | errors.ErrorDto
@@ -52,6 +53,41 @@ export async function subscribersCredentialsUpdate(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    updateSubscriberChannelRequestDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  updateSubscriberChannelRequestDto:
+    components.UpdateSubscriberChannelRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersV1ControllerUpdateSubscriberChannelResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input:
     operations.SubscribersV1ControllerUpdateSubscriberChannelRequest = {
@@ -69,7 +105,7 @@ export async function subscribersCredentialsUpdate(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.UpdateSubscriberChannelRequestDto, {
@@ -102,7 +138,7 @@ export async function subscribersCredentialsUpdate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersV1Controller_updateSubscriberChannel",
     oAuth2Scopes: [],
 
@@ -135,7 +171,7 @@ export async function subscribersCredentialsUpdate(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -162,7 +198,7 @@ export async function subscribersCredentialsUpdate(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -204,8 +240,8 @@ export async function subscribersCredentialsUpdate(
     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/subscribersDelete.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
  * Deletes a subscriber entity from the Novu platform
  */
-export async function subscribersDelete(
+export function subscribersDelete(
   client: NovuCore,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersControllerRemoveSubscriberResponse,
     | errors.ErrorDto
@@ -49,6 +50,38 @@ export async function subscribersDelete(
     | 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.SubscribersControllerRemoveSubscriberResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.SubscribersControllerRemoveSubscriberRequest = {
     subscriberId: subscriberId,
@@ -63,7 +96,7 @@ export async function subscribersDelete(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -91,7 +124,7 @@ export async function subscribersDelete(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersController_removeSubscriber",
     oAuth2Scopes: [],
 
@@ -124,7 +157,7 @@ export async function subscribersDelete(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -151,7 +184,7 @@ export async function subscribersDelete(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -192,8 +225,8 @@ export async function subscribersDelete(
     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/subscribersList.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";
 import {
   createPageIterator,
@@ -36,13 +37,13 @@ import {
  * @remarks
  * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
  */
-export async function subscribersList(
+export function subscribersList(
   client: NovuCore,
   page?: number | undefined,
   limit?: number | undefined,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   PageIterator<
     Result<
       operations.SubscribersV1ControllerListSubscribersResponse,
@@ -60,6 +61,43 @@ export async function subscribersList(
     >,
     { page: number }
   >
+> {
+  return new APIPromise($do(
+    client,
+    page,
+    limit,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  page?: number | undefined,
+  limit?: number | undefined,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.SubscribersV1ControllerListSubscribersResponse,
+        | errors.ErrorDto
+        | errors.ErrorDto
+        | errors.ValidationErrorDto
+        | errors.ErrorDto
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
 > {
   const input: operations.SubscribersV1ControllerListSubscribersRequest = {
     page: page,
@@ -75,7 +113,7 @@ export async function subscribersList(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return haltIterator(parsed);
+    return [haltIterator(parsed), { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -101,7 +139,7 @@ export async function subscribersList(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersV1Controller_listSubscribers",
     oAuth2Scopes: [],
 
@@ -135,7 +173,7 @@ export async function subscribersList(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return haltIterator(requestRes);
+    return [haltIterator(requestRes), { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -162,7 +200,7 @@ export async function subscribersList(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return haltIterator(doResult);
+    return [haltIterator(doResult), { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -203,7 +241,11 @@ export async function subscribersList(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return haltIterator(result);
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
   }
 
   const nextFunc = (
@@ -255,5 +297,9 @@ export async function subscribersList(
   };
 
   const page$ = { ...result, ...nextFunc(raw) };
-  return { ...page$, ...createPageIterator(page$, (v) => !v.ok) };
+  return [{ ...page$, ...createPageIterator(page$, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
 }

package/src/funcs/subscribersMessagesMarkAll.ts

@@ -22,18 +22,19 @@ 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";
 
 /**
  * Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
  */
-export async function subscribersMessagesMarkAll(
+export function subscribersMessagesMarkAll(
   client: NovuCore,
   markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto,
   subscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.SubscribersV1ControllerMarkAllUnreadAsReadResponse,
     | errors.ErrorDto
@@ -48,6 +49,40 @@ export async function subscribersMessagesMarkAll(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    markAllMessageAsRequestDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersV1ControllerMarkAllUnreadAsReadResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.SubscribersV1ControllerMarkAllUnreadAsReadRequest = {
     markAllMessageAsRequestDto: markAllMessageAsRequestDto,
@@ -65,7 +100,7 @@ export async function subscribersMessagesMarkAll(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.MarkAllMessageAsRequestDto, {
@@ -98,7 +133,7 @@ export async function subscribersMessagesMarkAll(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    baseURL: options?.serverURL ?? "",
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "SubscribersV1Controller_markAllUnreadAsRead",
     oAuth2Scopes: [],
 
@@ -131,7 +166,7 @@ export async function subscribersMessagesMarkAll(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -158,7 +193,7 @@ export async function subscribersMessagesMarkAll(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -200,8 +235,8 @@ export async function subscribersMessagesMarkAll(
     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 }];
 }