@orq-ai/node 4.2.0 → 4.2.3

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 (243) hide show
  1. package/FUNCTIONS.md +17 -7
  2. package/README.md +125 -70
  3. package/examples/contactsCreate.example.ts +42 -0
  4. package/examples/package-lock.json +1 -1
  5. package/funcs/contactsCreate.d.ts +3 -5
  6. package/funcs/contactsCreate.d.ts.map +1 -1
  7. package/funcs/contactsCreate.js +5 -9
  8. package/funcs/contactsCreate.js.map +1 -1
  9. package/jsr.json +1 -1
  10. package/lib/config.d.ts +2 -2
  11. package/lib/config.js +2 -2
  12. package/models/components/conversationresponse.js +1 -1
  13. package/models/components/conversationwithmessagesresponse.js +1 -1
  14. package/models/components/index.d.ts +1 -0
  15. package/models/components/index.d.ts.map +1 -1
  16. package/models/components/index.js +1 -0
  17. package/models/components/index.js.map +1 -1
  18. package/models/components/invokedeploymentrequest.d.ts +6 -0
  19. package/models/components/invokedeploymentrequest.d.ts.map +1 -1
  20. package/models/components/invokedeploymentrequest.js +2 -0
  21. package/models/components/invokedeploymentrequest.js.map +1 -1
  22. package/models/components/partdoneevent.js +1 -1
  23. package/models/components/publiccontact.d.ts +3 -1
  24. package/models/components/publiccontact.d.ts.map +1 -1
  25. package/models/components/publiccontact.js.map +1 -1
  26. package/models/components/publicidentity.d.ts +47 -0
  27. package/models/components/publicidentity.d.ts.map +1 -0
  28. package/models/{operations/deletecontact.js → components/publicidentity.js} +17 -6
  29. package/models/components/publicidentity.js.map +1 -0
  30. package/models/components/reasoningpart.js +1 -1
  31. package/models/errors/index.d.ts +0 -3
  32. package/models/errors/index.d.ts.map +1 -1
  33. package/models/errors/index.js +0 -3
  34. package/models/errors/index.js.map +1 -1
  35. package/models/operations/createchatcompletion.d.ts +9 -51
  36. package/models/operations/createchatcompletion.d.ts.map +1 -1
  37. package/models/operations/createchatcompletion.js +5 -24
  38. package/models/operations/createchatcompletion.js.map +1 -1
  39. package/models/operations/createcompletion.d.ts +9 -51
  40. package/models/operations/createcompletion.d.ts.map +1 -1
  41. package/models/operations/createcompletion.js +4 -22
  42. package/models/operations/createcompletion.js.map +1 -1
  43. package/models/operations/createcontact.d.ts +2 -6
  44. package/models/operations/createcontact.d.ts.map +1 -1
  45. package/models/operations/createcontact.js +1 -3
  46. package/models/operations/createcontact.js.map +1 -1
  47. package/models/operations/createconversation.js +1 -1
  48. package/models/operations/createconversationresponse.js +2 -2
  49. package/models/operations/createdataset.js +1 -1
  50. package/models/operations/createdatasetitem.js +4 -4
  51. package/models/operations/createdatasource.js +1 -1
  52. package/models/operations/createembedding.d.ts +9 -51
  53. package/models/operations/createembedding.d.ts.map +1 -1
  54. package/models/operations/createembedding.js +3 -21
  55. package/models/operations/createembedding.js.map +1 -1
  56. package/models/operations/createeval.js +14 -14
  57. package/models/operations/createidentity.js +1 -1
  58. package/models/operations/createimage.d.ts +9 -51
  59. package/models/operations/createimage.d.ts.map +1 -1
  60. package/models/operations/createimage.js +3 -21
  61. package/models/operations/createimage.js.map +1 -1
  62. package/models/operations/createimageedit.d.ts +9 -51
  63. package/models/operations/createimageedit.d.ts.map +1 -1
  64. package/models/operations/createimageedit.js +3 -21
  65. package/models/operations/createimageedit.js.map +1 -1
  66. package/models/operations/createimagevariation.d.ts +9 -51
  67. package/models/operations/createimagevariation.d.ts.map +1 -1
  68. package/models/operations/createimagevariation.js +3 -21
  69. package/models/operations/createimagevariation.js.map +1 -1
  70. package/models/operations/creatererank.d.ts +9 -51
  71. package/models/operations/creatererank.d.ts.map +1 -1
  72. package/models/operations/creatererank.js +3 -21
  73. package/models/operations/creatererank.js.map +1 -1
  74. package/models/operations/createspeech.d.ts +9 -51
  75. package/models/operations/createspeech.d.ts.map +1 -1
  76. package/models/operations/createspeech.js +3 -21
  77. package/models/operations/createspeech.js.map +1 -1
  78. package/models/operations/createtool.js +6 -6
  79. package/models/operations/createtranscription.d.ts +9 -51
  80. package/models/operations/createtranscription.d.ts.map +1 -1
  81. package/models/operations/createtranscription.js +3 -21
  82. package/models/operations/createtranscription.js.map +1 -1
  83. package/models/operations/createtranslation.d.ts +9 -51
  84. package/models/operations/createtranslation.d.ts.map +1 -1
  85. package/models/operations/createtranslation.js +3 -21
  86. package/models/operations/createtranslation.js.map +1 -1
  87. package/models/operations/deploymentgetconfig.d.ts +5 -0
  88. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  89. package/models/operations/deploymentgetconfig.js +1 -0
  90. package/models/operations/deploymentgetconfig.js.map +1 -1
  91. package/models/operations/deploymentstream.d.ts +5 -0
  92. package/models/operations/deploymentstream.d.ts.map +1 -1
  93. package/models/operations/deploymentstream.js +1 -0
  94. package/models/operations/deploymentstream.js.map +1 -1
  95. package/models/operations/fileget.js +1 -1
  96. package/models/operations/filelist.js +1 -1
  97. package/models/operations/fileupload.js +1 -1
  98. package/models/operations/generateconversationname.js +1 -1
  99. package/models/operations/getalltools.js +6 -6
  100. package/models/operations/getevals.d.ts +7 -7
  101. package/models/operations/getevals.d.ts.map +1 -1
  102. package/models/operations/getevals.js +25 -23
  103. package/models/operations/getevals.js.map +1 -1
  104. package/models/operations/index.d.ts +0 -4
  105. package/models/operations/index.d.ts.map +1 -1
  106. package/models/operations/index.js +0 -4
  107. package/models/operations/index.js.map +1 -1
  108. package/models/operations/listdatasetdatapoints.js +4 -4
  109. package/models/operations/listdatasets.js +1 -1
  110. package/models/operations/listdatasources.js +1 -1
  111. package/models/operations/listidentities.js +1 -1
  112. package/models/operations/retrievedatapoint.js +4 -4
  113. package/models/operations/retrievedataset.js +1 -1
  114. package/models/operations/retrievedatasource.js +1 -1
  115. package/models/operations/retrieveidentity.js +1 -1
  116. package/models/operations/retrievetool.js +6 -6
  117. package/models/operations/runagent.js +1 -1
  118. package/models/operations/streamrunagent.js +1 -1
  119. package/models/operations/updateconversation.js +1 -1
  120. package/models/operations/updatedatapoint.js +4 -4
  121. package/models/operations/updatedataset.js +1 -1
  122. package/models/operations/updatedatasource.js +1 -1
  123. package/models/operations/updateeval.js +14 -14
  124. package/models/operations/updateidentity.js +1 -1
  125. package/models/operations/updatetool.js +7 -7
  126. package/package.json +1 -1
  127. package/sdk/contacts.d.ts +3 -41
  128. package/sdk/contacts.d.ts.map +1 -1
  129. package/sdk/contacts.js +2 -52
  130. package/sdk/contacts.js.map +1 -1
  131. package/src/funcs/contactsCreate.ts +7 -14
  132. package/src/lib/config.ts +2 -2
  133. package/src/models/components/conversationresponse.ts +1 -1
  134. package/src/models/components/conversationwithmessagesresponse.ts +1 -1
  135. package/src/models/components/index.ts +1 -0
  136. package/src/models/components/invokedeploymentrequest.ts +11 -0
  137. package/src/models/components/partdoneevent.ts +1 -1
  138. package/src/models/components/publiccontact.ts +3 -1
  139. package/src/models/components/publicidentity.ts +69 -0
  140. package/src/models/components/reasoningpart.ts +1 -1
  141. package/src/models/errors/index.ts +0 -3
  142. package/src/models/operations/createchatcompletion.ts +11 -78
  143. package/src/models/operations/createcompletion.ts +11 -75
  144. package/src/models/operations/createcontact.ts +3 -9
  145. package/src/models/operations/createconversation.ts +1 -1
  146. package/src/models/operations/createconversationresponse.ts +2 -2
  147. package/src/models/operations/createdataset.ts +1 -1
  148. package/src/models/operations/createdatasetitem.ts +4 -4
  149. package/src/models/operations/createdatasource.ts +1 -1
  150. package/src/models/operations/createembedding.ts +11 -75
  151. package/src/models/operations/createeval.ts +14 -14
  152. package/src/models/operations/createidentity.ts +1 -1
  153. package/src/models/operations/createimage.ts +11 -75
  154. package/src/models/operations/createimageedit.ts +11 -75
  155. package/src/models/operations/createimagevariation.ts +11 -77
  156. package/src/models/operations/creatererank.ts +11 -75
  157. package/src/models/operations/createspeech.ts +11 -75
  158. package/src/models/operations/createtool.ts +6 -6
  159. package/src/models/operations/createtranscription.ts +11 -75
  160. package/src/models/operations/createtranslation.ts +11 -75
  161. package/src/models/operations/deploymentgetconfig.ts +6 -0
  162. package/src/models/operations/deploymentstream.ts +6 -0
  163. package/src/models/operations/fileget.ts +1 -1
  164. package/src/models/operations/filelist.ts +1 -1
  165. package/src/models/operations/fileupload.ts +1 -1
  166. package/src/models/operations/generateconversationname.ts +1 -1
  167. package/src/models/operations/getalltools.ts +6 -6
  168. package/src/models/operations/getevals.ts +35 -39
  169. package/src/models/operations/index.ts +0 -4
  170. package/src/models/operations/listdatasetdatapoints.ts +4 -4
  171. package/src/models/operations/listdatasets.ts +1 -1
  172. package/src/models/operations/listdatasources.ts +1 -1
  173. package/src/models/operations/listidentities.ts +1 -1
  174. package/src/models/operations/retrievedatapoint.ts +4 -4
  175. package/src/models/operations/retrievedataset.ts +1 -1
  176. package/src/models/operations/retrievedatasource.ts +1 -1
  177. package/src/models/operations/retrieveidentity.ts +1 -1
  178. package/src/models/operations/retrievetool.ts +6 -6
  179. package/src/models/operations/runagent.ts +1 -1
  180. package/src/models/operations/streamrunagent.ts +1 -1
  181. package/src/models/operations/updateconversation.ts +1 -1
  182. package/src/models/operations/updatedatapoint.ts +4 -4
  183. package/src/models/operations/updatedataset.ts +1 -1
  184. package/src/models/operations/updatedatasource.ts +1 -1
  185. package/src/models/operations/updateeval.ts +14 -14
  186. package/src/models/operations/updateidentity.ts +1 -1
  187. package/src/models/operations/updatetool.ts +7 -7
  188. package/src/sdk/contacts.ts +3 -85
  189. package/examples/feedbackCreate.example.ts +0 -32
  190. package/funcs/contactsDelete.d.ts +0 -20
  191. package/funcs/contactsDelete.d.ts.map +0 -1
  192. package/funcs/contactsDelete.js +0 -126
  193. package/funcs/contactsDelete.js.map +0 -1
  194. package/funcs/contactsList.d.ts +0 -19
  195. package/funcs/contactsList.d.ts.map +0 -1
  196. package/funcs/contactsList.js +0 -124
  197. package/funcs/contactsList.js.map +0 -1
  198. package/funcs/contactsRetrieve.d.ts +0 -20
  199. package/funcs/contactsRetrieve.d.ts.map +0 -1
  200. package/funcs/contactsRetrieve.js +0 -125
  201. package/funcs/contactsRetrieve.js.map +0 -1
  202. package/funcs/contactsUpdate.d.ts +0 -20
  203. package/funcs/contactsUpdate.d.ts.map +0 -1
  204. package/funcs/contactsUpdate.js +0 -126
  205. package/funcs/contactsUpdate.js.map +0 -1
  206. package/models/errors/deletecontact.d.ts +0 -30
  207. package/models/errors/deletecontact.d.ts.map +0 -1
  208. package/models/errors/deletecontact.js +0 -71
  209. package/models/errors/deletecontact.js.map +0 -1
  210. package/models/errors/retrievecontact.d.ts +0 -30
  211. package/models/errors/retrievecontact.d.ts.map +0 -1
  212. package/models/errors/retrievecontact.js +0 -71
  213. package/models/errors/retrievecontact.js.map +0 -1
  214. package/models/errors/updatecontact.d.ts +0 -26
  215. package/models/errors/updatecontact.d.ts.map +0 -1
  216. package/models/errors/updatecontact.js +0 -68
  217. package/models/errors/updatecontact.js.map +0 -1
  218. package/models/operations/deletecontact.d.ts +0 -15
  219. package/models/operations/deletecontact.d.ts.map +0 -1
  220. package/models/operations/deletecontact.js.map +0 -1
  221. package/models/operations/listcontacts.d.ts +0 -138
  222. package/models/operations/listcontacts.d.ts.map +0 -1
  223. package/models/operations/listcontacts.js +0 -136
  224. package/models/operations/listcontacts.js.map +0 -1
  225. package/models/operations/retrievecontact.d.ts +0 -63
  226. package/models/operations/retrievecontact.d.ts.map +0 -1
  227. package/models/operations/retrievecontact.js +0 -75
  228. package/models/operations/retrievecontact.js.map +0 -1
  229. package/models/operations/updatecontact.d.ts +0 -108
  230. package/models/operations/updatecontact.d.ts.map +0 -1
  231. package/models/operations/updatecontact.js +0 -97
  232. package/models/operations/updatecontact.js.map +0 -1
  233. package/src/funcs/contactsDelete.ts +0 -178
  234. package/src/funcs/contactsList.ts +0 -172
  235. package/src/funcs/contactsRetrieve.ts +0 -177
  236. package/src/funcs/contactsUpdate.ts +0 -178
  237. package/src/models/errors/deletecontact.ts +0 -62
  238. package/src/models/errors/retrievecontact.ts +0 -62
  239. package/src/models/errors/updatecontact.ts +0 -54
  240. package/src/models/operations/deletecontact.ts +0 -34
  241. package/src/models/operations/listcontacts.ts +0 -274
  242. package/src/models/operations/retrievecontact.ts +0 -117
  243. package/src/models/operations/updatecontact.ts +0 -188
