@wildix/xbees-kite-client 1.0.1

package/dist-types/models/models_0.d.ts

@@ -0,0 +1,617 @@
+import { KiteServiceException as __BaseException } from "./KiteServiceException";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+/**
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class LimitExceededException extends __BaseException {
+    readonly name: "LimitExceededException";
+    readonly $fault: "client";
+    /**
+     * Displays the applicable rate limits for the current request.
+     * @public
+     */
+    rateLimit?: string;
+    /**
+     * Indicates how many requests a user can still make within the current time window.
+     * @public
+     */
+    rateLimitRemaining?: number;
+    /**
+     * Shows the time in seconds until the rate limit resets.
+     * @public
+     */
+    rateLimitReset?: number;
+    /**
+     * Displays how many seconds the user agent should wait before making a follow-up request.
+     * @public
+     */
+    retryAfter?: number;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface User {
+    id: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    picture?: string;
+    locale?: string;
+    timeZone?: string;
+    company?: string;
+    bot?: boolean;
+    pbxDomain?: string;
+    pbxPort?: string;
+    pbxExtension?: string;
+    pbxSerial?: string;
+    pbxUserId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * @public
+ */
+export interface MessagePredefinedReply {
+    /**
+     * Text that will be sent to the user; clicking the text will trigger sending this message.
+     * @public
+     */
+    text: string;
+    /**
+     * Label that will appear on the reply button; if no label is provided, the text will be used.
+     * @public
+     */
+    label?: string;
+}
+/**
+ * @public
+ */
+export interface WidgetPalleteSettings {
+    /**
+     * The background color can be specified in hex format (#CCC or #FAFAFA), rgb format (rgb(22, 123, 200)), or rgba format (rgba(22, 123, 200, 1)).
+     * @public
+     */
+    backgroundColor?: string;
+    /**
+     * The accent color can be specified in hex format (#CCC or #FAFAFA), rgb format (rgb(22, 123, 200)), or rgba format (rgba(22, 123, 200, 1)).
+     * @public
+     */
+    accentColor?: string;
+}
+/**
+ * @public
+ */
+export interface WidgetTextSettings {
+    /**
+     * Text that will be visible to the user inside Send button (default: Start new conversation)
+     * @public
+     */
+    button?: string;
+    /**
+     * Text that will be visible to the user below avatar (default: Support agent)
+     * @public
+     */
+    title?: string;
+    /**
+     * Text that will be visible to the user in the header title (default: Hello)
+     * @public
+     */
+    topTitle?: string;
+    /**
+     * Text that will be visible to the user in the header subtitle (default: How can we help you?)
+     * @public
+     */
+    topSubtitle?: string;
+}
+/**
+ * @public
+ */
+export interface WidgetAppearance {
+    /**
+     * Configuration of the widget's color scheme settings.
+     * @public
+     */
+    pallete?: WidgetPalleteSettings;
+    /**
+     * Configuration of the widget's text elements.
+     * @public
+     */
+    text?: WidgetTextSettings;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const WidgetRouteTimeFrameDay: {
+    readonly EVERY_DAY: "EVERY_DAY";
+    readonly FRIDAY: "FRIDAY";
+    readonly MONDAY: "MONDAY";
+    readonly SATURDAY: "SATURDAY";
+    readonly SUNDAY: "SUNDAY";
+    readonly THUESDAY: "THUESDAY";
+    readonly THURSDAY: "THURSDAY";
+    readonly WEDNESDAY: "WEDNESDAY";
+    readonly WEEKDAYS: "WEEKDAYS";
+    readonly WEEKENDS: "WEEKENDS";
+};
+/**
+ * @public
+ */
+export type WidgetRouteTimeFrameDay = typeof WidgetRouteTimeFrameDay[keyof typeof WidgetRouteTimeFrameDay];
+/**
+ * @public
+ */
+export interface WidgetRouteTimeFrameRule {
+    /**
+     * The IANA time zone name (e.g., 'America/Los_Angeles') specifying the time zone in which the rule applies.
+     * @public
+     */
+    timeZone: string;
+    /**
+     * The day of the week or pattern when the rule applies.
+     * @public
+     */
+    day: WidgetRouteTimeFrameDay;
+    /**
+     * The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
+     * @public
+     */
+    startMinute: number;
+    /**
+     * The minute of the day when the rule matches for the specified time zone (for example, 300 corresponds to 5AM)
+     * @public
+     */
+    endMinute: number;
+}
+/**
+ * @public
+ */
+export type WidgetRouteRule = WidgetRouteRule.TimeFrameMember | WidgetRouteRule.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace WidgetRouteRule {
+    interface TimeFrameMember {
+        timeFrame: WidgetRouteTimeFrameRule;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        timeFrame?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        timeFrame: (value: WidgetRouteTimeFrameRule) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: WidgetRouteRule, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface WidgetAgentTarget {
+    /**
+     * An email of the user that registered on x-bees and account must be connected to the PBX.
+     * @public
+     */
+    email: string;
+}
+/**
+ * @public
+ */
+export interface WidgetBotTarget {
+    /**
+     * An ID of the bot.
+     * @public
+     */
+    id: string;
+}
+/**
+ * @public
+ */
+export interface WidgetServiceTarget {
+    /**
+     * An ID of the service. ID of the service equals the ID of the call group that available on the PBX.
+     * @public
+     */
+    id: number;
+    /**
+     * An URI of the service which includes ID, PBX domain and port (example - 1@example.wildixin.com:443
+     * @public
+     */
+    uri: string;
+}
+/**
+ * @public
+ */
+export type WidgetTarget = WidgetTarget.AgentMember | WidgetTarget.BotMember | WidgetTarget.ServiceMember | WidgetTarget.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace WidgetTarget {
+    interface ServiceMember {
+        service: WidgetServiceTarget;
+        agent?: never;
+        bot?: never;
+        $unknown?: never;
+    }
+    interface AgentMember {
+        service?: never;
+        agent: WidgetAgentTarget;
+        bot?: never;
+        $unknown?: never;
+    }
+    interface BotMember {
+        service?: never;
+        agent?: never;
+        bot: WidgetBotTarget;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        service?: never;
+        agent?: never;
+        bot?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        service: (value: WidgetServiceTarget) => T;
+        agent: (value: WidgetAgentTarget) => T;
+        bot: (value: WidgetBotTarget) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: WidgetTarget, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface WidgetRoute {
+    id: string;
+    rules: (WidgetRouteRule)[];
+    /**
+     * The target will be used if the specified route matches the specified rules. If no rules are matched, the default target of the widget will be used.
+     * @public
+     */
+    target: WidgetTarget;
+}
+/**
+ * @public
+ */
+export interface WelcomeMessage {
+    /**
+     * Welcome message text.
+     * @public
+     */
+    text?: string;
+    /**
+     * A list of predefined replies will be visible to the user receiving the message. Once the user clicks on a reply, the system will automatically send the specified message to the conversation. You can specify up to 10 replies, which will only be visible if the message is the last one in the conversation.
+     * @public
+     */
+    predefinedReplies?: (MessagePredefinedReply)[];
+    /**
+     * The time in milliseconds until the message will be visible to the end user.
+     * @public
+     */
+    delay?: number;
+}
+/**
+ * @public
+ */
+export interface CreateWidgetInput {
+    /**
+     * The appearance configuration allows you to customize colors and text settings.
+     * @public
+     */
+    appearance?: WidgetAppearance;
+    /**
+     * A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
+     * @public
+     */
+    routes?: (WidgetRoute)[];
+    /**
+     * A list of welcome messages that will be sent to the user when they first interact with the widget.
+     * @public
+     */
+    welcomeMessages?: (WelcomeMessage)[];
+    name: string;
+    /**
+     * The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
+     * @public
+     */
+    target: WidgetTarget;
+    /**
+     * The unique identifier of the company when a service token is used.
+     * @public
+     */
+    companyId?: string;
+}
+/**
+ * @public
+ */
+export interface Widget {
+    /**
+     * The appearance configuration allows you to customize colors and text settings.
+     * @public
+     */
+    appearance?: WidgetAppearance;
+    /**
+     * A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
+     * @public
+     */
+    routes?: (WidgetRoute)[];
+    /**
+     * A list of welcome messages that will be sent to the user when they first interact with the widget.
+     * @public
+     */
+    welcomeMessages?: (WelcomeMessage)[];
+    name: string;
+    /**
+     * The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
+     * @public
+     */
+    target: WidgetTarget;
+    id: string;
+    company: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+/**
+ * @public
+ */
+export interface CreateWidgetOutput {
+    widget: Widget;
+}
+/**
+ * @public
+ */
+export interface DeleteWidgetInput {
+    /**
+     * The unique identifier of the widget.
+     * @public
+     */
+    widgetId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteWidgetOutput {
+}
+/**
+ * @public
+ */
+export interface GetConfigInput {
+    /**
+     * TODO
+     * @public
+     */
+    targetId: string;
+}
+/**
+ * @public
+ */
+export interface KiteAgent {
+    id: string;
+    name?: string;
+    picture?: string;
+    bot?: boolean;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const KiteFeatures: {
+    readonly SCHEDULING: "scheduling";
+};
+/**
+ * @public
+ */
+export type KiteFeatures = typeof KiteFeatures[keyof typeof KiteFeatures];
+/**
+ * @public
+ * @enum
+ */
+export declare const KiteVariant: {
+    readonly DIRECT: "direct";
+    readonly GROUP: "group";
+};
+/**
+ * @public
+ */
+export type KiteVariant = typeof KiteVariant[keyof typeof KiteVariant];
+/**
+ * @public
+ */
+export interface KiteConfig {
+    /**
+     * The unique identifier of the Kite widget or email of the agent (example: 36cv69ao or vadim.ruban@wildix.com).
+     * @public
+     */
+    targetId: string;
+    /**
+     * The unique identifier of the route for time-based configuration.
+     * @public
+     */
+    targetRouteId?: string;
+    targetVariant?: KiteVariant;
+    agents?: (KiteAgent)[];
+    /**
+     * The appearance settings like color scheme or custom texts.
+     * @public
+     */
+    appearance?: WidgetAppearance;
+    /**
+     * A list of welcome messages that should be visible to the user.
+     * @public
+     */
+    welcomeMessages?: (WelcomeMessage)[];
+    /**
+     * A list of features that are supported.
+     * @public
+     */
+    features?: (KiteFeatures)[];
+}
+/**
+ * @public
+ */
+export interface GetConfigOutput {
+    config: KiteConfig;
+}
+/**
+ * @public
+ */
+export declare class TargetNotFoundException extends __BaseException {
+    readonly name: "TargetNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TargetNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface GetWidgetInput {
+    /**
+     * The unique identifier of the widget.
+     * @public
+     */
+    widgetId: string;
+}
+/**
+ * @public
+ */
+export interface GetWidgetOutput {
+    widget: Widget;
+}
+/**
+ * @public
+ */
+export declare class WidgetNotFoundException extends __BaseException {
+    readonly name: "WidgetNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<WidgetNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ListServicesInput {
+}
+/**
+ * @public
+ */
+export interface ServicePbx {
+    domain: string;
+    port: number;
+}
+/**
+ * @public
+ */
+export interface ServiceSettings {
+}
+/**
+ * @public
+ */
+export interface Service {
+    id: number;
+    title: string;
+    settings: ServiceSettings;
+    members: (User)[];
+    pbx: ServicePbx;
+}
+/**
+ * @public
+ */
+export interface ListServicesOutput {
+    services: (Service)[];
+}
+/**
+ * @public
+ */
+export interface ListWidgetsInput {
+    /**
+     * The unique identifier of the company when a service token is used.
+     * @public
+     */
+    companyId?: string;
+}
+/**
+ * @public
+ */
+export interface ListWidgetsOutput {
+    widgets: (Widget)[];
+}
+/**
+ * @public
+ */
+export interface UpdateWidgetInput {
+    /**
+     * The appearance configuration allows you to customize colors and text settings.
+     * @public
+     */
+    appearance?: WidgetAppearance;
+    /**
+     * A list of routes that define different routing rules for the widget. Each route specifies a set of rules and a target to direct the interaction.
+     * @public
+     */
+    routes?: (WidgetRoute)[];
+    /**
+     * A list of welcome messages that will be sent to the user when they first interact with the widget.
+     * @public
+     */
+    welcomeMessages?: (WelcomeMessage)[];
+    name: string;
+    /**
+     * The primary target for the widget. This target is used if no route rules are matched. The target can be a service, an agent, or a bot, and it specifies where the widget directs its interactions.
+     * @public
+     */
+    target: WidgetTarget;
+    /**
+     * The unique identifier of the company when a service token is used.
+     * @public
+     */
+    companyId?: string;
+    /**
+     * The unique identifier of the widget to be updated.
+     * @public
+     */
+    widgetId: string;
+}
+/**
+ * @public
+ */
+export interface UpdateWidgetOutput {
+    widget: Widget;
+}

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -0,0 +1,65 @@
+import { CreateWidgetCommandInput, CreateWidgetCommandOutput } from "../commands/CreateWidgetCommand";
+import { DeleteWidgetCommandInput, DeleteWidgetCommandOutput } from "../commands/DeleteWidgetCommand";
+import { GetConfigCommandInput, GetConfigCommandOutput } from "../commands/GetConfigCommand";
+import { GetWidgetCommandInput, GetWidgetCommandOutput } from "../commands/GetWidgetCommand";
+import { ListServicesCommandInput, ListServicesCommandOutput } from "../commands/ListServicesCommand";
+import { ListWidgetsCommandInput, ListWidgetsCommandOutput } from "../commands/ListWidgetsCommand";
+import { UpdateWidgetCommandInput, UpdateWidgetCommandOutput } from "../commands/UpdateWidgetCommand";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
+import { SerdeContext as __SerdeContext } from "@smithy/types";
+/**
+ * serializeAws_restJson1CreateWidgetCommand
+ */
+export declare const se_CreateWidgetCommand: (input: CreateWidgetCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1DeleteWidgetCommand
+ */
+export declare const se_DeleteWidgetCommand: (input: DeleteWidgetCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetConfigCommand
+ */
+export declare const se_GetConfigCommand: (input: GetConfigCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetWidgetCommand
+ */
+export declare const se_GetWidgetCommand: (input: GetWidgetCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1ListServicesCommand
+ */
+export declare const se_ListServicesCommand: (input: ListServicesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1ListWidgetsCommand
+ */
+export declare const se_ListWidgetsCommand: (input: ListWidgetsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1UpdateWidgetCommand
+ */
+export declare const se_UpdateWidgetCommand: (input: UpdateWidgetCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * deserializeAws_restJson1CreateWidgetCommand
+ */
+export declare const de_CreateWidgetCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateWidgetCommandOutput>;
+/**
+ * deserializeAws_restJson1DeleteWidgetCommand
+ */
+export declare const de_DeleteWidgetCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteWidgetCommandOutput>;
+/**
+ * deserializeAws_restJson1GetConfigCommand
+ */
+export declare const de_GetConfigCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetConfigCommandOutput>;
+/**
+ * deserializeAws_restJson1GetWidgetCommand
+ */
+export declare const de_GetWidgetCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetWidgetCommandOutput>;
+/**
+ * deserializeAws_restJson1ListServicesCommand
+ */
+export declare const de_ListServicesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListServicesCommandOutput>;
+/**
+ * deserializeAws_restJson1ListWidgetsCommand
+ */
+export declare const de_ListWidgetsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListWidgetsCommandOutput>;
+/**
+ * deserializeAws_restJson1UpdateWidgetCommand
+ */
+export declare const de_UpdateWidgetCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateWidgetCommandOutput>;

package/dist-types/runtimeConfig.browser.d.ts

@@ -0,0 +1,28 @@
+import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
+import { KiteClientConfig } from "./KiteClient";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: KiteClientConfig) => {
+    runtime: string;
+    defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
+    bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
+    defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
+    maxAttempts: number | import("@smithy/types").Provider<number>;
+    requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
+    retryMode: string | import("@smithy/types").Provider<string>;
+    sha256: import("@smithy/types").HashConstructor;
+    streamCollector: import("@smithy/types").StreamCollector;
+    env: "stage" | "stable" | "prod";
+    token: import("@wildix/smithy-utils").TokenProvider;
+    apiVersion: string;
+    urlParser: import("@smithy/types").UrlParser;
+    base64Decoder: import("@smithy/types").Decoder;
+    base64Encoder: (_input: string | Uint8Array) => string;
+    utf8Decoder: import("@smithy/types").Decoder;
+    utf8Encoder: (input: string | Uint8Array) => string;
+    disableHostPrefix: boolean;
+    logger: import("@smithy/types").Logger;
+    extensions: import("./runtimeExtensions").RuntimeExtension[];
+    customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
+};