@novu/api 0.0.1-alpha.10

package/src/funcs/subscribersRetrieve.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeSimple as encodeSimple$ } from "../lib/encodings.js";
+import * as m$ from "../lib/matchers.js";
+import * as schemas$ from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.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";
+
+/**
+ * Get subscriber
+ *
+ * @remarks
+ * Get subscriber by your internal id used to identify the subscriber
+ */
+export async function subscribersRetrieve(
+    client$: NovuCore,
+    subscriberId: string,
+    options?: RequestOptions
+): Promise<
+    Result<
+        components.SubscriberResponseDto,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >
+> {
+    const input$: operations.SubscribersControllerGetSubscriberRequest = {
+        subscriberId: subscriberId,
+    };
+
+    const parsed$ = schemas$.safeParse(
+        input$,
+        (value$) =>
+            operations.SubscribersControllerGetSubscriberRequest$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({
+        Accept: "application/json",
+    });
+
+    const apiKey$ = await extractSecurity(client$.options$.apiKey);
+    const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ };
+    const context = {
+        operationID: "SubscribersController_getSubscriber",
+        oAuth2Scopes: [],
+        securitySource: client$.options$.apiKey,
+    };
+    const securitySettings$ = resolveGlobalSecurity(security$);
+
+    const requestRes = client$.createRequest$(
+        context,
+        {
+            security: securitySettings$,
+            method: "GET",
+            path: path$,
+            headers: headers$,
+            body: body$,
+            timeoutMs: options?.timeoutMs || client$.options$.timeoutMs || -1,
+        },
+        options
+    );
+    if (!requestRes.ok) {
+        return requestRes;
+    }
+    const request$ = requestRes.value;
+
+    const doResult = await client$.do$(request$, {
+        context,
+        errorCodes: ["409", "429", "4XX", "503", "5XX"],
+        retryConfig: options?.retries ||
+            client$.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            },
+        retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+    });
+    if (!doResult.ok) {
+        return doResult;
+    }
+    const response = doResult.value;
+
+    const [result$] = await m$.match<
+        components.SubscriberResponseDto,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >(
+        m$.json(200, components.SubscriberResponseDto$inboundSchema),
+        m$.fail([409, 429, "4XX", 503, "5XX"])
+    )(response);
+    if (!result$.ok) {
+        return result$;
+    }
+
+    return result$;
+}

package/src/funcs/subscribersUpdate.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeJSON as encodeJSON$, encodeSimple as encodeSimple$ } from "../lib/encodings.js";
+import * as m$ from "../lib/matchers.js";
+import * as schemas$ from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.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";
+
+/**
+ * Update subscriber
+ *
+ * @remarks
+ * Used to update the subscriber entity with new information
+ */
+export async function subscribersUpdate(
+    client$: NovuCore,
+    subscriberId: string,
+    updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
+    options?: RequestOptions
+): Promise<
+    Result<
+        components.SubscriberResponseDto,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >
+> {
+    const input$: operations.SubscribersControllerUpdateSubscriberRequest = {
+        subscriberId: subscriberId,
+        updateSubscriberRequestDto: updateSubscriberRequestDto,
+    };
+
+    const parsed$ = schemas$.safeParse(
+        input$,
+        (value$) =>
+            operations.SubscribersControllerUpdateSubscriberRequest$outboundSchema.parse(value$),
+        "Input validation failed"
+    );
+    if (!parsed$.ok) {
+        return parsed$;
+    }
+    const payload$ = parsed$.value;
+    const body$ = encodeJSON$("body", payload$.UpdateSubscriberRequestDto, { explode: true });
+
+    const pathParams$ = {
+        subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+
+    const path$ = pathToFunc("/v1/subscribers/{subscriberId}")(pathParams$);
+
+    const headers$ = new Headers({
+        "Content-Type": "application/json",
+        Accept: "application/json",
+    });
+
+    const apiKey$ = await extractSecurity(client$.options$.apiKey);
+    const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ };
+    const context = {
+        operationID: "SubscribersController_updateSubscriber",
+        oAuth2Scopes: [],
+        securitySource: client$.options$.apiKey,
+    };
+    const securitySettings$ = resolveGlobalSecurity(security$);
+
+    const requestRes = client$.createRequest$(
+        context,
+        {
+            security: securitySettings$,
+            method: "PUT",
+            path: path$,
+            headers: headers$,
+            body: body$,
+            timeoutMs: options?.timeoutMs || client$.options$.timeoutMs || -1,
+        },
+        options
+    );
+    if (!requestRes.ok) {
+        return requestRes;
+    }
+    const request$ = requestRes.value;
+
+    const doResult = await client$.do$(request$, {
+        context,
+        errorCodes: ["409", "429", "4XX", "503", "5XX"],
+        retryConfig: options?.retries ||
+            client$.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            },
+        retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+    });
+    if (!doResult.ok) {
+        return doResult;
+    }
+    const response = doResult.value;
+
+    const [result$] = await m$.match<
+        components.SubscriberResponseDto,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >(
+        m$.json(200, components.SubscriberResponseDto$inboundSchema),
+        m$.fail([409, 429, "4XX", 503, "5XX"])
+    )(response);
+    if (!result$.ok) {
+        return result$;
+    }
+
+    return result$;
+}

