@chrt-inc/typescript-sdk 1.363.0 → 1.363.1

package/dist/cjs/api/resources/notifications/resources/groups/client/Client.d.ts

@@ -0,0 +1,209 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.js";
+import * as core from "../../../../../../core/index.js";
+import * as Chrt from "../../../../../index.js";
+export declare namespace Groups {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Groups {
+    protected readonly _options: Groups.Options;
+    constructor(_options?: Groups.Options);
+    /**
+     * Lists all notification groups for the caller's organization. | authz: min_org_role=operator | () -> (list[NotificationGroup1])
+     *
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.notifications.groups.listByOrgV1()
+     */
+    listByOrgV1(requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<Chrt.NotificationGroup1[]>;
+    private __listByOrgV1;
+    /**
+     * Retrieves full notification group details including user membership. | authz: min_org_role=operator | () -> (NotificationGroup1)
+     *
+     * @param {string} groupId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.getForAdministratorV1("group_id")
+     */
+    getForAdministratorV1(groupId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<Chrt.NotificationGroup1>;
+    private __getForAdministratorV1;
+    /**
+     * Lists notification groups the caller is a member of. | () -> (list[NotificationGroupLimitedForDriver1])
+     *
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.notifications.groups.listByUserV1()
+     */
+    listByUserV1(requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<Chrt.NotificationGroupLimitedForDriver1[]>;
+    private __listByUserV1;
+    /**
+     * Retrieves limited notification group details for a group the caller is a member of. | () -> (NotificationGroupLimitedForDriver1)
+     *
+     * @param {string} groupId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.getForMemberV1("group_id")
+     */
+    getForMemberV1(groupId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<Chrt.NotificationGroupLimitedForDriver1>;
+    private __getForMemberV1;
+    /**
+     * Creates a new notification group for the organization. | authz: min_org_role=administrator | (NotificationGroupClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {Chrt.notifications.NotificationGroupClientCreate1} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.createV1({
+     *         schema_version: 1,
+     *         group_name: "group_name"
+     *     })
+     */
+    createV1(request: Chrt.notifications.NotificationGroupClientCreate1, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
+    /**
+     * Updates the name of a notification group. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {Chrt.notifications.GroupsUpdateNameV1Request} request
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.updateNameV1("group_id", {
+     *         group_name: "group_name"
+     *     })
+     */
+    updateNameV1(groupId: string, request: Chrt.notifications.GroupsUpdateNameV1Request, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateNameV1;
+    /**
+     * Adds a notification event to a channel for a group. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {Chrt.NotificationChannelsEnum} channel
+     * @param {Chrt.NotificationEventsForOrgsEnum} event
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.addEventV1("group_id", "email", "shipping.order.staged")
+     */
+    addEventV1(groupId: string, channel: Chrt.NotificationChannelsEnum, event: Chrt.NotificationEventsForOrgsEnum, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addEventV1;
+    /**
+     * Removes a notification event from a channel for a group. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {Chrt.NotificationChannelsEnum} channel
+     * @param {Chrt.NotificationEventsForOrgsEnum} event
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.removeEventV1("group_id", "email", "shipping.order.staged")
+     */
+    removeEventV1(groupId: string, channel: Chrt.NotificationChannelsEnum, event: Chrt.NotificationEventsForOrgsEnum, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeEventV1;
+    /**
+     * Adds a user to a notification group. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.addUserV1("group_id", "user_id")
+     */
+    addUserV1(groupId: string, userId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addUserV1;
+    /**
+     * Removes a user from a notification group. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.removeUserV1("group_id", "user_id")
+     */
+    removeUserV1(groupId: string, userId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeUserV1;
+    /**
+     * Deletes a notification group. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.deleteV1("group_id")
+     */
+    deleteV1(groupId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Opts the caller back into notifications for a group they were opted out of. | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.userOptInV1("group_id")
+     */
+    userOptInV1(groupId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __userOptInV1;
+    /**
+     * Opts the caller out of notifications for a group. | () -> (bool)
+     *
+     * @param {string} groupId
+     * @param {Groups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.notifications.groups.userOptOutV1("group_id")
+     */
+    userOptOutV1(groupId: string, requestOptions?: Groups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __userOptOutV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}