@wildix/xbees-conversations-client 1.0.18

package/dist-types/Conversations.d.ts

@@ -0,0 +1,65 @@
+import { ConversationsClient } from "./ConversationsClient";
+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 { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
+export interface Conversations {
+    /**
+     * @see {@link CreateChannelCommand}
+     */
+    createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelCommandOutput>;
+    createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
+    createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
+    /**
+     * @see {@link CreateMessageCommand}
+     */
+    createMessage(args: CreateMessageCommandInput, options?: __HttpHandlerOptions): Promise<CreateMessageCommandOutput>;
+    createMessage(args: CreateMessageCommandInput, cb: (err: any, data?: CreateMessageCommandOutput) => void): void;
+    createMessage(args: CreateMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMessageCommandOutput) => void): void;
+    /**
+     * @see {@link DeleteChannelCommand}
+     */
+    deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelCommandOutput>;
+    deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
+    deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
+    /**
+     * @see {@link GetChannelCommand}
+     */
+    getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelCommandOutput>;
+    getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
+    getChannel(args: GetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
+    /**
+     * @see {@link GetChannelMemberCommand}
+     */
+    getChannelMember(args: GetChannelMemberCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelMemberCommandOutput>;
+    getChannelMember(args: GetChannelMemberCommandInput, cb: (err: any, data?: GetChannelMemberCommandOutput) => void): void;
+    getChannelMember(args: GetChannelMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMemberCommandOutput) => void): void;
+    /**
+     * @see {@link GetMessageCommand}
+     */
+    getMessage(args: GetMessageCommandInput, options?: __HttpHandlerOptions): Promise<GetMessageCommandOutput>;
+    getMessage(args: GetMessageCommandInput, cb: (err: any, data?: GetMessageCommandOutput) => void): void;
+    getMessage(args: GetMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessageCommandOutput) => void): void;
+    /**
+     * @see {@link PartialUpdateChannelCommand}
+     */
+    partialUpdateChannel(args: PartialUpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise<PartialUpdateChannelCommandOutput>;
+    partialUpdateChannel(args: PartialUpdateChannelCommandInput, cb: (err: any, data?: PartialUpdateChannelCommandOutput) => void): void;
+    partialUpdateChannel(args: PartialUpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PartialUpdateChannelCommandOutput) => void): void;
+    /**
+     * @see {@link UpdateChannelCommand}
+     */
+    updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelCommandOutput>;
+    updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
+    updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
+}
+/**
+ * @public
+ */
+export declare class Conversations extends ConversationsClient implements Conversations {
+}

package/dist-types/ConversationsClient.d.ts

