From 1519746795aa5a0d417876f63855a4ab7b110011 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 2 Sep 2026 20:07:37 +0000 Subject: [PATCH 1/2] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.796.3 --- .speakeasy/gen.lock | 162 ++++++++--------- .speakeasy/gen.yaml | 2 +- .speakeasy/glean-merged-spec.yaml | 51 ++++-- .speakeasy/tests.arazzo.yaml | 31 +--- .speakeasy/workflow.lock | 10 +- REACT_QUERY.md | 8 +- RELEASES.md | 12 +- .../components/platformsearchrequest.md | 13 -- .../platformtriggercreaterequest.md | 9 +- ...platformtriggerpreseteventsearchrequest.md | 2 +- .../platformtriggerupdaterequest.md | 10 +- .../platformagentscreaterunrequest.md | 4 +- .../operations/platformagentsgetrequest.md | 8 +- .../platformagentsgetschemasrequest.md | 10 +- .../platformskillscreateversionrequest.md | 8 +- .../operations/platformskillsdeleterequest.md | 8 +- .../platformskillsgetcontentrequest.md | 8 +- .../operations/platformskillsgetrequest.md | 8 +- .../platformskillsgetversioncontentrequest.md | 12 +- .../platformskillsgetversionrequest.md | 12 +- .../platformskillslistversionsrequest.md | 12 +- .../operations/platformskillssyncrequest.md | 8 +- .../operations/platformskillsupdaterequest.md | 4 +- ...atformtriggerpresetseventssearchrequest.md | 10 +- .../platformtriggerpresetsgetrequest.md | 8 +- ...ormtriggerpresetsinputvalueslistrequest.md | 14 +- .../platformtriggersdeleterequest.md | 8 +- .../platformtriggerseventssearchrequest.md | 10 +- .../operations/platformtriggersgetrequest.md | 8 +- .../platformtriggersupdaterequest.md | 20 +-- docs/sdks/agents/README.md | 40 ++--- docs/sdks/search/README.md | 26 --- docs/sdks/skills/README.md | 144 +++++++-------- docs/sdks/triggers/README.md | 164 ++++++++---------- examples/package-lock.json | 2 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/__tests__/messages.test.ts | 2 +- src/__tests__/search.test.ts | 13 -- src/__tests__/summarize.test.ts | 3 +- src/__tests__/triggers.test.ts | 23 +-- src/lib/config.ts | 4 +- 43 files changed, 424 insertions(+), 495 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 8eae7fa3..f4734385 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,19 +1,19 @@ lockVersion: 2.0.0 id: 664aaca5-a41f-4434-8f2a-642dba92fe68 management: - docChecksum: 78cef1a3e844732b5583bda7a0d7e87c + docChecksum: 68720f65cbf714217871381245ae8dc9 docVersion: 0.9.0 speakeasyVersion: 1.796.3 generationVersion: 2.934.1 - releaseVersion: 0.20.1 - configChecksum: 94ca623597329b712f11c613517dc1aa + releaseVersion: 0.20.2 + configChecksum: 22b57c4af6d9b7ea1cbbd92f12a3ffd8 repoURL: https://github.com/gleanwork/api-client-typescript.git installationURL: https://github.com/gleanwork/api-client-typescript published: true persistentEdits: - generation_id: 406c79fe-c98d-4c62-bbae-de4b06262b93 - pristine_commit_hash: 85f6eb26a01c6f8ce8627ff257fe9383d8a1616a - pristine_tree_hash: ddae982cafe890d3044b27892a8d2c4780937a10 + generation_id: d7e95a6a-1e87-4d74-8e8e-74679f58d78e + pristine_commit_hash: 4dcb26a9db23981a1827af453c73553b3daafd5a + pristine_tree_hash: ec807fc45396cbdff03dfa016971741f87a429b1 features: typescript: acceptHeaders: 2.81.2 @@ -75,8 +75,8 @@ trackedFiles: pristine_git_object: aeacd20b533be54c6ada7e006e19345ddbfd55f0 REACT_QUERY.md: id: 43d3a3ba4147 - last_write_checksum: sha1:b093ef1ca43506a3ca497f43f43df04d889c326f - pristine_git_object: 832fb713ac8079b95dc3b0f0b558425fcd7e1c91 + last_write_checksum: sha1:95eddcd18c3c9af6be0608128934de13d09cae26 + pristine_git_object: 49b559d762275526268e996038c907e7f7bf149f RUNTIMES.md: id: 620c490847b6 last_write_checksum: sha1:e45b854f02c357cbcfdb8c3663000e8339e16505 @@ -2183,8 +2183,8 @@ trackedFiles: pristine_git_object: cc6c059e7c04f64bfe696ecfdd5dfb1f17ab7b7b docs/models/components/platformsearchrequest.md: id: 8636ff30ae76 - last_write_checksum: sha1:5f8e079b9766c7d42b923f7c268c1eaa9250a78a - pristine_git_object: 0f34f62e55253f65b82e67618d555a61d1a7e27d + last_write_checksum: sha1:0deddfdc986c99422b6a6c5b78390a55822fad64 + pristine_git_object: d3518b8b469ae18c9d46fe2812b2e6da40007e00 docs/models/components/platformsearchresponse.md: id: d398b8139176 last_write_checksum: sha1:4de3236979e371dbd60fb0bd495f86dad84d76ed @@ -2347,8 +2347,8 @@ trackedFiles: pristine_git_object: aee6e6e3cf96bf4bf1bb5d1db0bfddab15d5c660 docs/models/components/platformtriggercreaterequest.md: id: a97627618e38 - last_write_checksum: sha1:237f97465acc2e661168c448344ae51ca9f2d822 - pristine_git_object: c6f166aa55a0b0efec05fe5a253e79c5112bab04 + last_write_checksum: sha1:4c6ff1062c19c454278a029ea8fd2c9861420425 + pristine_git_object: e8ed6a7ecb3ad53f92e33da2defac40f4074eb9a docs/models/components/platformtriggercreateresponse.md: id: fa81b7ea6f02 last_write_checksum: sha1:f1affe6550b3ec1a9d640c3c473732fea726900a @@ -2395,8 +2395,8 @@ trackedFiles: pristine_git_object: b3ef72c94530f1a97d3b58e3f000b82e7ae72959 docs/models/components/platformtriggerpreseteventsearchrequest.md: id: 232bb5d70f19 - last_write_checksum: sha1:e1f59742747688c57d3f173278e96bf690953be9 - pristine_git_object: 37e0dde728feafed12badace86b4aec5055ace46 + last_write_checksum: sha1:f4c3da0e4c518a32b1c5d6d4554527cb6294f2f1 + pristine_git_object: 31a8e101450fede204b3ba72d64435a9c3c69325 docs/models/components/platformtriggerpresetgetresponse.md: id: d93f7d84a9b4 last_write_checksum: sha1:fb0043d2fb3715dd4ba827113967676328bd8e16 @@ -2431,8 +2431,8 @@ trackedFiles: pristine_git_object: ca9ec29d891a01670d213d896564ecc02be0208f docs/models/components/platformtriggerupdaterequest.md: id: 20c0e1b0b8bc - last_write_checksum: sha1:d6ca9ddc72e27eeaec0503444d15dbd15f1976ab - pristine_git_object: 7bdf39359b8585a440b37f4ad08281f1609061ef + last_write_checksum: sha1:b361c70321bd1ed5b86464d5e64e0a009dd1b912 + pristine_git_object: 0c5b491daa5134732645e14a93f729fcd42be3b2 docs/models/components/platformtriggerwebhookevent.md: id: 8ce4a6161e45 last_write_checksum: sha1:9bcd625bd7b27c24d78ddc8acee78c10a5ba098f @@ -3467,20 +3467,20 @@ trackedFiles: pristine_git_object: b9b5b9cefc7b634682286de2c11e7b7f375add80 docs/models/operations/platformagentscreaterunrequest.md: id: "388574933310" - last_write_checksum: sha1:971cb9578bf2dcade57eec105051cf69ace1c29d - pristine_git_object: c23c378b321089d1da62c96b732cc184efa30d40 + last_write_checksum: sha1:3fbe204b00e5397472179d043b5d9c992b67453c + pristine_git_object: 9d15ac85c9127a875116ff980fbcc2b36e378e04 docs/models/operations/platformagentscreaterunresponse.md: id: aa686cb7fdf0 last_write_checksum: sha1:4c8a256e177c89489099936f7a7f1e8768f93eb3 pristine_git_object: a6ff4cd483a4f002c97a315f08e635fbed15c852 docs/models/operations/platformagentsgetrequest.md: id: 706ad4a6bd32 - last_write_checksum: sha1:11a6dcef6eea2c656083a4ffe5d9c01a378cbb4d - pristine_git_object: 9b82586d7979b656fd576a3e48318ea5c6805759 + last_write_checksum: sha1:72db0892e6d0df09575a56a7e3d5471cf4d5e023 + pristine_git_object: b02fac98bcf52fdde3818163b1e835006fac955e docs/models/operations/platformagentsgetschemasrequest.md: id: 58d615b7c78f - last_write_checksum: sha1:f72548f52835bd70987fa96727569f7fd5d32f9f - pristine_git_object: 86d0551865da2973d4bc49c26a9ae3fab6829f85 + last_write_checksum: sha1:fb7d9247173ad2c3f07def425cb55ad447f31006 + pristine_git_object: 8afdfa5959f9d40e6bfae72293d9485fdd5f143a docs/models/operations/platformchatcreateinput.md: id: 30dd49c63c34 last_write_checksum: sha1:b84e23b26eb042cfca1bcd894a12b11c4b7e9dd0 @@ -3507,92 +3507,92 @@ trackedFiles: pristine_git_object: b632d8d1155d3cacb51aa92301d71ac4798dcfe0 docs/models/operations/platformskillscreateversionrequest.md: id: "2144541424e6" - last_write_checksum: sha1:ae8c31be517af1b8d10a6a016812899bf059bec6 - pristine_git_object: 3c4146374563d18862fdc9d3730f8f3ef02710c4 + last_write_checksum: sha1:157567471ecc481d4a1890280edd677bd2552a9c + pristine_git_object: 9793bfe4c3320444e2728c1025a7e68dfe9bfa88 docs/models/operations/platformskillsdeleterequest.md: id: 76e6cf7f760a - last_write_checksum: sha1:fd5a528571b56d12fd01d48d46bc82d3c81e9bed - pristine_git_object: 98750929b1d99ee1aeed02b5d6890690418208e6 + last_write_checksum: sha1:322eee23555d60a1b9082bb179cee8ad7d8494d0 + pristine_git_object: ed596cfe2cadf363bcb7f705a77e48e0732751f4 docs/models/operations/platformskillsgetcontentrequest.md: id: 5462edb6ce37 - last_write_checksum: sha1:aefcfbcba14318c140d86d2d856fa4268d8d7414 - pristine_git_object: d9cde490eb1dbf7d1adccc794b239c42c6e4fcef + last_write_checksum: sha1:1a31e4ad088eda91de4216926560a556b0b51ba4 + pristine_git_object: 46e6f8245e8ecc659bb5bdf9d2aceb6db7833462 docs/models/operations/platformskillsgetcontentresponse.md: id: b6485cee828d last_write_checksum: sha1:1046b825f3c99353ce4269a61edc5df9b9436aa6 pristine_git_object: a1323c53a7f65b0be6eca65326f1d5704deb8f61 docs/models/operations/platformskillsgetrequest.md: id: 6e77031ea696 - last_write_checksum: sha1:77b912d1988027c6569d81359278fe1ce453b9e2 - pristine_git_object: 9e4d8cee63af8a2ff90a3bb1579be91720170191 + last_write_checksum: sha1:8911b0839001fe56161552807490c7171bbbd6d1 + pristine_git_object: 400f257a4c21a45a9629ae10da38d1001bffbd0b docs/models/operations/platformskillsgetversioncontentrequest.md: id: 422bf4074e8b - last_write_checksum: sha1:538fe84e11e6db7693a32ed491e56dc83258679b - pristine_git_object: 46f44647ef53fd415a06875fdb79e75bfd4d686c + last_write_checksum: sha1:5f2c52e64d2f48282df01182fead012d8c7e826b + pristine_git_object: bfceb36ca0df2ccd722233caeb5ac3ca1065a380 docs/models/operations/platformskillsgetversioncontentresponse.md: id: b0cf2f3b0901 last_write_checksum: sha1:ea9d050cd52478683d1b11bd3752dbd193cc12af pristine_git_object: 2c598faaa1e7a0f7df2a09edb8991f9d7c136a75 docs/models/operations/platformskillsgetversionrequest.md: id: ef0df25fbc16 - last_write_checksum: sha1:19c288b31e681f7618bf6f21efeddc9806140f77 - pristine_git_object: 362f1257388e0161a23ec674a745400b85c30589 + last_write_checksum: sha1:3ff821b5e83fe985d511f93ed292a7666702526e + pristine_git_object: df6d40b82f2de74f010de3c09c97f97464649a00 docs/models/operations/platformskillslistrequest.md: id: 2e304cbf2212 last_write_checksum: sha1:91ee0f4ef89ff4d3634615a9d2ee6daa1db63c20 pristine_git_object: 6a07bb06bb7902990b6031e194b30e73a289d62a docs/models/operations/platformskillslistversionsrequest.md: id: 6445143da2e1 - last_write_checksum: sha1:ee8144358fe287c81a6675c284216168fa9e0586 - pristine_git_object: f5215f8a3f1ae9373c2d255ad331c6b4fd739fd1 + last_write_checksum: sha1:66b757ef0e977a3cf0428f57242fea2b9f1334da + pristine_git_object: 805fed08bcb0b38a9645bf1b70f448ea90f3b8c2 docs/models/operations/platformskillspreviewsourceresponse.md: id: bde357631ee1 last_write_checksum: sha1:e6adc119a40e5e1b3563a330a20448a2a80e4e40 pristine_git_object: 37d76500c8680dd2bee73a5f2121e7d4806b9759 docs/models/operations/platformskillssyncrequest.md: id: 4bb36bc4c65f - last_write_checksum: sha1:01f619f242a16107740aa7acd650d2bb072770b8 - pristine_git_object: 5bc097e4fa7b6f0f737f86c55a4211e9ee4ddbf7 + last_write_checksum: sha1:f3843b3717212d37d06d10096b45cc4e749117bd + pristine_git_object: 4c0cc1270f89a21106adda0956582d0c6af9eb5b docs/models/operations/platformskillsupdaterequest.md: id: 0ecd8af8f701 - last_write_checksum: sha1:5bf37d81d9ed14716b52aadfe3d866e71b6541d9 - pristine_git_object: a05490d2a3cae794c3bbd0239bf63fbc884c65c9 + last_write_checksum: sha1:1387386f76e9552aecc144d8f8bad5ee6954cc9b + pristine_git_object: 4d5090ec410b46cba56347f29a10408785f80d64 docs/models/operations/platformtriggerpresetseventssearchrequest.md: id: e7975eb729f5 - last_write_checksum: sha1:d288c2d1aa9cff9b673fb63624ebf3b5de1cc4ae - pristine_git_object: ccc1014ccec863d86f7ee642c8118702918888bc + last_write_checksum: sha1:060de30ea8b93695678ed9595d9d37855de6be98 + pristine_git_object: 196ce606d4301b00acab943274063f32871eae4e docs/models/operations/platformtriggerpresetsgetrequest.md: id: 1c73fba32272 - last_write_checksum: sha1:459bb477a356452fa5ea47faa2c461fc7383c222 - pristine_git_object: 3e092b1fdcbf9c88ebe8729a06a8b1d2dd1112c5 + last_write_checksum: sha1:c4ba195d31a28a59a7d43e5018b9ad04027fb8af + pristine_git_object: 35f36b45524c1348ca281e8d372b5b2fd367a6c5 docs/models/operations/platformtriggerpresetsinputvalueslistrequest.md: id: 2bcf296778c5 - last_write_checksum: sha1:e6cdd14b333197896559db63e0df7fc3770c0419 - pristine_git_object: 8fbe206ba3757253f9cec9c6c4c7ba63b6da4654 + last_write_checksum: sha1:4c31edb985e57f7ce21d7a29462c86b30a34d1e0 + pristine_git_object: ffb1ea1b7521732b608c500235d13406d46597d3 docs/models/operations/platformtriggerpresetslistrequest.md: id: d5d046363585 last_write_checksum: sha1:8bd6c83462bee40aa40cad36f899600439758816 pristine_git_object: a73a93e5e3ac6ba20b8ff7eaa4066d9b895aae7c docs/models/operations/platformtriggersdeleterequest.md: id: 9d9c01c3ab75 - last_write_checksum: sha1:4161f07ee0d3e55ac3b3e7ef6b3d6cd315633134 - pristine_git_object: c81f9e53b4af35e9bbaa3d493e92787be190bad8 + last_write_checksum: sha1:8e3d082e9b2111fa9d3fb7c662e33341d3eeec0e + pristine_git_object: d6ca4a03d60f5a4ec89ac4cb4682fb6c23c99411 docs/models/operations/platformtriggerseventssearchrequest.md: id: b55312ea0a25 - last_write_checksum: sha1:e1044ac8014e29d86982bb286e77c7552c61f64f - pristine_git_object: d7ca59e0b37eeeb3bc9890b581b2f97bce91844a + last_write_checksum: sha1:ee915a0e5cc1c20dcf39e3defa18bb34d8d994e7 + pristine_git_object: bbc2c216cc80ad331aef71a711a0dcc31133ad0b docs/models/operations/platformtriggersgetrequest.md: id: e6ec4199a6fc - last_write_checksum: sha1:fe8d67ef6b1277f20dafe7dd5663926d251f7870 - pristine_git_object: e16272a6c8558ce75ab595a7447cdd0512165ac0 + last_write_checksum: sha1:049820344d67418f7e5b2c10da1bc07f9bafe772 + pristine_git_object: d86343a583f803ade54b0c2b612f67041f2e59f1 docs/models/operations/platformtriggerslistrequest.md: id: f833e5ee0b52 last_write_checksum: sha1:bced611122f84ced35604c012001afe9e98c5dba pristine_git_object: a9e97c3cfc0165dcee4824e0ad81ee30f12d3470 docs/models/operations/platformtriggersupdaterequest.md: id: 501a8c9f6fd4 - last_write_checksum: sha1:d1b5461fad8717e16b07cda9b0db84f09618796e - pristine_git_object: fd81b8d67523f03d3f6a9cbdab4fe392776a6edc + last_write_checksum: sha1:f99053d267e16dd9a8b900cf3a3d1538f4f53f0e + pristine_git_object: 9aa8ceac9b016aff0670136b20c3b213ad2ccf4e docs/models/operations/postapiindexv1debugdatasourcedocumenteventsrequest.md: id: 13205d748dcd last_write_checksum: sha1:a4343ef66a0c237e1eada5f9fe0ca897db13a0a2 @@ -3687,8 +3687,8 @@ trackedFiles: pristine_git_object: d660077d81220a7f0b093725c504fc9ed2db65ac docs/sdks/agents/README.md: id: 5965d8232fd8 - last_write_checksum: sha1:71582fbe56bc90f2e6e2fe6600e2a4394a5cfefc - pristine_git_object: 21e440ccd085b12b96c717c6863a5cb390dbeb4a + last_write_checksum: sha1:ae186b17e322b825bf77e554276c9fda52c8a90f + pristine_git_object: b1224201574023cd4e8000e718ac5eea6546aa7e docs/sdks/announcements/README.md: id: 3d2e130a217c last_write_checksum: sha1:9955e9b871a2deaa2c17cd1c92fb4d34f7e05138 @@ -3795,20 +3795,20 @@ trackedFiles: pristine_git_object: 6025b94e7355f974a45c9c00c892db4ad5f11bd0 docs/sdks/search/README.md: id: 5c534716244c - last_write_checksum: sha1:0ba414ed6689e9a91d151519f34bd6421da2c635 - pristine_git_object: 2c29a709d3d1b54d4abef32fe9f29f6364bfee38 + last_write_checksum: sha1:fc6f73f27c4a7c510f9408ca9b7bdda5552f3efb + pristine_git_object: bb8666982fe835860364141a7cdaa22e4472cd4d docs/sdks/skills/README.md: id: 3a14a5c90791 - last_write_checksum: sha1:6029a46cdbe5069db3645e882102498354dd4a49 - pristine_git_object: bf28c8a8a030c0a43d6fc7eeac4f334fff2003a9 + last_write_checksum: sha1:a07e7d1b332531af82534996a3b07225f2f81317 + pristine_git_object: 0ca3adef1e56373c966ddf01b38782ae808e812d docs/sdks/tools/README.md: id: 044286549bac last_write_checksum: sha1:23fcbbfc0e1b9d89c8466b6313b5125e05cd5aa7 pristine_git_object: bed0af9a44427e3eb7c2d8509454f1b77a7e4075 docs/sdks/triggers/README.md: id: 6706220e8a9c - last_write_checksum: sha1:faaa03767ed6f0284c003a7c3a3ee966c6382aaf - pristine_git_object: 08d7532f3257552bb6b28215daeb0024cf2190f3 + last_write_checksum: sha1:67d817b6b0d5fc1cdd942d1415cdac56feee77fe + pristine_git_object: beec0c847ccbf1d0aee096321cac51ebc01d3548 docs/sdks/verification/README.md: id: 8148670b64d3 last_write_checksum: sha1:5dae6116a97c546dd5d203beddd266ded05cdeec @@ -3843,12 +3843,12 @@ trackedFiles: pristine_git_object: 5a2797590d4be351d62915017d5b2a0f853537c8 jsr.json: id: 7f6ab7767282 - last_write_checksum: sha1:8c48bac407dc232c8f1201a0a710861d0ec839eb - pristine_git_object: 10d80ab78ce1f63f0fc1585ed49a2fba752fd55e + last_write_checksum: sha1:0007bb8bf98cc948652293be448cd09e98dd6d4d + pristine_git_object: 162b1153045cbbd9561e09eb7170f935e7869b65 package.json: id: 7030d0b2f71b - last_write_checksum: sha1:38e6e901909dfa4ca251e90fbf5c152250729d7d - pristine_git_object: c108ceb54617887546f47a54dc09e870494f309b + last_write_checksum: sha1:c8984176f8f8867fe6114ebe70a4b3098439a5da + pristine_git_object: 0f30175aae708229b363c3864f72098b1111bc8b src/__tests__/activities.test.ts: id: 65fa859b8f59 last_write_checksum: sha1:756bc40095f4495bbf62739b8218bb4a559a24f2 @@ -3963,8 +3963,8 @@ trackedFiles: pristine_git_object: d252821b825c62856886e3ab9287181d7ef7f9de src/__tests__/messages.test.ts: id: 39e293f09219 - last_write_checksum: sha1:17d923a23384341a26ce4774612e47a9bcfc8dc6 - pristine_git_object: 41c0b3c93454418989eac9a34b10c888541e3e2e + last_write_checksum: sha1:d71d67d8ed6743e623401b4101f70705c2eb5172 + pristine_git_object: a4785e3180745bef1ba299e2191e9c49bec1da88 src/__tests__/mockserver/.gitignore: id: 4a7fc421b6b6 last_write_checksum: sha1:228e1b05712a973948fd771323a2140a3b355ff4 @@ -7803,16 +7803,16 @@ trackedFiles: pristine_git_object: 7ce8f5effc329f11e78343356b16576bf94b9fed src/__tests__/search.test.ts: id: 97f2005515d0 - last_write_checksum: sha1:070b81b6acb9b6207f71dbddaa59f21c99cbca86 - pristine_git_object: 7e6a25ad28e03b2bc7e9b9ec272d1b8424e81ae6 + last_write_checksum: sha1:0caffb8a18345afdccbb6bf083547451fbe897b7 + pristine_git_object: 976a5e8d5b782d68ae02a68ff752f153746a4416 src/__tests__/skills.test.ts: id: 3fa6e540c659 last_write_checksum: sha1:84f9b02b6376707d515a2598c9a09f84db5f8d03 pristine_git_object: 80853fce6d86d20766336fb2fd27c8669cd12ca8 src/__tests__/summarize.test.ts: id: 3105d6ebc7eb - last_write_checksum: sha1:530339639c4d11743032d2771e3a3f0567ca7f4b - pristine_git_object: a526bf2187424ed2a5da7c9bbf52644176663dc5 + last_write_checksum: sha1:dfb185c744196a1c04135d609d44ccdaa541d5d4 + pristine_git_object: a1e80406504d94388ad5335968a981e0cc471443 src/__tests__/testclient.ts: id: f142c080bff8 last_write_checksum: sha1:3a38647391f52221c009a9273eebf90793b3d430 @@ -7823,8 +7823,8 @@ trackedFiles: pristine_git_object: 15f49d26a65db6e395ddac5ad93c5e1cb2ef28b0 src/__tests__/triggers.test.ts: id: 9325c87699e4 - last_write_checksum: sha1:a46d4c5730100b01e5f3b58639b11317842f905b - pristine_git_object: 3b4efedc6ad9e1c4bdd08a6512a0562855a4b19e + last_write_checksum: sha1:9381f4978f03f4b2987c8f5e9ce80c821a0633db + pristine_git_object: 0d1fdee6e65f3630296978403d44cbf532a95cc7 src/__tests__/troubleshooting.test.ts: id: 1f0f352d1c2f last_write_checksum: sha1:ae012c71aed121aeaf98640aca35ba5acf4d251c @@ -8527,8 +8527,8 @@ trackedFiles: pristine_git_object: 42d9739ab67c2fec0689f83777ffa5e1f875e5d5 src/lib/config.ts: id: 320761608fb3 - last_write_checksum: sha1:af04dab93046742d99e31067a3f85024c40f862c - pristine_git_object: 3dd86fe4cc9162feaac8b0e511aa8e27bbc0f6a4 + last_write_checksum: sha1:3c03dd73a32b36bb0b1002a59a3ffea03cc1b0f3 + pristine_git_object: 6555b62fcc88bf13aabd3145c381fb692c4c70f7 src/lib/encodings.ts: id: 3bd8ead98afd last_write_checksum: sha1:d1917169abb226ccb0d2e93fd211a1d2987822b4 @@ -13512,7 +13512,7 @@ examples: platform-search: speakeasy-default-platform-search: requestBody: - application/json: {"query": "quarterly planning 2026", "page_size": 10, "datasources": ["confluence", "google_drive"], "filters": [{"field": "type", "values": ["spreadsheet", "presentation"]}]} + application/json: {"query": "quarterly planning 2026", "page_size": 10} responses: "200": application/json: {"results": [], "has_more": false, "next_cursor": "", "request_id": "", "warnings": []} @@ -13765,7 +13765,7 @@ examples: platform-triggers-create: speakeasy-default-platform-triggers-create: requestBody: - application/json: {"preset_id": "GITHUB_1", "description": "Reviews I am tagged on, sent to my team's review channel", "inputs": {"repository": "acme/payments-api"}, "delivery": {"webhook_url": "https://customer.app/webhook", "auth": {"type": "BEARER", "secret": "secret_test_123"}}} + application/json: {"preset_id": "GITHUB_1", "inputs": {"repository": "{repository}"}, "delivery": {"webhook_url": "https://example.com/webhook"}} responses: "201": application/json: {"trigger": {"trigger_id": "trigger_test_123", "preset_id": "GITHUB_1", "description": "Reviews I am tagged on, sent to my team's review channel", "status": "ENABLED", "inputs": {"repository": "acme/payments-api"}, "delivery": {"webhook_url": "https://customer.app/webhook"}, "created_at": "2025-08-17T18:19:46.877Z", "updated_at": "2024-09-14T03:27:40.201Z", "signing_secret": "whsec_xxx"}, "request_id": ""} @@ -13803,7 +13803,7 @@ examples: path: trigger_id: "" requestBody: - application/json: {"status": "ENABLED", "description": "Reviews I am tagged on, sent to my team's review channel", "inputs": {"repository": "acme/payments-api"}, "delivery": {"webhook_url": "https://customer.app/webhook", "auth": {"type": "BEARER", "secret": "secret_test_123"}}} + application/json: {"inputs": {"repository": "{repository}"}, "delivery": {"webhook_url": "https://example.com/webhook"}} responses: "200": application/json: {"trigger": {"trigger_id": "trigger_test_123", "preset_id": "GITHUB_1", "description": "Reviews I am tagged on, sent to my team's review channel", "status": "ENABLED", "inputs": {"repository": "acme/payments-api"}, "delivery": {"webhook_url": "https://customer.app/webhook"}, "created_at": "2026-09-03T11:57:47.699Z", "updated_at": "2026-01-25T02:15:09.513Z"}, "request_id": ""} @@ -13826,6 +13826,8 @@ examples: parameters: path: trigger_id: "" + requestBody: + application/json: {"page_size": 10} responses: "200": application/json: {"results": [{"event_type": "DOCUMENT_CHANGE", "datasource": "GITHUB", "reason": "REVIEW_REQUESTED", "doc_type": "pull", "doc_id": "", "view_url": "https://silent-omelet.biz", "title": "", "event_time": "2024-06-12T22:23:25.274Z"}], "has_more": false, "request_id": ""} @@ -13877,7 +13879,7 @@ examples: path: preset_id: "" requestBody: - application/json: {"inputs": {"repository": "acme/payments-api"}, "page_size": 10} + application/json: {"inputs": {"repository": "{repository}"}, "page_size": 10} responses: "200": application/json: {"results": [{"event_type": "DOCUMENT_CHANGE", "datasource": "GITHUB", "reason": "REVIEW_REQUESTED", "doc_type": "pull", "doc_id": "", "view_url": "https://prickly-cutover.info/", "title": "", "event_time": "2025-04-15T15:45:31.544Z"}], "has_more": false, "request_id": ""} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 08626247..0b9f0dd8 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -35,7 +35,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: true typescript: - version: 0.20.1 + version: 0.20.2 acceptHeaderEnum: true additionalDependencies: dependencies: {} diff --git a/.speakeasy/glean-merged-spec.yaml b/.speakeasy/glean-merged-spec.yaml index f7da34f6..b4ceba82 100644 --- a/.speakeasy/glean-merged-spec.yaml +++ b/.speakeasy/glean-merged-spec.yaml @@ -2,8 +2,8 @@ openapi: 3.1.0 info: version: "0.9.0" title: Glean API - x-source-commit-sha: 5385fd04e94476a27a2fbb6d7dc806af5c4d61c8 - x-open-api-commit-sha: 78c3048aaa90e6293ba0522adee1866a5613da27 + x-source-commit-sha: 6c454c6b185ebe58e74e781a36041222f47897e0 + x-open-api-commit-sha: 0df5939226dc378b392825655b036df1e08909a7 description: | # Introduction In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean. @@ -90,6 +90,7 @@ paths: name: agent_id description: ID of the agent to retrieve. required: true + example: "{agent_id}" schema: type: string minLength: 1 @@ -134,6 +135,7 @@ paths: name: agent_id description: ID of the agent whose schemas should be retrieved. required: true + example: "{agent_id}" schema: type: string minLength: 1 @@ -186,6 +188,7 @@ paths: name: agent_id description: ID of the agent to run. required: true + example: "{agent_id}" schema: type: string minLength: 1 @@ -586,6 +589,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -643,6 +647,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -685,6 +690,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -732,6 +738,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -785,6 +792,7 @@ paths: in: path required: true description: ID of the GitHub-imported skill to sync. + example: "{skill_id}" schema: type: string minLength: 1 @@ -836,6 +844,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -893,6 +902,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -955,6 +965,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -962,6 +973,7 @@ paths: in: path required: true description: Major version number. + example: 1 schema: type: integer minimum: 1 @@ -1009,6 +1021,7 @@ paths: in: path required: true description: Glean skill ID. + example: "{skill_id}" schema: type: string minLength: 1 @@ -1016,6 +1029,7 @@ paths: in: path required: true description: Major version number. + example: 1 schema: type: integer minimum: 1 @@ -1325,6 +1339,7 @@ paths: name: trigger_id description: ID of the trigger to retrieve. required: true + example: "{trigger_id}" schema: type: string minLength: 1 @@ -1372,6 +1387,7 @@ paths: name: trigger_id description: ID of the trigger to update. required: true + example: "{trigger_id}" schema: type: string minLength: 1 @@ -1426,6 +1442,7 @@ paths: name: trigger_id description: ID of the trigger to delete. required: true + example: "{trigger_id}" schema: type: string minLength: 1 @@ -1469,6 +1486,7 @@ paths: name: trigger_id description: ID of the trigger whose events to search. required: true + example: "{trigger_id}" schema: type: string minLength: 1 @@ -1585,6 +1603,7 @@ paths: name: preset_id description: ID of the preset to retrieve. required: true + example: "{preset_id}" schema: type: string minLength: 1 @@ -1632,6 +1651,7 @@ paths: name: preset_id description: ID of the preset the input belongs to. required: true + example: "{preset_id}" schema: type: string minLength: 1 @@ -1639,6 +1659,7 @@ paths: name: field description: Field identifier of the input whose values to list. required: true + example: "{field}" schema: type: string minLength: 1 @@ -1693,6 +1714,7 @@ paths: name: preset_id description: ID of the preset to preview. required: true + example: "{preset_id}" schema: type: string minLength: 1 @@ -8279,14 +8301,6 @@ components: - query example: query: quarterly planning 2026 - datasources: - - confluence - - google_drive - filters: - - field: type - values: - - spreadsheet - - presentation properties: query: type: string @@ -8589,6 +8603,12 @@ components: required: - preset_id - delivery + example: + preset_id: GITHUB_1 + inputs: + repository: "{repository}" + delivery: + webhook_url: https://example.com/webhook properties: preset_id: type: string @@ -8760,6 +8780,11 @@ components: type: object additionalProperties: false description: Partial update. Only the supplied fields are changed. + example: + inputs: + repository: "{repository}" + delivery: + webhook_url: https://example.com/webhook properties: status: $ref: "#/components/schemas/PlatformTriggerStatus" @@ -8778,6 +8803,8 @@ components: PlatformTriggerEventSearchRequest: type: object additionalProperties: false + example: + page_size: 10 properties: page_size: type: integer @@ -9044,6 +9071,10 @@ components: PlatformTriggerPresetEventSearchRequest: type: object additionalProperties: false + example: + inputs: + repository: "{repository}" + page_size: 10 properties: inputs: type: object diff --git a/.speakeasy/tests.arazzo.yaml b/.speakeasy/tests.arazzo.yaml index 69fbc16d..14a3186f 100644 --- a/.speakeasy/tests.arazzo.yaml +++ b/.speakeasy/tests.arazzo.yaml @@ -164692,14 +164692,6 @@ workflows: requestBody: contentType: application/json payload: - datasources: - - confluence - - google_drive - filters: - - field: type - values: - - spreadsheet - - presentation page_size: 10 query: quarterly planning 2026 successCriteria: @@ -165182,13 +165174,9 @@ workflows: contentType: application/json payload: delivery: - auth: - secret: secret_test_123 - type: BEARER - webhook_url: https://customer.app/webhook - description: Reviews I am tagged on, sent to my team's review channel + webhook_url: https://example.com/webhook inputs: - repository: acme/payments-api + repository: '{repository}' preset_id: GITHUB_1 successCriteria: - condition: $statusCode == 201 @@ -165245,14 +165233,9 @@ workflows: contentType: application/json payload: delivery: - auth: - secret: secret_test_123 - type: BEARER - webhook_url: https://customer.app/webhook - description: Reviews I am tagged on, sent to my team's review channel + webhook_url: https://example.com/webhook inputs: - repository: acme/payments-api - status: ENABLED + repository: '{repository}' successCriteria: - condition: $statusCode == 200 - condition: $response.header.Content-Type == application/json @@ -165277,6 +165260,10 @@ workflows: condition: | {"results":[{"event_type":"DOCUMENT_CHANGE","datasource":"GITHUB","reason":"REVIEW_REQUESTED","doc_type":"pull","doc_id":"","view_url":"https://silent-omelet.biz","title":"","event_time":"2024-06-12T22:23:25.274Z"}],"has_more":false,"request_id":""} type: simple + requestBody: + contentType: application/json + payload: + page_size: 10 x-speakeasy-test-group: triggers x-speakeasy-test-rebuild: true - workflowId: platform-trigger-presets-list @@ -165345,7 +165332,7 @@ workflows: contentType: application/json payload: inputs: - repository: acme/payments-api + repository: '{repository}' page_size: 10 successCriteria: - condition: $statusCode == 200 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 27576033..81d5e671 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.796.3 sources: Glean API: sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:2b3f26244cb020a2b993f2ab0e89b609ddb1b9de5405cfd6b4f8706080a5a054 - sourceBlobDigest: sha256:23c5ad26db734cb51ec976cb1d9eca9d671b5482e8f290e98cf6b06ad4725d5a + sourceRevisionDigest: sha256:e247e871123d34059c563050f008462386b91706ae3dff64ae6d76ba1db41c47 + sourceBlobDigest: sha256:492a86ef598c2a97eeabd40c94fcbbdfe57c36e0381cf8bb18d91b8f6f8f135f tags: - latest Glean Client API: @@ -17,10 +17,10 @@ targets: glean: source: Glean API sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:2b3f26244cb020a2b993f2ab0e89b609ddb1b9de5405cfd6b4f8706080a5a054 - sourceBlobDigest: sha256:23c5ad26db734cb51ec976cb1d9eca9d671b5482e8f290e98cf6b06ad4725d5a + sourceRevisionDigest: sha256:e247e871123d34059c563050f008462386b91706ae3dff64ae6d76ba1db41c47 + sourceBlobDigest: sha256:492a86ef598c2a97eeabd40c94fcbbdfe57c36e0381cf8bb18d91b8f6f8f135f codeSamplesNamespace: glean-api-specs-typescript-code-samples - codeSamplesRevisionDigest: sha256:530ccf3adcf17c36d6baddaf4e156ae128d474bce63563bdbe7995152d9cb760 + codeSamplesRevisionDigest: sha256:37d8a1ee10aad5726f24ee15c09570bea21e19071ab41fdd2c9035040918a3be workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/REACT_QUERY.md b/REACT_QUERY.md index 832fb713..49b559d7 100644 --- a/REACT_QUERY.md +++ b/REACT_QUERY.md @@ -53,7 +53,7 @@ from TanStack Query. import { useAgentsGet } from "@gleanwork/api-client/react-query/agentsGet.js"; export function Example() { - const { data, error, status } = useAgentsGet(""); + const { data, error, status } = useAgentsGet("{agent_id}"); // Render the UI here... } @@ -71,7 +71,7 @@ import { useAgentsGet } from "@gleanwork/api-client/react-query/agentsGet.js"; export function ExampleWithOptions() { const [enabled, setEnabled] = useState(true); const { data, error, status } = useAgentsGet( - "", + "{agent_id}", { // TanStack Query options: enabled, @@ -256,7 +256,7 @@ export function App() { } function Example() { - const { data } = useAgentsGetSuspense(""); + const { data } = useAgentsGetSuspense("{agent_id}"); // Render the UI here... } @@ -284,7 +284,7 @@ export default async function Page() { apiToken: process.env["GLEAN_API_TOKEN"] ?? "", }); - await prefetchAgentsGet(queryClient, glean, ""); + await prefetchAgentsGet(queryClient, glean, "{agent_id}"); return ( // HydrationBoundary is a Client Component, so hydration will happen there. diff --git a/RELEASES.md b/RELEASES.md index df39e984..b1d513c2 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -898,4 +898,14 @@ Based on: ### Generated - [typescript v0.20.1] . ### Releases -- [NPM v0.20.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.20.1 - . \ No newline at end of file +- [NPM v0.20.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.20.1 - . + +## 2026-09-02 19:59:26 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.796.3 (2.934.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.20.2] . +### Releases +- [NPM v0.20.2] https://www.npmjs.com/package/@gleanwork/api-client/v/0.20.2 - . \ No newline at end of file diff --git a/docs/models/components/platformsearchrequest.md b/docs/models/components/platformsearchrequest.md index 0f34f62e..d3518b8b 100644 --- a/docs/models/components/platformsearchrequest.md +++ b/docs/models/components/platformsearchrequest.md @@ -7,19 +7,6 @@ import { PlatformSearchRequest } from "@gleanwork/api-client/models/components"; let value: PlatformSearchRequest = { query: "quarterly planning 2026", - datasources: [ - "confluence", - "google_drive", - ], - filters: [ - { - field: "type", - values: [ - "spreadsheet", - "presentation", - ], - }, - ], }; ``` diff --git a/docs/models/components/platformtriggercreaterequest.md b/docs/models/components/platformtriggercreaterequest.md index c6f166aa..e8ed6a7e 100644 --- a/docs/models/components/platformtriggercreaterequest.md +++ b/docs/models/components/platformtriggercreaterequest.md @@ -7,16 +7,11 @@ import { PlatformTriggerCreateRequest } from "@gleanwork/api-client/models/compo let value: PlatformTriggerCreateRequest = { preset_id: "GITHUB_1", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }; ``` diff --git a/docs/models/components/platformtriggerpreseteventsearchrequest.md b/docs/models/components/platformtriggerpreseteventsearchrequest.md index 37e0dde7..31a8e101 100644 --- a/docs/models/components/platformtriggerpreseteventsearchrequest.md +++ b/docs/models/components/platformtriggerpreseteventsearchrequest.md @@ -7,7 +7,7 @@ import { PlatformTriggerPresetEventSearchRequest } from "@gleanwork/api-client/m let value: PlatformTriggerPresetEventSearchRequest = { inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, }; ``` diff --git a/docs/models/components/platformtriggerupdaterequest.md b/docs/models/components/platformtriggerupdaterequest.md index 7bdf3935..0c5b491d 100644 --- a/docs/models/components/platformtriggerupdaterequest.md +++ b/docs/models/components/platformtriggerupdaterequest.md @@ -8,17 +8,11 @@ Partial update. Only the supplied fields are changed. import { PlatformTriggerUpdateRequest } from "@gleanwork/api-client/models/components"; let value: PlatformTriggerUpdateRequest = { - status: "ENABLED", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }; ``` diff --git a/docs/models/operations/platformagentscreaterunrequest.md b/docs/models/operations/platformagentscreaterunrequest.md index c23c378b..9d15ac85 100644 --- a/docs/models/operations/platformagentscreaterunrequest.md +++ b/docs/models/operations/platformagentscreaterunrequest.md @@ -6,7 +6,7 @@ import { PlatformAgentsCreateRunRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformAgentsCreateRunRequest = { - agent_id: "", + agent_id: "{agent_id}", platformAgentRunCreateRequest: { messages: [ { @@ -27,5 +27,5 @@ let value: PlatformAgentsCreateRunRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `agentId` | *string* | :heavy_check_mark: | ID of the agent to run. | | +| `agentId` | *string* | :heavy_check_mark: | ID of the agent to run. | {agent_id} | | `platformAgentRunCreateRequest` | [components.PlatformAgentRunCreateRequest](../../models/components/platformagentruncreaterequest.md) | :heavy_check_mark: | N/A | {
"messages": [
{
"role": "USER",
"content": [
{
"text": "What is our parental leave policy?",
"type": "text"
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/operations/platformagentsgetrequest.md b/docs/models/operations/platformagentsgetrequest.md index 9b82586d..b02fac98 100644 --- a/docs/models/operations/platformagentsgetrequest.md +++ b/docs/models/operations/platformagentsgetrequest.md @@ -6,12 +6,12 @@ import { PlatformAgentsGetRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformAgentsGetRequest = { - agent_id: "", + agent_id: "{agent_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `agentId` | *string* | :heavy_check_mark: | ID of the agent to retrieve. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | +| `agentId` | *string* | :heavy_check_mark: | ID of the agent to retrieve. | {agent_id} | \ No newline at end of file diff --git a/docs/models/operations/platformagentsgetschemasrequest.md b/docs/models/operations/platformagentsgetschemasrequest.md index 86d05518..8afdfa59 100644 --- a/docs/models/operations/platformagentsgetschemasrequest.md +++ b/docs/models/operations/platformagentsgetschemasrequest.md @@ -6,13 +6,13 @@ import { PlatformAgentsGetSchemasRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformAgentsGetSchemasRequest = { - agent_id: "", + agent_id: "{agent_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `agentId` | *string* | :heavy_check_mark: | ID of the agent whose schemas should be retrieved. | -| `includeTools` | *boolean* | :heavy_minus_sign: | Whether to include tool metadata in the response. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `agentId` | *string* | :heavy_check_mark: | ID of the agent whose schemas should be retrieved. | {agent_id} | +| `includeTools` | *boolean* | :heavy_minus_sign: | Whether to include tool metadata in the response. | | \ No newline at end of file diff --git a/docs/models/operations/platformskillscreateversionrequest.md b/docs/models/operations/platformskillscreateversionrequest.md index 3c414637..9793bfe4 100644 --- a/docs/models/operations/platformskillscreateversionrequest.md +++ b/docs/models/operations/platformskillscreateversionrequest.md @@ -10,7 +10,7 @@ import { PlatformSkillsCreateVersionRequest } from "@gleanwork/api-client/models ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `platformSkillVersionCreateRequest` | [components.PlatformSkillVersionCreateRequest](../../models/components/platformskillversioncreaterequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `platformSkillVersionCreateRequest` | [components.PlatformSkillVersionCreateRequest](../../models/components/platformskillversioncreaterequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/platformskillsdeleterequest.md b/docs/models/operations/platformskillsdeleterequest.md index 98750929..ed596cfe 100644 --- a/docs/models/operations/platformskillsdeleterequest.md +++ b/docs/models/operations/platformskillsdeleterequest.md @@ -6,12 +6,12 @@ import { PlatformSkillsDeleteRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsDeleteRequest = { - skill_id: "", + skill_id: "{skill_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | \ No newline at end of file diff --git a/docs/models/operations/platformskillsgetcontentrequest.md b/docs/models/operations/platformskillsgetcontentrequest.md index d9cde490..46e6f824 100644 --- a/docs/models/operations/platformskillsgetcontentrequest.md +++ b/docs/models/operations/platformskillsgetcontentrequest.md @@ -6,12 +6,12 @@ import { PlatformSkillsGetContentRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsGetContentRequest = { - skill_id: "", + skill_id: "{skill_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | \ No newline at end of file diff --git a/docs/models/operations/platformskillsgetrequest.md b/docs/models/operations/platformskillsgetrequest.md index 9e4d8cee..400f257a 100644 --- a/docs/models/operations/platformskillsgetrequest.md +++ b/docs/models/operations/platformskillsgetrequest.md @@ -6,12 +6,12 @@ import { PlatformSkillsGetRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsGetRequest = { - skill_id: "", + skill_id: "{skill_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | \ No newline at end of file diff --git a/docs/models/operations/platformskillsgetversioncontentrequest.md b/docs/models/operations/platformskillsgetversioncontentrequest.md index 46f44647..bfceb36c 100644 --- a/docs/models/operations/platformskillsgetversioncontentrequest.md +++ b/docs/models/operations/platformskillsgetversioncontentrequest.md @@ -6,14 +6,14 @@ import { PlatformSkillsGetVersionContentRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsGetVersionContentRequest = { - skill_id: "", - version: 320976, + skill_id: "{skill_id}", + version: 1, }; ``` ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `version` | *number* | :heavy_check_mark: | Major version number. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `version` | *number* | :heavy_check_mark: | Major version number. | 1 | \ No newline at end of file diff --git a/docs/models/operations/platformskillsgetversionrequest.md b/docs/models/operations/platformskillsgetversionrequest.md index 362f1257..df6d40b8 100644 --- a/docs/models/operations/platformskillsgetversionrequest.md +++ b/docs/models/operations/platformskillsgetversionrequest.md @@ -6,14 +6,14 @@ import { PlatformSkillsGetVersionRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsGetVersionRequest = { - skill_id: "", - version: 986773, + skill_id: "{skill_id}", + version: 1, }; ``` ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `version` | *number* | :heavy_check_mark: | Major version number. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `version` | *number* | :heavy_check_mark: | Major version number. | 1 | \ No newline at end of file diff --git a/docs/models/operations/platformskillslistversionsrequest.md b/docs/models/operations/platformskillslistversionsrequest.md index f5215f8a..805fed08 100644 --- a/docs/models/operations/platformskillslistversionsrequest.md +++ b/docs/models/operations/platformskillslistversionsrequest.md @@ -6,14 +6,14 @@ import { PlatformSkillsListVersionsRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsListVersionsRequest = { - skill_id: "", + skill_id: "{skill_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `pageSize` | *number* | :heavy_minus_sign: | Maximum number of versions to return. | -| `cursor` | *string* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `pageSize` | *number* | :heavy_minus_sign: | Maximum number of versions to return. | | +| `cursor` | *string* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | | \ No newline at end of file diff --git a/docs/models/operations/platformskillssyncrequest.md b/docs/models/operations/platformskillssyncrequest.md index 5bc097e4..4c0cc127 100644 --- a/docs/models/operations/platformskillssyncrequest.md +++ b/docs/models/operations/platformskillssyncrequest.md @@ -6,12 +6,12 @@ import { PlatformSkillsSyncRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsSyncRequest = { - skill_id: "", + skill_id: "{skill_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `skillId` | *string* | :heavy_check_mark: | ID of the GitHub-imported skill to sync. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `skillId` | *string* | :heavy_check_mark: | ID of the GitHub-imported skill to sync. | {skill_id} | \ No newline at end of file diff --git a/docs/models/operations/platformskillsupdaterequest.md b/docs/models/operations/platformskillsupdaterequest.md index a05490d2..4d5090ec 100644 --- a/docs/models/operations/platformskillsupdaterequest.md +++ b/docs/models/operations/platformskillsupdaterequest.md @@ -6,7 +6,7 @@ import { PlatformSkillsUpdateRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformSkillsUpdateRequest = { - skill_id: "", + skill_id: "{skill_id}", platformSkillUpdateRequest: { status: "ENABLED", }, @@ -17,5 +17,5 @@ let value: PlatformSkillsUpdateRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | | `platformSkillUpdateRequest` | [components.PlatformSkillUpdateRequest](../../models/components/platformskillupdaterequest.md) | :heavy_check_mark: | N/A | {
"status": "ENABLED"
} | \ No newline at end of file diff --git a/docs/models/operations/platformtriggerpresetseventssearchrequest.md b/docs/models/operations/platformtriggerpresetseventssearchrequest.md index ccc1014c..196ce606 100644 --- a/docs/models/operations/platformtriggerpresetseventssearchrequest.md +++ b/docs/models/operations/platformtriggerpresetseventssearchrequest.md @@ -6,13 +6,13 @@ import { PlatformTriggerPresetsEventsSearchRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggerPresetsEventsSearchRequest = { - preset_id: "", + preset_id: "{preset_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset to preview. | -| `platformTriggerPresetEventSearchRequest` | [components.PlatformTriggerPresetEventSearchRequest](../../models/components/platformtriggerpreseteventsearchrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `presetId` | *string* | :heavy_check_mark: | ID of the preset to preview. | {preset_id} | +| `platformTriggerPresetEventSearchRequest` | [components.PlatformTriggerPresetEventSearchRequest](../../models/components/platformtriggerpreseteventsearchrequest.md) | :heavy_minus_sign: | N/A | {
"inputs": {
"repository": "{repository}"
},
"page_size": 10
} | \ No newline at end of file diff --git a/docs/models/operations/platformtriggerpresetsgetrequest.md b/docs/models/operations/platformtriggerpresetsgetrequest.md index 3e092b1f..35f36b45 100644 --- a/docs/models/operations/platformtriggerpresetsgetrequest.md +++ b/docs/models/operations/platformtriggerpresetsgetrequest.md @@ -6,12 +6,12 @@ import { PlatformTriggerPresetsGetRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggerPresetsGetRequest = { - preset_id: "", + preset_id: "{preset_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset to retrieve. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | +| `presetId` | *string* | :heavy_check_mark: | ID of the preset to retrieve. | {preset_id} | \ No newline at end of file diff --git a/docs/models/operations/platformtriggerpresetsinputvalueslistrequest.md b/docs/models/operations/platformtriggerpresetsinputvalueslistrequest.md index 8fbe206b..ffb1ea1b 100644 --- a/docs/models/operations/platformtriggerpresetsinputvalueslistrequest.md +++ b/docs/models/operations/platformtriggerpresetsinputvalueslistrequest.md @@ -6,15 +6,15 @@ import { PlatformTriggerPresetsInputValuesListRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggerPresetsInputValuesListRequest = { - preset_id: "", - field: "", + preset_id: "{preset_id}", + field: "{field}", }; ``` ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset the input belongs to. | -| `field` | *string* | :heavy_check_mark: | Field identifier of the input whose values to list. | -| `query` | *string* | :heavy_minus_sign: | Prefix filter over the input's option values, for typeahead. Matching is on the option value, not its display name.
| \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `presetId` | *string* | :heavy_check_mark: | ID of the preset the input belongs to. | {preset_id} | +| `field` | *string* | :heavy_check_mark: | Field identifier of the input whose values to list. | {field} | +| `query` | *string* | :heavy_minus_sign: | Prefix filter over the input's option values, for typeahead. Matching is on the option value, not its display name.
| | \ No newline at end of file diff --git a/docs/models/operations/platformtriggersdeleterequest.md b/docs/models/operations/platformtriggersdeleterequest.md index c81f9e53..d6ca4a03 100644 --- a/docs/models/operations/platformtriggersdeleterequest.md +++ b/docs/models/operations/platformtriggersdeleterequest.md @@ -6,12 +6,12 @@ import { PlatformTriggersDeleteRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggersDeleteRequest = { - trigger_id: "", + trigger_id: "{trigger_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to delete. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to delete. | {trigger_id} | \ No newline at end of file diff --git a/docs/models/operations/platformtriggerseventssearchrequest.md b/docs/models/operations/platformtriggerseventssearchrequest.md index d7ca59e0..bbc2c216 100644 --- a/docs/models/operations/platformtriggerseventssearchrequest.md +++ b/docs/models/operations/platformtriggerseventssearchrequest.md @@ -6,13 +6,13 @@ import { PlatformTriggersEventsSearchRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggersEventsSearchRequest = { - trigger_id: "", + trigger_id: "{trigger_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger whose events to search. | -| `platformTriggerEventSearchRequest` | [components.PlatformTriggerEventSearchRequest](../../models/components/platformtriggereventsearchrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger whose events to search. | {trigger_id} | +| `platformTriggerEventSearchRequest` | [components.PlatformTriggerEventSearchRequest](../../models/components/platformtriggereventsearchrequest.md) | :heavy_minus_sign: | N/A | {
"page_size": 10
} | \ No newline at end of file diff --git a/docs/models/operations/platformtriggersgetrequest.md b/docs/models/operations/platformtriggersgetrequest.md index e16272a6..d86343a5 100644 --- a/docs/models/operations/platformtriggersgetrequest.md +++ b/docs/models/operations/platformtriggersgetrequest.md @@ -6,12 +6,12 @@ import { PlatformTriggersGetRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggersGetRequest = { - trigger_id: "", + trigger_id: "{trigger_id}", }; ``` ## Fields -| Field | Type | Required | Description | -| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to retrieve. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to retrieve. | {trigger_id} | \ No newline at end of file diff --git a/docs/models/operations/platformtriggersupdaterequest.md b/docs/models/operations/platformtriggersupdaterequest.md index fd81b8d6..9aa8ceac 100644 --- a/docs/models/operations/platformtriggersupdaterequest.md +++ b/docs/models/operations/platformtriggersupdaterequest.md @@ -6,19 +6,13 @@ import { PlatformTriggersUpdateRequest } from "@gleanwork/api-client/models/operations"; let value: PlatformTriggersUpdateRequest = { - trigger_id: "", + trigger_id: "{trigger_id}", platformTriggerUpdateRequest: { - status: "ENABLED", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }, }; @@ -26,7 +20,7 @@ let value: PlatformTriggersUpdateRequest = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to update. | -| `platformTriggerUpdateRequest` | [components.PlatformTriggerUpdateRequest](../../models/components/platformtriggerupdaterequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to update. | {trigger_id} | +| `platformTriggerUpdateRequest` | [components.PlatformTriggerUpdateRequest](../../models/components/platformtriggerupdaterequest.md) | :heavy_check_mark: | N/A | {
"inputs": {
"repository": "{repository}"
},
"delivery": {
"webhook_url": "https://example.com/webhook"
}
} | \ No newline at end of file diff --git a/docs/sdks/agents/README.md b/docs/sdks/agents/README.md index 21e440cc..b1224201 100644 --- a/docs/sdks/agents/README.md +++ b/docs/sdks/agents/README.md @@ -118,7 +118,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.agents.get(""); + const result = await glean.agents.get("{agent_id}"); console.log(result); } @@ -141,7 +141,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await agentsGet(glean, ""); + const res = await agentsGet(glean, "{agent_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -183,12 +183,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `agentId` | *string* | :heavy_check_mark: | ID of the agent to retrieve. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `agentId` | *string* | :heavy_check_mark: | ID of the agent to retrieve. | {agent_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -218,7 +218,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.agents.getSchemas(""); + const result = await glean.agents.getSchemas("{agent_id}"); console.log(result); } @@ -241,7 +241,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await agentsGetSchemas(glean, ""); + const res = await agentsGetSchemas(glean, "{agent_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -283,13 +283,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `agentId` | *string* | :heavy_check_mark: | ID of the agent whose schemas should be retrieved. | -| `includeTools` | *boolean* | :heavy_minus_sign: | Whether to include tool metadata in the response. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `agentId` | *string* | :heavy_check_mark: | ID of the agent whose schemas should be retrieved. | {agent_id} | +| `includeTools` | *boolean* | :heavy_minus_sign: | Whether to include tool metadata in the response. | | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -331,7 +331,7 @@ async function run() { ], }, ], - }, ""); + }, "{agent_id}"); console.log(result); } @@ -366,7 +366,7 @@ async function run() { ], }, ], - }, ""); + }, "{agent_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -399,7 +399,7 @@ import { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `agentId` | *string* | :heavy_check_mark: | ID of the agent to run. | | +| `agentId` | *string* | :heavy_check_mark: | ID of the agent to run. | {agent_id} | | `platformAgentRunCreateRequest` | [components.PlatformAgentRunCreateRequest](../../models/components/platformagentruncreaterequest.md) | :heavy_check_mark: | N/A | {
"messages": [
{
"role": "USER",
"content": [
{
"text": "What is our parental leave policy?",
"type": "text"
}
]
}
]
} | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md index 2c29a709..bb866698 100644 --- a/docs/sdks/search/README.md +++ b/docs/sdks/search/README.md @@ -26,19 +26,6 @@ const glean = new Glean({ async function run() { const result = await glean.search.query({ query: "quarterly planning 2026", - datasources: [ - "confluence", - "google_drive", - ], - filters: [ - { - field: "type", - values: [ - "spreadsheet", - "presentation", - ], - }, - ], }); console.log(result); @@ -64,19 +51,6 @@ const glean = new GleanCore({ async function run() { const res = await searchQuery(glean, { query: "quarterly planning 2026", - datasources: [ - "confluence", - "google_drive", - ], - filters: [ - { - field: "type", - values: [ - "spreadsheet", - "presentation", - ], - }, - ], }); if (res.ok) { const { value: result } = res; diff --git a/docs/sdks/skills/README.md b/docs/sdks/skills/README.md index bf28c8a8..0ca3adef 100644 --- a/docs/sdks/skills/README.md +++ b/docs/sdks/skills/README.md @@ -518,7 +518,7 @@ const glean = new Glean({ async function run() { const result = await glean.skills.update({ status: "ENABLED", - }, ""); + }, "{skill_id}"); console.log(result); } @@ -543,7 +543,7 @@ const glean = new GleanCore({ async function run() { const res = await skillsUpdate(glean, { status: "ENABLED", - }, ""); + }, "{skill_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -576,7 +576,7 @@ import { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | | `platformSkillUpdateRequest` | [components.PlatformSkillUpdateRequest](../../models/components/platformskillupdaterequest.md) | :heavy_check_mark: | N/A | {
"status": "ENABLED"
} | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | @@ -610,7 +610,7 @@ const glean = new Glean({ }); async function run() { - await glean.skills.delete(""); + await glean.skills.delete("{skill_id}"); } @@ -633,7 +633,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsDelete(glean, ""); + const res = await skillsDelete(glean, "{skill_id}"); if (res.ok) { const { value: result } = res; @@ -664,12 +664,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -699,7 +699,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.skills.retrieve(""); + const result = await glean.skills.retrieve("{skill_id}"); console.log(result); } @@ -722,7 +722,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsRetrieve(glean, ""); + const res = await skillsRetrieve(glean, "{skill_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -764,12 +764,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -799,7 +799,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.skills.retrieveContent(""); + const result = await glean.skills.retrieveContent("{skill_id}"); console.log(result); } @@ -822,7 +822,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsRetrieveContent(glean, ""); + const res = await skillsRetrieveContent(glean, "{skill_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -864,12 +864,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -899,7 +899,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.skills.sync(""); + const result = await glean.skills.sync("{skill_id}"); console.log(result); } @@ -922,7 +922,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsSync(glean, ""); + const res = await skillsSync(glean, "{skill_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -953,12 +953,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | ID of the GitHub-imported skill to sync. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | ID of the GitHub-imported skill to sync. | {skill_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -991,7 +991,7 @@ const glean = new Glean({ async function run() { const result = await glean.skills.createVersion({ file: await openAsBlob("example.file"), - }, ""); + }, "{skill_id}"); console.log(result); } @@ -1017,7 +1017,7 @@ const glean = new GleanCore({ async function run() { const res = await skillsCreateVersion(glean, { file: await openAsBlob("example.file"), - }, ""); + }, "{skill_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -1048,13 +1048,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `platformSkillVersionCreateRequest` | [components.PlatformSkillVersionCreateRequest](../../models/components/platformskillversioncreaterequest.md) | :heavy_check_mark: | N/A | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `platformSkillVersionCreateRequest` | [components.PlatformSkillVersionCreateRequest](../../models/components/platformskillversioncreaterequest.md) | :heavy_check_mark: | N/A | | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -1084,7 +1084,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.skills.listVersions(""); + const result = await glean.skills.listVersions("{skill_id}"); console.log(result); } @@ -1107,7 +1107,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsListVersions(glean, ""); + const res = await skillsListVersions(glean, "{skill_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -1149,14 +1149,14 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `pageSize` | *number* | :heavy_minus_sign: | Maximum number of versions to return. | -| `cursor` | *string* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `pageSize` | *number* | :heavy_minus_sign: | Maximum number of versions to return. | | +| `cursor` | *string* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -1186,7 +1186,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.skills.retrieveVersion("", 495658); + const result = await glean.skills.retrieveVersion("{skill_id}", 1); console.log(result); } @@ -1209,7 +1209,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsRetrieveVersion(glean, "", 495658); + const res = await skillsRetrieveVersion(glean, "{skill_id}", 1); if (res.ok) { const { value: result } = res; console.log(result); @@ -1251,13 +1251,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `version` | *number* | :heavy_check_mark: | Major version number. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `version` | *number* | :heavy_check_mark: | Major version number. | 1 | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -1287,7 +1287,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.skills.retrieveVersionContent("", 117760); + const result = await glean.skills.retrieveVersionContent("{skill_id}", 1); console.log(result); } @@ -1310,7 +1310,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await skillsRetrieveVersionContent(glean, "", 117760); + const res = await skillsRetrieveVersionContent(glean, "{skill_id}", 1); if (res.ok) { const { value: result } = res; console.log(result); @@ -1352,13 +1352,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | -| `version` | *number* | :heavy_check_mark: | Major version number. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `skillId` | *string* | :heavy_check_mark: | Glean skill ID. | {skill_id} | +| `version` | *number* | :heavy_check_mark: | Major version number. | 1 | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response diff --git a/docs/sdks/triggers/README.md b/docs/sdks/triggers/README.md index 08d7532f..beec0c84 100644 --- a/docs/sdks/triggers/README.md +++ b/docs/sdks/triggers/README.md @@ -33,16 +33,11 @@ const glean = new Glean({ async function run() { const result = await glean.triggers.create({ preset_id: "GITHUB_1", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }); @@ -69,16 +64,11 @@ const glean = new GleanCore({ async function run() { const res = await triggersCreate(glean, { preset_id: "GITHUB_1", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }); if (res.ok) { @@ -247,7 +237,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.triggers.get(""); + const result = await glean.triggers.get("{trigger_id}"); console.log(result); } @@ -270,7 +260,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await triggersGet(glean, ""); + const res = await triggersGet(glean, "{trigger_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -312,12 +302,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to retrieve. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to retrieve. | {trigger_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -348,19 +338,13 @@ const glean = new Glean({ async function run() { const result = await glean.triggers.update({ - status: "ENABLED", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, - }, ""); + }, "{trigger_id}"); console.log(result); } @@ -384,19 +368,13 @@ const glean = new GleanCore({ async function run() { const res = await triggersUpdate(glean, { - status: "ENABLED", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, - }, ""); + }, "{trigger_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -427,13 +405,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to update. | -| `platformTriggerUpdateRequest` | [components.PlatformTriggerUpdateRequest](../../models/components/platformtriggerupdaterequest.md) | :heavy_check_mark: | N/A | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to update. | {trigger_id} | +| `platformTriggerUpdateRequest` | [components.PlatformTriggerUpdateRequest](../../models/components/platformtriggerupdaterequest.md) | :heavy_check_mark: | N/A | {
"inputs": {
"repository": "{repository}"
},
"delivery": {
"webhook_url": "https://example.com/webhook"
}
} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -463,7 +441,7 @@ const glean = new Glean({ }); async function run() { - await glean.triggers.delete(""); + await glean.triggers.delete("{trigger_id}"); } @@ -486,7 +464,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await triggersDelete(glean, ""); + const res = await triggersDelete(glean, "{trigger_id}"); if (res.ok) { const { value: result } = res; @@ -517,12 +495,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to delete. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger to delete. | {trigger_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -552,7 +530,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.triggers.searchEvents(""); + const result = await glean.triggers.searchEvents("{trigger_id}", {}); console.log(result); } @@ -575,7 +553,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await triggersSearchEvents(glean, ""); + const res = await triggersSearchEvents(glean, "{trigger_id}", {}); if (res.ok) { const { value: result } = res; console.log(result); @@ -606,13 +584,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger whose events to search. | -| `platformTriggerEventSearchRequest` | [components.PlatformTriggerEventSearchRequest](../../models/components/platformtriggereventsearchrequest.md) | :heavy_minus_sign: | N/A | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `triggerId` | *string* | :heavy_check_mark: | ID of the trigger whose events to search. | {trigger_id} | +| `platformTriggerEventSearchRequest` | [components.PlatformTriggerEventSearchRequest](../../models/components/platformtriggereventsearchrequest.md) | :heavy_minus_sign: | N/A | {
"page_size": 10
} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -744,7 +722,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.triggers.getPreset(""); + const result = await glean.triggers.getPreset("{preset_id}"); console.log(result); } @@ -767,7 +745,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await triggersGetPreset(glean, ""); + const res = await triggersGetPreset(glean, "{preset_id}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -809,12 +787,12 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset to retrieve. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `presetId` | *string* | :heavy_check_mark: | ID of the preset to retrieve. | {preset_id} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -844,7 +822,7 @@ const glean = new Glean({ }); async function run() { - const result = await glean.triggers.listPresetInputValues("", ""); + const result = await glean.triggers.listPresetInputValues("{preset_id}", "{field}"); console.log(result); } @@ -867,7 +845,7 @@ const glean = new GleanCore({ }); async function run() { - const res = await triggersListPresetInputValues(glean, "", ""); + const res = await triggersListPresetInputValues(glean, "{preset_id}", "{field}"); if (res.ok) { const { value: result } = res; console.log(result); @@ -909,14 +887,14 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset the input belongs to. | -| `field` | *string* | :heavy_check_mark: | Field identifier of the input whose values to list. | -| `query` | *string* | :heavy_minus_sign: | Prefix filter over the input's option values, for typeahead. Matching is on the option value, not its display name.
| -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `presetId` | *string* | :heavy_check_mark: | ID of the preset the input belongs to. | {preset_id} | +| `field` | *string* | :heavy_check_mark: | Field identifier of the input whose values to list. | {field} | +| `query` | *string* | :heavy_minus_sign: | Prefix filter over the input's option values, for typeahead. Matching is on the option value, not its display name.
| | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response @@ -946,9 +924,9 @@ const glean = new Glean({ }); async function run() { - const result = await glean.triggers.searchPresetEvents("", { + const result = await glean.triggers.searchPresetEvents("{preset_id}", { inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, }); @@ -973,9 +951,9 @@ const glean = new GleanCore({ }); async function run() { - const res = await triggersSearchPresetEvents(glean, "", { + const res = await triggersSearchPresetEvents(glean, "{preset_id}", { inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, }); if (res.ok) { @@ -1008,13 +986,13 @@ import { ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset to preview. | -| `platformTriggerPresetEventSearchRequest` | [components.PlatformTriggerPresetEventSearchRequest](../../models/components/platformtriggerpreseteventsearchrequest.md) | :heavy_minus_sign: | N/A | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `presetId` | *string* | :heavy_check_mark: | ID of the preset to preview. | {preset_id} | +| `platformTriggerPresetEventSearchRequest` | [components.PlatformTriggerPresetEventSearchRequest](../../models/components/platformtriggerpreseteventsearchrequest.md) | :heavy_minus_sign: | N/A | {
"inputs": {
"repository": "{repository}"
},
"page_size": 10
} | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | | ### Response diff --git a/examples/package-lock.json b/examples/package-lock.json index 99930f7a..15d44899 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@gleanwork/api-client", - "version": "0.20.1", + "version": "0.20.2", "dependencies": { "zod": "^3.25.0 || ^4.0.0" }, diff --git a/jsr.json b/jsr.json index 10d80ab7..162b1153 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@gleanwork/api-client", - "version": "0.20.1", + "version": "0.20.2", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index eb0edf3b..a1b9693a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@gleanwork/api-client", - "version": "0.20.1", + "version": "0.20.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@gleanwork/api-client", - "version": "0.20.1", + "version": "0.20.2", "dependencies": { "zod": "^3.25.0 || ^4.0.0" }, diff --git a/package.json b/package.json index c108ceb5..0f30175a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@gleanwork/api-client", - "version": "0.20.1", + "version": "0.20.2", "author": "Speakeasy", "tshy": { "sourceDialects": [ diff --git a/src/__tests__/messages.test.ts b/src/__tests__/messages.test.ts index 41c0b3c9..a4785e31 100644 --- a/src/__tests__/messages.test.ts +++ b/src/__tests__/messages.test.ts @@ -20,7 +20,7 @@ test("Messages Messages", async () => { idType: "CONVERSATION_ID", id: "", timestampMillis: 558834, - datasource: "GCHAT", + datasource: "SLACK", }); expect(result).toBeDefined(); }); diff --git a/src/__tests__/search.test.ts b/src/__tests__/search.test.ts index 7e6a25ad..976a5e8d 100644 --- a/src/__tests__/search.test.ts +++ b/src/__tests__/search.test.ts @@ -2062,19 +2062,6 @@ test("Search Platform Search", async () => { const result = await glean.search.query({ query: "quarterly planning 2026", - datasources: [ - "confluence", - "google_drive", - ], - filters: [ - { - field: "type", - values: [ - "spreadsheet", - "presentation", - ], - }, - ], }); expect(result).toBeDefined(); }); diff --git a/src/__tests__/summarize.test.ts b/src/__tests__/summarize.test.ts index a526bf21..a1e80406 100644 --- a/src/__tests__/summarize.test.ts +++ b/src/__tests__/summarize.test.ts @@ -19,7 +19,8 @@ test("Summarize Summarize", async () => { const result = await glean.client.documents.summarize({ documentSpecs: [ { - id: "", + ugcType: "ARTIFACTS", + ugcId: "", }, { id: "", diff --git a/src/__tests__/triggers.test.ts b/src/__tests__/triggers.test.ts index 3b4efedc..0d1fdee6 100644 --- a/src/__tests__/triggers.test.ts +++ b/src/__tests__/triggers.test.ts @@ -18,16 +18,11 @@ test("Triggers Platform Triggers Create", async () => { const result = await glean.triggers.create({ preset_id: "GITHUB_1", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }); expect(result).toBeDefined(); @@ -69,17 +64,11 @@ test("Triggers Platform Triggers Update", async () => { }); const result = await glean.triggers.update({ - status: "ENABLED", - description: "Reviews I am tagged on, sent to my team's review channel", inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, delivery: { - webhook_url: "https://customer.app/webhook", - auth: { - type: "BEARER", - secret: "secret_test_123", - }, + webhook_url: "https://example.com/webhook", }, }, ""); expect(result).toBeDefined(); @@ -96,7 +85,7 @@ test("Triggers Platform Triggers Events Search", async () => { apiToken: process.env["GLEAN_API_TOKEN"] ?? "value", }); - const result = await glean.triggers.searchEvents(""); + const result = await glean.triggers.searchEvents("", {}); expect(result).toBeDefined(); }); @@ -154,7 +143,7 @@ test("Triggers Platform Trigger Presets Events Search", async () => { const result = await glean.triggers.searchPresetEvents("", { inputs: { - "repository": "acme/payments-api", + "repository": "{repository}", }, }); expect(result).toBeDefined(); diff --git a/src/lib/config.ts b/src/lib/config.ts index 22be6549..9bc7f02e 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -73,8 +73,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.9.0", - sdkVersion: "0.20.1", + sdkVersion: "0.20.2", genVersion: "2.934.1", userAgent: - "speakeasy-sdk/typescript 0.20.1 2.934.1 0.9.0 @gleanwork/api-client", + "speakeasy-sdk/typescript 0.20.2 2.934.1 0.9.0 @gleanwork/api-client", } as const; From 5d0fe35881ffab2a3d0eff38404441ef3ed8bf31 Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Wed, 2 Sep 2026 20:07:48 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow