diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index d03365a2bd..8ea34be96f 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -7,6 +7,10 @@ RUN apt-get update && apt-get install -y \ yarnpkg \ && apt-get clean autoclean +# Ensure UTF-8 encoding +ENV LANG=C.UTF-8 +ENV LC_ALL=C.UTF-8 + # Yarn RUN ln -sf /usr/bin/yarnpkg /usr/bin/yarn diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2e6d1af638..d4ecbf3e5b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,3 +28,26 @@ jobs: - name: Check types run: | yarn build + + examples: + name: examples + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Node + uses: actions/setup-node@v4 + with: + node-version: '18' + - name: Install dependencies + run: | + yarn install + + - env: + CLOUDFLARE_ACCOUNT_ID: f037e56e89293a057740de681ac9abbe + CLOUDFLARE_EMAIL: terraform-acceptance-test@cfapi.net + CLOUDFLARE_ZONE_ID: 0da42c8d2132a9ddaf714f9e7c92011 + CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }} + run: | + yarn tsn ./examples/workers/ai/demo.ts diff --git a/.gitignore b/.gitignore index 58b3944a13..425a01136c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ dist /deno /*.tgz .idea/ + diff --git a/.prettierignore b/.prettierignore index fc6160fb10..3548c5af9c 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,5 +1,5 @@ CHANGELOG.md -/ecosystem-tests +/ecosystem-tests/*/** /node_modules /deno diff --git a/.release-please-manifest.json b/.release-please-manifest.json index d4f6f2994e..ada7355e0b 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "3.0.0" + ".": "3.1.0" } diff --git a/.stats.yml b/.stats.yml index de12921cd5..860345bb66 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1 +1 @@ -configured_endpoints: 1292 +configured_endpoints: 1266 diff --git a/CHANGELOG.md b/CHANGELOG.md index ca4d5af12f..acba3cc1d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,164 @@ # Changelog +## 3.1.0 (2024-04-23) + +Full Changelog: [v3.0.0...v3.1.0](https://github.com/cloudflare/cloudflare-typescript/compare/v3.0.0...v3.1.0) + +### Features + +* **api:** OpenAPI spec update via Stainless API ([#221](https://github.com/cloudflare/cloudflare-typescript/issues/221)) ([c4d94ec](https://github.com/cloudflare/cloudflare-typescript/commit/c4d94eccfba7b8718ad2a7ba500ac1313ef4b55c)) +* **api:** OpenAPI spec update via Stainless API ([#223](https://github.com/cloudflare/cloudflare-typescript/issues/223)) ([7cfe8f4](https://github.com/cloudflare/cloudflare-typescript/commit/7cfe8f4800a75639d96ac32839d979978b643110)) +* **api:** OpenAPI spec update via Stainless API ([#224](https://github.com/cloudflare/cloudflare-typescript/issues/224)) ([72cb5b4](https://github.com/cloudflare/cloudflare-typescript/commit/72cb5b4d158bf8f35e2ae885abfd1c5a5226b4f0)) +* **api:** OpenAPI spec update via Stainless API ([#225](https://github.com/cloudflare/cloudflare-typescript/issues/225)) ([8d71777](https://github.com/cloudflare/cloudflare-typescript/commit/8d717776225e89aaacdf3a91a62340a1ef5639ec)) +* **api:** OpenAPI spec update via Stainless API ([#226](https://github.com/cloudflare/cloudflare-typescript/issues/226)) ([c6b2a75](https://github.com/cloudflare/cloudflare-typescript/commit/c6b2a75f1838708e40d495e89f7a73ea24b24409)) +* **api:** OpenAPI spec update via Stainless API ([#227](https://github.com/cloudflare/cloudflare-typescript/issues/227)) ([006d524](https://github.com/cloudflare/cloudflare-typescript/commit/006d524d58a7a796e01a23763af2d5c35c10f8c3)) +* **api:** OpenAPI spec update via Stainless API ([#228](https://github.com/cloudflare/cloudflare-typescript/issues/228)) ([613da61](https://github.com/cloudflare/cloudflare-typescript/commit/613da6137afdfb6431dd5b6816fb8d0493b9ed43)) +* **api:** OpenAPI spec update via Stainless API ([#229](https://github.com/cloudflare/cloudflare-typescript/issues/229)) ([2f22b0b](https://github.com/cloudflare/cloudflare-typescript/commit/2f22b0bcdb49c64230abd679eb5127a2e5521913)) +* **api:** OpenAPI spec update via Stainless API ([#237](https://github.com/cloudflare/cloudflare-typescript/issues/237)) ([9013310](https://github.com/cloudflare/cloudflare-typescript/commit/90133103eb5f409540c139f0e59c531f1c17d980)) +* **api:** OpenAPI spec update via Stainless API ([#238](https://github.com/cloudflare/cloudflare-typescript/issues/238)) ([39f4b40](https://github.com/cloudflare/cloudflare-typescript/commit/39f4b409c9701bfaa793856d0c48d2e43434bb07)) +* **api:** OpenAPI spec update via Stainless API ([#239](https://github.com/cloudflare/cloudflare-typescript/issues/239)) ([7c1e66f](https://github.com/cloudflare/cloudflare-typescript/commit/7c1e66f90b47448b8af816059b294cb6adb21bd5)) +* **api:** OpenAPI spec update via Stainless API ([#244](https://github.com/cloudflare/cloudflare-typescript/issues/244)) ([9191ea0](https://github.com/cloudflare/cloudflare-typescript/commit/9191ea09d18321d83e4fe9065a00515498eb2399)) +* **api:** OpenAPI spec update via Stainless API ([#285](https://github.com/cloudflare/cloudflare-typescript/issues/285)) ([e9b10b4](https://github.com/cloudflare/cloudflare-typescript/commit/e9b10b4dfff83da4655b68c86812d3d3647cbd91)) +* **api:** OpenAPI spec update via Stainless API ([#290](https://github.com/cloudflare/cloudflare-typescript/issues/290)) ([9187feb](https://github.com/cloudflare/cloudflare-typescript/commit/9187feb8af2fba1da7bde0cbc593187010383d3e)) +* **api:** OpenAPI spec update via Stainless API ([#291](https://github.com/cloudflare/cloudflare-typescript/issues/291)) ([bb16aeb](https://github.com/cloudflare/cloudflare-typescript/commit/bb16aebcd0767cc392d5fe4e1f31cabbfbf7a2dc)) +* **api:** OpenAPI spec update via Stainless API ([#292](https://github.com/cloudflare/cloudflare-typescript/issues/292)) ([d7b5433](https://github.com/cloudflare/cloudflare-typescript/commit/d7b543371ab2ba7e90db70f528d136363fc92769)) +* **api:** OpenAPI spec update via Stainless API ([#293](https://github.com/cloudflare/cloudflare-typescript/issues/293)) ([aab12f6](https://github.com/cloudflare/cloudflare-typescript/commit/aab12f664530b2c08d63eaffaba014a954ba1fc4)) +* **api:** OpenAPI spec update via Stainless API ([#294](https://github.com/cloudflare/cloudflare-typescript/issues/294)) ([c5f75c6](https://github.com/cloudflare/cloudflare-typescript/commit/c5f75c648c48dff51bc517844911fd7b64c02adb)) +* **api:** OpenAPI spec update via Stainless API ([#295](https://github.com/cloudflare/cloudflare-typescript/issues/295)) ([df66312](https://github.com/cloudflare/cloudflare-typescript/commit/df66312c7f4f12f4627d9eb7dbaa810b49586557)) +* **api:** OpenAPI spec update via Stainless API ([#316](https://github.com/cloudflare/cloudflare-typescript/issues/316)) ([70f4748](https://github.com/cloudflare/cloudflare-typescript/commit/70f47485c6769c856d59d4d7a907193e4d68cfea)) +* **api:** OpenAPI spec update via Stainless API ([#317](https://github.com/cloudflare/cloudflare-typescript/issues/317)) ([e6ac75b](https://github.com/cloudflare/cloudflare-typescript/commit/e6ac75b1d3a570a919e49e1879a3ea205af1a90d)) +* **api:** OpenAPI spec update via Stainless API ([#318](https://github.com/cloudflare/cloudflare-typescript/issues/318)) ([ce63512](https://github.com/cloudflare/cloudflare-typescript/commit/ce635120e3d8fa74e7ca7a49ea473da643e44f7c)) +* **api:** OpenAPI spec update via Stainless API ([#319](https://github.com/cloudflare/cloudflare-typescript/issues/319)) ([5e43d81](https://github.com/cloudflare/cloudflare-typescript/commit/5e43d81ee3b35a8ddb0806798352debafa3f3070)) +* **api:** OpenAPI spec update via Stainless API ([#320](https://github.com/cloudflare/cloudflare-typescript/issues/320)) ([87135d2](https://github.com/cloudflare/cloudflare-typescript/commit/87135d290c4f049d4996b38130624be2448db0b7)) +* **api:** OpenAPI spec update via Stainless API ([#321](https://github.com/cloudflare/cloudflare-typescript/issues/321)) ([554b69e](https://github.com/cloudflare/cloudflare-typescript/commit/554b69efbef1cd19ba58ffbd056c4807431dc776)) +* **api:** OpenAPI spec update via Stainless API ([#332](https://github.com/cloudflare/cloudflare-typescript/issues/332)) ([c3f1288](https://github.com/cloudflare/cloudflare-typescript/commit/c3f1288dc53a2f07c306f702222ef4b2fcad9c58)) +* **api:** OpenAPI spec update via Stainless API ([#334](https://github.com/cloudflare/cloudflare-typescript/issues/334)) ([c6d52a1](https://github.com/cloudflare/cloudflare-typescript/commit/c6d52a14488186947a9eece590931a75f086e3b5)) +* **api:** OpenAPI spec update via Stainless API ([#335](https://github.com/cloudflare/cloudflare-typescript/issues/335)) ([4a7d801](https://github.com/cloudflare/cloudflare-typescript/commit/4a7d801005c1fdd70a2cb5bcee8dd5790ae1fcfc)) +* **api:** OpenAPI spec update via Stainless API ([#336](https://github.com/cloudflare/cloudflare-typescript/issues/336)) ([24cf070](https://github.com/cloudflare/cloudflare-typescript/commit/24cf070de97960f74e6966248e9a3f065806ffe2)) +* **api:** OpenAPI spec update via Stainless API ([#337](https://github.com/cloudflare/cloudflare-typescript/issues/337)) ([d54ce52](https://github.com/cloudflare/cloudflare-typescript/commit/d54ce52c655efa03e2ddea474a66e0e5a5ef01e4)) +* **api:** OpenAPI spec update via Stainless API ([#338](https://github.com/cloudflare/cloudflare-typescript/issues/338)) ([14e5fed](https://github.com/cloudflare/cloudflare-typescript/commit/14e5fed94150a06729eab08055de5e4f6fac652d)) +* **api:** OpenAPI spec update via Stainless API ([#340](https://github.com/cloudflare/cloudflare-typescript/issues/340)) ([6f29f9f](https://github.com/cloudflare/cloudflare-typescript/commit/6f29f9f13ff96322a7bc9037c4e61fe7d8b8c7f2)) +* **api:** OpenAPI spec update via Stainless API ([#341](https://github.com/cloudflare/cloudflare-typescript/issues/341)) ([bd5fdbd](https://github.com/cloudflare/cloudflare-typescript/commit/bd5fdbdde465e1636d1b120b3039edd3726a102d)) +* **api:** OpenAPI spec update via Stainless API ([#342](https://github.com/cloudflare/cloudflare-typescript/issues/342)) ([a001213](https://github.com/cloudflare/cloudflare-typescript/commit/a001213ba23f122e68372ee7c10c4a803fe855a2)) +* **api:** OpenAPI spec update via Stainless API ([#343](https://github.com/cloudflare/cloudflare-typescript/issues/343)) ([3a16b16](https://github.com/cloudflare/cloudflare-typescript/commit/3a16b163560f8d34fcd9a9e542d97422e40222bb)) +* **api:** OpenAPI spec update via Stainless API ([#344](https://github.com/cloudflare/cloudflare-typescript/issues/344)) ([034877e](https://github.com/cloudflare/cloudflare-typescript/commit/034877e52c8a2862dcb1ad212e0767b948c78dc0)) +* **api:** OpenAPI spec update via Stainless API ([#345](https://github.com/cloudflare/cloudflare-typescript/issues/345)) ([c9247fa](https://github.com/cloudflare/cloudflare-typescript/commit/c9247faa293ffb4e4196cb7ee4c34fad6a645599)) +* **api:** OpenAPI spec update via Stainless API ([#346](https://github.com/cloudflare/cloudflare-typescript/issues/346)) ([953b5b0](https://github.com/cloudflare/cloudflare-typescript/commit/953b5b02af184b4b458d1f16b995b18a0aedb5c0)) +* **api:** OpenAPI spec update via Stainless API ([#347](https://github.com/cloudflare/cloudflare-typescript/issues/347)) ([97f6cf1](https://github.com/cloudflare/cloudflare-typescript/commit/97f6cf14d940e79fad1396a9372f36414a9a427e)) +* **api:** OpenAPI spec update via Stainless API ([#348](https://github.com/cloudflare/cloudflare-typescript/issues/348)) ([225e487](https://github.com/cloudflare/cloudflare-typescript/commit/225e487ccf186f18088cfb3089cc73a46d5db7f4)) +* **api:** OpenAPI spec update via Stainless API ([#349](https://github.com/cloudflare/cloudflare-typescript/issues/349)) ([865bfbe](https://github.com/cloudflare/cloudflare-typescript/commit/865bfbe07515b95c1649bcf3a0ce3c677222ea8e)) +* **api:** OpenAPI spec update via Stainless API ([#350](https://github.com/cloudflare/cloudflare-typescript/issues/350)) ([63c0da2](https://github.com/cloudflare/cloudflare-typescript/commit/63c0da2f205171de87207f50157f0b50d2b946c8)) +* **api:** OpenAPI spec update via Stainless API ([#355](https://github.com/cloudflare/cloudflare-typescript/issues/355)) ([5e7b68a](https://github.com/cloudflare/cloudflare-typescript/commit/5e7b68acdc1581f0c4ee4be2fef56ece92c8d6c7)) +* **api:** OpenAPI spec update via Stainless API ([#362](https://github.com/cloudflare/cloudflare-typescript/issues/362)) ([2024ee4](https://github.com/cloudflare/cloudflare-typescript/commit/2024ee426686ecb8931803111c30bf94104e0235)) +* **api:** OpenAPI spec update via Stainless API ([#363](https://github.com/cloudflare/cloudflare-typescript/issues/363)) ([72ce33c](https://github.com/cloudflare/cloudflare-typescript/commit/72ce33ce57ec3342e1e2c3878d884aaee1867bdd)) +* **api:** OpenAPI spec update via Stainless API ([#364](https://github.com/cloudflare/cloudflare-typescript/issues/364)) ([78b0049](https://github.com/cloudflare/cloudflare-typescript/commit/78b00499e2c08bcde5563b195abc683af808abbf)) +* **api:** OpenAPI spec update via Stainless API ([#370](https://github.com/cloudflare/cloudflare-typescript/issues/370)) ([9df7463](https://github.com/cloudflare/cloudflare-typescript/commit/9df746309d95cffc95c76187618ac40b5108851c)) +* **api:** update via SDK Studio ([#230](https://github.com/cloudflare/cloudflare-typescript/issues/230)) ([bf7ce08](https://github.com/cloudflare/cloudflare-typescript/commit/bf7ce086d0a54ce8bacfd905786683517b4bb8fe)) +* **api:** update via SDK Studio ([#232](https://github.com/cloudflare/cloudflare-typescript/issues/232)) ([278f0e3](https://github.com/cloudflare/cloudflare-typescript/commit/278f0e38d4d5038208aa0fdd306c266a143ea4c5)) +* **api:** update via SDK Studio ([#233](https://github.com/cloudflare/cloudflare-typescript/issues/233)) ([faa2f33](https://github.com/cloudflare/cloudflare-typescript/commit/faa2f338eff9b10264975386e45285fbc9c65eb1)) +* **api:** update via SDK Studio ([#234](https://github.com/cloudflare/cloudflare-typescript/issues/234)) ([c9a9a70](https://github.com/cloudflare/cloudflare-typescript/commit/c9a9a70d3d0a1d60f0ffd6dd77c9bbff7428dba4)) +* **api:** update via SDK Studio ([#235](https://github.com/cloudflare/cloudflare-typescript/issues/235)) ([22fd73c](https://github.com/cloudflare/cloudflare-typescript/commit/22fd73c8547595bcc61e47a8eb444ea526f950e1)) +* **api:** update via SDK Studio ([#236](https://github.com/cloudflare/cloudflare-typescript/issues/236)) ([bd1bff8](https://github.com/cloudflare/cloudflare-typescript/commit/bd1bff880660620c24e6306dd6644473d9ae5c31)) +* **api:** update via SDK Studio ([#240](https://github.com/cloudflare/cloudflare-typescript/issues/240)) ([0019f33](https://github.com/cloudflare/cloudflare-typescript/commit/0019f333439504cda687dcb373d592fedc8aebe7)) +* **api:** update via SDK Studio ([#241](https://github.com/cloudflare/cloudflare-typescript/issues/241)) ([2b1161a](https://github.com/cloudflare/cloudflare-typescript/commit/2b1161aa3285d4ee93e075fe10e8ecafa1696a43)) +* **api:** update via SDK Studio ([#242](https://github.com/cloudflare/cloudflare-typescript/issues/242)) ([7792e24](https://github.com/cloudflare/cloudflare-typescript/commit/7792e24c349ed7dcb11e2b437c1e7e7e191554ac)) +* **api:** update via SDK Studio ([#243](https://github.com/cloudflare/cloudflare-typescript/issues/243)) ([1da44f8](https://github.com/cloudflare/cloudflare-typescript/commit/1da44f8dc099bbab8f0816d70e2cb84f508b9855)) +* **api:** update via SDK Studio ([#245](https://github.com/cloudflare/cloudflare-typescript/issues/245)) ([39de41d](https://github.com/cloudflare/cloudflare-typescript/commit/39de41d44c86c9f35672610b986f52abb6ed262a)) +* **api:** update via SDK Studio ([#246](https://github.com/cloudflare/cloudflare-typescript/issues/246)) ([ca272e8](https://github.com/cloudflare/cloudflare-typescript/commit/ca272e8c6ff2678dcf584ecf3bf3b3f4ca5ed23e)) +* **api:** update via SDK Studio ([#247](https://github.com/cloudflare/cloudflare-typescript/issues/247)) ([63a7163](https://github.com/cloudflare/cloudflare-typescript/commit/63a716382cbe6dbaecdcab364dc27fbab7a0bc7c)) +* **api:** update via SDK Studio ([#248](https://github.com/cloudflare/cloudflare-typescript/issues/248)) ([9f4bba3](https://github.com/cloudflare/cloudflare-typescript/commit/9f4bba3ade9f627a4af2278d09126e981fc4fd7b)) +* **api:** update via SDK Studio ([#249](https://github.com/cloudflare/cloudflare-typescript/issues/249)) ([b5096b8](https://github.com/cloudflare/cloudflare-typescript/commit/b5096b878ac6a138e2308d7c02918f2ca63b66d9)) +* **api:** update via SDK Studio ([#250](https://github.com/cloudflare/cloudflare-typescript/issues/250)) ([4dab1eb](https://github.com/cloudflare/cloudflare-typescript/commit/4dab1eb0352ee188b89ac059bd5d6fde179c0e27)) +* **api:** update via SDK Studio ([#251](https://github.com/cloudflare/cloudflare-typescript/issues/251)) ([18a49f5](https://github.com/cloudflare/cloudflare-typescript/commit/18a49f5fa35b6ff88e2c7e3010a5ea805de665a7)) +* **api:** update via SDK Studio ([#252](https://github.com/cloudflare/cloudflare-typescript/issues/252)) ([0e1b49b](https://github.com/cloudflare/cloudflare-typescript/commit/0e1b49bb267624f21b5fe2ee4b7db69b1a3ebb9b)) +* **api:** update via SDK Studio ([#253](https://github.com/cloudflare/cloudflare-typescript/issues/253)) ([b7c2205](https://github.com/cloudflare/cloudflare-typescript/commit/b7c2205807107a59d31a6e9bb4bea0b3bbe11327)) +* **api:** update via SDK Studio ([#254](https://github.com/cloudflare/cloudflare-typescript/issues/254)) ([3464a12](https://github.com/cloudflare/cloudflare-typescript/commit/3464a1299066301658f903949bddc3d925e2ab38)) +* **api:** update via SDK Studio ([#255](https://github.com/cloudflare/cloudflare-typescript/issues/255)) ([66e8c22](https://github.com/cloudflare/cloudflare-typescript/commit/66e8c228d852a720219d2c636caa2683f16d6d3a)) +* **api:** update via SDK Studio ([#256](https://github.com/cloudflare/cloudflare-typescript/issues/256)) ([cbc4bc7](https://github.com/cloudflare/cloudflare-typescript/commit/cbc4bc75c2c81de5224bb9700ad3b9793d3d0da2)) +* **api:** update via SDK Studio ([#257](https://github.com/cloudflare/cloudflare-typescript/issues/257)) ([818267a](https://github.com/cloudflare/cloudflare-typescript/commit/818267a920809b93d8732f72ed3f94f721356c6e)) +* **api:** update via SDK Studio ([#258](https://github.com/cloudflare/cloudflare-typescript/issues/258)) ([1255730](https://github.com/cloudflare/cloudflare-typescript/commit/1255730306cffc038645c21c20f38af5e9bc7984)) +* **api:** update via SDK Studio ([#259](https://github.com/cloudflare/cloudflare-typescript/issues/259)) ([5febcf8](https://github.com/cloudflare/cloudflare-typescript/commit/5febcf80eda448c897d3fc9bb6e3bbdbd8aaa01e)) +* **api:** update via SDK Studio ([#260](https://github.com/cloudflare/cloudflare-typescript/issues/260)) ([95f3d30](https://github.com/cloudflare/cloudflare-typescript/commit/95f3d301e4fb231146452514f655f21255299ff6)) +* **api:** update via SDK Studio ([#261](https://github.com/cloudflare/cloudflare-typescript/issues/261)) ([971a57b](https://github.com/cloudflare/cloudflare-typescript/commit/971a57b69e526cc598eeba6a802a24fcf2e10935)) +* **api:** update via SDK Studio ([#262](https://github.com/cloudflare/cloudflare-typescript/issues/262)) ([5f221df](https://github.com/cloudflare/cloudflare-typescript/commit/5f221df8eecfaaf91158e0711afa06718e352e7f)) +* **api:** update via SDK Studio ([#263](https://github.com/cloudflare/cloudflare-typescript/issues/263)) ([0790bad](https://github.com/cloudflare/cloudflare-typescript/commit/0790bad6e687552380d871fb89c8ccb892893f06)) +* **api:** update via SDK Studio ([#264](https://github.com/cloudflare/cloudflare-typescript/issues/264)) ([c7eebd2](https://github.com/cloudflare/cloudflare-typescript/commit/c7eebd26cb3d139a59bee64cf239c1cd7a9b822e)) +* **api:** update via SDK Studio ([#265](https://github.com/cloudflare/cloudflare-typescript/issues/265)) ([312dba0](https://github.com/cloudflare/cloudflare-typescript/commit/312dba0fb56d87bbedc087a901374bcab4ee1d42)) +* **api:** update via SDK Studio ([#266](https://github.com/cloudflare/cloudflare-typescript/issues/266)) ([182aa26](https://github.com/cloudflare/cloudflare-typescript/commit/182aa268db4e64544601e398f26298251fa85c5c)) +* **api:** update via SDK Studio ([#267](https://github.com/cloudflare/cloudflare-typescript/issues/267)) ([46f3d96](https://github.com/cloudflare/cloudflare-typescript/commit/46f3d967aeec5e65a0caf416212da703056c54a2)) +* **api:** update via SDK Studio ([#268](https://github.com/cloudflare/cloudflare-typescript/issues/268)) ([63d3bfa](https://github.com/cloudflare/cloudflare-typescript/commit/63d3bfada21465717ae905b7c36e135b8f309eb2)) +* **api:** update via SDK Studio ([#269](https://github.com/cloudflare/cloudflare-typescript/issues/269)) ([037097f](https://github.com/cloudflare/cloudflare-typescript/commit/037097faa627452b16a51bb253c6a9464fe8939c)) +* **api:** update via SDK Studio ([#270](https://github.com/cloudflare/cloudflare-typescript/issues/270)) ([c088545](https://github.com/cloudflare/cloudflare-typescript/commit/c088545c5b84c472cb8f1751b21cc1e78f7b36be)) +* **api:** update via SDK Studio ([#271](https://github.com/cloudflare/cloudflare-typescript/issues/271)) ([facc70f](https://github.com/cloudflare/cloudflare-typescript/commit/facc70ff12f73c24edb06f1a4fab02acf4ef1643)) +* **api:** update via SDK Studio ([#272](https://github.com/cloudflare/cloudflare-typescript/issues/272)) ([e19e495](https://github.com/cloudflare/cloudflare-typescript/commit/e19e495727fe4394dc9879ec28d8ea0cf4cd3435)) +* **api:** update via SDK Studio ([#273](https://github.com/cloudflare/cloudflare-typescript/issues/273)) ([4dbe423](https://github.com/cloudflare/cloudflare-typescript/commit/4dbe42349b3e95f9973f6d0af6c763a3702b9ff4)) +* **api:** update via SDK Studio ([#274](https://github.com/cloudflare/cloudflare-typescript/issues/274)) ([8d0d47a](https://github.com/cloudflare/cloudflare-typescript/commit/8d0d47ad7c77ff9daf6480b7ec7ef50bda7b6f5e)) +* **api:** update via SDK Studio ([#275](https://github.com/cloudflare/cloudflare-typescript/issues/275)) ([8653d7e](https://github.com/cloudflare/cloudflare-typescript/commit/8653d7e8792c49782404d4bdbdca7b9eb493b43b)) +* **api:** update via SDK Studio ([#276](https://github.com/cloudflare/cloudflare-typescript/issues/276)) ([4de093d](https://github.com/cloudflare/cloudflare-typescript/commit/4de093d7104f9f6425fb71461a1c2efacfc4b242)) +* **api:** update via SDK Studio ([#277](https://github.com/cloudflare/cloudflare-typescript/issues/277)) ([0a7bb85](https://github.com/cloudflare/cloudflare-typescript/commit/0a7bb85a7b8dc4ba784b1b27dfa7274e3452d06b)) +* **api:** update via SDK Studio ([#278](https://github.com/cloudflare/cloudflare-typescript/issues/278)) ([28fd0fe](https://github.com/cloudflare/cloudflare-typescript/commit/28fd0fe56f826af81a58005fd6c89a8ab2275667)) +* **api:** update via SDK Studio ([#279](https://github.com/cloudflare/cloudflare-typescript/issues/279)) ([41cf25d](https://github.com/cloudflare/cloudflare-typescript/commit/41cf25d527fab1a856240f5d97340b8210084b30)) +* **api:** update via SDK Studio ([#280](https://github.com/cloudflare/cloudflare-typescript/issues/280)) ([3a85dd9](https://github.com/cloudflare/cloudflare-typescript/commit/3a85dd917afc4d7e23bb3cd71c18deeaf618e18e)) +* **api:** update via SDK Studio ([#281](https://github.com/cloudflare/cloudflare-typescript/issues/281)) ([e94d015](https://github.com/cloudflare/cloudflare-typescript/commit/e94d0150676d00c3e0d5d1dfd7166b60eb5c99d7)) +* **api:** update via SDK Studio ([#282](https://github.com/cloudflare/cloudflare-typescript/issues/282)) ([55b2e14](https://github.com/cloudflare/cloudflare-typescript/commit/55b2e143ef1d394e3c12d4a995e2936a0f3da35d)) +* **api:** update via SDK Studio ([#283](https://github.com/cloudflare/cloudflare-typescript/issues/283)) ([553da66](https://github.com/cloudflare/cloudflare-typescript/commit/553da66845712771e1eb15a60b755eeb3a6015ef)) +* **api:** update via SDK Studio ([#284](https://github.com/cloudflare/cloudflare-typescript/issues/284)) ([c108be3](https://github.com/cloudflare/cloudflare-typescript/commit/c108be318533135144b79cb5e0bfaa72e2da332a)) +* **api:** update via SDK Studio ([#286](https://github.com/cloudflare/cloudflare-typescript/issues/286)) ([4c56e68](https://github.com/cloudflare/cloudflare-typescript/commit/4c56e68e221b954003141eadc8561f228b03ed88)) +* **api:** update via SDK Studio ([#287](https://github.com/cloudflare/cloudflare-typescript/issues/287)) ([070b79b](https://github.com/cloudflare/cloudflare-typescript/commit/070b79b0b6946bc40544854be5ca1bf7450c375c)) +* **api:** update via SDK Studio ([#288](https://github.com/cloudflare/cloudflare-typescript/issues/288)) ([96bcef4](https://github.com/cloudflare/cloudflare-typescript/commit/96bcef45fa8ca00fac4ecb36eaae75b3b3d61391)) +* **api:** update via SDK Studio ([#289](https://github.com/cloudflare/cloudflare-typescript/issues/289)) ([33b9a3a](https://github.com/cloudflare/cloudflare-typescript/commit/33b9a3aea815f88323a4f97d24c858b72e3c5174)) +* **api:** update via SDK Studio ([#296](https://github.com/cloudflare/cloudflare-typescript/issues/296)) ([ff7121d](https://github.com/cloudflare/cloudflare-typescript/commit/ff7121d594a79fa552664a16cf70b8c774f3fe30)) +* **api:** update via SDK Studio ([#297](https://github.com/cloudflare/cloudflare-typescript/issues/297)) ([0097fc0](https://github.com/cloudflare/cloudflare-typescript/commit/0097fc09b2857b834a58d999551ac837568bce77)) +* **api:** update via SDK Studio ([#298](https://github.com/cloudflare/cloudflare-typescript/issues/298)) ([a5638e0](https://github.com/cloudflare/cloudflare-typescript/commit/a5638e0c365809daae60df9696bb16580d2bc737)) +* **api:** update via SDK Studio ([#299](https://github.com/cloudflare/cloudflare-typescript/issues/299)) ([b2b723d](https://github.com/cloudflare/cloudflare-typescript/commit/b2b723dfe14d0809f2c279f6b9eea5a0f6c2dfee)) +* **api:** update via SDK Studio ([#300](https://github.com/cloudflare/cloudflare-typescript/issues/300)) ([5bf09b4](https://github.com/cloudflare/cloudflare-typescript/commit/5bf09b4269bd7bd563bdc64c756c4cf5b68b389c)) +* **api:** update via SDK Studio ([#301](https://github.com/cloudflare/cloudflare-typescript/issues/301)) ([662c08a](https://github.com/cloudflare/cloudflare-typescript/commit/662c08aae2d78c72b760b650b6d0fb524e3ee3f8)) +* **api:** update via SDK Studio ([#302](https://github.com/cloudflare/cloudflare-typescript/issues/302)) ([8fbe296](https://github.com/cloudflare/cloudflare-typescript/commit/8fbe296df204d788aba307900ccb14518b47f144)) +* **api:** update via SDK Studio ([#303](https://github.com/cloudflare/cloudflare-typescript/issues/303)) ([37f440b](https://github.com/cloudflare/cloudflare-typescript/commit/37f440bd18ab99096e0de3be986dde3af4b0c431)) +* **api:** update via SDK Studio ([#304](https://github.com/cloudflare/cloudflare-typescript/issues/304)) ([9f7b605](https://github.com/cloudflare/cloudflare-typescript/commit/9f7b605cba7bfc6b0e5e0f8c1307b97269f54845)) +* **api:** update via SDK Studio ([#305](https://github.com/cloudflare/cloudflare-typescript/issues/305)) ([15e9219](https://github.com/cloudflare/cloudflare-typescript/commit/15e92190a49c00e0e003573986a2505931fdedb1)) +* **api:** update via SDK Studio ([#306](https://github.com/cloudflare/cloudflare-typescript/issues/306)) ([528f81c](https://github.com/cloudflare/cloudflare-typescript/commit/528f81c175e97734674205f3314401c7edb35ae0)) +* **api:** update via SDK Studio ([#307](https://github.com/cloudflare/cloudflare-typescript/issues/307)) ([9fce094](https://github.com/cloudflare/cloudflare-typescript/commit/9fce0946ce698a5e78df5ede6c06522b9257f49b)) +* **api:** update via SDK Studio ([#308](https://github.com/cloudflare/cloudflare-typescript/issues/308)) ([ea263f3](https://github.com/cloudflare/cloudflare-typescript/commit/ea263f3a3ebb8c872d173a3d1a6828c9486c5abf)) +* **api:** update via SDK Studio ([#309](https://github.com/cloudflare/cloudflare-typescript/issues/309)) ([99d8c1a](https://github.com/cloudflare/cloudflare-typescript/commit/99d8c1a785c534b45d6b4ae62c1311977d89e771)) +* **api:** update via SDK Studio ([#310](https://github.com/cloudflare/cloudflare-typescript/issues/310)) ([1466127](https://github.com/cloudflare/cloudflare-typescript/commit/14661270f9ce4acd914ac6c16bac23e401d5c2be)) +* **api:** update via SDK Studio ([#311](https://github.com/cloudflare/cloudflare-typescript/issues/311)) ([198e535](https://github.com/cloudflare/cloudflare-typescript/commit/198e535faa64a1117ebb3ebe2938ac8f8ba29b13)) +* **api:** update via SDK Studio ([#312](https://github.com/cloudflare/cloudflare-typescript/issues/312)) ([6465d1d](https://github.com/cloudflare/cloudflare-typescript/commit/6465d1d44cb0382c67d7ed9ba814f85f3a862e84)) +* **api:** update via SDK Studio ([#313](https://github.com/cloudflare/cloudflare-typescript/issues/313)) ([7e3717c](https://github.com/cloudflare/cloudflare-typescript/commit/7e3717c90ff79104bc12e5d29cf94a2a65958aab)) +* **api:** update via SDK Studio ([#314](https://github.com/cloudflare/cloudflare-typescript/issues/314)) ([38040f3](https://github.com/cloudflare/cloudflare-typescript/commit/38040f3e7ce93c4f5a7c0dce5e8a2f7dfc6f6d5f)) +* **api:** update via SDK Studio ([#315](https://github.com/cloudflare/cloudflare-typescript/issues/315)) ([c4f972a](https://github.com/cloudflare/cloudflare-typescript/commit/c4f972a399c099c54880b5a20d910d298e3b5f95)) +* **api:** update via SDK Studio ([#322](https://github.com/cloudflare/cloudflare-typescript/issues/322)) ([6bdda5d](https://github.com/cloudflare/cloudflare-typescript/commit/6bdda5d46ffc8d380e1bbde57b9e6831f50ad189)) +* **api:** update via SDK Studio ([#323](https://github.com/cloudflare/cloudflare-typescript/issues/323)) ([fddf5bf](https://github.com/cloudflare/cloudflare-typescript/commit/fddf5bfa22a8a3d96aa994d2c564b9f5f8c44243)) +* **api:** update via SDK Studio ([#324](https://github.com/cloudflare/cloudflare-typescript/issues/324)) ([bdae7b3](https://github.com/cloudflare/cloudflare-typescript/commit/bdae7b32cccc241db628529f16ab68fa8b2920dd)) +* **api:** update via SDK Studio ([#325](https://github.com/cloudflare/cloudflare-typescript/issues/325)) ([5089af9](https://github.com/cloudflare/cloudflare-typescript/commit/5089af905ec78e87d99a96bb8b0ca2a8b2671aff)) +* **api:** update via SDK Studio ([#326](https://github.com/cloudflare/cloudflare-typescript/issues/326)) ([8b17f2a](https://github.com/cloudflare/cloudflare-typescript/commit/8b17f2ac65a4282e5cf239ec6292d9ed6102b279)) +* **api:** update via SDK Studio ([#327](https://github.com/cloudflare/cloudflare-typescript/issues/327)) ([d579828](https://github.com/cloudflare/cloudflare-typescript/commit/d579828e3c4dd8961f1053cb295ed3f64979e139)) +* **api:** update via SDK Studio ([#328](https://github.com/cloudflare/cloudflare-typescript/issues/328)) ([1267f28](https://github.com/cloudflare/cloudflare-typescript/commit/1267f28b637fe8289b699f827d3d3245961a07f0)) +* **api:** update via SDK Studio ([#329](https://github.com/cloudflare/cloudflare-typescript/issues/329)) ([7992765](https://github.com/cloudflare/cloudflare-typescript/commit/7992765169bfc12b1a57a829204111fd321bb79d)) +* **api:** update via SDK Studio ([#330](https://github.com/cloudflare/cloudflare-typescript/issues/330)) ([b275bc5](https://github.com/cloudflare/cloudflare-typescript/commit/b275bc5a44ce4144337ce51ae746c1cced15823d)) +* **api:** update via SDK Studio ([#331](https://github.com/cloudflare/cloudflare-typescript/issues/331)) ([626a789](https://github.com/cloudflare/cloudflare-typescript/commit/626a78952f30baf9e6c111e2600ab37726481e91)) +* **api:** update via SDK Studio ([#333](https://github.com/cloudflare/cloudflare-typescript/issues/333)) ([94c67b4](https://github.com/cloudflare/cloudflare-typescript/commit/94c67b48fc8dca318520a90cae3809577d27ec9f)) +* **api:** update via SDK Studio ([#339](https://github.com/cloudflare/cloudflare-typescript/issues/339)) ([f6e8ed8](https://github.com/cloudflare/cloudflare-typescript/commit/f6e8ed85f3df8858da22e4f839af46ae7105baec)) +* **api:** update via SDK Studio ([#351](https://github.com/cloudflare/cloudflare-typescript/issues/351)) ([a891c87](https://github.com/cloudflare/cloudflare-typescript/commit/a891c87b29c2d7db700e68c5dd3d4cc20be1ffe6)) +* **api:** update via SDK Studio ([#352](https://github.com/cloudflare/cloudflare-typescript/issues/352)) ([13d89f5](https://github.com/cloudflare/cloudflare-typescript/commit/13d89f53c80d0c867ef0c1c257168e25208cc924)) +* **api:** update via SDK Studio ([#353](https://github.com/cloudflare/cloudflare-typescript/issues/353)) ([a4ee592](https://github.com/cloudflare/cloudflare-typescript/commit/a4ee5927f2409b565bf56628a924bf9e5533674a)) +* **api:** update via SDK Studio ([#354](https://github.com/cloudflare/cloudflare-typescript/issues/354)) ([b9ad105](https://github.com/cloudflare/cloudflare-typescript/commit/b9ad10558f79d19d570a41a3de628e9aac4c84c2)) +* **api:** update via SDK Studio ([#356](https://github.com/cloudflare/cloudflare-typescript/issues/356)) ([0bdd105](https://github.com/cloudflare/cloudflare-typescript/commit/0bdd10519c6e2262b77e9d682902aa24749cd80a)) +* **api:** update via SDK Studio ([#357](https://github.com/cloudflare/cloudflare-typescript/issues/357)) ([a63f145](https://github.com/cloudflare/cloudflare-typescript/commit/a63f145b2f6cca34ea8ff0e3dc7fded7da91a4a0)) +* **api:** update via SDK Studio ([#358](https://github.com/cloudflare/cloudflare-typescript/issues/358)) ([8b75685](https://github.com/cloudflare/cloudflare-typescript/commit/8b7568502f877ef0a78603c996c150d41fddf15c)) +* **api:** update via SDK Studio ([#359](https://github.com/cloudflare/cloudflare-typescript/issues/359)) ([3b40dd3](https://github.com/cloudflare/cloudflare-typescript/commit/3b40dd3d8c6180aecc3ac9c70267a6f1f0eb1036)) +* **api:** update via SDK Studio ([#360](https://github.com/cloudflare/cloudflare-typescript/issues/360)) ([8f10216](https://github.com/cloudflare/cloudflare-typescript/commit/8f102163d06746939ac041518dc264d6323055ff)) +* **api:** update via SDK Studio ([#361](https://github.com/cloudflare/cloudflare-typescript/issues/361)) ([625ce8f](https://github.com/cloudflare/cloudflare-typescript/commit/625ce8fb17f1a19b7ad8168326930c0c5eae7679)) +* **api:** update via SDK Studio ([#365](https://github.com/cloudflare/cloudflare-typescript/issues/365)) ([cecc36b](https://github.com/cloudflare/cloudflare-typescript/commit/cecc36bb939fc692e0fba8fbd42197d1c7ddfbe1)) +* **api:** update via SDK Studio ([#366](https://github.com/cloudflare/cloudflare-typescript/issues/366)) ([dc033fc](https://github.com/cloudflare/cloudflare-typescript/commit/dc033fc49f7571a3baeced14353bf52776b88134)) +* **api:** update via SDK Studio ([#368](https://github.com/cloudflare/cloudflare-typescript/issues/368)) ([8c5c8cd](https://github.com/cloudflare/cloudflare-typescript/commit/8c5c8cd7e3cdf40f788529d225afea43f8ce8bd4)) +* **api:** update via SDK Studio ([#369](https://github.com/cloudflare/cloudflare-typescript/issues/369)) ([4f8bf31](https://github.com/cloudflare/cloudflare-typescript/commit/4f8bf31b75ecae33cab5ccb46d98307ced1b6c9e)) + + +### Bug Fixes + +* **example:** update demo example ([#231](https://github.com/cloudflare/cloudflare-typescript/issues/231)) ([54faa1b](https://github.com/cloudflare/cloudflare-typescript/commit/54faa1bd35ae5f394e37e8ac7f75c36f738baff9)) + ## 3.0.0 (2024-04-02) Full Changelog: [v3.0.0-beta.14...v3.0.0](https://github.com/cloudflare/cloudflare-typescript/compare/v3.0.0-beta.14...v3.0.0) diff --git a/api.md b/api.md index d4de1de886..bdf6ec535d 100644 --- a/api.md +++ b/api.md @@ -2,7 +2,19 @@ Types: +- ASN +- AuditLog +- CloudflareTunnel - ErrorData +- Identifier +- LoadBalancerPreview +- Member +- PaginationInfo +- Permission +- PermissionGrant +- ResponseInfo +- Result +- Role # Accounts @@ -23,24 +35,22 @@ Methods: Types: -- AccountMember -- AccountMemberWithID +- UserWithInviteCode - MemberListResponse - MemberDeleteResponse Methods: -- client.accounts.members.create({ ...params }) -> AccountMemberWithID -- client.accounts.members.update(memberId, { ...params }) -> AccountMember +- client.accounts.members.create({ ...params }) -> UserWithInviteCode +- client.accounts.members.update(memberId, { ...params }) -> Member - client.accounts.members.list({ ...params }) -> MemberListResponsesV4PagePaginationArray - client.accounts.members.delete(memberId, { ...params }) -> MemberDeleteResponse | null -- client.accounts.members.get(memberId, { ...params }) -> AccountMember +- client.accounts.members.get(memberId, { ...params }) -> Member ## Roles Types: -- Role - RoleGetResponse Methods: @@ -60,8 +70,8 @@ Types: Methods: - client.originCACertificates.create({ ...params }) -> OriginCACertificateCreateResponse -- client.originCACertificates.list() -> OriginCACertificatesSinglePage -- client.originCACertificates.delete(certificateId) -> OriginCACertificateDeleteResponse +- client.originCACertificates.list({ ...params }) -> OriginCACertificatesSinglePage +- client.originCACertificates.delete(certificateId, { ...params }) -> OriginCACertificateDeleteResponse - client.originCACertificates.get(certificateId) -> OriginCACertificateGetResponse # IPs @@ -89,14 +99,13 @@ Methods: - client.memberships.update(membershipId, { ...params }) -> MembershipUpdateResponse - client.memberships.list({ ...params }) -> MembershipsV4PagePaginationArray -- client.memberships.delete(membershipId) -> MembershipDeleteResponse +- client.memberships.delete(membershipId, { ...params }) -> MembershipDeleteResponse - client.memberships.get(membershipId) -> MembershipGetResponse # User Types: -- User - UserEditResponse - UserGetResponse @@ -107,13 +116,9 @@ Methods: ## AuditLogs -Types: - -- AuditLogListResponse - Methods: -- client.user.auditLogs.list({ ...params }) -> AuditLogListResponsesV4PagePaginationArray +- client.user.auditLogs.list({ ...params }) -> AuditLogsV4PagePaginationArray ## Billing @@ -122,11 +127,10 @@ Methods: Types: - BillingHistory -- HistoryGetResponse Methods: -- client.user.billing.history.get({ ...params }) -> HistoryGetResponse | null +- client.user.billing.history.list({ ...params }) -> BillingHistoriesV4PagePaginationArray ### Profile @@ -138,103 +142,20 @@ Methods: - client.user.billing.profile.get() -> ProfileGetResponse -## Firewall - -### AccessRules - -Types: - -- FirewallRule -- AccessRuleDeleteResponse - -Methods: - -- client.user.firewall.accessRules.create({ ...params }) -> FirewallRule | null -- client.user.firewall.accessRules.list({ ...params }) -> FirewallRulesV4PagePaginationArray -- client.user.firewall.accessRules.delete(identifier) -> AccessRuleDeleteResponse | null -- client.user.firewall.accessRules.edit(identifier, { ...params }) -> FirewallRule | null - ## Invites Types: -- UserInvite -- InviteListResponse +- Invite - InviteEditResponse - InviteGetResponse Methods: -- client.user.invites.list() -> InviteListResponsesSinglePage +- client.user.invites.list() -> InvitesSinglePage - client.user.invites.edit(inviteId, { ...params }) -> InviteEditResponse - client.user.invites.get(inviteId) -> InviteGetResponse -## LoadBalancers - -### Monitors - -Types: - -- LoadBalancingMonitor -- MonitorDeleteResponse -- MonitorPreviewResponse -- MonitorReferencesResponse - -Methods: - -- client.user.loadBalancers.monitors.create({ ...params }) -> LoadBalancingMonitor -- client.user.loadBalancers.monitors.update(monitorId, { ...params }) -> LoadBalancingMonitor -- client.user.loadBalancers.monitors.list() -> LoadBalancingMonitorsSinglePage -- client.user.loadBalancers.monitors.delete(monitorId) -> MonitorDeleteResponse -- client.user.loadBalancers.monitors.edit(monitorId, { ...params }) -> LoadBalancingMonitor -- client.user.loadBalancers.monitors.get(monitorId) -> LoadBalancingMonitor -- client.user.loadBalancers.monitors.preview(monitorId, { ...params }) -> MonitorPreviewResponse -- client.user.loadBalancers.monitors.references(monitorId) -> MonitorReferencesResponse | null - -### Pools - -Types: - -- LoadBalancingPool -- PoolDeleteResponse -- PoolHealthResponse -- PoolPreviewResponse -- PoolReferencesResponse - -Methods: - -- client.user.loadBalancers.pools.create({ ...params }) -> LoadBalancingPool -- client.user.loadBalancers.pools.update(poolId, { ...params }) -> LoadBalancingPool -- client.user.loadBalancers.pools.list({ ...params }) -> LoadBalancingPoolsSinglePage -- client.user.loadBalancers.pools.delete(poolId) -> PoolDeleteResponse -- client.user.loadBalancers.pools.edit(poolId, { ...params }) -> LoadBalancingPool -- client.user.loadBalancers.pools.get(poolId) -> LoadBalancingPool -- client.user.loadBalancers.pools.health(poolId) -> PoolHealthResponse -- client.user.loadBalancers.pools.preview(poolId, { ...params }) -> PoolPreviewResponse -- client.user.loadBalancers.pools.references(poolId) -> PoolReferencesResponse | null - -### Preview - -Types: - -- LoadBalancingPreview - -Methods: - -- client.user.loadBalancers.preview.get(previewId) -> LoadBalancingPreview - -### Analytics - -#### Events - -Types: - -- LoadBalancingAnalytics - -Methods: - -- client.user.loadBalancers.analytics.events.list({ ...params }) -> LoadBalancingAnalyticsSinglePage - ## Organizations Types: @@ -246,14 +167,17 @@ Types: Methods: - client.user.organizations.list({ ...params }) -> OrganizationsV4PagePaginationArray -- client.user.organizations.delete(organizationId) -> OrganizationDeleteResponse +- client.user.organizations.delete(organizationId, { ...params }) -> OrganizationDeleteResponse - client.user.organizations.get(organizationId) -> OrganizationGetResponse ## Subscriptions Types: +- RatePlan - Subscription +- SubscriptionComponent +- SubscriptionZone - SubscriptionUpdateResponse - SubscriptionDeleteResponse - SubscriptionEditResponse @@ -262,7 +186,7 @@ Types: Methods: - client.user.subscriptions.update(identifier, { ...params }) -> SubscriptionUpdateResponse -- client.user.subscriptions.delete(identifier) -> SubscriptionDeleteResponse +- client.user.subscriptions.delete(identifier, { ...params }) -> SubscriptionDeleteResponse - client.user.subscriptions.edit(identifier, { ...params }) -> SubscriptionEditResponse - client.user.subscriptions.get() -> SubscriptionGetResponse | null @@ -270,6 +194,9 @@ Methods: Types: +- CIDRList +- Policy +- Token - TokenCreateResponse - TokenUpdateResponse - TokenListResponse @@ -282,7 +209,7 @@ Methods: - client.user.tokens.create({ ...params }) -> TokenCreateResponse - client.user.tokens.update(tokenId, { ...params }) -> TokenUpdateResponse - client.user.tokens.list({ ...params }) -> TokenListResponsesV4PagePaginationArray -- client.user.tokens.delete(tokenId) -> TokenDeleteResponse | null +- client.user.tokens.delete(tokenId, { ...params }) -> TokenDeleteResponse | null - client.user.tokens.get(tokenId) -> TokenGetResponse - client.user.tokens.verify() -> TokenVerifyResponse @@ -300,11 +227,11 @@ Methods: Types: -- TokenValue +- Value Methods: -- client.user.tokens.value.update(tokenId, { ...params }) -> TokenValue +- client.user.tokens.value.update(tokenId, { ...params }) -> Value # Zones @@ -335,370 +262,361 @@ Methods: Types: -- DNSSettingEditResponse -- DNSSettingGetResponse +- DNSSetting +- Nameserver Methods: -- client.zones.dnsSettings.edit({ ...params }) -> DNSSettingEditResponse -- client.zones.dnsSettings.get({ ...params }) -> DNSSettingGetResponse +- client.zones.dnsSettings.edit({ ...params }) -> DNSSetting +- client.zones.dnsSettings.get({ ...params }) -> DNSSetting ## Settings -Types: - -- SettingEditResponse -- SettingGetResponse - -Methods: - -- client.zones.settings.edit({ ...params }) -> SettingEditResponse -- client.zones.settings.get({ ...params }) -> SettingGetResponse - ### ZeroRTT Types: -- ZoneSetting0rtt +- ZeroRTT Methods: -- client.zones.settings.zeroRTT.edit({ ...params }) -> ZoneSetting0rtt -- client.zones.settings.zeroRTT.get({ ...params }) -> ZoneSetting0rtt +- client.zones.settings.zeroRTT.edit({ ...params }) -> ZeroRTT +- client.zones.settings.zeroRTT.get({ ...params }) -> ZeroRTT ### AdvancedDDoS Types: -- ZoneSettingAdvancedDDoS +- AdvancedDDoS Methods: -- client.zones.settings.advancedDDoS.get({ ...params }) -> ZoneSettingAdvancedDDoS +- client.zones.settings.advancedDDoS.get({ ...params }) -> AdvancedDDoS ### AlwaysOnline Types: -- ZoneSettingAlwaysOnline +- AlwaysOnline Methods: -- client.zones.settings.alwaysOnline.edit({ ...params }) -> ZoneSettingAlwaysOnline -- client.zones.settings.alwaysOnline.get({ ...params }) -> ZoneSettingAlwaysOnline +- client.zones.settings.alwaysOnline.edit({ ...params }) -> AlwaysOnline +- client.zones.settings.alwaysOnline.get({ ...params }) -> AlwaysOnline ### AlwaysUseHTTPS Types: -- ZoneSettingAlwaysUseHTTPS +- AlwaysUseHTTPS Methods: -- client.zones.settings.alwaysUseHTTPS.edit({ ...params }) -> ZoneSettingAlwaysUseHTTPS -- client.zones.settings.alwaysUseHTTPS.get({ ...params }) -> ZoneSettingAlwaysUseHTTPS +- client.zones.settings.alwaysUseHTTPS.edit({ ...params }) -> AlwaysUseHTTPS +- client.zones.settings.alwaysUseHTTPS.get({ ...params }) -> AlwaysUseHTTPS ### AutomaticHTTPSRewrites Types: -- ZoneSettingAutomaticHTTPSRewrites +- AutomaticHTTPSRewrites Methods: -- client.zones.settings.automaticHTTPSRewrites.edit({ ...params }) -> ZoneSettingAutomaticHTTPSRewrites -- client.zones.settings.automaticHTTPSRewrites.get({ ...params }) -> ZoneSettingAutomaticHTTPSRewrites +- client.zones.settings.automaticHTTPSRewrites.edit({ ...params }) -> AutomaticHTTPSRewrites +- client.zones.settings.automaticHTTPSRewrites.get({ ...params }) -> AutomaticHTTPSRewrites ### AutomaticPlatformOptimization Types: -- ZoneSettingAutomaticPlatformOptimization +- AutomaticPlatformOptimization Methods: -- client.zones.settings.automaticPlatformOptimization.edit({ ...params }) -> ZoneSettingAutomaticPlatformOptimization -- client.zones.settings.automaticPlatformOptimization.get({ ...params }) -> ZoneSettingAutomaticPlatformOptimization +- client.zones.settings.automaticPlatformOptimization.edit({ ...params }) -> AutomaticPlatformOptimization +- client.zones.settings.automaticPlatformOptimization.get({ ...params }) -> AutomaticPlatformOptimization ### Brotli Types: -- ZoneSettingBrotli +- Brotli Methods: -- client.zones.settings.brotli.edit({ ...params }) -> ZoneSettingBrotli -- client.zones.settings.brotli.get({ ...params }) -> ZoneSettingBrotli +- client.zones.settings.brotli.edit({ ...params }) -> Brotli +- client.zones.settings.brotli.get({ ...params }) -> Brotli ### BrowserCacheTTL Types: -- ZoneSettingBrowserCacheTTL +- BrowserCacheTTL Methods: -- client.zones.settings.browserCacheTTL.edit({ ...params }) -> ZoneSettingBrowserCacheTTL -- client.zones.settings.browserCacheTTL.get({ ...params }) -> ZoneSettingBrowserCacheTTL +- client.zones.settings.browserCacheTTL.edit({ ...params }) -> BrowserCacheTTL +- client.zones.settings.browserCacheTTL.get({ ...params }) -> BrowserCacheTTL ### BrowserCheck Types: -- ZoneSettingBrowserCheck +- BrowserCheck Methods: -- client.zones.settings.browserCheck.edit({ ...params }) -> ZoneSettingBrowserCheck -- client.zones.settings.browserCheck.get({ ...params }) -> ZoneSettingBrowserCheck +- client.zones.settings.browserCheck.edit({ ...params }) -> BrowserCheck +- client.zones.settings.browserCheck.get({ ...params }) -> BrowserCheck ### CacheLevel Types: -- ZoneSettingCacheLevel +- CacheLevel Methods: -- client.zones.settings.cacheLevel.edit({ ...params }) -> ZoneSettingCacheLevel -- client.zones.settings.cacheLevel.get({ ...params }) -> ZoneSettingCacheLevel +- client.zones.settings.cacheLevel.edit({ ...params }) -> CacheLevel +- client.zones.settings.cacheLevel.get({ ...params }) -> CacheLevel ### ChallengeTTL Types: -- ZoneSettingChallengeTTL +- ChallengeTTL Methods: -- client.zones.settings.challengeTTL.edit({ ...params }) -> ZoneSettingChallengeTTL -- client.zones.settings.challengeTTL.get({ ...params }) -> ZoneSettingChallengeTTL +- client.zones.settings.challengeTTL.edit({ ...params }) -> ChallengeTTL +- client.zones.settings.challengeTTL.get({ ...params }) -> ChallengeTTL ### Ciphers Types: -- ZoneSettingCiphers +- Ciphers Methods: -- client.zones.settings.ciphers.edit({ ...params }) -> ZoneSettingCiphers -- client.zones.settings.ciphers.get({ ...params }) -> ZoneSettingCiphers +- client.zones.settings.ciphers.edit({ ...params }) -> Ciphers +- client.zones.settings.ciphers.get({ ...params }) -> Ciphers ### DevelopmentMode Types: -- ZoneSettingDevelopmentMode +- DevelopmentMode Methods: -- client.zones.settings.developmentMode.edit({ ...params }) -> ZoneSettingDevelopmentMode -- client.zones.settings.developmentMode.get({ ...params }) -> ZoneSettingDevelopmentMode +- client.zones.settings.developmentMode.edit({ ...params }) -> DevelopmentMode +- client.zones.settings.developmentMode.get({ ...params }) -> DevelopmentMode ### EarlyHints Types: -- ZoneSettingEarlyHints +- EarlyHints Methods: -- client.zones.settings.earlyHints.edit({ ...params }) -> ZoneSettingEarlyHints -- client.zones.settings.earlyHints.get({ ...params }) -> ZoneSettingEarlyHints +- client.zones.settings.earlyHints.edit({ ...params }) -> EarlyHints +- client.zones.settings.earlyHints.get({ ...params }) -> EarlyHints ### EmailObfuscation Types: -- ZoneSettingEmailObfuscation +- EmailObfuscation Methods: -- client.zones.settings.emailObfuscation.edit({ ...params }) -> ZoneSettingEmailObfuscation -- client.zones.settings.emailObfuscation.get({ ...params }) -> ZoneSettingEmailObfuscation +- client.zones.settings.emailObfuscation.edit({ ...params }) -> EmailObfuscation +- client.zones.settings.emailObfuscation.get({ ...params }) -> EmailObfuscation ### H2Prioritization Types: -- ZoneSettingH2Prioritization +- H2Prioritization Methods: -- client.zones.settings.h2Prioritization.edit({ ...params }) -> ZoneSettingH2Prioritization -- client.zones.settings.h2Prioritization.get({ ...params }) -> ZoneSettingH2Prioritization +- client.zones.settings.h2Prioritization.edit({ ...params }) -> H2Prioritization +- client.zones.settings.h2Prioritization.get({ ...params }) -> H2Prioritization ### HotlinkProtection Types: -- ZoneSettingHotlinkProtection +- HotlinkProtection Methods: -- client.zones.settings.hotlinkProtection.edit({ ...params }) -> ZoneSettingHotlinkProtection -- client.zones.settings.hotlinkProtection.get({ ...params }) -> ZoneSettingHotlinkProtection +- client.zones.settings.hotlinkProtection.edit({ ...params }) -> HotlinkProtection +- client.zones.settings.hotlinkProtection.get({ ...params }) -> HotlinkProtection ### HTTP2 Types: -- ZoneSettingHTTP2 +- HTTP2 Methods: -- client.zones.settings.http2.edit({ ...params }) -> ZoneSettingHTTP2 -- client.zones.settings.http2.get({ ...params }) -> ZoneSettingHTTP2 +- client.zones.settings.http2.edit({ ...params }) -> HTTP2 +- client.zones.settings.http2.get({ ...params }) -> HTTP2 ### HTTP3 Types: -- ZoneSettingHTTP3 +- HTTP3 Methods: -- client.zones.settings.http3.edit({ ...params }) -> ZoneSettingHTTP3 -- client.zones.settings.http3.get({ ...params }) -> ZoneSettingHTTP3 +- client.zones.settings.http3.edit({ ...params }) -> HTTP3 +- client.zones.settings.http3.get({ ...params }) -> HTTP3 ### ImageResizing Types: -- ZoneSettingImageResizing +- ImageResizing Methods: -- client.zones.settings.imageResizing.edit({ ...params }) -> ZoneSettingImageResizing -- client.zones.settings.imageResizing.get({ ...params }) -> ZoneSettingImageResizing +- client.zones.settings.imageResizing.edit({ ...params }) -> ImageResizing +- client.zones.settings.imageResizing.get({ ...params }) -> ImageResizing ### IPGeolocation Types: -- ZoneSettingIPGeolocation +- IPGeolocation Methods: -- client.zones.settings.ipGeolocation.edit({ ...params }) -> ZoneSettingIPGeolocation -- client.zones.settings.ipGeolocation.get({ ...params }) -> ZoneSettingIPGeolocation +- client.zones.settings.ipGeolocation.edit({ ...params }) -> IPGeolocation +- client.zones.settings.ipGeolocation.get({ ...params }) -> IPGeolocation ### IPV6 Types: -- ZoneSettingIPV6 +- IPV6 Methods: -- client.zones.settings.ipv6.edit({ ...params }) -> ZoneSettingIPV6 -- client.zones.settings.ipv6.get({ ...params }) -> ZoneSettingIPV6 +- client.zones.settings.ipv6.edit({ ...params }) -> IPV6 +- client.zones.settings.ipv6.get({ ...params }) -> IPV6 ### MinTLSVersion Types: -- ZoneSettingMinTLSVersion +- MinTLSVersion Methods: -- client.zones.settings.minTLSVersion.edit({ ...params }) -> ZoneSettingMinTLSVersion -- client.zones.settings.minTLSVersion.get({ ...params }) -> ZoneSettingMinTLSVersion +- client.zones.settings.minTLSVersion.edit({ ...params }) -> MinTLSVersion +- client.zones.settings.minTLSVersion.get({ ...params }) -> MinTLSVersion ### Minify Types: -- ZoneSettingMinify +- Minify Methods: -- client.zones.settings.minify.edit({ ...params }) -> ZoneSettingMinify -- client.zones.settings.minify.get({ ...params }) -> ZoneSettingMinify +- client.zones.settings.minify.edit({ ...params }) -> Minify +- client.zones.settings.minify.get({ ...params }) -> Minify ### Mirage Types: -- ZoneSettingMirage +- Mirage Methods: -- client.zones.settings.mirage.edit({ ...params }) -> ZoneSettingMirage -- client.zones.settings.mirage.get({ ...params }) -> ZoneSettingMirage +- client.zones.settings.mirage.edit({ ...params }) -> Mirage +- client.zones.settings.mirage.get({ ...params }) -> Mirage ### MobileRedirect Types: -- ZoneSettingMobileRedirect +- MobileRedirect Methods: -- client.zones.settings.mobileRedirect.edit({ ...params }) -> ZoneSettingMobileRedirect -- client.zones.settings.mobileRedirect.get({ ...params }) -> ZoneSettingMobileRedirect +- client.zones.settings.mobileRedirect.edit({ ...params }) -> MobileRedirect +- client.zones.settings.mobileRedirect.get({ ...params }) -> MobileRedirect ### NEL Types: -- ZoneSettingNEL +- NEL Methods: -- client.zones.settings.nel.edit({ ...params }) -> ZoneSettingNEL -- client.zones.settings.nel.get({ ...params }) -> ZoneSettingNEL +- client.zones.settings.nel.edit({ ...params }) -> NEL +- client.zones.settings.nel.get({ ...params }) -> NEL ### OpportunisticEncryption Types: -- ZoneSettingOpportunisticEncryption +- OpportunisticEncryption Methods: -- client.zones.settings.opportunisticEncryption.edit({ ...params }) -> ZoneSettingOpportunisticEncryption -- client.zones.settings.opportunisticEncryption.get({ ...params }) -> ZoneSettingOpportunisticEncryption +- client.zones.settings.opportunisticEncryption.edit({ ...params }) -> OpportunisticEncryption +- client.zones.settings.opportunisticEncryption.get({ ...params }) -> OpportunisticEncryption ### OpportunisticOnion Types: -- ZoneSettingOpportunisticOnion +- OpportunisticOnion Methods: -- client.zones.settings.opportunisticOnion.edit({ ...params }) -> ZoneSettingOpportunisticOnion -- client.zones.settings.opportunisticOnion.get({ ...params }) -> ZoneSettingOpportunisticOnion +- client.zones.settings.opportunisticOnion.edit({ ...params }) -> OpportunisticOnion +- client.zones.settings.opportunisticOnion.get({ ...params }) -> OpportunisticOnion ### OrangeToOrange Types: -- ZoneSettingOrangeToOrange +- OrangeToOrange Methods: -- client.zones.settings.orangeToOrange.edit({ ...params }) -> ZoneSettingOrangeToOrange -- client.zones.settings.orangeToOrange.get({ ...params }) -> ZoneSettingOrangeToOrange +- client.zones.settings.orangeToOrange.edit({ ...params }) -> OrangeToOrange +- client.zones.settings.orangeToOrange.get({ ...params }) -> OrangeToOrange ### OriginErrorPagePassThru Types: -- ZoneSettingOriginErrorPagePassThru +- OriginErrorPagePassThru Methods: -- client.zones.settings.originErrorPagePassThru.edit({ ...params }) -> ZoneSettingOriginErrorPagePassThru -- client.zones.settings.originErrorPagePassThru.get({ ...params }) -> ZoneSettingOriginErrorPagePassThru +- client.zones.settings.originErrorPagePassThru.edit({ ...params }) -> OriginErrorPagePassThru +- client.zones.settings.originErrorPagePassThru.get({ ...params }) -> OriginErrorPagePassThru ### OriginMaxHTTPVersion Types: +- OriginMaxHTTPVersion - OriginMaxHTTPVersionEditResponse - OriginMaxHTTPVersionGetResponse @@ -711,210 +629,210 @@ Methods: Types: -- ZoneSettingPolish +- Polish Methods: -- client.zones.settings.polish.edit({ ...params }) -> ZoneSettingPolish -- client.zones.settings.polish.get({ ...params }) -> ZoneSettingPolish +- client.zones.settings.polish.edit({ ...params }) -> Polish +- client.zones.settings.polish.get({ ...params }) -> Polish ### PrefetchPreload Types: -- ZoneSettingPrefetchPreload +- PrefetchPreload Methods: -- client.zones.settings.prefetchPreload.edit({ ...params }) -> ZoneSettingPrefetchPreload -- client.zones.settings.prefetchPreload.get({ ...params }) -> ZoneSettingPrefetchPreload +- client.zones.settings.prefetchPreload.edit({ ...params }) -> PrefetchPreload +- client.zones.settings.prefetchPreload.get({ ...params }) -> PrefetchPreload ### ProxyReadTimeout Types: -- ZoneSettingProxyReadTimeout +- ProxyReadTimeout Methods: -- client.zones.settings.proxyReadTimeout.edit({ ...params }) -> ZoneSettingProxyReadTimeout -- client.zones.settings.proxyReadTimeout.get({ ...params }) -> ZoneSettingProxyReadTimeout +- client.zones.settings.proxyReadTimeout.edit({ ...params }) -> ProxyReadTimeout +- client.zones.settings.proxyReadTimeout.get({ ...params }) -> ProxyReadTimeout ### PseudoIPV4 Types: -- ZoneSettingPseudoIPV4 +- PseudoIPV4 Methods: -- client.zones.settings.pseudoIPV4.edit({ ...params }) -> ZoneSettingPseudoIPV4 -- client.zones.settings.pseudoIPV4.get({ ...params }) -> ZoneSettingPseudoIPV4 +- client.zones.settings.pseudoIPV4.edit({ ...params }) -> PseudoIPV4 +- client.zones.settings.pseudoIPV4.get({ ...params }) -> PseudoIPV4 ### ResponseBuffering Types: -- ZoneSettingBuffering +- ResponseBuffering Methods: -- client.zones.settings.responseBuffering.edit({ ...params }) -> ZoneSettingBuffering -- client.zones.settings.responseBuffering.get({ ...params }) -> ZoneSettingBuffering +- client.zones.settings.responseBuffering.edit({ ...params }) -> ResponseBuffering +- client.zones.settings.responseBuffering.get({ ...params }) -> ResponseBuffering ### RocketLoader Types: -- ZoneSettingRocketLoader +- RocketLoader Methods: -- client.zones.settings.rocketLoader.edit({ ...params }) -> ZoneSettingRocketLoader -- client.zones.settings.rocketLoader.get({ ...params }) -> ZoneSettingRocketLoader +- client.zones.settings.rocketLoader.edit({ ...params }) -> RocketLoader +- client.zones.settings.rocketLoader.get({ ...params }) -> RocketLoader ### SecurityHeaders Types: -- ZoneSettingSecurityHeader +- SecurityHeaders Methods: -- client.zones.settings.securityHeaders.edit({ ...params }) -> ZoneSettingSecurityHeader -- client.zones.settings.securityHeaders.get({ ...params }) -> ZoneSettingSecurityHeader +- client.zones.settings.securityHeaders.edit({ ...params }) -> SecurityHeaders +- client.zones.settings.securityHeaders.get({ ...params }) -> SecurityHeaders ### SecurityLevel Types: -- ZoneSettingSecurityLevel +- SecurityLevel Methods: -- client.zones.settings.securityLevel.edit({ ...params }) -> ZoneSettingSecurityLevel -- client.zones.settings.securityLevel.get({ ...params }) -> ZoneSettingSecurityLevel +- client.zones.settings.securityLevel.edit({ ...params }) -> SecurityLevel +- client.zones.settings.securityLevel.get({ ...params }) -> SecurityLevel ### ServerSideExcludes Types: -- ZoneSettingServerSideExclude +- ServerSideExcludes Methods: -- client.zones.settings.serverSideExcludes.edit({ ...params }) -> ZoneSettingServerSideExclude -- client.zones.settings.serverSideExcludes.get({ ...params }) -> ZoneSettingServerSideExclude +- client.zones.settings.serverSideExcludes.edit({ ...params }) -> ServerSideExcludes +- client.zones.settings.serverSideExcludes.get({ ...params }) -> ServerSideExcludes ### SortQueryStringForCache Types: -- ZoneSettingSortQueryStringForCache +- SortQueryStringForCache Methods: -- client.zones.settings.sortQueryStringForCache.edit({ ...params }) -> ZoneSettingSortQueryStringForCache -- client.zones.settings.sortQueryStringForCache.get({ ...params }) -> ZoneSettingSortQueryStringForCache +- client.zones.settings.sortQueryStringForCache.edit({ ...params }) -> SortQueryStringForCache +- client.zones.settings.sortQueryStringForCache.get({ ...params }) -> SortQueryStringForCache ### SSL Types: -- ZoneSettingSSL +- SSL Methods: -- client.zones.settings.ssl.edit({ ...params }) -> ZoneSettingSSL -- client.zones.settings.ssl.get({ ...params }) -> ZoneSettingSSL +- client.zones.settings.ssl.edit({ ...params }) -> SSL +- client.zones.settings.ssl.get({ ...params }) -> SSL ### SSLRecommender Types: -- ZoneSettingSSLRecommender +- SSLRecommender Methods: -- client.zones.settings.sslRecommender.edit({ ...params }) -> ZoneSettingSSLRecommender -- client.zones.settings.sslRecommender.get({ ...params }) -> ZoneSettingSSLRecommender +- client.zones.settings.sslRecommender.edit({ ...params }) -> SSLRecommender +- client.zones.settings.sslRecommender.get({ ...params }) -> SSLRecommender ### TLS1_3 Types: -- ZoneSettingTLS1_3 +- TLS1_3 Methods: -- client.zones.settings.tls1_3.edit({ ...params }) -> ZoneSettingTLS1_3 -- client.zones.settings.tls1_3.get({ ...params }) -> ZoneSettingTLS1_3 +- client.zones.settings.tls1_3.edit({ ...params }) -> TLS1_3 +- client.zones.settings.tls1_3.get({ ...params }) -> TLS1_3 ### TLSClientAuth Types: -- ZoneSettingTLSClientAuth +- TLSClientAuth Methods: -- client.zones.settings.tlsClientAuth.edit({ ...params }) -> ZoneSettingTLSClientAuth -- client.zones.settings.tlsClientAuth.get({ ...params }) -> ZoneSettingTLSClientAuth +- client.zones.settings.tlsClientAuth.edit({ ...params }) -> TLSClientAuth +- client.zones.settings.tlsClientAuth.get({ ...params }) -> TLSClientAuth ### TrueClientIPHeader Types: -- ZoneSettingTrueClientIPHeader +- TrueClientIPHeader Methods: -- client.zones.settings.trueClientIPHeader.edit({ ...params }) -> ZoneSettingTrueClientIPHeader -- client.zones.settings.trueClientIPHeader.get({ ...params }) -> ZoneSettingTrueClientIPHeader +- client.zones.settings.trueClientIPHeader.edit({ ...params }) -> TrueClientIPHeader +- client.zones.settings.trueClientIPHeader.get({ ...params }) -> TrueClientIPHeader ### WAF Types: -- ZoneSettingWAF +- WAF Methods: -- client.zones.settings.waf.edit({ ...params }) -> ZoneSettingWAF -- client.zones.settings.waf.get({ ...params }) -> ZoneSettingWAF +- client.zones.settings.waf.edit({ ...params }) -> WAF +- client.zones.settings.waf.get({ ...params }) -> WAF ### WebP Types: -- ZoneSettingWebP +- WebP Methods: -- client.zones.settings.WebP.edit({ ...params }) -> ZoneSettingWebP -- client.zones.settings.WebP.get({ ...params }) -> ZoneSettingWebP +- client.zones.settings.WebP.edit({ ...params }) -> WebP +- client.zones.settings.WebP.get({ ...params }) -> WebP ### Websocket Types: -- ZoneSettingWebsockets +- Websocket Methods: -- client.zones.settings.websocket.edit({ ...params }) -> ZoneSettingWebsockets -- client.zones.settings.websocket.get({ ...params }) -> ZoneSettingWebsockets +- client.zones.settings.websocket.edit({ ...params }) -> Websocket +- client.zones.settings.websocket.get({ ...params }) -> Websocket ### FontSettings Types: -- ZoneSettingFonts +- FontSettings Methods: -- client.zones.settings.fontSettings.edit({ ...params }) -> ZoneSettingFonts -- client.zones.settings.fontSettings.get({ ...params }) -> ZoneSettingFonts +- client.zones.settings.fontSettings.edit({ ...params }) -> FontSettings +- client.zones.settings.fontSettings.get({ ...params }) -> FontSettings ## CustomNameservers @@ -932,49 +850,46 @@ Methods: Types: -- HoldCreateResponse -- HoldDeleteResponse -- HoldGetResponse - -Methods: - -- client.zones.holds.create({ ...params }) -> HoldCreateResponse -- client.zones.holds.delete({ ...params }) -> HoldDeleteResponse -- client.zones.holds.get({ ...params }) -> HoldGetResponse - -## Workers - -### Script - -Types: - -- ScriptUpdateResponse +- ZoneHold Methods: -- client.zones.workers.script.update({ ...params }) -> ScriptUpdateResponse -- client.zones.workers.script.delete({ ...params }) -> void -- client.zones.workers.script.get({ ...params }) -> Response +- client.zones.holds.create({ ...params }) -> ZoneHold +- client.zones.holds.delete({ ...params }) -> ZoneHold +- client.zones.holds.get({ ...params }) -> ZoneHold ## Subscriptions Types: - SubscriptionCreateResponse -- SubscriptionListResponse - SubscriptionGetResponse Methods: - client.zones.subscriptions.create(identifier, { ...params }) -> SubscriptionCreateResponse -- client.zones.subscriptions.list(accountIdentifier) -> SubscriptionListResponsesSinglePage +- client.zones.subscriptions.list(accountIdentifier) -> SubscriptionsSinglePage - client.zones.subscriptions.get(identifier) -> SubscriptionGetResponse # LoadBalancers Types: +- AdaptiveRouting +- CheckRegion +- DefaultPools +- FilterOptions +- Header +- Host - LoadBalancer +- LoadShedding +- LocationStrategy +- NotificationFilter +- Origin +- OriginSteering +- RandomSteering +- Rules +- SessionAffinityAttributes - LoadBalancerDeleteResponse Methods: @@ -990,16 +905,17 @@ Methods: Types: +- Monitor - MonitorDeleteResponse Methods: -- client.loadBalancers.monitors.create({ ...params }) -> LoadBalancingMonitor -- client.loadBalancers.monitors.update(monitorId, { ...params }) -> LoadBalancingMonitor -- client.loadBalancers.monitors.list({ ...params }) -> LoadBalancingMonitorsSinglePage +- client.loadBalancers.monitors.create({ ...params }) -> Monitor +- client.loadBalancers.monitors.update(monitorId, { ...params }) -> Monitor +- client.loadBalancers.monitors.list({ ...params }) -> MonitorsSinglePage - client.loadBalancers.monitors.delete(monitorId, { ...params }) -> MonitorDeleteResponse -- client.loadBalancers.monitors.edit(monitorId, { ...params }) -> LoadBalancingMonitor -- client.loadBalancers.monitors.get(monitorId, { ...params }) -> LoadBalancingMonitor +- client.loadBalancers.monitors.edit(monitorId, { ...params }) -> Monitor +- client.loadBalancers.monitors.get(monitorId, { ...params }) -> Monitor ### Previews @@ -1025,16 +941,17 @@ Methods: Types: +- Pool - PoolDeleteResponse Methods: -- client.loadBalancers.pools.create({ ...params }) -> LoadBalancingPool -- client.loadBalancers.pools.update(poolId, { ...params }) -> LoadBalancingPool -- client.loadBalancers.pools.list({ ...params }) -> LoadBalancingPoolsSinglePage +- client.loadBalancers.pools.create({ ...params }) -> Pool +- client.loadBalancers.pools.update(poolId, { ...params }) -> Pool +- client.loadBalancers.pools.list({ ...params }) -> PoolsSinglePage - client.loadBalancers.pools.delete(poolId, { ...params }) -> PoolDeleteResponse -- client.loadBalancers.pools.edit(poolId, { ...params }) -> LoadBalancingPool -- client.loadBalancers.pools.get(poolId, { ...params }) -> LoadBalancingPool +- client.loadBalancers.pools.edit(poolId, { ...params }) -> Pool +- client.loadBalancers.pools.get(poolId, { ...params }) -> Pool ### Health @@ -1060,9 +977,13 @@ Methods: ## Previews +Types: + +- PreviewGetResponse + Methods: -- client.loadBalancers.previews.get(previewId, { ...params }) -> LoadBalancingPreview +- client.loadBalancers.previews.get(previewId, { ...params }) -> PreviewGetResponse ## Regions @@ -1100,6 +1021,8 @@ Methods: Types: +- CacheReserve +- CacheReserveClear - CacheReserveClearResponse - CacheReserveEditResponse - CacheReserveGetResponse @@ -1130,13 +1053,14 @@ Methods: Types: -- CacheVariants +- CacheVariant +- CacheVariantIdentifier - VariantEditResponse - VariantGetResponse Methods: -- client.cache.variants.delete({ ...params }) -> CacheVariants +- client.cache.variants.delete({ ...params }) -> CacheVariant - client.cache.variants.edit({ ...params }) -> VariantEditResponse - client.cache.variants.get({ ...params }) -> VariantGetResponse @@ -1144,6 +1068,7 @@ Methods: Types: +- RegionalTieredCache - RegionalTieredCacheEditResponse - RegionalTieredCacheGetResponse @@ -1168,6 +1093,7 @@ Methods: Types: +- Host - CertificatePackListResponse - CertificatePackDeleteResponse - CertificatePackEditResponse @@ -1227,7 +1153,7 @@ Methods: Types: -- TLSVerificationSetting +- Verification - VerificationEditResponse - VerificationGetResponse @@ -1242,7 +1168,6 @@ Types: - SubscriptionCreateResponse - SubscriptionUpdateResponse -- SubscriptionListResponse - SubscriptionDeleteResponse - SubscriptionGetResponse @@ -1250,8 +1175,8 @@ Methods: - client.subscriptions.create(identifier, { ...params }) -> SubscriptionCreateResponse - client.subscriptions.update(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionUpdateResponse -- client.subscriptions.list(accountIdentifier) -> SubscriptionListResponsesSinglePage -- client.subscriptions.delete(accountIdentifier, subscriptionIdentifier) -> SubscriptionDeleteResponse +- client.subscriptions.list(accountIdentifier) -> SubscriptionsSinglePage +- client.subscriptions.delete(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionDeleteResponse - client.subscriptions.get(identifier) -> SubscriptionGetResponse # ACM @@ -1322,12 +1247,15 @@ Methods: Types: +- HostnameAssociation - TLSHostnameAssociation +- HostnameAssociationUpdateResponse +- HostnameAssociationGetResponse Methods: -- client.certificateAuthorities.hostnameAssociations.update({ ...params }) -> TLSHostnameAssociation -- client.certificateAuthorities.hostnameAssociations.get({ ...params }) -> TLSHostnameAssociation +- client.certificateAuthorities.hostnameAssociations.update({ ...params }) -> HostnameAssociationUpdateResponse +- client.certificateAuthorities.hostnameAssociations.get({ ...params }) -> HostnameAssociationGetResponse # ClientCertificates @@ -1348,6 +1276,7 @@ Methods: Types: - CustomCertificate +- GeoRestrictions - CustomCertificateCreateResponse - CustomCertificateDeleteResponse - CustomCertificateEditResponse @@ -1375,7 +1304,10 @@ Methods: Types: +- BundleMethod - CustomHostname +- DCVMethod +- DomainValidationType - CustomHostnameCreateResponse - CustomHostnameListResponse - CustomHostnameDeleteResponse @@ -1424,11 +1356,40 @@ Methods: # DNS +Types: + +- DNSAnalyticsNominalMetric +- DNSAnalyticsQuery + ## Records Types: -- DNSRecord +- ARecord +- AAAARecord +- CAARecord +- CERTRecord +- CNAMERecord +- DNSKEYRecord +- DSRecord +- HTTPSRecord +- LOCRecord +- MXRecord +- NAPTRRecord +- NSRecord +- PTRRecord +- Record +- RecordMetadata +- RecordProcessTiming +- RecordTags +- SMIMEARecord +- SRVRecord +- SSHFPRecord +- SVCBRecord +- TLSARecord +- TTL +- TXTRecord +- URIRecord - RecordDeleteResponse - RecordExportResponse - RecordImportResponse @@ -1436,13 +1397,13 @@ Types: Methods: -- client.dns.records.create({ ...params }) -> DNSRecord -- client.dns.records.update(dnsRecordId, { ...params }) -> DNSRecord -- client.dns.records.list({ ...params }) -> DNSRecordsV4PagePaginationArray +- client.dns.records.create({ ...params }) -> Record +- client.dns.records.update(dnsRecordId, { ...params }) -> Record +- client.dns.records.list({ ...params }) -> RecordsV4PagePaginationArray - client.dns.records.delete(dnsRecordId, { ...params }) -> RecordDeleteResponse -- client.dns.records.edit(dnsRecordId, { ...params }) -> DNSRecord +- client.dns.records.edit(dnsRecordId, { ...params }) -> Record - client.dns.records.export({ ...params }) -> string -- client.dns.records.get(dnsRecordId, { ...params }) -> DNSRecord +- client.dns.records.get(dnsRecordId, { ...params }) -> Record - client.dns.records.import({ ...params }) -> RecordImportResponse - client.dns.records.scan({ ...params }) -> RecordScanResponse @@ -1452,36 +1413,39 @@ Methods: Types: -- DNSAnalyticsReport +- Report Methods: -- client.dns.analytics.reports.get({ ...params }) -> DNSAnalyticsReport +- client.dns.analytics.reports.get({ ...params }) -> Report #### Bytimes Types: -- DNSAnalyticsReportByTime +- ByTime Methods: -- client.dns.analytics.reports.bytimes.get({ ...params }) -> DNSAnalyticsReportByTime +- client.dns.analytics.reports.bytimes.get({ ...params }) -> ByTime ## Firewall Types: -- DNSFirewall +- AttackMitigation +- Firewall +- FirewallIPs +- UpstreamIPs - FirewallDeleteResponse Methods: -- client.dns.firewall.create({ ...params }) -> DNSFirewall -- client.dns.firewall.list({ ...params }) -> DNSFirewallsV4PagePaginationArray +- client.dns.firewall.create({ ...params }) -> Firewall +- client.dns.firewall.list({ ...params }) -> FirewallsV4PagePaginationArray - client.dns.firewall.delete(dnsFirewallId, { ...params }) -> FirewallDeleteResponse -- client.dns.firewall.edit(dnsFirewallId, { ...params }) -> DNSFirewall -- client.dns.firewall.get(dnsFirewallId, { ...params }) -> DNSFirewall +- client.dns.firewall.edit(dnsFirewallId, { ...params }) -> Firewall +- client.dns.firewall.get(dnsFirewallId, { ...params }) -> Firewall ### Analytics @@ -1489,13 +1453,13 @@ Methods: Methods: -- client.dns.firewall.analytics.reports.get(dnsFirewallId, { ...params }) -> DNSAnalyticsReport +- client.dns.firewall.analytics.reports.get(dnsFirewallId, { ...params }) -> Report ##### Bytimes Methods: -- client.dns.firewall.analytics.reports.bytimes.get(dnsFirewallId, { ...params }) -> DNSAnalyticsReportByTime +- client.dns.firewall.analytics.reports.bytimes.get(dnsFirewallId, { ...params }) -> ByTime # DNSSEC @@ -1514,22 +1478,19 @@ Methods: Types: -- EmailSettings -- EmailRoutingDisableResponse -- EmailRoutingEnableResponse -- EmailRoutingGetResponse +- Settings Methods: -- client.emailRouting.disable(zoneIdentifier) -> EmailRoutingDisableResponse -- client.emailRouting.enable(zoneIdentifier) -> EmailRoutingEnableResponse -- client.emailRouting.get(zoneIdentifier) -> EmailRoutingGetResponse +- client.emailRouting.disable(zoneIdentifier, { ...params }) -> Settings +- client.emailRouting.enable(zoneIdentifier, { ...params }) -> Settings +- client.emailRouting.get(zoneIdentifier) -> Settings ## DNS Types: -- EmailDNSRecord +- DNSRecord - DNSGetResponse Methods: @@ -1540,48 +1501,44 @@ Methods: Types: -- EmailRules -- RuleCreateResponse -- RuleUpdateResponse -- RuleListResponse -- RuleDeleteResponse -- RuleGetResponse +- Action +- EmailRoutingRule +- Matcher Methods: -- client.emailRouting.rules.create(zoneIdentifier, { ...params }) -> RuleCreateResponse -- client.emailRouting.rules.update(zoneIdentifier, ruleIdentifier, { ...params }) -> RuleUpdateResponse -- client.emailRouting.rules.list(zoneIdentifier, { ...params }) -> RuleListResponsesV4PagePaginationArray -- client.emailRouting.rules.delete(zoneIdentifier, ruleIdentifier) -> RuleDeleteResponse -- client.emailRouting.rules.get(zoneIdentifier, ruleIdentifier) -> RuleGetResponse +- client.emailRouting.rules.create(zoneIdentifier, { ...params }) -> EmailRoutingRule +- client.emailRouting.rules.update(zoneIdentifier, ruleIdentifier, { ...params }) -> EmailRoutingRule +- client.emailRouting.rules.list(zoneIdentifier, { ...params }) -> EmailRoutingRulesV4PagePaginationArray +- client.emailRouting.rules.delete(zoneIdentifier, ruleIdentifier) -> EmailRoutingRule +- client.emailRouting.rules.get(zoneIdentifier, ruleIdentifier) -> EmailRoutingRule ### CatchAlls Types: -- EmailCatchAllRule +- CatchAllAction +- CatchAllMatcher +- CatchAllUpdateResponse +- CatchAllGetResponse Methods: -- client.emailRouting.rules.catchAlls.update(zoneIdentifier, { ...params }) -> EmailCatchAllRule -- client.emailRouting.rules.catchAlls.get(zoneIdentifier) -> EmailCatchAllRule +- client.emailRouting.rules.catchAlls.update(zoneIdentifier, { ...params }) -> CatchAllUpdateResponse +- client.emailRouting.rules.catchAlls.get(zoneIdentifier) -> CatchAllGetResponse ## Addresses Types: -- EmailAddresses -- AddressCreateResponse -- AddressListResponse -- AddressDeleteResponse -- AddressGetResponse +- Address Methods: -- client.emailRouting.addresses.create(accountIdentifier, { ...params }) -> AddressCreateResponse -- client.emailRouting.addresses.list(accountIdentifier, { ...params }) -> AddressListResponsesV4PagePaginationArray -- client.emailRouting.addresses.delete(accountIdentifier, destinationAddressIdentifier) -> AddressDeleteResponse -- client.emailRouting.addresses.get(accountIdentifier, destinationAddressIdentifier) -> AddressGetResponse +- client.emailRouting.addresses.create(accountIdentifier, { ...params }) -> Address +- client.emailRouting.addresses.list(accountIdentifier, { ...params }) -> AddressesV4PagePaginationArray +- client.emailRouting.addresses.delete(accountIdentifier, destinationAddressIdentifier) -> Address +- client.emailRouting.addresses.get(accountIdentifier, destinationAddressIdentifier) -> Address # Filters @@ -1593,10 +1550,10 @@ Types: Methods: - client.filters.create(zoneIdentifier, { ...params }) -> FilterCreateResponse | null -- client.filters.update(zoneIdentifier, id, { ...params }) -> FirewallFilter | null +- client.filters.update(zoneIdentifier, id, { ...params }) -> FirewallFilter - client.filters.list(zoneIdentifier, { ...params }) -> FirewallFiltersV4PagePaginationArray -- client.filters.delete(zoneIdentifier, id) -> FirewallFilter | null -- client.filters.get(zoneIdentifier, id) -> FirewallFilter | null +- client.filters.delete(zoneIdentifier, id, { ...params }) -> FirewallFilter +- client.filters.get(zoneIdentifier, id) -> FirewallFilter # Firewall @@ -1604,38 +1561,49 @@ Methods: Types: -- FirewallZoneLockdown +- Configuration +- Lockdown +- LockdownCIDRConfiguration +- LockdownIPConfiguration +- LockdownURL - LockdownDeleteResponse Methods: -- client.firewall.lockdowns.create(zoneIdentifier, { ...params }) -> FirewallZoneLockdown | null -- client.firewall.lockdowns.update(zoneIdentifier, id, { ...params }) -> FirewallZoneLockdown | null -- client.firewall.lockdowns.list(zoneIdentifier, { ...params }) -> FirewallZoneLockdownsV4PagePaginationArray -- client.firewall.lockdowns.delete(zoneIdentifier, id) -> LockdownDeleteResponse -- client.firewall.lockdowns.get(zoneIdentifier, id) -> FirewallZoneLockdown | null +- client.firewall.lockdowns.create(zoneIdentifier, { ...params }) -> Lockdown +- client.firewall.lockdowns.update(zoneIdentifier, id, { ...params }) -> Lockdown +- client.firewall.lockdowns.list(zoneIdentifier, { ...params }) -> LockdownsV4PagePaginationArray +- client.firewall.lockdowns.delete(zoneIdentifier, id, { ...params }) -> LockdownDeleteResponse +- client.firewall.lockdowns.get(zoneIdentifier, id) -> Lockdown ## Rules Types: -- FirewallFilterRule +- FirewallRule +- Products +- DeletedFilter - RuleCreateResponse - RuleEditResponse Methods: - client.firewall.rules.create(zoneIdentifier, { ...params }) -> RuleCreateResponse | null -- client.firewall.rules.update(zoneIdentifier, id, { ...params }) -> FirewallFilterRule | null -- client.firewall.rules.list(zoneIdentifier, { ...params }) -> FirewallFilterRulesV4PagePaginationArray -- client.firewall.rules.delete(zoneIdentifier, id, { ...params }) -> FirewallFilterRule | null +- client.firewall.rules.update(zoneIdentifier, id, { ...params }) -> FirewallRule +- client.firewall.rules.list(zoneIdentifier, { ...params }) -> FirewallRulesV4PagePaginationArray +- client.firewall.rules.delete(zoneIdentifier, id, { ...params }) -> FirewallRule - client.firewall.rules.edit(zoneIdentifier, id, { ...params }) -> RuleEditResponse | null -- client.firewall.rules.get(zoneIdentifier, id) -> FirewallFilterRule | null +- client.firewall.rules.get(zoneIdentifier, { ...params }) -> FirewallRule ## AccessRules Types: +- AccessRuleCIDRConfiguration +- AccessRuleIPConfiguration +- ASNConfiguration +- CountryConfiguration +- IPV6Configuration - AccessRuleCreateResponse - AccessRuleListResponse - AccessRuleDeleteResponse @@ -1644,17 +1612,16 @@ Types: Methods: -- client.firewall.accessRules.create({ ...params }) -> AccessRuleCreateResponse | null +- client.firewall.accessRules.create({ ...params }) -> AccessRuleCreateResponse - client.firewall.accessRules.list({ ...params }) -> AccessRuleListResponsesV4PagePaginationArray - client.firewall.accessRules.delete(identifier, { ...params }) -> AccessRuleDeleteResponse | null -- client.firewall.accessRules.edit(identifier, { ...params }) -> AccessRuleEditResponse | null -- client.firewall.accessRules.get(identifier, { ...params }) -> AccessRuleGetResponse | null +- client.firewall.accessRules.edit(identifier, { ...params }) -> AccessRuleEditResponse +- client.firewall.accessRules.get(identifier, { ...params }) -> AccessRuleGetResponse ## UARules Types: -- FirewallUserAgentRule - UARuleCreateResponse - UARuleUpdateResponse - UARuleListResponse @@ -1663,11 +1630,11 @@ Types: Methods: -- client.firewall.uaRules.create(zoneIdentifier, { ...params }) -> UARuleCreateResponse | null -- client.firewall.uaRules.update(zoneIdentifier, id, { ...params }) -> UARuleUpdateResponse | null +- client.firewall.uaRules.create(zoneIdentifier, { ...params }) -> UARuleCreateResponse +- client.firewall.uaRules.update(zoneIdentifier, id, { ...params }) -> UARuleUpdateResponse - client.firewall.uaRules.list(zoneIdentifier, { ...params }) -> UARuleListResponsesV4PagePaginationArray -- client.firewall.uaRules.delete(zoneIdentifier, id) -> UARuleDeleteResponse | null -- client.firewall.uaRules.get(zoneIdentifier, id) -> UARuleGetResponse | null +- client.firewall.uaRules.delete(zoneIdentifier, id, { ...params }) -> UARuleDeleteResponse +- client.firewall.uaRules.get(zoneIdentifier, id) -> UARuleGetResponse ## WAF @@ -1675,16 +1642,19 @@ Methods: Types: -- WAFOverride +- Override +- OverrideURL +- RewriteAction +- WAFRule - OverrideDeleteResponse Methods: -- client.firewall.waf.overrides.create(zoneIdentifier, { ...params }) -> WAFOverride | null -- client.firewall.waf.overrides.update(zoneIdentifier, id, { ...params }) -> WAFOverride | null -- client.firewall.waf.overrides.list(zoneIdentifier, { ...params }) -> WAFOverridesV4PagePaginationArray -- client.firewall.waf.overrides.delete(zoneIdentifier, id) -> OverrideDeleteResponse -- client.firewall.waf.overrides.get(zoneIdentifier, id) -> WAFOverride | null +- client.firewall.waf.overrides.create(zoneIdentifier, { ...params }) -> Override +- client.firewall.waf.overrides.update(zoneIdentifier, id, { ...params }) -> Override +- client.firewall.waf.overrides.list(zoneIdentifier, { ...params }) -> OverridesV4PagePaginationArray +- client.firewall.waf.overrides.delete(zoneIdentifier, id, { ...params }) -> OverrideDeleteResponse +- client.firewall.waf.overrides.get(zoneIdentifier, id) -> Override ### Packages @@ -1702,13 +1672,13 @@ Methods: Types: -- WAFManagedRulesGroup +- Group - GroupEditResponse - GroupGetResponse Methods: -- client.firewall.waf.packages.groups.list(packageId, { ...params }) -> WAFManagedRulesGroupsV4PagePaginationArray +- client.firewall.waf.packages.groups.list(packageId, { ...params }) -> GroupsV4PagePaginationArray - client.firewall.waf.packages.groups.edit(packageId, groupId, { ...params }) -> GroupEditResponse - client.firewall.waf.packages.groups.get(packageId, groupId, { ...params }) -> GroupGetResponse @@ -1716,13 +1686,15 @@ Methods: Types: -- WAFManagedRulesRule +- AllowedModesAnomaly +- WAFRuleGroup +- RuleListResponse - RuleEditResponse - RuleGetResponse Methods: -- client.firewall.waf.packages.rules.list(packageId, { ...params }) -> WAFManagedRulesRulesV4PagePaginationArray +- client.firewall.waf.packages.rules.list(packageId, { ...params }) -> RuleListResponsesV4PagePaginationArray - client.firewall.waf.packages.rules.edit(packageId, ruleId, { ...params }) -> RuleEditResponse - client.firewall.waf.packages.rules.get(packageId, ruleId, { ...params }) -> RuleGetResponse @@ -1730,7 +1702,11 @@ Methods: Types: +- CheckRegion - Healthcheck +- HTTPConfiguration +- QueryHealthcheck +- TCPConfiguration - HealthcheckDeleteResponse Methods: @@ -1759,16 +1735,16 @@ Methods: Types: - KeylessCertificate -- KeylessCertificateHostname +- Tunnel - KeylessCertificateDeleteResponse Methods: -- client.keylessCertificates.create({ ...params }) -> KeylessCertificateHostname -- client.keylessCertificates.list({ ...params }) -> KeylessCertificateHostnamesSinglePage +- client.keylessCertificates.create({ ...params }) -> KeylessCertificate +- client.keylessCertificates.list({ ...params }) -> KeylessCertificatesSinglePage - client.keylessCertificates.delete(keylessCertificateId, { ...params }) -> KeylessCertificateDeleteResponse -- client.keylessCertificates.edit(keylessCertificateId, { ...params }) -> KeylessCertificateHostname -- client.keylessCertificates.get(keylessCertificateId, { ...params }) -> KeylessCertificateHostname +- client.keylessCertificates.edit(keylessCertificateId, { ...params }) -> KeylessCertificate +- client.keylessCertificates.get(keylessCertificateId, { ...params }) -> KeylessCertificate # Logpush @@ -1788,7 +1764,6 @@ Methods: Types: -- LogpushJob - JobGetResponse Methods: @@ -1811,6 +1786,8 @@ Methods: Types: +- LogpushJob +- OutputOptions - JobDeleteResponse Methods: @@ -1825,13 +1802,13 @@ Methods: Types: +- OwnershipValidation - OwnershipCreateResponse -- OwnershipValidateResponse Methods: - client.logpush.ownership.create({ ...params }) -> OwnershipCreateResponse | null -- client.logpush.ownership.validate({ ...params }) -> OwnershipValidateResponse | null +- client.logpush.ownership.validate({ ...params }) -> OwnershipValidation | null ## Validate @@ -1912,16 +1889,15 @@ Methods: Types: -- OriginTLSClientCertificateZoneAuthenticatedOriginPull +- ZoneAuthenticatedOriginPull - OriginTLSClientAuthCreateResponse -- OriginTLSClientAuthListResponse - OriginTLSClientAuthDeleteResponse - OriginTLSClientAuthGetResponse Methods: - client.originTLSClientAuth.create({ ...params }) -> OriginTLSClientAuthCreateResponse -- client.originTLSClientAuth.list({ ...params }) -> OriginTLSClientAuthListResponsesSinglePage +- client.originTLSClientAuth.list({ ...params }) -> ZoneAuthenticatedOriginPullsSinglePage - client.originTLSClientAuth.delete(certificateId, { ...params }) -> OriginTLSClientAuthDeleteResponse - client.originTLSClientAuth.get(certificateId, { ...params }) -> OriginTLSClientAuthGetResponse @@ -1929,27 +1905,29 @@ Methods: Types: -- OriginTLSClientCertificateAuthenticatedOriginPull -- OriginTLSClientCertificateID +- AuthenticatedOriginPull - HostnameUpdateResponse Methods: - client.originTLSClientAuth.hostnames.update({ ...params }) -> HostnameUpdateResponse | null -- client.originTLSClientAuth.hostnames.get(hostname, { ...params }) -> OriginTLSClientCertificateID +- client.originTLSClientAuth.hostnames.get(hostname, { ...params }) -> AuthenticatedOriginPull ### Certificates Types: -- OriginTLSClientCertificate +- Certificate +- CertificateCreateResponse +- CertificateDeleteResponse +- CertificateGetResponse Methods: -- client.originTLSClientAuth.hostnames.certificates.create({ ...params }) -> OriginTLSClientCertificate -- client.originTLSClientAuth.hostnames.certificates.list({ ...params }) -> OriginTLSClientCertificateIDsSinglePage -- client.originTLSClientAuth.hostnames.certificates.delete(certificateId, { ...params }) -> OriginTLSClientCertificate -- client.originTLSClientAuth.hostnames.certificates.get(certificateId, { ...params }) -> OriginTLSClientCertificate +- client.originTLSClientAuth.hostnames.certificates.create({ ...params }) -> CertificateCreateResponse +- client.originTLSClientAuth.hostnames.certificates.list({ ...params }) -> AuthenticatedOriginPullsSinglePage +- client.originTLSClientAuth.hostnames.certificates.delete(certificateId, { ...params }) -> CertificateDeleteResponse +- client.originTLSClientAuth.hostnames.certificates.get(certificateId, { ...params }) -> CertificateGetResponse ## Settings @@ -1967,7 +1945,10 @@ Methods: Types: -- ZonesPagerule +- PageRule +- Route +- Target +- URLTarget - PageruleCreateResponse - PageruleUpdateResponse - PageruleListResponse @@ -1988,30 +1969,31 @@ Methods: Types: -- ZonePageruleSettings +- SettingListResponse Methods: -- client.pagerules.settings.list({ ...params }) -> ZonePageruleSettings +- client.pagerules.settings.list({ ...params }) -> SettingListResponse # RateLimits Types: +- Action +- Methods - RateLimit - RateLimitCreateResponse -- RateLimitListResponse - RateLimitDeleteResponse - RateLimitEditResponse - RateLimitGetResponse Methods: -- client.rateLimits.create(zoneIdentifier, { ...params }) -> RateLimitCreateResponse | null -- client.rateLimits.list(zoneIdentifier, { ...params }) -> RateLimitListResponsesV4PagePaginationArray -- client.rateLimits.delete(zoneIdentifier, id) -> RateLimitDeleteResponse | null -- client.rateLimits.edit(zoneIdentifier, id, { ...params }) -> RateLimitEditResponse | null -- client.rateLimits.get(zoneIdentifier, id) -> RateLimitGetResponse | null +- client.rateLimits.create(zoneIdentifier, { ...params }) -> RateLimitCreateResponse +- client.rateLimits.list(zoneIdentifier, { ...params }) -> RateLimitsV4PagePaginationArray +- client.rateLimits.delete(zoneIdentifier, id, { ...params }) -> RateLimitDeleteResponse +- client.rateLimits.edit(zoneIdentifier, id, { ...params }) -> RateLimitEditResponse +- client.rateLimits.get(zoneIdentifier, id) -> RateLimitGetResponse # SecondaryDNS @@ -2019,16 +2001,17 @@ Methods: Types: -- SecondaryDNSForce +- ForceAXFR Methods: -- client.secondaryDNS.forceAXFR.create({ ...params }) -> SecondaryDNSForce +- client.secondaryDNS.forceAXFR.create({ ...params }) -> ForceAXFR ## Incoming Types: +- Incoming - IncomingCreateResponse - IncomingUpdateResponse - IncomingDeleteResponse @@ -2045,8 +2028,10 @@ Methods: Types: -- SecondaryDNSDisableTransfer -- SecondaryDNSEnableTransfer +- DisableTransfer +- EnableTransfer +- Outgoing +- OutgoingStatus - OutgoingCreateResponse - OutgoingUpdateResponse - OutgoingDeleteResponse @@ -2058,8 +2043,8 @@ Methods: - client.secondaryDNS.outgoing.create({ ...params }) -> OutgoingCreateResponse - client.secondaryDNS.outgoing.update({ ...params }) -> OutgoingUpdateResponse - client.secondaryDNS.outgoing.delete({ ...params }) -> OutgoingDeleteResponse -- client.secondaryDNS.outgoing.disable({ ...params }) -> SecondaryDNSDisableTransfer -- client.secondaryDNS.outgoing.enable({ ...params }) -> SecondaryDNSEnableTransfer +- client.secondaryDNS.outgoing.disable({ ...params }) -> DisableTransfer +- client.secondaryDNS.outgoing.enable({ ...params }) -> EnableTransfer - client.secondaryDNS.outgoing.forceNotify({ ...params }) -> OutgoingForceNotifyResponse - client.secondaryDNS.outgoing.get({ ...params }) -> OutgoingGetResponse @@ -2067,68 +2052,71 @@ Methods: Methods: -- client.secondaryDNS.outgoing.status.get({ ...params }) -> SecondaryDNSEnableTransfer +- client.secondaryDNS.outgoing.status.get({ ...params }) -> EnableTransfer ## ACLs Types: -- SecondaryDNSACL +- ACL - ACLDeleteResponse Methods: -- client.secondaryDNS.acls.create({ ...params }) -> SecondaryDNSACL -- client.secondaryDNS.acls.update(aclId, { ...params }) -> SecondaryDNSACL -- client.secondaryDNS.acls.list({ ...params }) -> SecondaryDnsaclsSinglePage +- client.secondaryDNS.acls.create({ ...params }) -> ACL +- client.secondaryDNS.acls.update(aclId, { ...params }) -> ACL +- client.secondaryDNS.acls.list({ ...params }) -> ACLsSinglePage - client.secondaryDNS.acls.delete(aclId, { ...params }) -> ACLDeleteResponse -- client.secondaryDNS.acls.get(aclId, { ...params }) -> SecondaryDNSACL +- client.secondaryDNS.acls.get(aclId, { ...params }) -> ACL ## Peers Types: -- SecondaryDNSPeer +- Peer - PeerDeleteResponse Methods: -- client.secondaryDNS.peers.create({ ...params }) -> SecondaryDNSPeer -- client.secondaryDNS.peers.update(peerId, { ...params }) -> SecondaryDNSPeer -- client.secondaryDNS.peers.list({ ...params }) -> SecondaryDNSPeersSinglePage +- client.secondaryDNS.peers.create({ ...params }) -> Peer +- client.secondaryDNS.peers.update(peerId, { ...params }) -> Peer +- client.secondaryDNS.peers.list({ ...params }) -> PeersSinglePage - client.secondaryDNS.peers.delete(peerId, { ...params }) -> PeerDeleteResponse -- client.secondaryDNS.peers.get(peerId, { ...params }) -> SecondaryDNSPeer +- client.secondaryDNS.peers.get(peerId, { ...params }) -> Peer ## TSIGs Types: -- SecondaryDNSTSIG +- TSIG - TSIGDeleteResponse Methods: -- client.secondaryDNS.tsigs.create({ ...params }) -> SecondaryDNSTSIG -- client.secondaryDNS.tsigs.update(tsigId, { ...params }) -> SecondaryDNSTSIG -- client.secondaryDNS.tsigs.list({ ...params }) -> SecondaryDnstsigsSinglePage +- client.secondaryDNS.tsigs.create({ ...params }) -> TSIG +- client.secondaryDNS.tsigs.update(tsigId, { ...params }) -> TSIG +- client.secondaryDNS.tsigs.list({ ...params }) -> TSIGsSinglePage - client.secondaryDNS.tsigs.delete(tsigId, { ...params }) -> TSIGDeleteResponse -- client.secondaryDNS.tsigs.get(tsigId, { ...params }) -> SecondaryDNSTSIG +- client.secondaryDNS.tsigs.get(tsigId, { ...params }) -> TSIG # WaitingRooms Types: +- AdditionalRoutes +- CookieAttributes +- Query - WaitingRoom - WaitingRoomDeleteResponse Methods: -- client.waitingRooms.create(zoneIdentifier, { ...params }) -> WaitingRoom -- client.waitingRooms.update(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingRoom -- client.waitingRooms.list(zoneIdentifier) -> WaitingRoomsSinglePage -- client.waitingRooms.delete(zoneIdentifier, waitingRoomId) -> WaitingRoomDeleteResponse -- client.waitingRooms.edit(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingRoom -- client.waitingRooms.get(zoneIdentifier, waitingRoomId) -> WaitingRoom +- client.waitingRooms.create({ ...params }) -> WaitingRoom +- client.waitingRooms.update(waitingRoomId, { ...params }) -> WaitingRoom +- client.waitingRooms.list({ ...params }) -> WaitingRoomsSinglePage +- client.waitingRooms.delete(waitingRoomId, { ...params }) -> WaitingRoomDeleteResponse +- client.waitingRooms.edit(waitingRoomId, { ...params }) -> WaitingRoom +- client.waitingRooms.get(waitingRoomId, { ...params }) -> WaitingRoom ## Page @@ -2138,39 +2126,40 @@ Types: Methods: -- client.waitingRooms.page.preview(zoneIdentifier, { ...params }) -> PagePreviewResponse +- client.waitingRooms.page.preview({ ...params }) -> PagePreviewResponse ## Events Types: -- WaitingroomEvent +- Event - EventDeleteResponse Methods: -- client.waitingRooms.events.create(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingroomEvent -- client.waitingRooms.events.update(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> WaitingroomEvent -- client.waitingRooms.events.list(zoneIdentifier, waitingRoomId) -> WaitingroomEventsSinglePage -- client.waitingRooms.events.delete(zoneIdentifier, waitingRoomId, eventId) -> EventDeleteResponse -- client.waitingRooms.events.edit(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> WaitingroomEvent -- client.waitingRooms.events.get(zoneIdentifier, waitingRoomId, eventId) -> WaitingroomEvent +- client.waitingRooms.events.create(waitingRoomId, { ...params }) -> Event +- client.waitingRooms.events.update(waitingRoomId, eventId, { ...params }) -> Event +- client.waitingRooms.events.list(waitingRoomId, { ...params }) -> EventsSinglePage +- client.waitingRooms.events.delete(waitingRoomId, eventId, { ...params }) -> EventDeleteResponse +- client.waitingRooms.events.edit(waitingRoomId, eventId, { ...params }) -> Event +- client.waitingRooms.events.get(waitingRoomId, eventId, { ...params }) -> Event ### Details Types: -- WaitingroomEventDetails +- EventQuery +- DetailGetResponse Methods: -- client.waitingRooms.events.details.get(zoneIdentifier, waitingRoomId, eventId) -> WaitingroomEventDetails +- client.waitingRooms.events.details.get(waitingRoomId, eventId, { ...params }) -> DetailGetResponse ## Rules Types: -- WaitingroomRule +- WaitingRoomRule - RuleCreateResponse - RuleUpdateResponse - RuleDeleteResponse @@ -2178,11 +2167,11 @@ Types: Methods: -- client.waitingRooms.rules.create(zoneIdentifier, waitingRoomId, { ...params }) -> RuleCreateResponse | null -- client.waitingRooms.rules.update(zoneIdentifier, waitingRoomId, [ ...body ]) -> RuleUpdateResponse | null -- client.waitingRooms.rules.list(zoneIdentifier, waitingRoomId) -> WaitingroomRulesSinglePage -- client.waitingRooms.rules.delete(zoneIdentifier, waitingRoomId, ruleId) -> RuleDeleteResponse | null -- client.waitingRooms.rules.edit(zoneIdentifier, waitingRoomId, ruleId, { ...params }) -> RuleEditResponse | null +- client.waitingRooms.rules.create(waitingRoomId, { ...params }) -> RuleCreateResponse | null +- client.waitingRooms.rules.update(waitingRoomId, [ ...body ]) -> RuleUpdateResponse | null +- client.waitingRooms.rules.list(waitingRoomId, { ...params }) -> WaitingRoomRulesSinglePage +- client.waitingRooms.rules.delete(waitingRoomId, ruleId, { ...params }) -> RuleDeleteResponse | null +- client.waitingRooms.rules.edit(waitingRoomId, ruleId, { ...params }) -> RuleEditResponse | null ## Statuses @@ -2192,21 +2181,22 @@ Types: Methods: -- client.waitingRooms.statuses.get(zoneIdentifier, waitingRoomId) -> StatusGetResponse +- client.waitingRooms.statuses.get(waitingRoomId, { ...params }) -> StatusGetResponse ## Settings Types: +- Setting - SettingUpdateResponse - SettingEditResponse - SettingGetResponse Methods: -- client.waitingRooms.settings.update(zoneIdentifier, { ...params }) -> SettingUpdateResponse -- client.waitingRooms.settings.edit(zoneIdentifier, { ...params }) -> SettingEditResponse -- client.waitingRooms.settings.get(zoneIdentifier) -> SettingGetResponse +- client.waitingRooms.settings.update({ ...params }) -> SettingUpdateResponse +- client.waitingRooms.settings.edit({ ...params }) -> SettingEditResponse +- client.waitingRooms.settings.get({ ...params }) -> SettingGetResponse # Web3 @@ -2214,16 +2204,16 @@ Methods: Types: -- DistributedWebHostname +- Hostname - HostnameDeleteResponse Methods: -- client.web3.hostnames.create(zoneIdentifier, { ...params }) -> DistributedWebHostname -- client.web3.hostnames.list(zoneIdentifier) -> DistributedWebHostnamesSinglePage -- client.web3.hostnames.delete(zoneIdentifier, identifier) -> HostnameDeleteResponse | null -- client.web3.hostnames.edit(zoneIdentifier, identifier, { ...params }) -> DistributedWebHostname -- client.web3.hostnames.get(zoneIdentifier, identifier) -> DistributedWebHostname +- client.web3.hostnames.create(zoneIdentifier, { ...params }) -> Hostname +- client.web3.hostnames.list(zoneIdentifier) -> HostnamesSinglePage +- client.web3.hostnames.delete(zoneIdentifier, identifier, { ...params }) -> HostnameDeleteResponse | null +- client.web3.hostnames.edit(zoneIdentifier, identifier, { ...params }) -> Hostname +- client.web3.hostnames.get(zoneIdentifier, identifier) -> Hostname ### IPFSUniversalPaths @@ -2231,31 +2221,49 @@ Methods: Types: -- DistributedWebConfigContentList +- ContentList Methods: -- client.web3.hostnames.ipfsUniversalPaths.contentLists.update(zoneIdentifier, identifier, { ...params }) -> DistributedWebConfigContentList -- client.web3.hostnames.ipfsUniversalPaths.contentLists.get(zoneIdentifier, identifier) -> DistributedWebConfigContentList +- client.web3.hostnames.ipfsUniversalPaths.contentLists.update(zoneIdentifier, identifier, { ...params }) -> ContentList +- client.web3.hostnames.ipfsUniversalPaths.contentLists.get(zoneIdentifier, identifier) -> ContentList ##### Entries Types: -- DistributedWebConfigContentListEntry +- EntryCreateResponse +- EntryUpdateResponse - EntryListResponse - EntryDeleteResponse +- EntryGetResponse Methods: -- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.create(zoneIdentifier, identifier, { ...params }) -> DistributedWebConfigContentListEntry -- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(zoneIdentifier, identifier, contentListEntryIdentifier, { ...params }) -> DistributedWebConfigContentListEntry +- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.create(zoneIdentifier, identifier, { ...params }) -> EntryCreateResponse +- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(zoneIdentifier, identifier, contentListEntryIdentifier, { ...params }) -> EntryUpdateResponse - client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.list(zoneIdentifier, identifier) -> EntryListResponse | null -- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(zoneIdentifier, identifier, contentListEntryIdentifier) -> EntryDeleteResponse | null -- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(zoneIdentifier, identifier, contentListEntryIdentifier) -> DistributedWebConfigContentListEntry +- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(zoneIdentifier, identifier, contentListEntryIdentifier, { ...params }) -> EntryDeleteResponse | null +- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(zoneIdentifier, identifier, contentListEntryIdentifier) -> EntryGetResponse # Workers +Types: + +- Binding +- D1Binding +- DispatchNamespaceBinding +- DurableObjectBinding +- KVNamespaceBinding +- MigrationStep +- MTLSCERTBinding +- PlacementConfiguration +- R2Binding +- ServiceBinding +- SingleStepMigration +- SteppedMigration +- WorkerMetadata + ## AI Types: @@ -2270,30 +2278,21 @@ Methods: Types: -- WorkersScript +- Script +- ScriptSetting Methods: -- client.workers.scripts.update(scriptName, { ...params }) -> WorkersScript -- client.workers.scripts.list({ ...params }) -> WorkersScriptsSinglePage +- client.workers.scripts.update(scriptName, { ...params }) -> Script +- client.workers.scripts.list({ ...params }) -> ScriptsSinglePage - client.workers.scripts.delete(scriptName, { ...params }) -> void - client.workers.scripts.get(scriptName, { ...params }) -> Response -### Bindings - -Types: - -- WorkersBinding -- BindingGetResponse - -Methods: - -- client.workers.scripts.bindings.get({ ...params }) -> BindingGetResponse - ### Schedules Types: +- Schedule - ScheduleUpdateResponse - ScheduleGetResponse @@ -2306,6 +2305,7 @@ Methods: Types: +- ConsumerScript - TailCreateResponse - TailDeleteResponse - TailGetResponse @@ -2316,72 +2316,46 @@ Methods: - client.workers.scripts.tail.delete(scriptName, id, { ...params }) -> TailDeleteResponse - client.workers.scripts.tail.get(scriptName, { ...params }) -> TailGetResponse -### UsageModel - -Types: - -- UsageModelUpdateResponse -- UsageModelGetResponse - -Methods: - -- client.workers.scripts.usageModel.update(scriptName, { ...params }) -> UsageModelUpdateResponse -- client.workers.scripts.usageModel.get(scriptName, { ...params }) -> UsageModelGetResponse - ### Content Methods: -- client.workers.scripts.content.update(scriptName, { ...params }) -> WorkersScript - -### ContentV2 - -Methods: - -- client.workers.scripts.contentV2.get(scriptName, { ...params }) -> Response +- client.workers.scripts.content.update(scriptName, { ...params }) -> Script +- client.workers.scripts.content.get(scriptName, { ...params }) -> Response ### Settings -Types: - -- SettingEditResponse -- SettingGetResponse - Methods: -- client.workers.scripts.settings.edit(scriptName, { ...params }) -> SettingEditResponse -- client.workers.scripts.settings.get(scriptName, { ...params }) -> SettingGetResponse +- client.workers.scripts.settings.edit(scriptName, { ...params }) -> ScriptSetting +- client.workers.scripts.settings.get(scriptName, { ...params }) -> ScriptSetting -## Filters +### Deployments Types: -- WorkersFilter -- FilterCreateResponse -- FilterDeleteResponse +- Deployment +- DeploymentCreateResponse +- DeploymentGetResponse Methods: -- client.workers.filters.create({ ...params }) -> FilterCreateResponse | null -- client.workers.filters.update(filterId, { ...params }) -> WorkersFilter -- client.workers.filters.list({ ...params }) -> WorkersFiltersSinglePage -- client.workers.filters.delete(filterId, { ...params }) -> FilterDeleteResponse | null +- client.workers.scripts.deployments.create(scriptName, { ...params }) -> DeploymentCreateResponse +- client.workers.scripts.deployments.get(scriptName, { ...params }) -> DeploymentGetResponse -## Routes +### Versions Types: -- WorkersRoute -- RouteCreateResponse -- RouteDeleteResponse +- VersionCreateResponse +- VersionListResponse +- VersionGetResponse Methods: -- client.workers.routes.create({ ...params }) -> RouteCreateResponse -- client.workers.routes.update(routeId, { ...params }) -> WorkersRoute -- client.workers.routes.list({ ...params }) -> WorkersRoutesSinglePage -- client.workers.routes.delete(routeId, { ...params }) -> RouteDeleteResponse -- client.workers.routes.get(routeId, { ...params }) -> WorkersRoute +- client.workers.scripts.versions.create(scriptName, { ...params }) -> VersionCreateResponse +- client.workers.scripts.versions.list(scriptName, { ...params }) -> VersionListResponse +- client.workers.scripts.versions.get(scriptName, versionId, { ...params }) -> VersionGetResponse ## AccountSettings @@ -2395,40 +2369,18 @@ Methods: - client.workers.accountSettings.update({ ...params }) -> AccountSettingUpdateResponse - client.workers.accountSettings.get({ ...params }) -> AccountSettingGetResponse -## Deployments - -### ByScripts - -Types: - -- ByScriptGetResponse - -Methods: - -- client.workers.deployments.byScripts.get(scriptId, { ...params }) -> ByScriptGetResponse - -#### Details - -Types: - -- DetailGetResponse - -Methods: - -- client.workers.deployments.byScripts.details.get(scriptId, deploymentId, { ...params }) -> DetailGetResponse - ## Domains Types: -- WorkersDomain +- Domain Methods: -- client.workers.domains.update({ ...params }) -> WorkersDomain -- client.workers.domains.list({ ...params }) -> WorkersDomainsSinglePage +- client.workers.domains.update({ ...params }) -> Domain +- client.workers.domains.list({ ...params }) -> DomainsSinglePage - client.workers.domains.delete(domainId, { ...params }) -> void -- client.workers.domains.get(domainId, { ...params }) -> WorkersDomain +- client.workers.domains.get(domainId, { ...params }) -> Domain ## Subdomains @@ -2442,44 +2394,21 @@ Methods: - client.workers.subdomains.update({ ...params }) -> SubdomainUpdateResponse - client.workers.subdomains.get({ ...params }) -> SubdomainGetResponse -## Services - -### Environments - -#### Content - -Methods: - -- client.workers.services.environments.content.update(serviceName, environmentName, { ...params }) -> WorkersScript -- client.workers.services.environments.content.get(serviceName, environmentName, { ...params }) -> Response - -#### Settings - -Types: - -- SettingEditResponse -- SettingGetResponse - -Methods: - -- client.workers.services.environments.settings.edit(serviceName, environmentName, { ...params }) -> SettingEditResponse -- client.workers.services.environments.settings.get(serviceName, environmentName, { ...params }) -> SettingGetResponse - # KV ## Namespaces Types: -- WorkersKVNamespace +- Namespace - NamespaceUpdateResponse - NamespaceDeleteResponse Methods: -- client.kv.namespaces.create({ ...params }) -> WorkersKVNamespace +- client.kv.namespaces.create({ ...params }) -> Namespace - client.kv.namespaces.update(namespaceId, { ...params }) -> NamespaceUpdateResponse -- client.kv.namespaces.list({ ...params }) -> WorkersKVNamespacesV4PagePaginationArray +- client.kv.namespaces.list({ ...params }) -> NamespacesV4PagePaginationArray - client.kv.namespaces.delete(namespaceId, { ...params }) -> NamespaceDeleteResponse ### Bulk @@ -2498,11 +2427,11 @@ Methods: Types: -- WorkersKVKey +- Key Methods: -- client.kv.namespaces.keys.list(namespaceId, { ...params }) -> WorkersKVKeysCursorLimitPagination +- client.kv.namespaces.keys.list(namespaceId, { ...params }) -> KeysCursorLimitPagination ### Metadata @@ -2534,11 +2463,11 @@ Methods: Types: -- DurableObjectNamespace +- Namespace Methods: -- client.durableObjects.namespaces.list({ ...params }) -> DurableObjectNamespacesSinglePage +- client.durableObjects.namespaces.list({ ...params }) -> NamespacesSinglePage ### Objects @@ -2557,24 +2486,21 @@ Types: - Queue - QueueCreated - QueueUpdated -- QueueCreateResponse -- QueueUpdateResponse -- QueueListResponse - QueueDeleteResponse -- QueueGetResponse Methods: -- client.queues.create({ ...params }) -> QueueCreateResponse | null -- client.queues.update(queueId, { ...params }) -> QueueUpdateResponse | null -- client.queues.list({ ...params }) -> QueueListResponsesSinglePage +- client.queues.create({ ...params }) -> QueueCreated | null +- client.queues.update(queueId, { ...params }) -> QueueUpdated | null +- client.queues.list({ ...params }) -> QueuesSinglePage - client.queues.delete(queueId, { ...params }) -> QueueDeleteResponse | null -- client.queues.get(queueId, { ...params }) -> QueueGetResponse | null +- client.queues.get(queueId, { ...params }) -> Queue | null ## Consumers Types: +- Consumer - ConsumerCreateResponse - ConsumerUpdateResponse - ConsumerDeleteResponse @@ -2591,9 +2517,6 @@ Methods: Types: -- QueueConsumer -- QueueConsumerCreated -- QueueConsumerUpdated - MessageAckResponse - MessagePullResponse @@ -2606,6 +2529,7 @@ Methods: Types: +- RequestModel - ManagedHeaderListResponse - ManagedHeaderEditResponse @@ -2618,49 +2542,49 @@ Methods: Types: -- PageShieldSetting +- Setting - PageShieldUpdateResponse Methods: - client.pageShield.update({ ...params }) -> PageShieldUpdateResponse -- client.pageShield.get({ ...params }) -> PageShieldSetting +- client.pageShield.get({ ...params }) -> Setting ## Policies Types: -- PageShieldPolicy +- Policy Methods: -- client.pageShield.policies.create({ ...params }) -> PageShieldPolicy -- client.pageShield.policies.update(policyId, { ...params }) -> PageShieldPolicy -- client.pageShield.policies.list({ ...params }) -> PageShieldPoliciesSinglePage +- client.pageShield.policies.create({ ...params }) -> Policy +- client.pageShield.policies.update(policyId, { ...params }) -> Policy +- client.pageShield.policies.list({ ...params }) -> PoliciesSinglePage - client.pageShield.policies.delete(policyId, { ...params }) -> void -- client.pageShield.policies.get(policyId, { ...params }) -> PageShieldPolicy +- client.pageShield.policies.get(policyId, { ...params }) -> Policy ## Connections Types: -- PageShieldConnection +- Connection Methods: -- client.pageShield.connections.list({ ...params }) -> PageShieldConnectionsSinglePage -- client.pageShield.connections.get(connectionId, { ...params }) -> PageShieldConnection +- client.pageShield.connections.list({ ...params }) -> ConnectionsSinglePage +- client.pageShield.connections.get(connectionId, { ...params }) -> Connection ## Scripts Types: -- PageShieldScript +- Script - ScriptGetResponse Methods: -- client.pageShield.scripts.list({ ...params }) -> PageShieldScriptsSinglePage +- client.pageShield.scripts.list({ ...params }) -> ScriptsSinglePage - client.pageShield.scripts.get(scriptId, { ...params }) -> ScriptGetResponse # Rulesets @@ -2668,59 +2592,94 @@ Methods: Types: - Ruleset -- RulesetListResponse +- RulesetCreateResponse +- RulesetUpdateResponse +- RulesetGetResponse Methods: -- client.rulesets.create({ ...params }) -> Ruleset -- client.rulesets.update(rulesetId, { ...params }) -> Ruleset -- client.rulesets.list({ ...params }) -> RulesetListResponsesSinglePage +- client.rulesets.create({ ...params }) -> RulesetCreateResponse +- client.rulesets.update(rulesetId, { ...params }) -> RulesetUpdateResponse +- client.rulesets.list({ ...params }) -> RulesetsSinglePage - client.rulesets.delete(rulesetId, { ...params }) -> void -- client.rulesets.get(rulesetId, { ...params }) -> Ruleset +- client.rulesets.get(rulesetId, { ...params }) -> RulesetGetResponse ## Phases +Types: + +- PhaseUpdateResponse +- PhaseGetResponse + Methods: -- client.rulesets.phases.update(rulesetPhase, { ...params }) -> Ruleset -- client.rulesets.phases.get(rulesetPhase, { ...params }) -> Ruleset +- client.rulesets.phases.update(rulesetPhase, { ...params }) -> PhaseUpdateResponse +- client.rulesets.phases.get(rulesetPhase, { ...params }) -> PhaseGetResponse ### Versions Types: -- VersionListResponse +- VersionGetResponse Methods: -- client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage -- client.rulesets.phases.versions.get(rulesetPhase, rulesetVersion, { ...params }) -> Ruleset +- client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> RulesetsSinglePage +- client.rulesets.phases.versions.get(rulesetPhase, rulesetVersion, { ...params }) -> VersionGetResponse ## Rules +Types: + +- BlockRule +- ChallengeRule +- CompressResponseRule +- ExecuteRule +- JSChallengeRule +- LogRule +- Logging +- ManagedChallengeRule +- RedirectRule +- RewriteRule +- RewriteURIPart +- RouteRule +- RulesetRule +- ScoreRule +- ServeErrorRule +- SetCacheSettingsRule +- SetConfigRule +- SkipRule +- RuleCreateResponse +- RuleDeleteResponse +- RuleEditResponse + Methods: -- client.rulesets.rules.create(rulesetId, { ...params }) -> Ruleset -- client.rulesets.rules.delete(rulesetId, ruleId, { ...params }) -> Ruleset -- client.rulesets.rules.edit(rulesetId, ruleId, { ...params }) -> Ruleset +- client.rulesets.rules.create(rulesetId, { ...params }) -> RuleCreateResponse +- client.rulesets.rules.delete(rulesetId, ruleId, { ...params }) -> RuleDeleteResponse +- client.rulesets.rules.edit(rulesetId, ruleId, { ...params }) -> RuleEditResponse ## Versions Types: -- VersionListResponse +- VersionGetResponse Methods: -- client.rulesets.versions.list(rulesetId, { ...params }) -> VersionListResponsesSinglePage +- client.rulesets.versions.list(rulesetId, { ...params }) -> RulesetsSinglePage - client.rulesets.versions.delete(rulesetId, rulesetVersion, { ...params }) -> void -- client.rulesets.versions.get(rulesetId, rulesetVersion, { ...params }) -> Ruleset +- client.rulesets.versions.get(rulesetId, rulesetVersion, { ...params }) -> VersionGetResponse ### ByTag +Types: + +- ByTagGetResponse + Methods: -- client.rulesets.versions.byTag.get(rulesetId, rulesetVersion, ruleTag, { ...params }) -> Ruleset +- client.rulesets.versions.byTag.get(rulesetId, rulesetVersion, ruleTag, { ...params }) -> ByTagGetResponse # URLNormalization @@ -2736,6 +2695,13 @@ Methods: # Spectrum +Types: + +- DNS +- EdgeIPs +- OriginDNS +- OriginPort + ## Analytics ### Aggregates @@ -2752,6 +2718,10 @@ Methods: ### Events +Types: + +- Dimension + #### Bytimes Types: @@ -2787,8 +2757,8 @@ Methods: - client.spectrum.apps.create(zone, { ...params }) -> AppCreateResponse | null - client.spectrum.apps.update(zone, appId, { ...params }) -> AppUpdateResponse | null - client.spectrum.apps.list(zone, { ...params }) -> AppListResponsesV4PagePaginationArray -- client.spectrum.apps.delete(zone, appId) -> AppDeleteResponse | null -- client.spectrum.apps.get(zone, appId) -> AppGetResponse | null +- client.spectrum.apps.delete(zone, appId, { ...params }) -> AppDeleteResponse | null +- client.spectrum.apps.get(zone, appId) -> AppGetResponse # Addressing @@ -2806,7 +2776,7 @@ Methods: Types: -- AddressingAddressMaps +- AddressMap - AddressMapCreateResponse - AddressMapDeleteResponse - AddressMapGetResponse @@ -2814,9 +2784,9 @@ Types: Methods: - client.addressing.addressMaps.create({ ...params }) -> AddressMapCreateResponse -- client.addressing.addressMaps.list({ ...params }) -> AddressingAddressMapsSinglePage +- client.addressing.addressMaps.list({ ...params }) -> AddressMapsSinglePage - client.addressing.addressMaps.delete(addressMapId, { ...params }) -> AddressMapDeleteResponse | null -- client.addressing.addressMaps.edit(addressMapId, { ...params }) -> AddressingAddressMaps +- client.addressing.addressMaps.edit(addressMapId, { ...params }) -> AddressMap - client.addressing.addressMaps.get(addressMapId, { ...params }) -> AddressMapGetResponse ### Accounts @@ -2879,16 +2849,16 @@ Methods: Types: -- AddressingIpamPrefixes +- Prefix - PrefixDeleteResponse Methods: -- client.addressing.prefixes.create({ ...params }) -> AddressingIpamPrefixes -- client.addressing.prefixes.list({ ...params }) -> AddressingIpamPrefixesSinglePage +- client.addressing.prefixes.create({ ...params }) -> Prefix +- client.addressing.prefixes.list({ ...params }) -> PrefixesSinglePage - client.addressing.prefixes.delete(prefixId, { ...params }) -> PrefixDeleteResponse | null -- client.addressing.prefixes.edit(prefixId, { ...params }) -> AddressingIpamPrefixes -- client.addressing.prefixes.get(prefixId, { ...params }) -> AddressingIpamPrefixes +- client.addressing.prefixes.edit(prefixId, { ...params }) -> Prefix +- client.addressing.prefixes.get(prefixId, { ...params }) -> Prefix ### BGP @@ -2896,27 +2866,27 @@ Methods: Types: -- AddressingServiceBinding +- ServiceBinding - BindingDeleteResponse Methods: -- client.addressing.prefixes.bgp.bindings.create(prefixId, { ...params }) -> AddressingServiceBinding -- client.addressing.prefixes.bgp.bindings.list(prefixId, { ...params }) -> AddressingServiceBindingsSinglePage +- client.addressing.prefixes.bgp.bindings.create(prefixId, { ...params }) -> ServiceBinding +- client.addressing.prefixes.bgp.bindings.list(prefixId, { ...params }) -> ServiceBindingsSinglePage - client.addressing.prefixes.bgp.bindings.delete(prefixId, bindingId, { ...params }) -> BindingDeleteResponse -- client.addressing.prefixes.bgp.bindings.get(prefixId, bindingId, { ...params }) -> AddressingServiceBinding +- client.addressing.prefixes.bgp.bindings.get(prefixId, bindingId, { ...params }) -> ServiceBinding #### Prefixes Types: -- AddressingIpamBGPPrefixes +- BGPPrefix Methods: -- client.addressing.prefixes.bgp.prefixes.list(prefixId, { ...params }) -> AddressingIpamBGPPrefixesSinglePage -- client.addressing.prefixes.bgp.prefixes.edit(prefixId, bgpPrefixId, { ...params }) -> AddressingIpamBGPPrefixes -- client.addressing.prefixes.bgp.prefixes.get(prefixId, bgpPrefixId, { ...params }) -> AddressingIpamBGPPrefixes +- client.addressing.prefixes.bgp.prefixes.list(prefixId, { ...params }) -> BGPPrefixesSinglePage +- client.addressing.prefixes.bgp.prefixes.edit(prefixId, bgpPrefixId, { ...params }) -> BGPPrefix +- client.addressing.prefixes.bgp.prefixes.get(prefixId, bgpPrefixId, { ...params }) -> BGPPrefix #### Statuses @@ -2934,24 +2904,20 @@ Methods: Types: -- AddressingIpamDelegations +- Delegations - DelegationDeleteResponse Methods: -- client.addressing.prefixes.delegations.create(prefixId, { ...params }) -> AddressingIpamDelegations -- client.addressing.prefixes.delegations.list(prefixId, { ...params }) -> AddressingIpamDelegationsSinglePage +- client.addressing.prefixes.delegations.create(prefixId, { ...params }) -> Delegations +- client.addressing.prefixes.delegations.list(prefixId, { ...params }) -> DelegationsSinglePage - client.addressing.prefixes.delegations.delete(prefixId, delegationId, { ...params }) -> DelegationDeleteResponse # AuditLogs -Types: - -- AuditLogListResponse - Methods: -- client.auditLogs.list({ ...params }) -> AuditLogListResponsesV4PagePaginationArray +- client.auditLogs.list({ ...params }) -> AuditLogsV4PagePaginationArray # Billing @@ -2969,13 +2935,16 @@ Methods: Types: -- IntelPhishingURLInfo -- IntelPhishingURLSubmit +- Info +- RuleMatch +- ScanStatus +- Submit +- URLInfoModelResults Methods: -- client.brandProtection.submit({ ...params }) -> IntelPhishingURLSubmit -- client.brandProtection.urlInfo({ ...params }) -> IntelPhishingURLInfo +- client.brandProtection.submit({ ...params }) -> Submit +- client.brandProtection.urlInfo({ ...params }) -> Info # Diagnostics @@ -2983,7 +2952,7 @@ Methods: Types: -- MagicTransitTargetResult +- Traceroute - TracerouteCreateResponse Methods: @@ -3012,39 +2981,44 @@ Methods: Types: -- ImagesImageKeys +- Key +- KeyUpdateResponse +- KeyListResponse +- KeyDeleteResponse Methods: -- client.images.v1.keys.update(signingKeyName, { ...params }) -> ImagesImageKeys -- client.images.v1.keys.list({ ...params }) -> ImagesImageKeys -- client.images.v1.keys.delete(signingKeyName, { ...params }) -> ImagesImageKeys +- client.images.v1.keys.update(signingKeyName, { ...params }) -> KeyUpdateResponse +- client.images.v1.keys.list({ ...params }) -> KeyListResponse +- client.images.v1.keys.delete(signingKeyName, { ...params }) -> KeyDeleteResponse ### Stats Types: -- ImagesImagesStats +- Stat Methods: -- client.images.v1.stats.get({ ...params }) -> ImagesImagesStats +- client.images.v1.stats.get({ ...params }) -> Stat ### Variants Types: -- V1ImageVariant -- V1ImageVariants +- Variant +- VariantCreateResponse - VariantDeleteResponse +- VariantEditResponse +- VariantGetResponse Methods: -- client.images.v1.variants.create({ ...params }) -> V1ImageVariant -- client.images.v1.variants.list({ ...params }) -> V1ImageVariants +- client.images.v1.variants.create({ ...params }) -> VariantCreateResponse +- client.images.v1.variants.list({ ...params }) -> Variant - client.images.v1.variants.delete(variantId, { ...params }) -> VariantDeleteResponse -- client.images.v1.variants.edit(variantId, { ...params }) -> V1ImageVariant -- client.images.v1.variants.get(variantId, { ...params }) -> V1ImageVariant +- client.images.v1.variants.edit(variantId, { ...params }) -> VariantEditResponse +- client.images.v1.variants.get(variantId, { ...params }) -> VariantGetResponse ### Blobs @@ -3076,13 +3050,9 @@ Methods: ## ASN -Types: - -- IntelASN - Methods: -- client.intel.asn.get(asn, { ...params }) -> IntelASN +- client.intel.asn.get(asn, { ...params }) -> ASN ### Subnets @@ -3098,21 +3068,22 @@ Methods: Types: -- IntelPassiveDNSByIP +- DNS +- DNSListResponse Methods: -- client.intel.dns.get({ ...params }) -> IntelPassiveDNSByIP +- client.intel.dns.list({ ...params }) -> DNSListResponsesV4PagePagination ## Domains Types: -- IntelDomain +- Domain Methods: -- client.intel.domains.get({ ...params }) -> IntelDomain +- client.intel.domains.get({ ...params }) -> Domain ### Bulks @@ -3128,7 +3099,7 @@ Methods: Types: -- IntelDomainHistory +- DomainHistory - DomainHistoryGetResponse Methods: @@ -3139,7 +3110,7 @@ Methods: Types: -- IntelSchemasIP +- IP - IPGetResponse Methods: @@ -3150,7 +3121,7 @@ Methods: Types: -- IntelIPList +- IPList - IPListGetResponse Methods: @@ -3171,11 +3142,11 @@ Methods: Types: -- IntelWhois +- Whois Methods: -- client.intel.whois.get({ ...params }) -> IntelWhois +- client.intel.whois.get({ ...params }) -> Whois ## IndicatorFeeds @@ -3213,11 +3184,11 @@ Methods: Types: -- IntelSinkholeItem +- Sinkhole Methods: -- client.intel.sinkholes.list({ ...params }) -> IntelSinkholeItemsSinglePage +- client.intel.sinkholes.list({ ...params }) -> SinkholesSinglePage ## AttackSurfaceReport @@ -3235,6 +3206,11 @@ Methods: Types: +- IssueClass +- IssueType +- Product +- SeverityQueryParam +- Subject - IssueListResponse - IssueClassResponse - IssueDismissResponse @@ -3251,6 +3227,12 @@ Methods: # MagicTransit +Types: + +- HealthCheck +- HealthCheckRate +- HealthCheckType + ## CfInterconnects Types: @@ -3287,6 +3269,7 @@ Methods: Types: +- PSKMetadata - IPSECTunnelCreateResponse - IPSECTunnelUpdateResponse - IPSECTunnelListResponse @@ -3307,6 +3290,9 @@ Methods: Types: +- ColoName +- ColoRegion +- Scope - RouteCreateResponse - RouteUpdateResponse - RouteListResponse @@ -3327,73 +3313,69 @@ Methods: Types: -- SiteCreateResponse -- SiteUpdateResponse -- SiteListResponse -- SiteDeleteResponse -- SiteGetResponse +- Site +- SiteLocation Methods: -- client.magicTransit.sites.create({ ...params }) -> SiteCreateResponse -- client.magicTransit.sites.update(siteId, { ...params }) -> SiteUpdateResponse -- client.magicTransit.sites.list({ ...params }) -> SiteListResponse -- client.magicTransit.sites.delete(siteId, { ...params }) -> SiteDeleteResponse -- client.magicTransit.sites.get(siteId, { ...params }) -> SiteGetResponse +- client.magicTransit.sites.create({ ...params }) -> Site +- client.magicTransit.sites.update(siteId, { ...params }) -> Site +- client.magicTransit.sites.list({ ...params }) -> SitesSinglePage +- client.magicTransit.sites.delete(siteId, { ...params }) -> Site +- client.magicTransit.sites.get(siteId, { ...params }) -> Site ### ACLs Types: -- ACLCreateResponse -- ACLUpdateResponse -- ACLListResponse -- ACLDeleteResponse -- ACLGetResponse +- ACL +- ACLConfiguration +- AllowedProtocol +- Subnet Methods: -- client.magicTransit.sites.acls.create(siteId, { ...params }) -> ACLCreateResponse -- client.magicTransit.sites.acls.update(siteId, aclIdentifier, { ...params }) -> ACLUpdateResponse -- client.magicTransit.sites.acls.list(siteId, { ...params }) -> ACLListResponse -- client.magicTransit.sites.acls.delete(siteId, aclIdentifier, { ...params }) -> ACLDeleteResponse -- client.magicTransit.sites.acls.get(siteId, aclIdentifier, { ...params }) -> ACLGetResponse +- client.magicTransit.sites.acls.create(siteId, { ...params }) -> ACL +- client.magicTransit.sites.acls.update(siteId, aclIdentifier, { ...params }) -> ACL +- client.magicTransit.sites.acls.list(siteId, { ...params }) -> ACLsSinglePage +- client.magicTransit.sites.acls.delete(siteId, aclIdentifier, { ...params }) -> ACL +- client.magicTransit.sites.acls.get(siteId, aclIdentifier, { ...params }) -> ACL ### LANs Types: +- DHCPRelay +- DHCPServer +- LAN +- LANStaticAddressing +- Nat +- RoutedSubnet - LANCreateResponse -- LANUpdateResponse -- LANListResponse -- LANDeleteResponse -- LANGetResponse Methods: - client.magicTransit.sites.lans.create(siteId, { ...params }) -> LANCreateResponse -- client.magicTransit.sites.lans.update(siteId, lanId, { ...params }) -> LANUpdateResponse -- client.magicTransit.sites.lans.list(siteId, { ...params }) -> LANListResponse -- client.magicTransit.sites.lans.delete(siteId, lanId, { ...params }) -> LANDeleteResponse -- client.magicTransit.sites.lans.get(siteId, lanId, { ...params }) -> LANGetResponse +- client.magicTransit.sites.lans.update(siteId, lanId, { ...params }) -> LAN +- client.magicTransit.sites.lans.list(siteId, { ...params }) -> LANsSinglePage +- client.magicTransit.sites.lans.delete(siteId, lanId, { ...params }) -> LAN +- client.magicTransit.sites.lans.get(siteId, lanId, { ...params }) -> LAN ### WANs Types: +- WAN +- WANStaticAddressing - WANCreateResponse -- WANUpdateResponse -- WANListResponse -- WANDeleteResponse -- WANGetResponse Methods: - client.magicTransit.sites.wans.create(siteId, { ...params }) -> WANCreateResponse -- client.magicTransit.sites.wans.update(siteId, wanId, { ...params }) -> WANUpdateResponse -- client.magicTransit.sites.wans.list(siteId, { ...params }) -> WANListResponse -- client.magicTransit.sites.wans.delete(siteId, wanId, { ...params }) -> WANDeleteResponse -- client.magicTransit.sites.wans.get(siteId, wanId, { ...params }) -> WANGetResponse +- client.magicTransit.sites.wans.update(siteId, wanId, { ...params }) -> WAN +- client.magicTransit.sites.wans.list(siteId, { ...params }) -> WANsSinglePage +- client.magicTransit.sites.wans.delete(siteId, wanId, { ...params }) -> WAN +- client.magicTransit.sites.wans.get(siteId, wanId, { ...params }) -> WAN # MagicNetworkMonitoring @@ -3401,21 +3383,21 @@ Methods: Types: -- MagicNetworkMonitoringConfig +- Configuration Methods: -- client.magicNetworkMonitoring.configs.create({ ...params }) -> MagicNetworkMonitoringConfig -- client.magicNetworkMonitoring.configs.update({ ...params }) -> MagicNetworkMonitoringConfig -- client.magicNetworkMonitoring.configs.delete({ ...params }) -> MagicNetworkMonitoringConfig -- client.magicNetworkMonitoring.configs.edit({ ...params }) -> MagicNetworkMonitoringConfig -- client.magicNetworkMonitoring.configs.get({ ...params }) -> MagicNetworkMonitoringConfig +- client.magicNetworkMonitoring.configs.create({ ...params }) -> Configuration +- client.magicNetworkMonitoring.configs.update({ ...params }) -> Configuration +- client.magicNetworkMonitoring.configs.delete({ ...params }) -> Configuration +- client.magicNetworkMonitoring.configs.edit({ ...params }) -> Configuration +- client.magicNetworkMonitoring.configs.get({ ...params }) -> Configuration ### Full Methods: -- client.magicNetworkMonitoring.configs.full.get({ ...params }) -> MagicNetworkMonitoringConfig +- client.magicNetworkMonitoring.configs.full.get({ ...params }) -> Configuration ## Rules @@ -3436,22 +3418,22 @@ Methods: Types: -- MagicNetworkMonitoringRuleAdvertisable +- Advertisement Methods: -- client.magicNetworkMonitoring.rules.advertisements.edit(ruleId, { ...params }) -> MagicNetworkMonitoringRuleAdvertisable | null +- client.magicNetworkMonitoring.rules.advertisements.edit(ruleId, { ...params }) -> Advertisement | null # MTLSCertificates Types: - MTLSCertificate -- MTLSCertificateUpdate +- MTLSCertificateCreateResponse Methods: -- client.mtlsCertificates.create({ ...params }) -> MTLSCertificateUpdate +- client.mtlsCertificates.create({ ...params }) -> MTLSCertificateCreateResponse - client.mtlsCertificates.list({ ...params }) -> MTLSCertificatesSinglePage - client.mtlsCertificates.delete(mtlsCertificateId, { ...params }) -> MTLSCertificate - client.mtlsCertificates.get(mtlsCertificateId, { ...params }) -> MTLSCertificate @@ -3460,7 +3442,7 @@ Methods: Types: -- MTLSCertificateAsssociation +- CertificateAsssociation - AssociationGetResponse Methods: @@ -3473,8 +3455,9 @@ Methods: Types: -- PagesDeployments -- PagesProjects +- Deployment +- Project +- Stage - ProjectCreateResponse - ProjectDeleteResponse - ProjectEditResponse @@ -3483,10 +3466,10 @@ Types: Methods: - client.pages.projects.create({ ...params }) -> ProjectCreateResponse -- client.pages.projects.list({ ...params }) -> PagesDeploymentsSinglePage +- client.pages.projects.list({ ...params }) -> DeploymentsSinglePage - client.pages.projects.delete(projectName, { ...params }) -> unknown - client.pages.projects.edit(projectName, { ...params }) -> ProjectEditResponse -- client.pages.projects.get(projectName, { ...params }) -> PagesProjects +- client.pages.projects.get(projectName, { ...params }) -> Project - client.pages.projects.purgeBuildCache(projectName, { ...params }) -> unknown ### Deployments @@ -3497,12 +3480,12 @@ Types: Methods: -- client.pages.projects.deployments.create(projectName, { ...params }) -> PagesDeployments -- client.pages.projects.deployments.list(projectName, { ...params }) -> PagesDeploymentsSinglePage +- client.pages.projects.deployments.create(projectName, { ...params }) -> Deployment +- client.pages.projects.deployments.list(projectName, { ...params }) -> DeploymentsSinglePage - client.pages.projects.deployments.delete(projectName, deploymentId, { ...params }) -> unknown -- client.pages.projects.deployments.get(projectName, deploymentId, { ...params }) -> PagesDeployments -- client.pages.projects.deployments.retry(projectName, deploymentId, { ...params }) -> PagesDeployments -- client.pages.projects.deployments.rollback(projectName, deploymentId, { ...params }) -> PagesDeployments +- client.pages.projects.deployments.get(projectName, deploymentId, { ...params }) -> Deployment +- client.pages.projects.deployments.retry(projectName, deploymentId, { ...params }) -> Deployment +- client.pages.projects.deployments.rollback(projectName, deploymentId, { ...params }) -> Deployment #### History @@ -3538,6 +3521,8 @@ Methods: Types: +- PCAP +- PCAPFilter - PCAPCreateResponse - PCAPListResponse - PCAPGetResponse @@ -3552,15 +3537,15 @@ Methods: Types: -- MagicVisibilityPCAPsOwnership +- Ownership - OwnershipGetResponse Methods: -- client.pcaps.ownership.create({ ...params }) -> MagicVisibilityPCAPsOwnership +- client.pcaps.ownership.create({ ...params }) -> Ownership - client.pcaps.ownership.delete(ownershipId, { ...params }) -> void - client.pcaps.ownership.get({ ...params }) -> OwnershipGetResponse | null -- client.pcaps.ownership.validate({ ...params }) -> MagicVisibilityPCAPsOwnership +- client.pcaps.ownership.validate({ ...params }) -> Ownership ## Download @@ -3574,15 +3559,14 @@ Methods: Types: -- RegistrarDomains +- Domain - DomainUpdateResponse -- DomainListResponse - DomainGetResponse Methods: - client.registrar.domains.update(domainName, { ...params }) -> DomainUpdateResponse | null -- client.registrar.domains.list({ ...params }) -> DomainListResponsesSinglePage +- client.registrar.domains.list({ ...params }) -> DomainsSinglePage - client.registrar.domains.get(domainName, { ...params }) -> DomainGetResponse | null # RequestTracers @@ -3597,7 +3581,7 @@ Types: Methods: -- client.requestTracers.traces.create(accountIdentifier, { ...params }) -> TraceCreateResponse +- client.requestTracers.traces.create({ ...params }) -> TraceCreateResponse # Rules @@ -3605,7 +3589,9 @@ Methods: Types: +- Hostname - ListsList +- Redirect - ListDeleteResponse Methods: @@ -3620,6 +3606,7 @@ Methods: Types: +- OperationStatus - BulkOperationGetResponse Methods: @@ -3630,6 +3617,8 @@ Methods: Types: +- ListCursor +- ListItem - ItemCreateResponse - ItemUpdateResponse - ItemListResponse @@ -3650,40 +3639,41 @@ Methods: Types: -- WorkersKVComponentsSchemasResult -- WorkersKVSchemasResult +- Components +- Schema Methods: -- client.storage.analytics.list({ ...params }) -> WorkersKVSchemasResult -- client.storage.analytics.stored({ ...params }) -> WorkersKVComponentsSchemasResult +- client.storage.analytics.list({ ...params }) -> Schema +- client.storage.analytics.stored({ ...params }) -> Components # Stream Types: -- StreamVideos +- AllowedOrigins +- Video Methods: - client.stream.create({ ...params }) -> void -- client.stream.list({ ...params }) -> StreamVideosSinglePage +- client.stream.list({ ...params }) -> VideosSinglePage - client.stream.delete(identifier, { ...params }) -> void -- client.stream.get(identifier, { ...params }) -> StreamVideos +- client.stream.get(identifier, { ...params }) -> Video ## AudioTracks Types: -- StreamAudio +- Audio - AudioTrackDeleteResponse - AudioTrackGetResponse Methods: - client.stream.audioTracks.delete(identifier, audioIdentifier, { ...params }) -> AudioTrackDeleteResponse -- client.stream.audioTracks.copy(identifier, { ...params }) -> StreamAudio -- client.stream.audioTracks.edit(identifier, audioIdentifier, { ...params }) -> StreamAudio +- client.stream.audioTracks.copy(identifier, { ...params }) -> Audio +- client.stream.audioTracks.edit(identifier, audioIdentifier, { ...params }) -> Audio - client.stream.audioTracks.get(identifier, { ...params }) -> AudioTrackGetResponse ## Videos @@ -3700,17 +3690,17 @@ Methods: Types: -- StreamClipping +- Clip Methods: -- client.stream.clip.create({ ...params }) -> StreamClipping +- client.stream.clip.create({ ...params }) -> Clip ## Copy Methods: -- client.stream.copy.create({ ...params }) -> StreamVideos +- client.stream.copy.create({ ...params }) -> Video ## DirectUpload @@ -3726,13 +3716,13 @@ Methods: Types: -- StreamKeys +- Keys - KeyDeleteResponse - KeyGetResponse Methods: -- client.stream.keys.create({ ...params }) -> StreamKeys +- client.stream.keys.create({ ...params }) -> Keys - client.stream.keys.delete(identifier, { ...params }) -> KeyDeleteResponse - client.stream.keys.get({ ...params }) -> KeyGetResponse @@ -3740,45 +3730,43 @@ Methods: Types: -- StreamLiveInput +- LiveInput - LiveInputListResponse Methods: -- client.stream.liveInputs.create({ ...params }) -> StreamLiveInput -- client.stream.liveInputs.update(liveInputIdentifier, { ...params }) -> StreamLiveInput +- client.stream.liveInputs.create({ ...params }) -> LiveInput +- client.stream.liveInputs.update(liveInputIdentifier, { ...params }) -> LiveInput - client.stream.liveInputs.list({ ...params }) -> LiveInputListResponse - client.stream.liveInputs.delete(liveInputIdentifier, { ...params }) -> void -- client.stream.liveInputs.get(liveInputIdentifier, { ...params }) -> StreamLiveInput +- client.stream.liveInputs.get(liveInputIdentifier, { ...params }) -> LiveInput ### Outputs Types: -- StreamOutput +- Output Methods: -- client.stream.liveInputs.outputs.create(liveInputIdentifier, { ...params }) -> StreamOutput -- client.stream.liveInputs.outputs.update(liveInputIdentifier, outputIdentifier, { ...params }) -> StreamOutput -- client.stream.liveInputs.outputs.list(liveInputIdentifier, { ...params }) -> StreamOutputsSinglePage +- client.stream.liveInputs.outputs.create(liveInputIdentifier, { ...params }) -> Output +- client.stream.liveInputs.outputs.update(liveInputIdentifier, outputIdentifier, { ...params }) -> Output +- client.stream.liveInputs.outputs.list(liveInputIdentifier, { ...params }) -> OutputsSinglePage - client.stream.liveInputs.outputs.delete(liveInputIdentifier, outputIdentifier, { ...params }) -> void ## Watermarks Types: -- StreamWatermarks -- WatermarkCreateResponse +- Watermark - WatermarkDeleteResponse -- WatermarkGetResponse Methods: -- client.stream.watermarks.create({ ...params }) -> WatermarkCreateResponse -- client.stream.watermarks.list({ ...params }) -> StreamWatermarksSinglePage +- client.stream.watermarks.create({ ...params }) -> Watermark +- client.stream.watermarks.list({ ...params }) -> WatermarksSinglePage - client.stream.watermarks.delete(identifier, { ...params }) -> WatermarkDeleteResponse -- client.stream.watermarks.get(identifier, { ...params }) -> WatermarkGetResponse +- client.stream.watermarks.get(identifier, { ...params }) -> Watermark ## Webhooks @@ -3798,16 +3786,34 @@ Methods: Types: -- StreamCaptions -- CaptionUpdateResponse -- CaptionDeleteResponse -- CaptionGetResponse +- Caption +- CaptionGetResponse + +Methods: + +- client.stream.captions.get(identifier, { ...params }) -> CaptionGetResponse + +### Language + +Types: + +- LanguageDeleteResponse Methods: -- client.stream.captions.update(identifier, language, { ...params }) -> CaptionUpdateResponse -- client.stream.captions.delete(identifier, language, { ...params }) -> CaptionDeleteResponse -- client.stream.captions.get(identifier, { ...params }) -> CaptionGetResponse +- client.stream.captions.language.update(identifier, language, { ...params }) -> Caption +- client.stream.captions.language.delete(identifier, language, { ...params }) -> LanguageDeleteResponse +- client.stream.captions.language.get(identifier, language, { ...params }) -> Caption + +#### Vtt + +Types: + +- VttGetResponse + +Methods: + +- client.stream.captions.language.vtt.get(identifier, language, { ...params }) -> string ## Downloads @@ -3845,6 +3851,10 @@ Methods: # Alerting +Types: + +- Alert + ## AvailableAlerts Types: @@ -3871,7 +3881,7 @@ Methods: Types: -- AlertingPagerduty +- Pagerduty - PagerdutyCreateResponse - PagerdutyDeleteResponse - PagerdutyGetResponse @@ -3888,7 +3898,7 @@ Methods: Types: -- AlertingWebhooks +- Webhooks - WebhookCreateResponse - WebhookUpdateResponse - WebhookDeleteResponse @@ -3897,25 +3907,27 @@ Methods: - client.alerting.destinations.webhooks.create({ ...params }) -> WebhookCreateResponse - client.alerting.destinations.webhooks.update(webhookId, { ...params }) -> WebhookUpdateResponse -- client.alerting.destinations.webhooks.list({ ...params }) -> AlertingWebhooksSinglePage +- client.alerting.destinations.webhooks.list({ ...params }) -> WebhooksSinglePage - client.alerting.destinations.webhooks.delete(webhookId, { ...params }) -> WebhookDeleteResponse | null -- client.alerting.destinations.webhooks.get(webhookId, { ...params }) -> AlertingWebhooks +- client.alerting.destinations.webhooks.get(webhookId, { ...params }) -> Webhooks ## History Types: -- AlertingHistory +- History Methods: -- client.alerting.history.list({ ...params }) -> AlertingHistoriesV4PagePaginationArray +- client.alerting.history.list({ ...params }) -> HistoriesV4PagePaginationArray ## Policies Types: -- AlertingPolicies +- Mechanism +- Policy +- PolicyFilter - PolicyCreateResponse - PolicyUpdateResponse - PolicyDeleteResponse @@ -3924,28 +3936,32 @@ Methods: - client.alerting.policies.create({ ...params }) -> PolicyCreateResponse - client.alerting.policies.update(policyId, { ...params }) -> PolicyUpdateResponse -- client.alerting.policies.list({ ...params }) -> AlertingPoliciesSinglePage +- client.alerting.policies.list({ ...params }) -> PoliciesSinglePage - client.alerting.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse | null -- client.alerting.policies.get(policyId, { ...params }) -> AlertingPolicies +- client.alerting.policies.get(policyId, { ...params }) -> Policy # D1 +Types: + +- D1 + ## Database Types: -- D1CreateDatabase -- D1DatabaseDetails -- D1QueryResult +- QueryResult +- DatabaseCreateResponse +- DatabaseListResponse - DatabaseDeleteResponse - DatabaseQueryResponse Methods: -- client.d1.database.create({ ...params }) -> D1CreateDatabase -- client.d1.database.list({ ...params }) -> D1CreateDatabasesV4PagePaginationArray -- client.d1.database.delete(accountIdentifier, databaseIdentifier) -> DatabaseDeleteResponse | null -- client.d1.database.get(accountIdentifier, databaseIdentifier) -> D1DatabaseDetails +- client.d1.database.create({ ...params }) -> DatabaseCreateResponse +- client.d1.database.list({ ...params }) -> DatabaseListResponsesV4PagePaginationArray +- client.d1.database.delete(accountIdentifier, databaseIdentifier) -> DatabaseDeleteResponse +- client.d1.database.get(accountIdentifier, databaseIdentifier) -> D1 - client.d1.database.query(accountIdentifier, databaseIdentifier, { ...params }) -> DatabaseQueryResponse # R2 @@ -3954,28 +3970,29 @@ Methods: Types: -- R2Bucket +- Bucket - BucketDeleteResponse Methods: -- client.r2.buckets.create({ ...params }) -> R2Bucket -- client.r2.buckets.list({ ...params }) -> R2BucketsCursorPagination +- client.r2.buckets.create({ ...params }) -> Bucket +- client.r2.buckets.list({ ...params }) -> BucketsCursorPagination - client.r2.buckets.delete(bucketName, { ...params }) -> BucketDeleteResponse -- client.r2.buckets.get(bucketName, { ...params }) -> R2Bucket +- client.r2.buckets.get(bucketName, { ...params }) -> Bucket ## Sippy Types: -- R2Sippy +- Provider +- Sippy - SippyDeleteResponse Methods: -- client.r2.sippy.update(bucketName, { ...params }) -> R2Sippy +- client.r2.sippy.update(bucketName, { ...params }) -> Sippy - client.r2.sippy.delete(bucketName, { ...params }) -> SippyDeleteResponse -- client.r2.sippy.get(bucketName, { ...params }) -> R2Sippy +- client.r2.sippy.get(bucketName, { ...params }) -> Sippy # WARPConnector @@ -4021,19 +4038,19 @@ Methods: Types: -- WorkersForPlatformsNamespaceScript +- Script Methods: -- client.workersForPlatforms.dispatch.namespaces.scripts.update(dispatchNamespace, scriptName, { ...params }) -> WorkersScript +- client.workersForPlatforms.dispatch.namespaces.scripts.update(dispatchNamespace, scriptName, { ...params }) -> Script - client.workersForPlatforms.dispatch.namespaces.scripts.delete(dispatchNamespace, scriptName, { ...params }) -> void -- client.workersForPlatforms.dispatch.namespaces.scripts.get(dispatchNamespace, scriptName, { ...params }) -> WorkersForPlatformsNamespaceScript +- client.workersForPlatforms.dispatch.namespaces.scripts.get(dispatchNamespace, scriptName, { ...params }) -> Script ##### Content Methods: -- client.workersForPlatforms.dispatch.namespaces.scripts.content.update(dispatchNamespace, scriptName, { ...params }) -> WorkersScript +- client.workersForPlatforms.dispatch.namespaces.scripts.content.update(dispatchNamespace, scriptName, { ...params }) -> Script - client.workersForPlatforms.dispatch.namespaces.scripts.content.get(dispatchNamespace, scriptName, { ...params }) -> Response ##### Settings @@ -4058,64 +4075,92 @@ Methods: - client.workersForPlatforms.dispatch.namespaces.scripts.bindings.get(dispatchNamespace, scriptName, { ...params }) -> BindingGetResponse +##### Secrets + +Types: + +- SecretUpdateResponse +- SecretListResponse + +Methods: + +- client.workersForPlatforms.dispatch.namespaces.scripts.secrets.update(dispatchNamespace, scriptName, { ...params }) -> SecretUpdateResponse +- client.workersForPlatforms.dispatch.namespaces.scripts.secrets.list(dispatchNamespace, scriptName, { ...params }) -> SecretListResponsesSinglePage + +##### Tags + +Types: + +- TagUpdateResponse +- TagListResponse +- TagDeleteResponse + +Methods: + +- client.workersForPlatforms.dispatch.namespaces.scripts.tags.update(dispatchNamespace, scriptName, [ ...body ]) -> TagUpdateResponse +- client.workersForPlatforms.dispatch.namespaces.scripts.tags.list(dispatchNamespace, scriptName, { ...params }) -> TagListResponsesSinglePage +- client.workersForPlatforms.dispatch.namespaces.scripts.tags.delete(dispatchNamespace, scriptName, tag, { ...params }) -> TagDeleteResponse | null + # ZeroTrust ## Devices Types: -- ZeroTrustDevices +- Device - DeviceGetResponse Methods: -- client.zeroTrust.devices.list({ ...params }) -> ZeroTrustDevicesSinglePage -- client.zeroTrust.devices.get(deviceId, { ...params }) -> DeviceGetResponse | null +- client.zeroTrust.devices.list({ ...params }) -> DevicesSinglePage +- client.zeroTrust.devices.get(deviceId, { ...params }) -> DeviceGetResponse ### DEXTests Types: -- DEXTestSchemasHTTP +- DEXTest +- SchemaData +- SchemaHTTP - DEXTestDeleteResponse Methods: -- client.zeroTrust.devices.dexTests.create({ ...params }) -> DEXTestSchemasHTTP | null -- client.zeroTrust.devices.dexTests.update(dexTestId, { ...params }) -> DEXTestSchemasHTTP | null -- client.zeroTrust.devices.dexTests.list({ ...params }) -> DEXTestSchemasHTTPSSinglePage +- client.zeroTrust.devices.dexTests.create({ ...params }) -> SchemaHTTP | null +- client.zeroTrust.devices.dexTests.update(dexTestId, { ...params }) -> SchemaHTTP | null +- client.zeroTrust.devices.dexTests.list({ ...params }) -> SchemaHTTPSSinglePage - client.zeroTrust.devices.dexTests.delete(dexTestId, { ...params }) -> DEXTestDeleteResponse | null -- client.zeroTrust.devices.dexTests.get(dexTestId, { ...params }) -> DEXTestSchemasHTTP | null +- client.zeroTrust.devices.dexTests.get(dexTestId, { ...params }) -> SchemaHTTP | null ### Networks Types: -- DeviceManagedNetworks +- DeviceNetwork - NetworkDeleteResponse Methods: -- client.zeroTrust.devices.networks.create({ ...params }) -> DeviceManagedNetworks | null -- client.zeroTrust.devices.networks.update(networkId, { ...params }) -> DeviceManagedNetworks | null -- client.zeroTrust.devices.networks.list({ ...params }) -> DeviceManagedNetworksSinglePage +- client.zeroTrust.devices.networks.create({ ...params }) -> DeviceNetwork | null +- client.zeroTrust.devices.networks.update(networkId, { ...params }) -> DeviceNetwork | null +- client.zeroTrust.devices.networks.list({ ...params }) -> DeviceNetworksSinglePage - client.zeroTrust.devices.networks.delete(networkId, { ...params }) -> NetworkDeleteResponse | null -- client.zeroTrust.devices.networks.get(networkId, { ...params }) -> DeviceManagedNetworks | null +- client.zeroTrust.devices.networks.get(networkId, { ...params }) -> DeviceNetwork | null ### Policies Types: -- DevicesDeviceSettingsPolicy +- SettingsPolicy - PolicyDeleteResponse Methods: -- client.zeroTrust.devices.policies.create({ ...params }) -> DevicesDeviceSettingsPolicy | null -- client.zeroTrust.devices.policies.list({ ...params }) -> DevicesDeviceSettingsPoliciesSinglePage +- client.zeroTrust.devices.policies.create({ ...params }) -> SettingsPolicy | null +- client.zeroTrust.devices.policies.list({ ...params }) -> SettingsPoliciesSinglePage - client.zeroTrust.devices.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse | null -- client.zeroTrust.devices.policies.edit(policyId, { ...params }) -> DevicesDeviceSettingsPolicy | null -- client.zeroTrust.devices.policies.get(policyId, { ...params }) -> DevicesDeviceSettingsPolicy | null +- client.zeroTrust.devices.policies.edit(policyId, { ...params }) -> SettingsPolicy | null +- client.zeroTrust.devices.policies.get(policyId, { ...params }) -> SettingsPolicy | null #### DefaultPolicy @@ -4131,73 +4176,91 @@ Methods: Types: -- DevicesSplitTunnel +- SplitTunnelExclude - ExcludeUpdateResponse - ExcludeGetResponse Methods: - client.zeroTrust.devices.policies.excludes.update([ ...body ]) -> ExcludeUpdateResponse | null -- client.zeroTrust.devices.policies.excludes.list({ ...params }) -> DevicesSplitTunnelsSinglePage +- client.zeroTrust.devices.policies.excludes.list({ ...params }) -> SplitTunnelExcludesSinglePage - client.zeroTrust.devices.policies.excludes.get(policyId, { ...params }) -> ExcludeGetResponse | null #### FallbackDomains Types: -- DevicesFallbackDomain +- FallbackDomain +- FallbackDomainPolicy - FallbackDomainUpdateResponse - FallbackDomainGetResponse Methods: - client.zeroTrust.devices.policies.fallbackDomains.update(policyId, [ ...body ]) -> FallbackDomainUpdateResponse | null -- client.zeroTrust.devices.policies.fallbackDomains.list({ ...params }) -> DevicesFallbackDomainsSinglePage +- client.zeroTrust.devices.policies.fallbackDomains.list({ ...params }) -> FallbackDomainsSinglePage - client.zeroTrust.devices.policies.fallbackDomains.get(policyId, { ...params }) -> FallbackDomainGetResponse | null #### Includes Types: -- DevicesSplitTunnelInclude +- SplitTunnelInclude - IncludeUpdateResponse - IncludeGetResponse Methods: - client.zeroTrust.devices.policies.includes.update([ ...body ]) -> IncludeUpdateResponse | null -- client.zeroTrust.devices.policies.includes.list({ ...params }) -> DevicesSplitTunnelIncludesSinglePage +- client.zeroTrust.devices.policies.includes.list({ ...params }) -> SplitTunnelIncludesSinglePage - client.zeroTrust.devices.policies.includes.get(policyId, { ...params }) -> IncludeGetResponse | null ### Posture Types: -- DevicePostureRules +- CarbonblackInput +- ClientCertificateInput +- CrowdstrikeInput +- DeviceInput +- DeviceMatch +- DevicePostureRule +- DiskEncryptionInput +- DomainJoinedInput +- FileInput +- FirewallInput +- IntuneInput +- KolideInput +- OSVersionInput +- SentineloneInput +- SentineloneS2sInput +- TaniumInput +- UniqueClientIDInput +- WorkspaceOneInput - PostureDeleteResponse Methods: -- client.zeroTrust.devices.posture.create({ ...params }) -> DevicePostureRules | null -- client.zeroTrust.devices.posture.update(ruleId, { ...params }) -> DevicePostureRules | null +- client.zeroTrust.devices.posture.create({ ...params }) -> DevicePostureRule | null +- client.zeroTrust.devices.posture.update(ruleId, { ...params }) -> DevicePostureRule | null - client.zeroTrust.devices.posture.list({ ...params }) -> DevicePostureRulesSinglePage - client.zeroTrust.devices.posture.delete(ruleId, { ...params }) -> PostureDeleteResponse | null -- client.zeroTrust.devices.posture.get(ruleId, { ...params }) -> DevicePostureRules | null +- client.zeroTrust.devices.posture.get(ruleId, { ...params }) -> DevicePostureRule | null #### Integrations Types: -- DevicePostureIntegrations +- Integration - IntegrationDeleteResponse Methods: -- client.zeroTrust.devices.posture.integrations.create({ ...params }) -> DevicePostureIntegrations | null -- client.zeroTrust.devices.posture.integrations.list({ ...params }) -> DevicePostureIntegrationsSinglePage -- client.zeroTrust.devices.posture.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse | null -- client.zeroTrust.devices.posture.integrations.edit(integrationId, { ...params }) -> DevicePostureIntegrations | null -- client.zeroTrust.devices.posture.integrations.get(integrationId, { ...params }) -> DevicePostureIntegrations | null +- client.zeroTrust.devices.posture.integrations.create({ ...params }) -> Integration | null +- client.zeroTrust.devices.posture.integrations.list({ ...params }) -> IntegrationsSinglePage +- client.zeroTrust.devices.posture.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse +- client.zeroTrust.devices.posture.integrations.edit(integrationId, { ...params }) -> Integration | null +- client.zeroTrust.devices.posture.integrations.get(integrationId, { ...params }) -> Integration | null ### Revoke @@ -4207,18 +4270,18 @@ Types: Methods: -- client.zeroTrust.devices.revoke.create([ ...body ]) -> RevokeCreateResponse | null +- client.zeroTrust.devices.revoke.create([ ...body ]) -> RevokeCreateResponse ### Settings Types: -- ZeroTrustAccountDeviceSettings +- DeviceSettings Methods: -- client.zeroTrust.devices.settings.update({ ...params }) -> ZeroTrustAccountDeviceSettings | null -- client.zeroTrust.devices.settings.list({ ...params }) -> ZeroTrustAccountDeviceSettings | null +- client.zeroTrust.devices.settings.update({ ...params }) -> DeviceSettings | null +- client.zeroTrust.devices.settings.list({ ...params }) -> DeviceSettings | null ### Unrevoke @@ -4228,7 +4291,7 @@ Types: Methods: -- client.zeroTrust.devices.unrevoke.create([ ...body ]) -> UnrevokeCreateResponse | null +- client.zeroTrust.devices.unrevoke.create([ ...body ]) -> UnrevokeCreateResponse ### OverrideCodes @@ -4244,37 +4307,42 @@ Methods: Types: -- ZeroTrustIdentityProviders +- AzureAD +- GenericOAuthConfig +- IdentityProvider +- IdentityProviderType +- ScimConfig - IdentityProviderListResponse - IdentityProviderDeleteResponse Methods: -- client.zeroTrust.identityProviders.create({ ...params }) -> ZeroTrustIdentityProviders -- client.zeroTrust.identityProviders.update(uuid, { ...params }) -> ZeroTrustIdentityProviders +- client.zeroTrust.identityProviders.create({ ...params }) -> IdentityProvider +- client.zeroTrust.identityProviders.update(uuid, { ...params }) -> IdentityProvider - client.zeroTrust.identityProviders.list({ ...params }) -> IdentityProviderListResponsesSinglePage - client.zeroTrust.identityProviders.delete(uuid, { ...params }) -> IdentityProviderDeleteResponse -- client.zeroTrust.identityProviders.get(uuid, { ...params }) -> ZeroTrustIdentityProviders +- client.zeroTrust.identityProviders.get(uuid, { ...params }) -> IdentityProvider ## Organizations Types: -- ZeroTrustOrganizations +- LoginDesign +- Organization - OrganizationRevokeUsersResponse Methods: -- client.zeroTrust.organizations.create({ ...params }) -> ZeroTrustOrganizations -- client.zeroTrust.organizations.update({ ...params }) -> ZeroTrustOrganizations -- client.zeroTrust.organizations.list({ ...params }) -> ZeroTrustOrganizations +- client.zeroTrust.organizations.create({ ...params }) -> Organization +- client.zeroTrust.organizations.update({ ...params }) -> Organization +- client.zeroTrust.organizations.list({ ...params }) -> Organization - client.zeroTrust.organizations.revokeUsers({ ...params }) -> OrganizationRevokeUsersResponse ## Seats Types: -- ZeroTrustSeats +- Seat - SeatEditResponse Methods: @@ -4283,28 +4351,63 @@ Methods: ## Access +Types: + +- AccessDevicePostureRule +- AccessRule +- AnyValidServiceTokenRule +- AuthenticationMethodRule +- AzureGroupRule +- CertificateRule +- CountryRule +- DomainRule +- EmailListRule +- EmailRule +- EveryoneRule +- ExternalEvaluationRule +- GitHubOrganizationRule +- GroupRule +- GSuiteGroupRule +- IPListRule +- IPRule +- OktaGroupRule +- SAMLGroupRule +- ServiceTokenRule + ### Applications Types: -- ZeroTrustApps +- AllowedHeadersh +- AllowedIdpsh +- AllowedMethodsh +- AllowedOriginsh +- AppID +- Application +- CORSHeaders +- CustomPagesh +- SaaSAppNameFormat +- SaaSAppNameIDFormat +- SaaSAppSource +- SAMLSaaSApp +- SelfHostedDomainsh - ApplicationDeleteResponse - ApplicationRevokeTokensResponse Methods: -- client.zeroTrust.access.applications.create({ ...params }) -> ZeroTrustApps -- client.zeroTrust.access.applications.update(appId, { ...params }) -> ZeroTrustApps -- client.zeroTrust.access.applications.list({ ...params }) -> ZeroTrustAppsSinglePage +- client.zeroTrust.access.applications.create({ ...params }) -> Application +- client.zeroTrust.access.applications.update(appId, { ...params }) -> Application +- client.zeroTrust.access.applications.list({ ...params }) -> ApplicationsSinglePage - client.zeroTrust.access.applications.delete(appId, { ...params }) -> ApplicationDeleteResponse -- client.zeroTrust.access.applications.get(appId, { ...params }) -> ZeroTrustApps +- client.zeroTrust.access.applications.get(appId, { ...params }) -> Application - client.zeroTrust.access.applications.revokeTokens(appId, { ...params }) -> ApplicationRevokeTokensResponse | null #### CAs Types: -- ZeroTrustCA +- CA - CACreateResponse - CADeleteResponse - CAGetResponse @@ -4312,7 +4415,7 @@ Types: Methods: - client.zeroTrust.access.applications.cas.create(uuid, { ...params }) -> CACreateResponse -- client.zeroTrust.access.applications.cas.list({ ...params }) -> ZeroTrustCAsSinglePage +- client.zeroTrust.access.applications.cas.list({ ...params }) -> CAsSinglePage - client.zeroTrust.access.applications.cas.delete(uuid, { ...params }) -> CADeleteResponse - client.zeroTrust.access.applications.cas.get(uuid, { ...params }) -> CAGetResponse @@ -4320,6 +4423,7 @@ Methods: Types: +- UserPolicyCheckGeo - UserPolicyCheckListResponse Methods: @@ -4330,37 +4434,39 @@ Methods: Types: -- ZeroTrustPolicies +- ApprovalGroup +- Policy - PolicyDeleteResponse Methods: -- client.zeroTrust.access.applications.policies.create(uuid, { ...params }) -> ZeroTrustPolicies -- client.zeroTrust.access.applications.policies.update(uuid1, uuid, { ...params }) -> ZeroTrustPolicies -- client.zeroTrust.access.applications.policies.list(uuid, { ...params }) -> ZeroTrustPoliciesSinglePage +- client.zeroTrust.access.applications.policies.create(uuid, { ...params }) -> Policy +- client.zeroTrust.access.applications.policies.update(uuid1, uuid, { ...params }) -> Policy +- client.zeroTrust.access.applications.policies.list(uuid, { ...params }) -> PoliciesSinglePage - client.zeroTrust.access.applications.policies.delete(uuid1, uuid, { ...params }) -> PolicyDeleteResponse -- client.zeroTrust.access.applications.policies.get(uuid1, uuid, { ...params }) -> ZeroTrustPolicies +- client.zeroTrust.access.applications.policies.get(uuid1, uuid, { ...params }) -> Policy ### Certificates Types: -- ZeroTrustCertificates +- AssociatedHostnames +- Certificate - CertificateDeleteResponse Methods: -- client.zeroTrust.access.certificates.create({ ...params }) -> ZeroTrustCertificates -- client.zeroTrust.access.certificates.update(uuid, { ...params }) -> ZeroTrustCertificates -- client.zeroTrust.access.certificates.list({ ...params }) -> ZeroTrustCertificatesSinglePage +- client.zeroTrust.access.certificates.create({ ...params }) -> Certificate +- client.zeroTrust.access.certificates.update(uuid, { ...params }) -> Certificate +- client.zeroTrust.access.certificates.list({ ...params }) -> CertificatesSinglePage - client.zeroTrust.access.certificates.delete(uuid, { ...params }) -> CertificateDeleteResponse -- client.zeroTrust.access.certificates.get(uuid, { ...params }) -> ZeroTrustCertificates +- client.zeroTrust.access.certificates.get(uuid, { ...params }) -> Certificate #### Settings Types: -- ZeroTrustSettings +- CertificateSettings - SettingUpdateResponse - SettingGetResponse @@ -4373,48 +4479,48 @@ Methods: Types: -- ZeroTrustGroups +- ZeroTrustGroup - GroupDeleteResponse Methods: -- client.zeroTrust.access.groups.create({ ...params }) -> ZeroTrustGroups -- client.zeroTrust.access.groups.update(uuid, { ...params }) -> ZeroTrustGroups +- client.zeroTrust.access.groups.create({ ...params }) -> ZeroTrustGroup +- client.zeroTrust.access.groups.update(uuid, { ...params }) -> ZeroTrustGroup - client.zeroTrust.access.groups.list({ ...params }) -> ZeroTrustGroupsSinglePage - client.zeroTrust.access.groups.delete(uuid, { ...params }) -> GroupDeleteResponse -- client.zeroTrust.access.groups.get(uuid, { ...params }) -> ZeroTrustGroups +- client.zeroTrust.access.groups.get(uuid, { ...params }) -> ZeroTrustGroup ### ServiceTokens Types: -- ZeroTrustServiceTokens +- ServiceToken - ServiceTokenCreateResponse - ServiceTokenRotateResponse Methods: - client.zeroTrust.access.serviceTokens.create({ ...params }) -> ServiceTokenCreateResponse -- client.zeroTrust.access.serviceTokens.update(uuid, { ...params }) -> ZeroTrustServiceTokens -- client.zeroTrust.access.serviceTokens.list({ ...params }) -> ZeroTrustServiceTokensSinglePage -- client.zeroTrust.access.serviceTokens.delete(uuid, { ...params }) -> ZeroTrustServiceTokens -- client.zeroTrust.access.serviceTokens.refresh(identifier, uuid) -> ZeroTrustServiceTokens +- client.zeroTrust.access.serviceTokens.update(uuid, { ...params }) -> ServiceToken +- client.zeroTrust.access.serviceTokens.list({ ...params }) -> ServiceTokensSinglePage +- client.zeroTrust.access.serviceTokens.delete(uuid, { ...params }) -> ServiceToken +- client.zeroTrust.access.serviceTokens.refresh(identifier, uuid) -> ServiceToken - client.zeroTrust.access.serviceTokens.rotate(identifier, uuid) -> ServiceTokenRotateResponse ### Bookmarks Types: -- ZeroTrustBookmarks +- Bookmark - BookmarkDeleteResponse Methods: -- client.zeroTrust.access.bookmarks.create(identifier, uuid) -> ZeroTrustBookmarks -- client.zeroTrust.access.bookmarks.update(identifier, uuid) -> ZeroTrustBookmarks -- client.zeroTrust.access.bookmarks.list(identifier) -> ZeroTrustBookmarksSinglePage -- client.zeroTrust.access.bookmarks.delete(identifier, uuid) -> BookmarkDeleteResponse -- client.zeroTrust.access.bookmarks.get(identifier, uuid) -> ZeroTrustBookmarks +- client.zeroTrust.access.bookmarks.create(identifier, uuid, { ...params }) -> Bookmark +- client.zeroTrust.access.bookmarks.update(identifier, uuid, { ...params }) -> Bookmark +- client.zeroTrust.access.bookmarks.list(identifier) -> BookmarksSinglePage +- client.zeroTrust.access.bookmarks.delete(identifier, uuid, { ...params }) -> BookmarkDeleteResponse +- client.zeroTrust.access.bookmarks.get(identifier, uuid) -> Bookmark ### Keys @@ -4436,7 +4542,7 @@ Methods: Types: -- ZeroTrustAccessRequests +- AccessRequests - AccessRequestListResponse Methods: @@ -4447,11 +4553,11 @@ Methods: Types: -- ZeroTrustUsers +- AccessUser Methods: -- client.zeroTrust.access.users.list(identifier) -> ZeroTrustUsersSinglePage +- client.zeroTrust.access.users.list(identifier) -> AccessUsersSinglePage #### ActiveSessions @@ -4469,11 +4575,11 @@ Methods: Types: -- ZeroTrustIdentity +- Identity Methods: -- client.zeroTrust.access.users.lastSeenIdentity.get(identifier, id) -> ZeroTrustIdentity +- client.zeroTrust.access.users.lastSeenIdentity.get(identifier, id) -> Identity #### FailedLogins @@ -4489,35 +4595,42 @@ Methods: Types: -- ZeroTrustCustomPage -- ZeroTrustCustomPageWithoutHTML +- CustomPage +- CustomPageWithoutHTML - CustomPageDeleteResponse Methods: -- client.zeroTrust.access.customPages.create(identifier, { ...params }) -> ZeroTrustCustomPageWithoutHTML -- client.zeroTrust.access.customPages.update(identifier, uuid, { ...params }) -> ZeroTrustCustomPageWithoutHTML -- client.zeroTrust.access.customPages.list(identifier) -> ZeroTrustCustomPageWithoutHTMLsSinglePage +- client.zeroTrust.access.customPages.create(identifier, { ...params }) -> CustomPageWithoutHTML +- client.zeroTrust.access.customPages.update(identifier, uuid, { ...params }) -> CustomPageWithoutHTML +- client.zeroTrust.access.customPages.list(identifier) -> CustomPageWithoutHTMLsSinglePage - client.zeroTrust.access.customPages.delete(identifier, uuid) -> CustomPageDeleteResponse -- client.zeroTrust.access.customPages.get(identifier, uuid) -> ZeroTrustCustomPage +- client.zeroTrust.access.customPages.get(identifier, uuid) -> CustomPage ### Tags Types: -- ZeroTrustTag +- Tag - TagDeleteResponse Methods: -- client.zeroTrust.access.tags.create(identifier, { ...params }) -> ZeroTrustTag -- client.zeroTrust.access.tags.update(identifier, tagName, { ...params }) -> ZeroTrustTag -- client.zeroTrust.access.tags.list(identifier) -> ZeroTrustTagsSinglePage +- client.zeroTrust.access.tags.create(identifier, { ...params }) -> Tag +- client.zeroTrust.access.tags.update(identifier, tagName, { ...params }) -> Tag +- client.zeroTrust.access.tags.list(identifier) -> TagsSinglePage - client.zeroTrust.access.tags.delete(identifier, name) -> TagDeleteResponse -- client.zeroTrust.access.tags.get(identifier, name) -> ZeroTrustTag +- client.zeroTrust.access.tags.get(identifier, name) -> Tag ## DEX +Types: + +- DeviceExperienceMonitor +- NetworkPath +- NetworkPathResponse +- Percentiles + ### Colos Types: @@ -4532,6 +4645,7 @@ Methods: Types: +- LiveStat - FleetStatusLiveResponse Methods: @@ -4543,37 +4657,39 @@ Methods: Types: -- DigitalExperienceMonitoringDevice +- DeviceListResponse Methods: -- client.zeroTrust.dex.fleetStatus.devices.list({ ...params }) -> DigitalExperienceMonitoringDevicesV4PagePaginationArray +- client.zeroTrust.dex.fleetStatus.devices.list({ ...params }) -> DeviceListResponsesV4PagePaginationArray ### HTTPTests Types: -- DigitalExperienceMonitoringHTTPDetails +- HTTPDetails Methods: -- client.zeroTrust.dex.httpTests.get(testId, { ...params }) -> DigitalExperienceMonitoringHTTPDetails +- client.zeroTrust.dex.httpTests.get(testId, { ...params }) -> HTTPDetails #### Percentiles Types: -- DigitalExperienceMonitoringHTTPDetailsPercentiles +- HTTPDetailsPercentiles +- TestStatOverTime Methods: -- client.zeroTrust.dex.httpTests.percentiles.get(testId, { ...params }) -> DigitalExperienceMonitoringHTTPDetailsPercentiles +- client.zeroTrust.dex.httpTests.percentiles.get(testId, { ...params }) -> HTTPDetailsPercentiles ### Tests Types: -- DigitalExperienceMonitoringTests +- AggregateTimePeriod +- Tests - TestListResponse Methods: @@ -4584,11 +4700,11 @@ Methods: Types: -- DigitalExperienceMonitoringUniqueDevices +- UniqueDevices Methods: -- client.zeroTrust.dex.tests.uniqueDevices.list({ ...params }) -> DigitalExperienceMonitoringUniqueDevices +- client.zeroTrust.dex.tests.uniqueDevices.list({ ...params }) -> UniqueDevices ### TracerouteTestResults @@ -4596,41 +4712,43 @@ Methods: Types: -- DigitalExperienceMonitoringTracerouteTestResultNetworkPath +- NetworkPathGetResponse Methods: -- client.zeroTrust.dex.tracerouteTestResults.networkPath.get(testResultId, { ...params }) -> DigitalExperienceMonitoringTracerouteTestResultNetworkPath +- client.zeroTrust.dex.tracerouteTestResults.networkPath.get(testResultId, { ...params }) -> NetworkPathGetResponse ### TracerouteTests Types: -- DigitalExperienceMonitoringTracerouteDetails -- DigitalExperienceMonitoringTracerouteDetailsPercentiles -- DigitalExperienceMonitoringTracerouteTestNetworkPath +- Traceroute +- TracerouteTestPercentilesResponse Methods: -- client.zeroTrust.dex.tracerouteTests.get(testId, { ...params }) -> DigitalExperienceMonitoringTracerouteDetails -- client.zeroTrust.dex.tracerouteTests.networkPath(testId, { ...params }) -> DigitalExperienceMonitoringTracerouteTestNetworkPath -- client.zeroTrust.dex.tracerouteTests.percentiles(testId, { ...params }) -> DigitalExperienceMonitoringTracerouteDetailsPercentiles +- client.zeroTrust.dex.tracerouteTests.get(testId, { ...params }) -> Traceroute +- client.zeroTrust.dex.tracerouteTests.networkPath(testId, { ...params }) -> NetworkPathResponse +- client.zeroTrust.dex.tracerouteTests.percentiles(testId, { ...params }) -> TracerouteTestPercentilesResponse ## Tunnels Types: -- TunnelArgoTunnel +- Connection +- TunnelCreateResponse - TunnelListResponse +- TunnelDeleteResponse - TunnelEditResponse +- TunnelGetResponse Methods: -- client.zeroTrust.tunnels.create({ ...params }) -> TunnelArgoTunnel +- client.zeroTrust.tunnels.create({ ...params }) -> TunnelCreateResponse - client.zeroTrust.tunnels.list({ ...params }) -> TunnelListResponsesV4PagePaginationArray -- client.zeroTrust.tunnels.delete(tunnelId, { ...params }) -> TunnelArgoTunnel +- client.zeroTrust.tunnels.delete(tunnelId, { ...params }) -> TunnelDeleteResponse - client.zeroTrust.tunnels.edit(tunnelId, { ...params }) -> TunnelEditResponse -- client.zeroTrust.tunnels.get(tunnelId, { ...params }) -> TunnelArgoTunnel +- client.zeroTrust.tunnels.get(tunnelId, { ...params }) -> TunnelGetResponse ### Configurations @@ -4648,7 +4766,7 @@ Methods: Types: -- TunnelTunnelClient +- Client - ConnectionDeleteResponse - ConnectionGetResponse @@ -4671,7 +4789,7 @@ Methods: Methods: -- client.zeroTrust.tunnels.connectors.get(tunnelId, connectorId, { ...params }) -> TunnelTunnelClient +- client.zeroTrust.tunnels.connectors.get(tunnelId, connectorId, { ...params }) -> Client ### Management @@ -4701,38 +4819,34 @@ Methods: Types: -- DLPDataset -- DLPDatasetArray -- DLPDatasetCreation +- Dataset +- DatasetArray +- DatasetCreation Methods: -- client.zeroTrust.dlp.datasets.create({ ...params }) -> DLPDatasetCreation -- client.zeroTrust.dlp.datasets.update(datasetId, { ...params }) -> DLPDataset -- client.zeroTrust.dlp.datasets.list({ ...params }) -> DLPDatasetsSinglePage +- client.zeroTrust.dlp.datasets.create({ ...params }) -> DatasetCreation +- client.zeroTrust.dlp.datasets.update(datasetId, { ...params }) -> Dataset +- client.zeroTrust.dlp.datasets.list({ ...params }) -> DatasetsSinglePage - client.zeroTrust.dlp.datasets.delete(datasetId, { ...params }) -> void -- client.zeroTrust.dlp.datasets.get(datasetId, { ...params }) -> DLPDataset +- client.zeroTrust.dlp.datasets.get(datasetId, { ...params }) -> Dataset #### Upload Types: -- DLPDatasetNewVersion +- NewVersion Methods: -- client.zeroTrust.dlp.datasets.upload.create(datasetId, { ...params }) -> DLPDatasetNewVersion -- client.zeroTrust.dlp.datasets.upload.edit(datasetId, version, { ...params }) -> DLPDataset +- client.zeroTrust.dlp.datasets.upload.create(datasetId, { ...params }) -> NewVersion +- client.zeroTrust.dlp.datasets.upload.edit(datasetId, version, { ...params }) -> Dataset ### Patterns -Types: - -- PatternValidateResponse - Methods: -- client.zeroTrust.dlp.patterns.validate({ ...params }) -> PatternValidateResponse +- client.zeroTrust.dlp.patterns.validate({ ...params }) -> OwnershipValidation | null ### PayloadLogs @@ -4750,39 +4864,42 @@ Methods: Types: -- DLPProfiles +- ContextAwareness +- Profile +- SkipConfiguration - ProfileGetResponse Methods: -- client.zeroTrust.dlp.profiles.list({ ...params }) -> DLPProfilesSinglePage +- client.zeroTrust.dlp.profiles.list({ ...params }) -> ProfilesSinglePage - client.zeroTrust.dlp.profiles.get(profileId, { ...params }) -> ProfileGetResponse #### Custom Types: -- DLPCustomProfile +- CustomProfile +- Pattern - CustomCreateResponse - CustomDeleteResponse Methods: - client.zeroTrust.dlp.profiles.custom.create({ ...params }) -> CustomCreateResponse | null -- client.zeroTrust.dlp.profiles.custom.update(profileId, { ...params }) -> DLPCustomProfile +- client.zeroTrust.dlp.profiles.custom.update(profileId, { ...params }) -> CustomProfile - client.zeroTrust.dlp.profiles.custom.delete(profileId, { ...params }) -> CustomDeleteResponse -- client.zeroTrust.dlp.profiles.custom.get(profileId, { ...params }) -> DLPCustomProfile +- client.zeroTrust.dlp.profiles.custom.get(profileId, { ...params }) -> CustomProfile #### Predefined Types: -- DLPPredefinedProfile +- PredefinedProfile Methods: -- client.zeroTrust.dlp.profiles.predefined.update(profileId, { ...params }) -> DLPPredefinedProfile -- client.zeroTrust.dlp.profiles.predefined.get(profileId, { ...params }) -> DLPPredefinedProfile +- client.zeroTrust.dlp.profiles.predefined.update(profileId, { ...params }) -> PredefinedProfile +- client.zeroTrust.dlp.profiles.predefined.get(profileId, { ...params }) -> PredefinedProfile ## Gateway @@ -4800,37 +4917,49 @@ Methods: Types: -- ZeroTrustGatewaySettings +- GatewaySettings Methods: -- client.zeroTrust.gateway.auditSSHSettings.update({ ...params }) -> ZeroTrustGatewaySettings -- client.zeroTrust.gateway.auditSSHSettings.get({ ...params }) -> ZeroTrustGatewaySettings +- client.zeroTrust.gateway.auditSSHSettings.update({ ...params }) -> GatewaySettings +- client.zeroTrust.gateway.auditSSHSettings.get({ ...params }) -> GatewaySettings ### Categories Types: -- ZeroTrustGatewayCategories +- Category Methods: -- client.zeroTrust.gateway.categories.list({ ...params }) -> ZeroTrustGatewayCategoriesSinglePage +- client.zeroTrust.gateway.categories.list({ ...params }) -> CategoriesSinglePage ### AppTypes Types: -- ZeroTrustGatewayAppTypes +- AppType Methods: -- client.zeroTrust.gateway.appTypes.list({ ...params }) -> ZeroTrustGatewayAppTypesSinglePage +- client.zeroTrust.gateway.appTypes.list({ ...params }) -> AppTypesSinglePage ### Configurations Types: +- ActivityLogSettings +- AntiVirusSettings +- BlockPageSettings +- BodyScanningSettings +- BrowserIsolationSettings +- CustomCertificateSettings +- ExtendedEmailMatching +- FipsSettings +- GatewayConfigurationSettings +- NotificationSettings +- ProtocolDetection +- TLSSettings - ConfigurationUpdateResponse - ConfigurationEditResponse - ConfigurationGetResponse @@ -4845,18 +4974,19 @@ Methods: Types: -- ZeroTrustGatewayLists +- GatewayItem +- GatewayList - ListCreateResponse - ListDeleteResponse Methods: - client.zeroTrust.gateway.lists.create({ ...params }) -> ListCreateResponse -- client.zeroTrust.gateway.lists.update(listId, { ...params }) -> ZeroTrustGatewayLists -- client.zeroTrust.gateway.lists.list({ ...params }) -> ZeroTrustGatewayListsSinglePage +- client.zeroTrust.gateway.lists.update(listId, { ...params }) -> GatewayList +- client.zeroTrust.gateway.lists.list({ ...params }) -> GatewayListsSinglePage - client.zeroTrust.gateway.lists.delete(listId, { ...params }) -> ListDeleteResponse -- client.zeroTrust.gateway.lists.edit(listId, { ...params }) -> ZeroTrustGatewayLists -- client.zeroTrust.gateway.lists.get(listId, { ...params }) -> ZeroTrustGatewayLists +- client.zeroTrust.gateway.lists.edit(listId, { ...params }) -> GatewayList +- client.zeroTrust.gateway.lists.get(listId, { ...params }) -> GatewayList #### Items @@ -4872,57 +5002,64 @@ Methods: Types: -- ZeroTrustGatewayLocations +- Location +- LocationNetwork - LocationDeleteResponse Methods: -- client.zeroTrust.gateway.locations.create({ ...params }) -> ZeroTrustGatewayLocations -- client.zeroTrust.gateway.locations.update(locationId, { ...params }) -> ZeroTrustGatewayLocations -- client.zeroTrust.gateway.locations.list({ ...params }) -> ZeroTrustGatewayLocationsSinglePage +- client.zeroTrust.gateway.locations.create({ ...params }) -> Location +- client.zeroTrust.gateway.locations.update(locationId, { ...params }) -> Location +- client.zeroTrust.gateway.locations.list({ ...params }) -> LocationsSinglePage - client.zeroTrust.gateway.locations.delete(locationId, { ...params }) -> LocationDeleteResponse -- client.zeroTrust.gateway.locations.get(locationId, { ...params }) -> ZeroTrustGatewayLocations +- client.zeroTrust.gateway.locations.get(locationId, { ...params }) -> Location ### Logging Types: -- ZeroTrustGatewayGatewayAccountLoggingSettings +- LoggingSetting Methods: -- client.zeroTrust.gateway.logging.update({ ...params }) -> ZeroTrustGatewayGatewayAccountLoggingSettings -- client.zeroTrust.gateway.logging.get({ ...params }) -> ZeroTrustGatewayGatewayAccountLoggingSettings +- client.zeroTrust.gateway.logging.update({ ...params }) -> LoggingSetting +- client.zeroTrust.gateway.logging.get({ ...params }) -> LoggingSetting ### ProxyEndpoints Types: -- ZeroTrustGatewayProxyEndpoints +- GatewayIPs +- ProxyEndpoint - ProxyEndpointDeleteResponse Methods: -- client.zeroTrust.gateway.proxyEndpoints.create({ ...params }) -> ZeroTrustGatewayProxyEndpoints -- client.zeroTrust.gateway.proxyEndpoints.list({ ...params }) -> ZeroTrustGatewayProxyEndpointsSinglePage +- client.zeroTrust.gateway.proxyEndpoints.create({ ...params }) -> ProxyEndpoint +- client.zeroTrust.gateway.proxyEndpoints.list({ ...params }) -> ProxyEndpointsSinglePage - client.zeroTrust.gateway.proxyEndpoints.delete(proxyEndpointId, { ...params }) -> ProxyEndpointDeleteResponse -- client.zeroTrust.gateway.proxyEndpoints.edit(proxyEndpointId, { ...params }) -> ZeroTrustGatewayProxyEndpoints -- client.zeroTrust.gateway.proxyEndpoints.get(proxyEndpointId, { ...params }) -> ZeroTrustGatewayProxyEndpoints +- client.zeroTrust.gateway.proxyEndpoints.edit(proxyEndpointId, { ...params }) -> ProxyEndpoint +- client.zeroTrust.gateway.proxyEndpoints.get(proxyEndpointId, { ...params }) -> ProxyEndpoint ### Rules Types: -- ZeroTrustGatewayRules +- DNSResolverSettingsV4 +- DNSResolverSettingsV6 +- GatewayFilter +- GatewayRule +- RuleSetting +- Schedule - RuleDeleteResponse Methods: -- client.zeroTrust.gateway.rules.create({ ...params }) -> ZeroTrustGatewayRules -- client.zeroTrust.gateway.rules.update(ruleId, { ...params }) -> ZeroTrustGatewayRules -- client.zeroTrust.gateway.rules.list({ ...params }) -> ZeroTrustGatewayRulesSinglePage +- client.zeroTrust.gateway.rules.create({ ...params }) -> GatewayRule +- client.zeroTrust.gateway.rules.update(ruleId, { ...params }) -> GatewayRule +- client.zeroTrust.gateway.rules.list({ ...params }) -> GatewayRulesSinglePage - client.zeroTrust.gateway.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse -- client.zeroTrust.gateway.rules.get(ruleId, { ...params }) -> ZeroTrustGatewayRules +- client.zeroTrust.gateway.rules.get(ruleId, { ...params }) -> GatewayRule ## Networks @@ -4930,35 +5067,36 @@ Methods: Types: -- TunnelRoute -- TunnelTeamnet +- NetworkRoute +- Route +- Teamnet Methods: -- client.zeroTrust.networks.routes.create({ ...params }) -> TunnelRoute -- client.zeroTrust.networks.routes.list({ ...params }) -> TunnelTeamnetsV4PagePaginationArray -- client.zeroTrust.networks.routes.delete(routeId, { ...params }) -> TunnelRoute -- client.zeroTrust.networks.routes.edit(routeId, { ...params }) -> TunnelRoute +- client.zeroTrust.networks.routes.create({ ...params }) -> Route +- client.zeroTrust.networks.routes.list({ ...params }) -> TeamnetsV4PagePaginationArray +- client.zeroTrust.networks.routes.delete(routeId, { ...params }) -> Route +- client.zeroTrust.networks.routes.edit(routeId, { ...params }) -> Route #### IPs Methods: -- client.zeroTrust.networks.routes.ips.get(ip, { ...params }) -> TunnelTeamnet +- client.zeroTrust.networks.routes.ips.get(ip, { ...params }) -> Teamnet #### Networks Methods: -- client.zeroTrust.networks.routes.networks.create(ipNetworkEncoded, { ...params }) -> TunnelRoute -- client.zeroTrust.networks.routes.networks.delete(ipNetworkEncoded, { ...params }) -> TunnelRoute -- client.zeroTrust.networks.routes.networks.edit(ipNetworkEncoded, { ...params }) -> TunnelRoute +- client.zeroTrust.networks.routes.networks.create(ipNetworkEncoded, { ...params }) -> Route +- client.zeroTrust.networks.routes.networks.delete(ipNetworkEncoded, { ...params }) -> Route +- client.zeroTrust.networks.routes.networks.edit(ipNetworkEncoded, { ...params }) -> Route ### VirtualNetworks Types: -- TunnelVirtualNetwork +- VirtualNetwork - VirtualNetworkCreateResponse - VirtualNetworkDeleteResponse - VirtualNetworkEditResponse @@ -4966,53 +5104,84 @@ Types: Methods: - client.zeroTrust.networks.virtualNetworks.create({ ...params }) -> VirtualNetworkCreateResponse -- client.zeroTrust.networks.virtualNetworks.list({ ...params }) -> TunnelVirtualNetworksSinglePage +- client.zeroTrust.networks.virtualNetworks.list({ ...params }) -> VirtualNetworksSinglePage - client.zeroTrust.networks.virtualNetworks.delete(virtualNetworkId, { ...params }) -> VirtualNetworkDeleteResponse - client.zeroTrust.networks.virtualNetworks.edit(virtualNetworkId, { ...params }) -> VirtualNetworkEditResponse +## RiskScoring + +Types: + +- RiskScoringGetResponse +- RiskScoringResetResponse + +Methods: + +- client.zeroTrust.riskScoring.get(accountIdentifier, userId, { ...params }) -> RiskScoringGetResponse +- client.zeroTrust.riskScoring.reset(accountIdentifier, userId) -> RiskScoringResetResponse + +### Behaviours + +Types: + +- BehaviourUpdateResponse +- BehaviourGetResponse + +Methods: + +- client.zeroTrust.riskScoring.behaviours.update(accountIdentifier, { ...params }) -> BehaviourUpdateResponse +- client.zeroTrust.riskScoring.behaviours.get(accountIdentifier) -> BehaviourGetResponse + +### Summary + +Types: + +- SummaryGetResponse + +Methods: + +- client.zeroTrust.riskScoring.summary.get(accountIdentifier, { ...params }) -> SummaryGetResponse + # Challenges ## Widgets Types: -- ChallengesWidget -- ChallengesWidgetList +- Widget +- WidgetDomain +- WidgetListResponse Methods: -- client.challenges.widgets.create({ ...params }) -> ChallengesWidget -- client.challenges.widgets.update(sitekey, { ...params }) -> ChallengesWidget -- client.challenges.widgets.list({ ...params }) -> ChallengesWidgetListsV4PagePaginationArray -- client.challenges.widgets.delete(sitekey, { ...params }) -> ChallengesWidget -- client.challenges.widgets.get(sitekey, { ...params }) -> ChallengesWidget -- client.challenges.widgets.rotateSecret(sitekey, { ...params }) -> ChallengesWidget +- client.challenges.widgets.create({ ...params }) -> Widget +- client.challenges.widgets.update(sitekey, { ...params }) -> Widget +- client.challenges.widgets.list({ ...params }) -> WidgetListResponsesV4PagePaginationArray +- client.challenges.widgets.delete(sitekey, { ...params }) -> Widget +- client.challenges.widgets.get(sitekey, { ...params }) -> Widget +- client.challenges.widgets.rotateSecret(sitekey, { ...params }) -> Widget # Hyperdrive Types: +- Configuration - Hyperdrive ## Configs Types: -- ConfigCreateResponse -- ConfigUpdateResponse -- ConfigListResponse - ConfigDeleteResponse -- ConfigEditResponse -- ConfigGetResponse Methods: -- client.hyperdrive.configs.create({ ...params }) -> ConfigCreateResponse | null -- client.hyperdrive.configs.update(hyperdriveId, { ...params }) -> ConfigUpdateResponse | null -- client.hyperdrive.configs.list({ ...params }) -> ConfigListResponsesSinglePage -- client.hyperdrive.configs.delete(hyperdriveId, { ...params }) -> ConfigDeleteResponse | null -- client.hyperdrive.configs.edit(hyperdriveId, { ...params }) -> ConfigEditResponse | null -- client.hyperdrive.configs.get(hyperdriveId, { ...params }) -> ConfigGetResponse | null +- client.hyperdrive.configs.create({ ...params }) -> Hyperdrive | null +- client.hyperdrive.configs.update(hyperdriveId, { ...params }) -> Hyperdrive | null +- client.hyperdrive.configs.list({ ...params }) -> HyperdrivesSinglePage +- client.hyperdrive.configs.delete(hyperdriveId, { ...params }) -> ConfigDeleteResponse +- client.hyperdrive.configs.edit(hyperdriveId, { ...params }) -> Hyperdrive | null +- client.hyperdrive.configs.get(hyperdriveId, { ...params }) -> Hyperdrive | null # RUM @@ -5020,16 +5189,16 @@ Methods: Types: -- RUMSite +- Site - SiteInfoDeleteResponse Methods: -- client.rum.siteInfo.create({ ...params }) -> RUMSite -- client.rum.siteInfo.update(siteId, { ...params }) -> RUMSite -- client.rum.siteInfo.list({ ...params }) -> RUMSitesV4PagePaginationArray +- client.rum.siteInfo.create({ ...params }) -> Site +- client.rum.siteInfo.update(siteId, { ...params }) -> Site +- client.rum.siteInfo.list({ ...params }) -> SitesV4PagePaginationArray - client.rum.siteInfo.delete(siteId, { ...params }) -> SiteInfoDeleteResponse -- client.rum.siteInfo.get(siteId, { ...params }) -> RUMSite +- client.rum.siteInfo.get(siteId, { ...params }) -> Site ## Rules @@ -5052,26 +5221,27 @@ Methods: Types: -- VectorizeCreateIndex -- VectorizeIndexDeleteVectorsByID -- VectorizeIndexInsert -- VectorizeIndexQuery -- VectorizeIndexUpsert +- CreateIndex +- IndexDeleteVectorsByID +- IndexDimensionConfiguration +- IndexInsert +- IndexQuery +- IndexUpsert - IndexDeleteResponse - IndexGetByIDsResponse Methods: -- client.vectorize.indexes.create(accountIdentifier, { ...params }) -> VectorizeCreateIndex | null -- client.vectorize.indexes.update(accountIdentifier, indexName, { ...params }) -> VectorizeCreateIndex | null -- client.vectorize.indexes.list(accountIdentifier) -> VectorizeCreateIndicesSinglePage -- client.vectorize.indexes.delete(accountIdentifier, indexName) -> IndexDeleteResponse | null -- client.vectorize.indexes.deleteByIds(accountIdentifier, indexName, { ...params }) -> VectorizeIndexDeleteVectorsByID | null -- client.vectorize.indexes.get(accountIdentifier, indexName) -> VectorizeCreateIndex | null -- client.vectorize.indexes.getByIds(accountIdentifier, indexName, { ...params }) -> IndexGetByIDsResponse | null -- client.vectorize.indexes.insert(accountIdentifier, indexName) -> VectorizeIndexInsert | null -- client.vectorize.indexes.query(accountIdentifier, indexName, { ...params }) -> VectorizeIndexQuery | null -- client.vectorize.indexes.upsert(accountIdentifier, indexName) -> VectorizeIndexUpsert | null +- client.vectorize.indexes.create({ ...params }) -> CreateIndex | null +- client.vectorize.indexes.update(indexName, { ...params }) -> CreateIndex | null +- client.vectorize.indexes.list({ ...params }) -> CreateIndicesSinglePage +- client.vectorize.indexes.delete(indexName, { ...params }) -> IndexDeleteResponse +- client.vectorize.indexes.deleteByIds(indexName, { ...params }) -> IndexDeleteVectorsByID | null +- client.vectorize.indexes.get(indexName, { ...params }) -> CreateIndex | null +- client.vectorize.indexes.getByIds(indexName, { ...params }) -> IndexGetByIDsResponse | null +- client.vectorize.indexes.insert(indexName, { ...params }) -> IndexInsert | null +- client.vectorize.indexes.query(indexName, { ...params }) -> IndexQuery | null +- client.vectorize.indexes.upsert(indexName, { ...params }) -> IndexUpsert | null # URLScanner @@ -5087,6 +5257,8 @@ Methods: Types: +- URLScannerDomain +- URLScannerTask - ScanCreateResponse - ScanGetResponse - ScanHarResponse @@ -5126,13 +5298,15 @@ Methods: ### Leaks +#### Events + Types: -- LeakEventsResponse +- EventListResponse Methods: -- client.radar.bgp.leaks.events({ ...params }) -> LeakEventsResponse +- client.radar.bgp.leaks.events.list({ ...params }) -> EventListResponsesV4PagePagination ### Top @@ -5158,13 +5332,15 @@ Methods: ### Hijacks +#### Events + Types: -- HijackEventsResponse +- EventListResponse Methods: -- client.radar.bgp.hijacks.events({ ...params }) -> HijackEventsResponse +- client.radar.bgp.hijacks.events.list({ ...params }) -> EventListResponsesV4PagePagination ### Routes @@ -5336,6 +5512,11 @@ Methods: ## Email +Types: + +- RadarEmailSeries +- RadarEmailSummary + ### Routing #### Summary @@ -5690,6 +5871,7 @@ Methods: Types: +- Browser - TopBrowserFamiliesResponse - TopBrowsersResponse @@ -5990,6 +6172,10 @@ Methods: Types: +- BotFightModeConfiguration +- SubscriptionConfiguration +- SuperBotFightModeDefinitelyConfiguration +- SuperBotFightModeLikelyConfiguration - BotManagementUpdateResponse - BotManagementGetResponse @@ -6014,35 +6200,37 @@ Methods: Types: -- ObservatorySchedule -- ObservatoryTrend +- LabeledRegion +- LighthouseReport +- Trend - SpeedDeleteResponse Methods: - client.speed.delete(url, { ...params }) -> SpeedDeleteResponse -- client.speed.scheduleGet(url, { ...params }) -> ObservatorySchedule -- client.speed.trendsList(url, { ...params }) -> ObservatoryTrend +- client.speed.scheduleGet(url, { ...params }) -> Schedule +- client.speed.trendsList(url, { ...params }) -> Trend ## Tests Types: -- ObservatoryPageTest +- Test - TestListResponse - TestDeleteResponse Methods: -- client.speed.tests.create(url, { ...params }) -> ObservatoryPageTest +- client.speed.tests.create(url, { ...params }) -> Test - client.speed.tests.list(url, { ...params }) -> TestListResponse - client.speed.tests.delete(url, { ...params }) -> TestDeleteResponse -- client.speed.tests.get(url, testId, { ...params }) -> ObservatoryPageTest +- client.speed.tests.get(url, testId, { ...params }) -> Test ## Schedule Types: +- Schedule - ScheduleCreateResponse Methods: @@ -6053,11 +6241,11 @@ Methods: Types: -- ObservatoryAvailabilities +- Availability Methods: -- client.speed.availabilities.list({ ...params }) -> ObservatoryAvailabilities +- client.speed.availabilities.list({ ...params }) -> Availability ## Pages @@ -6089,14 +6277,15 @@ Methods: Types: -- HostnameSettingDelete -- HostnameStting +- Setting +- SettingValue +- TLSDeleteResponse - TLSGetResponse Methods: -- client.hostnames.settings.tls.update(settingId, hostname, { ...params }) -> HostnameStting -- client.hostnames.settings.tls.delete(settingId, hostname, { ...params }) -> HostnameSettingDelete +- client.hostnames.settings.tls.update(settingId, hostname, { ...params }) -> Setting +- client.hostnames.settings.tls.delete(settingId, hostname, { ...params }) -> TLSDeleteResponse - client.hostnames.settings.tls.get(settingId, { ...params }) -> TLSGetResponse | null # Snippets @@ -6152,36 +6341,36 @@ Methods: Types: -- CloudforceOneQuota -- CloudforceOneRequestConstants -- CloudforceOneRequestItem -- CloudforceOneRequestListItem -- CloudforceOneRequestTypes +- Item +- ListItem +- Quota +- RequestConstants +- RequestTypes - RequestDeleteResponse Methods: -- client.cloudforceOne.requests.create(accountIdentifier, { ...params }) -> CloudforceOneRequestItem -- client.cloudforceOne.requests.update(accountIdentifier, requestIdentifier, { ...params }) -> CloudforceOneRequestItem -- client.cloudforceOne.requests.list(accountIdentifier, { ...params }) -> CloudforceOneRequestListItemsV4PagePaginationArray +- client.cloudforceOne.requests.create(accountIdentifier, { ...params }) -> Item +- client.cloudforceOne.requests.update(accountIdentifier, requestIdentifier, { ...params }) -> Item +- client.cloudforceOne.requests.list(accountIdentifier, { ...params }) -> ListItemsV4PagePaginationArray - client.cloudforceOne.requests.delete(accountIdentifier, requestIdentifier) -> RequestDeleteResponse -- client.cloudforceOne.requests.constants(accountIdentifier) -> CloudforceOneRequestConstants -- client.cloudforceOne.requests.get(accountIdentifier, requestIdentifier) -> CloudforceOneRequestItem -- client.cloudforceOne.requests.quota(accountIdentifier) -> CloudforceOneQuota -- client.cloudforceOne.requests.types(accountIdentifier) -> CloudforceOneRequestTypes +- client.cloudforceOne.requests.constants(accountIdentifier) -> RequestConstants +- client.cloudforceOne.requests.get(accountIdentifier, requestIdentifier) -> Item +- client.cloudforceOne.requests.quota(accountIdentifier) -> Quota +- client.cloudforceOne.requests.types(accountIdentifier) -> RequestTypes ### Message Types: -- CloudforceOneRequestMessageItem +- Message - MessageDeleteResponse - MessageGetResponse Methods: -- client.cloudforceOne.requests.message.create(accountIdentifier, requestIdentifier, { ...params }) -> CloudforceOneRequestMessageItem -- client.cloudforceOne.requests.message.update(accountIdentifier, requestIdentifier, messageIdentifer, { ...params }) -> CloudforceOneRequestMessageItem +- client.cloudforceOne.requests.message.create(accountIdentifier, requestIdentifier, { ...params }) -> Message +- client.cloudforceOne.requests.message.update(accountIdentifier, requestIdentifier, messageIdentifer, { ...params }) -> Message - client.cloudforceOne.requests.message.delete(accountIdentifier, requestIdentifier, messageIdentifer) -> MessageDeleteResponse - client.cloudforceOne.requests.message.get(accountIdentifier, requestIdentifier, { ...params }) -> MessageGetResponse @@ -6189,13 +6378,41 @@ Methods: Types: -- CloudforceOnePriorityItem +- Label +- Priority +- PriorityEdit - PriorityDeleteResponse Methods: -- client.cloudforceOne.requests.priority.create(accountIdentifier, { ...params }) -> CloudforceOnePriorityItem -- client.cloudforceOne.requests.priority.update(accountIdentifier, priorityIdentifer, { ...params }) -> CloudforceOneRequestItem +- client.cloudforceOne.requests.priority.create(accountIdentifier, { ...params }) -> Priority +- client.cloudforceOne.requests.priority.update(accountIdentifier, priorityIdentifer, { ...params }) -> Item - client.cloudforceOne.requests.priority.delete(accountIdentifier, priorityIdentifer) -> PriorityDeleteResponse -- client.cloudforceOne.requests.priority.get(accountIdentifier, priorityIdentifer) -> CloudforceOneRequestItem -- client.cloudforceOne.requests.priority.quota(accountIdentifier) -> CloudforceOneQuota +- client.cloudforceOne.requests.priority.get(accountIdentifier, priorityIdentifer) -> Item +- client.cloudforceOne.requests.priority.quota(accountIdentifier) -> Quota + +# EventNotifications + +## R2 + +### Configuration + +Types: + +- ConfigurationGetResponse + +Methods: + +- client.eventNotifications.r2.configuration.get(bucketName, { ...params }) -> ConfigurationGetResponse + +#### Queues + +Types: + +- QueueUpdateResponse +- QueueDeleteResponse + +Methods: + +- client.eventNotifications.r2.configuration.queues.update(bucketName, queueId, { ...params }) -> QueueUpdateResponse +- client.eventNotifications.r2.configuration.queues.delete(bucketName, queueId, { ...params }) -> QueueDeleteResponse diff --git a/jest.config.ts b/jest.config.ts index 978c07f71c..12abddd57f 100644 --- a/jest.config.ts +++ b/jest.config.ts @@ -3,6 +3,9 @@ import type { JestConfigWithTsJest } from 'ts-jest'; const config: JestConfigWithTsJest = { preset: 'ts-jest/presets/default-esm', testEnvironment: 'node', + transform: { + '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }], + }, moduleNameMapper: { '^cloudflare$': '/src/index.ts', '^cloudflare/_shims/auto/(.*)$': '/src/_shims/auto/$1-node', diff --git a/package.json b/package.json index a8102968fb..89328a03c9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "cloudflare", - "version": "3.0.0", + "version": "3.1.0", "description": "The official TypeScript library for the Cloudflare API", "author": "Cloudflare ", "types": "dist/index.d.ts", @@ -8,7 +8,7 @@ "type": "commonjs", "repository": "github:cloudflare/cloudflare-typescript", "license": "Apache-2.0", - "packageManager": "yarn@1.22.21", + "packageManager": "yarn@1.22.22", "files": [ "*" ], @@ -30,7 +30,6 @@ "@types/qs": "^6.9.7", "abort-controller": "^3.0.0", "agentkeepalive": "^4.2.1", - "digest-fetch": "^1.3.0", "form-data-encoder": "1.7.2", "formdata-node": "^4.3.2", "node-fetch": "^2.6.7", @@ -38,6 +37,8 @@ "web-streams-polyfill": "^3.2.1" }, "devDependencies": { + "@swc/core": "^1.3.102", + "@swc/jest": "^0.2.29", "@types/jest": "^29.4.0", "@typescript-eslint/eslint-plugin": "^6.7.0", "@typescript-eslint/parser": "^6.7.0", diff --git a/src/index.ts b/src/index.ts index 58c80def69..9af17bc07b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -9,6 +9,11 @@ import * as Pagination from 'cloudflare/pagination'; import * as API from 'cloudflare/resources/index'; export interface ClientOptions { + /** + * Defaults to process.env['CLOUDFLARE_API_TOKEN']. + */ + apiToken?: string | null | undefined; + /** * Defaults to process.env['CLOUDFLARE_API_KEY']. */ @@ -19,11 +24,6 @@ export interface ClientOptions { */ apiEmail?: string | null | undefined; - /** - * Defaults to process.env['CLOUDFLARE_API_TOKEN']. - */ - apiToken?: string | null | undefined; - /** * Defaults to process.env['CLOUDFLARE_API_USER_SERVICE_KEY']. */ @@ -88,9 +88,9 @@ export interface ClientOptions { /** API Client for interfacing with the Cloudflare API. */ export class Cloudflare extends Core.APIClient { + apiToken: string | null; apiKey: string | null; apiEmail: string | null; - apiToken: string | null; userServiceKey: string | null; private _options: ClientOptions; @@ -98,9 +98,9 @@ export class Cloudflare extends Core.APIClient { /** * API Client for interfacing with the Cloudflare API. * + * @param {string | null | undefined} [opts.apiToken=process.env['CLOUDFLARE_API_TOKEN'] ?? null] * @param {string | null | undefined} [opts.apiKey=process.env['CLOUDFLARE_API_KEY'] ?? null] * @param {string | null | undefined} [opts.apiEmail=process.env['CLOUDFLARE_EMAIL'] ?? null] - * @param {string | null | undefined} [opts.apiToken=process.env['CLOUDFLARE_API_TOKEN'] ?? null] * @param {string | null | undefined} [opts.userServiceKey=process.env['CLOUDFLARE_API_USER_SERVICE_KEY'] ?? null] * @param {string} [opts.baseURL=process.env['CLOUDFLARE_BASE_URL'] ?? https://api.cloudflare.com/client/v4] - Override the default base URL for the API. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. @@ -112,16 +112,16 @@ export class Cloudflare extends Core.APIClient { */ constructor({ baseURL = Core.readEnv('CLOUDFLARE_BASE_URL'), + apiToken = Core.readEnv('CLOUDFLARE_API_TOKEN') ?? null, apiKey = Core.readEnv('CLOUDFLARE_API_KEY') ?? null, apiEmail = Core.readEnv('CLOUDFLARE_EMAIL') ?? null, - apiToken = Core.readEnv('CLOUDFLARE_API_TOKEN') ?? null, userServiceKey = Core.readEnv('CLOUDFLARE_API_USER_SERVICE_KEY') ?? null, ...opts }: ClientOptions = {}) { const options: ClientOptions = { + apiToken, apiKey, apiEmail, - apiToken, userServiceKey, ...opts, baseURL: baseURL || `https://api.cloudflare.com/client/v4`, @@ -136,9 +136,9 @@ export class Cloudflare extends Core.APIClient { }); this._options = options; + this.apiToken = apiToken; this.apiKey = apiKey; this.apiEmail = apiEmail; - this.apiToken = apiToken; this.userServiceKey = userServiceKey; } @@ -146,7 +146,7 @@ export class Cloudflare extends Core.APIClient { originCACertificates: API.OriginCACertificates = new API.OriginCACertificates(this); ips: API.IPs = new API.IPs(this); memberships: API.Memberships = new API.Memberships(this); - user: API.UserResource = new API.UserResource(this); + user: API.User = new API.User(this); zones: API.Zones = new API.Zones(this); loadBalancers: API.LoadBalancers = new API.LoadBalancers(this); cache: API.Cache = new API.Cache(this); @@ -203,7 +203,7 @@ export class Cloudflare extends Core.APIClient { storage: API.Storage = new API.Storage(this); stream: API.Stream = new API.Stream(this); alerting: API.Alerting = new API.Alerting(this); - d1: API.D1 = new API.D1(this); + d1: API.D1Resource = new API.D1Resource(this); r2: API.R2 = new API.R2(this); warpConnector: API.WARPConnector = new API.WARPConnector(this); workersForPlatforms: API.WorkersForPlatforms = new API.WorkersForPlatforms(this); @@ -222,6 +222,7 @@ export class Cloudflare extends Core.APIClient { snippets: API.Snippets = new API.Snippets(this); calls: API.Calls = new API.Calls(this); cloudforceOne: API.CloudforceOne = new API.CloudforceOne(this); + eventNotifications: API.EventNotifications = new API.EventNotifications(this); protected override defaultQuery(): Core.DefaultQuery | undefined { return this._options.defaultQuery; @@ -324,7 +325,7 @@ export class Cloudflare extends Core.APIClient { } protected override stringifyQuery(query: Record): string { - return qs.stringify(query, { arrayFormat: 'comma' }); + return qs.stringify(query, { arrayFormat: 'repeat' }); } static Cloudflare = this; @@ -342,6 +343,9 @@ export class Cloudflare extends Core.APIClient { static InternalServerError = Errors.InternalServerError; static PermissionDeniedError = Errors.PermissionDeniedError; static UnprocessableEntityError = Errors.UnprocessableEntityError; + + static toFile = Uploads.toFile; + static fileFromPath = Uploads.fileFromPath; } export const { @@ -364,10 +368,6 @@ export import toFile = Uploads.toFile; export import fileFromPath = Uploads.fileFromPath; export namespace Cloudflare { - // Helper functions - export import toFile = Uploads.toFile; - export import fileFromPath = Uploads.fileFromPath; - export import RequestOptions = Core.RequestOptions; export import V4PagePagination = Pagination.V4PagePagination; @@ -390,241 +390,70 @@ export namespace Cloudflare { export import SinglePageResponse = Pagination.SinglePageResponse; export import Accounts = API.Accounts; - export import Account = API.Account; - export import AccountUpdateResponse = API.AccountUpdateResponse; - export import AccountListResponse = API.AccountListResponse; - export import AccountGetResponse = API.AccountGetResponse; - export import AccountListResponsesV4PagePaginationArray = API.AccountListResponsesV4PagePaginationArray; - export import AccountUpdateParams = API.AccountUpdateParams; - export import AccountListParams = API.AccountListParams; - export import AccountGetParams = API.AccountGetParams; export import OriginCACertificates = API.OriginCACertificates; - export import OriginCACertificate = API.OriginCACertificate; - export import OriginCACertificateCreateResponse = API.OriginCACertificateCreateResponse; - export import OriginCACertificateDeleteResponse = API.OriginCACertificateDeleteResponse; - export import OriginCACertificateGetResponse = API.OriginCACertificateGetResponse; - export import OriginCACertificatesSinglePage = API.OriginCACertificatesSinglePage; - export import OriginCACertificateCreateParams = API.OriginCACertificateCreateParams; export import IPs = API.IPs; - export import JDCloudIPs = API.JDCloudIPs; - export import IPListResponse = API.IPListResponse; - export import IPListParams = API.IPListParams; export import Memberships = API.Memberships; - export import Membership = API.Membership; - export import MembershipUpdateResponse = API.MembershipUpdateResponse; - export import MembershipDeleteResponse = API.MembershipDeleteResponse; - export import MembershipGetResponse = API.MembershipGetResponse; - export import MembershipsV4PagePaginationArray = API.MembershipsV4PagePaginationArray; - export import MembershipUpdateParams = API.MembershipUpdateParams; - export import MembershipListParams = API.MembershipListParams; - - export import UserResource = API.UserResource; + export import User = API.User; - export import UserEditResponse = API.UserEditResponse; - export import UserGetResponse = API.UserGetResponse; - export import UserEditParams = API.UserEditParams; export import Zones = API.Zones; - export import Zone = API.Zone; - export import ZoneDeleteResponse = API.ZoneDeleteResponse; - export import ZonesV4PagePaginationArray = API.ZonesV4PagePaginationArray; - export import ZoneCreateParams = API.ZoneCreateParams; - export import ZoneListParams = API.ZoneListParams; - export import ZoneDeleteParams = API.ZoneDeleteParams; - export import ZoneEditParams = API.ZoneEditParams; - export import ZoneGetParams = API.ZoneGetParams; export import LoadBalancers = API.LoadBalancers; - export import LoadBalancer = API.LoadBalancer; - export import LoadBalancerDeleteResponse = API.LoadBalancerDeleteResponse; - export import LoadBalancersSinglePage = API.LoadBalancersSinglePage; - export import LoadBalancerCreateParams = API.LoadBalancerCreateParams; - export import LoadBalancerUpdateParams = API.LoadBalancerUpdateParams; - export import LoadBalancerListParams = API.LoadBalancerListParams; - export import LoadBalancerDeleteParams = API.LoadBalancerDeleteParams; - export import LoadBalancerEditParams = API.LoadBalancerEditParams; - export import LoadBalancerGetParams = API.LoadBalancerGetParams; export import Cache = API.Cache; - export import CachePurgeResponse = API.CachePurgeResponse; - export import CachePurgeParams = API.CachePurgeParams; export import SSL = API.SSL; export import Subscriptions = API.Subscriptions; - export import SubscriptionCreateResponse = API.SubscriptionCreateResponse; - export import SubscriptionUpdateResponse = API.SubscriptionUpdateResponse; - export import SubscriptionListResponse = API.SubscriptionListResponse; - export import SubscriptionDeleteResponse = API.SubscriptionDeleteResponse; - export import SubscriptionGetResponse = API.SubscriptionGetResponse; - export import SubscriptionListResponsesSinglePage = API.SubscriptionListResponsesSinglePage; - export import SubscriptionCreateParams = API.SubscriptionCreateParams; - export import SubscriptionUpdateParams = API.SubscriptionUpdateParams; export import ACM = API.ACM; export import Argo = API.Argo; export import Plans = API.Plans; - export import AvailableRatePlan = API.AvailableRatePlan; - export import AvailableRatePlansSinglePage = API.AvailableRatePlansSinglePage; export import RatePlans = API.RatePlans; - export import RatePlan = API.RatePlan; - export import RatePlanGetResponse = API.RatePlanGetResponse; export import CertificateAuthorities = API.CertificateAuthorities; export import ClientCertificates = API.ClientCertificates; - export import ClientCertificate = API.ClientCertificate; - export import ClientCertificatesV4PagePaginationArray = API.ClientCertificatesV4PagePaginationArray; - export import ClientCertificateCreateParams = API.ClientCertificateCreateParams; - export import ClientCertificateListParams = API.ClientCertificateListParams; - export import ClientCertificateDeleteParams = API.ClientCertificateDeleteParams; - export import ClientCertificateEditParams = API.ClientCertificateEditParams; - export import ClientCertificateGetParams = API.ClientCertificateGetParams; export import CustomCertificates = API.CustomCertificates; - export import CustomCertificate = API.CustomCertificate; - export import CustomCertificateCreateResponse = API.CustomCertificateCreateResponse; - export import CustomCertificateDeleteResponse = API.CustomCertificateDeleteResponse; - export import CustomCertificateEditResponse = API.CustomCertificateEditResponse; - export import CustomCertificateGetResponse = API.CustomCertificateGetResponse; - export import CustomCertificatesV4PagePaginationArray = API.CustomCertificatesV4PagePaginationArray; - export import CustomCertificateCreateParams = API.CustomCertificateCreateParams; - export import CustomCertificateListParams = API.CustomCertificateListParams; - export import CustomCertificateDeleteParams = API.CustomCertificateDeleteParams; - export import CustomCertificateEditParams = API.CustomCertificateEditParams; - export import CustomCertificateGetParams = API.CustomCertificateGetParams; export import CustomHostnames = API.CustomHostnames; - export import CustomHostname = API.CustomHostname; - export import CustomHostnameCreateResponse = API.CustomHostnameCreateResponse; - export import CustomHostnameListResponse = API.CustomHostnameListResponse; - export import CustomHostnameDeleteResponse = API.CustomHostnameDeleteResponse; - export import CustomHostnameEditResponse = API.CustomHostnameEditResponse; - export import CustomHostnameGetResponse = API.CustomHostnameGetResponse; - export import CustomHostnameListResponsesV4PagePaginationArray = API.CustomHostnameListResponsesV4PagePaginationArray; - export import CustomHostnameCreateParams = API.CustomHostnameCreateParams; - export import CustomHostnameListParams = API.CustomHostnameListParams; - export import CustomHostnameDeleteParams = API.CustomHostnameDeleteParams; - export import CustomHostnameEditParams = API.CustomHostnameEditParams; - export import CustomHostnameGetParams = API.CustomHostnameGetParams; export import CustomNameservers = API.CustomNameservers; - export import CustomNameserver = API.CustomNameserver; - export import CustomNameserverDeleteResponse = API.CustomNameserverDeleteResponse; - export import CustomNameserverAvailabiltyResponse = API.CustomNameserverAvailabiltyResponse; - export import CustomNameserverGetResponse = API.CustomNameserverGetResponse; - export import CustomNameserverVerifyResponse = API.CustomNameserverVerifyResponse; - export import CustomNameserverCreateParams = API.CustomNameserverCreateParams; - export import CustomNameserverDeleteParams = API.CustomNameserverDeleteParams; - export import CustomNameserverAvailabiltyParams = API.CustomNameserverAvailabiltyParams; - export import CustomNameserverGetParams = API.CustomNameserverGetParams; - export import CustomNameserverVerifyParams = API.CustomNameserverVerifyParams; export import DNS = API.DNS; export import DNSSECResource = API.DNSSECResource; - export import DNSSEC = API.DNSSEC; - export import DNSSECDeleteResponse = API.DNSSECDeleteResponse; - export import DNSSECDeleteParams = API.DNSSECDeleteParams; - export import DNSSECEditParams = API.DNSSECEditParams; - export import DNSSECGetParams = API.DNSSECGetParams; export import EmailRouting = API.EmailRouting; - export import EmailSettings = API.EmailSettings; - export import EmailRoutingDisableResponse = API.EmailRoutingDisableResponse; - export import EmailRoutingEnableResponse = API.EmailRoutingEnableResponse; - export import EmailRoutingGetResponse = API.EmailRoutingGetResponse; export import Filters = API.Filters; - export import FirewallFilter = API.FirewallFilter; - export import FilterCreateResponse = API.FilterCreateResponse; - export import FirewallFiltersV4PagePaginationArray = API.FirewallFiltersV4PagePaginationArray; - export import FilterCreateParams = API.FilterCreateParams; - export import FilterUpdateParams = API.FilterUpdateParams; - export import FilterListParams = API.FilterListParams; export import Firewall = API.Firewall; export import Healthchecks = API.Healthchecks; - export import Healthcheck = API.Healthcheck; - export import HealthcheckDeleteResponse = API.HealthcheckDeleteResponse; - export import HealthchecksSinglePage = API.HealthchecksSinglePage; - export import HealthcheckCreateParams = API.HealthcheckCreateParams; - export import HealthcheckUpdateParams = API.HealthcheckUpdateParams; - export import HealthcheckListParams = API.HealthcheckListParams; - export import HealthcheckDeleteParams = API.HealthcheckDeleteParams; - export import HealthcheckEditParams = API.HealthcheckEditParams; - export import HealthcheckGetParams = API.HealthcheckGetParams; export import KeylessCertificates = API.KeylessCertificates; - export import KeylessCertificate = API.KeylessCertificate; - export import KeylessCertificateHostname = API.KeylessCertificateHostname; - export import KeylessCertificateDeleteResponse = API.KeylessCertificateDeleteResponse; - export import KeylessCertificateHostnamesSinglePage = API.KeylessCertificateHostnamesSinglePage; - export import KeylessCertificateCreateParams = API.KeylessCertificateCreateParams; - export import KeylessCertificateListParams = API.KeylessCertificateListParams; - export import KeylessCertificateDeleteParams = API.KeylessCertificateDeleteParams; - export import KeylessCertificateEditParams = API.KeylessCertificateEditParams; - export import KeylessCertificateGetParams = API.KeylessCertificateGetParams; export import Logpush = API.Logpush; export import Logs = API.Logs; export import OriginTLSClientAuth = API.OriginTLSClientAuth; - export import OriginTLSClientCertificateZoneAuthenticatedOriginPull = API.OriginTLSClientCertificateZoneAuthenticatedOriginPull; - export import OriginTLSClientAuthCreateResponse = API.OriginTLSClientAuthCreateResponse; - export import OriginTLSClientAuthListResponse = API.OriginTLSClientAuthListResponse; - export import OriginTLSClientAuthDeleteResponse = API.OriginTLSClientAuthDeleteResponse; - export import OriginTLSClientAuthGetResponse = API.OriginTLSClientAuthGetResponse; - export import OriginTLSClientAuthListResponsesSinglePage = API.OriginTLSClientAuthListResponsesSinglePage; - export import OriginTLSClientAuthCreateParams = API.OriginTLSClientAuthCreateParams; - export import OriginTLSClientAuthListParams = API.OriginTLSClientAuthListParams; - export import OriginTLSClientAuthDeleteParams = API.OriginTLSClientAuthDeleteParams; - export import OriginTLSClientAuthGetParams = API.OriginTLSClientAuthGetParams; export import Pagerules = API.Pagerules; - export import ZonesPagerule = API.ZonesPagerule; - export import PageruleCreateResponse = API.PageruleCreateResponse; - export import PageruleUpdateResponse = API.PageruleUpdateResponse; - export import PageruleListResponse = API.PageruleListResponse; - export import PageruleDeleteResponse = API.PageruleDeleteResponse; - export import PageruleEditResponse = API.PageruleEditResponse; - export import PageruleGetResponse = API.PageruleGetResponse; - export import PageruleCreateParams = API.PageruleCreateParams; - export import PageruleUpdateParams = API.PageruleUpdateParams; - export import PageruleListParams = API.PageruleListParams; - export import PageruleDeleteParams = API.PageruleDeleteParams; - export import PageruleEditParams = API.PageruleEditParams; - export import PageruleGetParams = API.PageruleGetParams; export import RateLimits = API.RateLimits; - export import RateLimit = API.RateLimit; - export import RateLimitCreateResponse = API.RateLimitCreateResponse; - export import RateLimitListResponse = API.RateLimitListResponse; - export import RateLimitDeleteResponse = API.RateLimitDeleteResponse; - export import RateLimitEditResponse = API.RateLimitEditResponse; - export import RateLimitGetResponse = API.RateLimitGetResponse; - export import RateLimitListResponsesV4PagePaginationArray = API.RateLimitListResponsesV4PagePaginationArray; - export import RateLimitCreateParams = API.RateLimitCreateParams; - export import RateLimitListParams = API.RateLimitListParams; - export import RateLimitEditParams = API.RateLimitEditParams; export import SecondaryDNS = API.SecondaryDNS; export import WaitingRooms = API.WaitingRooms; - export import WaitingRoom = API.WaitingRoom; - export import WaitingRoomDeleteResponse = API.WaitingRoomDeleteResponse; - export import WaitingRoomsSinglePage = API.WaitingRoomsSinglePage; - export import WaitingRoomCreateParams = API.WaitingRoomCreateParams; - export import WaitingRoomUpdateParams = API.WaitingRoomUpdateParams; - export import WaitingRoomEditParams = API.WaitingRoomEditParams; export import Web3 = API.Web3; @@ -635,65 +464,24 @@ export namespace Cloudflare { export import DurableObjects = API.DurableObjects; export import Queues = API.Queues; - export import Queue = API.Queue; - export import QueueCreated = API.QueueCreated; - export import QueueUpdated = API.QueueUpdated; - export import QueueCreateResponse = API.QueueCreateResponse; - export import QueueUpdateResponse = API.QueueUpdateResponse; - export import QueueListResponse = API.QueueListResponse; - export import QueueDeleteResponse = API.QueueDeleteResponse; - export import QueueGetResponse = API.QueueGetResponse; - export import QueueListResponsesSinglePage = API.QueueListResponsesSinglePage; - export import QueueCreateParams = API.QueueCreateParams; - export import QueueUpdateParams = API.QueueUpdateParams; - export import QueueListParams = API.QueueListParams; - export import QueueDeleteParams = API.QueueDeleteParams; - export import QueueGetParams = API.QueueGetParams; export import ManagedHeaders = API.ManagedHeaders; - export import ManagedHeaderListResponse = API.ManagedHeaderListResponse; - export import ManagedHeaderEditResponse = API.ManagedHeaderEditResponse; - export import ManagedHeaderListParams = API.ManagedHeaderListParams; - export import ManagedHeaderEditParams = API.ManagedHeaderEditParams; export import PageShield = API.PageShield; - export import PageShieldSetting = API.PageShieldSetting; - export import PageShieldUpdateResponse = API.PageShieldUpdateResponse; - export import PageShieldUpdateParams = API.PageShieldUpdateParams; - export import PageShieldGetParams = API.PageShieldGetParams; export import Rulesets = API.Rulesets; - export import Ruleset = API.Ruleset; - export import RulesetListResponse = API.RulesetListResponse; - export import RulesetListResponsesSinglePage = API.RulesetListResponsesSinglePage; - export import RulesetCreateParams = API.RulesetCreateParams; - export import RulesetUpdateParams = API.RulesetUpdateParams; - export import RulesetListParams = API.RulesetListParams; - export import RulesetDeleteParams = API.RulesetDeleteParams; - export import RulesetGetParams = API.RulesetGetParams; export import URLNormalization = API.URLNormalization; - export import URLNormalizationUpdateResponse = API.URLNormalizationUpdateResponse; - export import URLNormalizationGetResponse = API.URLNormalizationGetResponse; - export import URLNormalizationUpdateParams = API.URLNormalizationUpdateParams; - export import URLNormalizationGetParams = API.URLNormalizationGetParams; export import Spectrum = API.Spectrum; export import Addressing = API.Addressing; export import AuditLogs = API.AuditLogs; - export import AuditLogListResponse = API.AuditLogListResponse; - export import AuditLogListResponsesV4PagePaginationArray = API.AuditLogListResponsesV4PagePaginationArray; - export import AuditLogListParams = API.AuditLogListParams; export import Billing = API.Billing; export import BrandProtection = API.BrandProtection; - export import IntelPhishingURLInfo = API.IntelPhishingURLInfo; - export import IntelPhishingURLSubmit = API.IntelPhishingURLSubmit; - export import BrandProtectionSubmitParams = API.BrandProtectionSubmitParams; - export import BrandProtectionURLInfoParams = API.BrandProtectionURLInfoParams; export import Diagnostics = API.Diagnostics; @@ -706,24 +494,10 @@ export namespace Cloudflare { export import MagicNetworkMonitoring = API.MagicNetworkMonitoring; export import MTLSCertificates = API.MTLSCertificates; - export import MTLSCertificate = API.MTLSCertificate; - export import MTLSCertificateUpdate = API.MTLSCertificateUpdate; - export import MTLSCertificatesSinglePage = API.MTLSCertificatesSinglePage; - export import MTLSCertificateCreateParams = API.MTLSCertificateCreateParams; - export import MTLSCertificateListParams = API.MTLSCertificateListParams; - export import MTLSCertificateDeleteParams = API.MTLSCertificateDeleteParams; - export import MTLSCertificateGetParams = API.MTLSCertificateGetParams; export import Pages = API.Pages; export import PCAPs = API.PCAPs; - export import PCAPCreateResponse = API.PCAPCreateResponse; - export import PCAPListResponse = API.PCAPListResponse; - export import PCAPGetResponse = API.PCAPGetResponse; - export import PCAPListResponsesSinglePage = API.PCAPListResponsesSinglePage; - export import PCAPCreateParams = API.PCAPCreateParams; - export import PCAPListParams = API.PCAPListParams; - export import PCAPGetParams = API.PCAPGetParams; export import Registrar = API.Registrar; @@ -734,33 +508,14 @@ export namespace Cloudflare { export import Storage = API.Storage; export import Stream = API.Stream; - export import StreamVideos = API.StreamVideos; - export import StreamVideosSinglePage = API.StreamVideosSinglePage; - export import StreamCreateParams = API.StreamCreateParams; - export import StreamListParams = API.StreamListParams; - export import StreamDeleteParams = API.StreamDeleteParams; - export import StreamGetParams = API.StreamGetParams; export import Alerting = API.Alerting; - export import D1 = API.D1; + export import D1Resource = API.D1Resource; export import R2 = API.R2; export import WARPConnector = API.WARPConnector; - export import WARPConnectorCreateResponse = API.WARPConnectorCreateResponse; - export import WARPConnectorListResponse = API.WARPConnectorListResponse; - export import WARPConnectorDeleteResponse = API.WARPConnectorDeleteResponse; - export import WARPConnectorEditResponse = API.WARPConnectorEditResponse; - export import WARPConnectorGetResponse = API.WARPConnectorGetResponse; - export import WARPConnectorTokenResponse = API.WARPConnectorTokenResponse; - export import WARPConnectorListResponsesV4PagePaginationArray = API.WARPConnectorListResponsesV4PagePaginationArray; - export import WARPConnectorCreateParams = API.WARPConnectorCreateParams; - export import WARPConnectorListParams = API.WARPConnectorListParams; - export import WARPConnectorDeleteParams = API.WARPConnectorDeleteParams; - export import WARPConnectorEditParams = API.WARPConnectorEditParams; - export import WARPConnectorGetParams = API.WARPConnectorGetParams; - export import WARPConnectorTokenParams = API.WARPConnectorTokenParams; export import WorkersForPlatforms = API.WorkersForPlatforms; @@ -769,61 +524,46 @@ export namespace Cloudflare { export import Challenges = API.Challenges; export import HyperdriveResource = API.HyperdriveResource; - export import Hyperdrive = API.Hyperdrive; export import RUM = API.RUM; export import Vectorize = API.Vectorize; export import URLScanner = API.URLScanner; - export import URLScannerScanResponse = API.URLScannerScanResponse; - export import URLScannerScanParams = API.URLScannerScanParams; export import Radar = API.Radar; export import BotManagement = API.BotManagement; - export import BotManagementUpdateResponse = API.BotManagementUpdateResponse; - export import BotManagementGetResponse = API.BotManagementGetResponse; - export import BotManagementUpdateParams = API.BotManagementUpdateParams; - export import BotManagementGetParams = API.BotManagementGetParams; export import OriginPostQuantumEncryption = API.OriginPostQuantumEncryption; - export import OriginPostQuantumEncryptionUpdateResponse = API.OriginPostQuantumEncryptionUpdateResponse; - export import OriginPostQuantumEncryptionGetResponse = API.OriginPostQuantumEncryptionGetResponse; - export import OriginPostQuantumEncryptionUpdateParams = API.OriginPostQuantumEncryptionUpdateParams; - export import OriginPostQuantumEncryptionGetParams = API.OriginPostQuantumEncryptionGetParams; export import Speed = API.Speed; - export import ObservatorySchedule = API.ObservatorySchedule; - export import ObservatoryTrend = API.ObservatoryTrend; - export import SpeedDeleteResponse = API.SpeedDeleteResponse; - export import SpeedDeleteParams = API.SpeedDeleteParams; - export import SpeedScheduleGetParams = API.SpeedScheduleGetParams; - export import SpeedTrendsListParams = API.SpeedTrendsListParams; export import DCVDelegation = API.DCVDelegation; export import Hostnames = API.Hostnames; export import Snippets = API.Snippets; - export import Snippet = API.Snippet; - export import SnippetDeleteResponse = API.SnippetDeleteResponse; - export import SnippetsSinglePage = API.SnippetsSinglePage; - export import SnippetUpdateParams = API.SnippetUpdateParams; export import Calls = API.Calls; - export import CallsApp = API.CallsApp; - export import CallsAppWithSecret = API.CallsAppWithSecret; - export import CallsAppsSinglePage = API.CallsAppsSinglePage; - export import CallCreateParams = API.CallCreateParams; - export import CallUpdateParams = API.CallUpdateParams; - export import CallListParams = API.CallListParams; - export import CallDeleteParams = API.CallDeleteParams; - export import CallGetParams = API.CallGetParams; export import CloudforceOne = API.CloudforceOne; + export import EventNotifications = API.EventNotifications; + + export import ASN = API.ASN; + export import AuditLog = API.AuditLog; + export import CloudflareTunnel = API.CloudflareTunnel; export import ErrorData = API.ErrorData; + export import Identifier = API.Identifier; + export import LoadBalancerPreview = API.LoadBalancerPreview; + export import Member = API.Member; + export import PaginationInfo = API.PaginationInfo; + export import Permission = API.Permission; + export import PermissionGrant = API.PermissionGrant; + export import ResponseInfo = API.ResponseInfo; + export import Result = API.Result; + export import Role = API.Role; } export default Cloudflare; diff --git a/src/resources/accounts/accounts.ts b/src/resources/accounts/accounts.ts index 9f306332af..be8c86be2e 100644 --- a/src/resources/accounts/accounts.ts +++ b/src/resources/accounts/accounts.ts @@ -3,7 +3,6 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import { isRequestOptions } from 'cloudflare/core'; -import * as AccountsAPI from 'cloudflare/resources/accounts/accounts'; import * as MembersAPI from 'cloudflare/resources/accounts/members'; import * as RolesAPI from 'cloudflare/resources/accounts/roles'; import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination'; @@ -180,6 +179,11 @@ export interface AccountListParams extends V4PagePaginationArrayParams { * Direction to order results. */ direction?: 'asc' | 'desc'; + + /** + * Name of the account. + */ + name?: string; } export interface AccountGetParams { @@ -187,17 +191,8 @@ export interface AccountGetParams { } export namespace Accounts { - export import Account = AccountsAPI.Account; - export import AccountUpdateResponse = AccountsAPI.AccountUpdateResponse; - export import AccountListResponse = AccountsAPI.AccountListResponse; - export import AccountGetResponse = AccountsAPI.AccountGetResponse; - export import AccountListResponsesV4PagePaginationArray = AccountsAPI.AccountListResponsesV4PagePaginationArray; - export import AccountUpdateParams = AccountsAPI.AccountUpdateParams; - export import AccountListParams = AccountsAPI.AccountListParams; - export import AccountGetParams = AccountsAPI.AccountGetParams; export import Members = MembersAPI.Members; - export import AccountMember = MembersAPI.AccountMember; - export import AccountMemberWithID = MembersAPI.AccountMemberWithID; + export import UserWithInviteCode = MembersAPI.UserWithInviteCode; export import MemberListResponse = MembersAPI.MemberListResponse; export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse; export import MemberListResponsesV4PagePaginationArray = MembersAPI.MemberListResponsesV4PagePaginationArray; @@ -207,9 +202,7 @@ export namespace Accounts { export import MemberDeleteParams = MembersAPI.MemberDeleteParams; export import MemberGetParams = MembersAPI.MemberGetParams; export import Roles = RolesAPI.Roles; - export import Role = RolesAPI.Role; export import RoleGetResponse = RolesAPI.RoleGetResponse; - export import RolesSinglePage = RolesAPI.RolesSinglePage; export import RoleListParams = RolesAPI.RoleListParams; export import RoleGetParams = RolesAPI.RoleGetParams; } diff --git a/src/resources/accounts/index.ts b/src/resources/accounts/index.ts index b772caabe8..0819851b47 100644 --- a/src/resources/accounts/index.ts +++ b/src/resources/accounts/index.ts @@ -1,19 +1,9 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +export { Accounts } from './accounts'; +export { RoleGetResponse, RoleListParams, RoleGetParams, Roles } from './roles'; export { - Account, - AccountUpdateResponse, - AccountListResponse, - AccountGetResponse, - AccountUpdateParams, - AccountListParams, - AccountGetParams, - AccountListResponsesV4PagePaginationArray, - Accounts, -} from './accounts'; -export { - AccountMember, - AccountMemberWithID, + UserWithInviteCode, MemberListResponse, MemberDeleteResponse, MemberCreateParams, @@ -24,4 +14,3 @@ export { MemberListResponsesV4PagePaginationArray, Members, } from './members'; -export { Role, RoleGetResponse, RoleListParams, RoleGetParams, RolesSinglePage, Roles } from './roles'; diff --git a/src/resources/accounts/members.ts b/src/resources/accounts/members.ts index 88aa8c2203..d4c2a857dd 100644 --- a/src/resources/accounts/members.ts +++ b/src/resources/accounts/members.ts @@ -3,18 +3,18 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as MembersAPI from 'cloudflare/resources/accounts/members'; -import * as RolesAPI from 'cloudflare/resources/accounts/roles'; +import * as Shared from 'cloudflare/resources/shared'; import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination'; export class Members extends APIResource { /** * Add a user to the list of members for this account. */ - create(params: MemberCreateParams, options?: Core.RequestOptions): Core.APIPromise { + create(params: MemberCreateParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/members`, { body, ...options }) as Core.APIPromise<{ - result: AccountMemberWithID; + result: UserWithInviteCode; }> )._thenUnwrap((obj) => obj.result); } @@ -26,13 +26,13 @@ export class Members extends APIResource { memberId: string, params: MemberUpdateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.put(`/accounts/${account_id}/members/${memberId}`, { body, ...options, - }) as Core.APIPromise<{ result: AccountMember }> + }) as Core.APIPromise<{ result: Shared.Member }> )._thenUnwrap((obj) => obj.result); } @@ -59,11 +59,12 @@ export class Members extends APIResource { params: MemberDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( - this._client.delete(`/accounts/${account_id}/members/${memberId}`, options) as Core.APIPromise<{ - result: MemberDeleteResponse | null; - }> + this._client.delete(`/accounts/${account_id}/members/${memberId}`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: MemberDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } @@ -74,11 +75,11 @@ export class Members extends APIResource { memberId: string, params: MemberGetParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id } = params; return ( this._client.get(`/accounts/${account_id}/members/${memberId}`, options) as Core.APIPromise<{ - result: AccountMember; + result: Shared.Member; }> )._thenUnwrap((obj) => obj.result); } @@ -86,7 +87,7 @@ export class Members extends APIResource { export class MemberListResponsesV4PagePaginationArray extends V4PagePaginationArray {} -export interface AccountMember { +export interface UserWithInviteCode { /** * Membership identifier tag. */ @@ -95,178 +96,11 @@ export interface AccountMember { /** * Roles assigned to this member. */ - roles: Array; + roles: Array; status: unknown; - user: AccountMember.User; -} - -export namespace AccountMember { - export interface Role { - /** - * Role identifier tag. - */ - id: string; - - /** - * Description of role's permissions. - */ - description: string; - - /** - * Role name. - */ - name: string; - - permissions: Role.Permissions; - } - - export namespace Role { - export interface Permissions { - analytics?: Permissions.Analytics; - - billing?: Permissions.Billing; - - cache_purge?: Permissions.CachePurge; - - dns?: Permissions.DNS; - - dns_records?: Permissions.DNSRecords; - - lb?: Permissions.Lb; - - logs?: Permissions.Logs; - - organization?: Permissions.Organization; - - ssl?: Permissions.SSL; - - waf?: Permissions.WAF; - - zone_settings?: Permissions.ZoneSettings; - - zones?: Permissions.Zones; - } - - export namespace Permissions { - export interface Analytics { - read?: boolean; - - write?: boolean; - } - - export interface Billing { - read?: boolean; - - write?: boolean; - } - - export interface CachePurge { - read?: boolean; - - write?: boolean; - } - - export interface DNS { - read?: boolean; - - write?: boolean; - } - - export interface DNSRecords { - read?: boolean; - - write?: boolean; - } - - export interface Lb { - read?: boolean; - - write?: boolean; - } - - export interface Logs { - read?: boolean; - - write?: boolean; - } - - export interface Organization { - read?: boolean; - - write?: boolean; - } - - export interface SSL { - read?: boolean; - - write?: boolean; - } - - export interface WAF { - read?: boolean; - - write?: boolean; - } - - export interface ZoneSettings { - read?: boolean; - - write?: boolean; - } - - export interface Zones { - read?: boolean; - - write?: boolean; - } - } - } - - export interface User { - /** - * The contact email address of the user. - */ - email: string; - - /** - * Identifier - */ - id?: string; - - /** - * User's first name - */ - first_name?: string | null; - - /** - * User's last name - */ - last_name?: string | null; - - /** - * Indicates whether two-factor authentication is enabled for the user account. - * Does not apply to API authentication. - */ - two_factor_authentication_enabled?: boolean; - } -} - -export interface AccountMemberWithID { - /** - * Membership identifier tag. - */ - id: string; - - /** - * Roles assigned to this member. - */ - roles: Array; - - status: unknown; - - user: AccountMemberWithID.User; + user: UserWithInviteCode.User; /** * The unique activation code for the account membership. @@ -274,7 +108,7 @@ export interface AccountMemberWithID { code?: string; } -export namespace AccountMemberWithID { +export namespace UserWithInviteCode { export interface Role { /** * Role identifier tag. @@ -296,103 +130,29 @@ export namespace AccountMemberWithID { export namespace Role { export interface Permissions { - analytics?: Permissions.Analytics; - - billing?: Permissions.Billing; - - cache_purge?: Permissions.CachePurge; - - dns?: Permissions.DNS; - - dns_records?: Permissions.DNSRecords; - - lb?: Permissions.Lb; - - logs?: Permissions.Logs; - - organization?: Permissions.Organization; - - ssl?: Permissions.SSL; - - waf?: Permissions.WAF; - - zone_settings?: Permissions.ZoneSettings; - - zones?: Permissions.Zones; - } - - export namespace Permissions { - export interface Analytics { - read?: boolean; - - write?: boolean; - } - - export interface Billing { - read?: boolean; + analytics?: Shared.PermissionGrant; - write?: boolean; - } + billing?: Shared.PermissionGrant; - export interface CachePurge { - read?: boolean; + cache_purge?: Shared.PermissionGrant; - write?: boolean; - } + dns?: Shared.PermissionGrant; - export interface DNS { - read?: boolean; + dns_records?: Shared.PermissionGrant; - write?: boolean; - } + lb?: Shared.PermissionGrant; - export interface DNSRecords { - read?: boolean; + logs?: Shared.PermissionGrant; - write?: boolean; - } + organization?: Shared.PermissionGrant; - export interface Lb { - read?: boolean; + ssl?: Shared.PermissionGrant; - write?: boolean; - } + waf?: Shared.PermissionGrant; - export interface Logs { - read?: boolean; + zone_settings?: Shared.PermissionGrant; - write?: boolean; - } - - export interface Organization { - read?: boolean; - - write?: boolean; - } - - export interface SSL { - read?: boolean; - - write?: boolean; - } - - export interface WAF { - read?: boolean; - - write?: boolean; - } - - export interface ZoneSettings { - read?: boolean; - - write?: boolean; - } - - export interface Zones { - read?: boolean; - - write?: boolean; - } + zones?: Shared.PermissionGrant; } } @@ -444,7 +204,7 @@ export interface MemberListResponse { /** * Roles assigned to this Member. */ - roles: Array; + roles: Array; /** * A member's status in the organization. @@ -525,7 +285,15 @@ export interface MemberListParams extends V4PagePaginationArrayParams { } export interface MemberDeleteParams { + /** + * Path param: + */ account_id: unknown; + + /** + * Body param: + */ + body: unknown; } export interface MemberGetParams { @@ -533,8 +301,7 @@ export interface MemberGetParams { } export namespace Members { - export import AccountMember = MembersAPI.AccountMember; - export import AccountMemberWithID = MembersAPI.AccountMemberWithID; + export import UserWithInviteCode = MembersAPI.UserWithInviteCode; export import MemberListResponse = MembersAPI.MemberListResponse; export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse; export import MemberListResponsesV4PagePaginationArray = MembersAPI.MemberListResponsesV4PagePaginationArray; diff --git a/src/resources/accounts/roles.ts b/src/resources/accounts/roles.ts index fbc7ce426a..b50ef48d8a 100644 --- a/src/resources/accounts/roles.ts +++ b/src/resources/accounts/roles.ts @@ -3,13 +3,17 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as RolesAPI from 'cloudflare/resources/accounts/roles'; -import { SinglePage } from 'cloudflare/pagination'; +import * as Shared from 'cloudflare/resources/shared'; +import { RolesSinglePage } from 'cloudflare/resources/shared'; export class Roles extends APIResource { /** * Get all available roles for an account. */ - list(params: RoleListParams, options?: Core.RequestOptions): Core.PagePromise { + list( + params: RoleListParams, + options?: Core.RequestOptions, + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList(`/accounts/${account_id}/roles`, RolesSinglePage, options); } @@ -31,30 +35,6 @@ export class Roles extends APIResource { } } -export class RolesSinglePage extends SinglePage {} - -export interface Role { - /** - * Role identifier tag. - */ - id: string; - - /** - * Description of role's permissions. - */ - description: string; - - /** - * Role Name. - */ - name: string; - - /** - * Access permissions for this User. - */ - permissions: Array; -} - export type RoleGetResponse = unknown | string | null; export interface RoleListParams { @@ -66,9 +46,9 @@ export interface RoleGetParams { } export namespace Roles { - export import Role = RolesAPI.Role; export import RoleGetResponse = RolesAPI.RoleGetResponse; - export import RolesSinglePage = RolesAPI.RolesSinglePage; export import RoleListParams = RolesAPI.RoleListParams; export import RoleGetParams = RolesAPI.RoleGetParams; } + +export { RolesSinglePage }; diff --git a/src/resources/addressing/address-maps/accounts.ts b/src/resources/addressing/address-maps/accounts.ts index 6179d715cb..484e26530b 100644 --- a/src/resources/addressing/address-maps/accounts.ts +++ b/src/resources/addressing/address-maps/accounts.ts @@ -13,11 +13,11 @@ export class Accounts extends APIResource { params: AccountUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( this._client.put( `/accounts/${account_id}/addressing/address_maps/${addressMapId}/accounts/${account_id}`, - options, + { body: body, ...options }, ) as Core.APIPromise<{ result: AccountUpdateResponse | null }> )._thenUnwrap((obj) => obj.result); } @@ -30,32 +30,42 @@ export class Accounts extends APIResource { params: AccountDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( this._client.delete( `/accounts/${account_id}/addressing/address_maps/${addressMapId}/accounts/${account_id}`, - options, + { body: body, ...options }, ) as Core.APIPromise<{ result: AccountDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } } -export type AccountUpdateResponse = unknown | Array | string; +export type AccountUpdateResponse = Array; -export type AccountDeleteResponse = unknown | Array | string; +export type AccountDeleteResponse = Array; export interface AccountUpdateParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export interface AccountDeleteParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export namespace Accounts { diff --git a/src/resources/addressing/address-maps/address-maps.ts b/src/resources/addressing/address-maps/address-maps.ts index 92e17fffb6..923c0b426f 100644 --- a/src/resources/addressing/address-maps/address-maps.ts +++ b/src/resources/addressing/address-maps/address-maps.ts @@ -35,11 +35,11 @@ export class AddressMaps extends APIResource { list( params: AddressMapListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/addressing/address_maps`, - AddressingAddressMapsSinglePage, + AddressMapsSinglePage, options, ); } @@ -53,12 +53,12 @@ export class AddressMaps extends APIResource { params: AddressMapDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( - this._client.delete( - `/accounts/${account_id}/addressing/address_maps/${addressMapId}`, - options, - ) as Core.APIPromise<{ result: AddressMapDeleteResponse | null }> + this._client.delete(`/accounts/${account_id}/addressing/address_maps/${addressMapId}`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: AddressMapDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } @@ -69,13 +69,13 @@ export class AddressMaps extends APIResource { addressMapId: string, params: AddressMapEditParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.patch(`/accounts/${account_id}/addressing/address_maps/${addressMapId}`, { body, ...options, - }) as Core.APIPromise<{ result: AddressingAddressMaps }> + }) as Core.APIPromise<{ result: AddressMap }> )._thenUnwrap((obj) => obj.result); } @@ -97,9 +97,9 @@ export class AddressMaps extends APIResource { } } -export class AddressingAddressMapsSinglePage extends SinglePage {} +export class AddressMapsSinglePage extends SinglePage {} -export interface AddressingAddressMaps { +export interface AddressMap { /** * Identifier */ @@ -228,7 +228,7 @@ export namespace AddressMapCreateResponse { } } -export type AddressMapDeleteResponse = unknown | Array | string; +export type AddressMapDeleteResponse = Array; export interface AddressMapGetResponse { /** @@ -343,9 +343,14 @@ export interface AddressMapListParams { export interface AddressMapDeleteParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export interface AddressMapEditParams { @@ -384,11 +389,11 @@ export interface AddressMapGetParams { } export namespace AddressMaps { - export import AddressingAddressMaps = AddressMapsAPI.AddressingAddressMaps; + export import AddressMap = AddressMapsAPI.AddressMap; export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse; export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse; export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse; - export import AddressingAddressMapsSinglePage = AddressMapsAPI.AddressingAddressMapsSinglePage; + export import AddressMapsSinglePage = AddressMapsAPI.AddressMapsSinglePage; export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams; export import AddressMapListParams = AddressMapsAPI.AddressMapListParams; export import AddressMapDeleteParams = AddressMapsAPI.AddressMapDeleteParams; diff --git a/src/resources/addressing/address-maps/index.ts b/src/resources/addressing/address-maps/index.ts index e905034c8c..5abfaf9237 100644 --- a/src/resources/addressing/address-maps/index.ts +++ b/src/resources/addressing/address-maps/index.ts @@ -8,7 +8,7 @@ export { Accounts, } from './accounts'; export { - AddressingAddressMaps, + AddressMap, AddressMapCreateResponse, AddressMapDeleteResponse, AddressMapGetResponse, @@ -17,7 +17,7 @@ export { AddressMapDeleteParams, AddressMapEditParams, AddressMapGetParams, - AddressingAddressMapsSinglePage, + AddressMapsSinglePage, AddressMaps, } from './address-maps'; export { IPUpdateResponse, IPDeleteResponse, IPUpdateParams, IPDeleteParams, IPs } from './ips'; diff --git a/src/resources/addressing/address-maps/ips.ts b/src/resources/addressing/address-maps/ips.ts index c34579275b..3ef96f0e7e 100644 --- a/src/resources/addressing/address-maps/ips.ts +++ b/src/resources/addressing/address-maps/ips.ts @@ -14,12 +14,12 @@ export class IPs extends APIResource { params: IPUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( - this._client.put( - `/accounts/${account_id}/addressing/address_maps/${addressMapId}/ips/${ipAddress}`, - options, - ) as Core.APIPromise<{ result: IPUpdateResponse | null }> + this._client.put(`/accounts/${account_id}/addressing/address_maps/${addressMapId}/ips/${ipAddress}`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: IPUpdateResponse | null }> )._thenUnwrap((obj) => obj.result); } @@ -32,32 +32,42 @@ export class IPs extends APIResource { params: IPDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( this._client.delete( `/accounts/${account_id}/addressing/address_maps/${addressMapId}/ips/${ipAddress}`, - options, + { body: body, ...options }, ) as Core.APIPromise<{ result: IPDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } } -export type IPUpdateResponse = unknown | Array | string; +export type IPUpdateResponse = Array; -export type IPDeleteResponse = unknown | Array | string; +export type IPDeleteResponse = Array; export interface IPUpdateParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export interface IPDeleteParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export namespace IPs { diff --git a/src/resources/addressing/address-maps/zones.ts b/src/resources/addressing/address-maps/zones.ts index 29fe81a3bc..877421bd34 100644 --- a/src/resources/addressing/address-maps/zones.ts +++ b/src/resources/addressing/address-maps/zones.ts @@ -2,7 +2,6 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import { CloudflareError } from 'cloudflare/error'; import * as ZonesAPI from 'cloudflare/resources/addressing/address-maps/zones'; export class Zones extends APIResource { @@ -14,28 +13,12 @@ export class Zones extends APIResource { params: ZoneUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { zone_id, account_id } = params; - if (!account_id && !zone_id) { - throw new CloudflareError('You must provide either account_id or zone_id.'); - } - if (account_id && zone_id) { - throw new CloudflareError('You cannot provide both account_id and zone_id.'); - } - const { accountOrZone, accountOrZoneId } = - account_id ? - { - accountOrZone: 'accounts', - accountOrZoneId: account_id, - } - : { - accountOrZone: 'zones', - accountOrZoneId: zone_id, - }; + const { zone_id, account_id, body } = params; return ( - this._client.put( - `/accounts/${accountOrZone}/addressing/address_maps/${addressMapId}/zones/${accountOrZoneId}`, - options, - ) as Core.APIPromise<{ result: ZoneUpdateResponse | null }> + this._client.put(`/accounts/${account_id}/addressing/address_maps/${addressMapId}/zones/${zone_id}`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: ZoneUpdateResponse | null }> )._thenUnwrap((obj) => obj.result); } @@ -47,58 +30,52 @@ export class Zones extends APIResource { params: ZoneDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { zone_id, account_id } = params; - if (!account_id && !zone_id) { - throw new CloudflareError('You must provide either account_id or zone_id.'); - } - if (account_id && zone_id) { - throw new CloudflareError('You cannot provide both account_id and zone_id.'); - } - const { accountOrZone, accountOrZoneId } = - account_id ? - { - accountOrZone: 'accounts', - accountOrZoneId: account_id, - } - : { - accountOrZone: 'zones', - accountOrZoneId: zone_id, - }; + const { zone_id, account_id, body } = params; return ( this._client.delete( - `/accounts/${accountOrZone}/addressing/address_maps/${addressMapId}/zones/${accountOrZoneId}`, - options, + `/accounts/${account_id}/addressing/address_maps/${addressMapId}/zones/${zone_id}`, + { body: body, ...options }, ) as Core.APIPromise<{ result: ZoneDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } } -export type ZoneUpdateResponse = unknown | Array | string; +export type ZoneUpdateResponse = Array; -export type ZoneDeleteResponse = unknown | Array | string; +export type ZoneDeleteResponse = Array; export interface ZoneUpdateParams { /** - * Identifier + * Path param: Identifier */ zone_id: string; /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export interface ZoneDeleteParams { /** - * Identifier + * Path param: Identifier */ zone_id: string; /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export namespace Zones { diff --git a/src/resources/addressing/addressing.ts b/src/resources/addressing/addressing.ts index d36f90bf85..eb8618d778 100644 --- a/src/resources/addressing/addressing.ts +++ b/src/resources/addressing/addressing.ts @@ -19,11 +19,11 @@ export namespace Addressing { export import ServiceListResponsesSinglePage = ServicesAPI.ServiceListResponsesSinglePage; export import ServiceListParams = ServicesAPI.ServiceListParams; export import AddressMaps = AddressMapsAPI.AddressMaps; - export import AddressingAddressMaps = AddressMapsAPI.AddressingAddressMaps; + export import AddressMap = AddressMapsAPI.AddressMap; export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse; export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse; export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse; - export import AddressingAddressMapsSinglePage = AddressMapsAPI.AddressingAddressMapsSinglePage; + export import AddressMapsSinglePage = AddressMapsAPI.AddressMapsSinglePage; export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams; export import AddressMapListParams = AddressMapsAPI.AddressMapListParams; export import AddressMapDeleteParams = AddressMapsAPI.AddressMapDeleteParams; @@ -33,9 +33,9 @@ export namespace Addressing { export import LOADocumentCreateResponse = LOADocumentsAPI.LOADocumentCreateResponse; export import LOADocumentCreateParams = LOADocumentsAPI.LOADocumentCreateParams; export import Prefixes = PrefixesAPI.Prefixes; - export import AddressingIpamPrefixes = PrefixesAPI.AddressingIpamPrefixes; + export import Prefix = PrefixesAPI.Prefix; export import PrefixDeleteResponse = PrefixesAPI.PrefixDeleteResponse; - export import AddressingIpamPrefixesSinglePage = PrefixesAPI.AddressingIpamPrefixesSinglePage; + export import PrefixesSinglePage = PrefixesAPI.PrefixesSinglePage; export import PrefixCreateParams = PrefixesAPI.PrefixCreateParams; export import PrefixListParams = PrefixesAPI.PrefixListParams; export import PrefixDeleteParams = PrefixesAPI.PrefixDeleteParams; diff --git a/src/resources/addressing/index.ts b/src/resources/addressing/index.ts index ee6f12c34f..156b49e1ef 100644 --- a/src/resources/addressing/index.ts +++ b/src/resources/addressing/index.ts @@ -1,8 +1,7 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Addressing } from './addressing'; export { - AddressingAddressMaps, + AddressMap, AddressMapCreateResponse, AddressMapDeleteResponse, AddressMapGetResponse, @@ -11,19 +10,20 @@ export { AddressMapDeleteParams, AddressMapEditParams, AddressMapGetParams, - AddressingAddressMapsSinglePage, + AddressMapsSinglePage, AddressMaps, } from './address-maps/index'; +export { Addressing } from './addressing'; +export { LOADocumentCreateResponse, LOADocumentCreateParams, LOADocuments } from './loa-documents/index'; export { - AddressingIpamPrefixes, + Prefix, PrefixDeleteResponse, PrefixCreateParams, PrefixListParams, PrefixDeleteParams, PrefixEditParams, PrefixGetParams, - AddressingIpamPrefixesSinglePage, + PrefixesSinglePage, Prefixes, } from './prefixes/index'; -export { LOADocumentCreateResponse, LOADocumentCreateParams, LOADocuments } from './loa-documents/index'; export { ServiceListResponse, ServiceListParams, ServiceListResponsesSinglePage, Services } from './services'; diff --git a/src/resources/addressing/prefixes/bgp/bgp.ts b/src/resources/addressing/prefixes/bgp/bgp.ts index 5e03d7403a..a9f9a065e5 100644 --- a/src/resources/addressing/prefixes/bgp/bgp.ts +++ b/src/resources/addressing/prefixes/bgp/bgp.ts @@ -13,16 +13,16 @@ export class BGP extends APIResource { export namespace BGP { export import Bindings = BindingsAPI.Bindings; - export import AddressingServiceBinding = BindingsAPI.AddressingServiceBinding; + export import ServiceBinding = BindingsAPI.ServiceBinding; export import BindingDeleteResponse = BindingsAPI.BindingDeleteResponse; - export import AddressingServiceBindingsSinglePage = BindingsAPI.AddressingServiceBindingsSinglePage; + export import ServiceBindingsSinglePage = BindingsAPI.ServiceBindingsSinglePage; export import BindingCreateParams = BindingsAPI.BindingCreateParams; export import BindingListParams = BindingsAPI.BindingListParams; export import BindingDeleteParams = BindingsAPI.BindingDeleteParams; export import BindingGetParams = BindingsAPI.BindingGetParams; export import Prefixes = PrefixesAPI.Prefixes; - export import AddressingIpamBGPPrefixes = PrefixesAPI.AddressingIpamBGPPrefixes; - export import AddressingIpamBGPPrefixesSinglePage = PrefixesAPI.AddressingIpamBGPPrefixesSinglePage; + export import BGPPrefix = PrefixesAPI.BGPPrefix; + export import BGPPrefixesSinglePage = PrefixesAPI.BGPPrefixesSinglePage; export import PrefixListParams = PrefixesAPI.PrefixListParams; export import PrefixEditParams = PrefixesAPI.PrefixEditParams; export import PrefixGetParams = PrefixesAPI.PrefixGetParams; diff --git a/src/resources/addressing/prefixes/bgp/bindings.ts b/src/resources/addressing/prefixes/bgp/bindings.ts index fa37a8914d..41a3181938 100644 --- a/src/resources/addressing/prefixes/bgp/bindings.ts +++ b/src/resources/addressing/prefixes/bgp/bindings.ts @@ -3,6 +3,7 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as BindingsAPI from 'cloudflare/resources/addressing/prefixes/bgp/bindings'; +import * as Shared from 'cloudflare/resources/shared'; import { SinglePage } from 'cloudflare/pagination'; export class Bindings extends APIResource { @@ -16,13 +17,13 @@ export class Bindings extends APIResource { prefixId: string, params: BindingCreateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings`, { body, ...options, - }) as Core.APIPromise<{ result: AddressingServiceBinding }> + }) as Core.APIPromise<{ result: ServiceBinding }> )._thenUnwrap((obj) => obj.result); } @@ -38,11 +39,11 @@ export class Bindings extends APIResource { prefixId: string, params: BindingListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings`, - AddressingServiceBindingsSinglePage, + ServiceBindingsSinglePage, options, ); } @@ -57,12 +58,10 @@ export class Bindings extends APIResource { options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; - return ( - this._client.delete( - `/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings/${bindingId}`, - options, - ) as Core.APIPromise<{ result: BindingDeleteResponse }> - )._thenUnwrap((obj) => obj.result); + return this._client.delete( + `/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings/${bindingId}`, + options, + ); } /** @@ -73,20 +72,20 @@ export class Bindings extends APIResource { bindingId: string, params: BindingGetParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/addressing/prefixes/${prefixId}/bindings/${bindingId}`, options, - ) as Core.APIPromise<{ result: AddressingServiceBinding }> + ) as Core.APIPromise<{ result: ServiceBinding }> )._thenUnwrap((obj) => obj.result); } } -export class AddressingServiceBindingsSinglePage extends SinglePage {} +export class ServiceBindingsSinglePage extends SinglePage {} -export interface AddressingServiceBinding { +export interface ServiceBinding { /** * Identifier */ @@ -100,7 +99,7 @@ export interface AddressingServiceBinding { /** * Status of a Service Binding's deployment to the Cloudflare network */ - provisioning?: AddressingServiceBinding.Provisioning; + provisioning?: ServiceBinding.Provisioning; /** * Identifier @@ -113,7 +112,7 @@ export interface AddressingServiceBinding { service_name?: string; } -export namespace AddressingServiceBinding { +export namespace ServiceBinding { /** * Status of a Service Binding's deployment to the Cloudflare network */ @@ -126,7 +125,16 @@ export namespace AddressingServiceBinding { } } -export type BindingDeleteResponse = unknown | Array | string; +export interface BindingDeleteResponse { + errors: Array; + + messages: Array; + + /** + * Whether the API call was successful + */ + success: true; +} export interface BindingCreateParams { /** @@ -167,9 +175,9 @@ export interface BindingGetParams { } export namespace Bindings { - export import AddressingServiceBinding = BindingsAPI.AddressingServiceBinding; + export import ServiceBinding = BindingsAPI.ServiceBinding; export import BindingDeleteResponse = BindingsAPI.BindingDeleteResponse; - export import AddressingServiceBindingsSinglePage = BindingsAPI.AddressingServiceBindingsSinglePage; + export import ServiceBindingsSinglePage = BindingsAPI.ServiceBindingsSinglePage; export import BindingCreateParams = BindingsAPI.BindingCreateParams; export import BindingListParams = BindingsAPI.BindingListParams; export import BindingDeleteParams = BindingsAPI.BindingDeleteParams; diff --git a/src/resources/addressing/prefixes/bgp/index.ts b/src/resources/addressing/prefixes/bgp/index.ts index 781dae4dad..2ac5233947 100644 --- a/src/resources/addressing/prefixes/bgp/index.ts +++ b/src/resources/addressing/prefixes/bgp/index.ts @@ -1,24 +1,24 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +export { BGP } from './bgp'; export { - AddressingIpamBGPPrefixes, + BGPPrefix, PrefixListParams, PrefixEditParams, PrefixGetParams, - AddressingIpamBGPPrefixesSinglePage, + BGPPrefixesSinglePage, Prefixes, } from './prefixes'; export { - AddressingServiceBinding, + ServiceBinding, BindingDeleteResponse, BindingCreateParams, BindingListParams, BindingDeleteParams, BindingGetParams, - AddressingServiceBindingsSinglePage, + ServiceBindingsSinglePage, Bindings, } from './bindings'; -export { BGP } from './bgp'; export { StatusEditResponse, StatusGetResponse, diff --git a/src/resources/addressing/prefixes/bgp/prefixes.ts b/src/resources/addressing/prefixes/bgp/prefixes.ts index 26bcd70df2..f08fed9587 100644 --- a/src/resources/addressing/prefixes/bgp/prefixes.ts +++ b/src/resources/addressing/prefixes/bgp/prefixes.ts @@ -16,11 +16,11 @@ export class Prefixes extends APIResource { prefixId: string, params: PrefixListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/addressing/prefixes/${prefixId}/bgp/prefixes`, - AddressingIpamBGPPrefixesSinglePage, + BGPPrefixesSinglePage, options, ); } @@ -34,13 +34,13 @@ export class Prefixes extends APIResource { bgpPrefixId: string, params: PrefixEditParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.patch( `/accounts/${account_id}/addressing/prefixes/${prefixId}/bgp/prefixes/${bgpPrefixId}`, { body, ...options }, - ) as Core.APIPromise<{ result: AddressingIpamBGPPrefixes }> + ) as Core.APIPromise<{ result: BGPPrefix }> )._thenUnwrap((obj) => obj.result); } @@ -52,20 +52,20 @@ export class Prefixes extends APIResource { bgpPrefixId: string, params: PrefixGetParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/addressing/prefixes/${prefixId}/bgp/prefixes/${bgpPrefixId}`, options, - ) as Core.APIPromise<{ result: AddressingIpamBGPPrefixes }> + ) as Core.APIPromise<{ result: BGPPrefix }> )._thenUnwrap((obj) => obj.result); } } -export class AddressingIpamBGPPrefixesSinglePage extends SinglePage {} +export class BGPPrefixesSinglePage extends SinglePage {} -export interface AddressingIpamBGPPrefixes { +export interface BGPPrefix { /** * Identifier */ @@ -76,7 +76,7 @@ export interface AddressingIpamBGPPrefixes { */ asn?: number | null; - bgp_signal_opts?: AddressingIpamBGPPrefixes.BGPSignalOpts; + bgp_signal_opts?: BGPPrefix.BGPSignalOpts; /** * IP Prefix in Classless Inter-Domain Routing format. @@ -87,10 +87,10 @@ export interface AddressingIpamBGPPrefixes { modified_at?: string; - on_demand?: AddressingIpamBGPPrefixes.OnDemand; + on_demand?: BGPPrefix.OnDemand; } -export namespace AddressingIpamBGPPrefixes { +export namespace BGPPrefix { export interface BGPSignalOpts { /** * Whether control of advertisement of the prefix to the Internet is enabled to be @@ -165,8 +165,8 @@ export interface PrefixGetParams { } export namespace Prefixes { - export import AddressingIpamBGPPrefixes = PrefixesAPI.AddressingIpamBGPPrefixes; - export import AddressingIpamBGPPrefixesSinglePage = PrefixesAPI.AddressingIpamBGPPrefixesSinglePage; + export import BGPPrefix = PrefixesAPI.BGPPrefix; + export import BGPPrefixesSinglePage = PrefixesAPI.BGPPrefixesSinglePage; export import PrefixListParams = PrefixesAPI.PrefixListParams; export import PrefixEditParams = PrefixesAPI.PrefixEditParams; export import PrefixGetParams = PrefixesAPI.PrefixGetParams; diff --git a/src/resources/addressing/prefixes/delegations.ts b/src/resources/addressing/prefixes/delegations.ts index 2ec33b3263..ebccd55199 100644 --- a/src/resources/addressing/prefixes/delegations.ts +++ b/src/resources/addressing/prefixes/delegations.ts @@ -13,13 +13,13 @@ export class Delegations extends APIResource { prefixId: string, params: DelegationCreateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/addressing/prefixes/${prefixId}/delegations`, { body, ...options, - }) as Core.APIPromise<{ result: AddressingIpamDelegations }> + }) as Core.APIPromise<{ result: Delegations }> )._thenUnwrap((obj) => obj.result); } @@ -30,11 +30,11 @@ export class Delegations extends APIResource { prefixId: string, params: DelegationListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/addressing/prefixes/${prefixId}/delegations`, - AddressingIpamDelegationsSinglePage, + DelegationsSinglePage, options, ); } @@ -48,19 +48,19 @@ export class Delegations extends APIResource { params: DelegationDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( this._client.delete( `/accounts/${account_id}/addressing/prefixes/${prefixId}/delegations/${delegationId}`, - options, + { body: body, ...options }, ) as Core.APIPromise<{ result: DelegationDeleteResponse }> )._thenUnwrap((obj) => obj.result); } } -export class AddressingIpamDelegationsSinglePage extends SinglePage {} +export class DelegationsSinglePage extends SinglePage {} -export interface AddressingIpamDelegations { +export interface Delegations { /** * Delegation identifier tag. */ @@ -120,15 +120,20 @@ export interface DelegationListParams { export interface DelegationDeleteParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export namespace Delegations { - export import AddressingIpamDelegations = DelegationsAPI.AddressingIpamDelegations; + export import Delegations = DelegationsAPI.Delegations; export import DelegationDeleteResponse = DelegationsAPI.DelegationDeleteResponse; - export import AddressingIpamDelegationsSinglePage = DelegationsAPI.AddressingIpamDelegationsSinglePage; + export import DelegationsSinglePage = DelegationsAPI.DelegationsSinglePage; export import DelegationCreateParams = DelegationsAPI.DelegationCreateParams; export import DelegationListParams = DelegationsAPI.DelegationListParams; export import DelegationDeleteParams = DelegationsAPI.DelegationDeleteParams; diff --git a/src/resources/addressing/prefixes/index.ts b/src/resources/addressing/prefixes/index.ts index 48ee908cbc..f5c6f15ce2 100644 --- a/src/resources/addressing/prefixes/index.ts +++ b/src/resources/addressing/prefixes/index.ts @@ -1,23 +1,22 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +export { BGP } from './bgp/index'; export { - AddressingIpamDelegations, + Delegations, DelegationDeleteResponse, DelegationCreateParams, DelegationListParams, DelegationDeleteParams, - AddressingIpamDelegationsSinglePage, - Delegations, + DelegationsSinglePage, } from './delegations'; export { - AddressingIpamPrefixes, + Prefix, PrefixDeleteResponse, PrefixCreateParams, PrefixListParams, PrefixDeleteParams, PrefixEditParams, PrefixGetParams, - AddressingIpamPrefixesSinglePage, + PrefixesSinglePage, Prefixes, } from './prefixes'; -export { BGP } from './bgp/index'; diff --git a/src/resources/addressing/prefixes/prefixes.ts b/src/resources/addressing/prefixes/prefixes.ts index 72422a31ae..0fae0b98ce 100644 --- a/src/resources/addressing/prefixes/prefixes.ts +++ b/src/resources/addressing/prefixes/prefixes.ts @@ -14,13 +14,13 @@ export class Prefixes extends APIResource { /** * Add a new prefix under the account. */ - create(params: PrefixCreateParams, options?: Core.RequestOptions): Core.APIPromise { + create(params: PrefixCreateParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/addressing/prefixes`, { body, ...options, - }) as Core.APIPromise<{ result: AddressingIpamPrefixes }> + }) as Core.APIPromise<{ result: Prefix }> )._thenUnwrap((obj) => obj.result); } @@ -30,11 +30,11 @@ export class Prefixes extends APIResource { list( params: PrefixListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/addressing/prefixes`, - AddressingIpamPrefixesSinglePage, + PrefixesSinglePage, options, ); } @@ -47,53 +47,45 @@ export class Prefixes extends APIResource { params: PrefixDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { account_id } = params; + const { account_id, body } = params; return ( - this._client.delete( - `/accounts/${account_id}/addressing/prefixes/${prefixId}`, - options, - ) as Core.APIPromise<{ result: PrefixDeleteResponse | null }> + this._client.delete(`/accounts/${account_id}/addressing/prefixes/${prefixId}`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: PrefixDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } /** * Modify the description for a prefix owned by the account. */ - edit( - prefixId: string, - params: PrefixEditParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + edit(prefixId: string, params: PrefixEditParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.patch(`/accounts/${account_id}/addressing/prefixes/${prefixId}`, { body, ...options, - }) as Core.APIPromise<{ result: AddressingIpamPrefixes }> + }) as Core.APIPromise<{ result: Prefix }> )._thenUnwrap((obj) => obj.result); } /** * List a particular prefix owned by the account. */ - get( - prefixId: string, - params: PrefixGetParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + get(prefixId: string, params: PrefixGetParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/addressing/prefixes/${prefixId}`, options, - ) as Core.APIPromise<{ result: AddressingIpamPrefixes }> + ) as Core.APIPromise<{ result: Prefix }> )._thenUnwrap((obj) => obj.result); } } -export class AddressingIpamPrefixesSinglePage extends SinglePage {} +export class PrefixesSinglePage extends SinglePage {} -export interface AddressingIpamPrefixes { +export interface Prefix { /** * Identifier */ @@ -158,7 +150,7 @@ export interface AddressingIpamPrefixes { on_demand_locked?: boolean; } -export type PrefixDeleteResponse = unknown | Array | string; +export type PrefixDeleteResponse = Array; export interface PrefixCreateParams { /** @@ -191,9 +183,14 @@ export interface PrefixListParams { export interface PrefixDeleteParams { /** - * Identifier + * Path param: Identifier */ account_id: string; + + /** + * Body param: + */ + body: unknown; } export interface PrefixEditParams { @@ -216,9 +213,9 @@ export interface PrefixGetParams { } export namespace Prefixes { - export import AddressingIpamPrefixes = PrefixesAPI.AddressingIpamPrefixes; + export import Prefix = PrefixesAPI.Prefix; export import PrefixDeleteResponse = PrefixesAPI.PrefixDeleteResponse; - export import AddressingIpamPrefixesSinglePage = PrefixesAPI.AddressingIpamPrefixesSinglePage; + export import PrefixesSinglePage = PrefixesAPI.PrefixesSinglePage; export import PrefixCreateParams = PrefixesAPI.PrefixCreateParams; export import PrefixListParams = PrefixesAPI.PrefixListParams; export import PrefixDeleteParams = PrefixesAPI.PrefixDeleteParams; @@ -226,9 +223,8 @@ export namespace Prefixes { export import PrefixGetParams = PrefixesAPI.PrefixGetParams; export import BGP = BGPAPI.BGP; export import Delegations = DelegationsAPI.Delegations; - export import AddressingIpamDelegations = DelegationsAPI.AddressingIpamDelegations; export import DelegationDeleteResponse = DelegationsAPI.DelegationDeleteResponse; - export import AddressingIpamDelegationsSinglePage = DelegationsAPI.AddressingIpamDelegationsSinglePage; + export import DelegationsSinglePage = DelegationsAPI.DelegationsSinglePage; export import DelegationCreateParams = DelegationsAPI.DelegationCreateParams; export import DelegationListParams = DelegationsAPI.DelegationListParams; export import DelegationDeleteParams = DelegationsAPI.DelegationDeleteParams; diff --git a/src/resources/alerting/alerting.ts b/src/resources/alerting/alerting.ts index 7e39b76e30..1509b6d7bb 100644 --- a/src/resources/alerting/alerting.ts +++ b/src/resources/alerting/alerting.ts @@ -9,25 +9,34 @@ import * as DestinationsAPI from 'cloudflare/resources/alerting/destinations/des export class Alerting extends APIResource { availableAlerts: AvailableAlertsAPI.AvailableAlerts = new AvailableAlertsAPI.AvailableAlerts(this._client); destinations: DestinationsAPI.Destinations = new DestinationsAPI.Destinations(this._client); - history: HistoryAPI.History = new HistoryAPI.History(this._client); + history: HistoryAPI.HistoryResource = new HistoryAPI.HistoryResource(this._client); policies: PoliciesAPI.Policies = new PoliciesAPI.Policies(this._client); } +export interface Alert { + /** + * UUID + */ + id?: string; +} + export namespace Alerting { export import AvailableAlerts = AvailableAlertsAPI.AvailableAlerts; export import AvailableAlertListResponse = AvailableAlertsAPI.AvailableAlertListResponse; export import AvailableAlertListParams = AvailableAlertsAPI.AvailableAlertListParams; export import Destinations = DestinationsAPI.Destinations; + export import HistoryResource = HistoryAPI.HistoryResource; export import History = HistoryAPI.History; - export import AlertingHistory = HistoryAPI.AlertingHistory; - export import AlertingHistoriesV4PagePaginationArray = HistoryAPI.AlertingHistoriesV4PagePaginationArray; + export import HistoriesV4PagePaginationArray = HistoryAPI.HistoriesV4PagePaginationArray; export import HistoryListParams = HistoryAPI.HistoryListParams; export import Policies = PoliciesAPI.Policies; - export import AlertingPolicies = PoliciesAPI.AlertingPolicies; + export import Mechanism = PoliciesAPI.Mechanism; + export import Policy = PoliciesAPI.Policy; + export import PolicyFilter = PoliciesAPI.PolicyFilter; export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse; export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse; export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse; - export import AlertingPoliciesSinglePage = PoliciesAPI.AlertingPoliciesSinglePage; + export import PoliciesSinglePage = PoliciesAPI.PoliciesSinglePage; export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams; export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams; export import PolicyListParams = PoliciesAPI.PolicyListParams; diff --git a/src/resources/alerting/destinations/destinations.ts b/src/resources/alerting/destinations/destinations.ts index 1996256199..53efe6aaba 100644 --- a/src/resources/alerting/destinations/destinations.ts +++ b/src/resources/alerting/destinations/destinations.ts @@ -7,7 +7,7 @@ import * as WebhooksAPI from 'cloudflare/resources/alerting/destinations/webhook export class Destinations extends APIResource { eligible: EligibleAPI.Eligible = new EligibleAPI.Eligible(this._client); - pagerduty: PagerdutyAPI.Pagerduty = new PagerdutyAPI.Pagerduty(this._client); + pagerduty: PagerdutyAPI.PagerdutyResource = new PagerdutyAPI.PagerdutyResource(this._client); webhooks: WebhooksAPI.Webhooks = new WebhooksAPI.Webhooks(this._client); } @@ -15,8 +15,8 @@ export namespace Destinations { export import Eligible = EligibleAPI.Eligible; export import EligibleGetResponse = EligibleAPI.EligibleGetResponse; export import EligibleGetParams = EligibleAPI.EligibleGetParams; + export import PagerdutyResource = PagerdutyAPI.PagerdutyResource; export import Pagerduty = PagerdutyAPI.Pagerduty; - export import AlertingPagerduty = PagerdutyAPI.AlertingPagerduty; export import PagerdutyCreateResponse = PagerdutyAPI.PagerdutyCreateResponse; export import PagerdutyDeleteResponse = PagerdutyAPI.PagerdutyDeleteResponse; export import PagerdutyGetResponse = PagerdutyAPI.PagerdutyGetResponse; @@ -26,11 +26,10 @@ export namespace Destinations { export import PagerdutyGetParams = PagerdutyAPI.PagerdutyGetParams; export import PagerdutyLinkParams = PagerdutyAPI.PagerdutyLinkParams; export import Webhooks = WebhooksAPI.Webhooks; - export import AlertingWebhooks = WebhooksAPI.AlertingWebhooks; export import WebhookCreateResponse = WebhooksAPI.WebhookCreateResponse; export import WebhookUpdateResponse = WebhooksAPI.WebhookUpdateResponse; export import WebhookDeleteResponse = WebhooksAPI.WebhookDeleteResponse; - export import AlertingWebhooksSinglePage = WebhooksAPI.AlertingWebhooksSinglePage; + export import WebhooksSinglePage = WebhooksAPI.WebhooksSinglePage; export import WebhookCreateParams = WebhooksAPI.WebhookCreateParams; export import WebhookUpdateParams = WebhooksAPI.WebhookUpdateParams; export import WebhookListParams = WebhooksAPI.WebhookListParams; diff --git a/src/resources/alerting/destinations/index.ts b/src/resources/alerting/destinations/index.ts index ce1815e76a..2900a2183c 100644 --- a/src/resources/alerting/destinations/index.ts +++ b/src/resources/alerting/destinations/index.ts @@ -1,7 +1,9 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +export { Destinations } from './destinations'; +export { EligibleGetResponse, EligibleGetParams, Eligible } from './eligible'; export { - AlertingPagerduty, + Pagerduty, PagerdutyCreateResponse, PagerdutyDeleteResponse, PagerdutyGetResponse, @@ -10,10 +12,10 @@ export { PagerdutyDeleteParams, PagerdutyGetParams, PagerdutyLinkParams, - Pagerduty, + PagerdutyResource, } from './pagerduty'; export { - AlertingWebhooks, + Webhooks, WebhookCreateResponse, WebhookUpdateResponse, WebhookDeleteResponse, @@ -22,8 +24,5 @@ export { WebhookListParams, WebhookDeleteParams, WebhookGetParams, - AlertingWebhooksSinglePage, - Webhooks, + WebhooksSinglePage, } from './webhooks'; -export { Destinations } from './destinations'; -export { EligibleGetResponse, EligibleGetParams, Eligible } from './eligible'; diff --git a/src/resources/alerting/destinations/pagerduty.ts b/src/resources/alerting/destinations/pagerduty.ts index ea4e368d2e..ded4f2859a 100644 --- a/src/resources/alerting/destinations/pagerduty.ts +++ b/src/resources/alerting/destinations/pagerduty.ts @@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as PagerdutyAPI from 'cloudflare/resources/alerting/destinations/pagerduty'; -export class Pagerduty extends APIResource { +export class PagerdutyResource extends APIResource { /** * Creates a new token for integrating with PagerDuty. */ @@ -71,7 +71,7 @@ export class Pagerduty extends APIResource { } } -export interface AlertingPagerduty { +export interface Pagerduty { /** * UUID */ @@ -92,7 +92,7 @@ export interface PagerdutyCreateResponse { export type PagerdutyDeleteResponse = unknown | Array | string; -export type PagerdutyGetResponse = Array; +export type PagerdutyGetResponse = Array; export interface PagerdutyLinkResponse { /** @@ -129,8 +129,8 @@ export interface PagerdutyLinkParams { account_id: string; } -export namespace Pagerduty { - export import AlertingPagerduty = PagerdutyAPI.AlertingPagerduty; +export namespace PagerdutyResource { + export import Pagerduty = PagerdutyAPI.Pagerduty; export import PagerdutyCreateResponse = PagerdutyAPI.PagerdutyCreateResponse; export import PagerdutyDeleteResponse = PagerdutyAPI.PagerdutyDeleteResponse; export import PagerdutyGetResponse = PagerdutyAPI.PagerdutyGetResponse; diff --git a/src/resources/alerting/destinations/webhooks.ts b/src/resources/alerting/destinations/webhooks.ts index 3c0e9b9b3f..c803afeb38 100644 --- a/src/resources/alerting/destinations/webhooks.ts +++ b/src/resources/alerting/destinations/webhooks.ts @@ -42,11 +42,11 @@ export class Webhooks extends APIResource { list( params: WebhookListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/alerting/v3/destinations/webhooks`, - AlertingWebhooksSinglePage, + WebhooksSinglePage, options, ); } @@ -71,24 +71,20 @@ export class Webhooks extends APIResource { /** * Get details for a single webhooks destination. */ - get( - webhookId: string, - params: WebhookGetParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + get(webhookId: string, params: WebhookGetParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/alerting/v3/destinations/webhooks/${webhookId}`, options, - ) as Core.APIPromise<{ result: AlertingWebhooks }> + ) as Core.APIPromise<{ result: Webhooks }> )._thenUnwrap((obj) => obj.result); } } -export class AlertingWebhooksSinglePage extends SinglePage {} +export class WebhooksSinglePage extends SinglePage {} -export interface AlertingWebhooks { +export interface Webhooks { /** * The unique identifier of a webhook */ @@ -223,11 +219,11 @@ export interface WebhookGetParams { } export namespace Webhooks { - export import AlertingWebhooks = WebhooksAPI.AlertingWebhooks; + export import Webhooks = WebhooksAPI.Webhooks; export import WebhookCreateResponse = WebhooksAPI.WebhookCreateResponse; export import WebhookUpdateResponse = WebhooksAPI.WebhookUpdateResponse; export import WebhookDeleteResponse = WebhooksAPI.WebhookDeleteResponse; - export import AlertingWebhooksSinglePage = WebhooksAPI.AlertingWebhooksSinglePage; + export import WebhooksSinglePage = WebhooksAPI.WebhooksSinglePage; export import WebhookCreateParams = WebhooksAPI.WebhookCreateParams; export import WebhookUpdateParams = WebhooksAPI.WebhookUpdateParams; export import WebhookListParams = WebhooksAPI.WebhookListParams; diff --git a/src/resources/alerting/history.ts b/src/resources/alerting/history.ts index c8549ea238..87204e440b 100644 --- a/src/resources/alerting/history.ts +++ b/src/resources/alerting/history.ts @@ -5,7 +5,7 @@ import { APIResource } from 'cloudflare/resource'; import * as HistoryAPI from 'cloudflare/resources/alerting/history'; import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination'; -export class History extends APIResource { +export class HistoryResource extends APIResource { /** * Gets a list of history records for notifications sent to an account. The records * are displayed for last `x` number of days based on the zone plan (free = 30, pro @@ -14,19 +14,19 @@ export class History extends APIResource { list( params: HistoryListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id, ...query } = params; return this._client.getAPIList( `/accounts/${account_id}/alerting/v3/history`, - AlertingHistoriesV4PagePaginationArray, + HistoriesV4PagePaginationArray, { query, ...options }, ); } } -export class AlertingHistoriesV4PagePaginationArray extends V4PagePaginationArray {} +export class HistoriesV4PagePaginationArray extends V4PagePaginationArray {} -export interface AlertingHistory { +export interface History { /** * UUID */ @@ -93,8 +93,8 @@ export interface HistoryListParams extends V4PagePaginationArrayParams { since?: string; } -export namespace History { - export import AlertingHistory = HistoryAPI.AlertingHistory; - export import AlertingHistoriesV4PagePaginationArray = HistoryAPI.AlertingHistoriesV4PagePaginationArray; +export namespace HistoryResource { + export import History = HistoryAPI.History; + export import HistoriesV4PagePaginationArray = HistoryAPI.HistoriesV4PagePaginationArray; export import HistoryListParams = HistoryAPI.HistoryListParams; } diff --git a/src/resources/alerting/index.ts b/src/resources/alerting/index.ts index 8f83059ee0..4e3c7f7a3b 100644 --- a/src/resources/alerting/index.ts +++ b/src/resources/alerting/index.ts @@ -1,14 +1,13 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. export { Alerting } from './alerting'; +export { AvailableAlertListResponse, AvailableAlertListParams, AvailableAlerts } from './available-alerts'; +export { Destinations } from './destinations/index'; +export { History, HistoryListParams, HistoriesV4PagePaginationArray, HistoryResource } from './history'; export { - AlertingHistory, - HistoryListParams, - AlertingHistoriesV4PagePaginationArray, - History, -} from './history'; -export { - AlertingPolicies, + Mechanism, + Policy, + PolicyFilter, PolicyCreateResponse, PolicyUpdateResponse, PolicyDeleteResponse, @@ -17,8 +16,6 @@ export { PolicyListParams, PolicyDeleteParams, PolicyGetParams, - AlertingPoliciesSinglePage, + PoliciesSinglePage, Policies, } from './policies'; -export { AvailableAlertListResponse, AvailableAlertListParams, AvailableAlerts } from './available-alerts'; -export { Destinations } from './destinations/index'; diff --git a/src/resources/alerting/policies.ts b/src/resources/alerting/policies.ts index 3bbe6a8631..68e4c65a2f 100644 --- a/src/resources/alerting/policies.ts +++ b/src/resources/alerting/policies.ts @@ -42,11 +42,11 @@ export class Policies extends APIResource { list( params: PolicyListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/alerting/v3/policies`, - AlertingPoliciesSinglePage, + PoliciesSinglePage, options, ); } @@ -71,24 +71,35 @@ export class Policies extends APIResource { /** * Get details for a single policy. */ - get( - policyId: string, - params: PolicyGetParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + get(policyId: string, params: PolicyGetParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/alerting/v3/policies/${policyId}`, options, - ) as Core.APIPromise<{ result: AlertingPolicies }> + ) as Core.APIPromise<{ result: Policy }> )._thenUnwrap((obj) => obj.result); } } -export class AlertingPoliciesSinglePage extends SinglePage {} +export class PoliciesSinglePage extends SinglePage {} + +/** + * List of IDs that will be used when dispatching a notification. IDs for email + * type will be the email address. + */ +export type Mechanism = Record>; + +export namespace Mechanism { + export interface UnnamedSchemaWithMapParent1 { + /** + * UUID + */ + id?: string | string; + } +} -export interface AlertingPolicies { +export interface Policy { /** * The unique identifier of a notification policy */ @@ -173,13 +184,13 @@ export interface AlertingPolicies { * that alert type based on some criteria. This is only available for select alert * types. See alert type documentation for more details. */ - filters?: AlertingPolicies.Filters; + filters?: PolicyFilter; /** * List of IDs that will be used when dispatching a notification. IDs for email * type will be the email address. */ - mechanisms?: Record>; + mechanisms?: Mechanism; modified?: string; @@ -189,223 +200,214 @@ export interface AlertingPolicies { name?: string; } -export namespace AlertingPolicies { +/** + * Optional filters that allow you to be alerted only on a subset of events for + * that alert type based on some criteria. This is only available for select alert + * types. See alert type documentation for more details. + */ +export interface PolicyFilter { /** - * Optional filters that allow you to be alerted only on a subset of events for - * that alert type based on some criteria. This is only available for select alert - * types. See alert type documentation for more details. + * Usage depends on specific alert type */ - export interface Filters { - /** - * Usage depends on specific alert type - */ - actions?: Array; - - /** - * Used for configuring radar_notification - */ - affected_asns?: Array; + actions?: Array; - /** - * Used for configuring incident_alert. A list of identifiers for each component to - * monitor. - */ - affected_components?: Array; + /** + * Used for configuring radar_notification + */ + affected_asns?: Array; - /** - * Used for configuring radar_notification - */ - affected_locations?: Array; + /** + * Used for configuring incident_alert. A list of identifiers for each component to + * monitor. + */ + affected_components?: Array; - /** - * Used for configuring maintenance_event_notification - */ - airport_code?: Array; + /** + * Used for configuring radar_notification + */ + affected_locations?: Array; - /** - * Usage depends on specific alert type - */ - alert_trigger_preferences?: Array; + /** + * Used for configuring maintenance_event_notification + */ + airport_code?: Array; - /** - * Used for configuring magic_tunnel_health_check_event - */ - alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>; + /** + * Usage depends on specific alert type + */ + alert_trigger_preferences?: Array; - /** - * Used for configuring load_balancing_pool_enablement_alert - */ - enabled?: Array; + /** + * Used for configuring magic_tunnel_health_check_event + */ + alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>; - /** - * Used for configuring pages_event_alert - */ - environment?: Array; + /** + * Used for configuring load_balancing_pool_enablement_alert + */ + enabled?: Array; - /** - * Used for configuring pages_event_alert - */ - event?: Array; + /** + * Used for configuring pages_event_alert + */ + environment?: Array; - /** - * Used for configuring load_balancing_health_alert - */ - event_source?: Array; + /** + * Used for configuring pages_event_alert + */ + event?: Array; - /** - * Usage depends on specific alert type - */ - event_type?: Array; + /** + * Used for configuring load_balancing_health_alert + */ + event_source?: Array; - /** - * Usage depends on specific alert type - */ - group_by?: Array; + /** + * Usage depends on specific alert type + */ + event_type?: Array; - /** - * Used for configuring health_check_status_notification - */ - health_check_id?: Array; + /** + * Usage depends on specific alert type + */ + group_by?: Array; - /** - * Used for configuring incident_alert - */ - incident_impact?: Array< - 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL' - >; + /** + * Used for configuring health_check_status_notification + */ + health_check_id?: Array; - /** - * Used for configuring stream_live_notifications - */ - input_id?: Array; + /** + * Used for configuring incident_alert + */ + incident_impact?: Array< + 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL' + >; - /** - * Used for configuring billing_usage_alert - */ - limit?: Array; + /** + * Used for configuring stream_live_notifications + */ + input_id?: Array; - /** - * Used for configuring logo_match_alert - */ - logo_tag?: Array; + /** + * Used for configuring billing_usage_alert + */ + limit?: Array; - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - megabits_per_second?: Array; + /** + * Used for configuring logo_match_alert + */ + logo_tag?: Array; - /** - * Used for configuring load_balancing_health_alert - */ - new_health?: Array; + /** + * Used for configuring advanced_ddos_attack_l4_alert + */ + megabits_per_second?: Array; - /** - * Used for configuring tunnel_health_event - */ - new_status?: Array; + /** + * Used for configuring load_balancing_health_alert + */ + new_health?: Array; - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - packets_per_second?: Array; + /** + * Used for configuring tunnel_health_event + */ + new_status?: Array; - /** - * Usage depends on specific alert type - */ - pool_id?: Array; + /** + * Used for configuring advanced_ddos_attack_l4_alert + */ + packets_per_second?: Array; - /** - * Used for configuring billing_usage_alert - */ - product?: Array; + /** + * Usage depends on specific alert type + */ + pool_id?: Array; - /** - * Used for configuring pages_event_alert - */ - project_id?: Array; + /** + * Used for configuring billing_usage_alert + */ + product?: Array; - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - protocol?: Array; + /** + * Used for configuring pages_event_alert + */ + project_id?: Array; - /** - * Usage depends on specific alert type - */ - query_tag?: Array; + /** + * Used for configuring advanced_ddos_attack_l4_alert + */ + protocol?: Array; - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - requests_per_second?: Array; + /** + * Usage depends on specific alert type + */ + query_tag?: Array; - /** - * Usage depends on specific alert type - */ - selectors?: Array; + /** + * Used for configuring advanced_ddos_attack_l7_alert + */ + requests_per_second?: Array; - /** - * Used for configuring clickhouse_alert_fw_ent_anomaly - */ - services?: Array; + /** + * Usage depends on specific alert type + */ + selectors?: Array; - /** - * Usage depends on specific alert type - */ - slo?: Array; + /** + * Used for configuring clickhouse_alert_fw_ent_anomaly + */ + services?: Array; - /** - * Used for configuring health_check_status_notification - */ - status?: Array; + /** + * Usage depends on specific alert type + */ + slo?: Array; - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - target_hostname?: Array; + /** + * Used for configuring health_check_status_notification + */ + status?: Array; - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - target_ip?: Array; + /** + * Used for configuring advanced_ddos_attack_l7_alert + */ + target_hostname?: Array; - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - target_zone_name?: Array; + /** + * Used for configuring advanced_ddos_attack_l4_alert + */ + target_ip?: Array; - /** - * Used for configuring traffic_anomalies_alert - */ - traffic_exclusions?: Array<'security_events'>; + /** + * Used for configuring advanced_ddos_attack_l7_alert + */ + target_zone_name?: Array; - /** - * Used for configuring tunnel_health_event - */ - tunnel_id?: Array; + /** + * Used for configuring traffic_anomalies_alert + */ + traffic_exclusions?: Array<'security_events'>; - /** - * Used for configuring magic_tunnel_health_check_event - */ - tunnel_name?: Array; + /** + * Used for configuring tunnel_health_event + */ + tunnel_id?: Array; - /** - * Usage depends on specific alert type - */ - where?: Array; + /** + * Used for configuring magic_tunnel_health_check_event + */ + tunnel_name?: Array; - /** - * Usage depends on specific alert type - */ - zones?: Array; - } + /** + * Usage depends on specific alert type + */ + where?: Array; - export interface Mechanisms { - /** - * UUID - */ - id?: string | string; - } + /** + * Usage depends on specific alert type + */ + zones?: Array; } export interface PolicyCreateResponse { @@ -501,7 +503,7 @@ export interface PolicyCreateParams { * Body param: List of IDs that will be used when dispatching a notification. IDs * for email type will be the email address. */ - mechanisms: Record>; + mechanisms: Mechanism; /** * Body param: Name of the policy. @@ -518,226 +520,7 @@ export interface PolicyCreateParams { * events for that alert type based on some criteria. This is only available for * select alert types. See alert type documentation for more details. */ - filters?: PolicyCreateParams.Filters; -} - -export namespace PolicyCreateParams { - export interface Mechanisms { - /** - * UUID - */ - id?: string | string; - } - - /** - * Optional filters that allow you to be alerted only on a subset of events for - * that alert type based on some criteria. This is only available for select alert - * types. See alert type documentation for more details. - */ - export interface Filters { - /** - * Usage depends on specific alert type - */ - actions?: Array; - - /** - * Used for configuring radar_notification - */ - affected_asns?: Array; - - /** - * Used for configuring incident_alert. A list of identifiers for each component to - * monitor. - */ - affected_components?: Array; - - /** - * Used for configuring radar_notification - */ - affected_locations?: Array; - - /** - * Used for configuring maintenance_event_notification - */ - airport_code?: Array; - - /** - * Usage depends on specific alert type - */ - alert_trigger_preferences?: Array; - - /** - * Used for configuring magic_tunnel_health_check_event - */ - alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>; - - /** - * Used for configuring load_balancing_pool_enablement_alert - */ - enabled?: Array; - - /** - * Used for configuring pages_event_alert - */ - environment?: Array; - - /** - * Used for configuring pages_event_alert - */ - event?: Array; - - /** - * Used for configuring load_balancing_health_alert - */ - event_source?: Array; - - /** - * Usage depends on specific alert type - */ - event_type?: Array; - - /** - * Usage depends on specific alert type - */ - group_by?: Array; - - /** - * Used for configuring health_check_status_notification - */ - health_check_id?: Array; - - /** - * Used for configuring incident_alert - */ - incident_impact?: Array< - 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL' - >; - - /** - * Used for configuring stream_live_notifications - */ - input_id?: Array; - - /** - * Used for configuring billing_usage_alert - */ - limit?: Array; - - /** - * Used for configuring logo_match_alert - */ - logo_tag?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - megabits_per_second?: Array; - - /** - * Used for configuring load_balancing_health_alert - */ - new_health?: Array; - - /** - * Used for configuring tunnel_health_event - */ - new_status?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - packets_per_second?: Array; - - /** - * Usage depends on specific alert type - */ - pool_id?: Array; - - /** - * Used for configuring billing_usage_alert - */ - product?: Array; - - /** - * Used for configuring pages_event_alert - */ - project_id?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - protocol?: Array; - - /** - * Usage depends on specific alert type - */ - query_tag?: Array; - - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - requests_per_second?: Array; - - /** - * Usage depends on specific alert type - */ - selectors?: Array; - - /** - * Used for configuring clickhouse_alert_fw_ent_anomaly - */ - services?: Array; - - /** - * Usage depends on specific alert type - */ - slo?: Array; - - /** - * Used for configuring health_check_status_notification - */ - status?: Array; - - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - target_hostname?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - target_ip?: Array; - - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - target_zone_name?: Array; - - /** - * Used for configuring traffic_anomalies_alert - */ - traffic_exclusions?: Array<'security_events'>; - - /** - * Used for configuring tunnel_health_event - */ - tunnel_id?: Array; - - /** - * Used for configuring magic_tunnel_health_check_event - */ - tunnel_name?: Array; - - /** - * Usage depends on specific alert type - */ - where?: Array; - - /** - * Usage depends on specific alert type - */ - zones?: Array; - } + filters?: PolicyFilter; } export interface PolicyUpdateParams { @@ -823,13 +606,13 @@ export interface PolicyUpdateParams { * events for that alert type based on some criteria. This is only available for * select alert types. See alert type documentation for more details. */ - filters?: PolicyUpdateParams.Filters; + filters?: PolicyFilter; /** * Body param: List of IDs that will be used when dispatching a notification. IDs * for email type will be the email address. */ - mechanisms?: Record>; + mechanisms?: Mechanism; /** * Body param: Name of the policy. @@ -837,225 +620,6 @@ export interface PolicyUpdateParams { name?: string; } -export namespace PolicyUpdateParams { - /** - * Optional filters that allow you to be alerted only on a subset of events for - * that alert type based on some criteria. This is only available for select alert - * types. See alert type documentation for more details. - */ - export interface Filters { - /** - * Usage depends on specific alert type - */ - actions?: Array; - - /** - * Used for configuring radar_notification - */ - affected_asns?: Array; - - /** - * Used for configuring incident_alert. A list of identifiers for each component to - * monitor. - */ - affected_components?: Array; - - /** - * Used for configuring radar_notification - */ - affected_locations?: Array; - - /** - * Used for configuring maintenance_event_notification - */ - airport_code?: Array; - - /** - * Usage depends on specific alert type - */ - alert_trigger_preferences?: Array; - - /** - * Used for configuring magic_tunnel_health_check_event - */ - alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>; - - /** - * Used for configuring load_balancing_pool_enablement_alert - */ - enabled?: Array; - - /** - * Used for configuring pages_event_alert - */ - environment?: Array; - - /** - * Used for configuring pages_event_alert - */ - event?: Array; - - /** - * Used for configuring load_balancing_health_alert - */ - event_source?: Array; - - /** - * Usage depends on specific alert type - */ - event_type?: Array; - - /** - * Usage depends on specific alert type - */ - group_by?: Array; - - /** - * Used for configuring health_check_status_notification - */ - health_check_id?: Array; - - /** - * Used for configuring incident_alert - */ - incident_impact?: Array< - 'INCIDENT_IMPACT_NONE' | 'INCIDENT_IMPACT_MINOR' | 'INCIDENT_IMPACT_MAJOR' | 'INCIDENT_IMPACT_CRITICAL' - >; - - /** - * Used for configuring stream_live_notifications - */ - input_id?: Array; - - /** - * Used for configuring billing_usage_alert - */ - limit?: Array; - - /** - * Used for configuring logo_match_alert - */ - logo_tag?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - megabits_per_second?: Array; - - /** - * Used for configuring load_balancing_health_alert - */ - new_health?: Array; - - /** - * Used for configuring tunnel_health_event - */ - new_status?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - packets_per_second?: Array; - - /** - * Usage depends on specific alert type - */ - pool_id?: Array; - - /** - * Used for configuring billing_usage_alert - */ - product?: Array; - - /** - * Used for configuring pages_event_alert - */ - project_id?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - protocol?: Array; - - /** - * Usage depends on specific alert type - */ - query_tag?: Array; - - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - requests_per_second?: Array; - - /** - * Usage depends on specific alert type - */ - selectors?: Array; - - /** - * Used for configuring clickhouse_alert_fw_ent_anomaly - */ - services?: Array; - - /** - * Usage depends on specific alert type - */ - slo?: Array; - - /** - * Used for configuring health_check_status_notification - */ - status?: Array; - - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - target_hostname?: Array; - - /** - * Used for configuring advanced_ddos_attack_l4_alert - */ - target_ip?: Array; - - /** - * Used for configuring advanced_ddos_attack_l7_alert - */ - target_zone_name?: Array; - - /** - * Used for configuring traffic_anomalies_alert - */ - traffic_exclusions?: Array<'security_events'>; - - /** - * Used for configuring tunnel_health_event - */ - tunnel_id?: Array; - - /** - * Used for configuring magic_tunnel_health_check_event - */ - tunnel_name?: Array; - - /** - * Usage depends on specific alert type - */ - where?: Array; - - /** - * Usage depends on specific alert type - */ - zones?: Array; - } - - export interface Mechanisms { - /** - * UUID - */ - id?: string | string; - } -} - export interface PolicyListParams { /** * The account id @@ -1078,11 +642,13 @@ export interface PolicyGetParams { } export namespace Policies { - export import AlertingPolicies = PoliciesAPI.AlertingPolicies; + export import Mechanism = PoliciesAPI.Mechanism; + export import Policy = PoliciesAPI.Policy; + export import PolicyFilter = PoliciesAPI.PolicyFilter; export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse; export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse; export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse; - export import AlertingPoliciesSinglePage = PoliciesAPI.AlertingPoliciesSinglePage; + export import PoliciesSinglePage = PoliciesAPI.PoliciesSinglePage; export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams; export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams; export import PolicyListParams = PoliciesAPI.PolicyListParams; diff --git a/src/resources/audit-logs.ts b/src/resources/audit-logs.ts index 0553ca6f85..3278f7e2fb 100644 --- a/src/resources/audit-logs.ts +++ b/src/resources/audit-logs.ts @@ -2,8 +2,9 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as AuditLogsAPI from 'cloudflare/resources/audit-logs'; -import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination'; +import * as Shared from 'cloudflare/resources/shared'; +import { AuditLogsV4PagePaginationArray } from 'cloudflare/resources/shared'; +import { type V4PagePaginationArrayParams } from 'cloudflare/pagination'; export class AuditLogs extends APIResource { /** @@ -13,112 +14,12 @@ export class AuditLogs extends APIResource { list( params: AuditLogListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id, ...query } = params; - return this._client.getAPIList( - `/accounts/${account_id}/audit_logs`, - AuditLogListResponsesV4PagePaginationArray, - { query, ...options }, - ); - } -} - -export class AuditLogListResponsesV4PagePaginationArray extends V4PagePaginationArray {} - -export interface AuditLogListResponse { - /** - * A string that uniquely identifies the audit log. - */ - id?: string; - - action?: AuditLogListResponse.Action; - - actor?: AuditLogListResponse.Actor; - - /** - * The source of the event. - */ - interface?: string; - - /** - * An object which can lend more context to the action being logged. This is a - * flexible value and varies between different actions. - */ - metadata?: unknown; - - /** - * The new value of the resource that was modified. - */ - newValue?: string; - - /** - * The value of the resource before it was modified. - */ - oldValue?: string; - - owner?: AuditLogListResponse.Owner; - - resource?: AuditLogListResponse.Resource; - - /** - * A UTC RFC3339 timestamp that specifies when the action being logged occured. - */ - when?: string; -} - -export namespace AuditLogListResponse { - export interface Action { - /** - * A boolean that indicates if the action attempted was successful. - */ - result?: boolean; - - /** - * A short string that describes the action that was performed. - */ - type?: string; - } - - export interface Actor { - /** - * The ID of the actor that performed the action. If a user performed the action, - * this will be their User ID. - */ - id?: string; - - /** - * The email of the user that performed the action. - */ - email?: string; - - /** - * The IP address of the request that performed the action. - */ - ip?: string; - - /** - * The type of actor, whether a User, Cloudflare Admin, or an Automated System. - */ - type?: 'user' | 'admin' | 'Cloudflare'; - } - - export interface Owner { - /** - * Identifier - */ - id?: string; - } - - export interface Resource { - /** - * An identifier for the resource that was affected by the action. - */ - id?: string; - - /** - * A short string that describes the resource that was affected by the action. - */ - type?: string; + return this._client.getAPIList(`/accounts/${account_id}/audit_logs`, AuditLogsV4PagePaginationArray, { + query, + ...options, + }); } } @@ -207,8 +108,4 @@ export namespace AuditLogListParams { } } -export namespace AuditLogs { - export import AuditLogListResponse = AuditLogsAPI.AuditLogListResponse; - export import AuditLogListResponsesV4PagePaginationArray = AuditLogsAPI.AuditLogListResponsesV4PagePaginationArray; - export import AuditLogListParams = AuditLogsAPI.AuditLogListParams; -} +export { AuditLogsV4PagePaginationArray }; diff --git a/src/resources/bot-management.ts b/src/resources/bot-management.ts index c7796af99c..740a337aed 100644 --- a/src/resources/bot-management.ts +++ b/src/resources/bot-management.ts @@ -2,7 +2,6 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as BotManagementAPI from 'cloudflare/resources/bot-management'; export class BotManagement extends APIResource { /** @@ -45,276 +44,149 @@ export class BotManagement extends APIResource { } } -export type BotManagementUpdateResponse = - | BotManagementUpdateResponse.BotManagementBotFightModeConfig - | BotManagementUpdateResponse.BotManagementSbfmDefinitelyConfig - | BotManagementUpdateResponse.BotManagementSbfmLikelyConfig - | BotManagementUpdateResponse.BotManagementBmSubscriptionConfig; - -export namespace BotManagementUpdateResponse { - export interface BotManagementBotFightModeConfig { - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; - - /** - * Whether to enable Bot Fight Mode. - */ - fight_mode?: boolean; - - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } - - export interface BotManagementSbfmDefinitelyConfig { - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; - - /** - * Whether to optimize Super Bot Fight Mode protections for Wordpress. - */ - optimize_wordpress?: boolean; - - /** - * Super Bot Fight Mode (SBFM) action to take on definitely automated requests. - */ - sbfm_definitely_automated?: 'allow' | 'block' | 'managed_challenge'; - - /** - * Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if - * static resources on your application need bot protection. Note: Static resource - * protection can also result in legitimate traffic being blocked. - */ - sbfm_static_resource_protection?: boolean; - - /** - * Super Bot Fight Mode (SBFM) action to take on verified bots requests. - */ - sbfm_verified_bots?: 'allow' | 'block'; - - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } - - export interface BotManagementSbfmLikelyConfig { - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; - - /** - * Whether to optimize Super Bot Fight Mode protections for Wordpress. - */ - optimize_wordpress?: boolean; - - /** - * Super Bot Fight Mode (SBFM) action to take on definitely automated requests. - */ - sbfm_definitely_automated?: 'allow' | 'block' | 'managed_challenge'; - - /** - * Super Bot Fight Mode (SBFM) action to take on likely automated requests. - */ - sbfm_likely_automated?: 'allow' | 'block' | 'managed_challenge'; - - /** - * Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if - * static resources on your application need bot protection. Note: Static resource - * protection can also result in legitimate traffic being blocked. - */ - sbfm_static_resource_protection?: boolean; - - /** - * Super Bot Fight Mode (SBFM) action to take on verified bots requests. - */ - sbfm_verified_bots?: 'allow' | 'block'; - - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } - - export interface BotManagementBmSubscriptionConfig { - /** - * Automatically update to the newest bot detection models created by Cloudflare as - * they are released. - * [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes) - */ - auto_update_model?: boolean; - - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; +export interface BotFightModeConfiguration { + /** + * Use lightweight, invisible JavaScript detections to improve Bot Management. + * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). + */ + enable_js?: boolean; - /** - * Whether to disable tracking the highest bot score for a session in the Bot - * Management cookie. - */ - suppress_session_score?: boolean; + /** + * Whether to enable Bot Fight Mode. + */ + fight_mode?: boolean; - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } + /** + * A read-only field that indicates whether the zone currently is running the + * latest ML model. + */ + using_latest_model?: boolean; } -export type BotManagementGetResponse = - | BotManagementGetResponse.BotManagementBotFightModeConfig - | BotManagementGetResponse.BotManagementSbfmDefinitelyConfig - | BotManagementGetResponse.BotManagementSbfmLikelyConfig - | BotManagementGetResponse.BotManagementBmSubscriptionConfig; - -export namespace BotManagementGetResponse { - export interface BotManagementBotFightModeConfig { - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; - - /** - * Whether to enable Bot Fight Mode. - */ - fight_mode?: boolean; +export interface SubscriptionConfiguration { + /** + * Automatically update to the newest bot detection models created by Cloudflare as + * they are released. + * [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes) + */ + auto_update_model?: boolean; - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } + /** + * Use lightweight, invisible JavaScript detections to improve Bot Management. + * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). + */ + enable_js?: boolean; - export interface BotManagementSbfmDefinitelyConfig { - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; + /** + * Whether to disable tracking the highest bot score for a session in the Bot + * Management cookie. + */ + suppress_session_score?: boolean; - /** - * Whether to optimize Super Bot Fight Mode protections for Wordpress. - */ - optimize_wordpress?: boolean; + /** + * A read-only field that indicates whether the zone currently is running the + * latest ML model. + */ + using_latest_model?: boolean; +} - /** - * Super Bot Fight Mode (SBFM) action to take on definitely automated requests. - */ - sbfm_definitely_automated?: 'allow' | 'block' | 'managed_challenge'; +export interface SuperBotFightModeDefinitelyConfiguration { + /** + * Use lightweight, invisible JavaScript detections to improve Bot Management. + * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). + */ + enable_js?: boolean; - /** - * Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if - * static resources on your application need bot protection. Note: Static resource - * protection can also result in legitimate traffic being blocked. - */ - sbfm_static_resource_protection?: boolean; + /** + * Whether to optimize Super Bot Fight Mode protections for Wordpress. + */ + optimize_wordpress?: boolean; - /** - * Super Bot Fight Mode (SBFM) action to take on verified bots requests. - */ - sbfm_verified_bots?: 'allow' | 'block'; + /** + * Super Bot Fight Mode (SBFM) action to take on definitely automated requests. + */ + sbfm_definitely_automated?: 'allow' | 'block' | 'managed_challenge'; - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } + /** + * Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if + * static resources on your application need bot protection. Note: Static resource + * protection can also result in legitimate traffic being blocked. + */ + sbfm_static_resource_protection?: boolean; - export interface BotManagementSbfmLikelyConfig { - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; + /** + * Super Bot Fight Mode (SBFM) action to take on verified bots requests. + */ + sbfm_verified_bots?: 'allow' | 'block'; - /** - * Whether to optimize Super Bot Fight Mode protections for Wordpress. - */ - optimize_wordpress?: boolean; + /** + * A read-only field that indicates whether the zone currently is running the + * latest ML model. + */ + using_latest_model?: boolean; +} - /** - * Super Bot Fight Mode (SBFM) action to take on definitely automated requests. - */ - sbfm_definitely_automated?: 'allow' | 'block' | 'managed_challenge'; +export interface SuperBotFightModeLikelyConfiguration { + /** + * Use lightweight, invisible JavaScript detections to improve Bot Management. + * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). + */ + enable_js?: boolean; - /** - * Super Bot Fight Mode (SBFM) action to take on likely automated requests. - */ - sbfm_likely_automated?: 'allow' | 'block' | 'managed_challenge'; + /** + * Whether to optimize Super Bot Fight Mode protections for Wordpress. + */ + optimize_wordpress?: boolean; - /** - * Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if - * static resources on your application need bot protection. Note: Static resource - * protection can also result in legitimate traffic being blocked. - */ - sbfm_static_resource_protection?: boolean; + /** + * Super Bot Fight Mode (SBFM) action to take on definitely automated requests. + */ + sbfm_definitely_automated?: 'allow' | 'block' | 'managed_challenge'; - /** - * Super Bot Fight Mode (SBFM) action to take on verified bots requests. - */ - sbfm_verified_bots?: 'allow' | 'block'; + /** + * Super Bot Fight Mode (SBFM) action to take on likely automated requests. + */ + sbfm_likely_automated?: 'allow' | 'block' | 'managed_challenge'; - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } + /** + * Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if + * static resources on your application need bot protection. Note: Static resource + * protection can also result in legitimate traffic being blocked. + */ + sbfm_static_resource_protection?: boolean; - export interface BotManagementBmSubscriptionConfig { - /** - * Automatically update to the newest bot detection models created by Cloudflare as - * they are released. - * [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes) - */ - auto_update_model?: boolean; + /** + * Super Bot Fight Mode (SBFM) action to take on verified bots requests. + */ + sbfm_verified_bots?: 'allow' | 'block'; - /** - * Use lightweight, invisible JavaScript detections to improve Bot Management. - * [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - */ - enable_js?: boolean; + /** + * A read-only field that indicates whether the zone currently is running the + * latest ML model. + */ + using_latest_model?: boolean; +} - /** - * Whether to disable tracking the highest bot score for a session in the Bot - * Management cookie. - */ - suppress_session_score?: boolean; +export type BotManagementUpdateResponse = + | BotFightModeConfiguration + | SuperBotFightModeDefinitelyConfiguration + | SuperBotFightModeLikelyConfiguration + | SubscriptionConfiguration; - /** - * A read-only field that indicates whether the zone currently is running the - * latest ML model. - */ - using_latest_model?: boolean; - } -} +export type BotManagementGetResponse = + | BotFightModeConfiguration + | SuperBotFightModeDefinitelyConfiguration + | SuperBotFightModeLikelyConfiguration + | SubscriptionConfiguration; export type BotManagementUpdateParams = - | BotManagementUpdateParams.BotManagementBotFightModeConfig - | BotManagementUpdateParams.BotManagementSbfmDefinitelyConfig - | BotManagementUpdateParams.BotManagementSbfmLikelyConfig - | BotManagementUpdateParams.BotManagementBmSubscriptionConfig; + | BotManagementUpdateParams.BotFightModeConfiguration + | BotManagementUpdateParams.SuperBotFightModeDefinitelyConfiguration + | BotManagementUpdateParams.SuperBotFightModeLikelyConfiguration + | BotManagementUpdateParams.SubscriptionConfiguration; export namespace BotManagementUpdateParams { - export interface BotManagementBotFightModeConfig { + export interface BotFightModeConfiguration { /** * Path param: Identifier */ @@ -333,7 +205,7 @@ export namespace BotManagementUpdateParams { fight_mode?: boolean; } - export interface BotManagementSbfmDefinitelyConfig { + export interface SuperBotFightModeDefinitelyConfiguration { /** * Path param: Identifier */ @@ -371,7 +243,7 @@ export namespace BotManagementUpdateParams { sbfm_verified_bots?: 'allow' | 'block'; } - export interface BotManagementSbfmLikelyConfig { + export interface SuperBotFightModeLikelyConfiguration { /** * Path param: Identifier */ @@ -415,7 +287,7 @@ export namespace BotManagementUpdateParams { sbfm_verified_bots?: 'allow' | 'block'; } - export interface BotManagementBmSubscriptionConfig { + export interface SubscriptionConfiguration { /** * Path param: Identifier */ @@ -449,10 +321,3 @@ export interface BotManagementGetParams { */ zone_id: string; } - -export namespace BotManagement { - export import BotManagementUpdateResponse = BotManagementAPI.BotManagementUpdateResponse; - export import BotManagementGetResponse = BotManagementAPI.BotManagementGetResponse; - export import BotManagementUpdateParams = BotManagementAPI.BotManagementUpdateParams; - export import BotManagementGetParams = BotManagementAPI.BotManagementGetParams; -} diff --git a/src/resources/brand-protection.ts b/src/resources/brand-protection.ts index 1beb172308..7da5f528d2 100644 --- a/src/resources/brand-protection.ts +++ b/src/resources/brand-protection.ts @@ -2,63 +2,56 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as BrandProtectionAPI from 'cloudflare/resources/brand-protection'; export class BrandProtection extends APIResource { /** * Submit suspicious URL for scanning */ - submit( - params: BrandProtectionSubmitParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + submit(params: BrandProtectionSubmitParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/brand-protection/submit`, { body, ...options, - }) as Core.APIPromise<{ result: IntelPhishingURLSubmit }> + }) as Core.APIPromise<{ result: Submit }> )._thenUnwrap((obj) => obj.result); } /** * Get results for a URL scan */ - urlInfo( - params: BrandProtectionURLInfoParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + urlInfo(params: BrandProtectionURLInfoParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...query } = params; return ( this._client.get(`/accounts/${account_id}/brand-protection/url-info`, { query, ...options, - }) as Core.APIPromise<{ result: IntelPhishingURLInfo }> + }) as Core.APIPromise<{ result: Info }> )._thenUnwrap((obj) => obj.result); } } -export interface IntelPhishingURLInfo { +export interface Info { /** * List of categorizations applied to this submission. */ - categorizations?: Array; + categorizations?: Array; /** * List of model results for completed scans. */ - model_results?: Array; + model_results?: Array; /** * List of signatures that matched against site content found when crawling the * URL. */ - rule_matches?: Array; + rule_matches?: Array; /** * Status of the most recent scan found. */ - scan_status?: IntelPhishingURLInfo.ScanStatus; + scan_status?: ScanStatus; /** * For internal use. @@ -76,7 +69,7 @@ export interface IntelPhishingURLInfo { url?: string; } -export namespace IntelPhishingURLInfo { +export namespace Info { export interface Categorization { /** * Name of the category applied. @@ -88,86 +81,74 @@ export namespace IntelPhishingURLInfo { */ verification_status?: string; } +} - export interface ModelResult { - /** - * Name of the model. - */ - model_name?: string; - - /** - * Score output by the model for this submission. - */ - model_score?: number; - } - - export interface RuleMatch { - /** - * For internal use. - */ - banning?: boolean; +export interface RuleMatch { + /** + * For internal use. + */ + banning?: boolean; - /** - * For internal use. - */ - blocking?: boolean; + /** + * For internal use. + */ + blocking?: boolean; - /** - * Description of the signature that matched. - */ - description?: string; + /** + * Description of the signature that matched. + */ + description?: string; - /** - * Name of the signature that matched. - */ - name?: string; - } + /** + * Name of the signature that matched. + */ + name?: string; +} +/** + * Status of the most recent scan found. + */ +export interface ScanStatus { /** - * Status of the most recent scan found. + * Timestamp of when the submission was processed. */ - export interface ScanStatus { - /** - * Timestamp of when the submission was processed. - */ - last_processed?: string; + last_processed?: string; - /** - * For internal use. - */ - scan_complete?: boolean; + /** + * For internal use. + */ + scan_complete?: boolean; - /** - * Status code that the crawler received when loading the submitted URL. - */ - status_code?: number; + /** + * Status code that the crawler received when loading the submitted URL. + */ + status_code?: number; - /** - * ID of the most recent submission. - */ - submission_id?: number; - } + /** + * ID of the most recent submission. + */ + submission_id?: number; } -export interface IntelPhishingURLSubmit { +export interface Submit { /** * URLs that were excluded from scanning because their domain is in our no-scan * list. */ - excluded_urls?: Array; + excluded_urls?: Array; /** * URLs that were skipped because the same URL is currently being scanned */ - skipped_urls?: Array; + skipped_urls?: Array; /** * URLs that were successfully submitted for scanning. */ - submitted_urls?: Array; + submitted_urls?: Array; } -export namespace IntelPhishingURLSubmit { +export namespace Submit { export interface ExcludedURL { /** * URL that was excluded. @@ -200,6 +181,18 @@ export namespace IntelPhishingURLSubmit { } } +export interface URLInfoModelResults { + /** + * Name of the model. + */ + model_name?: string; + + /** + * Score output by the model for this submission. + */ + model_score?: number; +} + export interface BrandProtectionSubmitParams { /** * Path param: Identifier @@ -237,10 +230,3 @@ export namespace BrandProtectionURLInfoParams { url_id?: number; } } - -export namespace BrandProtection { - export import IntelPhishingURLInfo = BrandProtectionAPI.IntelPhishingURLInfo; - export import IntelPhishingURLSubmit = BrandProtectionAPI.IntelPhishingURLSubmit; - export import BrandProtectionSubmitParams = BrandProtectionAPI.BrandProtectionSubmitParams; - export import BrandProtectionURLInfoParams = BrandProtectionAPI.BrandProtectionURLInfoParams; -} diff --git a/src/resources/cache/cache-reserve.ts b/src/resources/cache/cache-reserve.ts index a23081efe8..0abee5e9cb 100644 --- a/src/resources/cache/cache-reserve.ts +++ b/src/resources/cache/cache-reserve.ts @@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as CacheReserveAPI from 'cloudflare/resources/cache/cache-reserve'; -export class CacheReserve extends APIResource { +export class CacheReserveResource extends APIResource { /** * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first * disable Cache Reserve. In most cases, this will be accomplished within 24 hours. @@ -15,11 +15,12 @@ export class CacheReserve extends APIResource { params: CacheReserveClearParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { zone_id } = params; + const { zone_id, body } = params; return ( - this._client.post(`/zones/${zone_id}/cache/cache_reserve_clear`, options) as Core.APIPromise<{ - result: CacheReserveClearResponse; - }> + this._client.post(`/zones/${zone_id}/cache/cache_reserve_clear`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: CacheReserveClearResponse }> )._thenUnwrap((obj) => obj.result); } @@ -82,6 +83,16 @@ export class CacheReserve extends APIResource { } } +/** + * ID of the zone setting. + */ +export type CacheReserve = 'cache_reserve'; + +/** + * ID of the zone setting. + */ +export type CacheReserveClear = 'cache_reserve_clear'; + /** * You can use Cache Reserve Clear to clear your Cache Reserve, but you must first * disable Cache Reserve. In most cases, this will be accomplished within 24 hours. @@ -92,7 +103,7 @@ export interface CacheReserveClearResponse { /** * ID of the zone setting. */ - id: 'cache_reserve_clear'; + id: CacheReserveClear; /** * last time this setting was modified. @@ -127,7 +138,7 @@ export interface CacheReserveEditResponse { /** * ID of the zone setting. */ - id: 'cache_reserve'; + id: CacheReserve; /** * last time this setting was modified. @@ -152,7 +163,7 @@ export interface CacheReserveGetResponse { /** * ID of the zone setting. */ - id: 'cache_reserve'; + id: CacheReserve; /** * last time this setting was modified. @@ -175,7 +186,7 @@ export interface CacheReserveStatusResponse { /** * ID of the zone setting. */ - id: 'cache_reserve_clear'; + id: CacheReserveClear; /** * last time this setting was modified. @@ -200,9 +211,14 @@ export interface CacheReserveStatusResponse { export interface CacheReserveClearParams { /** - * Identifier + * Path param: Identifier */ zone_id: string; + + /** + * Body param: + */ + body: unknown; } export interface CacheReserveEditParams { @@ -231,7 +247,9 @@ export interface CacheReserveStatusParams { zone_id: string; } -export namespace CacheReserve { +export namespace CacheReserveResource { + export import CacheReserve = CacheReserveAPI.CacheReserve; + export import CacheReserveClear = CacheReserveAPI.CacheReserveClear; export import CacheReserveClearResponse = CacheReserveAPI.CacheReserveClearResponse; export import CacheReserveEditResponse = CacheReserveAPI.CacheReserveEditResponse; export import CacheReserveGetResponse = CacheReserveAPI.CacheReserveGetResponse; diff --git a/src/resources/cache/cache.ts b/src/resources/cache/cache.ts index 975fa39309..a6ade3c6e3 100644 --- a/src/resources/cache/cache.ts +++ b/src/resources/cache/cache.ts @@ -2,20 +2,19 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as CacheAPI from 'cloudflare/resources/cache/cache'; import * as CacheReserveAPI from 'cloudflare/resources/cache/cache-reserve'; import * as RegionalTieredCacheAPI from 'cloudflare/resources/cache/regional-tiered-cache'; import * as SmartTieredCacheAPI from 'cloudflare/resources/cache/smart-tiered-cache'; import * as VariantsAPI from 'cloudflare/resources/cache/variants'; export class Cache extends APIResource { - cacheReserve: CacheReserveAPI.CacheReserve = new CacheReserveAPI.CacheReserve(this._client); + cacheReserve: CacheReserveAPI.CacheReserveResource = new CacheReserveAPI.CacheReserveResource(this._client); smartTieredCache: SmartTieredCacheAPI.SmartTieredCache = new SmartTieredCacheAPI.SmartTieredCache( this._client, ); variants: VariantsAPI.Variants = new VariantsAPI.Variants(this._client); - regionalTieredCache: RegionalTieredCacheAPI.RegionalTieredCache = - new RegionalTieredCacheAPI.RegionalTieredCache(this._client); + regionalTieredCache: RegionalTieredCacheAPI.RegionalTieredCacheResource = + new RegionalTieredCacheAPI.RegionalTieredCacheResource(this._client); /** * ### Purge All Cached Content @@ -34,7 +33,9 @@ export class Cache extends APIResource { * * **NB:** When including the Origin header, be sure to include the **scheme** and * **hostname**. The port number can be omitted if it is the default port (80 for - * http, 443 for https), but must be included otherwise. + * http, 443 for https), but must be included otherwise. **NB:** For Zones on + * Free/Pro/Business plan, you may purge up to 30 URLs in one API call. For Zones + * on Enterprise plan, you may purge up to 500 URLs in one API call. * * ### Purge Cached Content by Tag, Host or Prefix * @@ -142,9 +143,9 @@ export namespace CachePurgeParams { } export namespace Cache { - export import CachePurgeResponse = CacheAPI.CachePurgeResponse; - export import CachePurgeParams = CacheAPI.CachePurgeParams; + export import CacheReserveResource = CacheReserveAPI.CacheReserveResource; export import CacheReserve = CacheReserveAPI.CacheReserve; + export import CacheReserveClear = CacheReserveAPI.CacheReserveClear; export import CacheReserveClearResponse = CacheReserveAPI.CacheReserveClearResponse; export import CacheReserveEditResponse = CacheReserveAPI.CacheReserveEditResponse; export import CacheReserveGetResponse = CacheReserveAPI.CacheReserveGetResponse; @@ -161,12 +162,14 @@ export namespace Cache { export import SmartTieredCacheEditParams = SmartTieredCacheAPI.SmartTieredCacheEditParams; export import SmartTieredCacheGetParams = SmartTieredCacheAPI.SmartTieredCacheGetParams; export import Variants = VariantsAPI.Variants; - export import CacheVariants = VariantsAPI.CacheVariants; + export import CacheVariant = VariantsAPI.CacheVariant; + export import CacheVariantIdentifier = VariantsAPI.CacheVariantIdentifier; export import VariantEditResponse = VariantsAPI.VariantEditResponse; export import VariantGetResponse = VariantsAPI.VariantGetResponse; export import VariantDeleteParams = VariantsAPI.VariantDeleteParams; export import VariantEditParams = VariantsAPI.VariantEditParams; export import VariantGetParams = VariantsAPI.VariantGetParams; + export import RegionalTieredCacheResource = RegionalTieredCacheAPI.RegionalTieredCacheResource; export import RegionalTieredCache = RegionalTieredCacheAPI.RegionalTieredCache; export import RegionalTieredCacheEditResponse = RegionalTieredCacheAPI.RegionalTieredCacheEditResponse; export import RegionalTieredCacheGetResponse = RegionalTieredCacheAPI.RegionalTieredCacheGetResponse; diff --git a/src/resources/cache/index.ts b/src/resources/cache/index.ts index 3a23f42b2c..480f548d6e 100644 --- a/src/resources/cache/index.ts +++ b/src/resources/cache/index.ts @@ -1,7 +1,9 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { CachePurgeResponse, CachePurgeParams, Cache } from './cache'; +export { Cache } from './cache'; export { + CacheReserve, + CacheReserveClear, CacheReserveClearResponse, CacheReserveEditResponse, CacheReserveGetResponse, @@ -10,10 +12,11 @@ export { CacheReserveEditParams, CacheReserveGetParams, CacheReserveStatusParams, - CacheReserve, + CacheReserveResource, } from './cache-reserve'; export { - CacheVariants, + CacheVariant, + CacheVariantIdentifier, VariantEditResponse, VariantGetResponse, VariantDeleteParams, @@ -22,11 +25,12 @@ export { Variants, } from './variants'; export { + RegionalTieredCache, RegionalTieredCacheEditResponse, RegionalTieredCacheGetResponse, RegionalTieredCacheEditParams, RegionalTieredCacheGetParams, - RegionalTieredCache, + RegionalTieredCacheResource, } from './regional-tiered-cache'; export { SmartTieredCacheDeleteResponse, diff --git a/src/resources/cache/regional-tiered-cache.ts b/src/resources/cache/regional-tiered-cache.ts index cdafd97b64..2bef99f31b 100644 --- a/src/resources/cache/regional-tiered-cache.ts +++ b/src/resources/cache/regional-tiered-cache.ts @@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as RegionalTieredCacheAPI from 'cloudflare/resources/cache/regional-tiered-cache'; -export class RegionalTieredCache extends APIResource { +export class RegionalTieredCacheResource extends APIResource { /** * Instructs Cloudflare to check a regional hub data center on the way to your * upper tier. This can help improve performance for smart and custom tiered cache @@ -41,6 +41,11 @@ export class RegionalTieredCache extends APIResource { } } +/** + * ID of the zone setting. + */ +export type RegionalTieredCache = 'tc_regional'; + /** * Instructs Cloudflare to check a regional hub data center on the way to your * upper tier. This can help improve performance for smart and custom tiered cache @@ -50,7 +55,7 @@ export interface RegionalTieredCacheEditResponse { /** * ID of the zone setting. */ - id: 'tc_regional'; + id: RegionalTieredCache; /** * last time this setting was modified. @@ -75,7 +80,7 @@ export namespace RegionalTieredCacheEditResponse { /** * ID of the zone setting. */ - id: 'tc_regional'; + id: RegionalTieredCacheAPI.RegionalTieredCache; /** * last time this setting was modified. @@ -93,7 +98,7 @@ export interface RegionalTieredCacheGetResponse { /** * ID of the zone setting. */ - id: 'tc_regional'; + id: RegionalTieredCache; /** * last time this setting was modified. @@ -118,7 +123,7 @@ export namespace RegionalTieredCacheGetResponse { /** * ID of the zone setting. */ - id: 'tc_regional'; + id: RegionalTieredCacheAPI.RegionalTieredCache; /** * last time this setting was modified. @@ -146,7 +151,8 @@ export interface RegionalTieredCacheGetParams { zone_id: string; } -export namespace RegionalTieredCache { +export namespace RegionalTieredCacheResource { + export import RegionalTieredCache = RegionalTieredCacheAPI.RegionalTieredCache; export import RegionalTieredCacheEditResponse = RegionalTieredCacheAPI.RegionalTieredCacheEditResponse; export import RegionalTieredCacheGetResponse = RegionalTieredCacheAPI.RegionalTieredCacheGetResponse; export import RegionalTieredCacheEditParams = RegionalTieredCacheAPI.RegionalTieredCacheEditParams; diff --git a/src/resources/cache/smart-tiered-cache.ts b/src/resources/cache/smart-tiered-cache.ts index fe6a1f6b9d..6181c2fc72 100644 --- a/src/resources/cache/smart-tiered-cache.ts +++ b/src/resources/cache/smart-tiered-cache.ts @@ -12,12 +12,12 @@ export class SmartTieredCache extends APIResource { params: SmartTieredCacheDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { - const { zone_id } = params; + const { zone_id, body } = params; return ( - this._client.delete( - `/zones/${zone_id}/cache/tiered_cache_smart_topology_enable`, - options, - ) as Core.APIPromise<{ result: SmartTieredCacheDeleteResponse }> + this._client.delete(`/zones/${zone_id}/cache/tiered_cache_smart_topology_enable`, { + body: body, + ...options, + }) as Core.APIPromise<{ result: SmartTieredCacheDeleteResponse }> )._thenUnwrap((obj) => obj.result); } @@ -62,9 +62,14 @@ export type SmartTieredCacheGetResponse = unknown | string | null; export interface SmartTieredCacheDeleteParams { /** - * Identifier + * Path param: Identifier */ zone_id: string; + + /** + * Body param: + */ + body: unknown; } export interface SmartTieredCacheEditParams { diff --git a/src/resources/cache/variants.ts b/src/resources/cache/variants.ts index 4a657f8b2a..9091c57c95 100644 --- a/src/resources/cache/variants.ts +++ b/src/resources/cache/variants.ts @@ -12,11 +12,11 @@ export class Variants extends APIResource { * does not serve the variant requested, the response will not be cached. This will * be indicated with BYPASS cache status in the response headers. */ - delete(params: VariantDeleteParams, options?: Core.RequestOptions): Core.APIPromise { - const { zone_id } = params; + delete(params: VariantDeleteParams, options?: Core.RequestOptions): Core.APIPromise { + const { zone_id, body } = params; return ( - this._client.delete(`/zones/${zone_id}/cache/variants`, options) as Core.APIPromise<{ - result: CacheVariants; + this._client.delete(`/zones/${zone_id}/cache/variants`, { body: body, ...options }) as Core.APIPromise<{ + result: CacheVariant; }> )._thenUnwrap((obj) => obj.result); } @@ -61,11 +61,11 @@ export class Variants extends APIResource { * does not serve the variant requested, the response will not be cached. This will * be indicated with BYPASS cache status in the response headers. */ -export interface CacheVariants { +export interface CacheVariant { /** * ID of the zone setting. */ - id: 'variants'; + id: CacheVariantIdentifier; /** * last time this setting was modified. @@ -73,6 +73,11 @@ export interface CacheVariants { modified_on: string | null; } +/** + * ID of the zone setting. + */ +export type CacheVariantIdentifier = 'variants'; + /** * Variant support enables caching variants of images with certain file extensions * in addition to the original. This only applies when the origin server sends the @@ -84,7 +89,7 @@ export interface VariantEditResponse { /** * ID of the zone setting. */ - id: 'variants'; + id: CacheVariantIdentifier; /** * last time this setting was modified. @@ -106,67 +111,67 @@ export namespace VariantEditResponse { * List of strings with the MIME types of all the variants that should be served * for avif. */ - avif?: Array; + avif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for bmp. */ - bmp?: Array; + bmp?: Array; /** * List of strings with the MIME types of all the variants that should be served * for gif. */ - gif?: Array; + gif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jp2. */ - jp2?: Array; + jp2?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpeg. */ - jpeg?: Array; + jpeg?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpg. */ - jpg?: Array; + jpg?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpg2. */ - jpg2?: Array; + jpg2?: Array; /** * List of strings with the MIME types of all the variants that should be served * for png. */ - png?: Array; + png?: Array; /** * List of strings with the MIME types of all the variants that should be served * for tif. */ - tif?: Array; + tif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for tiff. */ - tiff?: Array; + tiff?: Array; /** * List of strings with the MIME types of all the variants that should be served * for webp. */ - webp?: Array; + webp?: Array; } } @@ -181,7 +186,7 @@ export interface VariantGetResponse { /** * ID of the zone setting. */ - id: 'variants'; + id: CacheVariantIdentifier; /** * last time this setting was modified. @@ -203,75 +208,80 @@ export namespace VariantGetResponse { * List of strings with the MIME types of all the variants that should be served * for avif. */ - avif?: Array; + avif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for bmp. */ - bmp?: Array; + bmp?: Array; /** * List of strings with the MIME types of all the variants that should be served * for gif. */ - gif?: Array; + gif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jp2. */ - jp2?: Array; + jp2?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpeg. */ - jpeg?: Array; + jpeg?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpg. */ - jpg?: Array; + jpg?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpg2. */ - jpg2?: Array; + jpg2?: Array; /** * List of strings with the MIME types of all the variants that should be served * for png. */ - png?: Array; + png?: Array; /** * List of strings with the MIME types of all the variants that should be served * for tif. */ - tif?: Array; + tif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for tiff. */ - tiff?: Array; + tiff?: Array; /** * List of strings with the MIME types of all the variants that should be served * for webp. */ - webp?: Array; + webp?: Array; } } export interface VariantDeleteParams { /** - * Identifier + * Path param: Identifier */ zone_id: string; + + /** + * Body param: + */ + body: unknown; } export interface VariantEditParams { @@ -295,67 +305,67 @@ export namespace VariantEditParams { * List of strings with the MIME types of all the variants that should be served * for avif. */ - avif?: Array; + avif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for bmp. */ - bmp?: Array; + bmp?: Array; /** * List of strings with the MIME types of all the variants that should be served * for gif. */ - gif?: Array; + gif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jp2. */ - jp2?: Array; + jp2?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpeg. */ - jpeg?: Array; + jpeg?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpg. */ - jpg?: Array; + jpg?: Array; /** * List of strings with the MIME types of all the variants that should be served * for jpg2. */ - jpg2?: Array; + jpg2?: Array; /** * List of strings with the MIME types of all the variants that should be served * for png. */ - png?: Array; + png?: Array; /** * List of strings with the MIME types of all the variants that should be served * for tif. */ - tif?: Array; + tif?: Array; /** * List of strings with the MIME types of all the variants that should be served * for tiff. */ - tiff?: Array; + tiff?: Array; /** * List of strings with the MIME types of all the variants that should be served * for webp. */ - webp?: Array; + webp?: Array; } } @@ -367,7 +377,8 @@ export interface VariantGetParams { } export namespace Variants { - export import CacheVariants = VariantsAPI.CacheVariants; + export import CacheVariant = VariantsAPI.CacheVariant; + export import CacheVariantIdentifier = VariantsAPI.CacheVariantIdentifier; export import VariantEditResponse = VariantsAPI.VariantEditResponse; export import VariantGetResponse = VariantsAPI.VariantGetResponse; export import VariantDeleteParams = VariantsAPI.VariantDeleteParams; diff --git a/src/resources/calls.ts b/src/resources/calls.ts index 373dce3bb5..0d638360ad 100644 --- a/src/resources/calls.ts +++ b/src/resources/calls.ts @@ -2,7 +2,6 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as CallsAPI from 'cloudflare/resources/calls'; import { SinglePage } from 'cloudflare/pagination'; export class Calls extends APIResource { @@ -163,14 +162,3 @@ export interface CallGetParams { */ account_id: string; } - -export namespace Calls { - export import CallsApp = CallsAPI.CallsApp; - export import CallsAppWithSecret = CallsAPI.CallsAppWithSecret; - export import CallsAppsSinglePage = CallsAPI.CallsAppsSinglePage; - export import CallCreateParams = CallsAPI.CallCreateParams; - export import CallUpdateParams = CallsAPI.CallUpdateParams; - export import CallListParams = CallsAPI.CallListParams; - export import CallDeleteParams = CallsAPI.CallDeleteParams; - export import CallGetParams = CallsAPI.CallGetParams; -} diff --git a/src/resources/certificate-authorities/certificate-authorities.ts b/src/resources/certificate-authorities/certificate-authorities.ts index fe8a058f1e..e5f52f3caa 100644 --- a/src/resources/certificate-authorities/certificate-authorities.ts +++ b/src/resources/certificate-authorities/certificate-authorities.ts @@ -10,7 +10,10 @@ export class CertificateAuthorities extends APIResource { export namespace CertificateAuthorities { export import HostnameAssociations = HostnameAssociationsAPI.HostnameAssociations; + export import HostnameAssociation = HostnameAssociationsAPI.HostnameAssociation; export import TLSHostnameAssociation = HostnameAssociationsAPI.TLSHostnameAssociation; + export import HostnameAssociationUpdateResponse = HostnameAssociationsAPI.HostnameAssociationUpdateResponse; + export import HostnameAssociationGetResponse = HostnameAssociationsAPI.HostnameAssociationGetResponse; export import HostnameAssociationUpdateParams = HostnameAssociationsAPI.HostnameAssociationUpdateParams; export import HostnameAssociationGetParams = HostnameAssociationsAPI.HostnameAssociationGetParams; } diff --git a/src/resources/certificate-authorities/hostname-associations.ts b/src/resources/certificate-authorities/hostname-associations.ts index 9b76ebc5fc..ac5bd7a641 100644 --- a/src/resources/certificate-authorities/hostname-associations.ts +++ b/src/resources/certificate-authorities/hostname-associations.ts @@ -11,13 +11,13 @@ export class HostnameAssociations extends APIResource { update( params: HostnameAssociationUpdateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { zone_id, ...body } = params; return ( this._client.put(`/zones/${zone_id}/certificate_authorities/hostname_associations`, { body, ...options, - }) as Core.APIPromise<{ result: TLSHostnameAssociation }> + }) as Core.APIPromise<{ result: HostnameAssociationUpdateResponse }> )._thenUnwrap((obj) => obj.result); } @@ -27,19 +27,21 @@ export class HostnameAssociations extends APIResource { get( params: HostnameAssociationGetParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { zone_id, ...query } = params; return ( this._client.get(`/zones/${zone_id}/certificate_authorities/hostname_associations`, { query, ...options, - }) as Core.APIPromise<{ result: TLSHostnameAssociation }> + }) as Core.APIPromise<{ result: HostnameAssociationGetResponse }> )._thenUnwrap((obj) => obj.result); } } +export type HostnameAssociation = string; + export interface TLSHostnameAssociation { - hostnames?: Array; + hostnames?: Array; /** * The UUID for a certificate that was uploaded to the mTLS Certificate Management @@ -49,6 +51,14 @@ export interface TLSHostnameAssociation { mtls_certificate_id?: string; } +export interface HostnameAssociationUpdateResponse { + hostnames?: Array; +} + +export interface HostnameAssociationGetResponse { + hostnames?: Array; +} + export interface HostnameAssociationUpdateParams { /** * Path param: Identifier @@ -58,7 +68,7 @@ export interface HostnameAssociationUpdateParams { /** * Body param: */ - hostnames?: Array; + hostnames?: Array; /** * Body param: The UUID for a certificate that was uploaded to the mTLS Certificate @@ -84,7 +94,10 @@ export interface HostnameAssociationGetParams { } export namespace HostnameAssociations { + export import HostnameAssociation = HostnameAssociationsAPI.HostnameAssociation; export import TLSHostnameAssociation = HostnameAssociationsAPI.TLSHostnameAssociation; + export import HostnameAssociationUpdateResponse = HostnameAssociationsAPI.HostnameAssociationUpdateResponse; + export import HostnameAssociationGetResponse = HostnameAssociationsAPI.HostnameAssociationGetResponse; export import HostnameAssociationUpdateParams = HostnameAssociationsAPI.HostnameAssociationUpdateParams; export import HostnameAssociationGetParams = HostnameAssociationsAPI.HostnameAssociationGetParams; } diff --git a/src/resources/certificate-authorities/index.ts b/src/resources/certificate-authorities/index.ts index 2d3fc925a1..e84e9da00c 100644 --- a/src/resources/certificate-authorities/index.ts +++ b/src/resources/certificate-authorities/index.ts @@ -2,7 +2,10 @@ export { CertificateAuthorities } from './certificate-authorities'; export { + HostnameAssociation, TLSHostnameAssociation, + HostnameAssociationUpdateResponse, + HostnameAssociationGetResponse, HostnameAssociationUpdateParams, HostnameAssociationGetParams, HostnameAssociations, diff --git a/src/resources/challenges/challenges.ts b/src/resources/challenges/challenges.ts index bf3e168b70..0371c921b7 100644 --- a/src/resources/challenges/challenges.ts +++ b/src/resources/challenges/challenges.ts @@ -9,9 +9,10 @@ export class Challenges extends APIResource { export namespace Challenges { export import Widgets = WidgetsAPI.Widgets; - export import ChallengesWidget = WidgetsAPI.ChallengesWidget; - export import ChallengesWidgetList = WidgetsAPI.ChallengesWidgetList; - export import ChallengesWidgetListsV4PagePaginationArray = WidgetsAPI.ChallengesWidgetListsV4PagePaginationArray; + export import Widget = WidgetsAPI.Widget; + export import WidgetDomain = WidgetsAPI.WidgetDomain; + export import WidgetListResponse = WidgetsAPI.WidgetListResponse; + export import WidgetListResponsesV4PagePaginationArray = WidgetsAPI.WidgetListResponsesV4PagePaginationArray; export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams; export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams; export import WidgetListParams = WidgetsAPI.WidgetListParams; diff --git a/src/resources/challenges/index.ts b/src/resources/challenges/index.ts index e97706cb9f..3b0bf982b7 100644 --- a/src/resources/challenges/index.ts +++ b/src/resources/challenges/index.ts @@ -2,14 +2,15 @@ export { Challenges } from './challenges'; export { - ChallengesWidget, - ChallengesWidgetList, + Widget, + WidgetDomain, + WidgetListResponse, WidgetCreateParams, WidgetUpdateParams, WidgetListParams, WidgetDeleteParams, WidgetGetParams, WidgetRotateSecretParams, - ChallengesWidgetListsV4PagePaginationArray, + WidgetListResponsesV4PagePaginationArray, Widgets, } from './widgets'; diff --git a/src/resources/challenges/widgets.ts b/src/resources/challenges/widgets.ts index bb62f4eff0..ec23613a7b 100644 --- a/src/resources/challenges/widgets.ts +++ b/src/resources/challenges/widgets.ts @@ -9,14 +9,14 @@ export class Widgets extends APIResource { /** * Lists challenge widgets. */ - create(params: WidgetCreateParams, options?: Core.RequestOptions): Core.APIPromise { + create(params: WidgetCreateParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, direction, order, page, per_page, ...body } = params; return ( this._client.post(`/accounts/${account_id}/challenges/widgets`, { query: { direction, order, page, per_page }, body, ...options, - }) as Core.APIPromise<{ result: ChallengesWidget }> + }) as Core.APIPromise<{ result: Widget }> )._thenUnwrap((obj) => obj.result); } @@ -27,13 +27,13 @@ export class Widgets extends APIResource { sitekey: string, params: WidgetUpdateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.put(`/accounts/${account_id}/challenges/widgets/${sitekey}`, { body, ...options, - }) as Core.APIPromise<{ result: ChallengesWidget }> + }) as Core.APIPromise<{ result: Widget }> )._thenUnwrap((obj) => obj.result); } @@ -43,11 +43,11 @@ export class Widgets extends APIResource { list( params: WidgetListParams, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { const { account_id, ...query } = params; return this._client.getAPIList( `/accounts/${account_id}/challenges/widgets`, - ChallengesWidgetListsV4PagePaginationArray, + WidgetListResponsesV4PagePaginationArray, { query, ...options }, ); } @@ -59,28 +59,24 @@ export class Widgets extends APIResource { sitekey: string, params: WidgetDeleteParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id } = params; return ( this._client.delete( `/accounts/${account_id}/challenges/widgets/${sitekey}`, options, - ) as Core.APIPromise<{ result: ChallengesWidget }> + ) as Core.APIPromise<{ result: Widget }> )._thenUnwrap((obj) => obj.result); } /** * Show a single challenge widget configuration. */ - get( - sitekey: string, - params: WidgetGetParams, - options?: Core.RequestOptions, - ): Core.APIPromise { + get(sitekey: string, params: WidgetGetParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id } = params; return ( this._client.get(`/accounts/${account_id}/challenges/widgets/${sitekey}`, options) as Core.APIPromise<{ - result: ChallengesWidget; + result: Widget; }> )._thenUnwrap((obj) => obj.result); } @@ -95,23 +91,23 @@ export class Widgets extends APIResource { sitekey: string, params: WidgetRotateSecretParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/challenges/widgets/${sitekey}/rotate_secret`, { body, ...options, - }) as Core.APIPromise<{ result: ChallengesWidget }> + }) as Core.APIPromise<{ result: Widget }> )._thenUnwrap((obj) => obj.result); } } -export class ChallengesWidgetListsV4PagePaginationArray extends V4PagePaginationArray {} +export class WidgetListResponsesV4PagePaginationArray extends V4PagePaginationArray {} /** * A Turnstile widget's detailed configuration */ -export interface ChallengesWidget { +export interface Widget { /** * If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive * challenges in response to malicious bots (ENT only). @@ -129,7 +125,7 @@ export interface ChallengesWidget { */ created_on: string; - domains: Array; + domains: Array; /** * Widget Mode @@ -169,10 +165,16 @@ export interface ChallengesWidget { sitekey: string; } +/** + * Hosts as a hostname or IPv4/IPv6 address represented by strings. The widget will + * only work on these domains, and their subdomains. + */ +export type WidgetDomain = string; + /** * A Turnstile Widgets configuration as it appears in listings */ -export interface ChallengesWidgetList { +export interface WidgetListResponse { /** * If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive * challenges in response to malicious bots (ENT only). @@ -190,7 +192,7 @@ export interface ChallengesWidgetList { */ created_on: string; - domains: Array; + domains: Array; /** * Widget Mode @@ -234,7 +236,7 @@ export interface WidgetCreateParams { /** * Body param: */ - domains: Array; + domains: Array; /** * Body param: Widget Mode @@ -301,7 +303,7 @@ export interface WidgetUpdateParams { /** * Body param: */ - domains: Array; + domains: Array; /** * Body param: Widget Mode @@ -380,9 +382,10 @@ export interface WidgetRotateSecretParams { } export namespace Widgets { - export import ChallengesWidget = WidgetsAPI.ChallengesWidget; - export import ChallengesWidgetList = WidgetsAPI.ChallengesWidgetList; - export import ChallengesWidgetListsV4PagePaginationArray = WidgetsAPI.ChallengesWidgetListsV4PagePaginationArray; + export import Widget = WidgetsAPI.Widget; + export import WidgetDomain = WidgetsAPI.WidgetDomain; + export import WidgetListResponse = WidgetsAPI.WidgetListResponse; + export import WidgetListResponsesV4PagePaginationArray = WidgetsAPI.WidgetListResponsesV4PagePaginationArray; export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams; export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams; export import WidgetListParams = WidgetsAPI.WidgetListParams; diff --git a/src/resources/client-certificates.ts b/src/resources/client-certificates.ts index b366ed5e73..cb852a4a35 100644 --- a/src/resources/client-certificates.ts +++ b/src/resources/client-certificates.ts @@ -2,7 +2,6 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as ClientCertificatesAPI from 'cloudflare/resources/client-certificates'; import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination'; export class ClientCertificates extends APIResource { @@ -257,13 +256,3 @@ export interface ClientCertificateGetParams { */ zone_id: string; } - -export namespace ClientCertificates { - export import ClientCertificate = ClientCertificatesAPI.ClientCertificate; - export import ClientCertificatesV4PagePaginationArray = ClientCertificatesAPI.ClientCertificatesV4PagePaginationArray; - export import ClientCertificateCreateParams = ClientCertificatesAPI.ClientCertificateCreateParams; - export import ClientCertificateListParams = ClientCertificatesAPI.ClientCertificateListParams; - export import ClientCertificateDeleteParams = ClientCertificatesAPI.ClientCertificateDeleteParams; - export import ClientCertificateEditParams = ClientCertificatesAPI.ClientCertificateEditParams; - export import ClientCertificateGetParams = ClientCertificatesAPI.ClientCertificateGetParams; -} diff --git a/src/resources/cloudforce-one/cloudforce-one.ts b/src/resources/cloudforce-one/cloudforce-one.ts index 74b7476c3a..1d0aef9573 100644 --- a/src/resources/cloudforce-one/cloudforce-one.ts +++ b/src/resources/cloudforce-one/cloudforce-one.ts @@ -9,13 +9,13 @@ export class CloudforceOne extends APIResource { export namespace CloudforceOne { export import Requests = RequestsAPI.Requests; - export import CloudforceOneQuota = RequestsAPI.CloudforceOneQuota; - export import CloudforceOneRequestConstants = RequestsAPI.CloudforceOneRequestConstants; - export import CloudforceOneRequestItem = RequestsAPI.CloudforceOneRequestItem; - export import CloudforceOneRequestListItem = RequestsAPI.CloudforceOneRequestListItem; - export import CloudforceOneRequestTypes = RequestsAPI.CloudforceOneRequestTypes; + export import Item = RequestsAPI.Item; + export import ListItem = RequestsAPI.ListItem; + export import Quota = RequestsAPI.Quota; + export import RequestConstants = RequestsAPI.RequestConstants; + export import RequestTypes = RequestsAPI.RequestTypes; export import RequestDeleteResponse = RequestsAPI.RequestDeleteResponse; - export import CloudforceOneRequestListItemsV4PagePaginationArray = RequestsAPI.CloudforceOneRequestListItemsV4PagePaginationArray; + export import ListItemsV4PagePaginationArray = RequestsAPI.ListItemsV4PagePaginationArray; export import RequestCreateParams = RequestsAPI.RequestCreateParams; export import RequestUpdateParams = RequestsAPI.RequestUpdateParams; export import RequestListParams = RequestsAPI.RequestListParams; diff --git a/src/resources/cloudforce-one/index.ts b/src/resources/cloudforce-one/index.ts index 75970d115f..ffe55bdb29 100644 --- a/src/resources/cloudforce-one/index.ts +++ b/src/resources/cloudforce-one/index.ts @@ -2,15 +2,15 @@ export { CloudforceOne } from './cloudforce-one'; export { - CloudforceOneQuota, - CloudforceOneRequestConstants, - CloudforceOneRequestItem, - CloudforceOneRequestListItem, - CloudforceOneRequestTypes, + Item, + ListItem, + Quota, + RequestConstants, + RequestTypes, RequestDeleteResponse, RequestCreateParams, RequestUpdateParams, RequestListParams, - CloudforceOneRequestListItemsV4PagePaginationArray, + ListItemsV4PagePaginationArray, Requests, } from './requests/index'; diff --git a/src/resources/cloudforce-one/requests/index.ts b/src/resources/cloudforce-one/requests/index.ts index ca62509576..d1a1dac5d8 100644 --- a/src/resources/cloudforce-one/requests/index.ts +++ b/src/resources/cloudforce-one/requests/index.ts @@ -1,31 +1,33 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. export { - CloudforceOnePriorityItem, - PriorityDeleteResponse, - PriorityCreateParams, - PriorityUpdateParams, - Priority, -} from './priority'; -export { - CloudforceOneQuota, - CloudforceOneRequestConstants, - CloudforceOneRequestItem, - CloudforceOneRequestListItem, - CloudforceOneRequestTypes, + Item, + ListItem, + Quota, + RequestConstants, + RequestTypes, RequestDeleteResponse, RequestCreateParams, RequestUpdateParams, RequestListParams, - CloudforceOneRequestListItemsV4PagePaginationArray, + ListItemsV4PagePaginationArray, Requests, } from './requests'; export { - CloudforceOneRequestMessageItem, + Label, + Priority, + PriorityEdit, + PriorityDeleteResponse, + PriorityCreateParams, + PriorityUpdateParams, + PriorityResource, +} from './priority'; +export { + Message, MessageDeleteResponse, MessageGetResponse, MessageCreateParams, MessageUpdateParams, MessageGetParams, - Message, + MessageResource, } from './message'; diff --git a/src/resources/cloudforce-one/requests/message.ts b/src/resources/cloudforce-one/requests/message.ts index 25badd4a6a..22753ec181 100644 --- a/src/resources/cloudforce-one/requests/message.ts +++ b/src/resources/cloudforce-one/requests/message.ts @@ -4,7 +4,7 @@ import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as MessageAPI from 'cloudflare/resources/cloudforce-one/requests/message'; -export class Message extends APIResource { +export class MessageResource extends APIResource { /** * Creating a request adds the request into the Cloudforce One queue for analysis. * In addition to the content, a short title, type, priority, and releasability @@ -15,12 +15,12 @@ export class Message extends APIResource { requestIdentifier: string, body: MessageCreateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { return ( this._client.post( `/accounts/${accountIdentifier}/cloudforce-one/requests/${requestIdentifier}/message/new`, { body, ...options }, - ) as Core.APIPromise<{ result: CloudforceOneRequestMessageItem }> + ) as Core.APIPromise<{ result: Message }> )._thenUnwrap((obj) => obj.result); } @@ -33,12 +33,12 @@ export class Message extends APIResource { messageIdentifer: number, body: MessageUpdateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { return ( this._client.put( `/accounts/${accountIdentifier}/cloudforce-one/requests/${requestIdentifier}/message/${messageIdentifer}`, { body, ...options }, - ) as Core.APIPromise<{ result: CloudforceOneRequestMessageItem }> + ) as Core.APIPromise<{ result: Message }> )._thenUnwrap((obj) => obj.result); } @@ -77,7 +77,7 @@ export class Message extends APIResource { } } -export interface CloudforceOneRequestMessageItem { +export interface Message { /** * Message ID */ @@ -111,7 +111,7 @@ export interface CloudforceOneRequestMessageItem { export type MessageDeleteResponse = unknown | Array | string; -export type MessageGetResponse = Array; +export type MessageGetResponse = Array; export interface MessageCreateParams { /** @@ -179,8 +179,8 @@ export interface MessageGetParams { sort_order?: 'asc' | 'desc'; } -export namespace Message { - export import CloudforceOneRequestMessageItem = MessageAPI.CloudforceOneRequestMessageItem; +export namespace MessageResource { + export import Message = MessageAPI.Message; export import MessageDeleteResponse = MessageAPI.MessageDeleteResponse; export import MessageGetResponse = MessageAPI.MessageGetResponse; export import MessageCreateParams = MessageAPI.MessageCreateParams; diff --git a/src/resources/cloudforce-one/requests/priority.ts b/src/resources/cloudforce-one/requests/priority.ts index b314b0467a..f01a1b698c 100644 --- a/src/resources/cloudforce-one/requests/priority.ts +++ b/src/resources/cloudforce-one/requests/priority.ts @@ -5,7 +5,7 @@ import { APIResource } from 'cloudflare/resource'; import * as PriorityAPI from 'cloudflare/resources/cloudforce-one/requests/priority'; import * as RequestsAPI from 'cloudflare/resources/cloudforce-one/requests/requests'; -export class Priority extends APIResource { +export class PriorityResource extends APIResource { /** * Create a New Priority Requirement */ @@ -13,12 +13,12 @@ export class Priority extends APIResource { accountIdentifier: string, body: PriorityCreateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { return ( this._client.post(`/accounts/${accountIdentifier}/cloudforce-one/requests/priority/new`, { body, ...options, - }) as Core.APIPromise<{ result: CloudforceOnePriorityItem }> + }) as Core.APIPromise<{ result: Priority }> )._thenUnwrap((obj) => obj.result); } @@ -30,12 +30,12 @@ export class Priority extends APIResource { priorityIdentifer: string, body: PriorityUpdateParams, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { return ( this._client.put( `/accounts/${accountIdentifier}/cloudforce-one/requests/priority/${priorityIdentifer}`, { body, ...options }, - ) as Core.APIPromise<{ result: RequestsAPI.CloudforceOneRequestItem }> + ) as Core.APIPromise<{ result: RequestsAPI.Item }> )._thenUnwrap((obj) => obj.result); } @@ -62,32 +62,31 @@ export class Priority extends APIResource { accountIdentifier: string, priorityIdentifer: string, options?: Core.RequestOptions, - ): Core.APIPromise { + ): Core.APIPromise { return ( this._client.get( `/accounts/${accountIdentifier}/cloudforce-one/requests/priority/${priorityIdentifer}`, options, - ) as Core.APIPromise<{ result: RequestsAPI.CloudforceOneRequestItem }> + ) as Core.APIPromise<{ result: RequestsAPI.Item }> )._thenUnwrap((obj) => obj.result); } /** * Get Priority Intelligence Requirement Quota */ - quota( - accountIdentifier: string, - options?: Core.RequestOptions, - ): Core.APIPromise { + quota(accountIdentifier: string, options?: Core.RequestOptions): Core.APIPromise { return ( this._client.get( `/accounts/${accountIdentifier}/cloudforce-one/requests/priority/quota`, options, - ) as Core.APIPromise<{ result: RequestsAPI.CloudforceOneQuota }> + ) as Core.APIPromise<{ result: RequestsAPI.Quota }> )._thenUnwrap((obj) => obj.result); } } -export interface CloudforceOnePriorityItem { +export type Label = string; + +export interface Priority { /** * UUID */ @@ -101,7 +100,7 @@ export interface CloudforceOnePriorityItem { /** * List of labels */ - labels: Array; + labels: Array