Skip to main content

@wildix/xbees-kite-client > GetConfigCommand

GetConfigCommand class​

Signature:

export declare class GetConfigCommand extends GetConfigCommand_base

Extends: GetConfigCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { KiteClient, GetConfigCommand } from "@wildix/xbees-kite-client"; // ES Modules import
// const { KiteClient, GetConfigCommand } = require("@wildix/xbees-kite-client"); // CommonJS import
const client = new KiteClient(config);
const input = { // GetConfigInput
  targetId: "STRING_VALUE", // required
  targetRouteId: "STRING_VALUE",
};
const command = new GetConfigCommand(input);
const response = await client.send(command);
// { // GetConfigOutput
//   config: { // KiteConfig
//     targetId: "STRING_VALUE", // required
//     targetRouteId: "STRING_VALUE",
//     targetVariant: "group" || "direct", // required
//     targetService: { // KiteTargetService
//       uri: "STRING_VALUE", // required
//       title: "STRING_VALUE", // required
//     },
//     agents: [ // UsersList // required
//       { // User
//         id: "STRING_VALUE", // required
//         name: "STRING_VALUE",
//         email: "STRING_VALUE",
//         phone: "STRING_VALUE",
//         picture: "STRING_VALUE",
//         locale: "STRING_VALUE",
//         timeZone: "STRING_VALUE",
//         company: "STRING_VALUE",
//         bot: true || false,
//         pbxDomain: "STRING_VALUE",
//         pbxPort: "STRING_VALUE",
//         pbxExtension: "STRING_VALUE",
//         pbxSerial: "STRING_VALUE",
//         pbxUserId: "STRING_VALUE",
//         createdAt: "STRING_VALUE",
//         updatedAt: "STRING_VALUE",
//       },
//     ],
//     appearance: { // WidgetAppearance
//       pallete: { // WidgetPalleteSettings
//         backgroundColor: "STRING_VALUE",
//         accentColor: "STRING_VALUE",
//       },
//       text: { // WidgetTextSettings
//         button: "STRING_VALUE",
//         title: "STRING_VALUE",
//         topTitle: "STRING_VALUE",
//         topSubtitle: "STRING_VALUE",
//       },
//     },
//     welcomeMessages: [ // WidgetWelcomeMessagesList
//       { // WidgetWelcomeMessage
//         text: "STRING_VALUE",
//         elements: [ // ElementsList
//           { // Element Union: only one key present
//             actions: [ // ActionsElementsList
//               { // ActionElement Union: only one key present
//                 button: { // ButtonElement
//                   text: "STRING_VALUE", // required
//                   handler: { // ButtonHandler Union: only one key present
//                     link: { // ButtonLinkHandler
//                       url: "STRING_VALUE", // required
//                     },
//                     reply: { // ButtonReplyHandler
//                       text: "STRING_VALUE",
//                     },
//                     action: { // ButtonActionHandler
//                       id: "STRING_VALUE", // required
//                     },
//                   },
//                   variant: "contained" || "outlined",
//                   disabled: true || false,
//                 },
//               },
//             ],
//           },
//         ],
//         delay: Number("int"),
//       },
//     ],
//     features: [ // KiteFeaturesList
//       "scheduling",
//     ],
//   },
// };