diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 6db6a898..3abbfcb9 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 664aaca5-a41f-4434-8f2a-642dba92fe68 management: - docChecksum: ba76322a279d357942029f1599c8ad4d + docChecksum: 11234d282481d3710e009ee7857573b0 docVersion: 0.9.0 speakeasyVersion: 1.551.0 generationVersion: 2.610.0 - releaseVersion: 0.10.1 - configChecksum: 3bd74537051753318af32d7b46f15b76 + releaseVersion: 0.10.3 + configChecksum: 95364415984ba790845c513bbbb022d4 repoURL: https://github.com/gleanwork/api-client-typescript.git installationURL: https://github.com/gleanwork/api-client-typescript published: true @@ -2936,4 +2936,6 @@ generatedTests: createpolicy: "2025-06-09T18:05:10Z" createreport: "2025-06-09T18:05:10Z" setdocvisibility: "2025-06-09T18:05:10Z" -releaseNotes: "## Typescript SDK Changes Detected:\n* `glean.client.documents.summarize()`: \n * `request.documentSpecs.[].[class]` **Changed** **Breaking** :warning:\n* `glean.client.documents.retrieve()`: \n * `request.documentSpecs.[].[class]` **Changed** **Breaking** :warning:\n * `response.documents.{}.[document].metadata.author.relatedDocuments.[]` **Changed**\n* `glean.client.answers.create()`: \n * `request.data.addedRoles.[]` **Changed** **Breaking** :warning:\n * `response.addedroles.[]` **Changed**\n* `glean.client.answers.update()`: \n * `request.addedRoles.[]` **Changed** **Breaking** :warning:\n * `response.addedroles.[]` **Changed**\n* `glean.client.shortcuts.update()`: \n * `request.addedRoles.[]` **Changed** **Breaking** :warning:\n * `response.shortcut.addedRoles.[]` **Changed**\n* `glean.client.shortcuts.create()`: \n * `request.data.addedRoles.[]` **Changed** **Breaking** :warning:\n * `response.shortcut.addedRoles.[]` **Changed**\n* `glean.client.chat.create()`: \n * `request.chatrequest.messages.[]` **Changed** **Breaking** :warning:\n * `response.messages.[]` **Changed**\n* `glean.client.search.query()`: \n * `request.sourceDocument.metadata.author.relatedDocuments.[]` **Changed** **Breaking** :warning:\n * `response.results.[].structuredResults.[].document.metadata` **Changed**\n* `glean.client.search.recommendations()`: \n * `request.sourceDocument.metadata.author.relatedDocuments.[]` **Changed** **Breaking** :warning:\n * `response.results.[].structuredResults.[].document.metadata` **Changed**\n* `glean.client.search.queryAsAdmin()`: \n * `request.sourceDocument.metadata.author.relatedDocuments.[]` **Changed** **Breaking** :warning:\n * `response.results.[].structuredResults.[].document.metadata` **Changed**\n* `glean.client.chat.createStream()`: \n * `request.chatrequest.messages.[]` **Changed** **Breaking** :warning:\n* `glean.client.announcements.create()`: \n * `request.body.structuredList.[].document.metadata.author.relatedDocuments.[]` **Changed** **Breaking** :warning:\n * `response.body.structuredList.[].document.metadata.author.relatedDocuments.[]` **Changed**\n* `glean.client.collections.create()`: \n * `request.addedRoles.[]` **Changed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n* `glean.client.announcements.update()`: \n * `request.body.structuredList.[].document.metadata.author.relatedDocuments.[]` **Changed** **Breaking** :warning:\n * `response.body.structuredList.[].document.metadata.author.relatedDocuments.[]` **Changed**\n* `glean.client.collections.update()`: \n * `request.addedRoles.[]` **Changed** **Breaking** :warning:\n * `response.addedroles.[]` **Changed**\n* `glean.client.collections.addItems()`: `response.collection.addedRoles.[]` **Changed**\n* `glean.client.search.autocomplete()`: `response.results.[].document.metadata.author.relatedDocuments.[]` **Changed**\n* `glean.client.collections.list()`: `response.collections.[].addedRoles.[]` **Changed**\n* `glean.client.collections.updateItem()`: `response.collection.addedRoles.[]` **Changed**\n* `glean.client.documents.retrieveByFacets()`: `response.documents.[].metadata.author.relatedDocuments.[]` **Changed**\n* `glean.client.collections.deleteItem()`: `response.collection.addedRoles.[]` **Changed**\n* `glean.client.insights.retrieve()`: `response.users.activityInsights.[].user.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.messages.retrieve()`: `response.searchresponse.results.[].structuredResults.[].document.metadata` **Changed**\n* `glean.client.pins.update()`: `response.attribution.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.pins.retrieve()`: `response.pin.attribution.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.pins.list()`: `response.pins.[].attribution.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.pins.create()`: `response.attribution.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.chat.retrieveFiles()`: \n * `request.getchatfilesrequest.chatId` **Added**\n* `glean.client.collections.retrieve()`: `response.collection.addedRoles.[]` **Changed**\n* `glean.client.search.retrieveFeed()`: `response.results.[].primaryEntry` **Changed**\n* `glean.client.chat.list()`: `response.chatresults.[].chat.createdBy.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.chat.retrieve()`: `response.chatresult.chat` **Changed**\n* `glean.client.entities.list()`: `response.results.[].relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.entities.readPeople()`: `response.results.[].relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.answers.list()`: `response.answerresults.[].answer.addedRoles.[]` **Changed**\n* `glean.client.shortcuts.retrieve()`: `response.shortcut.addedRoles.[]` **Changed**\n* `glean.client.shortcuts.list()`: `response.shortcuts.[].addedRoles.[]` **Changed**\n* `glean.client.answers.retrieve()`: `response.answerresult.answer.addedRoles.[]` **Changed**\n* `glean.client.verification.addReminder()`: `response.metadata.lastVerifier.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.verification.list()`: `response.documents.[].metadata.lastVerifier.relatedDocuments.[].querySuggestion` **Changed**\n* `glean.client.verification.verify()`: `response.metadata.lastVerifier.relatedDocuments.[].querySuggestion` **Changed**\n" +releaseNotes: | + ## Typescript SDK Changes Detected: + * `glean.client.search.retrieveFeed()`: `response.results.[].primaryEntry.digest.sections.[].channelType` **Added** diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index e3f55f9c..724ce3f3 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -25,7 +25,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: true typescript: - version: 0.10.1 + version: 0.10.3 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/.speakeasy/glean-merged-spec.yaml b/.speakeasy/glean-merged-spec.yaml index 7a87e86a..2114919e 100644 --- a/.speakeasy/glean-merged-spec.yaml +++ b/.speakeasy/glean-merged-spec.yaml @@ -9430,6 +9430,11 @@ components: channelName: type: string description: Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. + channelType: + type: string + description: | + Channel visibility/type for CHANNEL sections. For Slack this is typically one of + PublicChannel, PrivateChannel. Omit if not applicable or unknown. instanceId: type: string description: Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 22b8fd41..11eda5a2 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,11 +2,11 @@ speakeasyVersion: 1.551.0 sources: Glean API: sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:a9b49b3146d88faffb25761f988ab0445ed0366b84774a13d4754cb0eb7a3b9b - sourceBlobDigest: sha256:4408853be9bce04865c08fd37b8c11320ffd3b79ef0c70ca8fa1791df0679b1f + sourceRevisionDigest: sha256:3dba87a7b61abaf1f2a6b645c2c9d1c5d79481f48ff3d57b2f1a864b8c8aa02f + sourceBlobDigest: sha256:49403d59f8446958ed5e813bbf322fda12ae91ed0991975bb0f24de0a189f74e tags: - latest - - speakeasy-sdk-regen-1758751963 + - speakeasy-sdk-regen-1758790485 Glean Client API: sourceNamespace: glean-client-api sourceRevisionDigest: sha256:aec0770b5bcca91068c3a844cb9ef4a091281f6cc3b7d86f2abef1bd6fb2b301 @@ -18,10 +18,10 @@ targets: glean: source: Glean API sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:a9b49b3146d88faffb25761f988ab0445ed0366b84774a13d4754cb0eb7a3b9b - sourceBlobDigest: sha256:4408853be9bce04865c08fd37b8c11320ffd3b79ef0c70ca8fa1791df0679b1f + sourceRevisionDigest: sha256:3dba87a7b61abaf1f2a6b645c2c9d1c5d79481f48ff3d57b2f1a864b8c8aa02f + sourceBlobDigest: sha256:49403d59f8446958ed5e813bbf322fda12ae91ed0991975bb0f24de0a189f74e codeSamplesNamespace: glean-api-specs-typescript-code-samples - codeSamplesRevisionDigest: sha256:0faa3e3cad537b98ca05e0f777adeede536028fa2b7623226588c20503b12347 + codeSamplesRevisionDigest: sha256:d46efa3e112ce3ae15122e31a915ebc045264f9b507264abdc70b8a94156465a workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index f5175380..ec7e10de 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -258,4 +258,14 @@ Based on: ### Generated - [typescript v0.10.1] . ### Releases -- [NPM v0.10.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.10.1 - . \ No newline at end of file +- [NPM v0.10.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.10.1 - . + +## 2025-09-25 16:02:55 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.551.0 (2.610.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.10.3] . +### Releases +- [NPM v0.10.3] https://www.npmjs.com/package/@gleanwork/api-client/v/0.10.3 - . \ No newline at end of file diff --git a/docs/models/components/digestsection.md b/docs/models/components/digestsection.md index 5e5ab51d..9e2b7d1c 100644 --- a/docs/models/components/digestsection.md +++ b/docs/models/components/digestsection.md @@ -16,12 +16,13 @@ let value: DigestSection = { ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the digest section. | -| `type` | [components.SectionType](../../models/components/sectiontype.md) | :heavy_check_mark: | Type of the section. This defines how the section should be interpreted and rendered in the digest. | -| `displayName` | *string* | :heavy_minus_sign: | Human-readable name for the digest section. | -| `channelName` | *string* | :heavy_minus_sign: | Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. | -| `instanceId` | *string* | :heavy_minus_sign: | Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. | -| `url` | *string* | :heavy_minus_sign: | Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section. | -| `updates` | [components.DigestUpdate](../../models/components/digestupdate.md)[] | :heavy_check_mark: | List of updates within this digest section. | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | Unique identifier for the digest section. | +| `type` | [components.SectionType](../../models/components/sectiontype.md) | :heavy_check_mark: | Type of the section. This defines how the section should be interpreted and rendered in the digest. | +| `displayName` | *string* | :heavy_minus_sign: | Human-readable name for the digest section. | +| `channelName` | *string* | :heavy_minus_sign: | Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. | +| `channelType` | *string* | :heavy_minus_sign: | Channel visibility/type for CHANNEL sections. For Slack this is typically one of
PublicChannel, PrivateChannel. Omit if not applicable or unknown.
| +| `instanceId` | *string* | :heavy_minus_sign: | Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. | +| `url` | *string* | :heavy_minus_sign: | Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section. | +| `updates` | [components.DigestUpdate](../../models/components/digestupdate.md)[] | :heavy_check_mark: | List of updates within this digest section. | \ No newline at end of file diff --git a/jsr.json b/jsr.json index 09c3182c..9aabb12a 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@gleanwork/api-client", - "version": "0.10.1", + "version": "0.10.3", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 773e3eae..a0765e00 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@gleanwork/api-client", - "version": "0.10.1", + "version": "0.10.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@gleanwork/api-client", - "version": "0.10.1", + "version": "0.10.3", "devDependencies": { "@eslint/js": "^9.19.0", "@tanstack/react-query": "^5.61.4", diff --git a/package.json b/package.json index dfdb3b1d..66386317 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@gleanwork/api-client", - "version": "0.10.1", + "version": "0.10.3", "author": "Speakeasy", "type": "module", "tshy": { diff --git a/src/__tests__/mockserver/internal/sdk/models/components/digestsection.go b/src/__tests__/mockserver/internal/sdk/models/components/digestsection.go index da5e9a2f..e316597e 100644 --- a/src/__tests__/mockserver/internal/sdk/models/components/digestsection.go +++ b/src/__tests__/mockserver/internal/sdk/models/components/digestsection.go @@ -11,6 +11,10 @@ type DigestSection struct { DisplayName *string `json:"displayName,omitempty"` // Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. ChannelName *string `json:"channelName,omitempty"` + // Channel visibility/type for CHANNEL sections. For Slack this is typically one of + // PublicChannel, PrivateChannel. Omit if not applicable or unknown. + // + ChannelType *string `json:"channelType,omitempty"` // Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. InstanceID *string `json:"instanceId,omitempty"` // Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section. @@ -47,6 +51,13 @@ func (o *DigestSection) GetChannelName() *string { return o.ChannelName } +func (o *DigestSection) GetChannelType() *string { + if o == nil { + return nil + } + return o.ChannelType +} + func (o *DigestSection) GetInstanceID() *string { if o == nil { return nil diff --git a/src/__tests__/summarize.test.ts b/src/__tests__/summarize.test.ts index 01d89dc1..b1448d0b 100644 --- a/src/__tests__/summarize.test.ts +++ b/src/__tests__/summarize.test.ts @@ -18,12 +18,11 @@ test("Summarize Summarize", async () => { const result = await glean.client.documents.summarize({ documentSpecs: [ { - ugcType: "SHORTCUTS", - ugcId: "", + ugcType: "ANNOUNCEMENTS", + contentId: 4922, }, { - ugcType: "CHATS", - ugcId: "", + url: "https://pushy-marksman.biz/", }, ], }); diff --git a/src/lib/config.ts b/src/lib/config.ts index 1c45e6b9..b231ff5a 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.9.0", - sdkVersion: "0.10.1", + sdkVersion: "0.10.3", genVersion: "2.610.0", userAgent: - "speakeasy-sdk/typescript 0.10.1 2.610.0 0.9.0 @gleanwork/api-client", + "speakeasy-sdk/typescript 0.10.3 2.610.0 0.9.0 @gleanwork/api-client", } as const; diff --git a/src/models/components/digestsection.ts b/src/models/components/digestsection.ts index 9063da9b..c654885d 100644 --- a/src/models/components/digestsection.ts +++ b/src/models/components/digestsection.ts @@ -35,6 +35,13 @@ export type DigestSection = { * Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend. */ channelName?: string | undefined; + /** + * Channel visibility/type for CHANNEL sections. For Slack this is typically one of + * + * @remarks + * PublicChannel, PrivateChannel. Omit if not applicable or unknown. + */ + channelType?: string | undefined; /** * Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend. */ @@ -59,6 +66,7 @@ export const DigestSection$inboundSchema: z.ZodType< type: SectionType$inboundSchema, displayName: z.string().optional(), channelName: z.string().optional(), + channelType: z.string().optional(), instanceId: z.string().optional(), url: z.string().optional(), updates: z.array(DigestUpdate$inboundSchema), @@ -70,6 +78,7 @@ export type DigestSection$Outbound = { type: string; displayName?: string | undefined; channelName?: string | undefined; + channelType?: string | undefined; instanceId?: string | undefined; url?: string | undefined; updates: Array; @@ -85,6 +94,7 @@ export const DigestSection$outboundSchema: z.ZodType< type: SectionType$outboundSchema, displayName: z.string().optional(), channelName: z.string().optional(), + channelType: z.string().optional(), instanceId: z.string().optional(), url: z.string().optional(), updates: z.array(DigestUpdate$outboundSchema),