@@ -0,0 +1,144 @@
+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 { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
+import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
+import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
+import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser } from "@smithy/types";
+import { TokenProvider } from '@wildix/smithy-utils';
+export { __Client };
+/**
+ * @public
+ */
+export type ServiceInputTypes = CreateChannelCommandInput | CreateMessageCommandInput | DeleteChannelCommandInput | GetChannelCommandInput | GetChannelMemberCommandInput | GetMessageCommandInput | PartialUpdateChannelCommandInput | UpdateChannelCommandInput;
+/**
+ * @public
+ */
+export type ServiceOutputTypes = CreateChannelCommandOutput | CreateMessageCommandOutput | DeleteChannelCommandOutput | GetChannelCommandOutput | GetChannelMemberCommandOutput | GetMessageCommandOutput | PartialUpdateChannelCommandOutput | UpdateChannelCommandOutput;
+/**
+ * @public
+ */
+export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
+    /**
+     * The HTTP handler to use. Fetch in browser and Https in Nodejs.
+     */
+    requestHandler?: __HttpHandler;
+    /**
+     * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
+     * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
+     * @internal
+     */
+    sha256?: __ChecksumConstructor | __HashConstructor;
+    /**
+     * The function that will be used to convert strings into HTTP endpoints.
+     * @internal
+     */
+    urlParser?: __UrlParser;
+    /**
+     * A function that can calculate the length of a request body.
+     * @internal
+     */
+    bodyLengthChecker?: __BodyLengthCalculator;
+    /**
+     * A function that converts a stream into an array of bytes.
+     * @internal
+     */
+    streamCollector?: __StreamCollector;
+    /**
+     * The function that will be used to convert a base64-encoded string to a byte array.
+     * @internal
+     */
+    base64Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a base64-encoded string.
+     * @internal
+     */
+    base64Encoder?: __Encoder;
+    /**
+     * The function that will be used to convert a UTF8-encoded string to a byte array.
+     * @internal
+     */
+    utf8Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a UTF-8 encoded string.
+     * @internal
+     */
+    utf8Encoder?: __Encoder;
+    /**
+     * The runtime environment.
+     * @internal
+     */
+    runtime?: string;
+    /**
+     * Disable dynamically changing the endpoint of the client based on the hostPrefix
+     * trait of an operation.
+     */
+    disableHostPrefix?: boolean;
+    /**
+     * Value for how many times a request will be made at most in case of retry.
+     */
+    maxAttempts?: number | __Provider<number>;
+    /**
+     * Specifies which retry algorithm to use.
+     * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
+     *
+     */
+    retryMode?: string | __Provider<string>;
+    /**
+     * Optional logger for logging debug/info/warn/error.
+     */
+    logger?: __Logger;
+    /**
+     * Optional extensions
+     */
+    extensions?: RuntimeExtension[];
+    /**
+     * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     */
+    defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
+}
+/**
+ * @public
+ */
+export type ConversationsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults;
+/**
+ * @public
+ *
+ *  The configuration interface of ConversationsClient class constructor that set the region, credentials and other options.
+ */
+export interface ConversationsClientConfig extends ConversationsClientConfigType {
+    env: 'stage' | 'stable' | 'prod';
+    token: TokenProvider;
+}
+/**
+ * @public
+ */
+export type ConversationsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig;
+/**
+ * @public
+ *
+ *  The resolved configuration interface of ConversationsClient class. This is resolved and normalized from the {@link ConversationsClientConfig | constructor configuration interface}.
+ */
+export interface ConversationsClientResolvedConfig extends ConversationsClientResolvedConfigType {
+}
+/**
+ * @public
+ */
+export declare class ConversationsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConversationsClientResolvedConfig> {
+    /**
+     * The resolved configuration of ConversationsClient class. This is resolved and normalized from the {@link ConversationsClientConfig | constructor configuration interface}.
+     */
+    readonly config: ConversationsClientResolvedConfig;
+    constructor(...[configuration]: __CheckOptionalClientConfig<ConversationsClientConfig>);
+    /**
+     * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+     * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+     * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+     */
+    destroy(): void;
+}

package/dist-types/commands/CreateChannelCommand.d.ts

