syllable-sdk 0.1.0-alpha.29 → 0.1.0-alpha.30

package/.devcontainer/devcontainer.json

@@ -0,0 +1,45 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
+{
+    "name": "TypeScript",
+    "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.vscode-typescript-tslint-plugin",
+                "esbenp.prettier-vscode",
+                "github.vscode-pull-request-github"
+            ],
+            "settings": {
+                "files.eol": "\n",
+                "editor.formatOnSave": true,
+                "typescript.tsc.autoDetect": "on",
+                "typescript.updateImportsOnFileMove.enabled": "always",
+                "typescript.preferences.importModuleSpecifier": "relative",
+                "[typescript]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true
+                    }
+                },
+                "[typescriptreact]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true
+                    }
+                }
+            }
+        },
+        "codespaces": {
+            "openFiles": [
+                ".devcontainer/README.md"
+            ]
+        }
+    }
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root"
+}

package/README.md

@@ -1,6 +1,6 @@
 # syllable-sdk
 
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *syllable-sdk* API.
+Developer-friendly & type-safe TypeScript SDK specifically catered to leverage *syllable-sdk* API.
 
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=syllable-sdk&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -44,7 +44,6 @@ assistants, or any other AI-driven solutions, Syllable SDK has got you covered.
   * [SDK Example Usage](#sdk-example-usage)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
-  * [File uploads](#file-uploads)
   * [Retries](#retries)
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
@@ -171,16 +170,6 @@ run();
 * [postSessionTransfersDashboard](docs/sdks/dashboards/README.md#postsessiontransfersdashboard) - Post Session Transfers
 * [postSessionsDashboard](docs/sdks/dashboards/README.md#postsessionsdashboard) - Post Sessions
 
-### [directory](docs/sdks/directory/README.md)
-
-* [list](docs/sdks/directory/README.md#list) - Directory Member List
-* [create](docs/sdks/directory/README.md#create) - Create Directory Member
-* [getById](docs/sdks/directory/README.md#getbyid) - Get Directory Member By Id
-* [update](docs/sdks/directory/README.md#update) - Update Directory Member
-* [delete](docs/sdks/directory/README.md#delete) - Delete Directory Member
-* [directoryMemberBulkLoad](docs/sdks/directory/README.md#directorymemberbulkload) - Bulk Load Directory Members
-* [directoryMemberDownload](docs/sdks/directory/README.md#directorymemberdownload) - Download Directory Members
-
 ### [events](docs/sdks/events/README.md)
 
 * [list](docs/sdks/events/README.md#list) - Events List
@@ -274,13 +263,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`dashboardsPostSessionsDashboard`](docs/sdks/dashboards/README.md#postsessionsdashboard) - Post Sessions
 - [`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard) - Post Session Summary
 - [`dashboardsPostSessionTransfersDashboard`](docs/sdks/dashboards/README.md#postsessiontransfersdashboard) - Post Session Transfers
-- [`directoryCreate`](docs/sdks/directory/README.md#create) - Create Directory Member
-- [`directoryDelete`](docs/sdks/directory/README.md#delete) - Delete Directory Member
-- [`directoryDirectoryMemberBulkLoad`](docs/sdks/directory/README.md#directorymemberbulkload) - Bulk Load Directory Members
-- [`directoryDirectoryMemberDownload`](docs/sdks/directory/README.md#directorymemberdownload) - Download Directory Members
-- [`directoryGetById`](docs/sdks/directory/README.md#getbyid) - Get Directory Member By Id
-- [`directoryList`](docs/sdks/directory/README.md#list) - Directory Member List
-- [`directoryUpdate`](docs/sdks/directory/README.md#update) - Update Directory Member
 - [`eventsList`](docs/sdks/events/README.md#list) - Events List
 - [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create Prompt
 - [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
@@ -311,42 +293,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
-<!-- Start File uploads [file-upload] -->
-## File uploads
-
-Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
-
-> [!TIP]
->
-> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
->
-> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
-> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
-> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
-> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
-
-```typescript
-import { openAsBlob } from "node:fs";
-import { SyllableSDK } from "syllable-sdk";
-
-const syllableSDK = new SyllableSDK({
-  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
-});
-
-async function run() {
-  const result = await syllableSDK.directory.directoryMemberBulkLoad({
-    file: await openAsBlob("example.file"),
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-
-```
-<!-- End File uploads [file-upload] -->
-
 <!-- Start Retries [retries] -->
 ## Retries