@gleanwork/api-client 0.2.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, Glean Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -13,12 +13,24 @@ Each namespace has its own authentication requirements and access patterns. Whil
 
 ```typescript
 // Example of accessing Client namespace
-const glean = new Glean({ apiToken: "client-token" });
-await glean.client.search.query({ query: "search term" });
+const glean = new Glean({
+  instance: 'instance-name',
+  apiToken: 'client-token'
+});
+
+await glean.client.search.query({ 
+  query: 'search term' 
+});
 
 // Example of accessing Indexing namespace 
-const glean = new Glean({ apiToken: "indexing-token" });
-await glean.indexing.documents.index({ /* document data */ });
+const glean = new Glean({
+  instance: 'instance-name',
+  apiToken: 'indexing-token'
+});
+
+await glean.indexing.documents.index({ 
+  /* document data */ 
+});
 ```
 
 Remember that each namespace requires its own authentication token type as described in the [Authentication Methods](#authentication-methods) section.
@@ -866,11 +878,11 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 ### Server Variables
 
-The default server `https://{domain}-be.glean.com` contains variables and is set to `https://domain-be.glean.com` by default. To override default values, the following parameters are available when initializing the SDK client instance:
+The default server `https://{instance}-be.glean.com` contains variables and is set to `https://instance-name-be.glean.com` by default. To override default values, the following parameters are available when initializing the SDK client instance:
 
-| Variable | Parameter        | Default    | Description                                                              |
-| -------- | ---------------- | ---------- | ------------------------------------------------------------------------ |
-| `domain` | `domain: string` | `"domain"` | Email domain (without extension) that determines the deployment backend. |
+| Variable   | Parameter          | Default           | Description                                                                                                  |
+| ---------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------ |
+| `instance` | `instance: string` | `"instance-name"` | The instance name (typically the email domain without the extension) that determines the deployment backend. |
 
 #### Example
 
@@ -878,7 +890,7 @@ The default server `https://{domain}-be.glean.com` contains variables and is set
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  domain: "scared-pearl.biz",
+  instance: "<value>",
   apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
@@ -922,7 +934,7 @@ The default server can be overridden globally by passing a URL to the `serverURL
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  serverURL: "https://domain-be.glean.com",
+  serverURL: "https://instance-name-be.glean.com",
   apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });