@orq-ai/node 3.6.0 → 3.7.0-rc.1

package/packages/orq-rc/RUNTIMES.md

@@ -1,48 +0,0 @@
-# Supported JavaScript runtimes
-
-This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
-
-* [Web Fetch API][web-fetch]
-* [Web Streams API][web-streams] and in particular `ReadableStream`
-* [Async iterables][async-iter] using `Symbol.asyncIterator`
-
-[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
-[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
-[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
-
-Runtime environments that are explicitly supported are:
-
-- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
-- Node.js active and maintenance LTS releases
-  - Currently, this is v18 and v20
-- Bun v1 and above
-- Deno v1.39
-  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
-
-[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
-
-## Recommended TypeScript compiler options
-
-The following `tsconfig.json` options are recommended for projects using this
-SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
-[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
-so on):
-
-[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
-[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
-[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
-[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
-
-```jsonc
-{
-  "compilerOptions": {
-    "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"],
-  }
-}
-```
-
-While `target` can be set to older ECMAScript versions, it may result in extra,
-unnecessary compatibility code being generated if you are not targeting old
-runtimes.

package/packages/orq-rc/docs/sdks/contacts/README.md

@@ -1,84 +0,0 @@
-# Contacts
-(*contacts*)
-
-## Overview
-
-### Available Operations
-
-* [create](#create) - Update user information
-
-## create
-
-Update or add user information to workspace
-
-### Example Usage
-
-```typescript
-import { Orq } from "@orq-ai/node";
-
-const orq = new Orq({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await orq.contacts.create({
-    externalId: "<id>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OrqCore } from "@orq-ai/node/core.js";
-import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
-
-// Use `OrqCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const orq = new OrqCore({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await contactsCreate(orq, {
-    externalId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateContactRequestBody](../../models/operations/createcontactrequestbody.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.CreateContactResponseBody](../../models/operations/createcontactresponsebody.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |