Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .devcontainer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<div align="center">
<a href="https://codespaces.new/gleanwork/api-client-typescript.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
<a href="https://codespaces.new/speakeasy-sdks/glean-sdk-ts.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
</div>
<br>

Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/examples/node_modules
.env
.env.local
.env.*.local
**/.speakeasy/temp/
**/.speakeasy/logs/
.speakeasy/logs/
Expand Down
201 changes: 139 additions & 62 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

18 changes: 17 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ generation:
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
Expand All @@ -23,23 +24,33 @@ generation:
tests:
generateNewTests: true
skipResponseBodyAssertions: true
requestBodyFieldName: ""
schemas:
allOfMergeStrategy: shallowMerge
typescript:
version: 0.4.4
version: 0.5.1
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
author: Speakeasy
baseErrorName: GleanBaseError
clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: true
defaultErrorName: GleanError
enableCustomCodeRegions: false
enableMCPServer: false
enableReactQuery: true
enumFormat: union
envVarPrefix: GLEAN
exportZodModelNamespace: false
flattenGlobalSecurity: true
flatteningOrder: body-first
generateExamples: true
imports:
option: openapi
paths:
Expand All @@ -52,9 +63,14 @@ typescript:
jsonpath: rfc9535
maxMethodParams: 5
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: dual
outputModelSuffix: output
packageName: '@gleanwork/api-client'
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
unionStrategy: left-to-right
usageSDKInitImports: []
useIndexModules: true
zodVersion: v3
1,589 changes: 1,161 additions & 428 deletions .speakeasy/glean-merged-spec.yaml

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ speakeasyVersion: 1.551.0
sources:
Glean API:
sourceNamespace: glean-api-specs
sourceRevisionDigest: sha256:54c0b7f53a738ea4d896b6041514ca6308f8fad84fb2ce9ca39e5c4cb5f52afc
sourceBlobDigest: sha256:e03e7548ba6cb180d1f94e0a3912501f47f1f9944c0631dd752b396e56513f1f
sourceRevisionDigest: sha256:2ad700f2ce85b0aa442a98a80f3c131f73fc187c53407d3d84b1899c0e603eb1
sourceBlobDigest: sha256:d62d91bcf73cf5775dc081807ae550dd20f6ecdfb5dc06ebbd08804f84a2d2f1
tags:
- latest
- speakeasy-sdk-regen-1748049192
- speakeasy-sdk-regen-1759191280
Glean Client API:
sourceNamespace: glean-client-api
sourceRevisionDigest: sha256:aec0770b5bcca91068c3a844cb9ef4a091281f6cc3b7d86f2abef1bd6fb2b301
Expand All @@ -18,10 +18,10 @@ targets:
glean:
source: Glean API
sourceNamespace: glean-api-specs
sourceRevisionDigest: sha256:54c0b7f53a738ea4d896b6041514ca6308f8fad84fb2ce9ca39e5c4cb5f52afc
sourceBlobDigest: sha256:e03e7548ba6cb180d1f94e0a3912501f47f1f9944c0631dd752b396e56513f1f
sourceRevisionDigest: sha256:2ad700f2ce85b0aa442a98a80f3c131f73fc187c53407d3d84b1899c0e603eb1
sourceBlobDigest: sha256:d62d91bcf73cf5775dc081807ae550dd20f6ecdfb5dc06ebbd08804f84a2d2f1
codeSamplesNamespace: glean-api-specs-typescript-code-samples
codeSamplesRevisionDigest: sha256:5d3868b4c20c82f7499c78f4a4fba241957935d984270124fe7d4325e659a860
codeSamplesRevisionDigest: sha256:c898215c215421f08315fe3b4ba22aca8f844706b9cb6f9a533e95c7a371b0cc
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
96 changes: 48 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,11 +293,11 @@ For more information on obtaining the appropriate token type, please contact you

#### [client.agents](docs/sdks/agents/README.md)

