@orq-ai/node 3.6.5 → 3.6.7

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 (120) hide show
  1. package/FUNCTIONS.md +5 -22
  2. package/README.md +45 -47
  3. package/bin/mcp-server.js +43 -43
  4. package/bin/mcp-server.js.map +23 -23
  5. package/docs/sdks/contacts/README.md +5 -9
  6. package/docs/sdks/datasets/README.md +65 -111
  7. package/docs/sdks/deployments/README.md +34 -44
  8. package/docs/sdks/feedback/README.md +5 -9
  9. package/docs/sdks/files/README.md +20 -34
  10. package/docs/sdks/knowledge/README.md +80 -138
  11. package/docs/sdks/metrics/README.md +5 -9
  12. package/docs/sdks/models/README.md +5 -9
  13. package/docs/sdks/prompts/README.md +35 -61
  14. package/docs/sdks/remoteconfigs/README.md +5 -9
  15. package/jsr.json +1 -1
  16. package/lib/config.d.ts +3 -3
  17. package/lib/config.js +3 -3
  18. package/mcp-server/mcp-server.js +1 -1
  19. package/mcp-server/server.js +1 -1
  20. package/models/errors/apierror.d.ts +14 -2
  21. package/models/errors/apierror.d.ts.map +1 -1
  22. package/models/errors/apierror.js +1 -1
  23. package/models/errors/apierror.js.map +1 -1
  24. package/models/operations/bulkcreatedatapoints.js +2 -2
  25. package/models/operations/createcontact.js +2 -2
  26. package/models/operations/createdataset.js +2 -2
  27. package/models/operations/createdatasetitem.js +2 -2
  28. package/models/operations/createdatasource.js +2 -2
  29. package/models/operations/fileget.js +2 -2
  30. package/models/operations/filelist.js +2 -2
  31. package/models/operations/fileupload.js +2 -2
  32. package/models/operations/listdatasetdatapoints.js +2 -2
  33. package/models/operations/listdatasets.js +2 -2
  34. package/models/operations/listdatasources.js +2 -2
  35. package/models/operations/retrievedatapoint.js +2 -2
  36. package/models/operations/retrievedataset.js +2 -2
  37. package/models/operations/retrievedatasource.js +2 -2
  38. package/models/operations/updatedatapoint.js +2 -2
  39. package/models/operations/updatedataset.js +2 -2
  40. package/models/operations/updatedatasource.js +2 -2
  41. package/package.json +1 -1
  42. package/packages/orq-rc/FUNCTIONS.md +5 -22
  43. package/packages/orq-rc/README.md +129 -47
  44. package/packages/orq-rc/docs/sdks/contacts/README.md +344 -11
  45. package/packages/orq-rc/docs/sdks/datasets/README.md +60 -102
  46. package/packages/orq-rc/docs/sdks/deployments/README.md +34 -44
  47. package/packages/orq-rc/docs/sdks/evals/README.md +175 -315
  48. package/packages/orq-rc/docs/sdks/feedback/README.md +5 -9
  49. package/packages/orq-rc/docs/sdks/files/README.md +20 -34
  50. package/packages/orq-rc/docs/sdks/knowledge/README.md +80 -138
  51. package/packages/orq-rc/docs/sdks/metrics/README.md +5 -9
  52. package/packages/orq-rc/docs/sdks/models/README.md +5 -9
  53. package/packages/orq-rc/docs/sdks/prompts/README.md +35 -61
  54. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +5 -9
  55. package/packages/orq-rc/jsr.json +1 -1
  56. package/packages/orq-rc/package-lock.json +2 -2
  57. package/packages/orq-rc/package.json +1 -1
  58. package/packages/orq-rc/src/funcs/contactsCreate.ts +12 -7
  59. package/packages/orq-rc/src/funcs/contactsDelete.ts +172 -0
  60. package/packages/orq-rc/src/funcs/contactsList.ts +165 -0
  61. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +171 -0
  62. package/packages/orq-rc/src/funcs/contactsUpdate.ts +172 -0
  63. package/packages/orq-rc/src/lib/config.ts +3 -3
  64. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  65. package/packages/orq-rc/src/mcp-server/server.ts +9 -1
  66. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +3 -3
  67. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
  68. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
  69. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
  70. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
  71. package/packages/orq-rc/src/models/errors/apierror.ts +18 -3
  72. package/packages/orq-rc/src/models/errors/deletecontact.ts +81 -0
  73. package/packages/orq-rc/src/models/errors/index.ts +3 -0
  74. package/packages/orq-rc/src/models/errors/retrievecontact.ts +81 -0
  75. package/packages/orq-rc/src/models/errors/updatecontact.ts +74 -0
  76. package/packages/orq-rc/src/models/operations/createcontact.ts +30 -19
  77. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  78. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
  79. package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
  80. package/packages/orq-rc/src/models/operations/createeval.ts +16 -16
  81. package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
  82. package/packages/orq-rc/src/models/operations/deployments.ts +69 -59
  83. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  84. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  85. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  86. package/packages/orq-rc/src/models/operations/index.ts +4 -0
  87. package/packages/orq-rc/src/models/operations/listcontacts.ts +490 -0
  88. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
  89. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  90. package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
  91. package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
  92. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
  93. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  94. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
  95. package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
  96. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
  97. package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
  98. package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
  99. package/packages/orq-rc/src/sdk/contacts.ts +75 -3
  100. package/src/lib/config.ts +3 -3
  101. package/src/mcp-server/mcp-server.ts +1 -1
  102. package/src/mcp-server/server.ts +1 -1
  103. package/src/models/errors/apierror.ts +18 -3
  104. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  105. package/src/models/operations/createcontact.ts +2 -2
  106. package/src/models/operations/createdataset.ts +2 -2
  107. package/src/models/operations/createdatasetitem.ts +2 -2
  108. package/src/models/operations/createdatasource.ts +2 -2
  109. package/src/models/operations/fileget.ts +2 -2
  110. package/src/models/operations/filelist.ts +2 -2
  111. package/src/models/operations/fileupload.ts +2 -2
  112. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  113. package/src/models/operations/listdatasets.ts +2 -2
  114. package/src/models/operations/listdatasources.ts +2 -2
  115. package/src/models/operations/retrievedatapoint.ts +2 -2
  116. package/src/models/operations/retrievedataset.ts +2 -2
  117. package/src/models/operations/retrievedatasource.ts +2 -2
  118. package/src/models/operations/updatedatapoint.ts +2 -2
  119. package/src/models/operations/updatedataset.ts +2 -2
  120. package/src/models/operations/updatedatasource.ts +2 -2
