@wildix/xbees-conversations-client 1.0.18

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

@@ -0,0 +1,508 @@
+import { ConversationsServiceException as __BaseException } from "./ConversationsServiceException";
+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
+ * @enum
+ */
+export declare const ChannelAccess: {
+    readonly PRIVATE: "private";
+    readonly PUBLIC: "public";
+};
+/**
+ * @public
+ */
+export type ChannelAccess = typeof ChannelAccess[keyof typeof ChannelAccess];
+/**
+ * @public
+ */
+export interface User {
+    id: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    picture?: string;
+    company?: string;
+    pbxDomain?: string;
+    pbxPort?: string;
+    pbxExtension?: string;
+    pbxSerial?: string;
+    pbxUserId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelType: {
+    readonly DIRECT: "direct";
+    readonly GROUP: "group";
+};
+/**
+ * @public
+ */
+export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextEventAttendeeStatus: {
+    readonly ACCEPTED: "accepted";
+    readonly DECLINED: "declined";
+    readonly NONE: "none";
+    readonly TENTATIVE: "tentative";
+};
+/**
+ * @public
+ */
+export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttendeeStatus[keyof typeof ChannelContextEventAttendeeStatus];
+/**
+ * @public
+ */
+export interface ChannelContextEventAttendee {
+    email: string;
+    name?: string;
+    status: ChannelContextEventAttendeeStatus | string;
+}
+/**
+ * @public
+ */
+export interface ChannelContextEvent {
+    id?: string;
+    owner?: string;
+    start?: string;
+    end?: string;
+    summary?: string;
+    attendees?: (ChannelContextEventAttendee)[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextSource: {
+    readonly KITE: "kite";
+};
+/**
+ * @public
+ */
+export type ChannelContextSource = typeof ChannelContextSource[keyof typeof ChannelContextSource];
+/**
+ * @public
+ */
+export interface ChannelContext {
+    source?: ChannelContextSource | string;
+    target?: string;
+    events?: (ChannelContextEvent)[];
+}
+/**
+ * @public
+ */
+export interface Channel {
+    subject?: string;
+    description?: string;
+    /**
+     * @public
+     * Picture URL
+     */
+    picture?: string;
+    /**
+     * @public
+     * Picture dominant color represented by a hex value.
+     */
+    pictureColor?: string;
+    access?: ChannelAccess | string;
+    company?: string;
+    context?: ChannelContext;
+    kite?: boolean;
+    kiteTarget?: string;
+    kiteVariant?: string;
+    kiteAssign?: string;
+    kiteServiceName?: string;
+    kiteDefaultSubject?: string;
+    service?: string;
+    serviceTitle?: string;
+    serviceRecipient?: string;
+    assignee?: User;
+    telephony?: boolean;
+    sms?: boolean;
+    broadcast?: boolean;
+    external?: boolean;
+    channelId: string;
+    channelType: ChannelType | string;
+    memberCount: number;
+    createdAt: string;
+    createdBy: string;
+    updatedAt?: string;
+}
+/**
+ * @public
+ */
+export interface ChannelCreateFields {
+    subject?: string;
+    description?: string;
+    /**
+     * @public
+     * Picture URL
+     */
+    picture?: string;
+    /**
+     * @public
+     * Picture dominant color represented by a hex value.
+     */
+    pictureColor?: string;
+    access?: ChannelAccess | string;
+    company?: string;
+    context?: ChannelContext;
+    kite?: boolean;
+    kiteTarget?: string;
+    kiteVariant?: string;
+    kiteAssign?: string;
+    kiteServiceName?: string;
+    kiteDefaultSubject?: string;
+    service?: string;
+    serviceTitle?: string;
+    serviceRecipient?: string;
+    assignee?: User;
+    telephony?: boolean;
+    sms?: boolean;
+    broadcast?: boolean;
+    external?: boolean;
+    channelId?: string;
+    channelType: ChannelType | string;
+    members?: (string)[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelMemberRole: {
+    readonly MEMBER: "member";
+    readonly SUPERVISOR: "supervisor";
+};
+/**
+ * @public
+ */
+export type ChannelMemberRole = typeof ChannelMemberRole[keyof typeof ChannelMemberRole];
+/**
+ * @public
+ */
+export interface ChannelMember {
+    id: string;
+    createdAt: string;
+    role: ChannelMemberRole | string;
+}
+/**
+ * @public
+ */
+export declare class ChannelNotFoundException extends __BaseException {
+    readonly name: "ChannelNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelUnsetFields: {
+    readonly ACCESS: "access";
+    readonly ASSIGNEE: "assignee";
+    readonly BROADCAST: "broadcast";
+    readonly COMPANY: "company";
+    readonly CONTEXT: "context";
+    readonly DESCRIPTION: "description";
+    readonly EXTERNAL: "external";
+    readonly KITE: "kite";
+    readonly KITE_ASSIGN: "kiteAssign";
+    readonly KITE_DEFAULT_SUBJECT: "kiteDefaultSubject";
+    readonly KITE_SERVICE_NAME: "kiteServiceName";
+    readonly KITE_TARGET: "kiteTarget";
+    readonly KITE_VARIANT: "kiteVariant";
+    readonly PICTURE: "picture";
+    readonly PICTURE_COLOR: "pictureColor";
+    readonly SERVICE: "service";
+    readonly SERVICE_RECIPIENT: "serviceRecipient";
+    readonly SERVICE_TITLE: "serviceTitle";
+    readonly SMS: "sms";
+    readonly SUBJECT: "subject";
+    readonly TELEPHONY: "telephony";
+};
+/**
+ * @public
+ */
+export type ChannelUnsetFields = typeof ChannelUnsetFields[keyof typeof ChannelUnsetFields];
+/**
+ * @public
+ */
+export interface ChannelUpdateFields {
+    subject?: string;
+    description?: string;
+    /**
+     * @public
+     * Picture URL
+     */
+    picture?: string;
+    /**
+     * @public
+     * Picture dominant color represented by a hex value.
+     */
+    pictureColor?: string;
+    access?: ChannelAccess | string;
+    company?: string;
+    context?: ChannelContext;
+    kite?: boolean;
+    kiteTarget?: string;
+    kiteVariant?: string;
+    kiteAssign?: string;
+    kiteServiceName?: string;
+    kiteDefaultSubject?: string;
+    service?: string;
+    serviceTitle?: string;
+    serviceRecipient?: string;
+    assignee?: User;
+    telephony?: boolean;
+    sms?: boolean;
+    broadcast?: boolean;
+    external?: boolean;
+}
+/**
+ * @public
+ */
+export interface CreateChannelInput {
+    channel: ChannelCreateFields;
+}
+/**
+ * @public
+ */
+export interface CreateChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface MessageAttachment {
+    id: string;
+    /**
+     * @public
+     * This *is* documentation about the field. Describe here what fsId and how to get it.
+     */
+    fsId: string;
+    mime?: string;
+    name?: string;
+    size: number;
+    width?: number;
+    height?: number;
+    thumbnail?: string;
+}
+/**
+ * @public
+ */
+export interface MessageForward {
+    forwardCompany?: string;
+    forwardDate: string;
+    forwardEmail?: string;
+    forwardName?: string;
+}
+/**
+ * @public
+ */
+export interface MessageGiphy {
+    id?: string;
+    size?: string;
+    url?: string;
+    height?: string;
+    width?: string;
+}
+/**
+ * @public
+ */
+export interface Reaction {
+    type?: string;
+    userId?: string;
+    messageId?: string;
+    user?: User;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageSmsStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageType: {
+    readonly REGULAR: "regular";
+};
+/**
+ * @public
+ */
+export type MessageType = typeof MessageType[keyof typeof MessageType];
+/**
+ * @public
+ */
+export interface DeleteChannelInput {
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteChannelOutput {
+}
+/**
+ * @public
+ */
+export interface GetChannelInput {
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface GetChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface GetChannelMemberInput {
+    channelId: string;
+    memberId: string;
+}
+/**
+ * @public
+ */
+export interface GetChannelMemberOutput {
+    member: ChannelMember;
+}
+/**
+ * @public
+ */
+export declare class MemberNotFoundException extends __BaseException {
+    readonly name: "MemberNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MemberNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface GetMessageInput {
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface PartialUpdateChannelInput {
+    channelId: string;
+    set?: ChannelUpdateFields;
+    unset?: (ChannelUnsetFields | string)[];
+}
+/**
+ * @public
+ */
+export interface PartialUpdateChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface UpdateChannelInput {
+    channelId: string;
+    channel: ChannelUpdateFields;
+}
+/**
+ * @public
+ */
+export interface UpdateChannelOutput {
+    channel: Channel;
+}
+/**
+ * @public
+ */
+export interface Message {
+    type: MessageType | string;
+    text?: string;
+    silent?: boolean;
+    event?: string;
+    attachments?: (MessageAttachment)[];
+    giphy?: MessageGiphy;
+    quote?: Message;
+    forward?: MessageForward;
+    sms?: boolean;
+    smsStatus?: MessageSmsStatus | string;
+    messageId: string;
+    channelId: string;
+    user: User;
+    edit?: boolean;
+    mentions?: (User)[];
+    latestReactions?: (Reaction)[];
+    reactionCounts?: Record<string, number>;
+    createdAt: string;
+    updatedAt?: string;
+}
+/**
+ * @public
+ */
+export interface CreateMessageOutput {
+    message?: Message;
+}
+/**
+ * @public
+ */
+export interface GetMessageOutput {
+    message?: Message;
+}
+/**
+ * @public
+ * An interface of available options for new message command
+ */
+export interface MessageCreateFields {
+    type: MessageType | string;
+    text?: string;
+    silent?: boolean;
+    event?: string;
+    attachments?: (MessageAttachment)[];
+    giphy?: MessageGiphy;
+    quote?: Message;
+    forward?: MessageForward;
+    sms?: boolean;
+    smsStatus?: MessageSmsStatus | string;
+    messageId?: string;
+    mentions?: (string)[];
+}
+/**
+ * @public
+ */
+export interface CreateMessageInput {
+    channelId: string;
+    userId: string;
+    /**
+     * @public
+     * An interface of available options for new message command
+     */
+    message: MessageCreateFields;
+}

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

@@ -0,0 +1,74 @@
+import { CreateChannelCommandInput, CreateChannelCommandOutput } from "../commands/CreateChannelCommand";
+import { CreateMessageCommandInput, CreateMessageCommandOutput } from "../commands/CreateMessageCommand";
+import { DeleteChannelCommandInput, DeleteChannelCommandOutput } from "../commands/DeleteChannelCommand";
+import { GetChannelCommandInput, GetChannelCommandOutput } from "../commands/GetChannelCommand";
+import { GetChannelMemberCommandInput, GetChannelMemberCommandOutput } from "../commands/GetChannelMemberCommand";
+import { GetMessageCommandInput, GetMessageCommandOutput } from "../commands/GetMessageCommand";
+import { PartialUpdateChannelCommandInput, PartialUpdateChannelCommandOutput } from "../commands/PartialUpdateChannelCommand";
+import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "../commands/UpdateChannelCommand";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
+import { SerdeContext as __SerdeContext } from "@smithy/types";
+/**
+ * serializeAws_restJson1CreateChannelCommand
+ */
+export declare const se_CreateChannelCommand: (input: CreateChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1CreateMessageCommand
+ */
+export declare const se_CreateMessageCommand: (input: CreateMessageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1DeleteChannelCommand
+ */
+export declare const se_DeleteChannelCommand: (input: DeleteChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetChannelCommand
+ */
+export declare const se_GetChannelCommand: (input: GetChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetChannelMemberCommand
+ */
+export declare const se_GetChannelMemberCommand: (input: GetChannelMemberCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetMessageCommand
+ */
+export declare const se_GetMessageCommand: (input: GetMessageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1PartialUpdateChannelCommand
+ */
+export declare const se_PartialUpdateChannelCommand: (input: PartialUpdateChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1UpdateChannelCommand
+ */
+export declare const se_UpdateChannelCommand: (input: UpdateChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * deserializeAws_restJson1CreateChannelCommand
+ */
+export declare const de_CreateChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateChannelCommandOutput>;
+/**
+ * deserializeAws_restJson1CreateMessageCommand
+ */
+export declare const de_CreateMessageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateMessageCommandOutput>;
+/**
+ * deserializeAws_restJson1DeleteChannelCommand
+ */
+export declare const de_DeleteChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteChannelCommandOutput>;
+/**
+ * deserializeAws_restJson1GetChannelCommand
+ */
+export declare const de_GetChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetChannelCommandOutput>;
+/**
+ * deserializeAws_restJson1GetChannelMemberCommand
+ */
+export declare const de_GetChannelMemberCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetChannelMemberCommandOutput>;
+/**
+ * deserializeAws_restJson1GetMessageCommand
+ */
+export declare const de_GetMessageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetMessageCommandOutput>;
+/**
+ * deserializeAws_restJson1PartialUpdateChannelCommand
+ */
+export declare const de_PartialUpdateChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PartialUpdateChannelCommandOutput>;
+/**
+ * deserializeAws_restJson1UpdateChannelCommand
+ */
+export declare const de_UpdateChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateChannelCommandOutput>;

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

@@ -0,0 +1,29 @@
+import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
+import { ConversationsClientConfig } from "./ConversationsClient";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: ConversationsClientConfig) => {
+    runtime: string;
+    defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
+    bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
+    maxAttempts: number | import("@smithy/types").Provider<number>;
+    requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
+        updateHttpClientConfig(key: never, value: never): void;
+        httpHandlerConfigs(): {};
+    }) | 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: import("@smithy/types").Encoder;
+    utf8Decoder: import("@smithy/types").Decoder;
+    utf8Encoder: import("@smithy/types").Encoder;
+    disableHostPrefix: boolean;
+    logger: import("@smithy/types").Logger;
+    extensions: import("./runtimeExtensions").RuntimeExtension[];
+};

package/dist-types/runtimeConfig.d.ts

@@ -0,0 +1,29 @@
+import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
+import { ConversationsClientConfig } from "./ConversationsClient";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: ConversationsClientConfig) => {
+    runtime: string;
+    defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
+    bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
+    maxAttempts: number | import("@smithy/types").Provider<number>;
+    requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
+        updateHttpClientConfig(key: never, value: never): void;
+        httpHandlerConfigs(): {};
+    }) | 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: import("@smithy/types").Encoder;
+    utf8Decoder: import("@smithy/types").Decoder;
+    utf8Encoder: import("@smithy/types").Encoder;
+    disableHostPrefix: boolean;
+    logger: import("@smithy/types").Logger;
+    extensions: import("./runtimeExtensions").RuntimeExtension[];
+};

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

@@ -0,0 +1,28 @@
+import { ConversationsClientConfig } from "./ConversationsClient";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: ConversationsClientConfig) => {
+    runtime: string;
+    sha256: import("@smithy/types").HashConstructor;
+    env: "stage" | "stable" | "prod";
+    token: import("@wildix/smithy-utils").TokenProvider;
+    requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
+        updateHttpClientConfig(key: never, value: never): void;
+        httpHandlerConfigs(): {};
+    }) | import("@smithy/fetch-http-handler").FetchHttpHandler;
+    apiVersion: string;
+    urlParser: import("@smithy/types").UrlParser;
+    bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
+    streamCollector: import("@smithy/types").StreamCollector;
+    base64Decoder: import("@smithy/types").Decoder;
+    base64Encoder: import("@smithy/types").Encoder;
+    utf8Decoder: import("@smithy/types").Decoder;
+    utf8Encoder: import("@smithy/types").Encoder;
+    disableHostPrefix: boolean;
+    maxAttempts: number | import("@smithy/types").Provider<number>;
+    retryMode: string | import("@smithy/types").Provider<string>;
+    logger: import("@smithy/types").Logger;
+    extensions: import("./runtimeExtensions").RuntimeExtension[];
+    defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
+};

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

@@ -0,0 +1,15 @@
+import { ConversationsClientConfig } from "./ConversationsClient";
+/**
+ * @internal
+ */
+export declare const getRuntimeConfig: (config: ConversationsClientConfig) => {
+    apiVersion: string;
+    base64Decoder: import("@smithy/types").Decoder;
+    base64Encoder: import("@smithy/types").Encoder;
+    disableHostPrefix: boolean;
+    extensions: import("./runtimeExtensions").RuntimeExtension[];
+    logger: import("@smithy/types").Logger;
+    urlParser: import("@smithy/types").UrlParser;
+    utf8Decoder: import("@smithy/types").Decoder;
+    utf8Encoder: import("@smithy/types").Encoder;
+};

package/dist-types/runtimeExtensions.d.ts

@@ -0,0 +1,17 @@
+import { ConversationsExtensionConfiguration } from "./extensionConfiguration";
+/**
+ * @public
+ */
+export interface RuntimeExtension {
+    configure(extensionConfiguration: ConversationsExtensionConfiguration): void;
+}
+/**
+ * @public
+ */
+export interface RuntimeExtensionsConfig {
+    extensions: RuntimeExtension[];
+}
+/**
+ * @internal
+ */
+export declare const resolveRuntimeExtensions: (runtimeConfig: any, extensions: RuntimeExtension[]) => any;