@botpress/client 0.22.0 → 0.23.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.
@@ -0,0 +1,165 @@
1
+ export interface UpdateInterfaceRequestHeaders {
2
+ }
3
+ export interface UpdateInterfaceRequestQuery {
4
+ }
5
+ export interface UpdateInterfaceRequestParams {
6
+ id: string;
7
+ }
8
+ export interface UpdateInterfaceRequestBody {
9
+ events?: {
10
+ /**
11
+ * Event Definition
12
+ */
13
+ [k: string]: {
14
+ /**
15
+ * Title of the event
16
+ */
17
+ title?: string;
18
+ /**
19
+ * Description of the event
20
+ */
21
+ description?: string;
22
+ schema: {
23
+ [k: string]: any;
24
+ };
25
+ } | null;
26
+ };
27
+ actions?: {
28
+ /**
29
+ * Action definition
30
+ */
31
+ [k: string]: {
32
+ /**
33
+ * Title of the action
34
+ */
35
+ title?: string;
36
+ /**
37
+ * Description of the action
38
+ */
39
+ description?: string;
40
+ input: {
41
+ schema: {
42
+ [k: string]: any;
43
+ };
44
+ };
45
+ output: {
46
+ schema: {
47
+ [k: string]: any;
48
+ };
49
+ };
50
+ } | null;
51
+ };
52
+ entities?: {
53
+ /**
54
+ * Entity definition
55
+ */
56
+ [k: string]: {
57
+ /**
58
+ * Title of the entity
59
+ */
60
+ title?: string;
61
+ /**
62
+ * Description of the entity
63
+ */
64
+ description?: string;
65
+ schema: {
66
+ [k: string]: any;
67
+ };
68
+ } | null;
69
+ };
70
+ }
71
+ export type UpdateInterfaceInput = UpdateInterfaceRequestBody & UpdateInterfaceRequestHeaders & UpdateInterfaceRequestQuery & UpdateInterfaceRequestParams;
72
+ export type UpdateInterfaceRequest = {
73
+ headers: UpdateInterfaceRequestHeaders;
74
+ query: UpdateInterfaceRequestQuery;
75
+ params: UpdateInterfaceRequestParams;
76
+ body: UpdateInterfaceRequestBody;
77
+ };
78
+ export declare const parseReq: (input: UpdateInterfaceInput) => UpdateInterfaceRequest & {
79
+ path: string;
80
+ };
81
+ export interface UpdateInterfaceResponse {
82
+ interface: {
83
+ /**
84
+ * ID of the [Interface](#schema_interface)
85
+ */
86
+ id: string;
87
+ /**
88
+ * Creation date of the [Interface](#schema_interface) in ISO 8601 format
89
+ */
90
+ createdAt: string;
91
+ /**
92
+ * Updating date of the [Interface](#schema_interface) in ISO 8601 format
93
+ */
94
+ updatedAt: string;
95
+ /**
96
+ * Name of the [Interface](#schema_interface)
97
+ */
98
+ name: string;
99
+ /**
100
+ * Version of the [Interface](#schema_interface)
101
+ */
102
+ version: string;
103
+ events: {
104
+ /**
105
+ * Event Definition
106
+ */
107
+ [k: string]: {
108
+ /**
109
+ * Title of the event
110
+ */
111
+ title?: string;
112
+ /**
113
+ * Description of the event
114
+ */
115
+ description?: string;
116
+ schema: {
117
+ [k: string]: any;
118
+ };
119
+ };
120
+ };
121
+ actions: {
122
+ /**
123
+ * Action definition
124
+ */
125
+ [k: string]: {
126
+ /**
127
+ * Title of the action
128
+ */
129
+ title?: string;
130
+ /**
131
+ * Description of the action
132
+ */
133
+ description?: string;
134
+ input: {
135
+ schema: {
136
+ [k: string]: any;
137
+ };
138
+ };
139
+ output: {
140
+ schema: {
141
+ [k: string]: any;
142
+ };
143
+ };
144
+ };
145
+ };
146
+ entities: {
147
+ /**
148
+ * Entity definition
149
+ */
150
+ [k: string]: {
151
+ /**
152
+ * Title of the entity
153
+ */
154
+ title?: string;
155
+ /**
156
+ * Description of the entity
157
+ */
158
+ description?: string;
159
+ schema: {
160
+ [k: string]: any;
161
+ };
162
+ };
163
+ };
164
+ };
165
+ }
@@ -56,6 +56,12 @@ export interface UpsertFileResponse {
56
56
  * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
57
57
  */
58
58
  key: string;
59
+ /**
60
+ * URL to retrieve the file content. This URL will be ready to use once the file is uploaded.
61
+ *
62
+ * If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
63
+ */
64
+ url: string;
59
65
  /**
60
66
  * File size in bytes. Non-null if file upload status is "COMPLETE".
61
67
  */