@novu/api 0.2.0 → 0.3.0

package/src/funcs/topicsSubscribersAssign.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
  * Add subscribers to a topic by key
  */
-export async function topicsSubscribersAssign(
+export function topicsSubscribersAssign(
   client: NovuCore,
   addSubscribersRequestDto: components.AddSubscribersRequestDto,
   topicKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.TopicsControllerAssignResponse,
     | errors.ErrorDto
@@ -51,6 +52,40 @@ export async function topicsSubscribersAssign(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    addSubscribersRequestDto,
+    topicKey,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  addSubscribersRequestDto: components.AddSubscribersRequestDto,
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerAssignResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.TopicsControllerAssignRequest = {
     addSubscribersRequestDto: addSubscribersRequestDto,
@@ -65,7 +100,7 @@ export async function topicsSubscribersAssign(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.AddSubscribersRequestDto, {
@@ -96,6 +131,7 @@ export async function topicsSubscribersAssign(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "TopicsController_assign",
     oAuth2Scopes: [],
 
@@ -128,7 +164,7 @@ export async function topicsSubscribersAssign(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -155,7 +191,7 @@ export async function topicsSubscribersAssign(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -195,8 +231,8 @@ export async function topicsSubscribersAssign(
     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/topicsSubscribersRemove.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
  * Remove subscribers from a topic
  */
-export async function topicsSubscribersRemove(
+export function topicsSubscribersRemove(
   client: NovuCore,
   removeSubscribersRequestDto: components.RemoveSubscribersRequestDto,
   topicKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.TopicsControllerRemoveSubscribersResponse | undefined,
     | errors.ErrorDto
@@ -51,6 +52,40 @@ export async function topicsSubscribersRemove(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    removeSubscribersRequestDto,
+    topicKey,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  removeSubscribersRequestDto: components.RemoveSubscribersRequestDto,
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerRemoveSubscribersResponse | undefined,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.TopicsControllerRemoveSubscribersRequest = {
     removeSubscribersRequestDto: removeSubscribersRequestDto,
@@ -67,7 +102,7 @@ export async function topicsSubscribersRemove(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.RemoveSubscribersRequestDto, {
@@ -100,6 +135,7 @@ export async function topicsSubscribersRemove(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "TopicsController_removeSubscribers",
     oAuth2Scopes: [],
 
@@ -132,7 +168,7 @@ export async function topicsSubscribersRemove(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -159,7 +195,7 @@ export async function topicsSubscribersRemove(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -201,8 +237,8 @@ export async function topicsSubscribersRemove(
     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/topicsSubscribersRetrieve.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
  * Check if a subscriber belongs to a certain topic
  */
-export async function topicsSubscribersRetrieve(
+export function topicsSubscribersRetrieve(
   client: NovuCore,
   externalSubscriberId: string,
   topicKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.TopicsControllerGetTopicSubscriberResponse,
     | errors.ErrorDto
@@ -50,6 +51,40 @@ export async function topicsSubscribersRetrieve(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    externalSubscriberId,
+    topicKey,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  externalSubscriberId: string,
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerGetTopicSubscriberResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.TopicsControllerGetTopicSubscriberRequest = {
     externalSubscriberId: externalSubscriberId,
@@ -66,7 +101,7 @@ export async function topicsSubscribersRetrieve(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -101,6 +136,7 @@ export async function topicsSubscribersRetrieve(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "TopicsController_getTopicSubscriber",
     oAuth2Scopes: [],
 
@@ -133,7 +169,7 @@ export async function topicsSubscribersRetrieve(
     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 topicsSubscribersRetrieve(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -201,8 +237,8 @@ export async function topicsSubscribersRetrieve(
     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/trigger.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";
 
 /**
@@ -33,12 +34,12 @@ import { Result } from "../types/fp.js";
  *     The trigger identifier is used to match the particular workflow associated with it.
  *     Additional information can be passed according the body interface below.
  */
-export async function trigger(
+export function trigger(
   client: NovuCore,
   triggerEventRequestDto: components.TriggerEventRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.EventsControllerTriggerResponse,
     | errors.ErrorDto
@@ -53,6 +54,38 @@ export async function trigger(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    triggerEventRequestDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  triggerEventRequestDto: components.TriggerEventRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EventsControllerTriggerResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.EventsControllerTriggerRequest = {
     triggerEventRequestDto: triggerEventRequestDto,
@@ -66,7 +99,7 @@ export async function trigger(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.TriggerEventRequestDto, {
@@ -90,6 +123,7 @@ export async function trigger(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "EventsController_trigger",
     oAuth2Scopes: [],
 
@@ -122,7 +156,7 @@ export async function trigger(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -149,7 +183,7 @@ export async function trigger(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -189,8 +223,8 @@ export async function trigger(
     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/triggerBroadcast.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,12 +32,12 @@ import { Result } from "../types/fp.js";
  * Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
  *       In the future could be used to trigger events to a subset of subscribers based on defined filters.
  */
-export async function triggerBroadcast(
+export function triggerBroadcast(
   client: NovuCore,
   triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.EventsControllerBroadcastEventToAllResponse,
     | errors.ErrorDto
@@ -51,6 +52,38 @@ export async function triggerBroadcast(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    triggerEventToAllRequestDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EventsControllerBroadcastEventToAllResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.EventsControllerBroadcastEventToAllRequest = {
     triggerEventToAllRequestDto: triggerEventToAllRequestDto,
@@ -65,7 +98,7 @@ export async function triggerBroadcast(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.TriggerEventToAllRequestDto, {
@@ -89,6 +122,7 @@ export async function triggerBroadcast(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "EventsController_broadcastEventToAll",
     oAuth2Scopes: [],
 
@@ -121,7 +155,7 @@ export async function triggerBroadcast(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -148,7 +182,7 @@ export async function triggerBroadcast(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -189,8 +223,8 @@ export async function triggerBroadcast(
     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/triggerBulk.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";
 
 /**
@@ -32,12 +33,12 @@ import { Result } from "../types/fp.js";
  *       Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
  *       The bulk API is limited to 100 events per request.
  */
-export async function triggerBulk(
+export function triggerBulk(
   client: NovuCore,
   bulkTriggerEventDto: components.BulkTriggerEventDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.EventsControllerTriggerBulkResponse,
     | errors.ErrorDto
@@ -52,6 +53,38 @@ export async function triggerBulk(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    bulkTriggerEventDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  bulkTriggerEventDto: components.BulkTriggerEventDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EventsControllerTriggerBulkResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const input: operations.EventsControllerTriggerBulkRequest = {
     bulkTriggerEventDto: bulkTriggerEventDto,
@@ -65,7 +98,7 @@ export async function triggerBulk(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload.BulkTriggerEventDto, {
@@ -89,6 +122,7 @@ export async function triggerBulk(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    baseURL: options?.serverURL ?? "",
     operationID: "EventsController_triggerBulk",
     oAuth2Scopes: [],
 
@@ -121,7 +155,7 @@ export async function triggerBulk(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -148,7 +182,7 @@ export async function triggerBulk(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -188,8 +222,8 @@ export async function triggerBulk(
     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/hooks/types.ts

@@ -7,6 +7,7 @@ import { RetryConfig } from "../lib/retries.js";
 import { SecurityState } from "../lib/security.js";
 
 export type HookContext = {
+  baseURL: string | URL;
   operationID: string;
   oAuth2Scopes?: string[];
   securitySource?: any | (() => Promise<any>);

package/src/lib/config.ts

@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.2.0",
-  genVersion: "2.506.0",
-  userAgent: "speakeasy-sdk/typescript 0.2.0 2.506.0 1.0 @novu/api",
+  sdkVersion: "0.3.0",
+  genVersion: "2.515.0",
+  userAgent: "speakeasy-sdk/typescript 0.3.0 2.515.0 1.0 @novu/api",
 } as const;

package/src/lib/security.ts

@@ -3,7 +3,6 @@
  */
 
 import * as components from "../models/components/index.js";
-
 type OAuth2PasswordFlow = {
   username: string;
   password?: string | undefined;