@novu/api 0.0.1-alpha.6

package/src/sdk/tenants.ts

@@ -0,0 +1,527 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { SDKHooks } from "../hooks";
+import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "../lib/config";
+import {
+    encodeFormQuery as encodeFormQuery$,
+    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 { createPageIterator, PageIterator, Paginator } from "../types";
+import jp from "jsonpath";
+import * as z from "zod";
+
+export class Tenants 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$;
+    }
+
+    /**
+     * Create tenant
+     *
+     * @remarks
+     * Create tenant under the current environment
+     */
+    async create(
+        request: components.CreateTenantRequestDto,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<components.CreateTenantResponseDto> {
+        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$) => components.CreateTenantRequestDto$.outboundSchema.parse(value$),
+            "Input validation failed"
+        );
+        const body$ = encodeJSON$("body", payload$, { explode: true });
+
+        const path$ = this.templateURLComponent("/v1/tenants")();
+
+        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: "TenantController_createTenant",
+            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: "POST",
+                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.CreateTenantResponseDto>()
+            .json([200, 201], components.CreateTenantResponseDto$)
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+
+    /**
+     * Delete tenant
+     *
+     * @remarks
+     * Deletes a tenant entity from the Novu platform
+     */
+    async delete(
+        identifier: string,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<void> {
+        const input$: operations.TenantControllerRemoveTenantRequest = {
+            identifier: identifier,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Accept", "*/*");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.TenantControllerRemoveTenantRequest$.outboundSchema.parse(value$),
+            "Input validation failed"
+        );
+        const body$ = null;
+
+        const pathParams$ = {
+            identifier: encodeSimple$("identifier", payload$.identifier, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent("/v1/tenants/{identifier}")(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: "TenantController_removeTenant",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["404", "409", "429", "4XX", "503", "5XX"] };
+        const request$ = this.createRequest$(
+            context,
+            {
+                security: securitySettings$,
+                method: "DELETE",
+                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<void>()
+            .void(204, z.void())
+            .fail([404, 409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+
+    /**
+     * Get tenants
+     *
+     * @remarks
+     * Returns a list of tenants, could paginated using the `page` and `limit` query parameter
+     */
+    async list(
+        page?: number | undefined,
+        limit?: number | undefined,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<PageIterator<operations.TenantControllerListTenantsResponse>> {
+        const input$: operations.TenantControllerListTenantsRequest = {
+            page: page,
+            limit: limit,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) => operations.TenantControllerListTenantsRequest$.outboundSchema.parse(value$),
+            "Input validation failed"
+        );
+        const body$ = null;
+
+        const path$ = this.templateURLComponent("/v1/tenants")();
+
+        const query$ = encodeFormQuery$({
+            limit: payload$.limit,
+            page: payload$.page,
+        });
+
+        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: "TenantController_listTenants",
+            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 responseFields$ = {
+            HttpMeta: { Response: response, Request: request$ },
+        };
+
+        const [result$, raw$] = await this.matcher<operations.TenantControllerListTenantsResponse>()
+            .json(200, operations.TenantControllerListTenantsResponse$, { key: "Result" })
+            .fail([409, 429, "4XX", 503, "5XX"])
+            .match(response, { extraFields: responseFields$ });
+
+        const nextFunc = (
+            responseData: unknown
+        ): Paginator<operations.TenantControllerListTenantsResponse> => {
+            const page = input$.page || 0;
+            const nextPage = page + 1;
+
+            if (!responseData) {
+                return () => null;
+            }
+            const results = jp.value(responseData, "$.data.resultArray");
+            if (!results.length) {
+                return () => null;
+            }
+            const limit = input$.limit || 0;
+            if (results.length < limit) {
+                return () => null;
+            }
+
+            return () => this.list(nextPage, limit, options);
+        };
+
+        const page$ = { ...result$, next: nextFunc(raw$) };
+        return { ...page$, ...createPageIterator(page$) };
+    }
+
+    /**
+     * Get tenant
+     *
+     * @remarks
+     * Get tenant by your internal id used to identify the tenant
+     */
+    async retrieve(
+        identifier: string,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<components.GetTenantResponseDto> {
+        const input$: operations.TenantControllerGetTenantByIdRequest = {
+            identifier: identifier,
+        };
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input$,
+            (value$) =>
+                operations.TenantControllerGetTenantByIdRequest$.outboundSchema.parse(value$),
+            "Input validation failed"
+        );
+        const body$ = null;
+
+        const pathParams$ = {
+            identifier: encodeSimple$("identifier", payload$.identifier, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent("/v1/tenants/{identifier}")(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: "TenantController_getTenantById",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["404", "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<components.GetTenantResponseDto>()
+            .json(200, components.GetTenantResponseDto$)
+            .fail([404, 409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+
+    /**
+     * Update tenant
+     *
+     * @remarks
+     * Update tenant by your internal id used to identify the tenant
+     */
+    async update(
+        identifier: string,
+        updateTenantRequestDto: components.UpdateTenantRequestDto,
+        options?: RequestOptions & { retries?: retries$.RetryConfig }
+    ): Promise<components.UpdateTenantResponseDto> {
+        const input$: operations.TenantControllerUpdateTenantRequest = {
+            identifier: identifier,
+            updateTenantRequestDto: updateTenantRequestDto,
+        };
+        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.TenantControllerUpdateTenantRequest$.outboundSchema.parse(value$),
+            "Input validation failed"
+        );
+        const body$ = encodeJSON$("body", payload$.UpdateTenantRequestDto, { explode: true });
+
+        const pathParams$ = {
+            identifier: encodeSimple$("identifier", payload$.identifier, {
+                explode: false,
+                charEncoding: "percent",
+            }),
+        };
+        const path$ = this.templateURLComponent("/v1/tenants/{identifier}")(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: "TenantController_updateTenant",
+            oAuth2Scopes: [],
+            securitySource: this.options$.apiKey,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["404", "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.UpdateTenantResponseDto>()
+            .json(200, components.UpdateTenantResponseDto$)
+            .fail([404, 409, 429, "4XX", 503, "5XX"])
+            .match(response);
+
+        return result$;
+    }
+}