@bkper/bkper-api-types 5.13.0 → 5.15.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 +103 -2
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -112,6 +112,14 @@ declare namespace bkper {
112
112
  * Tell if this app is connectable by a user
113
113
  */
114
114
  connectable?: boolean;
115
+ /**
116
+ * The Conversation endpoint URL to respond to conversation messages
117
+ */
118
+ conversationUrl?: string;
119
+ /**
120
+ * The Conversation endpoint URL to respond to conversation messages in dev mode
121
+ */
122
+ conversationUrlDev?: string;
115
123
  /**
116
124
  * Tell if the code app is deprecated
117
125
  */
@@ -144,6 +152,10 @@ declare namespace bkper {
144
152
  * The App logo url
145
153
  */
146
154
  logoUrl?: string;
155
+ /**
156
+ * The App logo url in dark mode
157
+ */
158
+ logoUrlDark?: string;
147
159
  /**
148
160
  * The menu popup window height
149
161
  */
@@ -210,11 +222,11 @@ declare namespace bkper {
210
222
  */
211
223
  userEmails?: string;
212
224
  /**
213
- * The Webhook URL to listen for book events
225
+ * The Webhook endpoint URL to listen for book events
214
226
  */
215
227
  webhookUrl?: string;
216
228
  /**
217
- * The Webhook URL to listen for book events in dev mode
229
+ * The Webhook endpoint URL to listen for book events in dev mode
218
230
  */
219
231
  webhookUrlDev?: string;
220
232
  /**
@@ -469,6 +481,34 @@ declare namespace bkper {
469
481
  */
470
482
  items?: Connection[];
471
483
  }
484
+ export interface Conversation {
485
+ /**
486
+ * The creation timestamp, in milliseconds
487
+ */
488
+ createdAt?: string;
489
+ /**
490
+ * The creation date time on RFC3339 format
491
+ */
492
+ createdOn?: string; // date-time
493
+ /**
494
+ * The unique id that identifies the Conversation
495
+ */
496
+ id?: string;
497
+ /**
498
+ * The context messages
499
+ */
500
+ messages?: Message[];
501
+ /**
502
+ * The title of the Conversation
503
+ */
504
+ title?: string;
505
+ }
506
+ export interface ConversationList {
507
+ /**
508
+ * List items
509
+ */
510
+ items?: Conversation[];
511
+ }
472
512
  export interface Count {
473
513
  day?: number; // int32
474
514
  fuzzyDate?: number; // int32
@@ -678,6 +718,36 @@ declare namespace bkper {
678
718
  */
679
719
  items?: Integration[];
680
720
  }
721
+ export interface Message {
722
+ agent?: Agent;
723
+ /**
724
+ * The id of the Book in the context of the Message
725
+ */
726
+ bookId?: string;
727
+ /**
728
+ * The content of the Message
729
+ */
730
+ content?: string;
731
+ /**
732
+ * The creation timestamp, in milliseconds
733
+ */
734
+ createdAt?: string;
735
+ /**
736
+ * The creation date time on RFC3339 format
737
+ */
738
+ createdOn?: string; // date-time
739
+ /**
740
+ * The unique id that identifies the Message
741
+ */
742
+ id?: string;
743
+ user?: User;
744
+ }
745
+ export interface MessageList {
746
+ /**
747
+ * List items
748
+ */
749
+ items?: Message[];
750
+ }
681
751
  export interface Query {
682
752
  /**
683
753
  * The id of agent that created the resource
@@ -914,6 +984,17 @@ declare namespace Paths {
914
984
  export type $200 = bkper.Collaborator;
915
985
  }
916
986
  }
987
+ namespace BkperV5ChatWithApp {
988
+ export interface BodyParameters {
989
+ Conversation: Parameters.Conversation;
990
+ }
991
+ namespace Parameters {
992
+ export type Conversation = bkper.Conversation;
993
+ }
994
+ namespace Responses {
995
+ export type $200 = bkper.Conversation;
996
+ }
997
+ }
917
998
  namespace BkperV5CheckTransaction {
918
999
  export interface BodyParameters {
919
1000
  Transaction: Parameters.Transaction;
@@ -1090,6 +1171,11 @@ declare namespace Paths {
1090
1171
  export type $200 = bkper.Connection;
1091
1172
  }
1092
1173
  }
1174
+ namespace BkperV5DeleteEventResponse {
1175
+ namespace Responses {
1176
+ export type $200 = bkper.Event;
1177
+ }
1178
+ }
1093
1179
  namespace BkperV5DeleteGroup {
1094
1180
  namespace Responses {
1095
1181
  export type $200 = bkper.Group;
@@ -1165,6 +1251,16 @@ declare namespace Paths {
1165
1251
  export type $200 = bkper.AccountList;
1166
1252
  }
1167
1253
  }
1254
+ namespace BkperV5ListAppConversationMessages {
1255
+ namespace Responses {
1256
+ export type $200 = bkper.MessageList;
1257
+ }
1258
+ }
1259
+ namespace BkperV5ListAppConversations {
1260
+ namespace Responses {
1261
+ export type $200 = bkper.ConversationList;
1262
+ }
1263
+ }
1168
1264
  namespace BkperV5ListApps {
1169
1265
  namespace Responses {
1170
1266
  export type $200 = bkper.AppList;
@@ -1279,6 +1375,11 @@ declare namespace Paths {
1279
1375
  export type $200 = bkper.TransactionOperation;
1280
1376
  }
1281
1377
  }
1378
+ namespace BkperV5ReplayEventResponse {
1379
+ namespace Responses {
1380
+ export type $200 = bkper.Event;
1381
+ }
1382
+ }
1282
1383
  namespace BkperV5ReplayEvents {
1283
1384
  export interface BodyParameters {
1284
1385
  EventList: Parameters.EventList;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bkper/bkper-api-types",
3
- "version": "5.13.0",
3
+ "version": "5.15.0",
4
4
  "description": "Typescript definitions for Bkper REST API",
5
5
  "homepage": "https://api.bkper.com",
6
6
  "repository": {