@wildix/xbees-conversations-client 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/Conversations.js +14 -0
- package/dist-cjs/commands/CreateKiteChannelCommand.js +21 -0
- package/dist-cjs/commands/GetActionTriggerResultCommand.js +21 -0
- package/dist-cjs/commands/ListPinnedMessagesCommand.js +21 -0
- package/dist-cjs/commands/PinMessageCommand.js +21 -0
- package/dist-cjs/commands/SendActionTriggerResultCommand.js +21 -0
- package/dist-cjs/commands/TriggerMessageActionCommand.js +21 -0
- package/dist-cjs/commands/UnpinMessageCommand.js +21 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +107 -12
- package/dist-cjs/protocols/Aws_restJson1.js +302 -2
- package/dist-es/Conversations.js +14 -0
- package/dist-es/commands/CreateKiteChannelCommand.js +17 -0
- package/dist-es/commands/GetActionTriggerResultCommand.js +17 -0
- package/dist-es/commands/ListPinnedMessagesCommand.js +17 -0
- package/dist-es/commands/PinMessageCommand.js +17 -0
- package/dist-es/commands/SendActionTriggerResultCommand.js +17 -0
- package/dist-es/commands/TriggerMessageActionCommand.js +17 -0
- package/dist-es/commands/UnpinMessageCommand.js +17 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +102 -11
- package/dist-es/protocols/Aws_restJson1.js +286 -1
- package/dist-types/Conversations.d.ts +49 -0
- package/dist-types/ConversationsClient.d.ts +9 -2
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +240 -0
- package/dist-types/commands/DescribeEventCommand.d.ts +144 -9
- package/dist-types/commands/GetActionTriggerResultCommand.d.ts +70 -0
- package/dist-types/commands/GetMessageCommand.d.ts +24 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +24 -0
- package/dist-types/commands/ListPinnedMessagesCommand.d.ts +224 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +53 -1
- package/dist-types/commands/PinMessageCommand.d.ts +73 -0
- package/dist-types/commands/SendActionTriggerResultCommand.d.ts +68 -0
- package/dist-types/commands/SendGiphyCommand.d.ts +24 -0
- package/dist-types/commands/SendMessageCommand.d.ts +48 -0
- package/dist-types/commands/TriggerMessageActionCommand.d.ts +75 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +71 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +49 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +578 -102
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/package.json +1 -1
|
@@ -42,7 +42,7 @@ declare const DescribeEventCommand_base: {
|
|
|
42
42
|
* // WebhookChatChannelCreatedEvent: { // WebhookChatChannelCreatedEvent
|
|
43
43
|
* // id: "STRING_VALUE", // required
|
|
44
44
|
* // company: "STRING_VALUE", // required
|
|
45
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
45
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
46
46
|
* // time: Number("long"), // required
|
|
47
47
|
* // integrationId: "STRING_VALUE",
|
|
48
48
|
* // botId: "STRING_VALUE",
|
|
@@ -147,7 +147,7 @@ declare const DescribeEventCommand_base: {
|
|
|
147
147
|
* // WebhookChatChannelUpdatedEvent: { // WebhookChatChannelUpdatedEvent
|
|
148
148
|
* // id: "STRING_VALUE", // required
|
|
149
149
|
* // company: "STRING_VALUE", // required
|
|
150
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
150
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
151
151
|
* // time: Number("long"), // required
|
|
152
152
|
* // integrationId: "STRING_VALUE",
|
|
153
153
|
* // botId: "STRING_VALUE",
|
|
@@ -252,7 +252,7 @@ declare const DescribeEventCommand_base: {
|
|
|
252
252
|
* // WebhookChatMemberAddedEvent: { // WebhookChatMemberAddedEvent
|
|
253
253
|
* // id: "STRING_VALUE", // required
|
|
254
254
|
* // company: "STRING_VALUE", // required
|
|
255
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
255
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
256
256
|
* // time: Number("long"), // required
|
|
257
257
|
* // integrationId: "STRING_VALUE",
|
|
258
258
|
* // botId: "STRING_VALUE",
|
|
@@ -336,7 +336,7 @@ declare const DescribeEventCommand_base: {
|
|
|
336
336
|
* // WebhookChatMemberRemovedEvent: { // WebhookChatMemberRemovedEvent
|
|
337
337
|
* // id: "STRING_VALUE", // required
|
|
338
338
|
* // company: "STRING_VALUE", // required
|
|
339
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
339
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
340
340
|
* // time: Number("long"), // required
|
|
341
341
|
* // integrationId: "STRING_VALUE",
|
|
342
342
|
* // botId: "STRING_VALUE",
|
|
@@ -403,7 +403,7 @@ declare const DescribeEventCommand_base: {
|
|
|
403
403
|
* // WebhookChatMessageNewEvent: { // WebhookChatMessageNewEvent
|
|
404
404
|
* // id: "STRING_VALUE", // required
|
|
405
405
|
* // company: "STRING_VALUE", // required
|
|
406
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
406
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
407
407
|
* // time: Number("long"), // required
|
|
408
408
|
* // integrationId: "STRING_VALUE",
|
|
409
409
|
* // botId: "STRING_VALUE",
|
|
@@ -471,6 +471,30 @@ declare const DescribeEventCommand_base: {
|
|
|
471
471
|
* // ],
|
|
472
472
|
* // message: { // Message
|
|
473
473
|
* // text: "STRING_VALUE",
|
|
474
|
+
* // elements: [ // ElementsList
|
|
475
|
+
* // { // Element Union: only one key present
|
|
476
|
+
* // actions: [ // ActionsElementsList
|
|
477
|
+
* // { // ActionElement Union: only one key present
|
|
478
|
+
* // button: { // ButtonElement
|
|
479
|
+
* // text: "STRING_VALUE", // required
|
|
480
|
+
* // variant: "contained" || "outlined",
|
|
481
|
+
* // disabled: true || false,
|
|
482
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
483
|
+
* // link: { // ButtonLinkHandler
|
|
484
|
+
* // url: "STRING_VALUE", // required
|
|
485
|
+
* // },
|
|
486
|
+
* // reply: { // ButtonReplyHandler
|
|
487
|
+
* // text: "STRING_VALUE",
|
|
488
|
+
* // },
|
|
489
|
+
* // action: { // ButtonActionHandler
|
|
490
|
+
* // id: "STRING_VALUE", // required
|
|
491
|
+
* // },
|
|
492
|
+
* // },
|
|
493
|
+
* // },
|
|
494
|
+
* // },
|
|
495
|
+
* // ],
|
|
496
|
+
* // },
|
|
497
|
+
* // ],
|
|
474
498
|
* // attachments: [ // MessageAttachmentList
|
|
475
499
|
* // { // MessageAttachment
|
|
476
500
|
* // id: "STRING_VALUE", // required
|
|
@@ -567,7 +591,7 @@ declare const DescribeEventCommand_base: {
|
|
|
567
591
|
* // WebhookChatMessageUpdatedEvent: { // WebhookChatMessageUpdatedEvent
|
|
568
592
|
* // id: "STRING_VALUE", // required
|
|
569
593
|
* // company: "STRING_VALUE", // required
|
|
570
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
594
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
571
595
|
* // time: Number("long"), // required
|
|
572
596
|
* // integrationId: "STRING_VALUE",
|
|
573
597
|
* // botId: "STRING_VALUE",
|
|
@@ -575,6 +599,30 @@ declare const DescribeEventCommand_base: {
|
|
|
575
599
|
* // channel: "<Channel>", // required
|
|
576
600
|
* // message: {
|
|
577
601
|
* // text: "STRING_VALUE",
|
|
602
|
+
* // elements: [
|
|
603
|
+
* // {// Union: only one key present
|
|
604
|
+
* // actions: [
|
|
605
|
+
* // {// Union: only one key present
|
|
606
|
+
* // button: {
|
|
607
|
+
* // text: "STRING_VALUE", // required
|
|
608
|
+
* // variant: "contained" || "outlined",
|
|
609
|
+
* // disabled: true || false,
|
|
610
|
+
* // handler: {// Union: only one key present
|
|
611
|
+
* // link: {
|
|
612
|
+
* // url: "STRING_VALUE", // required
|
|
613
|
+
* // },
|
|
614
|
+
* // reply: {
|
|
615
|
+
* // text: "STRING_VALUE",
|
|
616
|
+
* // },
|
|
617
|
+
* // action: {
|
|
618
|
+
* // id: "STRING_VALUE", // required
|
|
619
|
+
* // },
|
|
620
|
+
* // },
|
|
621
|
+
* // },
|
|
622
|
+
* // },
|
|
623
|
+
* // ],
|
|
624
|
+
* // },
|
|
625
|
+
* // ],
|
|
578
626
|
* // attachments: [
|
|
579
627
|
* // {
|
|
580
628
|
* // id: "STRING_VALUE", // required
|
|
@@ -669,7 +717,7 @@ declare const DescribeEventCommand_base: {
|
|
|
669
717
|
* // WebhookChatMessageDeletedEvent: { // WebhookChatMessageDeletedEvent
|
|
670
718
|
* // id: "STRING_VALUE", // required
|
|
671
719
|
* // company: "STRING_VALUE", // required
|
|
672
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
720
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
673
721
|
* // time: Number("long"), // required
|
|
674
722
|
* // integrationId: "STRING_VALUE",
|
|
675
723
|
* // botId: "STRING_VALUE",
|
|
@@ -677,6 +725,30 @@ declare const DescribeEventCommand_base: {
|
|
|
677
725
|
* // channel: "<Channel>", // required
|
|
678
726
|
* // message: {
|
|
679
727
|
* // text: "STRING_VALUE",
|
|
728
|
+
* // elements: [
|
|
729
|
+
* // {// Union: only one key present
|
|
730
|
+
* // actions: [
|
|
731
|
+
* // {// Union: only one key present
|
|
732
|
+
* // button: {
|
|
733
|
+
* // text: "STRING_VALUE", // required
|
|
734
|
+
* // variant: "contained" || "outlined",
|
|
735
|
+
* // disabled: true || false,
|
|
736
|
+
* // handler: {// Union: only one key present
|
|
737
|
+
* // link: {
|
|
738
|
+
* // url: "STRING_VALUE", // required
|
|
739
|
+
* // },
|
|
740
|
+
* // reply: {
|
|
741
|
+
* // text: "STRING_VALUE",
|
|
742
|
+
* // },
|
|
743
|
+
* // action: {
|
|
744
|
+
* // id: "STRING_VALUE", // required
|
|
745
|
+
* // },
|
|
746
|
+
* // },
|
|
747
|
+
* // },
|
|
748
|
+
* // },
|
|
749
|
+
* // ],
|
|
750
|
+
* // },
|
|
751
|
+
* // ],
|
|
680
752
|
* // attachments: [
|
|
681
753
|
* // {
|
|
682
754
|
* // id: "STRING_VALUE", // required
|
|
@@ -747,7 +819,7 @@ declare const DescribeEventCommand_base: {
|
|
|
747
819
|
* // WebhookChatReactionNewEvent: { // WebhookChatReactionNewEvent
|
|
748
820
|
* // id: "STRING_VALUE", // required
|
|
749
821
|
* // company: "STRING_VALUE", // required
|
|
750
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
822
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
751
823
|
* // time: Number("long"), // required
|
|
752
824
|
* // integrationId: "STRING_VALUE",
|
|
753
825
|
* // botId: "STRING_VALUE",
|
|
@@ -755,6 +827,30 @@ declare const DescribeEventCommand_base: {
|
|
|
755
827
|
* // channel: "<Channel>", // required
|
|
756
828
|
* // message: {
|
|
757
829
|
* // text: "STRING_VALUE",
|
|
830
|
+
* // elements: [
|
|
831
|
+
* // {// Union: only one key present
|
|
832
|
+
* // actions: [
|
|
833
|
+
* // {// Union: only one key present
|
|
834
|
+
* // button: {
|
|
835
|
+
* // text: "STRING_VALUE", // required
|
|
836
|
+
* // variant: "contained" || "outlined",
|
|
837
|
+
* // disabled: true || false,
|
|
838
|
+
* // handler: {// Union: only one key present
|
|
839
|
+
* // link: {
|
|
840
|
+
* // url: "STRING_VALUE", // required
|
|
841
|
+
* // },
|
|
842
|
+
* // reply: {
|
|
843
|
+
* // text: "STRING_VALUE",
|
|
844
|
+
* // },
|
|
845
|
+
* // action: {
|
|
846
|
+
* // id: "STRING_VALUE", // required
|
|
847
|
+
* // },
|
|
848
|
+
* // },
|
|
849
|
+
* // },
|
|
850
|
+
* // },
|
|
851
|
+
* // ],
|
|
852
|
+
* // },
|
|
853
|
+
* // ],
|
|
758
854
|
* // attachments: "<MessageAttachmentList>",
|
|
759
855
|
* // quote: {
|
|
760
856
|
* // messageId: "STRING_VALUE", // required
|
|
@@ -807,7 +903,7 @@ declare const DescribeEventCommand_base: {
|
|
|
807
903
|
* // WebhookChatReactionDeletedEvent: { // WebhookChatReactionDeletedEvent
|
|
808
904
|
* // id: "STRING_VALUE", // required
|
|
809
905
|
* // company: "STRING_VALUE", // required
|
|
810
|
-
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted", // required
|
|
906
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
811
907
|
* // time: Number("long"), // required
|
|
812
908
|
* // integrationId: "STRING_VALUE",
|
|
813
909
|
* // botId: "STRING_VALUE",
|
|
@@ -815,6 +911,30 @@ declare const DescribeEventCommand_base: {
|
|
|
815
911
|
* // channel: "<Channel>", // required
|
|
816
912
|
* // message: {
|
|
817
913
|
* // text: "STRING_VALUE",
|
|
914
|
+
* // elements: [
|
|
915
|
+
* // {// Union: only one key present
|
|
916
|
+
* // actions: [
|
|
917
|
+
* // {// Union: only one key present
|
|
918
|
+
* // button: {
|
|
919
|
+
* // text: "STRING_VALUE", // required
|
|
920
|
+
* // variant: "contained" || "outlined",
|
|
921
|
+
* // disabled: true || false,
|
|
922
|
+
* // handler: {// Union: only one key present
|
|
923
|
+
* // link: {
|
|
924
|
+
* // url: "STRING_VALUE", // required
|
|
925
|
+
* // },
|
|
926
|
+
* // reply: {
|
|
927
|
+
* // text: "STRING_VALUE",
|
|
928
|
+
* // },
|
|
929
|
+
* // action: {
|
|
930
|
+
* // id: "STRING_VALUE", // required
|
|
931
|
+
* // },
|
|
932
|
+
* // },
|
|
933
|
+
* // },
|
|
934
|
+
* // },
|
|
935
|
+
* // ],
|
|
936
|
+
* // },
|
|
937
|
+
* // ],
|
|
818
938
|
* // attachments: "<MessageAttachmentList>",
|
|
819
939
|
* // quote: {
|
|
820
940
|
* // messageId: "STRING_VALUE", // required
|
|
@@ -854,6 +974,21 @@ declare const DescribeEventCommand_base: {
|
|
|
854
974
|
* // reaction: "<Reaction>", // required
|
|
855
975
|
* // },
|
|
856
976
|
* // },
|
|
977
|
+
* // WebhookChatActionTriggeredEvent: { // WebhookChatActionTriggeredEvent
|
|
978
|
+
* // id: "STRING_VALUE", // required
|
|
979
|
+
* // company: "STRING_VALUE", // required
|
|
980
|
+
* // type: "chat:channel:created" || "chat:channel:updated" || "chat:member:added" || "chat:member:removed" || "chat:message:new" || "chat:message:updated" || "chat:message:deleted" || "chat:reaction:new" || "chat:reaction:deleted" || "chat:action:triggered", // required
|
|
981
|
+
* // time: Number("long"), // required
|
|
982
|
+
* // integrationId: "STRING_VALUE",
|
|
983
|
+
* // botId: "STRING_VALUE",
|
|
984
|
+
* // data: { // WebhookChatActionTriggeredEventData
|
|
985
|
+
* // channel: "<Channel>", // required
|
|
986
|
+
* // message: "<Message>", // required
|
|
987
|
+
* // user: "<User>", // required
|
|
988
|
+
* // actionId: "STRING_VALUE", // required
|
|
989
|
+
* // triggerId: "STRING_VALUE", // required
|
|
990
|
+
* // },
|
|
991
|
+
* // },
|
|
857
992
|
* // };
|
|
858
993
|
*
|
|
859
994
|
* ```
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetActionTriggerResultInput, GetActionTriggerResultOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetActionTriggerResultCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetActionTriggerResultCommandInput extends GetActionTriggerResultInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetActionTriggerResultCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetActionTriggerResultCommandOutput extends GetActionTriggerResultOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetActionTriggerResultCommand_base: {
|
|
25
|
+
new (input: GetActionTriggerResultCommandInput): import("@smithy/smithy-client").CommandImpl<GetActionTriggerResultCommandInput, GetActionTriggerResultCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetActionTriggerResultCommandInput): import("@smithy/smithy-client").CommandImpl<GetActionTriggerResultCommandInput, GetActionTriggerResultCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get result of the triggered action.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, GetActionTriggerResultCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, GetActionTriggerResultCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // GetActionTriggerResultInput
|
|
38
|
+
* triggerId: "STRING_VALUE", // required
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetActionTriggerResultCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetActionTriggerResultOutput
|
|
44
|
+
* // status: "completed" || "pending", // required
|
|
45
|
+
* // result: {},
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param GetActionTriggerResultCommandInput - {@link GetActionTriggerResultCommandInput}
|
|
51
|
+
* @returns {@link GetActionTriggerResultCommandOutput}
|
|
52
|
+
* @see {@link GetActionTriggerResultCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link GetActionTriggerResultCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link TriggerNotFoundException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ValidationException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ConversationsServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class GetActionTriggerResultCommand extends GetActionTriggerResultCommand_base {
|
|
70
|
+
}
|
|
@@ -43,6 +43,30 @@ declare const GetMessageCommand_base: {
|
|
|
43
43
|
* // { // GetMessageOutput
|
|
44
44
|
* // message: { // Message
|
|
45
45
|
* // text: "STRING_VALUE",
|
|
46
|
+
* // elements: [ // ElementsList
|
|
47
|
+
* // { // Element Union: only one key present
|
|
48
|
+
* // actions: [ // ActionsElementsList
|
|
49
|
+
* // { // ActionElement Union: only one key present
|
|
50
|
+
* // button: { // ButtonElement
|
|
51
|
+
* // text: "STRING_VALUE", // required
|
|
52
|
+
* // variant: "contained" || "outlined",
|
|
53
|
+
* // disabled: true || false,
|
|
54
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
55
|
+
* // link: { // ButtonLinkHandler
|
|
56
|
+
* // url: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // reply: { // ButtonReplyHandler
|
|
59
|
+
* // text: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // action: { // ButtonActionHandler
|
|
62
|
+
* // id: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
46
70
|
* // attachments: [ // MessageAttachmentList
|
|
47
71
|
* // { // MessageAttachment
|
|
48
72
|
* // id: "STRING_VALUE", // required
|
|
@@ -45,6 +45,30 @@ declare const ListMessagesCommand_base: {
|
|
|
45
45
|
* // messages: [ // MessagesList // required
|
|
46
46
|
* // { // Message
|
|
47
47
|
* // text: "STRING_VALUE",
|
|
48
|
+
* // elements: [ // ElementsList
|
|
49
|
+
* // { // Element Union: only one key present
|
|
50
|
+
* // actions: [ // ActionsElementsList
|
|
51
|
+
* // { // ActionElement Union: only one key present
|
|
52
|
+
* // button: { // ButtonElement
|
|
53
|
+
* // text: "STRING_VALUE", // required
|
|
54
|
+
* // variant: "contained" || "outlined",
|
|
55
|
+
* // disabled: true || false,
|
|
56
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
57
|
+
* // link: { // ButtonLinkHandler
|
|
58
|
+
* // url: "STRING_VALUE", // required
|
|
59
|
+
* // },
|
|
60
|
+
* // reply: { // ButtonReplyHandler
|
|
61
|
+
* // text: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // action: { // ButtonActionHandler
|
|
64
|
+
* // id: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
48
72
|
* // attachments: [ // MessageAttachmentList
|
|
49
73
|
* // { // MessageAttachment
|
|
50
74
|
* // id: "STRING_VALUE", // required
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { ListPinnedMessagesInput, ListPinnedMessagesOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListPinnedMessagesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPinnedMessagesCommandInput extends ListPinnedMessagesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPinnedMessagesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPinnedMessagesCommandOutput extends ListPinnedMessagesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListPinnedMessagesCommand_base: {
|
|
25
|
+
new (input: ListPinnedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListPinnedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves a list of pinned messages from a specified channel. Supports pagination through limit and offset parameters.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, ListPinnedMessagesCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, ListPinnedMessagesCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // ListPinnedMessagesInput
|
|
38
|
+
* channelId: "STRING_VALUE", // required
|
|
39
|
+
* limit: Number("int"),
|
|
40
|
+
* offset: Number("int"),
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListPinnedMessagesCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListPinnedMessagesOutput
|
|
45
|
+
* // messages: [ // MessagesList // required
|
|
46
|
+
* // { // Message
|
|
47
|
+
* // text: "STRING_VALUE",
|
|
48
|
+
* // elements: [ // ElementsList
|
|
49
|
+
* // { // Element Union: only one key present
|
|
50
|
+
* // actions: [ // ActionsElementsList
|
|
51
|
+
* // { // ActionElement Union: only one key present
|
|
52
|
+
* // button: { // ButtonElement
|
|
53
|
+
* // text: "STRING_VALUE", // required
|
|
54
|
+
* // variant: "contained" || "outlined",
|
|
55
|
+
* // disabled: true || false,
|
|
56
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
57
|
+
* // link: { // ButtonLinkHandler
|
|
58
|
+
* // url: "STRING_VALUE", // required
|
|
59
|
+
* // },
|
|
60
|
+
* // reply: { // ButtonReplyHandler
|
|
61
|
+
* // text: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // action: { // ButtonActionHandler
|
|
64
|
+
* // id: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // attachments: [ // MessageAttachmentList
|
|
73
|
+
* // { // MessageAttachment
|
|
74
|
+
* // id: "STRING_VALUE", // required
|
|
75
|
+
* // fsId: "STRING_VALUE", // required
|
|
76
|
+
* // mime: "STRING_VALUE",
|
|
77
|
+
* // name: "STRING_VALUE", // required
|
|
78
|
+
* // size: Number("int"), // required
|
|
79
|
+
* // width: Number("int"),
|
|
80
|
+
* // height: Number("int"),
|
|
81
|
+
* // thumbnail: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // quote: { // MessageQuote
|
|
85
|
+
* // messageId: "STRING_VALUE", // required
|
|
86
|
+
* // channelId: "STRING_VALUE", // required
|
|
87
|
+
* // user: { // User
|
|
88
|
+
* // id: "STRING_VALUE", // required
|
|
89
|
+
* // name: "STRING_VALUE",
|
|
90
|
+
* // email: "STRING_VALUE",
|
|
91
|
+
* // phone: "STRING_VALUE",
|
|
92
|
+
* // picture: "STRING_VALUE",
|
|
93
|
+
* // locale: "STRING_VALUE",
|
|
94
|
+
* // timeZone: "STRING_VALUE",
|
|
95
|
+
* // company: "STRING_VALUE",
|
|
96
|
+
* // bot: true || false,
|
|
97
|
+
* // pbxDomain: "STRING_VALUE",
|
|
98
|
+
* // pbxPort: "STRING_VALUE",
|
|
99
|
+
* // pbxExtension: "STRING_VALUE",
|
|
100
|
+
* // pbxSerial: "STRING_VALUE",
|
|
101
|
+
* // pbxUserId: "STRING_VALUE",
|
|
102
|
+
* // createdAt: "STRING_VALUE",
|
|
103
|
+
* // updatedAt: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // text: "STRING_VALUE",
|
|
106
|
+
* // attachments: [
|
|
107
|
+
* // {
|
|
108
|
+
* // id: "STRING_VALUE", // required
|
|
109
|
+
* // fsId: "STRING_VALUE", // required
|
|
110
|
+
* // mime: "STRING_VALUE",
|
|
111
|
+
* // name: "STRING_VALUE", // required
|
|
112
|
+
* // size: Number("int"), // required
|
|
113
|
+
* // width: Number("int"),
|
|
114
|
+
* // height: Number("int"),
|
|
115
|
+
* // thumbnail: "STRING_VALUE",
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // forward: { // MessageForward
|
|
119
|
+
* // forwardCompany: "STRING_VALUE",
|
|
120
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
121
|
+
* // forwardEmail: "STRING_VALUE",
|
|
122
|
+
* // forwardName: "STRING_VALUE",
|
|
123
|
+
* // messageId: "STRING_VALUE", // required
|
|
124
|
+
* // channelId: "STRING_VALUE", // required
|
|
125
|
+
* // },
|
|
126
|
+
* // mentions: [ // UsersList
|
|
127
|
+
* // {
|
|
128
|
+
* // id: "STRING_VALUE", // required
|
|
129
|
+
* // name: "STRING_VALUE",
|
|
130
|
+
* // email: "STRING_VALUE",
|
|
131
|
+
* // phone: "STRING_VALUE",
|
|
132
|
+
* // picture: "STRING_VALUE",
|
|
133
|
+
* // locale: "STRING_VALUE",
|
|
134
|
+
* // timeZone: "STRING_VALUE",
|
|
135
|
+
* // company: "STRING_VALUE",
|
|
136
|
+
* // bot: true || false,
|
|
137
|
+
* // pbxDomain: "STRING_VALUE",
|
|
138
|
+
* // pbxPort: "STRING_VALUE",
|
|
139
|
+
* // pbxExtension: "STRING_VALUE",
|
|
140
|
+
* // pbxSerial: "STRING_VALUE",
|
|
141
|
+
* // pbxUserId: "STRING_VALUE",
|
|
142
|
+
* // createdAt: "STRING_VALUE",
|
|
143
|
+
* // updatedAt: "STRING_VALUE",
|
|
144
|
+
* // },
|
|
145
|
+
* // ],
|
|
146
|
+
* // giphy: { // MessageGiphy
|
|
147
|
+
* // id: "STRING_VALUE", // required
|
|
148
|
+
* // size: "STRING_VALUE", // required
|
|
149
|
+
* // url: "STRING_VALUE", // required
|
|
150
|
+
* // height: "STRING_VALUE", // required
|
|
151
|
+
* // width: "STRING_VALUE", // required
|
|
152
|
+
* // },
|
|
153
|
+
* // createdAt: "STRING_VALUE", // required
|
|
154
|
+
* // updatedAt: "STRING_VALUE",
|
|
155
|
+
* // },
|
|
156
|
+
* // forward: {
|
|
157
|
+
* // forwardCompany: "STRING_VALUE",
|
|
158
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
159
|
+
* // forwardEmail: "STRING_VALUE",
|
|
160
|
+
* // forwardName: "STRING_VALUE",
|
|
161
|
+
* // messageId: "STRING_VALUE", // required
|
|
162
|
+
* // channelId: "STRING_VALUE", // required
|
|
163
|
+
* // },
|
|
164
|
+
* // type: "regular" || "system", // required
|
|
165
|
+
* // giphy: {
|
|
166
|
+
* // id: "STRING_VALUE", // required
|
|
167
|
+
* // size: "STRING_VALUE", // required
|
|
168
|
+
* // url: "STRING_VALUE", // required
|
|
169
|
+
* // height: "STRING_VALUE", // required
|
|
170
|
+
* // width: "STRING_VALUE", // required
|
|
171
|
+
* // },
|
|
172
|
+
* // silent: true || false,
|
|
173
|
+
* // event: "STRING_VALUE",
|
|
174
|
+
* // sms: true || false,
|
|
175
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
176
|
+
* // whatsapp: true || false,
|
|
177
|
+
* // whatsappStatus: "trying" || "sent" || "delivered" || "error",
|
|
178
|
+
* // messageId: "STRING_VALUE", // required
|
|
179
|
+
* // channelId: "STRING_VALUE", // required
|
|
180
|
+
* // user: "<User>", // required
|
|
181
|
+
* // edit: true || false,
|
|
182
|
+
* // mentions: [
|
|
183
|
+
* // "<User>",
|
|
184
|
+
* // ],
|
|
185
|
+
* // latestReactions: [ // ReactionList
|
|
186
|
+
* // { // Reaction
|
|
187
|
+
* // type: "STRING_VALUE",
|
|
188
|
+
* // userId: "STRING_VALUE",
|
|
189
|
+
* // messageId: "STRING_VALUE",
|
|
190
|
+
* // user: "<User>",
|
|
191
|
+
* // },
|
|
192
|
+
* // ],
|
|
193
|
+
* // reactionCounts: { // ReactionCounts
|
|
194
|
+
* // "<keys>": Number("int"),
|
|
195
|
+
* // },
|
|
196
|
+
* // createdAt: "STRING_VALUE", // required
|
|
197
|
+
* // updatedAt: "STRING_VALUE",
|
|
198
|
+
* // },
|
|
199
|
+
* // ],
|
|
200
|
+
* // };
|
|
201
|
+
*
|
|
202
|
+
* ```
|
|
203
|
+
*
|
|
204
|
+
* @param ListPinnedMessagesCommandInput - {@link ListPinnedMessagesCommandInput}
|
|
205
|
+
* @returns {@link ListPinnedMessagesCommandOutput}
|
|
206
|
+
* @see {@link ListPinnedMessagesCommandInput} for command's `input` shape.
|
|
207
|
+
* @see {@link ListPinnedMessagesCommandOutput} for command's `response` shape.
|
|
208
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
209
|
+
*
|
|
210
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
211
|
+
*
|
|
212
|
+
* @throws {@link ValidationException} (client fault)
|
|
213
|
+
*
|
|
214
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
215
|
+
*
|
|
216
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
217
|
+
*
|
|
218
|
+
* @throws {@link ConversationsServiceException}
|
|
219
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
220
|
+
*
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
export declare class ListPinnedMessagesCommand extends ListPinnedMessagesCommand_base {
|
|
224
|
+
}
|