@@ -1,188 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod/v3";
6
- import { remap as remap$ } from "../../lib/primitives.js";
7
- import { safeParse } from "../../lib/schemas.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
-
11
- /**
12
- * Contact fields to update
13
- */
14
- export type UpdateContactRequestBody = {
15
- /**
16
- * Display name or nickname of the contact user. This is typically shown in user interfaces.
17
- */
18
- displayName?: string | null | undefined;
19
- /**
20
- * Email address of the contact user
21
- */
22
- email?: string | null | undefined;
23
- /**
24
- * URL linking to the contact user's avatar image
25
- */
26
- avatarUrl?: string | null | undefined;
27
- /**
28
- * Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
29
- */
30
- tags?: Array<string> | undefined;
31
- /**
32
- * Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
33
- */
34
- metadata?: { [k: string]: any } | undefined;
35
- };
36
-
37
- export type UpdateContactRequest = {
38
- /**
39
- * Unique contact id or external id
40
- */
41
- id: string;
42
- /**
43
- * Contact fields to update
44
- */
45
- requestBody?: UpdateContactRequestBody | undefined;
46
- };
47
-
48
- /**
49
- * Updated contact
50
- */
51
- export type UpdateContactResponseBody = {
52
- /**
53
- * Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
54
- */
55
- id: string;
56
- /**
57
- * Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.
58
- */
59
- externalId: string;
60
- /**
61
- * Display name or nickname of the contact user. This is typically shown in user interfaces.
62
- */
63
- displayName?: string | null | undefined;
64
- /**
65
- * Email address of the contact user
66
- */
67
- email?: string | null | undefined;
68
- /**
69
- * URL linking to the contact user's avatar image
70
- */
71
- avatarUrl?: string | null | undefined;
72
- /**
73
- * Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
74
- */
75
- tags?: Array<string> | undefined;
76
- /**
77
- * Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
78
- */
79
- metadata?: { [k: string]: any } | undefined;
80
- /**
81
- * The date and time the resource was created
82
- */
83
- created?: Date | undefined;
84
- /**
85
- * The date and time the resource was last updated
86
- */
87
- updated: Date;
88
- };
89
-
90
- /** @internal */
91
- export type UpdateContactRequestBody$Outbound = {
92
- display_name?: string | null | undefined;
93
- email?: string | null | undefined;
94
- avatar_url?: string | null | undefined;
95
- tags?: Array<string> | undefined;
96
- metadata?: { [k: string]: any } | undefined;
97
- };
98
-
99
- /** @internal */
100
- export const UpdateContactRequestBody$outboundSchema: z.ZodType<
101
- UpdateContactRequestBody$Outbound,
102
- z.ZodTypeDef,
103
- UpdateContactRequestBody
104
- > = z.object({
105
- displayName: z.nullable(z.string()).optional(),
106
- email: z.nullable(z.string()).optional(),
107
- avatarUrl: z.nullable(z.string()).optional(),
108
- tags: z.array(z.string()).optional(),
109
- metadata: z.record(z.any()).optional(),
110
- }).transform((v) => {
111
- return remap$(v, {
112
- displayName: "display_name",
113
- avatarUrl: "avatar_url",
114
- });
115
- });
116
-
117
- export function updateContactRequestBodyToJSON(
118
- updateContactRequestBody: UpdateContactRequestBody,
119
- ): string {
120
- return JSON.stringify(
121
- UpdateContactRequestBody$outboundSchema.parse(updateContactRequestBody),
122
- );
123
- }
124
-
125
- /** @internal */
126
- export type UpdateContactRequest$Outbound = {
127
- id: string;
128
- RequestBody?: UpdateContactRequestBody$Outbound | undefined;
129
- };
130
-
131
- /** @internal */
132
- export const UpdateContactRequest$outboundSchema: z.ZodType<
133
- UpdateContactRequest$Outbound,
134
- z.ZodTypeDef,
135
- UpdateContactRequest
136
- > = z.object({
137
- id: z.string(),
138
- requestBody: z.lazy(() => UpdateContactRequestBody$outboundSchema).optional(),
139
- }).transform((v) => {
140
- return remap$(v, {
141
- requestBody: "RequestBody",
142
- });
143
- });
144
-
145
- export function updateContactRequestToJSON(
146
- updateContactRequest: UpdateContactRequest,
147
- ): string {
148
- return JSON.stringify(
149
- UpdateContactRequest$outboundSchema.parse(updateContactRequest),
150
- );
151
- }
152
-
153
- /** @internal */
154
- export const UpdateContactResponseBody$inboundSchema: z.ZodType<
155
- UpdateContactResponseBody,
156
- z.ZodTypeDef,
157
- unknown
158
- > = z.object({
159
- _id: z.string(),
160
- external_id: z.string(),
161
- display_name: z.nullable(z.string()).optional(),
162
- email: z.nullable(z.string()).optional(),
163
- avatar_url: z.nullable(z.string()).optional(),
164
- tags: z.array(z.string()).optional(),
165
- metadata: z.record(z.any()).optional(),
166
- created: z.string().datetime({ offset: true }).transform(v => new Date(v))
167
- .optional(),
168
- updated: z.string().datetime({ offset: true }).default(
169
- "2026-01-23T11:14:01.166Z",
170
- ).transform(v => new Date(v)),
171
- }).transform((v) => {
172
- return remap$(v, {
173
- "_id": "id",
174
- "external_id": "externalId",
175
- "display_name": "displayName",
176
- "avatar_url": "avatarUrl",
177
- });
178
- });
179
-
180
- export function updateContactResponseBodyFromJSON(
181
- jsonString: string,
182
- ): SafeParseResult<UpdateContactResponseBody, SDKValidationError> {
183
- return safeParse(
184
- jsonString,
185
- (x) => UpdateContactResponseBody$inboundSchema.parse(JSON.parse(x)),
186
- `Failed to parse 'UpdateContactResponseBody' from JSON`,
187
- );
188
- }