@bkper/bkper-api-types 5.17.0 → 5.18.0

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.
Files changed (2) hide show
  1. package/index.d.ts +65 -27
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -88,6 +88,10 @@ declare namespace bkper {
88
88
  * The agent logo. Public url or Base64 encoded
89
89
  */
90
90
  logo?: string;
91
+ /**
92
+ * The agent logo on dark mode. Public url or Base64 encoded
93
+ */
94
+ logoDark?: string;
91
95
  /**
92
96
  * The agent name
93
97
  */
@@ -120,6 +124,10 @@ declare namespace bkper {
120
124
  * The Conversation endpoint URL to respond to conversation messages in dev mode
121
125
  */
122
126
  conversationUrlDev?: string;
127
+ /**
128
+ * Tell if this app is conversational
129
+ */
130
+ conversational?: boolean;
123
131
  /**
124
132
  * Tell if the code app is deprecated
125
133
  */
@@ -482,6 +490,7 @@ declare namespace bkper {
482
490
  items?: Connection[];
483
491
  }
484
492
  export interface Conversation {
493
+ agent?: Agent;
485
494
  /**
486
495
  * The creation timestamp, in milliseconds
487
496
  */
@@ -728,10 +737,6 @@ declare namespace bkper {
728
737
  }
729
738
  export interface Message {
730
739
  agent?: Agent;
731
- /**
732
- * The id of the Book in the context of the Message
733
- */
734
- bookId?: string;
735
740
  /**
736
741
  * The content of the Message
737
742
  */
@@ -748,6 +753,13 @@ declare namespace bkper {
748
753
  * The unique id that identifies the Message
749
754
  */
750
755
  id?: string;
756
+ parent?: Message;
757
+ /**
758
+ * The key/value custom properties of the Message
759
+ */
760
+ properties?: {
761
+ [name: string]: string;
762
+ };
751
763
  user?: User;
752
764
  }
753
765
  export interface MessageList {
@@ -806,11 +818,15 @@ declare namespace bkper {
806
818
  */
807
819
  agentId?: string;
808
820
  /**
809
- * The agent logo that created the transaction
821
+ * The logo of the agent that created the transaction
810
822
  */
811
823
  agentLogo?: string;
812
824
  /**
813
- * The agent name that created the transaction
825
+ * The logo in dark mode, of the agent that created the transaction
826
+ */
827
+ agentLogoDark?: string;
828
+ /**
829
+ * The name of the agent that created the transaction
814
830
  */
815
831
  agentName?: string;
816
832
  /**
@@ -992,17 +1008,6 @@ declare namespace Paths {
992
1008
  export type $200 = bkper.Collaborator;
993
1009
  }
994
1010
  }
995
- namespace BkperV5ChatWithApp {
996
- export interface BodyParameters {
997
- Conversation: Parameters.Conversation;
998
- }
999
- namespace Parameters {
1000
- export type Conversation = bkper.Conversation;
1001
- }
1002
- namespace Responses {
1003
- export type $200 = bkper.Conversation;
1004
- }
1005
- }
1006
1011
  namespace BkperV5CheckTransaction {
1007
1012
  export interface BodyParameters {
1008
1013
  Transaction: Parameters.Transaction;
@@ -1087,6 +1092,17 @@ declare namespace Paths {
1087
1092
  export type $200 = bkper.Connection;
1088
1093
  }
1089
1094
  }
1095
+ namespace BkperV5CreateConversation {
1096
+ export interface BodyParameters {
1097
+ Conversation: Parameters.Conversation;
1098
+ }
1099
+ namespace Parameters {
1100
+ export type Conversation = bkper.Conversation;
1101
+ }
1102
+ namespace Responses {
1103
+ export type $200 = bkper.Conversation;
1104
+ }
1105
+ }
1090
1106
  namespace BkperV5CreateFile {
1091
1107
  export interface BodyParameters {
1092
1108
  File: Parameters.File;
@@ -1131,6 +1147,17 @@ declare namespace Paths {
1131
1147
  export type $200 = bkper.Integration;
1132
1148
  }
1133
1149
  }
1150
+ namespace BkperV5CreateMessage {
1151
+ export interface BodyParameters {
1152
+ Message: Parameters.Message;
1153
+ }
1154
+ namespace Parameters {
1155
+ export type Message = bkper.Message;
1156
+ }
1157
+ namespace Responses {
1158
+ export type $200 = bkper.Message;
1159
+ }
1160
+ }
1134
1161
  namespace BkperV5CreateNewBook {
1135
1162
  export interface BodyParameters {
1136
1163
  Book: Parameters.Book;
@@ -1259,16 +1286,6 @@ declare namespace Paths {
1259
1286
  export type $200 = bkper.AccountList;
1260
1287
  }
1261
1288
  }
1262
- namespace BkperV5ListAppConversationMessages {
1263
- namespace Responses {
1264
- export type $200 = bkper.MessageList;
1265
- }
1266
- }
1267
- namespace BkperV5ListAppConversations {
1268
- namespace Responses {
1269
- export type $200 = bkper.ConversationList;
1270
- }
1271
- }
1272
1289
  namespace BkperV5ListApps {
1273
1290
  namespace Responses {
1274
1291
  export type $200 = bkper.AppList;
@@ -1299,6 +1316,11 @@ declare namespace Paths {
1299
1316
  export type $200 = bkper.ConnectionList;
1300
1317
  }
1301
1318
  }
1319
+ namespace BkperV5ListConversations {
1320
+ namespace Responses {
1321
+ export type $200 = bkper.ConversationList;
1322
+ }
1323
+ }
1302
1324
  namespace BkperV5ListEvents {
1303
1325
  namespace Responses {
1304
1326
  export type $200 = bkper.EventList;
@@ -1319,6 +1341,11 @@ declare namespace Paths {
1319
1341
  export type $200 = bkper.IntegrationList;
1320
1342
  }
1321
1343
  }
1344
+ namespace BkperV5ListMessages {
1345
+ namespace Responses {
1346
+ export type $200 = bkper.MessageList;
1347
+ }
1348
+ }
1322
1349
  namespace BkperV5ListQueries {
1323
1350
  namespace Responses {
1324
1351
  export type $200 = bkper.QueryList;
@@ -1407,6 +1434,17 @@ declare namespace Paths {
1407
1434
  export type $200 = bkper.TransactionOperation;
1408
1435
  }
1409
1436
  }
1437
+ namespace BkperV5StreamConversation {
1438
+ export interface BodyParameters {
1439
+ Message: Parameters.Message;
1440
+ }
1441
+ namespace Parameters {
1442
+ export type Message = bkper.Message;
1443
+ }
1444
+ namespace Responses {
1445
+ export type $200 = bkper.Message;
1446
+ }
1447
+ }
1410
1448
  namespace BkperV5TrashTransaction {
1411
1449
  export interface BodyParameters {
1412
1450
  Transaction: Parameters.Transaction;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bkper/bkper-api-types",
3
- "version": "5.17.0",
3
+ "version": "5.18.0",
4
4
  "description": "Typescript definitions for Bkper REST API",
5
5
  "homepage": "https://api.bkper.com",
6
6
  "repository": {