package/src/funcs/tenantsCreate.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeJSON as encodeJSON$ } from "../lib/encodings.js";
+import * as m$ from "../lib/matchers.js";
+import * as schemas$ from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Create tenant
+ *
+ * @remarks
+ * Create tenant under the current environment Tenants is not supported in code first version of the API.
+ */
+export async function tenantsCreate(
+    client$: NovuCore,
+    request: components.CreateTenantRequestDto,
+    options?: RequestOptions
+): Promise<
+    Result<
+        components.CreateTenantResponseDto,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >
+> {
+    const input$ = request;
+
+    const parsed$ = schemas$.safeParse(
+        input$,
+        (value$) => components.CreateTenantRequestDto$outboundSchema.parse(value$),
+        "Input validation failed"
+    );
+    if (!parsed$.ok) {
+        return parsed$;
+    }
+    const payload$ = parsed$.value;
+    const body$ = encodeJSON$("body", payload$, { explode: true });
+
+    const path$ = pathToFunc("/v1/tenants")();
+
+    const headers$ = new Headers({
+        "Content-Type": "application/json",
+        Accept: "application/json",
+    });
+
+    const apiKey$ = await extractSecurity(client$.options$.apiKey);
+    const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ };
+    const context = {
+        operationID: "TenantController_createTenant",
+        oAuth2Scopes: [],
+        securitySource: client$.options$.apiKey,
+    };
+    const securitySettings$ = resolveGlobalSecurity(security$);
+
+    const requestRes = client$.createRequest$(
+        context,
+        {
+            security: securitySettings$,
+            method: "POST",
+            path: path$,
+            headers: headers$,
+            body: body$,
+            timeoutMs: options?.timeoutMs || client$.options$.timeoutMs || -1,
+        },
+        options
+    );
+    if (!requestRes.ok) {
+        return requestRes;
+    }
+    const request$ = requestRes.value;
+
+    const doResult = await client$.do$(request$, {
+        context,
+        errorCodes: ["409", "429", "4XX", "503", "5XX"],
+        retryConfig: options?.retries ||
+            client$.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            },
+        retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+    });
+    if (!doResult.ok) {
+        return doResult;
+    }
+    const response = doResult.value;
+
+    const [result$] = await m$.match<
+        components.CreateTenantResponseDto,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >(
+        m$.json(200, components.CreateTenantResponseDto$inboundSchema),
+        m$.fail([409, 429, "4XX", 503, "5XX"])
+    )(response);
+    if (!result$.ok) {
+        return result$;
+    }
+
+    return result$;
+}

package/src/funcs/tenantsDelete.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeSimple as encodeSimple$ } from "../lib/encodings.js";
+import * as m$ from "../lib/matchers.js";
+import * as schemas$ 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 { 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";
+import * as z from "zod";
+
+/**
+ * Delete tenant
+ *
+ * @remarks
+ * Deletes a tenant entity from the Novu platform. Tenants is not supported in code first version of the API.
+ */
+export async function tenantsDelete(
+    client$: NovuCore,
+    identifier: string,
+    options?: RequestOptions
+): Promise<
+    Result<
+        void,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >
+> {
+    const input$: operations.TenantControllerRemoveTenantRequest = {
+        identifier: identifier,
+    };
+
+    const parsed$ = schemas$.safeParse(
+        input$,
+        (value$) => operations.TenantControllerRemoveTenantRequest$outboundSchema.parse(value$),
+        "Input validation failed"
+    );
+    if (!parsed$.ok) {
+        return parsed$;
+    }
+    const payload$ = parsed$.value;
+    const body$ = null;
+
+    const pathParams$ = {
+        identifier: encodeSimple$("identifier", payload$.identifier, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+
+    const path$ = pathToFunc("/v1/tenants/{identifier}")(pathParams$);
+
+    const headers$ = new Headers({
+        Accept: "*/*",
+    });
+
+    const apiKey$ = await extractSecurity(client$.options$.apiKey);
+    const security$ = apiKey$ == null ? {} : { apiKey: apiKey$ };
+    const context = {
+        operationID: "TenantController_removeTenant",
+        oAuth2Scopes: [],
+        securitySource: client$.options$.apiKey,
+    };
+    const securitySettings$ = resolveGlobalSecurity(security$);
+
+    const requestRes = client$.createRequest$(
+        context,
+        {
+            security: securitySettings$,
+            method: "DELETE",
+            path: path$,
+            headers: headers$,
+            body: body$,
+            timeoutMs: options?.timeoutMs || client$.options$.timeoutMs || -1,
+        },
+        options
+    );
+    if (!requestRes.ok) {
+        return requestRes;
+    }
+    const request$ = requestRes.value;
+
+    const doResult = await client$.do$(request$, {
+        context,
+        errorCodes: ["404", "409", "429", "4XX", "503", "5XX"],
+        retryConfig: options?.retries ||
+            client$.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            },
+        retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+    });
+    if (!doResult.ok) {
+        return doResult;
+    }
+    const response = doResult.value;
+
+    const [result$] = await m$.match<
+        void,
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+    >(
+        m$.nil(204, z.void()),
+        m$.fail([404, 409, 429, "4XX", 503, "5XX"])
+    )(response);
+    if (!result$.ok) {
+        return result$;
+    }
+
+    return result$;
+}