@gleanwork/api-client 0.5.3 → 0.6.1

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.
package/README.md CHANGED
@@ -297,7 +297,7 @@ For more information on obtaining the appropriate token type, please contact you
297
297
  * [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
298
298
  * [list](docs/sdks/agents/README.md#list) - Search agents
299
299
  * [runStream](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
300
- * [run](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
300
+ * [run](docs/sdks/agents/README.md#run) - Create an agent run and wait for the response
301
301
 
302
302
  #### [client.announcements](docs/sdks/announcements/README.md)
303
303
 
@@ -511,7 +511,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
511
511
  - [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search agents
512
512
  - [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
513
513
  - [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
514
- - [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
514
+ - [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create an agent run and wait for the response
515
515
  - [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
516
516
  - [`clientAnnouncementsCreate`](docs/sdks/announcements/README.md#create) - Create Announcement
517
517
  - [`clientAnnouncementsDelete`](docs/sdks/announcements/README.md#delete) - Delete Announcement
@@ -650,7 +650,7 @@ To learn about this feature and how to get started, check
650
650
  - [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search agents
651
651
  - [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
652
652
  - [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
653
- - [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
653
+ - [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create an agent run and wait for the response
654
654
  - [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
655
655
  - [`useClientAnnouncementsCreateMutation`](docs/sdks/announcements/README.md#create) - Create Announcement
656
656
  - [`useClientAnnouncementsDeleteMutation`](docs/sdks/announcements/README.md#delete) - Delete Announcement
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
10
+ * Create an agent run and wait for the response
11
11
  *
12
12
  * @remarks
13
- * Executes an agent run and returns the final response.
13
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
14
14
  */
15
15
  export declare function clientAgentsRun(client: GleanCore, request: components.AgentRunCreate, options?: RequestOptions): APIPromise<Result<components.AgentRunWaitResponse, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsRun.d.ts.map
@@ -46,10 +46,10 @@ const url_js_1 = require("../lib/url.js");
46
46
  const components = __importStar(require("../models/components/index.js"));
47
47
  const async_js_1 = require("../types/async.js");
48
48
  /**
49
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
49
+ * Create an agent run and wait for the response
50
50
  *
51
51
  * @remarks
52
- * Executes an agent run and returns the final response.
52
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
53
53
  */
54
54
  function clientAgentsRun(client, request, options) {
55
55
  return new async_js_1.APIPromise($do(client, request, options));
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
31
31
  export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
33
  readonly openapiDocVersion: "0.9.0";
34
- readonly sdkVersion: "0.5.3";
34
+ readonly sdkVersion: "0.6.1";
35
35
  readonly genVersion: "2.610.0";
36
- readonly userAgent: "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client";
36
+ readonly userAgent: "speakeasy-sdk/typescript 0.6.1 2.610.0 0.9.0 @gleanwork/api-client";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
@@ -34,8 +34,8 @@ function serverURLFromOptions(options) {
34
34
  exports.SDK_METADATA = {
35
35
  language: "typescript",
36
36
  openapiDocVersion: "0.9.0",
37
- sdkVersion: "0.5.3",
37
+ sdkVersion: "0.6.1",
38
38
  genVersion: "2.610.0",
39
- userAgent: "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client",
39
+ userAgent: "speakeasy-sdk/typescript 0.6.1 2.610.0 0.9.0 @gleanwork/api-client",
40
40
  };
41
41
  //# sourceMappingURL=config.js.map
@@ -2,11 +2,11 @@ import * as z from "zod";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  /**
5
- * The schema for the agent input. In JSON schema format.
5
+ * The schema for the agent input. In JSON Schema format.
6
6
  */
7
7
  export type InputSchema = {};
8
8
  /**
9
- * The schema for the agent output. In JSON schema format.
9
+ * The schema for the agent output. In JSON Schema format.
10
10
  */
11
11
  export type OutputSchema = {};
12
12
  /**
@@ -18,11 +18,11 @@ export type AgentSchemas = {
18
18
  */
19
19
  agentId: string;
20
20
  /**
21
- * The schema for the agent input. In JSON schema format.
21
+ * The schema for the agent input. In JSON Schema format.
22
22
  */
23
23
  inputSchema: InputSchema;
24
24
  /**
25
- * The schema for the agent output. In JSON schema format.
25
+ * The schema for the agent output. In JSON Schema format.
26
26
  */
27
27
  outputSchema: OutputSchema;
28
28
  };
@@ -9,10 +9,10 @@ export type ClientAgentsRunMutationVariables = {
9
9
  };
10
10
  export type ClientAgentsRunMutationData = components.AgentRunWaitResponse;
11
11
  /**
12
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
12
+ * Create an agent run and wait for the response
13
13
  *
14
14
  * @remarks
15
- * Executes an agent run and returns the final response.
15
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
16
16
  */
17
17
  export declare function useClientAgentsRunMutation(options?: MutationHookOptions<ClientAgentsRunMutationData, Error, ClientAgentsRunMutationVariables>): UseMutationResult<ClientAgentsRunMutationData, Error, ClientAgentsRunMutationVariables>;
18
18
  export declare function mutationKeyClientAgentsRun(): MutationKey;
@@ -12,10 +12,10 @@ const primitives_js_1 = require("../lib/primitives.js");
12
12
  const fp_js_1 = require("../types/fp.js");
13
13
  const _context_js_1 = require("./_context.js");
14
14
  /**
15
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
15
+ * Create an agent run and wait for the response
16
16
  *
17
17
  * @remarks
18
- * Executes an agent run and returns the final response.
18
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
19
19
  */
20
20
  function useClientAgentsRunMutation(options) {
21
21
  const client = (0, _context_js_1.useGleanContext)();
@@ -30,10 +30,10 @@ export declare class Agents extends ClientSDK {
30
30
  */
31
31
  runStream(request: components.AgentRunCreate, options?: RequestOptions): Promise<string>;
32
32
  /**
33
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
33
+ * Create an agent run and wait for the response
34
34
  *
35
35
  * @remarks
36
- * Executes an agent run and returns the final response.
36
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
37
37
  */
38
38
  run(request: components.AgentRunCreate, options?: RequestOptions): Promise<components.AgentRunWaitResponse>;
39
39
  }
@@ -49,10 +49,10 @@ class Agents extends sdks_js_1.ClientSDK {
49
49
  return (0, fp_js_1.unwrapAsync)((0, clientAgentsRunStream_js_1.clientAgentsRunStream)(this, request, options));
50
50
  }
51
51
  /**
52
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
52
+ * Create an agent run and wait for the response
53
53
  *
54
54
  * @remarks
55
- * Executes an agent run and returns the final response.
55
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
56
56
  */
57
57
  async run(request, options) {
58
58
  return (0, fp_js_1.unwrapAsync)((0, clientAgentsRun_js_1.clientAgentsRun)(this, request, options));
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
10
+ * Create an agent run and wait for the response
11
11
  *
12
12
  * @remarks
13
- * Executes an agent run and returns the final response.
13
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
14
14
  */
15
15
  export declare function clientAgentsRun(client: GleanCore, request: components.AgentRunCreate, options?: RequestOptions): APIPromise<Result<components.AgentRunWaitResponse, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsRun.d.ts.map
@@ -10,10 +10,10 @@ import { pathToFunc } from "../lib/url.js";
10
10
  import * as components from "../models/components/index.js";
11
11
  import { APIPromise } from "../types/async.js";
12
12
  /**
13
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
13
+ * Create an agent run and wait for the response
14
14
  *
15
15
  * @remarks
16
- * Executes an agent run and returns the final response.
16
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
17
17
  */
18
18
  export function clientAgentsRun(client, request, options) {
19
19
  return new APIPromise($do(client, request, options));
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
31
31
  export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
33
  readonly openapiDocVersion: "0.9.0";
34
- readonly sdkVersion: "0.5.3";
34
+ readonly sdkVersion: "0.6.1";
35
35
  readonly genVersion: "2.610.0";
36
- readonly userAgent: "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client";
36
+ readonly userAgent: "speakeasy-sdk/typescript 0.6.1 2.610.0 0.9.0 @gleanwork/api-client";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
@@ -30,8 +30,8 @@ export function serverURLFromOptions(options) {
30
30
  export const SDK_METADATA = {
31
31
  language: "typescript",
32
32
  openapiDocVersion: "0.9.0",
33
- sdkVersion: "0.5.3",
33
+ sdkVersion: "0.6.1",
34
34
  genVersion: "2.610.0",
35
- userAgent: "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client",
35
+ userAgent: "speakeasy-sdk/typescript 0.6.1 2.610.0 0.9.0 @gleanwork/api-client",
36
36
  };
37
37
  //# sourceMappingURL=config.js.map
@@ -2,11 +2,11 @@ import * as z from "zod";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  /**
5
- * The schema for the agent input. In JSON schema format.
5
+ * The schema for the agent input. In JSON Schema format.
6
6
  */
7
7
  export type InputSchema = {};
8
8
  /**
9
- * The schema for the agent output. In JSON schema format.
9
+ * The schema for the agent output. In JSON Schema format.
10
10
  */
11
11
  export type OutputSchema = {};
12
12
  /**
@@ -18,11 +18,11 @@ export type AgentSchemas = {
18
18
  */
19
19
  agentId: string;
20
20
  /**
21
- * The schema for the agent input. In JSON schema format.
21
+ * The schema for the agent input. In JSON Schema format.
22
22
  */
23
23
  inputSchema: InputSchema;
24
24
  /**
25
- * The schema for the agent output. In JSON schema format.
25
+ * The schema for the agent output. In JSON Schema format.
26
26
  */
27
27
  outputSchema: OutputSchema;
28
28
  };
@@ -9,10 +9,10 @@ export type ClientAgentsRunMutationVariables = {
9
9
  };
10
10
  export type ClientAgentsRunMutationData = components.AgentRunWaitResponse;
11
11
  /**
12
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
12
+ * Create an agent run and wait for the response
13
13
  *
14
14
  * @remarks
15
- * Executes an agent run and returns the final response.
15
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
16
16
  */
17
17
  export declare function useClientAgentsRunMutation(options?: MutationHookOptions<ClientAgentsRunMutationData, Error, ClientAgentsRunMutationVariables>): UseMutationResult<ClientAgentsRunMutationData, Error, ClientAgentsRunMutationVariables>;
18
18
  export declare function mutationKeyClientAgentsRun(): MutationKey;
@@ -7,10 +7,10 @@ import { combineSignals } from "../lib/primitives.js";
7
7
  import { unwrapAsync } from "../types/fp.js";
8
8
  import { useGleanContext } from "./_context.js";
9
9
  /**
10
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
10
+ * Create an agent run and wait for the response
11
11
  *
12
12
  * @remarks
13
- * Executes an agent run and returns the final response.
13
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
14
14
  */
15
15
  export function useClientAgentsRunMutation(options) {
16
16
  const client = useGleanContext();
@@ -30,10 +30,10 @@ export declare class Agents extends ClientSDK {
30
30
  */
31
31
  runStream(request: components.AgentRunCreate, options?: RequestOptions): Promise<string>;
32
32
  /**
33
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
33
+ * Create an agent run and wait for the response
34
34
  *
35
35
  * @remarks
36
- * Executes an agent run and returns the final response.
36
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
37
37
  */
38
38
  run(request: components.AgentRunCreate, options?: RequestOptions): Promise<components.AgentRunWaitResponse>;
39
39
  }
@@ -46,10 +46,10 @@ export class Agents extends ClientSDK {
46
46
  return unwrapAsync(clientAgentsRunStream(this, request, options));
47
47
  }
48
48
  /**
49
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
49
+ * Create an agent run and wait for the response
50
50
  *
51
51
  * @remarks
52
- * Executes an agent run and returns the final response.
52
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
53
53
  */
54
54
  async run(request, options) {
55
55
  return unwrapAsync(clientAgentsRun(this, request, options));
@@ -9,7 +9,7 @@
9
9
  * [retrieveSchemas](#retrieveschemas) - List an agent's schemas
10
10
  * [list](#list) - Search agents
11
11
  * [runStream](#runstream) - Create an agent run and stream the response
12
- * [run](#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
12
+ * [run](#run) - Create an agent run and wait for the response
13
13
 
14
14
  ## retrieve
15
15
 
@@ -401,7 +401,7 @@ import {
401
401
 
402
402
  ## run
403
403
 
404
- Executes an agent run and returns the final response.
404
+ Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
405
405
 
406
406
  ### Example Usage
407
407
 
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@gleanwork/api-client",
5
- "version": "0.5.3",
5
+ "version": "0.6.1",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gleanwork/api-client",
3
- "version": "0.5.3",
3
+ "version": "0.6.1",
4
4
  "author": "Speakeasy",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -24,10 +24,10 @@ import { APICall, APIPromise } from "../types/async.js";
24
24
  import { Result } from "../types/fp.js";
25
25
 
26
26
  /**
27
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
27
+ * Create an agent run and wait for the response
28
28
  *
29
29
  * @remarks
30
- * Executes an agent run and returns the final response.
30
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
31
31
  */
32
32
  export function clientAgentsRun(
33
33
  client: GleanCore,
package/src/lib/config.ts CHANGED
@@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
64
64
  export const SDK_METADATA = {
65
65
  language: "typescript",
66
66
  openapiDocVersion: "0.9.0",
67
- sdkVersion: "0.5.3",
67
+ sdkVersion: "0.6.1",
68
68
  genVersion: "2.610.0",
69
69
  userAgent:
70
- "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client",
70
+ "speakeasy-sdk/typescript 0.6.1 2.610.0 0.9.0 @gleanwork/api-client",
71
71
  } as const;
@@ -9,12 +9,12 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * The schema for the agent input. In JSON schema format.
12
+ * The schema for the agent input. In JSON Schema format.
13
13
  */
14
14
  export type InputSchema = {};
15
15
 
16
16
  /**
17
- * The schema for the agent output. In JSON schema format.
17
+ * The schema for the agent output. In JSON Schema format.
18
18
  */
19
19
  export type OutputSchema = {};
20
20
 
@@ -27,11 +27,11 @@ export type AgentSchemas = {
27
27
  */
28
28
  agentId: string;
29
29
  /**
30
- * The schema for the agent input. In JSON schema format.
30
+ * The schema for the agent input. In JSON Schema format.
31
31
  */
32
32
  inputSchema: InputSchema;
33
33
  /**
34
- * The schema for the agent output. In JSON schema format.
34
+ * The schema for the agent output. In JSON Schema format.
35
35
  */
36
36
  outputSchema: OutputSchema;
37
37
  };
@@ -24,10 +24,10 @@ export type ClientAgentsRunMutationVariables = {
24
24
  export type ClientAgentsRunMutationData = components.AgentRunWaitResponse;
25
25
 
26
26
  /**
27
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
27
+ * Create an agent run and wait for the response
28
28
  *
29
29
  * @remarks
30
- * Executes an agent run and returns the final response.
30
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
31
31
  */
32
32
  export function useClientAgentsRunMutation(
33
33
  options?: MutationHookOptions<
package/src/sdk/agents.ts CHANGED
@@ -85,10 +85,10 @@ export class Agents extends ClientSDK {
85
85
  }
86
86
 
87
87
  /**
88
- * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
88
+ * Create an agent run and wait for the response
89
89
  *
90
90
  * @remarks
91
- * Executes an agent run and returns the final response.
91
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
92
92
  */
93
93
  async run(
94
94
  request: components.AgentRunCreate,