@novu/api 0.0.1-alpha.6

package/src/sdk/preferences.ts

@@ -0,0 +1,435 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { SDKHooks } from "../hooks";
+import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "../lib/config";
+import { encodeJSON as encodeJSON$, encodeSimple as encodeSimple$ } from "../lib/encodings";
+import { HTTPClient } from "../lib/http";
+import * as retries$ from "../lib/retries";
+import * as schemas$ from "../lib/schemas";
+import { ClientSDK, RequestOptions } from "../lib/sdks";
+import * as components from "../models/components";
+import * as operations from "../models/operations";
+import * as z from "zod";
+
+export class Preferences extends ClientSDK {
+    private readonly options$: SDKOptions & { hooks?: SDKHooks };
+
+    constructor(options: SDKOptions = {}) {
+        const opt = options as unknown;
+        let hooks: SDKHooks;
+        if (
+            typeof opt === "object" &&
+            opt != null &&
+            "hooks" in opt &&
+            opt.hooks instanceof SDKHooks
+        ) {
+            hooks = opt.hooks;
+        } else {
+            hooks = new SDKHooks();
+        }
+
+        super({
+            client: options.httpClient || new HTTPClient(),
+            baseURL: serverURLFromOptions(options),
+            hooks,
+        });
+
+        this.options$ = { ...options, hooks };
+        void this.options$;
+    }
+
+    /**
+     * Get subscriber preferences
+     */
+    async list(
+        subscriberId: string,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<Array<components.UpdateSubscriberPreferenceResponseDto>> {
+        const input$: operations.SubscribersControllerListSubscriberPreferencesRequest = {
+            subscriberId: subscriberId,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.SubscribersControllerListSubscriberPreferencesRequest$.outboundSchema.parse(
+                    value$
+                ),
+            "Input validation failed"
+        );
+        const body$ = null;
+
+        const pathParams$ = {
+            subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/preferences")(
+            pathParams$
+        );
+
+        const query$ = "";
+
+        let security$;
+        if (typeof this.options$.apiKey === "function") {
+            security$ = { apiKey: await this.options$.apiKey() };
+        } else if (this.options$.apiKey) {
+            security$ = { apiKey: this.options$.apiKey };
+        } else {
+            security$ = {};
+        }
+        const context = {
+            operationID: "SubscribersController_listSubscriberPreferences",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] };
+        const request$ = this.createRequest$(
+            context,
+            {
+                security: securitySettings$,
+                method: "GET",
+                path: path$,
+                headers: headers$,
+                query: query$,
+                body: body$,
+            },
+            options
+        );
+
+        const retryConfig = options?.retries ||
+            this.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            };
+
+        const response = await retries$.retry(
+            () => {
+                const cloned = request$.clone();
+                return this.do$(cloned, doOptions);
+            },
+            { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] }
+        );
+
+        const [result$] = await this.matcher<
+            Array<components.UpdateSubscriberPreferenceResponseDto>
+        >()
+            .json(200, z.array(components.UpdateSubscriberPreferenceResponseDto$.inboundSchema))
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+
+    /**
+     * Get subscriber preferences by level
+     */
+    async retrieveByLevel(
+        parameter: string,
+        subscriberId: string,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<Array<components.GetSubscriberPreferencesResponseDto>> {
+        const input$: operations.SubscribersControllerGetSubscriberPreferenceByLevelRequest = {
+            parameter: parameter,
+            subscriberId: subscriberId,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.SubscribersControllerGetSubscriberPreferenceByLevelRequest$.outboundSchema.parse(
+                    value$
+                ),
+            "Input validation failed"
+        );
+        const body$ = null;
+
+        const pathParams$ = {
+            parameter: encodeSimple$("parameter", payload$.parameter, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+            subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent(
+            "/v1/subscribers/{subscriberId}/preferences/{parameter}"
+        )(pathParams$);
+
+        const query$ = "";
+
+        let security$;
+        if (typeof this.options$.apiKey === "function") {
+            security$ = { apiKey: await this.options$.apiKey() };
+        } else if (this.options$.apiKey) {
+            security$ = { apiKey: this.options$.apiKey };
+        } else {
+            security$ = {};
+        }
+        const context = {
+            operationID: "SubscribersController_getSubscriberPreferenceByLevel",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] };
+        const request$ = this.createRequest$(
+            context,
+            {
+                security: securitySettings$,
+                method: "GET",
+                path: path$,
+                headers: headers$,
+                query: query$,
+                body: body$,
+            },
+            options
+        );
+
+        const retryConfig = options?.retries ||
+            this.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            };
+
+        const response = await retries$.retry(
+            () => {
+                const cloned = request$.clone();
+                return this.do$(cloned, doOptions);
+            },
+            { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] }
+        );
+
+        const [result$] = await this.matcher<
+            Array<components.GetSubscriberPreferencesResponseDto>
+        >()
+            .json(200, z.array(components.GetSubscriberPreferencesResponseDto$.inboundSchema))
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+
+    /**
+     * Update subscriber preference
+     */
+    async update(
+        request: operations.SubscribersControllerUpdateSubscriberPreferenceRequest,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<components.UpdateSubscriberPreferenceResponseDto> {
+        const input$ = request;
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Content-Type", "application/json");
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.SubscribersControllerUpdateSubscriberPreferenceRequest$.outboundSchema.parse(
+                    value$
+                ),
+            "Input validation failed"
+        );
+        const body$ = encodeJSON$("body", payload$.UpdateSubscriberPreferenceRequestDto, {
+            explode: true,
+        });
+
+        const pathParams$ = {
+            parameter: encodeSimple$("parameter", payload$.parameter, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+            subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent(
+            "/v1/subscribers/{subscriberId}/preferences/{parameter}"
+        )(pathParams$);
+
+        const query$ = "";
+
+        let security$;
+        if (typeof this.options$.apiKey === "function") {
+            security$ = { apiKey: await this.options$.apiKey() };
+        } else if (this.options$.apiKey) {
+            security$ = { apiKey: this.options$.apiKey };
+        } else {
+            security$ = {};
+        }
+        const context = {
+            operationID: "SubscribersController_updateSubscriberPreference",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] };
+        const request$ = this.createRequest$(
+            context,
+            {
+                security: securitySettings$,
+                method: "PATCH",
+                path: path$,
+                headers: headers$,
+                query: query$,
+                body: body$,
+            },
+            options
+        );
+
+        const retryConfig = options?.retries ||
+            this.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            };
+
+        const response = await retries$.retry(
+            () => {
+                const cloned = request$.clone();
+                return this.do$(cloned, doOptions);
+            },
+            { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] }
+        );
+
+        const [result$] = await this.matcher<components.UpdateSubscriberPreferenceResponseDto>()
+            .json(200, components.UpdateSubscriberPreferenceResponseDto$)
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+
+    /**
+     * Update subscriber global preferences
+     */
+    async updateGlobal(
+        subscriberId: string,
+        updateSubscriberGlobalPreferencesRequestDto: components.UpdateSubscriberGlobalPreferencesRequestDto,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<components.UpdateSubscriberPreferenceResponseDto> {
+        const input$: operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest = {
+            subscriberId: subscriberId,
+            updateSubscriberGlobalPreferencesRequestDto:
+                updateSubscriberGlobalPreferencesRequestDto,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Content-Type", "application/json");
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest$.outboundSchema.parse(
+                    value$
+                ),
+            "Input validation failed"
+        );
+        const body$ = encodeJSON$("body", payload$.UpdateSubscriberGlobalPreferencesRequestDto, {
+            explode: true,
+        });
+
+        const pathParams$ = {
+            subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/preferences")(
+            pathParams$
+        );
+
+        const query$ = "";
+
+        let security$;
+        if (typeof this.options$.apiKey === "function") {
+            security$ = { apiKey: await this.options$.apiKey() };
+        } else if (this.options$.apiKey) {
+            security$ = { apiKey: this.options$.apiKey };
+        } else {
+            security$ = {};
+        }
+        const context = {
+            operationID: "SubscribersController_updateSubscriberGlobalPreferences",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] };
+        const request$ = this.createRequest$(
+            context,
+            {
+                security: securitySettings$,
+                method: "PATCH",
+                path: path$,
+                headers: headers$,
+                query: query$,
+                body: body$,
+            },
+            options
+        );
+
+        const retryConfig = options?.retries ||
+            this.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            };
+
+        const response = await retries$.retry(
+            () => {
+                const cloned = request$.clone();
+                return this.do$(cloned, doOptions);
+            },
+            { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] }
+        );
+
+        const [result$] = await this.matcher<components.UpdateSubscriberPreferenceResponseDto>()
+            .json(200, components.UpdateSubscriberPreferenceResponseDto$)
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+}