@@ -0,0 +1,194 @@
+import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
+import { CreateChannelInput, CreateChannelOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateChannelCommand}.
+ */
+export interface CreateChannelCommandInput extends CreateChannelInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateChannelCommand}.
+ */
+export interface CreateChannelCommandOutput extends CreateChannelOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConversationsClient, CreateChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
+ * // const { ConversationsClient, CreateChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
+ * const client = new ConversationsClient(config);
+ * const input = { // CreateChannelInput
+ *   channel: { // ChannelCreateFields
+ *     subject: "STRING_VALUE",
+ *     description: "STRING_VALUE",
+ *     picture: "STRING_VALUE",
+ *     pictureColor: "STRING_VALUE",
+ *     access: "private" || "public",
+ *     company: "STRING_VALUE",
+ *     context: { // ChannelContext
+ *       source: "kite",
+ *       target: "STRING_VALUE",
+ *       events: [ // ChannelContextEventList
+ *         { // ChannelContextEvent
+ *           id: "STRING_VALUE",
+ *           owner: "STRING_VALUE",
+ *           start: "STRING_VALUE",
+ *           end: "STRING_VALUE",
+ *           summary: "STRING_VALUE",
+ *           attendees: [ // ChannelContextEventAttendeeList
+ *             { // ChannelContextEventAttendee
+ *               email: "STRING_VALUE", // required
+ *               name: "STRING_VALUE",
+ *               status: "accepted" || "tentative" || "declined" || "none", // required
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *     },
+ *     kite: true || false,
+ *     kiteTarget: "STRING_VALUE",
+ *     kiteVariant: "STRING_VALUE",
+ *     kiteAssign: "STRING_VALUE",
+ *     kiteServiceName: "STRING_VALUE",
+ *     kiteDefaultSubject: "STRING_VALUE",
+ *     service: "STRING_VALUE",
+ *     serviceTitle: "STRING_VALUE",
+ *     serviceRecipient: "STRING_VALUE",
+ *     assignee: { // User
+ *       id: "STRING_VALUE", // required
+ *       name: "STRING_VALUE",
+ *       email: "STRING_VALUE",
+ *       phone: "STRING_VALUE",
+ *       picture: "STRING_VALUE",
+ *       company: "STRING_VALUE",
+ *       pbxDomain: "STRING_VALUE",
+ *       pbxPort: "STRING_VALUE",
+ *       pbxExtension: "STRING_VALUE",
+ *       pbxSerial: "STRING_VALUE",
+ *       pbxUserId: "STRING_VALUE",
+ *       createdAt: "STRING_VALUE",
+ *       updatedAt: "STRING_VALUE",
+ *     },
+ *     telephony: true || false,
+ *     sms: true || false,
+ *     broadcast: true || false,
+ *     external: true || false,
+ *     channelId: "STRING_VALUE",
+ *     channelType: "direct" || "group", // required
+ *     members: [ // ChannelCreateFieldsMembersList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ * };
+ * const command = new CreateChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateChannelOutput
+ * //   channel: { // Channel
+ * //     subject: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
+ * //     picture: "STRING_VALUE",
+ * //     pictureColor: "STRING_VALUE",
+ * //     access: "private" || "public",
+ * //     company: "STRING_VALUE",
+ * //     context: { // ChannelContext
+ * //       source: "kite",
+ * //       target: "STRING_VALUE",
+ * //       events: [ // ChannelContextEventList
+ * //         { // ChannelContextEvent
+ * //           id: "STRING_VALUE",
+ * //           owner: "STRING_VALUE",
+ * //           start: "STRING_VALUE",
+ * //           end: "STRING_VALUE",
+ * //           summary: "STRING_VALUE",
+ * //           attendees: [ // ChannelContextEventAttendeeList
+ * //             { // ChannelContextEventAttendee
+ * //               email: "STRING_VALUE", // required
+ * //               name: "STRING_VALUE",
+ * //               status: "accepted" || "tentative" || "declined" || "none", // required
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
+ * //     kite: true || false,
+ * //     kiteTarget: "STRING_VALUE",
+ * //     kiteVariant: "STRING_VALUE",
+ * //     kiteAssign: "STRING_VALUE",
+ * //     kiteServiceName: "STRING_VALUE",
+ * //     kiteDefaultSubject: "STRING_VALUE",
+ * //     service: "STRING_VALUE",
+ * //     serviceTitle: "STRING_VALUE",
+ * //     serviceRecipient: "STRING_VALUE",
+ * //     assignee: { // User
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       phone: "STRING_VALUE",
+ * //       picture: "STRING_VALUE",
+ * //       company: "STRING_VALUE",
+ * //       pbxDomain: "STRING_VALUE",
+ * //       pbxPort: "STRING_VALUE",
+ * //       pbxExtension: "STRING_VALUE",
+ * //       pbxSerial: "STRING_VALUE",
+ * //       pbxUserId: "STRING_VALUE",
+ * //       createdAt: "STRING_VALUE",
+ * //       updatedAt: "STRING_VALUE",
+ * //     },
+ * //     telephony: true || false,
+ * //     sms: true || false,
+ * //     broadcast: true || false,
+ * //     external: true || false,
+ * //     channelId: "STRING_VALUE", // required
+ * //     channelType: "direct" || "group", // required
+ * //     memberCount: Number("int"), // required
+ * //     createdAt: "STRING_VALUE", // required
+ * //     createdBy: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
+ * @returns {@link CreateChannelCommandOutput}
+ * @see {@link CreateChannelCommandInput} for command's `input` shape.
+ * @see {@link CreateChannelCommandOutput} for command's `response` shape.
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link ConversationsServiceException}
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
+ *
+ */
+export declare class CreateChannelCommand extends $Command<CreateChannelCommandInput, CreateChannelCommandOutput, ConversationsClientResolvedConfig> {
+    readonly input: CreateChannelCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: CreateChannelCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelCommandInput, CreateChannelCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}