@breign/client 1.0.86 → 1.0.87

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.
@@ -37,11 +37,13 @@ export interface CreateAppChatRequest {
37
37
  appId: string;
38
38
  appChatCreateRequestUio: AppChatCreateRequestUio;
39
39
  instanceId?: string;
40
+ ephemeral?: boolean;
40
41
  }
41
42
  export interface CreateAppFlowRequest {
42
43
  appId: string;
43
44
  appFlowCreateRequestUio: AppFlowCreateRequestUio;
44
45
  instanceId?: string;
46
+ ephemeral?: boolean;
45
47
  }
46
48
  export interface CreateInstanceRequest {
47
49
  appId: string;
@@ -210,17 +212,17 @@ export declare class AppApi extends runtime.BaseAPI {
210
212
  * Initialize a chat
211
213
  * Initialize a chat
212
214
  */
213
- createAppChat(appId: string, appChatCreateRequestUio: AppChatCreateRequestUio, instanceId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppChatCreateResponseUio>;
215
+ createAppChat(appId: string, appChatCreateRequestUio: AppChatCreateRequestUio, instanceId?: string, ephemeral?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppChatCreateResponseUio>;
214
216
  /**
215
- * Create a flow
216
- * Create a flow
217
+ * Start a conversation with a flow.
218
+ * Start a chat with a flow
217
219
  */
218
220
  createAppFlowRaw(requestParameters: CreateAppFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlowUio>>;
219
221
  /**
220
- * Create a flow
221
- * Create a flow
222
+ * Start a conversation with a flow.
223
+ * Start a chat with a flow
222
224
  */
223
- createAppFlow(appId: string, appFlowCreateRequestUio: AppFlowCreateRequestUio, instanceId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowUio>;
225
+ createAppFlow(appId: string, appFlowCreateRequestUio: AppFlowCreateRequestUio, instanceId?: string, ephemeral?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlowUio>;
224
226
  /**
225
227
  * Create instance
226
228
  * Create instance
@@ -242,6 +242,9 @@ class AppApi extends runtime.BaseAPI {
242
242
  if (requestParameters['instanceId'] != null) {
243
243
  queryParameters['instanceId'] = requestParameters['instanceId'];
244
244
  }
245
+ if (requestParameters['ephemeral'] != null) {
246
+ queryParameters['ephemeral'] = requestParameters['ephemeral'];
247
+ }
245
248
  const headerParameters = {};
246
249
  headerParameters['Content-Type'] = 'application/json';
247
250
  if (this.configuration && this.configuration.apiKey) {
@@ -260,13 +263,13 @@ class AppApi extends runtime.BaseAPI {
260
263
  * Initialize a chat
261
264
  * Initialize a chat
262
265
  */
263
- async createAppChat(appId, appChatCreateRequestUio, instanceId, initOverrides) {
264
- const response = await this.createAppChatRaw({ appId: appId, appChatCreateRequestUio: appChatCreateRequestUio, instanceId: instanceId }, initOverrides);
266
+ async createAppChat(appId, appChatCreateRequestUio, instanceId, ephemeral, initOverrides) {
267
+ const response = await this.createAppChatRaw({ appId: appId, appChatCreateRequestUio: appChatCreateRequestUio, instanceId: instanceId, ephemeral: ephemeral }, initOverrides);
265
268
  return await response.value();
266
269
  }
267
270
  /**
268
- * Create a flow
269
- * Create a flow
271
+ * Start a conversation with a flow.
272
+ * Start a chat with a flow
270
273
  */
271
274
  async createAppFlowRaw(requestParameters, initOverrides) {
272
275
  if (requestParameters['appId'] == null) {
@@ -279,6 +282,9 @@ class AppApi extends runtime.BaseAPI {
279
282
  if (requestParameters['instanceId'] != null) {
280
283
  queryParameters['instanceId'] = requestParameters['instanceId'];
281
284
  }
285
+ if (requestParameters['ephemeral'] != null) {
286
+ queryParameters['ephemeral'] = requestParameters['ephemeral'];
287
+ }
282
288
  const headerParameters = {};
283
289
  headerParameters['Content-Type'] = 'application/json';
284
290
  if (this.configuration && this.configuration.apiKey) {
@@ -294,11 +300,11 @@ class AppApi extends runtime.BaseAPI {
294
300
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FlowUioFromJSON)(jsonValue));
295
301
  }
296
302
  /**
297
- * Create a flow
298
- * Create a flow
303
+ * Start a conversation with a flow.
304
+ * Start a chat with a flow
299
305
  */
300
- async createAppFlow(appId, appFlowCreateRequestUio, instanceId, initOverrides) {
301
- const response = await this.createAppFlowRaw({ appId: appId, appFlowCreateRequestUio: appFlowCreateRequestUio, instanceId: instanceId }, initOverrides);
306
+ async createAppFlow(appId, appFlowCreateRequestUio, instanceId, ephemeral, initOverrides) {
307
+ const response = await this.createAppFlowRaw({ appId: appId, appFlowCreateRequestUio: appFlowCreateRequestUio, instanceId: instanceId, ephemeral: ephemeral }, initOverrides);
302
308
  return await response.value();
303
309
  }
304
310
  /**
@@ -14,15 +14,18 @@ import type { BodyWithIdUio, ChatMessageUio, Conversation1Uio, MessageUio, Promp
14
14
  export interface CreateConversationRequest {
15
15
  agentId: string;
16
16
  promptFlowCreateRequestUio: PromptFlowCreateRequestUio;
17
+ ephemeral?: boolean;
17
18
  }
18
19
  export interface CreateConversationWithFlowManagementRequest {
19
20
  agentId: string;
20
21
  promptFlowCreateRequestUio: PromptFlowCreateRequestUio;
22
+ ephemeral?: boolean;
21
23
  }
22
24
  export interface CreatePromptRequest {
23
25
  agentId: string;
24
26
  promptCreateRequestUio: PromptCreateRequestUio;
25
27
  async?: boolean;
28
+ ephemeral?: boolean;
26
29
  }
27
30
  export interface GetConversationByIdRequest {
28
31
  conversationId: string;
@@ -53,7 +56,7 @@ export declare class PromptsApi extends runtime.BaseAPI {
53
56
  * Create a new empty conversation for the specified agent.
54
57
  * Create a new conversation
55
58
  */
56
- createConversation(agentId: string, promptFlowCreateRequestUio: PromptFlowCreateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithIdUio>;
59
+ createConversation(agentId: string, promptFlowCreateRequestUio: PromptFlowCreateRequestUio, ephemeral?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithIdUio>;
57
60
  /**
58
61
  * Starts a new conversation session for the specified agent with flow management
59
62
  * Create a new conversation with flow management
@@ -63,7 +66,7 @@ export declare class PromptsApi extends runtime.BaseAPI {
63
66
  * Starts a new conversation session for the specified agent with flow management
64
67
  * Create a new conversation with flow management
65
68
  */
66
- createConversationWithFlowManagement(agentId: string, promptFlowCreateRequestUio: PromptFlowCreateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptFlowCreateResponseUio>;
69
+ createConversationWithFlowManagement(agentId: string, promptFlowCreateRequestUio: PromptFlowCreateRequestUio, ephemeral?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptFlowCreateResponseUio>;
67
70
  /**
68
71
  * Starts a new conversation session for the specified agent
69
72
  * Create a new prompt
@@ -73,7 +76,7 @@ export declare class PromptsApi extends runtime.BaseAPI {
73
76
  * Starts a new conversation session for the specified agent
74
77
  * Create a new prompt
75
78
  */
76
- createPrompt(agentId: string, promptCreateRequestUio: PromptCreateRequestUio, async?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptCreateResponseUio>;
79
+ createPrompt(agentId: string, promptCreateRequestUio: PromptCreateRequestUio, async?: boolean, ephemeral?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptCreateResponseUio>;
77
80
  /**
78
81
  * Retrieves details of a specific conversation including all messages
79
82
  * Get a conversation by ID
@@ -65,6 +65,9 @@ class PromptsApi extends runtime.BaseAPI {
65
65
  throw new runtime.RequiredError('promptFlowCreateRequestUio', 'Required parameter "promptFlowCreateRequestUio" was null or undefined when calling createConversation().');
66
66
  }
67
67
  const queryParameters = {};
68
+ if (requestParameters['ephemeral'] != null) {
69
+ queryParameters['ephemeral'] = requestParameters['ephemeral'];
70
+ }
68
71
  const headerParameters = {};
69
72
  headerParameters['Content-Type'] = 'application/json';
70
73
  if (this.configuration && this.configuration.apiKey) {
@@ -83,8 +86,8 @@ class PromptsApi extends runtime.BaseAPI {
83
86
  * Create a new empty conversation for the specified agent.
84
87
  * Create a new conversation
85
88
  */
86
- async createConversation(agentId, promptFlowCreateRequestUio, initOverrides) {
87
- const response = await this.createConversationRaw({ agentId: agentId, promptFlowCreateRequestUio: promptFlowCreateRequestUio }, initOverrides);
89
+ async createConversation(agentId, promptFlowCreateRequestUio, ephemeral, initOverrides) {
90
+ const response = await this.createConversationRaw({ agentId: agentId, promptFlowCreateRequestUio: promptFlowCreateRequestUio, ephemeral: ephemeral }, initOverrides);
88
91
  return await response.value();
89
92
  }
90
93
  /**
@@ -99,6 +102,9 @@ class PromptsApi extends runtime.BaseAPI {
99
102
  throw new runtime.RequiredError('promptFlowCreateRequestUio', 'Required parameter "promptFlowCreateRequestUio" was null or undefined when calling createConversationWithFlowManagement().');
100
103
  }
101
104
  const queryParameters = {};
105
+ if (requestParameters['ephemeral'] != null) {
106
+ queryParameters['ephemeral'] = requestParameters['ephemeral'];
107
+ }
102
108
  const headerParameters = {};
103
109
  headerParameters['Content-Type'] = 'application/json';
104
110
  if (this.configuration && this.configuration.apiKey) {
@@ -117,8 +123,8 @@ class PromptsApi extends runtime.BaseAPI {
117
123
  * Starts a new conversation session for the specified agent with flow management
118
124
  * Create a new conversation with flow management
119
125
  */
120
- async createConversationWithFlowManagement(agentId, promptFlowCreateRequestUio, initOverrides) {
121
- const response = await this.createConversationWithFlowManagementRaw({ agentId: agentId, promptFlowCreateRequestUio: promptFlowCreateRequestUio }, initOverrides);
126
+ async createConversationWithFlowManagement(agentId, promptFlowCreateRequestUio, ephemeral, initOverrides) {
127
+ const response = await this.createConversationWithFlowManagementRaw({ agentId: agentId, promptFlowCreateRequestUio: promptFlowCreateRequestUio, ephemeral: ephemeral }, initOverrides);
122
128
  return await response.value();
123
129
  }
124
130
  /**
@@ -136,6 +142,9 @@ class PromptsApi extends runtime.BaseAPI {
136
142
  if (requestParameters['async'] != null) {
137
143
  queryParameters['async'] = requestParameters['async'];
138
144
  }
145
+ if (requestParameters['ephemeral'] != null) {
146
+ queryParameters['ephemeral'] = requestParameters['ephemeral'];
147
+ }
139
148
  const headerParameters = {};
140
149
  headerParameters['Content-Type'] = 'application/json';
141
150
  if (this.configuration && this.configuration.apiKey) {
@@ -154,8 +163,8 @@ class PromptsApi extends runtime.BaseAPI {
154
163
  * Starts a new conversation session for the specified agent
155
164
  * Create a new prompt
156
165
  */
157
- async createPrompt(agentId, promptCreateRequestUio, async, initOverrides) {
158
- const response = await this.createPromptRaw({ agentId: agentId, promptCreateRequestUio: promptCreateRequestUio, async: async }, initOverrides);
166
+ async createPrompt(agentId, promptCreateRequestUio, async, ephemeral, initOverrides) {
167
+ const response = await this.createPromptRaw({ agentId: agentId, promptCreateRequestUio: promptCreateRequestUio, async: async, ephemeral: ephemeral }, initOverrides);
159
168
  return await response.value();
160
169
  }
161
170
  /**
package/dist/openapi.json CHANGED
@@ -1502,6 +1502,14 @@
1502
1502
  "format" : "uuid",
1503
1503
  "type" : "string"
1504
1504
  }
1505
+ }, {
1506
+ "description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
1507
+ "in" : "query",
1508
+ "name" : "ephemeral",
1509
+ "required" : false,
1510
+ "schema" : {
1511
+ "type" : "boolean"
1512
+ }
1505
1513
  } ],
1506
1514
  "requestBody" : {
1507
1515
  "content" : {
@@ -1744,7 +1752,7 @@
1744
1752
  },
1745
1753
  "/apps/{appId}/flows" : {
1746
1754
  "post" : {
1747
- "description" : "Create a flow",
1755
+ "description" : "Start a conversation with a flow.",
1748
1756
  "operationId" : "createAppFlow",
1749
1757
  "parameters" : [ {
1750
1758
  "description" : "ID of the app",
@@ -1761,6 +1769,14 @@
1761
1769
  "schema" : {
1762
1770
  "type" : "string"
1763
1771
  }
1772
+ }, {
1773
+ "description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
1774
+ "in" : "query",
1775
+ "name" : "ephemeral",
1776
+ "required" : false,
1777
+ "schema" : {
1778
+ "type" : "boolean"
1779
+ }
1764
1780
  } ],
1765
1781
  "requestBody" : {
1766
1782
  "content" : {
@@ -1784,7 +1800,7 @@
1784
1800
  "description" : "App Flow created successfully"
1785
1801
  }
1786
1802
  },
1787
- "summary" : "Create a flow",
1803
+ "summary" : "Start a chat with a flow",
1788
1804
  "tags" : [ "app" ]
1789
1805
  }
1790
1806
  },
@@ -1807,6 +1823,14 @@
1807
1823
  "schema" : {
1808
1824
  "type" : "string"
1809
1825
  }
1826
+ }, {
1827
+ "description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
1828
+ "in" : "query",
1829
+ "name" : "ephemeral",
1830
+ "required" : false,
1831
+ "schema" : {
1832
+ "type" : "boolean"
1833
+ }
1810
1834
  } ],
1811
1835
  "requestBody" : {
1812
1836
  "content" : {
@@ -7379,6 +7403,14 @@
7379
7403
  "format" : "uuid",
7380
7404
  "type" : "string"
7381
7405
  }
7406
+ }, {
7407
+ "description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
7408
+ "in" : "query",
7409
+ "name" : "ephemeral",
7410
+ "required" : false,
7411
+ "schema" : {
7412
+ "type" : "boolean"
7413
+ }
7382
7414
  } ],
7383
7415
  "requestBody" : {
7384
7416
  "content" : {
@@ -7442,6 +7474,14 @@
7442
7474
  "schema" : {
7443
7475
  "type" : "boolean"
7444
7476
  }
7477
+ }, {
7478
+ "description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
7479
+ "in" : "query",
7480
+ "name" : "ephemeral",
7481
+ "required" : false,
7482
+ "schema" : {
7483
+ "type" : "boolean"
7484
+ }
7445
7485
  } ],
7446
7486
  "requestBody" : {
7447
7487
  "content" : {
@@ -7948,6 +7988,15 @@
7948
7988
  "type" : "integer"
7949
7989
  }
7950
7990
  },
7991
+ "ephemeral" : {
7992
+ "description" : "If true, the resource will not appear in history and will be deleted after a certain time.",
7993
+ "in" : "query",
7994
+ "name" : "ephemeral",
7995
+ "required" : false,
7996
+ "schema" : {
7997
+ "type" : "boolean"
7998
+ }
7999
+ },
7951
8000
  "instanceId" : {
7952
8001
  "description" : "Instance id",
7953
8002
  "in" : "query",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breign/client",
3
- "version": "1.0.86",
3
+ "version": "1.0.87",
4
4
  "main": "dist/index.js",
5
5
  "exports": {
6
6
  ".": "./dist/index.js",