package/src/sdk/properties.ts

@@ -0,0 +1,142 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { SDKHooks } from "../hooks";
+import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "../lib/config";
+import { encodeJSON as encodeJSON$, encodeSimple as encodeSimple$ } from "../lib/encodings";
+import { HTTPClient } from "../lib/http";
+import * as retries$ from "../lib/retries";
+import * as schemas$ from "../lib/schemas";
+import { ClientSDK, RequestOptions } from "../lib/sdks";
+import * as components from "../models/components";
+import * as operations from "../models/operations";
+
+export class Properties extends ClientSDK {
+    private readonly options$: SDKOptions & { hooks?: SDKHooks };
+
+    constructor(options: SDKOptions = {}) {
+        const opt = options as unknown;
+        let hooks: SDKHooks;
+        if (
+            typeof opt === "object" &&
+            opt != null &&
+            "hooks" in opt &&
+            opt.hooks instanceof SDKHooks
+        ) {
+            hooks = opt.hooks;
+        } else {
+            hooks = new SDKHooks();
+        }
+
+        super({
+            client: options.httpClient || new HTTPClient(),
+            baseURL: serverURLFromOptions(options),
+            hooks,
+        });
+
+        this.options$ = { ...options, hooks };
+        void this.options$;
+    }
+
+    /**
+     * Update subscriber online status
+     *
+     * @remarks
+     * Used to update the subscriber isOnline flag.
+     */
+    async updateOnlineFlag(
+        subscriberId: string,
+        updateSubscriberOnlineFlagRequestDto: components.UpdateSubscriberOnlineFlagRequestDto,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<components.SubscriberResponseDto> {
+        const input$: operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest = {
+            subscriberId: subscriberId,
+            updateSubscriberOnlineFlagRequestDto: updateSubscriberOnlineFlagRequestDto,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Content-Type", "application/json");
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest$.outboundSchema.parse(
+                    value$
+                ),
+            "Input validation failed"
+        );
+        const body$ = encodeJSON$("body", payload$.UpdateSubscriberOnlineFlagRequestDto, {
+            explode: true,
+        });
+
+        const pathParams$ = {
+            subscriberId: encodeSimple$("subscriberId", payload$.subscriberId, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent("/v1/subscribers/{subscriberId}/online-status")(
+            pathParams$
+        );
+
+        const query$ = "";
+
+        let security$;
+        if (typeof this.options$.apiKey === "function") {
+            security$ = { apiKey: await this.options$.apiKey() };
+        } else if (this.options$.apiKey) {
+            security$ = { apiKey: this.options$.apiKey };
+        } else {
+            security$ = {};
+        }
+        const context = {
+            operationID: "SubscribersController_updateSubscriberOnlineFlag",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] };
+        const request$ = this.createRequest$(
+            context,
+            {
+                security: securitySettings$,
+                method: "PATCH",
+                path: path$,
+                headers: headers$,
+                query: query$,
+                body: body$,
+            },
+            options
+        );
+
+        const retryConfig = options?.retries ||
+            this.options$.retryConfig || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 30000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            };
+
+        const response = await retries$.retry(
+            () => {
+                const cloned = request$.clone();
+                return this.do$(cloned, doOptions);
+            },
+            { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] }
+        );
+
+        const [result$] = await this.matcher<components.SubscriberResponseDto>()
+            .json(200, components.SubscriberResponseDto$)
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+}