diff --git a/.claude/skills/scalar-api-python-sdk/SKILL.md b/.claude/skills/scalar-api-python-sdk/SKILL.md index fd18c2a..ef6a97c 100644 --- a/.claude/skills/scalar-api-python-sdk/SKILL.md +++ b/.claude/skills/scalar-api-python-sdk/SKILL.md @@ -41,6 +41,7 @@ client = Scalar( ) registry = client.registry.list_all_api_documents() + print(registry) ``` diff --git a/.github/workflows/release-title-edit.yml b/.github/workflows/release-title-edit.yml index d20b38d..d1827b1 100644 --- a/.github/workflows/release-title-edit.yml +++ b/.github/workflows/release-title-edit.yml @@ -15,14 +15,24 @@ jobs: version-consistency: # Also the check name the release PR's footer tells maintainers to wait for. name: Release PR version - # Only the platform's release PR carries a version in its title; every other pull request - # skips this job, which GitHub reports as neutral. The release may be presented from - # scalar-next itself or from the release-please branch rendered off it, so both heads - # count as the release PR. + # A release-shaped title against the release branch is the whole test here, with no clause + # on who opened the pull request or what branch it is rendered onto. This job only reads, + # and a pull request claiming to be a release is worth checking against the committed + # version whoever opened it. Every other pull request skips this job, which GitHub reports + # as neutral. + # + # Loose on purpose: the prefix, not the full semver pattern the script matches. A version + # typo'd into the title still reaches the script and fails there, rather than falling out + # of the guard and leaving no check at all — a missing check is not a failing one, and this + # is the check the release PR's footer tells maintainers to wait for before merging. + # + # It is also what keeps the workflow from failing silently if the platform ever opens + # release PRs from a different account: the bridge below stops firing, but this check still + # runs, the retitled version and the committed one disagree, and it turns red. The merge is + # blocked loudly instead of releasing the old version. if: >- ${{ github.event.pull_request.base.ref == 'main' - && (github.event.pull_request.head.ref == 'scalar-next' - || startsWith(github.event.pull_request.head.ref, 'release-please--branches--scalar-next--')) }} + && startsWith(github.event.pull_request.title, 'release: ') }} runs-on: ubuntu-latest steps: - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 @@ -60,14 +70,30 @@ jobs: # release PR from). `changes.title` is only set when the title itself changed, and bot # senders are ignored so the platform's own retitles cannot bounce back into another # commit. + # + # Both signals are required here, unlike the read-only check above, and each covers what the + # other cannot. The author, because this job pushes with `contents: write` and a title is + # free text — anyone able to open a pull request against main could otherwise + # name a version and have it committed to scalar-next. `user.login` is set by GitHub when + # the pull request is opened and cannot be forged by whoever edits the title afterwards. + # The title, because those accounts open pull requests other than release PRs, and retitling + # one of those must not push a release. + # + # One login per platform deployment, since a repo generated by staging carries staging's + # app. Parenthesised because the group is ANDed with the title clause below: without the + # parens that `&&` would bind to the last login alone, letting the other accounts push a + # release off any title. Listed rather than matched on the shared `scalar-docs` stem — a + # prefix test would also admit any future `scalar-docs-*[bot]`, including someone else's. if: >- ${{ github.event.action == 'edited' && github.event.changes.title != null && github.event.sender.type != 'Bot' && github.event.pull_request.state == 'open' && github.event.pull_request.base.ref == 'main' - && (github.event.pull_request.head.ref == 'scalar-next' - || startsWith(github.event.pull_request.head.ref, 'release-please--branches--scalar-next--')) }} + && (github.event.pull_request.user.login == 'scalar-docs[bot]' + || github.event.pull_request.user.login == 'scalar-docs-staging[bot]' + || github.event.pull_request.user.login == 'scalar-docs-development[bot]') + && startsWith(github.event.pull_request.title, 'release: ') }} # One bridge run at a time per pull request, newest retitle wins. Two retitles in quick # succession (a version typo corrected seconds later) would otherwise start two runs that # both read the version committed on the PR head, both get past the no-op guard, and both diff --git a/.github/workflows/sdk-ci.yml b/.github/workflows/sdk-ci.yml index 0594850..52fc8dd 100644 --- a/.github/workflows/sdk-ci.yml +++ b/.github/workflows/sdk-ci.yml @@ -14,3 +14,8 @@ jobs: python-version: "3.11" - run: python -m pip install --upgrade build - run: python -m build + # Verification only, never auto-fix: the SDK is generated formatted, so a diff here means + # either hand-edited custom code or a regenerate that was not committed. ruff is pinned to + # the release that produced these bytes, since a formatter minor can change them. + - run: python -m pip install "ruff==0.16.1" + - run: ruff format --check . diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 0477999..6969ddf 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.3.2" + ".": "0.3.3" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fed17d..063d47c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [0.3.3](https://github.com/scalar/scalar-python/compare/v0.3.2...v0.3.3) (2026-08-07) + + +### Chores + +* **api:** regenerate SDK ([bd41de9](https://github.com/scalar/scalar-python/commit/bd41de9d48cb9e92f4f559a670f7a5335d5dc385)) + ## [0.3.2](https://github.com/scalar/scalar-python/compare/v0.3.1...v0.3.2) (2026-07-28) diff --git a/LICENSE b/LICENSE index 261eeb9..190fc3a 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright 2026 Scalar API Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 58c0316..b334ad8 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ client = Scalar( ) registry = client.registry.list_all_api_documents() + print(registry) ``` @@ -60,10 +61,12 @@ import asyncio from scalar_sdk import AsyncScalar + async def main() -> None: client = AsyncScalar() registry = await client.registry.list_all_api_documents() + asyncio.run(main()) ``` diff --git a/SKILL.md b/SKILL.md index affd387..b62e9f0 100644 --- a/SKILL.md +++ b/SKILL.md @@ -41,6 +41,7 @@ client = Scalar( ) registry = client.registry.list_all_api_documents() + print(registry) ``` diff --git a/api.md b/api.md index a1f9c06..f007244 100644 --- a/api.md +++ b/api.md @@ -482,8 +482,35 @@ Create a login portal for the current team. login_portal = client.login_portals.create( title="", slug="", - email={"logo": "", "logo_size": "100", "button_text": "Login", "message": "Click to access private documentation hosted by scalar.com", "title": "Private Docs", "main_color": "#2a2f45", "main_background": "#f6f6f6", "card_color": "2a2f45", "card_background": "#fff", "button_color": "#fff", "button_background": "#0f0f0f"}, - page={"title": "Scalar Private Docs", "description": "Login to access your documentation", "head": "", "script": "", "theme": "", "company_name": "", "logo": "", "logo_url": "", "favicon": "", "terms_link": "", "privacy_link": "", "form_title": "Scalar Private Docs", "form_description": "Login to access your documentation", "form_image": ""}, + email={ + "logo": "", + "logo_size": "100", + "button_text": "Login", + "message": "Click to access private documentation hosted by scalar.com", + "title": "Private Docs", + "main_color": "#2a2f45", + "main_background": "#f6f6f6", + "card_color": "2a2f45", + "card_background": "#fff", + "button_color": "#fff", + "button_background": "#0f0f0f", + }, + page={ + "title": "Scalar Private Docs", + "description": "Login to access your documentation", + "head": "", + "script": "", + "theme": "", + "company_name": "", + "logo": "", + "logo_url": "", + "favicon": "", + "terms_link": "", + "privacy_link": "", + "form_title": "Scalar Private Docs", + "form_description": "Login to access your documentation", + "form_image": "", + }, ) ``` diff --git a/openapi.augmented.json b/openapi.augmented.json index 860d9f1..5adff09 100644 --- a/openapi.augmented.json +++ b/openapi.augmented.json @@ -1066,7 +1066,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst listAllAPIDocuments = await client.registry.listAllAPIDocuments();\nconsole.log(listAllAPIDocuments);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst listAllAPIDocuments = await client.registry.listAllAPIDocuments();\n\nconsole.log(listAllAPIDocuments);" }, { "lang": "Shell", @@ -1076,7 +1076,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.list_all_api_documents()\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.list_all_api_documents()\n\nprint(registry)" } ] } @@ -1178,7 +1178,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst listAPIDocuments = await client.registry.listAPIDocuments(\"namespace\");\nconsole.log(listAPIDocuments);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst listAPIDocuments = await client.registry.listAPIDocuments('namespace');\n\nconsole.log(listAPIDocuments);" }, { "lang": "Shell", @@ -1188,7 +1188,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.list_api_documents(\n namespace=\"namespace\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.list_api_documents(\n namespace=\"namespace\",\n)\n\nprint(registry)" } ] }, @@ -1354,7 +1354,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst createAPIDocument = await client.registry.createAPIDocument(\"namespace\", {\n title: \"\",\n version: \"x\",\n slug: \"\",\n document: \"\",\n});\nconsole.log(createAPIDocument);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst createAPIDocument = await client.registry.createAPIDocument('namespace', {\n title: '',\n version: 'x',\n slug: '',\n document: '',\n});\n\nconsole.log(createAPIDocument);" }, { "lang": "Shell", @@ -1364,7 +1364,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.create_api_document(\n namespace=\"namespace\",\n title=\"\",\n version=\"x\",\n slug=\"\",\n document=\"\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.create_api_document(\n namespace=\"namespace\",\n title=\"\",\n version=\"x\",\n slug=\"\",\n document=\"\",\n)\n\nprint(registry)" } ] } @@ -1496,7 +1496,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.updateAPIDocument(\"slug\", {\n namespace: \"namespace\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.updateAPIDocument('slug', {\n namespace: 'namespace',\n});" }, { "lang": "Shell", @@ -1506,7 +1506,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.update_api_document(\n namespace=\"namespace\",\n slug=\"slug\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.update_api_document(\n namespace=\"namespace\",\n slug=\"slug\",\n)\n\nprint(registry)" } ] }, @@ -1611,7 +1611,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.deleteAPIDocument(\"slug\", {\n namespace: \"namespace\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.deleteAPIDocument('slug', {\n namespace: 'namespace',\n});" }, { "lang": "Shell", @@ -1621,7 +1621,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.delete_api_document(\n namespace=\"namespace\",\n slug=\"slug\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.delete_api_document(\n namespace=\"namespace\",\n slug=\"slug\",\n)\n\nprint(registry)" } ] } @@ -1736,7 +1736,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.registry.retrieveAPIDocumentVersion(\"semver\", {\n namespace: \"namespace\",\n slug: \"slug\",\n});\nconsole.log(string_);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.registry.retrieveAPIDocumentVersion('semver', {\n namespace: 'namespace',\n slug: 'slug',\n});\n\nconsole.log(string_);" }, { "lang": "Shell", @@ -1746,7 +1746,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.retrieve_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.retrieve_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\n\nprint(registry)" } ] }, @@ -1898,7 +1898,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst updateAPIDocumentVersion = await client.registry.updateAPIDocumentVersion(\"semver\", {\n namespace: \"namespace\",\n slug: \"slug\",\n document: \"\",\n});\nconsole.log(updateAPIDocumentVersion);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst updateAPIDocumentVersion = await client.registry.updateAPIDocumentVersion('semver', {\n namespace: 'namespace',\n slug: 'slug',\n document: '',\n});\n\nconsole.log(updateAPIDocumentVersion);" }, { "lang": "Shell", @@ -1908,7 +1908,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.update_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n document=\"\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.update_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n document=\"\",\n)\n\nprint(registry)" } ] }, @@ -2021,7 +2021,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.deleteAPIDocumentVersion(\"semver\", {\n namespace: \"namespace\",\n slug: \"slug\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.deleteAPIDocumentVersion('semver', {\n namespace: 'namespace',\n slug: 'slug',\n});" }, { "lang": "Shell", @@ -2031,7 +2031,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.delete_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.delete_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\n\nprint(registry)" } ] } @@ -2146,7 +2146,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst listAPIDocumentVersionMetadata = await client.registry.listAPIDocumentVersionMetadata(\"semver\", {\n namespace: \"namespace\",\n slug: \"slug\",\n});\nconsole.log(listAPIDocumentVersionMetadata);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst listAPIDocumentVersionMetadata = await client.registry.listAPIDocumentVersionMetadata('semver', {\n namespace: 'namespace',\n slug: 'slug',\n});\n\nconsole.log(listAPIDocumentVersionMetadata);" }, { "lang": "Shell", @@ -2156,7 +2156,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.list_api_document_version_metadata(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.list_api_document_version_metadata(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\n\nprint(registry)" } ] } @@ -2292,7 +2292,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst createAPIDocumentVersion = await client.registry.createAPIDocumentVersion(\"slug\", {\n namespace: \"namespace\",\n version: \"x\",\n document: \"\",\n});\nconsole.log(createAPIDocumentVersion);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst createAPIDocumentVersion = await client.registry.createAPIDocumentVersion('slug', {\n namespace: 'namespace',\n version: 'x',\n document: '',\n});\n\nconsole.log(createAPIDocumentVersion);" }, { "lang": "Shell", @@ -2302,7 +2302,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.create_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n version=\"x\",\n document=\"\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.create_api_document_version(\n namespace=\"namespace\",\n slug=\"slug\",\n version=\"x\",\n document=\"\",\n)\n\nprint(registry)" } ] } @@ -2419,7 +2419,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.createAPIDocumentAccessGroup(\"slug\", {\n namespace: \"namespace\",\n accessGroupSlug: \"xxx\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.createAPIDocumentAccessGroup('slug', {\n namespace: 'namespace',\n accessGroupSlug: 'xxx',\n});" }, { "lang": "Shell", @@ -2429,7 +2429,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.create_api_document_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.create_api_document_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\n\nprint(registry)" } ] }, @@ -2544,7 +2544,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.deleteAPIDocumentAccessGroup(\"slug\", {\n namespace: \"namespace\",\n accessGroupSlug: \"xxx\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.registry.deleteAPIDocumentAccessGroup('slug', {\n namespace: 'namespace',\n accessGroupSlug: 'xxx',\n});" }, { "lang": "Shell", @@ -2554,7 +2554,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.delete_api_document_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\nprint(registry)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nregistry = client.registry.delete_api_document_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\n\nprint(registry)" } ] } @@ -2656,7 +2656,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.schemas.list(\"namespace\");\nconsole.log(list);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.schemas.list('namespace');\n\nconsole.log(list);" }, { "lang": "Shell", @@ -2666,7 +2666,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.list(\n namespace=\"namespace\",\n)\nprint(schema)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.list(\n namespace=\"namespace\",\n)\n\nprint(schema)" } ] }, @@ -2800,7 +2800,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst create = await client.schemas.create(\"namespace\", {\n title: \"\",\n version: \"x\",\n slug: \"\",\n document: \"\",\n});\nconsole.log(create);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst create = await client.schemas.create('namespace', {\n title: '',\n version: 'x',\n slug: '',\n document: '',\n});\n\nconsole.log(create);" }, { "lang": "Shell", @@ -2810,7 +2810,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.create(\n namespace=\"namespace\",\n title=\"\",\n version=\"x\",\n slug=\"\",\n document=\"\",\n)\nprint(schema)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.create(\n namespace=\"namespace\",\n title=\"\",\n version=\"x\",\n slug=\"\",\n document=\"\",\n)\n\nprint(schema)" } ] } @@ -2939,7 +2939,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.update(\"slug\", {\n namespace: \"namespace\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.update('slug', {\n namespace: 'namespace',\n});" }, { "lang": "Shell", @@ -2949,7 +2949,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.update(\n namespace=\"namespace\",\n slug=\"slug\",\n)\nprint(schema)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.update(\n namespace=\"namespace\",\n slug=\"slug\",\n)\n\nprint(schema)" } ] }, @@ -3054,7 +3054,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.delete(\"slug\", {\n namespace: \"namespace\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.delete('slug', {\n namespace: 'namespace',\n});" }, { "lang": "Shell", @@ -3064,7 +3064,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.delete(\n namespace=\"namespace\",\n slug=\"slug\",\n)\nprint(schema)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nschema = client.schemas.delete(\n namespace=\"namespace\",\n slug=\"slug\",\n)\n\nprint(schema)" } ] } @@ -3179,7 +3179,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.schemas.version.retrieveSchema(\"semver\", {\n namespace: \"namespace\",\n slug: \"slug\",\n});\nconsole.log(string_);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.schemas.version.retrieveSchema('semver', {\n namespace: 'namespace',\n slug: 'slug',\n});\n\nconsole.log(string_);" }, { "lang": "Shell", @@ -3189,7 +3189,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nversion = client.schemas.version.retrieve_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\nprint(version)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nversion = client.schemas.version.retrieve_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\n\nprint(version)" } ] }, @@ -3302,7 +3302,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.version.deleteSchema(\"semver\", {\n namespace: \"namespace\",\n slug: \"slug\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.version.deleteSchema('semver', {\n namespace: 'namespace',\n slug: 'slug',\n});" }, { "lang": "Shell", @@ -3312,7 +3312,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nversion = client.schemas.version.delete_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\nprint(version)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nversion = client.schemas.version.delete_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n semver=\"semver\",\n)\n\nprint(version)" } ] } @@ -3442,7 +3442,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst createSchema = await client.schemas.version.createSchema(\"slug\", {\n namespace: \"namespace\",\n version: \"x\",\n document: \"\",\n});\nconsole.log(createSchema);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst createSchema = await client.schemas.version.createSchema('slug', {\n namespace: 'namespace',\n version: 'x',\n document: '',\n});\n\nconsole.log(createSchema);" }, { "lang": "Shell", @@ -3452,7 +3452,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nversion = client.schemas.version.create_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n version=\"x\",\n document=\"\",\n)\nprint(version)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nversion = client.schemas.version.create_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n version=\"x\",\n document=\"\",\n)\n\nprint(version)" } ] } @@ -3569,7 +3569,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.accessGroup.createSchema(\"slug\", {\n namespace: \"namespace\",\n accessGroupSlug: \"xxx\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.accessGroup.createSchema('slug', {\n namespace: 'namespace',\n accessGroupSlug: 'xxx',\n});" }, { "lang": "Shell", @@ -3579,7 +3579,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\naccess_group = client.schemas.access_group.create_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\nprint(access_group)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\naccess_group = client.schemas.access_group.create_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\n\nprint(access_group)" } ] }, @@ -3694,7 +3694,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.accessGroup.deleteSchema(\"slug\", {\n namespace: \"namespace\",\n accessGroupSlug: \"xxx\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.schemas.accessGroup.deleteSchema('slug', {\n namespace: 'namespace',\n accessGroupSlug: 'xxx',\n});" }, { "lang": "Shell", @@ -3704,7 +3704,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\naccess_group = client.schemas.access_group.delete_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\nprint(access_group)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\naccess_group = client.schemas.access_group.delete_schema(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\n\nprint(access_group)" } ] } @@ -3828,7 +3828,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst retrieve = await client.loginPortals.retrieve(\"slug\");\nconsole.log(retrieve);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst retrieve = await client.loginPortals.retrieve('slug');\n\nconsole.log(retrieve);" }, { "lang": "Shell", @@ -3838,7 +3838,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.retrieve(\n slug=\"slug\",\n)\nprint(login_portal)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.retrieve(\n slug=\"slug\",\n)\n\nprint(login_portal)" } ] }, @@ -3951,7 +3951,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.loginPortals.update(\"slug\", {});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.loginPortals.update('slug', {});" }, { "lang": "Shell", @@ -3961,7 +3961,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.update(\n slug=\"slug\",\n)\nprint(login_portal)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.update(\n slug=\"slug\",\n)\n\nprint(login_portal)" } ] }, @@ -4058,7 +4058,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.loginPortals.delete(\"slug\");" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.loginPortals.delete('slug');" }, { "lang": "Shell", @@ -4068,7 +4068,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.delete(\n slug=\"slug\",\n)\nprint(login_portal)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.delete(\n slug=\"slug\",\n)\n\nprint(login_portal)" } ] } @@ -4188,7 +4188,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst create = await client.loginPortals.create({\n title: \"\",\n slug: \"\",\n email: {\n logo: \"\",\n logoSize: \"100\",\n buttonText: \"Login\",\n message: \"Click to access private documentation hosted by scalar.com\",\n title: \"Private Docs\",\n mainColor: \"#2a2f45\",\n mainBackground: \"#f6f6f6\",\n cardColor: \"2a2f45\",\n cardBackground: \"#fff\",\n buttonColor: \"#fff\",\n buttonBackground: \"#0f0f0f\",\n },\n page: {\n title: \"Scalar Private Docs\",\n description: \"Login to access your documentation\",\n head: \"\",\n script: \"\",\n theme: \"\",\n companyName: \"\",\n logo: \"\",\n logoURL: \"\",\n favicon: \"\",\n termsLink: \"\",\n privacyLink: \"\",\n formTitle: \"Scalar Private Docs\",\n formDescription: \"Login to access your documentation\",\n formImage: \"\",\n },\n});\nconsole.log(create);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst create = await client.loginPortals.create({\n title: '',\n slug: '',\n email: {\n logo: '',\n logoSize: '100',\n buttonText: 'Login',\n message: 'Click to access private documentation hosted by scalar.com',\n title: 'Private Docs',\n mainColor: '#2a2f45',\n mainBackground: '#f6f6f6',\n cardColor: '2a2f45',\n cardBackground: '#fff',\n buttonColor: '#fff',\n buttonBackground: '#0f0f0f',\n },\n page: {\n title: 'Scalar Private Docs',\n description: 'Login to access your documentation',\n head: '',\n script: '',\n theme: '',\n companyName: '',\n logo: '',\n logoURL: '',\n favicon: '',\n termsLink: '',\n privacyLink: '',\n formTitle: 'Scalar Private Docs',\n formDescription: 'Login to access your documentation',\n formImage: '',\n },\n});\n\nconsole.log(create);" }, { "lang": "Shell", @@ -4198,7 +4198,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.create(\n title=\"\",\n slug=\"\",\n email={\"logo\": \"\", \"logo_size\": \"100\", \"button_text\": \"Login\", \"message\": \"Click to access private documentation hosted by scalar.com\", \"title\": \"Private Docs\", \"main_color\": \"#2a2f45\", \"main_background\": \"#f6f6f6\", \"card_color\": \"2a2f45\", \"card_background\": \"#fff\", \"button_color\": \"#fff\", \"button_background\": \"#0f0f0f\"},\n page={\"title\": \"Scalar Private Docs\", \"description\": \"Login to access your documentation\", \"head\": \"\", \"script\": \"\", \"theme\": \"\", \"company_name\": \"\", \"logo\": \"\", \"logo_url\": \"\", \"favicon\": \"\", \"terms_link\": \"\", \"privacy_link\": \"\", \"form_title\": \"Scalar Private Docs\", \"form_description\": \"Login to access your documentation\", \"form_image\": \"\"},\n)\nprint(login_portal)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.create(\n title=\"\",\n slug=\"\",\n email={\n \"logo\": \"\",\n \"logo_size\": \"100\",\n \"button_text\": \"Login\",\n \"message\": \"Click to access private documentation hosted by scalar.com\",\n \"title\": \"Private Docs\",\n \"main_color\": \"#2a2f45\",\n \"main_background\": \"#f6f6f6\",\n \"card_color\": \"2a2f45\",\n \"card_background\": \"#fff\",\n \"button_color\": \"#fff\",\n \"button_background\": \"#0f0f0f\",\n },\n page={\n \"title\": \"Scalar Private Docs\",\n \"description\": \"Login to access your documentation\",\n \"head\": \"\",\n \"script\": \"\",\n \"theme\": \"\",\n \"company_name\": \"\",\n \"logo\": \"\",\n \"logo_url\": \"\",\n \"favicon\": \"\",\n \"terms_link\": \"\",\n \"privacy_link\": \"\",\n \"form_title\": \"Scalar Private Docs\",\n \"form_description\": \"Login to access your documentation\",\n \"form_image\": \"\",\n },\n)\n\nprint(login_portal)" } ] }, @@ -4288,7 +4288,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.loginPortals.list();\nconsole.log(list);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.loginPortals.list();\n\nconsole.log(list);" }, { "lang": "Shell", @@ -4298,7 +4298,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.list()\nprint(login_portal)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nlogin_portal = client.login_portals.list()\n\nprint(login_portal)" } ] } @@ -4400,7 +4400,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst listRulesets = await client.rules.listRulesets(\"namespace\");\nconsole.log(listRulesets);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst listRulesets = await client.rules.listRulesets('namespace');\n\nconsole.log(listRulesets);" }, { "lang": "Shell", @@ -4410,7 +4410,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.list_rulesets(\n namespace=\"namespace\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.list_rulesets(\n namespace=\"namespace\",\n)\n\nprint(rule)" } ] }, @@ -4540,7 +4540,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst createRuleset = await client.rules.createRuleset(\"namespace\", {\n title: \"\",\n slug: \"\",\n document: \"\",\n});\nconsole.log(createRuleset);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst createRuleset = await client.rules.createRuleset('namespace', {\n title: '',\n slug: '',\n document: '',\n});\n\nconsole.log(createRuleset);" }, { "lang": "Shell", @@ -4550,7 +4550,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.create_ruleset(\n namespace=\"namespace\",\n title=\"\",\n slug=\"\",\n document=\"\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.create_ruleset(\n namespace=\"namespace\",\n title=\"\",\n slug=\"\",\n document=\"\",\n)\n\nprint(rule)" } ] } @@ -4685,7 +4685,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.updateRuleset(\"slug\", {\n namespace: \"namespace\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.updateRuleset('slug', {\n namespace: 'namespace',\n});" }, { "lang": "Shell", @@ -4695,7 +4695,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.update_ruleset(\n path_namespace=\"namespace\",\n path_slug=\"slug\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.update_ruleset(\n path_namespace=\"namespace\",\n path_slug=\"slug\",\n)\n\nprint(rule)" } ] }, @@ -4800,7 +4800,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.deleteRuleset(\"slug\", {\n namespace: \"namespace\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.deleteRuleset('slug', {\n namespace: 'namespace',\n});" }, { "lang": "Shell", @@ -4810,7 +4810,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.delete_ruleset(\n namespace=\"namespace\",\n slug=\"slug\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.delete_ruleset(\n namespace=\"namespace\",\n slug=\"slug\",\n)\n\nprint(rule)" } ] }, @@ -4915,7 +4915,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.rules.retrieveRulesetDocument(\"slug\", {\n namespace: \"namespace\",\n});\nconsole.log(string_);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.rules.retrieveRulesetDocument('slug', {\n namespace: 'namespace',\n});\n\nconsole.log(string_);" }, { "lang": "Shell", @@ -4925,7 +4925,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.retrieve_ruleset_document(\n namespace=\"namespace\",\n slug=\"slug\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.retrieve_ruleset_document(\n namespace=\"namespace\",\n slug=\"slug\",\n)\n\nprint(rule)" } ] } @@ -5042,7 +5042,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.createRulesetAccessGroup(\"slug\", {\n namespace: \"namespace\",\n accessGroupSlug: \"xxx\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.createRulesetAccessGroup('slug', {\n namespace: 'namespace',\n accessGroupSlug: 'xxx',\n});" }, { "lang": "Shell", @@ -5052,7 +5052,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.create_ruleset_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.create_ruleset_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\n\nprint(rule)" } ] }, @@ -5167,7 +5167,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.deleteRulesetAccessGroup(\"slug\", {\n namespace: \"namespace\",\n accessGroupSlug: \"xxx\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.rules.deleteRulesetAccessGroup('slug', {\n namespace: 'namespace',\n accessGroupSlug: 'xxx',\n});" }, { "lang": "Shell", @@ -5177,7 +5177,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.delete_ruleset_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\nprint(rule)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nrule = client.rules.delete_ruleset_access_group(\n namespace=\"namespace\",\n slug=\"slug\",\n access_group_slug=\"xxx\",\n)\n\nprint(rule)" } ] } @@ -5269,7 +5269,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.themes.list();\nconsole.log(list);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.themes.list();\n\nconsole.log(list);" }, { "lang": "Shell", @@ -5279,7 +5279,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.list()\nprint(theme)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.list()\n\nprint(theme)" } ] }, @@ -5396,7 +5396,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst create = await client.themes.create({\n name: \"\",\n slug: \"\",\n document: \"\",\n});\nconsole.log(create);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst create = await client.themes.create({\n name: '',\n slug: '',\n document: '',\n});\n\nconsole.log(create);" }, { "lang": "Shell", @@ -5406,7 +5406,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.create(\n name=\"\",\n slug=\"\",\n document=\"\",\n)\nprint(theme)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.create(\n name=\"\",\n slug=\"\",\n document=\"\",\n)\n\nprint(theme)" } ] } @@ -5524,7 +5524,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.themes.update(\"slug\", {});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.themes.update('slug', {});" }, { "lang": "Shell", @@ -5534,7 +5534,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.update(\n slug=\"slug\",\n)\nprint(theme)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.update(\n slug=\"slug\",\n)\n\nprint(theme)" } ] }, @@ -5650,7 +5650,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.themes.replaceDocument(\"slug\", {\n document: \"\",\n});" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.themes.replaceDocument('slug', {\n document: '',\n});" }, { "lang": "Shell", @@ -5660,7 +5660,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.replace_document(\n slug=\"slug\",\n document=\"\",\n)\nprint(theme)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.replace_document(\n slug=\"slug\",\n document=\"\",\n)\n\nprint(theme)" } ] }, @@ -5757,7 +5757,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nawait client.themes.delete(\"slug\");" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nawait client.themes.delete('slug');" }, { "lang": "Shell", @@ -5767,7 +5767,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.delete(\n slug=\"slug\",\n)\nprint(theme)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.delete(\n slug=\"slug\",\n)\n\nprint(theme)" } ] }, @@ -5864,7 +5864,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.themes.retrieve(\"slug\");\nconsole.log(string_);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst string_ = await client.themes.retrieve('slug');\n\nconsole.log(string_);" }, { "lang": "Shell", @@ -5874,7 +5874,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.retrieve(\n slug=\"slug\",\n)\nprint(theme)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\ntheme = client.themes.retrieve(\n slug=\"slug\",\n)\n\nprint(theme)" } ] } @@ -5966,7 +5966,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.teams.list();\nconsole.log(list);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.teams.list();\n\nconsole.log(list);" }, { "lang": "Shell", @@ -5976,7 +5976,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nteam = client.teams.list()\nprint(team)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nteam = client.teams.list()\n\nprint(team)" } ] } @@ -6068,7 +6068,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst listGuides = await client.scalarDocs.listGuides();\nconsole.log(listGuides);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst listGuides = await client.scalarDocs.listGuides();\n\nconsole.log(listGuides);" }, { "lang": "Shell", @@ -6078,7 +6078,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nscalar_doc = client.scalar_docs.list_guides()\nprint(scalar_doc)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nscalar_doc = client.scalar_docs.list_guides()\n\nprint(scalar_doc)" } ] }, @@ -6221,7 +6221,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst createGuide = await client.scalarDocs.createGuide({\n name: \"\",\n isPrivate: false,\n allowedUsers: [],\n allowedDomains: [],\n});\nconsole.log(createGuide);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst createGuide = await client.scalarDocs.createGuide({\n name: '',\n isPrivate: false,\n allowedUsers: [],\n allowedDomains: [],\n});\n\nconsole.log(createGuide);" }, { "lang": "Shell", @@ -6231,7 +6231,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nscalar_doc = client.scalar_docs.create_guide(\n name=\"\",\n is_private=False,\n allowed_users=[],\n allowed_domains=[],\n)\nprint(scalar_doc)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nscalar_doc = client.scalar_docs.create_guide(\n name=\"\",\n is_private=False,\n allowed_users=[],\n allowed_domains=[],\n)\n\nprint(scalar_doc)" } ] } @@ -6339,7 +6339,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst publishGuide = await client.scalarDocs.publishGuide(\"slug\");\nconsole.log(publishGuide);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst publishGuide = await client.scalarDocs.publishGuide('slug');\n\nconsole.log(publishGuide);" }, { "lang": "Shell", @@ -6349,7 +6349,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nscalar_doc = client.scalar_docs.publish_guide(\n slug=\"slug\",\n)\nprint(scalar_doc)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nscalar_doc = client.scalar_docs.publish_guide(\n slug=\"slug\",\n)\n\nprint(scalar_doc)" } ] } @@ -6441,7 +6441,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.namespaces.list();\nconsole.log(list);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst list = await client.namespaces.list();\n\nconsole.log(list);" }, { "lang": "Shell", @@ -6451,7 +6451,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nnamespace = client.namespaces.list()\nprint(namespace)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nnamespace = client.namespaces.list()\n\nprint(namespace)" } ] } @@ -6569,7 +6569,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst exchangePersonalToken = await client.authentication.exchangePersonalToken({\n personalToken: \"\",\n});\nconsole.log(exchangePersonalToken);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst exchangePersonalToken = await client.authentication.exchangePersonalToken({\n personalToken: '',\n});\n\nconsole.log(exchangePersonalToken);" }, { "lang": "Shell", @@ -6579,7 +6579,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nauthentication = client.authentication.exchange_personal_token(\n personal_token=\"\",\n)\nprint(authentication)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nauthentication = client.authentication.exchange_personal_token(\n personal_token=\"\",\n)\n\nprint(authentication)" } ] } @@ -6668,7 +6668,7 @@ { "lang": "TypeScript", "label": "TypeScript", - "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n});\n\nconst listCurrentUser = await client.authentication.listCurrentUser();\nconsole.log(listCurrentUser);" + "source": "import Scalar from '@scalar/sdk';\n\nconst client = new Scalar({\n bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var\n});\n\nconst listCurrentUser = await client.authentication.listCurrentUser();\n\nconsole.log(listCurrentUser);" }, { "lang": "Shell", @@ -6678,7 +6678,7 @@ { "lang": "Python", "label": "Python", - "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nauthentication = client.authentication.list_current_user()\nprint(authentication)" + "source": "import os\n\nfrom scalar_sdk import Scalar\n\nclient = Scalar(\n bearer_auth=os.environ.get(\"BEARER_AUTH\"),\n)\n\nauthentication = client.authentication.list_current_user()\n\nprint(authentication)" } ] } diff --git a/pyproject.toml b/pyproject.toml index ea30d41..a55221d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "scalar-sdk" -version = "0.3.2" # x-release-please-version +version = "0.3.3" # x-release-please-version description = "API for managing Scalar platform resources." readme = "README.md" license = "Apache-2.0" @@ -26,3 +26,6 @@ packages = ["src"] [tool.hatch.build.targets.wheel.sources] "src" = "scalar_sdk" + +[tool.ruff] +line-length = 120 diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index ba89530..04343bf 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -1,7 +1,7 @@ { "name": "ScalarApi", "slug": "scalarApi", - "generatorVersion": "0.20.1", + "generatorVersion": "0.23.1", "servers": [ "https://access.scalar.com" ], diff --git a/src/_base_client.py b/src/_base_client.py index c2a36e7..b19da69 100644 --- a/src/_base_client.py +++ b/src/_base_client.py @@ -505,7 +505,7 @@ def _build_headers( retries_taken: int = 0, ) -> httpx.Headers: custom_headers = options.headers or {} - # Auth headers are folded into `default_headers` (matching Stainless), so + # Auth headers are folded into `default_headers` (matching the reference SDKs), so # merging `default_headers` here already applies the configured credentials. headers_dict = _merge_mappings(self.default_headers, custom_headers) self._validate_headers(headers_dict, custom_headers, params, cookies) @@ -1831,9 +1831,7 @@ def _request_api_list( options: FinalRequestOptions, cursor_config: Optional[CursorPageConfig] = None, ) -> AsyncPaginator[_T, AsyncPageT]: - return AsyncPaginator( - client=self, options=options, page_cls=page, model=model, cursor_config=cursor_config - ) + return AsyncPaginator(client=self, options=options, page_cls=page, model=model, cursor_config=cursor_config) @overload async def get( diff --git a/src/_client.py b/src/_client.py index 9d441f3..875c3d2 100644 --- a/src/_client.py +++ b/src/_client.py @@ -33,7 +33,17 @@ from ._version import __version__ if TYPE_CHECKING: - from .resources import registry, schemas, login_portals, rules, themes, teams, scalar_docs, namespaces, authentication + from .resources import ( + registry, + schemas, + login_portals, + rules, + themes, + teams, + scalar_docs, + namespaces, + authentication, + ) from .resources.registry import RegistryResource, AsyncRegistryResource from .resources.schemas import SchemasResource, AsyncSchemasResource from .resources.login_portals import LoginPortalsResource, AsyncLoginPortalsResource @@ -192,14 +202,12 @@ def auth_headers(self) -> dict[str, str]: @override def _auth_query(self, security: dict[str, bool]) -> dict[str, str]: _ = security - return { - } + return {} @override def _auth_cookies(self, security: dict[str, bool]) -> dict[str, str]: _ = security - return { - } + return {} @property def _bearer_auth_header_auth(self) -> dict[str, str]: @@ -208,7 +216,6 @@ def _bearer_auth_header_auth(self) -> dict[str, str]: return {} return {"Authorization": f"Bearer {value}"} - @property @override def default_headers(self) -> dict[str, str | Omit]: @@ -232,7 +239,6 @@ def _validate_headers( return raise TypeError("Could not resolve authentication method. Expected Authorization to be set.") - def copy( self, *, @@ -439,14 +445,12 @@ def auth_headers(self) -> dict[str, str]: @override def _auth_query(self, security: dict[str, bool]) -> dict[str, str]: _ = security - return { - } + return {} @override def _auth_cookies(self, security: dict[str, bool]) -> dict[str, str]: _ = security - return { - } + return {} @property def _bearer_auth_header_auth(self) -> dict[str, str]: @@ -455,7 +459,6 @@ def _bearer_auth_header_auth(self) -> dict[str, str]: return {} return {"Authorization": f"Bearer {value}"} - @property @override def default_headers(self) -> dict[str, str | Omit]: @@ -479,7 +482,6 @@ def _validate_headers( return raise TypeError("Could not resolve authentication method. Expected Authorization to be set.") - def copy( self, *, diff --git a/src/_version.py b/src/_version.py index e35bf83..b6bb03e 100644 --- a/src/_version.py +++ b/src/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Scalar. See README.md for details. __title__ = "scalarApi" -__version__ = "0.3.2" # x-release-please-version +__version__ = "0.3.3" # x-release-please-version diff --git a/src/resources/authentication.py b/src/resources/authentication.py index 5ef3e15..83de647 100644 --- a/src/resources/authentication.py +++ b/src/resources/authentication.py @@ -23,7 +23,6 @@ class AuthenticationResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> AuthenticationResourceWithRawResponse: return AuthenticationResourceWithRawResponse(self) @@ -45,17 +44,17 @@ def exchange_personal_token( ) -> AuthenticationExchangePersonalTokenResponse: """ Exchange an API key for an access token. - + Args: personal_token: Body parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AuthenticationExchangePersonalTokenResponse: Default Response - + Example: ```python authentication = client.authentication.exchange_personal_token( @@ -66,10 +65,12 @@ def exchange_personal_token( return self._post( "/v1/auth/exchange", body=maybe_transform( - {"personal_token": personal_token}, - authentication_exchange_personal_token_params.AuthenticationExchangePersonalTokenParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"personal_token": personal_token}, + authentication_exchange_personal_token_params.AuthenticationExchangePersonalTokenParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AuthenticationExchangePersonalTokenResponse, ) @@ -85,16 +86,16 @@ def list_current_user( ) -> AuthenticationListCurrentUserResponse: """ Get the authenticated user, including their available teams and theme. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AuthenticationListCurrentUserResponse: Default Response - + Example: ```python authentication = client.authentication.list_current_user() @@ -102,13 +103,14 @@ def list_current_user( """ return self._get( "/v1/auth/me", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AuthenticationListCurrentUserResponse, ) class AsyncAuthenticationResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncAuthenticationResourceWithRawResponse: return AsyncAuthenticationResourceWithRawResponse(self) @@ -130,17 +132,17 @@ async def exchange_personal_token( ) -> AuthenticationExchangePersonalTokenResponse: """ Exchange an API key for an access token. - + Args: personal_token: Body parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AuthenticationExchangePersonalTokenResponse: Default Response - + Example: ```python authentication = await client.authentication.exchange_personal_token( @@ -151,10 +153,12 @@ async def exchange_personal_token( return await self._post( "/v1/auth/exchange", body=await async_maybe_transform( - {"personal_token": personal_token}, - authentication_exchange_personal_token_params.AuthenticationExchangePersonalTokenParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"personal_token": personal_token}, + authentication_exchange_personal_token_params.AuthenticationExchangePersonalTokenParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AuthenticationExchangePersonalTokenResponse, ) @@ -170,16 +174,16 @@ async def list_current_user( ) -> AuthenticationListCurrentUserResponse: """ Get the authenticated user, including their available teams and theme. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AuthenticationListCurrentUserResponse: Default Response - + Example: ```python authentication = await client.authentication.list_current_user() @@ -187,7 +191,9 @@ async def list_current_user( """ return await self._get( "/v1/auth/me", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AuthenticationListCurrentUserResponse, ) diff --git a/src/resources/login_portals.py b/src/resources/login_portals.py index 0c327a7..41aec67 100644 --- a/src/resources/login_portals.py +++ b/src/resources/login_portals.py @@ -28,7 +28,6 @@ class LoginPortalsResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> LoginPortalsResourceWithRawResponse: return LoginPortalsResourceWithRawResponse(self) @@ -50,17 +49,17 @@ def retrieve( ) -> LoginPortalRetrieveResponse: """ Get a login portal by slug. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalRetrieveResponse: Default Response - + Example: ```python login_portal = client.login_portals.retrieve( @@ -72,7 +71,9 @@ def retrieve( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._get( path_template("/v1/login-portals/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalRetrieveResponse, ) @@ -90,7 +91,7 @@ def update( ) -> LoginPortalUpdateResponse: """ Update metadata for a login portal. - + Args: slug: Path parameter. title: Body parameter. @@ -98,10 +99,10 @@ def update( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalUpdateResponse: Default Response - + Example: ```python login_portal = client.login_portals.update( @@ -114,10 +115,12 @@ def update( return self._patch( path_template("/v1/login-portals/{slug}", **{"slug": slug}), body=maybe_transform( - {"title": title}, - login_portal_update_params.LoginPortalUpdateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"title": title}, + login_portal_update_params.LoginPortalUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalUpdateResponse, ) @@ -134,17 +137,17 @@ def delete( ) -> LoginPortalDeleteResponse: """ Delete a login portal. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalDeleteResponse: Default Response - + Example: ```python login_portal = client.login_portals.delete( @@ -156,7 +159,9 @@ def delete( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._delete( path_template("/v1/login-portals/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalDeleteResponse, ) @@ -176,7 +181,7 @@ def create( ) -> LoginPortalCreateResponse: """ Create a login portal for the current team. - + Args: title: Body parameter. slug: Body parameter. @@ -186,32 +191,61 @@ def create( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalCreateResponse: Default Response - + Example: ```python login_portal = client.login_portals.create( title="", slug="", - email={"logo": "", "logo_size": "100", "button_text": "Login", "message": "Click to access private documentation hosted by scalar.com", "title": "Private Docs", "main_color": "#2a2f45", "main_background": "#f6f6f6", "card_color": "2a2f45", "card_background": "#fff", "button_color": "#fff", "button_background": "#0f0f0f"}, - page={"title": "Scalar Private Docs", "description": "Login to access your documentation", "head": "", "script": "", "theme": "", "company_name": "", "logo": "", "logo_url": "", "favicon": "", "terms_link": "", "privacy_link": "", "form_title": "Scalar Private Docs", "form_description": "Login to access your documentation", "form_image": ""}, + email={ + "logo": "", + "logo_size": "100", + "button_text": "Login", + "message": "Click to access private documentation hosted by scalar.com", + "title": "Private Docs", + "main_color": "#2a2f45", + "main_background": "#f6f6f6", + "card_color": "2a2f45", + "card_background": "#fff", + "button_color": "#fff", + "button_background": "#0f0f0f", + }, + page={ + "title": "Scalar Private Docs", + "description": "Login to access your documentation", + "head": "", + "script": "", + "theme": "", + "company_name": "", + "logo": "", + "logo_url": "", + "favicon": "", + "terms_link": "", + "privacy_link": "", + "form_title": "Scalar Private Docs", + "form_description": "Login to access your documentation", + "form_image": "", + }, ) ``` """ return self._post( "/v1/login-portals", body=maybe_transform( - { - "title": title, - "slug": slug, - "email": email, - "page": page, - }, - login_portal_create_params.LoginPortalCreateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "slug": slug, + "email": email, + "page": page, + }, + login_portal_create_params.LoginPortalCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalCreateResponse, ) @@ -227,16 +261,16 @@ def list( ) -> LoginPortalListResponse: """ List all login portals for the current team. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalListResponse: Default Response - + Example: ```python login_portal = client.login_portals.list() @@ -244,13 +278,14 @@ def list( """ return self._get( "/v1/login-portals", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalListResponse, ) class AsyncLoginPortalsResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncLoginPortalsResourceWithRawResponse: return AsyncLoginPortalsResourceWithRawResponse(self) @@ -272,17 +307,17 @@ async def retrieve( ) -> LoginPortalRetrieveResponse: """ Get a login portal by slug. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalRetrieveResponse: Default Response - + Example: ```python login_portal = await client.login_portals.retrieve( @@ -294,7 +329,9 @@ async def retrieve( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._get( path_template("/v1/login-portals/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalRetrieveResponse, ) @@ -312,7 +349,7 @@ async def update( ) -> LoginPortalUpdateResponse: """ Update metadata for a login portal. - + Args: slug: Path parameter. title: Body parameter. @@ -320,10 +357,10 @@ async def update( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalUpdateResponse: Default Response - + Example: ```python login_portal = await client.login_portals.update( @@ -336,10 +373,12 @@ async def update( return await self._patch( path_template("/v1/login-portals/{slug}", **{"slug": slug}), body=await async_maybe_transform( - {"title": title}, - login_portal_update_params.LoginPortalUpdateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"title": title}, + login_portal_update_params.LoginPortalUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalUpdateResponse, ) @@ -356,17 +395,17 @@ async def delete( ) -> LoginPortalDeleteResponse: """ Delete a login portal. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalDeleteResponse: Default Response - + Example: ```python login_portal = await client.login_portals.delete( @@ -378,7 +417,9 @@ async def delete( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._delete( path_template("/v1/login-portals/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalDeleteResponse, ) @@ -398,7 +439,7 @@ async def create( ) -> LoginPortalCreateResponse: """ Create a login portal for the current team. - + Args: title: Body parameter. slug: Body parameter. @@ -408,32 +449,61 @@ async def create( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalCreateResponse: Default Response - + Example: ```python login_portal = await client.login_portals.create( title="", slug="", - email={"logo": "", "logo_size": "100", "button_text": "Login", "message": "Click to access private documentation hosted by scalar.com", "title": "Private Docs", "main_color": "#2a2f45", "main_background": "#f6f6f6", "card_color": "2a2f45", "card_background": "#fff", "button_color": "#fff", "button_background": "#0f0f0f"}, - page={"title": "Scalar Private Docs", "description": "Login to access your documentation", "head": "", "script": "", "theme": "", "company_name": "", "logo": "", "logo_url": "", "favicon": "", "terms_link": "", "privacy_link": "", "form_title": "Scalar Private Docs", "form_description": "Login to access your documentation", "form_image": ""}, + email={ + "logo": "", + "logo_size": "100", + "button_text": "Login", + "message": "Click to access private documentation hosted by scalar.com", + "title": "Private Docs", + "main_color": "#2a2f45", + "main_background": "#f6f6f6", + "card_color": "2a2f45", + "card_background": "#fff", + "button_color": "#fff", + "button_background": "#0f0f0f", + }, + page={ + "title": "Scalar Private Docs", + "description": "Login to access your documentation", + "head": "", + "script": "", + "theme": "", + "company_name": "", + "logo": "", + "logo_url": "", + "favicon": "", + "terms_link": "", + "privacy_link": "", + "form_title": "Scalar Private Docs", + "form_description": "Login to access your documentation", + "form_image": "", + }, ) ``` """ return await self._post( "/v1/login-portals", body=await async_maybe_transform( - { - "title": title, - "slug": slug, - "email": email, - "page": page, - }, - login_portal_create_params.LoginPortalCreateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "slug": slug, + "email": email, + "page": page, + }, + login_portal_create_params.LoginPortalCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalCreateResponse, ) @@ -449,16 +519,16 @@ async def list( ) -> LoginPortalListResponse: """ List all login portals for the current team. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: LoginPortalListResponse: Default Response - + Example: ```python login_portal = await client.login_portals.list() @@ -466,7 +536,9 @@ async def list( """ return await self._get( "/v1/login-portals", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=LoginPortalListResponse, ) diff --git a/src/resources/namespaces.py b/src/resources/namespaces.py index 8b7a96e..a4cc1f4 100644 --- a/src/resources/namespaces.py +++ b/src/resources/namespaces.py @@ -20,7 +20,6 @@ class NamespacesResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> NamespacesResourceWithRawResponse: return NamespacesResourceWithRawResponse(self) @@ -41,16 +40,16 @@ def list( ) -> NamespaceListResponse: """ Get all namespaces for the current team - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: NamespaceListResponse: Default Response - + Example: ```python namespace = client.namespaces.list() @@ -58,13 +57,14 @@ def list( """ return self._get( "/v1/namespaces", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=NamespaceListResponse, ) class AsyncNamespacesResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncNamespacesResourceWithRawResponse: return AsyncNamespacesResourceWithRawResponse(self) @@ -85,16 +85,16 @@ async def list( ) -> NamespaceListResponse: """ Get all namespaces for the current team - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: NamespaceListResponse: Default Response - + Example: ```python namespace = await client.namespaces.list() @@ -102,7 +102,9 @@ async def list( """ return await self._get( "/v1/namespaces", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=NamespaceListResponse, ) diff --git a/src/resources/registry.py b/src/resources/registry.py index 788acd6..bde473a 100644 --- a/src/resources/registry.py +++ b/src/resources/registry.py @@ -19,7 +19,14 @@ from ..types.registry_list_api_documents_response import RegistryListAPIDocumentsResponse from ..types.registry_create_api_document_response import RegistryCreateAPIDocumentResponse from ..types.version import Version -from ..types import registry_create_api_document_params, registry_update_api_document_params, registry_update_api_document_version_params, registry_create_api_document_version_params, registry_create_api_document_access_group_params, registry_delete_api_document_access_group_params +from ..types import ( + registry_create_api_document_params, + registry_update_api_document_params, + registry_update_api_document_version_params, + registry_create_api_document_version_params, + registry_create_api_document_access_group_params, + registry_delete_api_document_access_group_params, +) from ..types.registry_update_api_document_response import RegistryUpdateAPIDocumentResponse from ..types.registry_delete_api_document_response import RegistryDeleteAPIDocumentResponse from ..types.registry_update_api_document_version_response import RegistryUpdateAPIDocumentVersionResponse @@ -34,7 +41,6 @@ class RegistryResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> RegistryResourceWithRawResponse: return RegistryResourceWithRawResponse(self) @@ -55,16 +61,16 @@ def list_all_api_documents( ) -> RegistryListAllAPIDocumentsResponse: """ List all API documents across every namespace the caller can access. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryListAllAPIDocumentsResponse: Default Response - + Example: ```python registry = client.registry.list_all_api_documents() @@ -72,7 +78,9 @@ def list_all_api_documents( """ return self._get( "/v1/apis", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryListAllAPIDocumentsResponse, ) @@ -89,17 +97,17 @@ def list_api_documents( ) -> RegistryListAPIDocumentsResponse: """ List API documents in a namespace. - + Args: namespace: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryListAPIDocumentsResponse: Default Response - + Example: ```python registry = client.registry.list_api_documents( @@ -111,7 +119,9 @@ def list_api_documents( raise ValueError(f"Expected a non-empty value for `namespace` but received {namespace!r}") return self._get( path_template("/v1/apis/{namespace}", **{"namespace": namespace}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryListAPIDocumentsResponse, ) @@ -135,7 +145,7 @@ def create_api_document( ) -> RegistryCreateAPIDocumentResponse: """ Create an API document. - + Args: namespace: Path parameter. title: Body parameter. @@ -149,10 +159,10 @@ def create_api_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryCreateAPIDocumentResponse: Default Response - + Example: ```python registry = client.registry.create_api_document( @@ -169,18 +179,20 @@ def create_api_document( return self._post( path_template("/v1/apis/{namespace}", **{"namespace": namespace}), body=maybe_transform( - { - "title": title, - "description": description, - "version": version, - "slug": slug, - "ruleset": ruleset, - "is_private": is_private, - "document": document, - }, - registry_create_api_document_params.RegistryCreateAPIDocumentParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "version": version, + "slug": slug, + "ruleset": ruleset, + "is_private": is_private, + "document": document, + }, + registry_create_api_document_params.RegistryCreateAPIDocumentParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryCreateAPIDocumentResponse, ) @@ -202,7 +214,7 @@ def update_api_document( ) -> RegistryUpdateAPIDocumentResponse: """ Update metadata for an API document. - + Args: slug: Path parameter. namespace: Path parameter. @@ -214,10 +226,10 @@ def update_api_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryUpdateAPIDocumentResponse: Default Response - + Example: ```python registry = client.registry.update_api_document( @@ -233,15 +245,17 @@ def update_api_document( return self._patch( path_template("/v1/apis/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - { - "title": title, - "description": description, - "is_private": is_private, - "ruleset": ruleset, - }, - registry_update_api_document_params.RegistryUpdateAPIDocumentParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "is_private": is_private, + "ruleset": ruleset, + }, + registry_update_api_document_params.RegistryUpdateAPIDocumentParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryUpdateAPIDocumentResponse, ) @@ -259,7 +273,7 @@ def delete_api_document( ) -> RegistryDeleteAPIDocumentResponse: """ Delete an API document and all versions. - + Args: slug: Path parameter. namespace: Path parameter. @@ -267,10 +281,10 @@ def delete_api_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryDeleteAPIDocumentResponse: Default Response - + Example: ```python registry = client.registry.delete_api_document( @@ -285,7 +299,9 @@ def delete_api_document( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._delete( path_template("/v1/apis/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryDeleteAPIDocumentResponse, ) @@ -304,7 +320,7 @@ def retrieve_api_document_version( ) -> str: """ Get a specific API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -313,10 +329,10 @@ def retrieve_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python registry = client.registry.retrieve_api_document_version( @@ -334,8 +350,13 @@ def retrieve_api_document_version( raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return self._get( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) @@ -356,7 +377,7 @@ def update_api_document_version( ) -> RegistryUpdateAPIDocumentVersionResponse: """ Update the registry file content for an API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -367,10 +388,10 @@ def update_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryUpdateAPIDocumentVersionResponse: Default Response - + Example: ```python registry = client.registry.update_api_document_version( @@ -388,15 +409,20 @@ def update_api_document_version( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return self._patch( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), body=maybe_transform( - { - "document": document, - "last_known_version_sha": last_known_version_sha, - }, - registry_update_api_document_version_params.RegistryUpdateAPIDocumentVersionParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "document": document, + "last_known_version_sha": last_known_version_sha, + }, + registry_update_api_document_version_params.RegistryUpdateAPIDocumentVersionParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryUpdateAPIDocumentVersionResponse, ) @@ -415,7 +441,7 @@ def delete_api_document_version( ) -> RegistryDeleteAPIDocumentVersionResponse: """ Delete a specific API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -424,10 +450,10 @@ def delete_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryDeleteAPIDocumentVersionResponse: Default Response - + Example: ```python registry = client.registry.delete_api_document_version( @@ -444,8 +470,13 @@ def delete_api_document_version( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return self._delete( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryDeleteAPIDocumentVersionResponse, ) @@ -464,7 +495,7 @@ def list_api_document_version_metadata( ) -> RegistryListAPIDocumentVersionMetadataResponse: """ Get metadata (uid, content shas, version sha, tags) for a specific API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -473,10 +504,10 @@ def list_api_document_version_metadata( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryListAPIDocumentVersionMetadataResponse: Default Response - + Example: ```python registry = client.registry.list_api_document_version_metadata( @@ -493,8 +524,13 @@ def list_api_document_version_metadata( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return self._get( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}/metadata", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryListAPIDocumentVersionMetadataResponse, ) @@ -516,7 +552,7 @@ def create_api_document_version( ) -> RegistryCreateAPIDocumentVersionResponse: """ Create a new API document version. - + Args: slug: Path parameter. namespace: Path parameter. @@ -528,10 +564,10 @@ def create_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryCreateAPIDocumentVersionResponse: Default Response - + Example: ```python registry = client.registry.create_api_document_version( @@ -549,15 +585,17 @@ def create_api_document_version( return self._post( path_template("/v1/apis/{namespace}/{slug}/version", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - { - "version": version, - "document": document, - "force": force, - "last_known_version_sha": last_known_version_sha, - }, - registry_create_api_document_version_params.RegistryCreateAPIDocumentVersionParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "version": version, + "document": document, + "force": force, + "last_known_version_sha": last_known_version_sha, + }, + registry_create_api_document_version_params.RegistryCreateAPIDocumentVersionParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryCreateAPIDocumentVersionResponse, ) @@ -576,7 +614,7 @@ def create_api_document_access_group( ) -> RegistryCreateAPIDocumentAccessGroupResponse: """ Add an access group to an API document. - + Args: slug: Path parameter. namespace: Path parameter. @@ -585,10 +623,10 @@ def create_api_document_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryCreateAPIDocumentAccessGroupResponse: Default Response - + Example: ```python registry = client.registry.create_api_document_access_group( @@ -605,10 +643,12 @@ def create_api_document_access_group( return self._post( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - {"access_group_slug": access_group_slug}, - registry_create_api_document_access_group_params.RegistryCreateAPIDocumentAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + registry_create_api_document_access_group_params.RegistryCreateAPIDocumentAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryCreateAPIDocumentAccessGroupResponse, ) @@ -627,7 +667,7 @@ def delete_api_document_access_group( ) -> RegistryDeleteAPIDocumentAccessGroupResponse: """ Remove an access group from an API document. - + Args: slug: Path parameter. namespace: Path parameter. @@ -636,10 +676,10 @@ def delete_api_document_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryDeleteAPIDocumentAccessGroupResponse: Default Response - + Example: ```python registry = client.registry.delete_api_document_access_group( @@ -656,16 +696,17 @@ def delete_api_document_access_group( return self._delete( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - {"access_group_slug": access_group_slug}, - registry_delete_api_document_access_group_params.RegistryDeleteAPIDocumentAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + registry_delete_api_document_access_group_params.RegistryDeleteAPIDocumentAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryDeleteAPIDocumentAccessGroupResponse, ) class AsyncRegistryResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncRegistryResourceWithRawResponse: return AsyncRegistryResourceWithRawResponse(self) @@ -686,16 +727,16 @@ async def list_all_api_documents( ) -> RegistryListAllAPIDocumentsResponse: """ List all API documents across every namespace the caller can access. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryListAllAPIDocumentsResponse: Default Response - + Example: ```python registry = await client.registry.list_all_api_documents() @@ -703,7 +744,9 @@ async def list_all_api_documents( """ return await self._get( "/v1/apis", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryListAllAPIDocumentsResponse, ) @@ -720,17 +763,17 @@ async def list_api_documents( ) -> RegistryListAPIDocumentsResponse: """ List API documents in a namespace. - + Args: namespace: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryListAPIDocumentsResponse: Default Response - + Example: ```python registry = await client.registry.list_api_documents( @@ -742,7 +785,9 @@ async def list_api_documents( raise ValueError(f"Expected a non-empty value for `namespace` but received {namespace!r}") return await self._get( path_template("/v1/apis/{namespace}", **{"namespace": namespace}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryListAPIDocumentsResponse, ) @@ -766,7 +811,7 @@ async def create_api_document( ) -> RegistryCreateAPIDocumentResponse: """ Create an API document. - + Args: namespace: Path parameter. title: Body parameter. @@ -780,10 +825,10 @@ async def create_api_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryCreateAPIDocumentResponse: Default Response - + Example: ```python registry = await client.registry.create_api_document( @@ -800,18 +845,20 @@ async def create_api_document( return await self._post( path_template("/v1/apis/{namespace}", **{"namespace": namespace}), body=await async_maybe_transform( - { - "title": title, - "description": description, - "version": version, - "slug": slug, - "ruleset": ruleset, - "is_private": is_private, - "document": document, - }, - registry_create_api_document_params.RegistryCreateAPIDocumentParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "version": version, + "slug": slug, + "ruleset": ruleset, + "is_private": is_private, + "document": document, + }, + registry_create_api_document_params.RegistryCreateAPIDocumentParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryCreateAPIDocumentResponse, ) @@ -833,7 +880,7 @@ async def update_api_document( ) -> RegistryUpdateAPIDocumentResponse: """ Update metadata for an API document. - + Args: slug: Path parameter. namespace: Path parameter. @@ -845,10 +892,10 @@ async def update_api_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryUpdateAPIDocumentResponse: Default Response - + Example: ```python registry = await client.registry.update_api_document( @@ -864,15 +911,17 @@ async def update_api_document( return await self._patch( path_template("/v1/apis/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - { - "title": title, - "description": description, - "is_private": is_private, - "ruleset": ruleset, - }, - registry_update_api_document_params.RegistryUpdateAPIDocumentParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "is_private": is_private, + "ruleset": ruleset, + }, + registry_update_api_document_params.RegistryUpdateAPIDocumentParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryUpdateAPIDocumentResponse, ) @@ -890,7 +939,7 @@ async def delete_api_document( ) -> RegistryDeleteAPIDocumentResponse: """ Delete an API document and all versions. - + Args: slug: Path parameter. namespace: Path parameter. @@ -898,10 +947,10 @@ async def delete_api_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryDeleteAPIDocumentResponse: Default Response - + Example: ```python registry = await client.registry.delete_api_document( @@ -916,7 +965,9 @@ async def delete_api_document( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._delete( path_template("/v1/apis/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryDeleteAPIDocumentResponse, ) @@ -935,7 +986,7 @@ async def retrieve_api_document_version( ) -> str: """ Get a specific API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -944,10 +995,10 @@ async def retrieve_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python registry = await client.registry.retrieve_api_document_version( @@ -965,8 +1016,13 @@ async def retrieve_api_document_version( raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return await self._get( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) @@ -987,7 +1043,7 @@ async def update_api_document_version( ) -> RegistryUpdateAPIDocumentVersionResponse: """ Update the registry file content for an API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -998,10 +1054,10 @@ async def update_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryUpdateAPIDocumentVersionResponse: Default Response - + Example: ```python registry = await client.registry.update_api_document_version( @@ -1019,15 +1075,20 @@ async def update_api_document_version( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return await self._patch( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), body=await async_maybe_transform( - { - "document": document, - "last_known_version_sha": last_known_version_sha, - }, - registry_update_api_document_version_params.RegistryUpdateAPIDocumentVersionParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "document": document, + "last_known_version_sha": last_known_version_sha, + }, + registry_update_api_document_version_params.RegistryUpdateAPIDocumentVersionParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryUpdateAPIDocumentVersionResponse, ) @@ -1046,7 +1107,7 @@ async def delete_api_document_version( ) -> RegistryDeleteAPIDocumentVersionResponse: """ Delete a specific API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -1055,10 +1116,10 @@ async def delete_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryDeleteAPIDocumentVersionResponse: Default Response - + Example: ```python registry = await client.registry.delete_api_document_version( @@ -1075,8 +1136,13 @@ async def delete_api_document_version( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return await self._delete( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryDeleteAPIDocumentVersionResponse, ) @@ -1095,7 +1161,7 @@ async def list_api_document_version_metadata( ) -> RegistryListAPIDocumentVersionMetadataResponse: """ Get metadata (uid, content shas, version sha, tags) for a specific API document version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -1104,10 +1170,10 @@ async def list_api_document_version_metadata( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryListAPIDocumentVersionMetadataResponse: Default Response - + Example: ```python registry = await client.registry.list_api_document_version_metadata( @@ -1124,8 +1190,13 @@ async def list_api_document_version_metadata( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return await self._get( - path_template("/v1/apis/{namespace}/{slug}/version/{semver}/metadata", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryListAPIDocumentVersionMetadataResponse, ) @@ -1147,7 +1218,7 @@ async def create_api_document_version( ) -> RegistryCreateAPIDocumentVersionResponse: """ Create a new API document version. - + Args: slug: Path parameter. namespace: Path parameter. @@ -1159,10 +1230,10 @@ async def create_api_document_version( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryCreateAPIDocumentVersionResponse: Default Response - + Example: ```python registry = await client.registry.create_api_document_version( @@ -1180,15 +1251,17 @@ async def create_api_document_version( return await self._post( path_template("/v1/apis/{namespace}/{slug}/version", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - { - "version": version, - "document": document, - "force": force, - "last_known_version_sha": last_known_version_sha, - }, - registry_create_api_document_version_params.RegistryCreateAPIDocumentVersionParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "version": version, + "document": document, + "force": force, + "last_known_version_sha": last_known_version_sha, + }, + registry_create_api_document_version_params.RegistryCreateAPIDocumentVersionParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryCreateAPIDocumentVersionResponse, ) @@ -1207,7 +1280,7 @@ async def create_api_document_access_group( ) -> RegistryCreateAPIDocumentAccessGroupResponse: """ Add an access group to an API document. - + Args: slug: Path parameter. namespace: Path parameter. @@ -1216,10 +1289,10 @@ async def create_api_document_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryCreateAPIDocumentAccessGroupResponse: Default Response - + Example: ```python registry = await client.registry.create_api_document_access_group( @@ -1236,10 +1309,12 @@ async def create_api_document_access_group( return await self._post( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - {"access_group_slug": access_group_slug}, - registry_create_api_document_access_group_params.RegistryCreateAPIDocumentAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + registry_create_api_document_access_group_params.RegistryCreateAPIDocumentAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryCreateAPIDocumentAccessGroupResponse, ) @@ -1258,7 +1333,7 @@ async def delete_api_document_access_group( ) -> RegistryDeleteAPIDocumentAccessGroupResponse: """ Remove an access group from an API document. - + Args: slug: Path parameter. namespace: Path parameter. @@ -1267,10 +1342,10 @@ async def delete_api_document_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RegistryDeleteAPIDocumentAccessGroupResponse: Default Response - + Example: ```python registry = await client.registry.delete_api_document_access_group( @@ -1287,10 +1362,12 @@ async def delete_api_document_access_group( return await self._delete( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - {"access_group_slug": access_group_slug}, - registry_delete_api_document_access_group_params.RegistryDeleteAPIDocumentAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + registry_delete_api_document_access_group_params.RegistryDeleteAPIDocumentAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RegistryDeleteAPIDocumentAccessGroupResponse, ) diff --git a/src/resources/rules.py b/src/resources/rules.py index e2af964..47ebedb 100644 --- a/src/resources/rules.py +++ b/src/resources/rules.py @@ -17,7 +17,12 @@ from .._base_client import make_request_options from ..types.rule_list_rulesets_response import RuleListRulesetsResponse from ..types.rule_create_ruleset_response import RuleCreateRulesetResponse -from ..types import rule_create_ruleset_params, rule_update_ruleset_params, rule_create_ruleset_access_group_params, rule_delete_ruleset_access_group_params +from ..types import ( + rule_create_ruleset_params, + rule_update_ruleset_params, + rule_create_ruleset_access_group_params, + rule_delete_ruleset_access_group_params, +) from ..types.rule_update_ruleset_response import RuleUpdateRulesetResponse from ..types.rule_delete_ruleset_response import RuleDeleteRulesetResponse from ..types.rule_create_ruleset_access_group_response import RuleCreateRulesetAccessGroupResponse @@ -28,7 +33,6 @@ class RulesResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> RulesResourceWithRawResponse: return RulesResourceWithRawResponse(self) @@ -50,17 +54,17 @@ def list_rulesets( ) -> RuleListRulesetsResponse: """ List all rulesets in a namespace. - + Args: namespace: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleListRulesetsResponse: Default Response - + Example: ```python rule = client.rules.list_rulesets( @@ -72,7 +76,9 @@ def list_rulesets( raise ValueError(f"Expected a non-empty value for `namespace` but received {namespace!r}") return self._get( path_template("/v1/rulesets/{namespace}", **{"namespace": namespace}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleListRulesetsResponse, ) @@ -94,7 +100,7 @@ def create_ruleset( ) -> RuleCreateRulesetResponse: """ Create a rule in a namespace. - + Args: namespace: Path parameter. title: Body parameter. @@ -106,10 +112,10 @@ def create_ruleset( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleCreateRulesetResponse: Default Response - + Example: ```python rule = client.rules.create_ruleset( @@ -125,16 +131,18 @@ def create_ruleset( return self._post( path_template("/v1/rulesets/{namespace}", **{"namespace": namespace}), body=maybe_transform( - { - "title": title, - "description": description, - "slug": slug, - "is_private": is_private, - "document": document, - }, - rule_create_ruleset_params.RuleCreateRulesetParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "slug": slug, + "is_private": is_private, + "document": document, + }, + rule_create_ruleset_params.RuleCreateRulesetParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleCreateRulesetResponse, ) @@ -157,7 +165,7 @@ def update_ruleset( ) -> RuleUpdateRulesetResponse: """ Update rule metadata by slug. - + Args: path_slug: Path parameter. path_namespace: Path parameter. @@ -170,10 +178,10 @@ def update_ruleset( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleUpdateRulesetResponse: Default Response - + Example: ```python rule = client.rules.update_ruleset( @@ -189,16 +197,18 @@ def update_ruleset( return self._patch( path_template("/v1/rulesets/{namespace}/{slug}", **{"namespace": path_namespace, "slug": path_slug}), body=maybe_transform( - { - "body_namespace": body_namespace, - "body_slug": body_slug, - "title": title, - "description": description, - "is_private": is_private, - }, - rule_update_ruleset_params.RuleUpdateRulesetParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "body_namespace": body_namespace, + "body_slug": body_slug, + "title": title, + "description": description, + "is_private": is_private, + }, + rule_update_ruleset_params.RuleUpdateRulesetParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleUpdateRulesetResponse, ) @@ -216,7 +226,7 @@ def delete_ruleset( ) -> RuleDeleteRulesetResponse: """ Delete a rule by slug. - + Args: slug: Path parameter. namespace: Path parameter. @@ -224,10 +234,10 @@ def delete_ruleset( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleDeleteRulesetResponse: Default Response - + Example: ```python rule = client.rules.delete_ruleset( @@ -242,7 +252,9 @@ def delete_ruleset( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._delete( path_template("/v1/rulesets/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleDeleteRulesetResponse, ) @@ -260,7 +272,7 @@ def retrieve_ruleset_document( ) -> str: """ Get a rule document by slug. - + Args: slug: Path parameter. namespace: Path parameter. @@ -268,10 +280,10 @@ def retrieve_ruleset_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python rule = client.rules.retrieve_ruleset_document( @@ -287,7 +299,9 @@ def retrieve_ruleset_document( extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return self._get( path_template("/v1/rulesets/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) @@ -306,7 +320,7 @@ def create_ruleset_access_group( ) -> RuleCreateRulesetAccessGroupResponse: """ Grant an access group to a rule. - + Args: slug: Path parameter. namespace: Path parameter. @@ -315,10 +329,10 @@ def create_ruleset_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleCreateRulesetAccessGroupResponse: Default Response - + Example: ```python rule = client.rules.create_ruleset_access_group( @@ -335,10 +349,12 @@ def create_ruleset_access_group( return self._post( path_template("/v1/rulesets/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - {"access_group_slug": access_group_slug}, - rule_create_ruleset_access_group_params.RuleCreateRulesetAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + rule_create_ruleset_access_group_params.RuleCreateRulesetAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleCreateRulesetAccessGroupResponse, ) @@ -357,7 +373,7 @@ def delete_ruleset_access_group( ) -> RuleDeleteRulesetAccessGroupResponse: """ Remove an access group from a rule. - + Args: slug: Path parameter. namespace: Path parameter. @@ -366,10 +382,10 @@ def delete_ruleset_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleDeleteRulesetAccessGroupResponse: Default Response - + Example: ```python rule = client.rules.delete_ruleset_access_group( @@ -386,16 +402,17 @@ def delete_ruleset_access_group( return self._delete( path_template("/v1/rulesets/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - {"access_group_slug": access_group_slug}, - rule_delete_ruleset_access_group_params.RuleDeleteRulesetAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + rule_delete_ruleset_access_group_params.RuleDeleteRulesetAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleDeleteRulesetAccessGroupResponse, ) class AsyncRulesResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncRulesResourceWithRawResponse: return AsyncRulesResourceWithRawResponse(self) @@ -417,17 +434,17 @@ async def list_rulesets( ) -> RuleListRulesetsResponse: """ List all rulesets in a namespace. - + Args: namespace: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleListRulesetsResponse: Default Response - + Example: ```python rule = await client.rules.list_rulesets( @@ -439,7 +456,9 @@ async def list_rulesets( raise ValueError(f"Expected a non-empty value for `namespace` but received {namespace!r}") return await self._get( path_template("/v1/rulesets/{namespace}", **{"namespace": namespace}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleListRulesetsResponse, ) @@ -461,7 +480,7 @@ async def create_ruleset( ) -> RuleCreateRulesetResponse: """ Create a rule in a namespace. - + Args: namespace: Path parameter. title: Body parameter. @@ -473,10 +492,10 @@ async def create_ruleset( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleCreateRulesetResponse: Default Response - + Example: ```python rule = await client.rules.create_ruleset( @@ -492,16 +511,18 @@ async def create_ruleset( return await self._post( path_template("/v1/rulesets/{namespace}", **{"namespace": namespace}), body=await async_maybe_transform( - { - "title": title, - "description": description, - "slug": slug, - "is_private": is_private, - "document": document, - }, - rule_create_ruleset_params.RuleCreateRulesetParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "slug": slug, + "is_private": is_private, + "document": document, + }, + rule_create_ruleset_params.RuleCreateRulesetParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleCreateRulesetResponse, ) @@ -524,7 +545,7 @@ async def update_ruleset( ) -> RuleUpdateRulesetResponse: """ Update rule metadata by slug. - + Args: path_slug: Path parameter. path_namespace: Path parameter. @@ -537,10 +558,10 @@ async def update_ruleset( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleUpdateRulesetResponse: Default Response - + Example: ```python rule = await client.rules.update_ruleset( @@ -556,16 +577,18 @@ async def update_ruleset( return await self._patch( path_template("/v1/rulesets/{namespace}/{slug}", **{"namespace": path_namespace, "slug": path_slug}), body=await async_maybe_transform( - { - "body_namespace": body_namespace, - "body_slug": body_slug, - "title": title, - "description": description, - "is_private": is_private, - }, - rule_update_ruleset_params.RuleUpdateRulesetParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "body_namespace": body_namespace, + "body_slug": body_slug, + "title": title, + "description": description, + "is_private": is_private, + }, + rule_update_ruleset_params.RuleUpdateRulesetParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleUpdateRulesetResponse, ) @@ -583,7 +606,7 @@ async def delete_ruleset( ) -> RuleDeleteRulesetResponse: """ Delete a rule by slug. - + Args: slug: Path parameter. namespace: Path parameter. @@ -591,10 +614,10 @@ async def delete_ruleset( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleDeleteRulesetResponse: Default Response - + Example: ```python rule = await client.rules.delete_ruleset( @@ -609,7 +632,9 @@ async def delete_ruleset( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._delete( path_template("/v1/rulesets/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleDeleteRulesetResponse, ) @@ -627,7 +652,7 @@ async def retrieve_ruleset_document( ) -> str: """ Get a rule document by slug. - + Args: slug: Path parameter. namespace: Path parameter. @@ -635,10 +660,10 @@ async def retrieve_ruleset_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python rule = await client.rules.retrieve_ruleset_document( @@ -654,7 +679,9 @@ async def retrieve_ruleset_document( extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return await self._get( path_template("/v1/rulesets/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) @@ -673,7 +700,7 @@ async def create_ruleset_access_group( ) -> RuleCreateRulesetAccessGroupResponse: """ Grant an access group to a rule. - + Args: slug: Path parameter. namespace: Path parameter. @@ -682,10 +709,10 @@ async def create_ruleset_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleCreateRulesetAccessGroupResponse: Default Response - + Example: ```python rule = await client.rules.create_ruleset_access_group( @@ -702,10 +729,12 @@ async def create_ruleset_access_group( return await self._post( path_template("/v1/rulesets/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - {"access_group_slug": access_group_slug}, - rule_create_ruleset_access_group_params.RuleCreateRulesetAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + rule_create_ruleset_access_group_params.RuleCreateRulesetAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleCreateRulesetAccessGroupResponse, ) @@ -724,7 +753,7 @@ async def delete_ruleset_access_group( ) -> RuleDeleteRulesetAccessGroupResponse: """ Remove an access group from a rule. - + Args: slug: Path parameter. namespace: Path parameter. @@ -733,10 +762,10 @@ async def delete_ruleset_access_group( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: RuleDeleteRulesetAccessGroupResponse: Default Response - + Example: ```python rule = await client.rules.delete_ruleset_access_group( @@ -753,10 +782,12 @@ async def delete_ruleset_access_group( return await self._delete( path_template("/v1/rulesets/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - {"access_group_slug": access_group_slug}, - rule_delete_ruleset_access_group_params.RuleDeleteRulesetAccessGroupParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + rule_delete_ruleset_access_group_params.RuleDeleteRulesetAccessGroupParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=RuleDeleteRulesetAccessGroupResponse, ) diff --git a/src/resources/scalar_docs.py b/src/resources/scalar_docs.py index 8e4a4d5..27e880e 100644 --- a/src/resources/scalar_docs.py +++ b/src/resources/scalar_docs.py @@ -27,7 +27,6 @@ class ScalarDocsResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> ScalarDocsResourceWithRawResponse: return ScalarDocsResourceWithRawResponse(self) @@ -48,16 +47,16 @@ def list_guides( ) -> ScalarDocListGuidesResponse: """ List all guide projects. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ScalarDocListGuidesResponse: Default Response - + Example: ```python scalar_doc = client.scalar_docs.list_guides() @@ -65,7 +64,9 @@ def list_guides( """ return self._get( "/v1/guides", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ScalarDocListGuidesResponse, ) @@ -86,7 +87,7 @@ def create_guide( ) -> ScalarDocCreateGuideResponse: """ Create a guide project. - + Args: name: Body parameter. slug: Body parameter. @@ -97,10 +98,10 @@ def create_guide( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ScalarDocCreateGuideResponse: Default Response - + Example: ```python scalar_doc = client.scalar_docs.create_guide( @@ -114,16 +115,18 @@ def create_guide( return self._post( "/v1/guides", body=maybe_transform( - { - "name": name, - "slug": slug, - "is_private": is_private, - "allowed_users": allowed_users, - "allowed_domains": allowed_domains, - }, - scalar_doc_create_guide_params.ScalarDocCreateGuideParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "name": name, + "slug": slug, + "is_private": is_private, + "allowed_users": allowed_users, + "allowed_domains": allowed_domains, + }, + scalar_doc_create_guide_params.ScalarDocCreateGuideParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ScalarDocCreateGuideResponse, ) @@ -140,17 +143,17 @@ def publish_guide( ) -> ScalarDocPublishGuideResponse: """ Start a new publish process. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ScalarDocPublishGuideResponse: Default Response - + Example: ```python scalar_doc = client.scalar_docs.publish_guide( @@ -162,13 +165,14 @@ def publish_guide( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._post( path_template("/v1/guides/{slug}/publish", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ScalarDocPublishGuideResponse, ) class AsyncScalarDocsResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncScalarDocsResourceWithRawResponse: return AsyncScalarDocsResourceWithRawResponse(self) @@ -189,16 +193,16 @@ async def list_guides( ) -> ScalarDocListGuidesResponse: """ List all guide projects. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ScalarDocListGuidesResponse: Default Response - + Example: ```python scalar_doc = await client.scalar_docs.list_guides() @@ -206,7 +210,9 @@ async def list_guides( """ return await self._get( "/v1/guides", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ScalarDocListGuidesResponse, ) @@ -227,7 +233,7 @@ async def create_guide( ) -> ScalarDocCreateGuideResponse: """ Create a guide project. - + Args: name: Body parameter. slug: Body parameter. @@ -238,10 +244,10 @@ async def create_guide( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ScalarDocCreateGuideResponse: Default Response - + Example: ```python scalar_doc = await client.scalar_docs.create_guide( @@ -255,16 +261,18 @@ async def create_guide( return await self._post( "/v1/guides", body=await async_maybe_transform( - { - "name": name, - "slug": slug, - "is_private": is_private, - "allowed_users": allowed_users, - "allowed_domains": allowed_domains, - }, - scalar_doc_create_guide_params.ScalarDocCreateGuideParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "name": name, + "slug": slug, + "is_private": is_private, + "allowed_users": allowed_users, + "allowed_domains": allowed_domains, + }, + scalar_doc_create_guide_params.ScalarDocCreateGuideParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ScalarDocCreateGuideResponse, ) @@ -281,17 +289,17 @@ async def publish_guide( ) -> ScalarDocPublishGuideResponse: """ Start a new publish process. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ScalarDocPublishGuideResponse: Default Response - + Example: ```python scalar_doc = await client.scalar_docs.publish_guide( @@ -303,7 +311,9 @@ async def publish_guide( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._post( path_template("/v1/guides/{slug}/publish", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ScalarDocPublishGuideResponse, ) diff --git a/src/resources/schemas/access_group.py b/src/resources/schemas/access_group.py index 8211392..a16cd7e 100644 --- a/src/resources/schemas/access_group.py +++ b/src/resources/schemas/access_group.py @@ -24,7 +24,6 @@ class AccessGroupResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> AccessGroupResourceWithRawResponse: return AccessGroupResourceWithRawResponse(self) @@ -48,7 +47,7 @@ def create_schema( ) -> AccessGroupCreateSchemaResponse: """ Add an access group to a schema. - + Args: slug: Path parameter. namespace: Path parameter. @@ -57,10 +56,10 @@ def create_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AccessGroupCreateSchemaResponse: Default Response - + Example: ```python access_group = client.schemas.access_group.create_schema( @@ -77,10 +76,12 @@ def create_schema( return self._post( path_template("/v1/schemas/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - {"access_group_slug": access_group_slug}, - access_group_create_schema_params.AccessGroupCreateSchemaParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + access_group_create_schema_params.AccessGroupCreateSchemaParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AccessGroupCreateSchemaResponse, ) @@ -99,7 +100,7 @@ def delete_schema( ) -> AccessGroupDeleteSchemaResponse: """ Remove an access group from a schema. - + Args: slug: Path parameter. namespace: Path parameter. @@ -108,10 +109,10 @@ def delete_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AccessGroupDeleteSchemaResponse: Default Response - + Example: ```python access_group = client.schemas.access_group.delete_schema( @@ -128,16 +129,17 @@ def delete_schema( return self._delete( path_template("/v1/schemas/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - {"access_group_slug": access_group_slug}, - access_group_delete_schema_params.AccessGroupDeleteSchemaParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + access_group_delete_schema_params.AccessGroupDeleteSchemaParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AccessGroupDeleteSchemaResponse, ) class AsyncAccessGroupResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncAccessGroupResourceWithRawResponse: return AsyncAccessGroupResourceWithRawResponse(self) @@ -161,7 +163,7 @@ async def create_schema( ) -> AccessGroupCreateSchemaResponse: """ Add an access group to a schema. - + Args: slug: Path parameter. namespace: Path parameter. @@ -170,10 +172,10 @@ async def create_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AccessGroupCreateSchemaResponse: Default Response - + Example: ```python access_group = await client.schemas.access_group.create_schema( @@ -190,10 +192,12 @@ async def create_schema( return await self._post( path_template("/v1/schemas/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - {"access_group_slug": access_group_slug}, - access_group_create_schema_params.AccessGroupCreateSchemaParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + access_group_create_schema_params.AccessGroupCreateSchemaParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AccessGroupCreateSchemaResponse, ) @@ -212,7 +216,7 @@ async def delete_schema( ) -> AccessGroupDeleteSchemaResponse: """ Remove an access group from a schema. - + Args: slug: Path parameter. namespace: Path parameter. @@ -221,10 +225,10 @@ async def delete_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: AccessGroupDeleteSchemaResponse: Default Response - + Example: ```python access_group = await client.schemas.access_group.delete_schema( @@ -241,10 +245,12 @@ async def delete_schema( return await self._delete( path_template("/v1/schemas/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - {"access_group_slug": access_group_slug}, - access_group_delete_schema_params.AccessGroupDeleteSchemaParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"access_group_slug": access_group_slug}, + access_group_delete_schema_params.AccessGroupDeleteSchemaParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=AccessGroupDeleteSchemaResponse, ) diff --git a/src/resources/schemas/schemas.py b/src/resources/schemas/schemas.py index d596f23..ab04769 100644 --- a/src/resources/schemas/schemas.py +++ b/src/resources/schemas/schemas.py @@ -42,7 +42,6 @@ class SchemasResource(SyncAPIResource): - @cached_property def version(self) -> VersionResource: return VersionResource(self._client) @@ -72,17 +71,17 @@ def list( ) -> SchemaListResponse: """ List schemas in a namespace. - + Args: namespace: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaListResponse: Default Response - + Example: ```python schema = client.schemas.list( @@ -94,7 +93,9 @@ def list( raise ValueError(f"Expected a non-empty value for `namespace` but received {namespace!r}") return self._get( path_template("/v1/schemas/{namespace}", **{"namespace": namespace}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaListResponse, ) @@ -117,7 +118,7 @@ def create( ) -> SchemaCreateResponse: """ Create a schema in a namespace. - + Args: namespace: Path parameter. title: Body parameter. @@ -130,10 +131,10 @@ def create( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaCreateResponse: Default Response - + Example: ```python schema = client.schemas.create( @@ -150,17 +151,19 @@ def create( return self._post( path_template("/v1/schemas/{namespace}", **{"namespace": namespace}), body=maybe_transform( - { - "title": title, - "description": description, - "version": version, - "slug": slug, - "is_private": is_private, - "document": document, - }, - schema_create_params.SchemaCreateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "version": version, + "slug": slug, + "is_private": is_private, + "document": document, + }, + schema_create_params.SchemaCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaCreateResponse, ) @@ -181,7 +184,7 @@ def update( ) -> SchemaUpdateResponse: """ Update schema metadata. - + Args: slug: Path parameter. namespace: Path parameter. @@ -192,10 +195,10 @@ def update( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaUpdateResponse: Default Response - + Example: ```python schema = client.schemas.update( @@ -211,14 +214,16 @@ def update( return self._patch( path_template("/v1/schemas/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - { - "title": title, - "description": description, - "is_private": is_private, - }, - schema_update_params.SchemaUpdateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "is_private": is_private, + }, + schema_update_params.SchemaUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaUpdateResponse, ) @@ -236,7 +241,7 @@ def delete( ) -> SchemaDeleteResponse: """ Delete a schema and all related versions. - + Args: slug: Path parameter. namespace: Path parameter. @@ -244,10 +249,10 @@ def delete( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaDeleteResponse: Default Response - + Example: ```python schema = client.schemas.delete( @@ -262,13 +267,14 @@ def delete( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._delete( path_template("/v1/schemas/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaDeleteResponse, ) class AsyncSchemasResource(AsyncAPIResource): - @cached_property def version(self) -> AsyncVersionResource: return AsyncVersionResource(self._client) @@ -298,17 +304,17 @@ async def list( ) -> SchemaListResponse: """ List schemas in a namespace. - + Args: namespace: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaListResponse: Default Response - + Example: ```python schema = await client.schemas.list( @@ -320,7 +326,9 @@ async def list( raise ValueError(f"Expected a non-empty value for `namespace` but received {namespace!r}") return await self._get( path_template("/v1/schemas/{namespace}", **{"namespace": namespace}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaListResponse, ) @@ -343,7 +351,7 @@ async def create( ) -> SchemaCreateResponse: """ Create a schema in a namespace. - + Args: namespace: Path parameter. title: Body parameter. @@ -356,10 +364,10 @@ async def create( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaCreateResponse: Default Response - + Example: ```python schema = await client.schemas.create( @@ -376,17 +384,19 @@ async def create( return await self._post( path_template("/v1/schemas/{namespace}", **{"namespace": namespace}), body=await async_maybe_transform( - { - "title": title, - "description": description, - "version": version, - "slug": slug, - "is_private": is_private, - "document": document, - }, - schema_create_params.SchemaCreateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "version": version, + "slug": slug, + "is_private": is_private, + "document": document, + }, + schema_create_params.SchemaCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaCreateResponse, ) @@ -407,7 +417,7 @@ async def update( ) -> SchemaUpdateResponse: """ Update schema metadata. - + Args: slug: Path parameter. namespace: Path parameter. @@ -418,10 +428,10 @@ async def update( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaUpdateResponse: Default Response - + Example: ```python schema = await client.schemas.update( @@ -437,14 +447,16 @@ async def update( return await self._patch( path_template("/v1/schemas/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - { - "title": title, - "description": description, - "is_private": is_private, - }, - schema_update_params.SchemaUpdateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "title": title, + "description": description, + "is_private": is_private, + }, + schema_update_params.SchemaUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaUpdateResponse, ) @@ -462,7 +474,7 @@ async def delete( ) -> SchemaDeleteResponse: """ Delete a schema and all related versions. - + Args: slug: Path parameter. namespace: Path parameter. @@ -470,10 +482,10 @@ async def delete( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: SchemaDeleteResponse: Default Response - + Example: ```python schema = await client.schemas.delete( @@ -488,7 +500,9 @@ async def delete( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._delete( path_template("/v1/schemas/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=SchemaDeleteResponse, ) diff --git a/src/resources/schemas/version.py b/src/resources/schemas/version.py index 5a03591..c674e9b 100644 --- a/src/resources/schemas/version.py +++ b/src/resources/schemas/version.py @@ -24,7 +24,6 @@ class VersionResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> VersionResourceWithRawResponse: return VersionResourceWithRawResponse(self) @@ -48,7 +47,7 @@ def retrieve_schema( ) -> str: """ Get a specific schema version document. - + Args: semver: Path parameter. namespace: Path parameter. @@ -57,10 +56,10 @@ def retrieve_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python version = client.schemas.version.retrieve_schema( @@ -78,8 +77,13 @@ def retrieve_schema( raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return self._get( - path_template("/v1/schemas/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/schemas/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) @@ -98,7 +102,7 @@ def delete_schema( ) -> VersionDeleteSchemaResponse: """ Delete a schema version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -107,10 +111,10 @@ def delete_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: VersionDeleteSchemaResponse: Default Response - + Example: ```python version = client.schemas.version.delete_schema( @@ -127,8 +131,13 @@ def delete_schema( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return self._delete( - path_template("/v1/schemas/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/schemas/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=VersionDeleteSchemaResponse, ) @@ -148,7 +157,7 @@ def create_schema( ) -> VersionCreateSchemaResponse: """ Create a schema version. - + Args: slug: Path parameter. namespace: Path parameter. @@ -158,10 +167,10 @@ def create_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: VersionCreateSchemaResponse: Default Response - + Example: ```python version = client.schemas.version.create_schema( @@ -179,19 +188,20 @@ def create_schema( return self._post( path_template("/v1/schemas/{namespace}/{slug}/version", **{"namespace": namespace, "slug": slug}), body=maybe_transform( - { - "version": version, - "document": document, - }, - version_create_schema_params.VersionCreateSchemaParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "version": version, + "document": document, + }, + version_create_schema_params.VersionCreateSchemaParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=VersionCreateSchemaResponse, ) class AsyncVersionResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncVersionResourceWithRawResponse: return AsyncVersionResourceWithRawResponse(self) @@ -215,7 +225,7 @@ async def retrieve_schema( ) -> str: """ Get a specific schema version document. - + Args: semver: Path parameter. namespace: Path parameter. @@ -224,10 +234,10 @@ async def retrieve_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python version = await client.schemas.version.retrieve_schema( @@ -245,8 +255,13 @@ async def retrieve_schema( raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return await self._get( - path_template("/v1/schemas/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/schemas/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) @@ -265,7 +280,7 @@ async def delete_schema( ) -> VersionDeleteSchemaResponse: """ Delete a schema version. - + Args: semver: Path parameter. namespace: Path parameter. @@ -274,10 +289,10 @@ async def delete_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: VersionDeleteSchemaResponse: Default Response - + Example: ```python version = await client.schemas.version.delete_schema( @@ -294,8 +309,13 @@ async def delete_schema( if semver is None or (isinstance(semver, str) and not semver): raise ValueError(f"Expected a non-empty value for `semver` but received {semver!r}") return await self._delete( - path_template("/v1/schemas/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + path_template( + "/v1/schemas/{namespace}/{slug}/version/{semver}", + **{"namespace": namespace, "slug": slug, "semver": semver}, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=VersionDeleteSchemaResponse, ) @@ -315,7 +335,7 @@ async def create_schema( ) -> VersionCreateSchemaResponse: """ Create a schema version. - + Args: slug: Path parameter. namespace: Path parameter. @@ -325,10 +345,10 @@ async def create_schema( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: VersionCreateSchemaResponse: Default Response - + Example: ```python version = await client.schemas.version.create_schema( @@ -346,13 +366,15 @@ async def create_schema( return await self._post( path_template("/v1/schemas/{namespace}/{slug}/version", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( - { - "version": version, - "document": document, - }, - version_create_schema_params.VersionCreateSchemaParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "version": version, + "document": document, + }, + version_create_schema_params.VersionCreateSchemaParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=VersionCreateSchemaResponse, ) diff --git a/src/resources/teams.py b/src/resources/teams.py index a01929a..4c0190d 100644 --- a/src/resources/teams.py +++ b/src/resources/teams.py @@ -20,7 +20,6 @@ class TeamsResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> TeamsResourceWithRawResponse: return TeamsResourceWithRawResponse(self) @@ -41,16 +40,16 @@ def list( ) -> TeamListResponse: """ List all available teams - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: TeamListResponse: Default Response - + Example: ```python team = client.teams.list() @@ -58,13 +57,14 @@ def list( """ return self._get( "/v1/teams", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=TeamListResponse, ) class AsyncTeamsResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncTeamsResourceWithRawResponse: return AsyncTeamsResourceWithRawResponse(self) @@ -85,16 +85,16 @@ async def list( ) -> TeamListResponse: """ List all available teams - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: TeamListResponse: Default Response - + Example: ```python team = await client.teams.list() @@ -102,7 +102,9 @@ async def list( """ return await self._get( "/v1/teams", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=TeamListResponse, ) diff --git a/src/resources/themes.py b/src/resources/themes.py index c526d62..013a5cb 100644 --- a/src/resources/themes.py +++ b/src/resources/themes.py @@ -26,7 +26,6 @@ class ThemesResource(SyncAPIResource): - @cached_property def with_raw_response(self) -> ThemesResourceWithRawResponse: return ThemesResourceWithRawResponse(self) @@ -47,16 +46,16 @@ def list( ) -> ThemeListResponse: """ List all team themes. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeListResponse: Default Response - + Example: ```python theme = client.themes.list() @@ -64,7 +63,9 @@ def list( """ return self._get( "/v1/themes", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeListResponse, ) @@ -84,7 +85,7 @@ def create( ) -> ThemeCreateResponse: """ Create a team theme. - + Args: name: Body parameter. description: Body parameter. @@ -94,10 +95,10 @@ def create( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeCreateResponse: Default Response - + Example: ```python theme = client.themes.create( @@ -110,15 +111,17 @@ def create( return self._post( "/v1/themes", body=maybe_transform( - { - "name": name, - "description": description, - "slug": slug, - "document": document, - }, - theme_create_params.ThemeCreateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "name": name, + "description": description, + "slug": slug, + "document": document, + }, + theme_create_params.ThemeCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeCreateResponse, ) @@ -137,7 +140,7 @@ def update( ) -> ThemeUpdateResponse: """ Update theme metadata. - + Args: slug: Path parameter. name: Body parameter. @@ -146,10 +149,10 @@ def update( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeUpdateResponse: Default Response - + Example: ```python theme = client.themes.update( @@ -162,13 +165,15 @@ def update( return self._patch( path_template("/v1/themes/{slug}", **{"slug": slug}), body=maybe_transform( - { - "name": name, - "description": description, - }, - theme_update_params.ThemeUpdateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "name": name, + "description": description, + }, + theme_update_params.ThemeUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeUpdateResponse, ) @@ -186,7 +191,7 @@ def replace_document( ) -> ThemeReplaceDocumentResponse: """ Replace the theme document. - + Args: slug: Path parameter. document: Body parameter. @@ -194,10 +199,10 @@ def replace_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeReplaceDocumentResponse: Default Response - + Example: ```python theme = client.themes.replace_document( @@ -211,10 +216,12 @@ def replace_document( return self._put( path_template("/v1/themes/{slug}", **{"slug": slug}), body=maybe_transform( - {"document": document}, - theme_replace_document_params.ThemeReplaceDocumentParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"document": document}, + theme_replace_document_params.ThemeReplaceDocumentParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeReplaceDocumentResponse, ) @@ -231,17 +238,17 @@ def delete( ) -> ThemeDeleteResponse: """ Delete a theme by slug. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeDeleteResponse: Default Response - + Example: ```python theme = client.themes.delete( @@ -253,7 +260,9 @@ def delete( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return self._delete( path_template("/v1/themes/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeDeleteResponse, ) @@ -270,17 +279,17 @@ def retrieve( ) -> str: """ Get the theme document by slug. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python theme = client.themes.retrieve( @@ -293,13 +302,14 @@ def retrieve( extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return self._get( path_template("/v1/themes/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) class AsyncThemesResource(AsyncAPIResource): - @cached_property def with_raw_response(self) -> AsyncThemesResourceWithRawResponse: return AsyncThemesResourceWithRawResponse(self) @@ -320,16 +330,16 @@ async def list( ) -> ThemeListResponse: """ List all team themes. - + Args: extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeListResponse: Default Response - + Example: ```python theme = await client.themes.list() @@ -337,7 +347,9 @@ async def list( """ return await self._get( "/v1/themes", - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeListResponse, ) @@ -357,7 +369,7 @@ async def create( ) -> ThemeCreateResponse: """ Create a team theme. - + Args: name: Body parameter. description: Body parameter. @@ -367,10 +379,10 @@ async def create( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeCreateResponse: Default Response - + Example: ```python theme = await client.themes.create( @@ -383,15 +395,17 @@ async def create( return await self._post( "/v1/themes", body=await async_maybe_transform( - { - "name": name, - "description": description, - "slug": slug, - "document": document, - }, - theme_create_params.ThemeCreateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "name": name, + "description": description, + "slug": slug, + "document": document, + }, + theme_create_params.ThemeCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeCreateResponse, ) @@ -410,7 +424,7 @@ async def update( ) -> ThemeUpdateResponse: """ Update theme metadata. - + Args: slug: Path parameter. name: Body parameter. @@ -419,10 +433,10 @@ async def update( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeUpdateResponse: Default Response - + Example: ```python theme = await client.themes.update( @@ -435,13 +449,15 @@ async def update( return await self._patch( path_template("/v1/themes/{slug}", **{"slug": slug}), body=await async_maybe_transform( - { - "name": name, - "description": description, - }, - theme_update_params.ThemeUpdateParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + { + "name": name, + "description": description, + }, + theme_update_params.ThemeUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeUpdateResponse, ) @@ -459,7 +475,7 @@ async def replace_document( ) -> ThemeReplaceDocumentResponse: """ Replace the theme document. - + Args: slug: Path parameter. document: Body parameter. @@ -467,10 +483,10 @@ async def replace_document( extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeReplaceDocumentResponse: Default Response - + Example: ```python theme = await client.themes.replace_document( @@ -484,10 +500,12 @@ async def replace_document( return await self._put( path_template("/v1/themes/{slug}", **{"slug": slug}), body=await async_maybe_transform( - {"document": document}, - theme_replace_document_params.ThemeReplaceDocumentParams, - ), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + {"document": document}, + theme_replace_document_params.ThemeReplaceDocumentParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeReplaceDocumentResponse, ) @@ -504,17 +522,17 @@ async def delete( ) -> ThemeDeleteResponse: """ Delete a theme by slug. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: ThemeDeleteResponse: Default Response - + Example: ```python theme = await client.themes.delete( @@ -526,7 +544,9 @@ async def delete( raise ValueError(f"Expected a non-empty value for `slug` but received {slug!r}") return await self._delete( path_template("/v1/themes/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=ThemeDeleteResponse, ) @@ -543,17 +563,17 @@ async def retrieve( ) -> str: """ Get the theme document by slug. - + Args: slug: Path parameter. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. timeout: Override the client-level default timeout for this request, in seconds. - + Returns: str: Default Response - + Example: ```python theme = await client.themes.retrieve( @@ -566,7 +586,9 @@ async def retrieve( extra_headers = {"Accept": "text/plain", **(extra_headers or {})} return await self._get( path_template("/v1/themes/{slug}", **{"slug": slug}), - options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), cast_to=str, ) diff --git a/src/types/__init__.py b/src/types/__init__.py index 3c6691a..cd781cf 100644 --- a/src/types/__init__.py +++ b/src/types/__init__.py @@ -8,24 +8,54 @@ from .login_portal_page import LoginPortalPage as LoginPortalPage from .login_portal_email_param import LoginPortalEmailParam as LoginPortalEmailParam from .login_portal_page_param import LoginPortalPageParam as LoginPortalPageParam -from .registry_list_all_api_documents_response import RegistryListAllAPIDocumentsResponse as RegistryListAllAPIDocumentsResponse +from .registry_list_all_api_documents_response import ( + RegistryListAllAPIDocumentsResponse as RegistryListAllAPIDocumentsResponse, +) from .registry_list_api_documents_response import RegistryListAPIDocumentsResponse as RegistryListAPIDocumentsResponse -from .registry_create_api_document_response import RegistryCreateAPIDocumentResponse as RegistryCreateAPIDocumentResponse +from .registry_create_api_document_response import ( + RegistryCreateAPIDocumentResponse as RegistryCreateAPIDocumentResponse, +) from .registry_create_api_document_params import RegistryCreateAPIDocumentParams as RegistryCreateAPIDocumentParams -from .registry_update_api_document_response import RegistryUpdateAPIDocumentResponse as RegistryUpdateAPIDocumentResponse +from .registry_update_api_document_response import ( + RegistryUpdateAPIDocumentResponse as RegistryUpdateAPIDocumentResponse, +) from .registry_update_api_document_params import RegistryUpdateAPIDocumentParams as RegistryUpdateAPIDocumentParams -from .registry_delete_api_document_response import RegistryDeleteAPIDocumentResponse as RegistryDeleteAPIDocumentResponse -from .registry_retrieve_api_document_version_response import RegistryRetrieveAPIDocumentVersionResponse as RegistryRetrieveAPIDocumentVersionResponse -from .registry_update_api_document_version_response import RegistryUpdateAPIDocumentVersionResponse as RegistryUpdateAPIDocumentVersionResponse -from .registry_update_api_document_version_params import RegistryUpdateAPIDocumentVersionParams as RegistryUpdateAPIDocumentVersionParams -from .registry_delete_api_document_version_response import RegistryDeleteAPIDocumentVersionResponse as RegistryDeleteAPIDocumentVersionResponse -from .registry_list_api_document_version_metadata_response import RegistryListAPIDocumentVersionMetadataResponse as RegistryListAPIDocumentVersionMetadataResponse -from .registry_create_api_document_version_response import RegistryCreateAPIDocumentVersionResponse as RegistryCreateAPIDocumentVersionResponse -from .registry_create_api_document_version_params import RegistryCreateAPIDocumentVersionParams as RegistryCreateAPIDocumentVersionParams -from .registry_create_api_document_access_group_response import RegistryCreateAPIDocumentAccessGroupResponse as RegistryCreateAPIDocumentAccessGroupResponse -from .registry_create_api_document_access_group_params import RegistryCreateAPIDocumentAccessGroupParams as RegistryCreateAPIDocumentAccessGroupParams -from .registry_delete_api_document_access_group_response import RegistryDeleteAPIDocumentAccessGroupResponse as RegistryDeleteAPIDocumentAccessGroupResponse -from .registry_delete_api_document_access_group_params import RegistryDeleteAPIDocumentAccessGroupParams as RegistryDeleteAPIDocumentAccessGroupParams +from .registry_delete_api_document_response import ( + RegistryDeleteAPIDocumentResponse as RegistryDeleteAPIDocumentResponse, +) +from .registry_retrieve_api_document_version_response import ( + RegistryRetrieveAPIDocumentVersionResponse as RegistryRetrieveAPIDocumentVersionResponse, +) +from .registry_update_api_document_version_response import ( + RegistryUpdateAPIDocumentVersionResponse as RegistryUpdateAPIDocumentVersionResponse, +) +from .registry_update_api_document_version_params import ( + RegistryUpdateAPIDocumentVersionParams as RegistryUpdateAPIDocumentVersionParams, +) +from .registry_delete_api_document_version_response import ( + RegistryDeleteAPIDocumentVersionResponse as RegistryDeleteAPIDocumentVersionResponse, +) +from .registry_list_api_document_version_metadata_response import ( + RegistryListAPIDocumentVersionMetadataResponse as RegistryListAPIDocumentVersionMetadataResponse, +) +from .registry_create_api_document_version_response import ( + RegistryCreateAPIDocumentVersionResponse as RegistryCreateAPIDocumentVersionResponse, +) +from .registry_create_api_document_version_params import ( + RegistryCreateAPIDocumentVersionParams as RegistryCreateAPIDocumentVersionParams, +) +from .registry_create_api_document_access_group_response import ( + RegistryCreateAPIDocumentAccessGroupResponse as RegistryCreateAPIDocumentAccessGroupResponse, +) +from .registry_create_api_document_access_group_params import ( + RegistryCreateAPIDocumentAccessGroupParams as RegistryCreateAPIDocumentAccessGroupParams, +) +from .registry_delete_api_document_access_group_response import ( + RegistryDeleteAPIDocumentAccessGroupResponse as RegistryDeleteAPIDocumentAccessGroupResponse, +) +from .registry_delete_api_document_access_group_params import ( + RegistryDeleteAPIDocumentAccessGroupParams as RegistryDeleteAPIDocumentAccessGroupParams, +) from .schema_list_response import SchemaListResponse as SchemaListResponse from .schema_create_response import SchemaCreateResponse as SchemaCreateResponse from .schema_create_params import SchemaCreateParams as SchemaCreateParams @@ -45,11 +75,21 @@ from .rule_update_ruleset_response import RuleUpdateRulesetResponse as RuleUpdateRulesetResponse from .rule_update_ruleset_params import RuleUpdateRulesetParams as RuleUpdateRulesetParams from .rule_delete_ruleset_response import RuleDeleteRulesetResponse as RuleDeleteRulesetResponse -from .rule_retrieve_ruleset_document_response import RuleRetrieveRulesetDocumentResponse as RuleRetrieveRulesetDocumentResponse -from .rule_create_ruleset_access_group_response import RuleCreateRulesetAccessGroupResponse as RuleCreateRulesetAccessGroupResponse -from .rule_create_ruleset_access_group_params import RuleCreateRulesetAccessGroupParams as RuleCreateRulesetAccessGroupParams -from .rule_delete_ruleset_access_group_response import RuleDeleteRulesetAccessGroupResponse as RuleDeleteRulesetAccessGroupResponse -from .rule_delete_ruleset_access_group_params import RuleDeleteRulesetAccessGroupParams as RuleDeleteRulesetAccessGroupParams +from .rule_retrieve_ruleset_document_response import ( + RuleRetrieveRulesetDocumentResponse as RuleRetrieveRulesetDocumentResponse, +) +from .rule_create_ruleset_access_group_response import ( + RuleCreateRulesetAccessGroupResponse as RuleCreateRulesetAccessGroupResponse, +) +from .rule_create_ruleset_access_group_params import ( + RuleCreateRulesetAccessGroupParams as RuleCreateRulesetAccessGroupParams, +) +from .rule_delete_ruleset_access_group_response import ( + RuleDeleteRulesetAccessGroupResponse as RuleDeleteRulesetAccessGroupResponse, +) +from .rule_delete_ruleset_access_group_params import ( + RuleDeleteRulesetAccessGroupParams as RuleDeleteRulesetAccessGroupParams, +) from .theme_list_response import ThemeListResponse as ThemeListResponse from .theme_create_response import ThemeCreateResponse as ThemeCreateResponse from .theme_create_params import ThemeCreateParams as ThemeCreateParams @@ -65,6 +105,12 @@ from .scalar_doc_create_guide_params import ScalarDocCreateGuideParams as ScalarDocCreateGuideParams from .scalar_doc_publish_guide_response import ScalarDocPublishGuideResponse as ScalarDocPublishGuideResponse from .namespace_list_response import NamespaceListResponse as NamespaceListResponse -from .authentication_exchange_personal_token_response import AuthenticationExchangePersonalTokenResponse as AuthenticationExchangePersonalTokenResponse -from .authentication_exchange_personal_token_params import AuthenticationExchangePersonalTokenParams as AuthenticationExchangePersonalTokenParams -from .authentication_list_current_user_response import AuthenticationListCurrentUserResponse as AuthenticationListCurrentUserResponse +from .authentication_exchange_personal_token_response import ( + AuthenticationExchangePersonalTokenResponse as AuthenticationExchangePersonalTokenResponse, +) +from .authentication_exchange_personal_token_params import ( + AuthenticationExchangePersonalTokenParams as AuthenticationExchangePersonalTokenParams, +) +from .authentication_list_current_user_response import ( + AuthenticationListCurrentUserResponse as AuthenticationListCurrentUserResponse, +) diff --git a/src/types/authentication_exchange_personal_token_params.py b/src/types/authentication_exchange_personal_token_params.py index 46d3b6b..6ddc0f9 100644 --- a/src/types/authentication_exchange_personal_token_params.py +++ b/src/types/authentication_exchange_personal_token_params.py @@ -10,5 +10,4 @@ class AuthenticationExchangePersonalTokenParams(TypedDict, total=False): - personal_token: Required[Annotated[str, PropertyInfo(alias="personalToken")]] diff --git a/src/types/authentication_exchange_personal_token_response.py b/src/types/authentication_exchange_personal_token_response.py index 386bb00..307c681 100644 --- a/src/types/authentication_exchange_personal_token_response.py +++ b/src/types/authentication_exchange_personal_token_response.py @@ -6,9 +6,6 @@ __all__ = ["AuthenticationExchangePersonalTokenResponse"] -class AuthenticationExchangePersonalTokenResponse(BaseModel): +class AuthenticationExchangePersonalTokenResponse(BaseModel): access_token: str = FieldInfo(alias="accessToken") - - - diff --git a/src/types/authentication_list_current_user_response.py b/src/types/authentication_list_current_user_response.py index 5e341cc..be71163 100644 --- a/src/types/authentication_list_current_user_response.py +++ b/src/types/authentication_list_current_user_response.py @@ -10,7 +10,6 @@ class Team(BaseModel): - uid: str name: str @@ -18,9 +17,7 @@ class Team(BaseModel): image_uri: Optional[str] = FieldInfo(alias="imageUri", default=None) - class AuthenticationListCurrentUserResponse(BaseModel): - uid: str created_at: int = FieldInfo(alias="createdAt") diff --git a/src/types/login_portal_create_params.py b/src/types/login_portal_create_params.py index 99a0c44..77985e1 100644 --- a/src/types/login_portal_create_params.py +++ b/src/types/login_portal_create_params.py @@ -11,7 +11,6 @@ class LoginPortalCreateParams(TypedDict, total=False): - title: Required[str] slug: Required[str] diff --git a/src/types/login_portal_create_response.py b/src/types/login_portal_create_response.py index 952996d..6382937 100644 --- a/src/types/login_portal_create_response.py +++ b/src/types/login_portal_create_response.py @@ -6,5 +6,4 @@ class LoginPortalCreateResponse(BaseModel): - uid: str diff --git a/src/types/login_portal_email.py b/src/types/login_portal_email.py index 4380610..1bfa784 100644 --- a/src/types/login_portal_email.py +++ b/src/types/login_portal_email.py @@ -8,7 +8,6 @@ class LoginPortalEmail(BaseModel): - logo: str logo_size: str = FieldInfo(alias="logoSize") diff --git a/src/types/login_portal_email_param.py b/src/types/login_portal_email_param.py index 6ef95df..f6e90f2 100644 --- a/src/types/login_portal_email_param.py +++ b/src/types/login_portal_email_param.py @@ -10,7 +10,6 @@ class LoginPortalEmailParam(TypedDict, total=False): - logo: Required[str] logo_size: Required[Annotated[str, PropertyInfo(alias="logoSize")]] diff --git a/src/types/login_portal_list_response.py b/src/types/login_portal_list_response.py index fb5a2fd..06b734a 100644 --- a/src/types/login_portal_list_response.py +++ b/src/types/login_portal_list_response.py @@ -9,8 +9,8 @@ __all__ = ["LoginPortalListResponse", "LoginPortal"] -class LoginPortal(BaseModel): +class LoginPortal(BaseModel): uid: str title: str @@ -18,5 +18,4 @@ class LoginPortal(BaseModel): slug: Slug - LoginPortalListResponse: TypeAlias = List[LoginPortal] diff --git a/src/types/login_portal_page.py b/src/types/login_portal_page.py index 43e6c50..2c1d8cc 100644 --- a/src/types/login_portal_page.py +++ b/src/types/login_portal_page.py @@ -8,7 +8,6 @@ class LoginPortalPage(BaseModel): - title: str description: str diff --git a/src/types/login_portal_page_param.py b/src/types/login_portal_page_param.py index 2961645..b7be46c 100644 --- a/src/types/login_portal_page_param.py +++ b/src/types/login_portal_page_param.py @@ -10,7 +10,6 @@ class LoginPortalPageParam(TypedDict, total=False): - title: Required[str] description: Required[str] diff --git a/src/types/login_portal_retrieve_response.py b/src/types/login_portal_retrieve_response.py index 1ef1d86..dd830e2 100644 --- a/src/types/login_portal_retrieve_response.py +++ b/src/types/login_portal_retrieve_response.py @@ -7,8 +7,8 @@ __all__ = ["LoginPortalRetrieveResponse"] -class LoginPortalRetrieveResponse(BaseModel): +class LoginPortalRetrieveResponse(BaseModel): uid: str title: str @@ -18,6 +18,3 @@ class LoginPortalRetrieveResponse(BaseModel): email: LoginPortalEmail page: LoginPortalPage - - - diff --git a/src/types/login_portal_update_params.py b/src/types/login_portal_update_params.py index 8832ac2..dffa222 100644 --- a/src/types/login_portal_update_params.py +++ b/src/types/login_portal_update_params.py @@ -8,5 +8,4 @@ class LoginPortalUpdateParams(TypedDict, total=False): - title: str diff --git a/src/types/registry_create_api_document_access_group_params.py b/src/types/registry_create_api_document_access_group_params.py index 4ceb233..b81a6ff 100644 --- a/src/types/registry_create_api_document_access_group_params.py +++ b/src/types/registry_create_api_document_access_group_params.py @@ -12,7 +12,6 @@ class RegistryCreateAPIDocumentAccessGroupParams(TypedDict, total=False): - namespace: Required[str] access_group_slug: Required[Annotated[Slug, PropertyInfo(alias="accessGroupSlug")]] diff --git a/src/types/registry_create_api_document_params.py b/src/types/registry_create_api_document_params.py index 61602e0..8ad7a44 100644 --- a/src/types/registry_create_api_document_params.py +++ b/src/types/registry_create_api_document_params.py @@ -12,7 +12,6 @@ class RegistryCreateAPIDocumentParams(TypedDict, total=False): - title: Required[str] description: str diff --git a/src/types/registry_create_api_document_response.py b/src/types/registry_create_api_document_response.py index 01a14d4..4dba314 100644 --- a/src/types/registry_create_api_document_response.py +++ b/src/types/registry_create_api_document_response.py @@ -6,8 +6,8 @@ __all__ = ["RegistryCreateAPIDocumentResponse"] -class RegistryCreateAPIDocumentResponse(BaseModel): +class RegistryCreateAPIDocumentResponse(BaseModel): uid: str version_uid: str = FieldInfo(alias="versionUid") @@ -19,6 +19,3 @@ class RegistryCreateAPIDocumentResponse(BaseModel): yaml_sha: str = FieldInfo(alias="yamlSha") version_sha: str = FieldInfo(alias="versionSha") - - - diff --git a/src/types/registry_create_api_document_version_params.py b/src/types/registry_create_api_document_version_params.py index ea22c07..1bacd25 100644 --- a/src/types/registry_create_api_document_version_params.py +++ b/src/types/registry_create_api_document_version_params.py @@ -12,7 +12,6 @@ class RegistryCreateAPIDocumentVersionParams(TypedDict, total=False): - namespace: Required[str] version: Required[Version] diff --git a/src/types/registry_create_api_document_version_response.py b/src/types/registry_create_api_document_version_response.py index 6e75f0a..a3db246 100644 --- a/src/types/registry_create_api_document_version_response.py +++ b/src/types/registry_create_api_document_version_response.py @@ -13,7 +13,6 @@ class Tool(BaseModel): - path: str method: Literal["delete", "get", "head", "options", "patch", "post", "put", "trace"] @@ -21,9 +20,7 @@ class Tool(BaseModel): enabled_tools: List[Literal["execute-request", "get-mini-openapi-spec"]] = FieldInfo(alias="enabledTools") - class RegistryCreateAPIDocumentVersionResponse(BaseModel): - uid: str created_at: float = FieldInfo(alias="createdAt") diff --git a/src/types/registry_delete_api_document_access_group_params.py b/src/types/registry_delete_api_document_access_group_params.py index 3e19a4f..aab2b5b 100644 --- a/src/types/registry_delete_api_document_access_group_params.py +++ b/src/types/registry_delete_api_document_access_group_params.py @@ -12,7 +12,6 @@ class RegistryDeleteAPIDocumentAccessGroupParams(TypedDict, total=False): - namespace: Required[str] access_group_slug: Required[Annotated[Slug, PropertyInfo(alias="accessGroupSlug")]] diff --git a/src/types/registry_list_all_api_documents_response.py b/src/types/registry_list_all_api_documents_response.py index 36a0c2a..ad7c112 100644 --- a/src/types/registry_list_all_api_documents_response.py +++ b/src/types/registry_list_all_api_documents_response.py @@ -14,16 +14,16 @@ __all__ = ["RegistryListAllAPIDocumentsResponse", "APIDocument", "Version", "VersionTool"] -class VersionTool(BaseModel): +class VersionTool(BaseModel): path: str method: Literal["delete", "get", "head", "options", "patch", "post", "put", "trace"] enabled_tools: List[Literal["execute-request", "get-mini-openapi-spec"]] = FieldInfo(alias="enabledTools") -class Version(BaseModel): +class Version(BaseModel): uid: str created_at: float = FieldInfo(alias="createdAt") @@ -44,8 +44,8 @@ class Version(BaseModel): version_sha: Optional[str] = FieldInfo(alias="versionSha", default=None) -class APIDocument(BaseModel): +class APIDocument(BaseModel): uid: str version: Version @@ -65,5 +65,4 @@ class APIDocument(BaseModel): versions: List[Version] - RegistryListAllAPIDocumentsResponse: TypeAlias = List[APIDocument] diff --git a/src/types/registry_list_api_document_version_metadata_response.py b/src/types/registry_list_api_document_version_metadata_response.py index 9d20c17..765f911 100644 --- a/src/types/registry_list_api_document_version_metadata_response.py +++ b/src/types/registry_list_api_document_version_metadata_response.py @@ -13,7 +13,6 @@ class Tool(BaseModel): - path: str method: Literal["delete", "get", "head", "options", "patch", "post", "put", "trace"] @@ -21,9 +20,7 @@ class Tool(BaseModel): enabled_tools: List[Literal["execute-request", "get-mini-openapi-spec"]] = FieldInfo(alias="enabledTools") - class RegistryListAPIDocumentVersionMetadataResponse(BaseModel): - uid: str created_at: float = FieldInfo(alias="createdAt") diff --git a/src/types/registry_list_api_documents_response.py b/src/types/registry_list_api_documents_response.py index 5c91ba4..3ddf5dd 100644 --- a/src/types/registry_list_api_documents_response.py +++ b/src/types/registry_list_api_documents_response.py @@ -14,16 +14,16 @@ __all__ = ["RegistryListAPIDocumentsResponse", "APIDocument", "Version", "VersionTool"] -class VersionTool(BaseModel): +class VersionTool(BaseModel): path: str method: Literal["delete", "get", "head", "options", "patch", "post", "put", "trace"] enabled_tools: List[Literal["execute-request", "get-mini-openapi-spec"]] = FieldInfo(alias="enabledTools") -class Version(BaseModel): +class Version(BaseModel): uid: str created_at: float = FieldInfo(alias="createdAt") @@ -44,8 +44,8 @@ class Version(BaseModel): version_sha: Optional[str] = FieldInfo(alias="versionSha", default=None) -class APIDocument(BaseModel): +class APIDocument(BaseModel): uid: str version: Version @@ -65,5 +65,4 @@ class APIDocument(BaseModel): versions: List[Version] - RegistryListAPIDocumentsResponse: TypeAlias = List[APIDocument] diff --git a/src/types/registry_update_api_document_params.py b/src/types/registry_update_api_document_params.py index 3dd61d0..786718a 100644 --- a/src/types/registry_update_api_document_params.py +++ b/src/types/registry_update_api_document_params.py @@ -10,7 +10,6 @@ class RegistryUpdateAPIDocumentParams(TypedDict, total=False): - namespace: Required[str] title: str diff --git a/src/types/registry_update_api_document_version_params.py b/src/types/registry_update_api_document_version_params.py index e53b7b6..2c42470 100644 --- a/src/types/registry_update_api_document_version_params.py +++ b/src/types/registry_update_api_document_version_params.py @@ -10,7 +10,6 @@ class RegistryUpdateAPIDocumentVersionParams(TypedDict, total=False): - namespace: Required[str] slug: Required[str] diff --git a/src/types/registry_update_api_document_version_response.py b/src/types/registry_update_api_document_version_response.py index c81d6e7..f973a71 100644 --- a/src/types/registry_update_api_document_version_response.py +++ b/src/types/registry_update_api_document_version_response.py @@ -6,13 +6,10 @@ __all__ = ["RegistryUpdateAPIDocumentVersionResponse"] -class RegistryUpdateAPIDocumentVersionResponse(BaseModel): +class RegistryUpdateAPIDocumentVersionResponse(BaseModel): json_sha: str = FieldInfo(alias="jsonSha") yaml_sha: str = FieldInfo(alias="yamlSha") version_sha: str = FieldInfo(alias="versionSha") - - - diff --git a/src/types/rule_create_ruleset_access_group_params.py b/src/types/rule_create_ruleset_access_group_params.py index 992550d..a08874d 100644 --- a/src/types/rule_create_ruleset_access_group_params.py +++ b/src/types/rule_create_ruleset_access_group_params.py @@ -12,7 +12,6 @@ class RuleCreateRulesetAccessGroupParams(TypedDict, total=False): - namespace: Required[str] access_group_slug: Required[Annotated[Slug, PropertyInfo(alias="accessGroupSlug")]] diff --git a/src/types/rule_create_ruleset_params.py b/src/types/rule_create_ruleset_params.py index f7bedb5..2de8dcb 100644 --- a/src/types/rule_create_ruleset_params.py +++ b/src/types/rule_create_ruleset_params.py @@ -10,7 +10,6 @@ class RuleCreateRulesetParams(TypedDict, total=False): - title: Required[str] description: str diff --git a/src/types/rule_create_ruleset_response.py b/src/types/rule_create_ruleset_response.py index 79b42b3..a8f04de 100644 --- a/src/types/rule_create_ruleset_response.py +++ b/src/types/rule_create_ruleset_response.py @@ -6,5 +6,4 @@ class RuleCreateRulesetResponse(BaseModel): - uid: str diff --git a/src/types/rule_delete_ruleset_access_group_params.py b/src/types/rule_delete_ruleset_access_group_params.py index ee9880d..e1fed5c 100644 --- a/src/types/rule_delete_ruleset_access_group_params.py +++ b/src/types/rule_delete_ruleset_access_group_params.py @@ -12,7 +12,6 @@ class RuleDeleteRulesetAccessGroupParams(TypedDict, total=False): - namespace: Required[str] access_group_slug: Required[Annotated[Slug, PropertyInfo(alias="accessGroupSlug")]] diff --git a/src/types/rule_list_rulesets_response.py b/src/types/rule_list_rulesets_response.py index 9322deb..6c7c4a6 100644 --- a/src/types/rule_list_rulesets_response.py +++ b/src/types/rule_list_rulesets_response.py @@ -11,8 +11,8 @@ __all__ = ["RuleListRulesetsResponse", "Rule"] -class Rule(BaseModel): +class Rule(BaseModel): uid: str title: str @@ -26,5 +26,4 @@ class Rule(BaseModel): is_private: bool = FieldInfo(alias="isPrivate") - RuleListRulesetsResponse: TypeAlias = List[Rule] diff --git a/src/types/rule_update_ruleset_params.py b/src/types/rule_update_ruleset_params.py index 56eacd5..78d5152 100644 --- a/src/types/rule_update_ruleset_params.py +++ b/src/types/rule_update_ruleset_params.py @@ -10,7 +10,6 @@ class RuleUpdateRulesetParams(TypedDict, total=False): - path_namespace: Required[Annotated[str, PropertyInfo(alias="namespace")]] body_namespace: Annotated[str, PropertyInfo(alias="namespace")] diff --git a/src/types/scalar_doc_create_guide_params.py b/src/types/scalar_doc_create_guide_params.py index 305cb97..307a01c 100644 --- a/src/types/scalar_doc_create_guide_params.py +++ b/src/types/scalar_doc_create_guide_params.py @@ -13,7 +13,6 @@ class ScalarDocCreateGuideParams(TypedDict, total=False): - name: Required[str] slug: Slug diff --git a/src/types/scalar_doc_create_guide_response.py b/src/types/scalar_doc_create_guide_response.py index 7011b2f..c2ee675 100644 --- a/src/types/scalar_doc_create_guide_response.py +++ b/src/types/scalar_doc_create_guide_response.py @@ -4,11 +4,8 @@ __all__ = ["ScalarDocCreateGuideResponse"] -class ScalarDocCreateGuideResponse(BaseModel): +class ScalarDocCreateGuideResponse(BaseModel): uid: str slug: str - - - diff --git a/src/types/scalar_doc_list_guides_response.py b/src/types/scalar_doc_list_guides_response.py index 49c438b..cda031c 100644 --- a/src/types/scalar_doc_list_guides_response.py +++ b/src/types/scalar_doc_list_guides_response.py @@ -13,8 +13,8 @@ __all__ = ["ScalarDocListGuidesResponse", "GithubProject", "ActiveDeployment", "Repository"] -class Repository(BaseModel): +class Repository(BaseModel): linked_by: str = FieldInfo(alias="linkedBy") id: float @@ -33,16 +33,16 @@ class Repository(BaseModel): expired: bool -class ActiveDeployment(BaseModel): +class ActiveDeployment(BaseModel): uid: str domain: str published_at: int = FieldInfo(alias="publishedAt") -class GithubProject(BaseModel): +class GithubProject(BaseModel): uid: str created_at: int = FieldInfo(alias="createdAt") @@ -78,5 +78,4 @@ class GithubProject(BaseModel): repository: Optional[Repository] = None - ScalarDocListGuidesResponse: TypeAlias = List[GithubProject] diff --git a/src/types/scalar_doc_publish_guide_response.py b/src/types/scalar_doc_publish_guide_response.py index 3744141..d8201d6 100644 --- a/src/types/scalar_doc_publish_guide_response.py +++ b/src/types/scalar_doc_publish_guide_response.py @@ -6,9 +6,6 @@ __all__ = ["ScalarDocPublishGuideResponse"] -class ScalarDocPublishGuideResponse(BaseModel): +class ScalarDocPublishGuideResponse(BaseModel): publish_uid: str = FieldInfo(alias="publishUid") - - - diff --git a/src/types/schema_create_params.py b/src/types/schema_create_params.py index 7a849aa..89ebbfa 100644 --- a/src/types/schema_create_params.py +++ b/src/types/schema_create_params.py @@ -12,7 +12,6 @@ class SchemaCreateParams(TypedDict, total=False): - title: Required[str] description: str diff --git a/src/types/schema_create_response.py b/src/types/schema_create_response.py index 1c6fdef..68b0d42 100644 --- a/src/types/schema_create_response.py +++ b/src/types/schema_create_response.py @@ -6,5 +6,4 @@ class SchemaCreateResponse(BaseModel): - uid: str diff --git a/src/types/schema_list_response.py b/src/types/schema_list_response.py index 2f34012..f916d9b 100644 --- a/src/types/schema_list_response.py +++ b/src/types/schema_list_response.py @@ -14,8 +14,8 @@ __all__ = ["SchemaListResponse", "Schema", "Version"] -class Version(BaseModel): +class Version(BaseModel): uid: str created_at: int = FieldInfo(alias="createdAt") @@ -24,8 +24,8 @@ class Version(BaseModel): version: Version -class Schema(BaseModel): +class Schema(BaseModel): uid: str title: str @@ -41,5 +41,4 @@ class Schema(BaseModel): versions: List[Version] - SchemaListResponse: TypeAlias = List[Schema] diff --git a/src/types/schema_update_params.py b/src/types/schema_update_params.py index 960deec..1c68169 100644 --- a/src/types/schema_update_params.py +++ b/src/types/schema_update_params.py @@ -10,7 +10,6 @@ class SchemaUpdateParams(TypedDict, total=False): - namespace: Required[str] title: str diff --git a/src/types/schemas/access_group_create_schema_params.py b/src/types/schemas/access_group_create_schema_params.py index 48160fc..462e250 100644 --- a/src/types/schemas/access_group_create_schema_params.py +++ b/src/types/schemas/access_group_create_schema_params.py @@ -12,7 +12,6 @@ class AccessGroupCreateSchemaParams(TypedDict, total=False): - namespace: Required[str] access_group_slug: Required[Annotated[Slug, PropertyInfo(alias="accessGroupSlug")]] diff --git a/src/types/schemas/access_group_delete_schema_params.py b/src/types/schemas/access_group_delete_schema_params.py index 03782f7..0085d51 100644 --- a/src/types/schemas/access_group_delete_schema_params.py +++ b/src/types/schemas/access_group_delete_schema_params.py @@ -12,7 +12,6 @@ class AccessGroupDeleteSchemaParams(TypedDict, total=False): - namespace: Required[str] access_group_slug: Required[Annotated[Slug, PropertyInfo(alias="accessGroupSlug")]] diff --git a/src/types/schemas/version_create_schema_params.py b/src/types/schemas/version_create_schema_params.py index 6a29dbc..d366b33 100644 --- a/src/types/schemas/version_create_schema_params.py +++ b/src/types/schemas/version_create_schema_params.py @@ -10,7 +10,6 @@ class VersionCreateSchemaParams(TypedDict, total=False): - namespace: Required[str] version: Required[Version] diff --git a/src/types/schemas/version_create_schema_response.py b/src/types/schemas/version_create_schema_response.py index 3e54917..7a2190e 100644 --- a/src/types/schemas/version_create_schema_response.py +++ b/src/types/schemas/version_create_schema_response.py @@ -6,5 +6,4 @@ class VersionCreateSchemaResponse(BaseModel): - uid: str diff --git a/src/types/team_list_response.py b/src/types/team_list_response.py index 0d71143..3e2e363 100644 --- a/src/types/team_list_response.py +++ b/src/types/team_list_response.py @@ -11,8 +11,8 @@ __all__ = ["TeamListResponse", "Team"] -class Team(BaseModel): +class Team(BaseModel): uid: str name: str @@ -24,5 +24,4 @@ class Team(BaseModel): theme: str - TeamListResponse: TypeAlias = List[Team] diff --git a/src/types/theme_create_params.py b/src/types/theme_create_params.py index 9e1c513..77bf9e3 100644 --- a/src/types/theme_create_params.py +++ b/src/types/theme_create_params.py @@ -8,7 +8,6 @@ class ThemeCreateParams(TypedDict, total=False): - name: Required[str] description: str diff --git a/src/types/theme_create_response.py b/src/types/theme_create_response.py index d00d052..d6e68ef 100644 --- a/src/types/theme_create_response.py +++ b/src/types/theme_create_response.py @@ -6,5 +6,4 @@ class ThemeCreateResponse(BaseModel): - uid: str diff --git a/src/types/theme_list_response.py b/src/types/theme_list_response.py index 484e3e2..a3c7112 100644 --- a/src/types/theme_list_response.py +++ b/src/types/theme_list_response.py @@ -9,8 +9,8 @@ __all__ = ["ThemeListResponse", "Theme"] -class Theme(BaseModel): +class Theme(BaseModel): uid: str name: str @@ -20,5 +20,4 @@ class Theme(BaseModel): slug: Slug - ThemeListResponse: TypeAlias = List[Theme] diff --git a/src/types/theme_replace_document_params.py b/src/types/theme_replace_document_params.py index 8f41750..44ea6f2 100644 --- a/src/types/theme_replace_document_params.py +++ b/src/types/theme_replace_document_params.py @@ -8,5 +8,4 @@ class ThemeReplaceDocumentParams(TypedDict, total=False): - document: Required[str] diff --git a/src/types/theme_update_params.py b/src/types/theme_update_params.py index d7b438b..03d7fed 100644 --- a/src/types/theme_update_params.py +++ b/src/types/theme_update_params.py @@ -8,7 +8,6 @@ class ThemeUpdateParams(TypedDict, total=False): - name: str description: str diff --git a/tests/smoke-test.py b/tests/smoke-test.py index 64ba0c2..6ee31ff 100644 --- a/tests/smoke-test.py +++ b/tests/smoke-test.py @@ -40,11 +40,13 @@ class SmokeCase(TypedDict): def _smoke_case_0() -> None: registry = client.registry.list_all_api_documents() + def _smoke_case_1() -> None: registry = client.registry.list_api_documents( namespace="namespace", ) + def _smoke_case_2() -> None: registry = client.registry.create_api_document( namespace="namespace", @@ -54,18 +56,21 @@ def _smoke_case_2() -> None: document="", ) + def _smoke_case_3() -> None: registry = client.registry.update_api_document( namespace="namespace", slug="slug", ) + def _smoke_case_4() -> None: registry = client.registry.delete_api_document( namespace="namespace", slug="slug", ) + def _smoke_case_5() -> None: registry = client.registry.retrieve_api_document_version( namespace="namespace", @@ -73,6 +78,7 @@ def _smoke_case_5() -> None: semver="semver", ) + def _smoke_case_6() -> None: registry = client.registry.update_api_document_version( namespace="namespace", @@ -81,6 +87,7 @@ def _smoke_case_6() -> None: document="", ) + def _smoke_case_7() -> None: registry = client.registry.delete_api_document_version( namespace="namespace", @@ -88,6 +95,7 @@ def _smoke_case_7() -> None: semver="semver", ) + def _smoke_case_8() -> None: registry = client.registry.list_api_document_version_metadata( namespace="namespace", @@ -95,6 +103,7 @@ def _smoke_case_8() -> None: semver="semver", ) + def _smoke_case_9() -> None: registry = client.registry.create_api_document_version( namespace="namespace", @@ -103,6 +112,7 @@ def _smoke_case_9() -> None: document="", ) + def _smoke_case_10() -> None: registry = client.registry.create_api_document_access_group( namespace="namespace", @@ -110,6 +120,7 @@ def _smoke_case_10() -> None: access_group_slug="xxx", ) + def _smoke_case_11() -> None: registry = client.registry.delete_api_document_access_group( namespace="namespace", @@ -117,11 +128,13 @@ def _smoke_case_11() -> None: access_group_slug="xxx", ) + def _smoke_case_12() -> None: schema = client.schemas.list( namespace="namespace", ) + def _smoke_case_13() -> None: schema = client.schemas.create( namespace="namespace", @@ -131,18 +144,21 @@ def _smoke_case_13() -> None: document="", ) + def _smoke_case_14() -> None: schema = client.schemas.update( namespace="namespace", slug="slug", ) + def _smoke_case_15() -> None: schema = client.schemas.delete( namespace="namespace", slug="slug", ) + def _smoke_case_16() -> None: version = client.schemas.version.retrieve_schema( namespace="namespace", @@ -150,6 +166,7 @@ def _smoke_case_16() -> None: semver="semver", ) + def _smoke_case_17() -> None: version = client.schemas.version.delete_schema( namespace="namespace", @@ -157,6 +174,7 @@ def _smoke_case_17() -> None: semver="semver", ) + def _smoke_case_18() -> None: version = client.schemas.version.create_schema( namespace="namespace", @@ -165,6 +183,7 @@ def _smoke_case_18() -> None: document="", ) + def _smoke_case_19() -> None: access_group = client.schemas.access_group.create_schema( namespace="namespace", @@ -172,6 +191,7 @@ def _smoke_case_19() -> None: access_group_slug="xxx", ) + def _smoke_case_20() -> None: access_group = client.schemas.access_group.delete_schema( namespace="namespace", @@ -179,37 +199,71 @@ def _smoke_case_20() -> None: access_group_slug="xxx", ) + def _smoke_case_21() -> None: login_portal = client.login_portals.retrieve( slug="slug", ) + def _smoke_case_22() -> None: login_portal = client.login_portals.update( slug="slug", ) + def _smoke_case_23() -> None: login_portal = client.login_portals.delete( slug="slug", ) + def _smoke_case_24() -> None: login_portal = client.login_portals.create( title="", slug="", - email={"logo": "", "logo_size": "100", "button_text": "Login", "message": "Click to access private documentation hosted by scalar.com", "title": "Private Docs", "main_color": "#2a2f45", "main_background": "#f6f6f6", "card_color": "2a2f45", "card_background": "#fff", "button_color": "#fff", "button_background": "#0f0f0f"}, - page={"title": "Scalar Private Docs", "description": "Login to access your documentation", "head": "", "script": "", "theme": "", "company_name": "", "logo": "", "logo_url": "", "favicon": "", "terms_link": "", "privacy_link": "", "form_title": "Scalar Private Docs", "form_description": "Login to access your documentation", "form_image": ""}, + email={ + "logo": "", + "logo_size": "100", + "button_text": "Login", + "message": "Click to access private documentation hosted by scalar.com", + "title": "Private Docs", + "main_color": "#2a2f45", + "main_background": "#f6f6f6", + "card_color": "2a2f45", + "card_background": "#fff", + "button_color": "#fff", + "button_background": "#0f0f0f", + }, + page={ + "title": "Scalar Private Docs", + "description": "Login to access your documentation", + "head": "", + "script": "", + "theme": "", + "company_name": "", + "logo": "", + "logo_url": "", + "favicon": "", + "terms_link": "", + "privacy_link": "", + "form_title": "Scalar Private Docs", + "form_description": "Login to access your documentation", + "form_image": "", + }, ) + def _smoke_case_25() -> None: login_portal = client.login_portals.list() + def _smoke_case_26() -> None: rule = client.rules.list_rulesets( namespace="namespace", ) + def _smoke_case_27() -> None: rule = client.rules.create_ruleset( namespace="namespace", @@ -218,24 +272,28 @@ def _smoke_case_27() -> None: document="", ) + def _smoke_case_28() -> None: rule = client.rules.update_ruleset( path_namespace="namespace", path_slug="slug", ) + def _smoke_case_29() -> None: rule = client.rules.delete_ruleset( namespace="namespace", slug="slug", ) + def _smoke_case_30() -> None: rule = client.rules.retrieve_ruleset_document( namespace="namespace", slug="slug", ) + def _smoke_case_31() -> None: rule = client.rules.create_ruleset_access_group( namespace="namespace", @@ -243,6 +301,7 @@ def _smoke_case_31() -> None: access_group_slug="xxx", ) + def _smoke_case_32() -> None: rule = client.rules.delete_ruleset_access_group( namespace="namespace", @@ -250,9 +309,11 @@ def _smoke_case_32() -> None: access_group_slug="xxx", ) + def _smoke_case_33() -> None: theme = client.themes.list() + def _smoke_case_34() -> None: theme = client.themes.create( name="", @@ -260,33 +321,40 @@ def _smoke_case_34() -> None: document="", ) + def _smoke_case_35() -> None: theme = client.themes.update( slug="slug", ) + def _smoke_case_36() -> None: theme = client.themes.replace_document( slug="slug", document="", ) + def _smoke_case_37() -> None: theme = client.themes.delete( slug="slug", ) + def _smoke_case_38() -> None: theme = client.themes.retrieve( slug="slug", ) + def _smoke_case_39() -> None: team = client.teams.list() + def _smoke_case_40() -> None: scalar_doc = client.scalar_docs.list_guides() + def _smoke_case_41() -> None: scalar_doc = client.scalar_docs.create_guide( name="", @@ -295,19 +363,23 @@ def _smoke_case_41() -> None: allowed_domains=[], ) + def _smoke_case_42() -> None: scalar_doc = client.scalar_docs.publish_guide( slug="slug", ) + def _smoke_case_43() -> None: namespace = client.namespaces.list() + def _smoke_case_44() -> None: authentication = client.authentication.exchange_personal_token( personal_token="", ) + def _smoke_case_45() -> None: authentication = client.authentication.list_current_user() @@ -319,322 +391,276 @@ def _smoke_case_45() -> None: "path": "/v1/apis", "run": _smoke_case_0, }, - { "operation": "listApiDocuments", "method": "GET", "path": "/v1/apis/{namespace}", "run": _smoke_case_1, }, - { "operation": "createApiDocument", "method": "POST", "path": "/v1/apis/{namespace}", "run": _smoke_case_2, }, - { "operation": "updateApiDocument", "method": "PATCH", "path": "/v1/apis/{namespace}/{slug}", "run": _smoke_case_3, }, - { "operation": "deleteApiDocument", "method": "DELETE", "path": "/v1/apis/{namespace}/{slug}", "run": _smoke_case_4, }, - { "operation": "retrieveApiDocumentVersion", "method": "GET", "path": "/v1/apis/{namespace}/{slug}/version/{semver}", "run": _smoke_case_5, }, - { "operation": "updateApiDocumentVersion", "method": "PATCH", "path": "/v1/apis/{namespace}/{slug}/version/{semver}", "run": _smoke_case_6, }, - { "operation": "deleteApiDocumentVersion", "method": "DELETE", "path": "/v1/apis/{namespace}/{slug}/version/{semver}", "run": _smoke_case_7, }, - { "operation": "listApiDocumentVersionMetadata", "method": "GET", "path": "/v1/apis/{namespace}/{slug}/version/{semver}/metadata", "run": _smoke_case_8, }, - { "operation": "createApiDocumentVersion", "method": "POST", "path": "/v1/apis/{namespace}/{slug}/version", "run": _smoke_case_9, }, - { "operation": "createApiDocumentAccessGroup", "method": "POST", "path": "/v1/apis/{namespace}/{slug}/access-group", "run": _smoke_case_10, }, - { "operation": "deleteApiDocumentAccessGroup", "method": "DELETE", "path": "/v1/apis/{namespace}/{slug}/access-group", "run": _smoke_case_11, }, - { "operation": "list", "method": "GET", "path": "/v1/schemas/{namespace}", "run": _smoke_case_12, }, - { "operation": "create", "method": "POST", "path": "/v1/schemas/{namespace}", "run": _smoke_case_13, }, - { "operation": "update", "method": "PATCH", "path": "/v1/schemas/{namespace}/{slug}", "run": _smoke_case_14, }, - { "operation": "delete", "method": "DELETE", "path": "/v1/schemas/{namespace}/{slug}", "run": _smoke_case_15, }, - { "operation": "retrieveSchema", "method": "GET", "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", "run": _smoke_case_16, }, - { "operation": "deleteSchema", "method": "DELETE", "path": "/v1/schemas/{namespace}/{slug}/version/{semver}", "run": _smoke_case_17, }, - { "operation": "createSchema", "method": "POST", "path": "/v1/schemas/{namespace}/{slug}/version", "run": _smoke_case_18, }, - { "operation": "createSchema", "method": "POST", "path": "/v1/schemas/{namespace}/{slug}/access-group", "run": _smoke_case_19, }, - { "operation": "deleteSchema", "method": "DELETE", "path": "/v1/schemas/{namespace}/{slug}/access-group", "run": _smoke_case_20, }, - { "operation": "retrieve", "method": "GET", "path": "/v1/login-portals/{slug}", "run": _smoke_case_21, }, - { "operation": "update", "method": "PATCH", "path": "/v1/login-portals/{slug}", "run": _smoke_case_22, }, - { "operation": "delete", "method": "DELETE", "path": "/v1/login-portals/{slug}", "run": _smoke_case_23, }, - { "operation": "create", "method": "POST", "path": "/v1/login-portals", "run": _smoke_case_24, }, - { "operation": "list", "method": "GET", "path": "/v1/login-portals", "run": _smoke_case_25, }, - { "operation": "listRulesets", "method": "GET", "path": "/v1/rulesets/{namespace}", "run": _smoke_case_26, }, - { "operation": "createRuleset", "method": "POST", "path": "/v1/rulesets/{namespace}", "run": _smoke_case_27, }, - { "operation": "updateRuleset", "method": "PATCH", "path": "/v1/rulesets/{namespace}/{slug}", "run": _smoke_case_28, }, - { "operation": "deleteRuleset", "method": "DELETE", "path": "/v1/rulesets/{namespace}/{slug}", "run": _smoke_case_29, }, - { "operation": "retrieveRulesetDocument", "method": "GET", "path": "/v1/rulesets/{namespace}/{slug}", "run": _smoke_case_30, }, - { "operation": "createRulesetAccessGroup", "method": "POST", "path": "/v1/rulesets/{namespace}/{slug}/access-group", "run": _smoke_case_31, }, - { "operation": "deleteRulesetAccessGroup", "method": "DELETE", "path": "/v1/rulesets/{namespace}/{slug}/access-group", "run": _smoke_case_32, }, - { "operation": "list", "method": "GET", "path": "/v1/themes", "run": _smoke_case_33, }, - { "operation": "create", "method": "POST", "path": "/v1/themes", "run": _smoke_case_34, }, - { "operation": "update", "method": "PATCH", "path": "/v1/themes/{slug}", "run": _smoke_case_35, }, - { "operation": "replaceDocument", "method": "PUT", "path": "/v1/themes/{slug}", "run": _smoke_case_36, }, - { "operation": "delete", "method": "DELETE", "path": "/v1/themes/{slug}", "run": _smoke_case_37, }, - { "operation": "retrieve", "method": "GET", "path": "/v1/themes/{slug}", "run": _smoke_case_38, }, - { "operation": "list", "method": "GET", "path": "/v1/teams", "run": _smoke_case_39, }, - { "operation": "listGuides", "method": "GET", "path": "/v1/guides", "run": _smoke_case_40, }, - { "operation": "createGuide", "method": "POST", "path": "/v1/guides", "run": _smoke_case_41, }, - { "operation": "publishGuide", "method": "POST", "path": "/v1/guides/{slug}/publish", "run": _smoke_case_42, }, - { "operation": "list", "method": "GET", "path": "/v1/namespaces", "run": _smoke_case_43, }, - { "operation": "exchangePersonalToken", "method": "POST", "path": "/v1/auth/exchange", "run": _smoke_case_44, }, - { "operation": "listCurrentUser", "method": "GET", "path": "/v1/auth/me", "run": _smoke_case_45, }, - ] DEFAULT_SMOKE_CONCURRENCY = 32 @@ -645,11 +671,7 @@ def _selected_cases() -> list[SmokeCase]: needles = [needle.strip() for needle in filter_value.split(",") if needle.strip()] if filter_value else [] if not needles: return cases - return [ - case - for case in cases - if any(needle in case["operation"] or needle in case["path"] for needle in needles) - ] + return [case for case in cases if any(needle in case["operation"] or needle in case["path"] for needle in needles)] def _smoke_concurrency(case_count: int) -> int: @@ -699,13 +721,18 @@ def main() -> None: report_path = os.environ.get("SCALAR_SMOKE_REPORT") if report_path: - Path(report_path).write_text(json.dumps({"total": len(results), "failed": len(failed), "results": results}), encoding="utf-8") + Path(report_path).write_text( + json.dumps({"total": len(results), "failed": len(failed), "results": results}), encoding="utf-8" + ) else: for result in results: if result["status"] == "passed": print(f"PASS {result['operation']} ({result['method']} {result['path']}) {result['durationMs']}ms") else: - print(f"FAIL {result['operation']} ({result['method']} {result['path']})\n{result.get('error', '')}", file=sys.stderr) + print( + f"FAIL {result['operation']} ({result['method']} {result['path']})\n{result.get('error', '')}", + file=sys.stderr, + ) if not results: print("No code samples ran (empty SDK or a SCALAR_SMOKE_FILTER that matched nothing).", file=sys.stderr) else: