@bkper/bkper-api-types 5.14.0 → 5.15.1

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 +101 -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,42 @@ 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 conversation messages
499
+ */
500
+ messages?: Message[];
501
+ /**
502
+ * The title of the Conversation
503
+ */
504
+ title?: string;
505
+ /**
506
+ * The last update timestamp, in milliseconds
507
+ */
508
+ updatedAt?: string;
509
+ /**
510
+ * The last update date time on RFC3339 format
511
+ */
512
+ updatedOn?: string; // date-time
513
+ }
514
+ export interface ConversationList {
515
+ /**
516
+ * List items
517
+ */
518
+ items?: Conversation[];
519
+ }
472
520
  export interface Count {
473
521
  day?: number; // int32
474
522
  fuzzyDate?: number; // int32
@@ -678,6 +726,36 @@ declare namespace bkper {
678
726
  */
679
727
  items?: Integration[];
680
728
  }
729
+ export interface Message {
730
+ agent?: Agent;
731
+ /**
732
+ * The id of the Book in the context of the Message
733
+ */
734
+ bookId?: string;
735
+ /**
736
+ * The content of the Message
737
+ */
738
+ content?: string;
739
+ /**
740
+ * The creation timestamp, in milliseconds
741
+ */
742
+ createdAt?: string;
743
+ /**
744
+ * The creation date time on RFC3339 format
745
+ */
746
+ createdOn?: string; // date-time
747
+ /**
748
+ * The unique id that identifies the Message
749
+ */
750
+ id?: string;
751
+ user?: User;
752
+ }
753
+ export interface MessageList {
754
+ /**
755
+ * List items
756
+ */
757
+ items?: Message[];
758
+ }
681
759
  export interface Query {
682
760
  /**
683
761
  * The id of agent that created the resource
@@ -914,6 +992,17 @@ declare namespace Paths {
914
992
  export type $200 = bkper.Collaborator;
915
993
  }
916
994
  }
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
+ }
917
1006
  namespace BkperV5CheckTransaction {
918
1007
  export interface BodyParameters {
919
1008
  Transaction: Parameters.Transaction;
@@ -1170,6 +1259,16 @@ declare namespace Paths {
1170
1259
  export type $200 = bkper.AccountList;
1171
1260
  }
1172
1261
  }
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
+ }
1173
1272
  namespace BkperV5ListApps {
1174
1273
  namespace Responses {
1175
1274
  export type $200 = bkper.AppList;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bkper/bkper-api-types",
3
- "version": "5.14.0",
3
+ "version": "5.15.1",
4
4
  "description": "Typescript definitions for Bkper REST API",
5
5
  "homepage": "https://api.bkper.com",
6
6
  "repository": {