@@ -29,7 +29,6 @@ const orq = new Orq({
29
29
  async function run() {
30
30
  const result = await orq.prompts.list({});
31
31
 
32
- // Handle the result
33
32
  console.log(result);
34
33
  }
35
34
 
@@ -52,15 +51,12 @@ const orq = new OrqCore({
52
51
 
53
52
  async function run() {
54
53
  const res = await promptsList(orq, {});
55
-
56
- if (!res.ok) {
57
- throw res.error;
54
+ if (res.ok) {
55
+ const { value: result } = res;
56
+ console.log(result);
57
+ } else {
58
+ console.log("promptsList failed:", res.error);
58
59
  }
59
-
60
- const { value: result } = res;
61
-
62
- // Handle the result
63
- console.log(result);
64
60
  }
65
61
 
66
62
  run();
@@ -116,7 +112,6 @@ async function run() {
116
112
  path: "Default",
117
113
  });
118
114
 
119
- // Handle the result
120
115
  console.log(result);
121
116
  }
122
117
 
@@ -154,15 +149,12 @@ async function run() {
154
149
  },
155
150
  path: "Default",
156
151
  });
157
-
158
- if (!res.ok) {
159
- throw res.error;
152
+ if (res.ok) {
153
+ const { value: result } = res;
154
+ console.log(result);
155
+ } else {
156
+ console.log("promptsCreate failed:", res.error);
160
157
  }
161
-
162
- const { value: result } = res;
163
-
164
- // Handle the result
165
- console.log(result);
166
158
  }
167
159
 
168
160
  run();
@@ -205,7 +197,6 @@ async function run() {
205
197
  id: "<id>",
206
198
  });
207
199
 
208
- // Handle the result
209
200
  console.log(result);
210
201
  }
211
202
 
@@ -230,15 +221,12 @@ async function run() {
230
221
  const res = await promptsRetrieve(orq, {
231
222
  id: "<id>",
232
223
  });
233
-
234
- if (!res.ok) {
235
- throw res.error;
224
+ if (res.ok) {
225
+ const { value: result } = res;
226
+ console.log(result);
227
+ } else {
228
+ console.log("promptsRetrieve failed:", res.error);
236
229
  }
237
-
238
- const { value: result } = res;
239
-
240
- // Handle the result
241
- console.log(result);
242
230
  }
243
231
 
244
232
  run();
@@ -284,7 +272,6 @@ async function run() {
284
272
  },
285
273
  });
286
274
 
287
- // Handle the result
288
275
  console.log(result);
289
276
  }
290
277
 
@@ -312,15 +299,12 @@ async function run() {
312
299
  path: "Default",
313
300
  },
314
301
  });
315
-
316
- if (!res.ok) {
317
- throw res.error;
302
+ if (res.ok) {
303
+ const { value: result } = res;
304
+ console.log(result);
305
+ } else {
306
+ console.log("promptsUpdate failed:", res.error);
318
307
  }
319
-
320
- const { value: result } = res;
321
-
322
- // Handle the result
323
- console.log(result);
324
308
  }
325
309
 
326
310
  run();
@@ -388,14 +372,12 @@ async function run() {
388
372
  const res = await promptsDelete(orq, {
389
373
  id: "<id>",
390
374
  });
391
-
392
- if (!res.ok) {
393
- throw res.error;
375
+ if (res.ok) {
376
+ const { value: result } = res;
377
+
378
+ } else {
379
+ console.log("promptsDelete failed:", res.error);
394
380
  }
395
-
396
- const { value: result } = res;
397
-
398
-
399
381
  }
400
382
 
401
383
  run();
@@ -438,7 +420,6 @@ async function run() {
438
420
  promptId: "<id>",
439
421
  });
440
422
 
441
- // Handle the result
442
423
  console.log(result);
443
424
  }
444
425
 
@@ -463,15 +444,12 @@ async function run() {
463
444
  const res = await promptsListVersions(orq, {
464
445
  promptId: "<id>",
465
446
  });
466
-
467
- if (!res.ok) {
468
- throw res.error;
447
+ if (res.ok) {
448
+ const { value: result } = res;
449
+ console.log(result);
450
+ } else {
451
+ console.log("promptsListVersions failed:", res.error);
469
452
  }
470
-
471
- const { value: result } = res;
472
-
473
- // Handle the result
474
- console.log(result);
475
453
  }
476
454
 
477
455
  run();
@@ -515,7 +493,6 @@ async function run() {
515
493
  versionId: "<id>",
516
494
  });
517
495
 
518
- // Handle the result
519
496
  console.log(result);
520
497
  }
521
498
 
@@ -541,15 +518,12 @@ async function run() {
541
518
  promptId: "<id>",
542
519
  versionId: "<id>",
543
520
  });
544
-
545
- if (!res.ok) {
546
- throw res.error;
521
+ if (res.ok) {
522
+ const { value: result } = res;
523
+ console.log(result);
524
+ } else {
525
+ console.log("promptsGetVersion failed:", res.error);
547
526
  }
548
-
549
- const { value: result } = res;
550
-
551
- // Handle the result
552
- console.log(result);
553
527
  }
554
528
 
555
529
  run();
@@ -23,7 +23,6 @@ const orq = new Orq({
23
23
  async function run() {
24
24
  const result = await orq.remoteconfigs.retrieve();
25
25
 
26
- // Handle the result
27
26
  console.log(result);
28
27
  }
29
28
 
@@ -46,15 +45,12 @@ const orq = new OrqCore({
46
45
 
47
46
  async function run() {
48
47
  const res = await remoteconfigsRetrieve(orq);
49
-
50
- if (!res.ok) {
51
- throw res.error;
48
+ if (res.ok) {
49
+ const { value: result } = res;
50
+ console.log(result);
51
+ } else {
52
+ console.log("remoteconfigsRetrieve failed:", res.error);
52
53
  }
53
-
54
- const { value: result } = res;
55
-
56
- // Handle the result
57
- console.log(result);
58
54
  }
59
55
 
60
56
  run();
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@orq-ai/node",
5
- "version": "3.7.0-rc.8",
5
+ "version": "3.8.0-rc.1",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.7.0-rc.8",
3
+ "version": "3.8.0-rc.1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@orq-ai/node",
9
- "version": "3.7.0-rc.8",
9
+ "version": "3.8.0-rc.1",
10
10
  "bin": {
11
11
  "mcp": "bin/mcp-server.js"
12
12
  },
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.7.0-rc.8",
3
+ "version": "3.8.0-rc.1",
4
4
  "author": "Orq",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
@@ -24,14 +24,14 @@ import { APICall, APIPromise } from "../types/async.js";
24
24
  import { Result } from "../types/fp.js";
25
25
 
26
26
  /**
27
- * Update user information
27
+ * Create a contact
28
28
  *
29
29
  * @remarks
30
- * Update or add user information to workspace
30
+ * Creates a new contact or updates an existing one based on external_id. Use this endpoint to add users from your system to orq.ai for tracking their usage and engagement.
31
31
  */
32
32
  export function contactsCreate(
33
33
  client: OrqCore,
34
- request: operations.CreateContactRequestBody,
34
+ request?: operations.CreateContactRequestBody | undefined,
35
35
  options?: RequestOptions,
36
36
  ): APIPromise<
37
37
  Result<
@@ -54,7 +54,7 @@ export function contactsCreate(
54
54
 
55
55
  async function $do(
56
56
  client: OrqCore,
57
- request: operations.CreateContactRequestBody,
57
+ request?: operations.CreateContactRequestBody | undefined,
58
58
  options?: RequestOptions,
59
59
  ): Promise<
60
60
  [
@@ -73,14 +73,19 @@ async function $do(
73
73
  > {
74
74
  const parsed = safeParse(
75
75
  request,
76
- (value) => operations.CreateContactRequestBody$outboundSchema.parse(value),
76
+ (value) =>
77
+ operations.CreateContactRequestBody$outboundSchema.optional().parse(
78
+ value,
79
+ ),
77
80
  "Input validation failed",
78
81
  );
79
82
  if (!parsed.ok) {
80
83
  return [parsed, { status: "invalid" }];
81
84
  }
82
85
  const payload = parsed.value;
83
- const body = encodeJSON("body", payload, { explode: true });
86
+ const body = payload === undefined
87
+ ? null
88
+ : encodeJSON("body", payload, { explode: true });
84
89
 
85
90
  const path = pathToFunc("/v2/contacts")();
86
91
 
@@ -144,7 +149,7 @@ async function $do(
144
149
  | RequestTimeoutError
145
150
  | ConnectionError
146
151
  >(
147
- M.json(200, operations.CreateContactResponseBody$inboundSchema),
152
+ M.json(201, operations.CreateContactResponseBody$inboundSchema),
148
153
  M.fail("4XX"),
149
154
  M.fail("5XX"),
150
155
  )(response);
@@ -0,0 +1,172 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { OrqCore } from "../core.js";
7
+ import { encodeSimple } from "../lib/encodings.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import { APIError } from "../models/errors/apierror.js";
15
+ import {
16
+ ConnectionError,
17
+ InvalidRequestError,
18
+ RequestAbortedError,
19
+ RequestTimeoutError,
20
+ UnexpectedClientError,
21
+ } from "../models/errors/httpclienterrors.js";
22
+ import * as errors from "../models/errors/index.js";
23
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
24
+ import * as operations from "../models/operations/index.js";
25
+ import { APICall, APIPromise } from "../types/async.js";
26
+ import { Result } from "../types/fp.js";
27
+
28
+ /**
29
+ * Delete a contact
30
+ *
31
+ * @remarks
32
+ * Permanently deletes a contact from your workspace. This action cannot be undone.
33
+ */
34
+ export function contactsDelete(
35
+ client: OrqCore,
36
+ request: operations.DeleteContactRequest,
37
+ options?: RequestOptions,
38
+ ): APIPromise<
39
+ Result<
40
+ void,
41
+ | errors.DeleteContactResponseBody
42
+ | APIError
43
+ | SDKValidationError
44
+ | UnexpectedClientError
45
+ | InvalidRequestError
46
+ | RequestAbortedError
47
+ | RequestTimeoutError
48
+ | ConnectionError
49
+ >
50
+ > {
51
+ return new APIPromise($do(
52
+ client,
53
+ request,
54
+ options,
55
+ ));
56
+ }
57
+
58
+ async function $do(
59
+ client: OrqCore,
60
+ request: operations.DeleteContactRequest,
61
+ options?: RequestOptions,
62
+ ): Promise<
63
+ [
64
+ Result<
65
+ void,
66
+ | errors.DeleteContactResponseBody
67
+ | APIError
68
+ | SDKValidationError
69
+ | UnexpectedClientError
70
+ | InvalidRequestError
71
+ | RequestAbortedError
72
+ | RequestTimeoutError
73
+ | ConnectionError
74
+ >,
75
+ APICall,
76
+ ]
77
+ > {
78
+ const parsed = safeParse(
79
+ request,
80
+ (value) => operations.DeleteContactRequest$outboundSchema.parse(value),
81
+ "Input validation failed",
82
+ );
83
+ if (!parsed.ok) {
84
+ return [parsed, { status: "invalid" }];
85
+ }
86
+ const payload = parsed.value;
87
+ const body = null;
88
+
89
+ const pathParams = {
90
+ id: encodeSimple("id", payload.id, {
91
+ explode: false,
92
+ charEncoding: "percent",
93
+ }),
94
+ };
95
+
96
+ const path = pathToFunc("/v2/contacts/{id}")(pathParams);
97
+
98
+ const headers = new Headers(compactMap({
99
+ Accept: "application/json",
100
+ }));
101
+
102
+ const secConfig = await extractSecurity(client._options.apiKey);
103
+ const securityInput = secConfig == null ? {} : { apiKey: secConfig };
104
+ const requestSecurity = resolveGlobalSecurity(securityInput);
105
+
106
+ const context = {
107
+ options: client._options,
108
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
109
+ operationID: "DeleteContact",
110
+ oAuth2Scopes: [],
111
+
112
+ resolvedSecurity: requestSecurity,
113
+
114
+ securitySource: client._options.apiKey,
115
+ retryConfig: options?.retries
116
+ || client._options.retryConfig
117
+ || { strategy: "none" },
118
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
119
+ };
120
+
121
+ const requestRes = client._createRequest(context, {
122
+ security: requestSecurity,
123
+ method: "DELETE",
124
+ baseURL: options?.serverURL,
125
+ path: path,
126
+ headers: headers,
127
+ body: body,
128
+ userAgent: client._options.userAgent,
129
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
130
+ }, options);
131
+ if (!requestRes.ok) {
132
+ return [requestRes, { status: "invalid" }];
133
+ }
134
+ const req = requestRes.value;
135
+
136
+ const doResult = await client._do(req, {
137
+ context,
138
+ errorCodes: ["404", "4XX", "5XX"],
139
+ retryConfig: context.retryConfig,
140
+ retryCodes: context.retryCodes,
141
+ });
142
+ if (!doResult.ok) {
143
+ return [doResult, { status: "request-error", request: req }];
144
+ }
145
+ const response = doResult.value;
146
+
147
+ const responseFields = {
148
+ HttpMeta: { Response: response, Request: req },
149
+ };
150
+
151
+ const [result] = await M.match<
152
+ void,
153
+ | errors.DeleteContactResponseBody
154
+ | APIError
155
+ | SDKValidationError
156
+ | UnexpectedClientError
157
+ | InvalidRequestError
158
+ | RequestAbortedError
159
+ | RequestTimeoutError
160
+ | ConnectionError
161
+ >(
162
+ M.nil(204, z.void()),
163
+ M.jsonErr(404, errors.DeleteContactResponseBody$inboundSchema),
164
+ M.fail("4XX"),
165
+ M.fail("5XX"),
166
+ )(response, { extraFields: responseFields });
167
+ if (!result.ok) {
168
+ return [result, { status: "complete", request: req, response }];
169
+ }
170
+
171
+ return [result, { status: "complete", request: req, response }];
172
+ }
@@ -0,0 +1,165 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { OrqCore } from "../core.js";
6
+ import { encodeFormQuery } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import { APIError } from "../models/errors/apierror.js";
14
+ import {
15
+ ConnectionError,
16
+ InvalidRequestError,
17
+ RequestAbortedError,
18
+ RequestTimeoutError,
19
+ UnexpectedClientError,
20
+ } from "../models/errors/httpclienterrors.js";
21
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
22
+ import * as operations from "../models/operations/index.js";
23
+ import { APICall, APIPromise } from "../types/async.js";
24
+ import { Result } from "../types/fp.js";
25
+
26
+ /**
27
+ * List contacts
28
+ *
29
+ * @remarks
30
+ * Retrieves a paginated list of contacts in your workspace. Use pagination parameters to navigate through large contact lists efficiently.
31
+ */
32
+ export function contactsList(
33
+ client: OrqCore,
34
+ request?: operations.ListContactsRequest | undefined,
35
+ options?: RequestOptions,
36
+ ): APIPromise<
37
+ Result<
38
+ operations.ListContactsResponseBody,
39
+ | APIError
40
+ | SDKValidationError
41
+ | UnexpectedClientError
42
+ | InvalidRequestError
43
+ | RequestAbortedError
44
+ | RequestTimeoutError
45
+ | ConnectionError
46
+ >
47
+ > {
48
+ return new APIPromise($do(
49
+ client,
50
+ request,
51
+ options,
52
+ ));
53
+ }
54
+
55
+ async function $do(
56
+ client: OrqCore,
57
+ request?: operations.ListContactsRequest | undefined,
58
+ options?: RequestOptions,
59
+ ): Promise<
60
+ [
61
+ Result<
62
+ operations.ListContactsResponseBody,
63
+ | APIError
64
+ | SDKValidationError
65
+ | UnexpectedClientError
66
+ | InvalidRequestError
67
+ | RequestAbortedError
68
+ | RequestTimeoutError
69
+ | ConnectionError
70
+ >,
71
+ APICall,
72
+ ]
73
+ > {
74
+ const parsed = safeParse(
75
+ request,
76
+ (value) =>
77
+ operations.ListContactsRequest$outboundSchema.optional().parse(value),
78
+ "Input validation failed",
79
+ );
80
+ if (!parsed.ok) {
81
+ return [parsed, { status: "invalid" }];
82
+ }
83
+ const payload = parsed.value;
84
+ const body = null;
85
+
86
+ const path = pathToFunc("/v2/contacts")();
87
+
88
+ const query = encodeFormQuery({
89
+ "ending_before": payload?.ending_before,
90
+ "filter_by": payload?.filter_by,
91
+ "include_metrics": payload?.include_metrics,
92
+ "limit": payload?.limit,
93
+ "starting_after": payload?.starting_after,
94
+ });
95
+
96
+ const headers = new Headers(compactMap({
97
+ Accept: "application/json",
98
+ }));
99
+
100
+ const secConfig = await extractSecurity(client._options.apiKey);
101
+ const securityInput = secConfig == null ? {} : { apiKey: secConfig };
102
+ const requestSecurity = resolveGlobalSecurity(securityInput);
103
+
104
+ const context = {
105
+ options: client._options,
106
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
107
+ operationID: "ListContacts",
108
+ oAuth2Scopes: [],
109
+
110
+ resolvedSecurity: requestSecurity,
111
+
112
+ securitySource: client._options.apiKey,
113
+ retryConfig: options?.retries
114
+ || client._options.retryConfig
115
+ || { strategy: "none" },
116
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
117
+ };
118
+
119
+ const requestRes = client._createRequest(context, {
120
+ security: requestSecurity,
121
+ method: "GET",
122
+ baseURL: options?.serverURL,
123
+ path: path,
124
+ headers: headers,
125
+ query: query,
126
+ body: body,
127
+ userAgent: client._options.userAgent,
128
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
129
+ }, options);
130
+ if (!requestRes.ok) {
131
+ return [requestRes, { status: "invalid" }];
132
+ }
133
+ const req = requestRes.value;
134
+
135
+ const doResult = await client._do(req, {
136
+ context,
137
+ errorCodes: ["4XX", "5XX"],
138
+ retryConfig: context.retryConfig,
139
+ retryCodes: context.retryCodes,
140
+ });
141
+ if (!doResult.ok) {
142
+ return [doResult, { status: "request-error", request: req }];
143
+ }
144
+ const response = doResult.value;
145
+
146
+ const [result] = await M.match<
147
+ operations.ListContactsResponseBody,
148
+ | APIError
149
+ | SDKValidationError
150
+ | UnexpectedClientError
151
+ | InvalidRequestError
152
+ | RequestAbortedError
153
+ | RequestTimeoutError
154
+ | ConnectionError
155
+ >(
156
+ M.json(200, operations.ListContactsResponseBody$inboundSchema),
157
+ M.fail("4XX"),
158
+ M.fail("5XX"),
159
+ )(response);
160
+ if (!result.ok) {
161
+ return [result, { status: "complete", request: req, response }];
162
+ }
163
+
164
+ return [result, { status: "complete", request: req, response }];
165
+ }