* [retrieve](docs/sdks/agents/README.md#retrieve) - Get Agent
* [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
* [list](docs/sdks/agents/README.md#list) - Search Agents
* [runStream](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
* [run](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
* [retrieve](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
* [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
* [list](docs/sdks/agents/README.md#list) - Search agents
* [runStream](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
* [run](docs/sdks/agents/README.md#run) - Create an agent run and wait for the response

#### [client.announcements](docs/sdks/announcements/README.md)

Expand Down Expand Up @@ -359,29 +359,29 @@ For more information on obtaining the appropriate token type, please contact you

#### [client.governance.data.policies](docs/sdks/policies/README.md)

* [retrieve](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
* [update](docs/sdks/policies/README.md#update) - Updates an existing policy.
* [list](docs/sdks/policies/README.md#list) - Lists policies.
* [create](docs/sdks/policies/README.md#create) - Creates new policy.
* [download](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
* [retrieve](docs/sdks/policies/README.md#retrieve) - Gets specified policy
* [update](docs/sdks/policies/README.md#update) - Updates an existing policy
* [list](docs/sdks/policies/README.md#list) - Lists policies
* [create](docs/sdks/policies/README.md#create) - Creates new policy
* [download](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy

#### [client.governance.data.reports](docs/sdks/reports/README.md)

* [create](docs/sdks/reports/README.md#create) - Creates new one-time report.
* [download](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
* [status](docs/sdks/reports/README.md#status) - Fetches report run status.
* [create](docs/sdks/reports/README.md#create) - Creates new one-time report
* [download](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
* [status](docs/sdks/reports/README.md#status) - Fetches report run status

#### [client.governance.documents](docs/sdks/governancedocuments/README.md)


#### [client.governance.documents.visibilityoverrides](docs/sdks/visibilityoverrides/README.md)

* [list](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
* [create](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
* [list](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
* [create](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs

#### [client.insights](docs/sdks/insights/README.md)

* [retrieve](docs/sdks/insights/README.md#retrieve) - Read insights
* [retrieve](docs/sdks/insights/README.md#retrieve) - Get insights

#### [client.messages](docs/sdks/messages/README.md)

Expand Down Expand Up @@ -508,11 +508,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).

- [`clientActivityFeedback`](docs/sdks/activity/README.md#feedback) - Report client activity
- [`clientActivityReport`](docs/sdks/activity/README.md#report) - Report document activity
- [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search Agents
- [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get Agent
- [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
- [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
- [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
- [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search agents
- [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
- [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
- [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create an agent run and wait for the response
- [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
- [`clientAnnouncementsCreate`](docs/sdks/announcements/README.md#create) - Create Announcement
- [`clientAnnouncementsDelete`](docs/sdks/announcements/README.md#delete) - Delete Announcement
- [`clientAnnouncementsUpdate`](docs/sdks/announcements/README.md#update) - Update Announcement
Expand Down Expand Up @@ -546,17 +546,17 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`clientDocumentsSummarize`](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
- [`clientEntitiesList`](docs/sdks/entities/README.md#list) - List entities
- [`clientEntitiesReadPeople`](docs/sdks/entities/README.md#readpeople) - Read people
- [`clientGovernanceDataPoliciesCreate`](docs/sdks/policies/README.md#create) - Creates new policy.
- [`clientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
- [`clientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies.
- [`clientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
- [`clientGovernanceDataPoliciesUpdate`](docs/sdks/policies/README.md#update) - Updates an existing policy.
- [`clientGovernanceDataReportsCreate`](docs/sdks/reports/README.md#create) - Creates new one-time report.
- [`clientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
- [`clientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status.
- [`clientGovernanceDocumentsVisibilityoverridesCreate`](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
- [`clientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
- [`clientInsightsRetrieve`](docs/sdks/insights/README.md#retrieve) - Read insights
- [`clientGovernanceDataPoliciesCreate`](docs/sdks/policies/README.md#create) - Creates new policy
- [`clientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy
- [`clientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies
- [`clientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified policy
- [`clientGovernanceDataPoliciesUpdate`](docs/sdks/policies/README.md#update) - Updates an existing policy
- [`clientGovernanceDataReportsCreate`](docs/sdks/reports/README.md#create) - Creates new one-time report
- [`clientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
- [`clientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status
- [`clientGovernanceDocumentsVisibilityoverridesCreate`](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs
- [`clientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
- [`clientInsightsRetrieve`](docs/sdks/insights/README.md#retrieve) - Get insights
- [`clientMessagesRetrieve`](docs/sdks/messages/README.md#retrieve) - Read messages
- [`clientPinsCreate`](docs/sdks/pins/README.md#create) - Create pin
- [`clientPinsList`](docs/sdks/pins/README.md#list) - List pins
Expand Down Expand Up @@ -647,11 +647,11 @@ To learn about this feature and how to get started, check

- [`useClientActivityFeedbackMutation`](docs/sdks/activity/README.md#feedback) - Report client activity
- [`useClientActivityReportMutation`](docs/sdks/activity/README.md#report) - Report document activity
- [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search Agents
- [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get Agent
- [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
- [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
- [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
- [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search agents
- [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
- [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
- [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create an agent run and wait for the response
- [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
- [`useClientAnnouncementsCreateMutation`](docs/sdks/announcements/README.md#create) - Create Announcement
- [`useClientAnnouncementsDeleteMutation`](docs/sdks/announcements/README.md#delete) - Delete Announcement
- [`useClientAnnouncementsUpdateMutation`](docs/sdks/announcements/README.md#update) - Update Announcement
Expand Down Expand Up @@ -685,17 +685,17 @@ To learn about this feature and how to get started, check
- [`useClientDocumentsSummarizeMutation`](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
- [`useClientEntitiesListMutation`](docs/sdks/entities/README.md#list) - List entities
- [`useClientEntitiesReadPeopleMutation`](docs/sdks/entities/README.md#readpeople) - Read people
- [`useClientGovernanceDataPoliciesCreateMutation`](docs/sdks/policies/README.md#create) - Creates new policy.
- [`useClientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
- [`useClientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies.
- [`useClientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
- [`useClientGovernanceDataPoliciesUpdateMutation`](docs/sdks/policies/README.md#update) - Updates an existing policy.
- [`useClientGovernanceDataReportsCreateMutation`](docs/sdks/reports/README.md#create) - Creates new one-time report.
- [`useClientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
- [`useClientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status.
- [`useClientGovernanceDocumentsVisibilityoverridesCreateMutation`](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
- [`useClientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
- [`useClientInsightsRetrieveMutation`](docs/sdks/insights/README.md#retrieve) - Read insights
- [`useClientGovernanceDataPoliciesCreateMutation`](docs/sdks/policies/README.md#create) - Creates new policy
- [`useClientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy
- [`useClientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies
- [`useClientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified policy
- [`useClientGovernanceDataPoliciesUpdateMutation`](docs/sdks/policies/README.md#update) - Updates an existing policy
- [`useClientGovernanceDataReportsCreateMutation`](docs/sdks/reports/README.md#create) - Creates new one-time report
- [`useClientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
- [`useClientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status
- [`useClientGovernanceDocumentsVisibilityoverridesCreateMutation`](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs
- [`useClientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
- [`useClientInsightsRetrieveMutation`](docs/sdks/insights/README.md#retrieve) - Get insights
- [`useClientMessagesRetrieveMutation`](docs/sdks/messages/README.md#retrieve) - Read messages
- [`useClientPinsCreateMutation`](docs/sdks/pins/README.md#create) - Create pin
- [`useClientPinsListMutation`](docs/sdks/pins/README.md#list) - List pins
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,14 @@ Based on:
### Generated
- [typescript v0.4.4] .
### Releases
- [NPM v0.4.4] https://www.npmjs.com/package/@gleanwork/api-client/v/0.4.4 - .
- [NPM v0.4.4] https://www.npmjs.com/package/@gleanwork/api-client/v/0.4.4 - .

## 2025-11-14 00:15:08
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.551.0 (2.610.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.5.1] .
### Releases
- [NPM v0.5.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.5.1 - .
Loading
Loading