From d6c32f08277e0fef9c5f1f7826fac87b10091f0c Mon Sep 17 00:00:00 2001
From: "stainless-app[bot]"
<142633134+stainless-app[bot]@users.noreply.github.com>
Date: Tue, 20 Feb 2024 23:16:18 +0000
Subject: [PATCH] feat: update via SDK Studio (#45)
---
.stats.yml | 2 +-
README.md | 2 +-
api.md | 923 ++--
src/index.ts | 122 +-
src/resources/access/access.ts | 42 +-
.../access/applications/applications.ts | 156 +-
src/resources/access/applications/index.ts | 8 +-
src/resources/access/applications/policies.ts | 3848 ++++++-------
src/resources/access/bookmarks.ts | 88 +-
.../access/certificates/certificates.ts | 98 +-
src/resources/access/certificates/index.ts | 6 +-
src/resources/access/certificates/settings.ts | 52 +-
src/resources/access/custom-pages.ts | 88 +-
src/resources/access/groups.ts | 4792 ++++++++---------
src/resources/access/identity-providers.ts | 410 +-
src/resources/access/index.ts | 38 +-
src/resources/access/keys.ts | 34 +-
src/resources/access/organizations.ts | 58 +-
src/resources/access/seats.ts | 22 +-
src/resources/access/service-tokens.ts | 100 +-
src/resources/access/tags.ts | 74 +-
src/resources/account-members.ts | 202 +-
src/resources/accounts.ts | 58 +-
src/resources/activation-checks.ts | 8 +-
.../addresses/address-maps/accounts.ts | 26 +-
.../addresses/address-maps/address-maps.ts | 134 +-
src/resources/addresses/address-maps/index.ts | 10 +-
src/resources/addresses/address-maps/ips.ts | 26 +-
src/resources/addresses/address-maps/zones.ts | 26 +-
src/resources/addresses/addresses.ts | 8 +-
src/resources/addresses/index.ts | 8 +-
src/resources/addresses/prefixes/bgps/bgps.ts | 4 +-
.../addresses/prefixes/bgps/index.ts | 2 +-
.../addresses/prefixes/bgps/statuses.ts | 16 +-
src/resources/addresses/prefixes/index.ts | 4 +-
src/resources/addresses/prefixes/prefixes.ts | 170 +-
.../addressing/prefixes/bgp-prefixes.ts | 182 +-
src/resources/addressing/prefixes/index.ts | 4 +-
src/resources/addressing/prefixes/prefixes.ts | 4 +-
.../alerting/v3/destinations/destinations.ts | 4 +-
.../alerting/v3/destinations/index.ts | 4 +-
.../alerting/v3/destinations/webhooks.ts | 50 +-
src/resources/alerting/v3/index.ts | 4 +-
src/resources/alerting/v3/policies.ts | 56 +-
src/resources/alerting/v3/v3.ts | 4 +-
src/resources/argo/argo.ts | 8 +-
src/resources/argo/index.ts | 8 +-
src/resources/argo/smart-routing.ts | 16 +-
src/resources/argo/tiered-caching.ts | 16 +-
src/resources/bot-management.ts | 70 +-
src/resources/cache/cache-reserves.ts | 30 +-
src/resources/cache/cache.ts | 100 +-
src/resources/cache/index.ts | 18 +-
src/resources/cache/regional-tiered-cache.ts | 20 +-
.../cache/tiered-cache-smart-topology.ts | 40 +-
src/resources/cache/variants.ts | 86 +-
src/resources/calls.ts | 84 +-
.../certificate-authorities.ts | 4 +-
.../hostname-associations.ts | 54 +-
.../certificate-authorities/index.ts | 4 +-
src/resources/challenges/challenges.ts | 4 +-
src/resources/challenges/index.ts | 4 +-
src/resources/challenges/widgets.ts | 86 +-
src/resources/client-certificates.ts | 54 +-
.../custom-certificates.ts | 70 +-
src/resources/custom-certificates/index.ts | 6 +-
.../custom-certificates/prioritize.ts | 30 +-
.../custom-hostnames/custom-hostnames.ts | 142 +-
.../custom-hostnames/fallback-origin.ts | 42 +-
src/resources/custom-hostnames/index.ts | 8 +-
src/resources/devices/devices.ts | 20 +-
src/resources/devices/dex-tests.ts | 144 +-
src/resources/devices/index.ts | 18 +-
src/resources/devices/networks.ts | 130 +-
src/resources/devices/policies/excludes.ts | 50 +-
.../devices/policies/fallback-domains.ts | 60 +-
src/resources/devices/policies/includes.ts | 50 +-
src/resources/devices/policies/index.ts | 12 +-
src/resources/devices/policies/policies.ts | 60 +-
src/resources/devices/postures/index.ts | 8 +-
.../devices/postures/integrations.ts | 62 +-
src/resources/devices/postures/postures.ts | 1460 ++---
src/resources/devices/settings.ts | 34 +-
src/resources/dispatchers/dispatchers.ts | 4 +-
src/resources/dispatchers/index.ts | 4 +-
src/resources/dispatchers/scripts.ts | 194 +-
src/resources/dlp/datasets/datasets.ts | 104 +-
src/resources/dlp/datasets/index.ts | 6 +-
src/resources/dlp/datasets/upload.ts | 20 +-
src/resources/dlp/dlp.ts | 8 +-
src/resources/dlp/index.ts | 8 +-
src/resources/dlp/payload-logs.ts | 34 +-
src/resources/dlp/profiles/customs.ts | 52 +-
src/resources/dlp/profiles/index.ts | 8 +-
src/resources/dlp/profiles/predefineds.ts | 52 +-
src/resources/dlp/profiles/profiles.ts | 8 +-
src/resources/dns-firewall/dns-firewall.ts | 74 +-
src/resources/dns-firewall/index.ts | 4 +-
src/resources/dns-records.ts | 734 +--
src/resources/dnssec.ts | 36 +-
src/resources/emails/routing/index.ts | 4 +-
src/resources/emails/routing/routing.ts | 4 +-
.../emails/routing/rules/catch-alls.ts | 58 +-
src/resources/emails/routing/rules/index.ts | 6 +-
src/resources/emails/routing/rules/rules.ts | 96 +-
src/resources/filters.ts | 76 +-
src/resources/firewall/waf/packages/groups.ts | 68 +-
src/resources/firewall/waf/packages/index.ts | 6 +-
.../firewall/waf/packages/packages.ts | 8 +-
src/resources/firewall/waf/packages/rules.ts | 24 +-
src/resources/firewalls/access-rules.ts | 200 +-
src/resources/firewalls/firewalls.ts | 16 +-
src/resources/firewalls/index.ts | 16 +-
src/resources/firewalls/lockdowns.ts | 80 +-
src/resources/firewalls/rules.ts | 260 +-
src/resources/firewalls/ua-rules.ts | 46 +-
src/resources/firewalls/waf/index.ts | 4 +-
src/resources/firewalls/waf/overrides.ts | 154 +-
.../firewalls/waf/packages/groups.ts | 68 +-
src/resources/firewalls/waf/packages/index.ts | 8 +-
.../firewalls/waf/packages/packages.ts | 8 +-
src/resources/firewalls/waf/packages/rules.ts | 24 +-
src/resources/firewalls/waf/waf.ts | 4 +-
src/resources/gateways/audit-ssh-settings.ts | 40 +-
src/resources/gateways/configurations.ts | 62 +-
src/resources/gateways/gateways.ts | 28 +-
src/resources/gateways/index.ts | 26 +-
src/resources/gateways/lists/index.ts | 4 +-
src/resources/gateways/lists/lists.ts | 102 +-
src/resources/gateways/locations.ts | 142 +-
src/resources/gateways/loggings.ts | 46 +-
src/resources/gateways/proxy-endpoints.ts | 86 +-
src/resources/gateways/rules.ts | 1470 ++---
src/resources/healthchecks/healthchecks.ts | 396 +-
src/resources/healthchecks/index.ts | 4 +-
src/resources/hostnames/settings/index.ts | 2 +-
src/resources/hostnames/settings/settings.ts | 4 +-
src/resources/hostnames/settings/tls.ts | 90 +-
src/resources/hyperdrive/configs.ts | 54 +-
src/resources/hyperdrive/hyperdrive.ts | 4 +-
src/resources/hyperdrive/index.ts | 4 +-
src/resources/images/images.ts | 4 +-
src/resources/images/index.ts | 4 +-
src/resources/images/v1s/index.ts | 8 +-
src/resources/images/v1s/v1s.ts | 118 +-
src/resources/images/v1s/variants.ts | 142 +-
src/resources/index.ts | 132 +-
src/resources/intel/index.ts | 4 +-
src/resources/intel/indicator-feeds/index.ts | 4 +-
.../intel/indicator-feeds/indicator-feeds.ts | 74 +-
src/resources/intel/intel.ts | 4 +-
src/resources/keyless-certificates.ts | 188 +-
src/resources/load-balancers/index.ts | 12 +-
.../load-balancers/load-balancers.ts | 2402 ++++-----
.../load-balancers/monitors/index.ts | 4 +-
.../load-balancers/monitors/monitors.ts | 250 +-
src/resources/load-balancers/pools/index.ts | 4 +-
src/resources/load-balancers/pools/pools.ts | 968 ++--
src/resources/logpush/index.ts | 4 +-
src/resources/logpush/jobs.ts | 352 +-
src/resources/logpush/logpush.ts | 4 +-
src/resources/magics/cf-interconnects.ts | 60 +-
src/resources/magics/gre-tunnels.ts | 58 +-
src/resources/magics/index.ts | 16 +-
src/resources/magics/ipsec-tunnels/index.ts | 4 +-
.../magics/ipsec-tunnels/ipsec-tunnels.ts | 56 +-
src/resources/magics/magics.ts | 16 +-
src/resources/magics/routes.ts | 58 +-
src/resources/managed-headers.ts | 68 +-
src/resources/memberships.ts | 50 +-
src/resources/mnms/configs/configs.ts | 18 +-
src/resources/mnms/configs/index.ts | 2 +-
src/resources/mnms/index.ts | 4 +-
src/resources/mnms/mnms.ts | 4 +-
src/resources/mnms/rules/advertisements.ts | 10 +-
src/resources/mnms/rules/index.ts | 4 +-
src/resources/mnms/rules/rules.ts | 42 +-
.../origin-post-quantum-encryption.ts | 34 +-
.../hostnames/hostnames.ts | 118 +-
.../origin-tls-client-auth/hostnames/index.ts | 2 +-
src/resources/origin-tls-client-auth/index.ts | 6 +-
.../origin-tls-client-auth.ts | 8 +-
.../origin-tls-client-auth/settings.ts | 42 +-
src/resources/page-shield/index.ts | 8 +-
src/resources/page-shield/page-shield.ts | 38 +-
src/resources/page-shield/policies.ts | 92 +-
src/resources/pagerules/index.ts | 4 +-
src/resources/pagerules/pagerules.ts | 96 +-
src/resources/pages/index.ts | 4 +-
src/resources/pages/pages.ts | 4 +-
src/resources/pages/projects/domains.ts | 40 +-
src/resources/pages/projects/index.ts | 6 +-
src/resources/pages/projects/projects.ts | 48 +-
src/resources/rate-limits.ts | 46 +-
src/resources/registrar/domains.ts | 44 +-
src/resources/registrar/index.ts | 4 +-
src/resources/registrar/registrar.ts | 4 +-
src/resources/request-tracers/index.ts | 2 +-
.../request-tracers/request-tracers.ts | 1 +
src/resources/request-tracers/traces.ts | 83 +-
src/resources/rules/index.ts | 4 +-
src/resources/rules/lists/index.ts | 8 +-
src/resources/rules/lists/items.ts | 134 +-
src/resources/rules/lists/lists.ts | 48 +-
src/resources/rules/rules.ts | 4 +-
src/resources/rulesets/index.ts | 8 +-
src/resources/rulesets/rules.ts | 90 +-
src/resources/rulesets/rulesets.ts | 220 +-
src/resources/rum/index.ts | 8 +-
src/resources/rum/rules.ts | 100 +-
src/resources/rum/rum.ts | 8 +-
src/resources/rum/site-infos.ts | 92 +-
src/resources/secondary-dns/acls.ts | 72 +-
src/resources/secondary-dns/incoming.ts | 48 +-
src/resources/secondary-dns/index.ts | 20 +-
src/resources/secondary-dns/outgoing/index.ts | 4 +-
.../secondary-dns/outgoing/outgoing.ts | 80 +-
src/resources/secondary-dns/peers.ts | 106 +-
src/resources/secondary-dns/secondary-dns.ts | 20 +-
src/resources/secondary-dns/tsigs.ts | 74 +-
src/resources/settings/always-online.ts | 16 +-
src/resources/settings/always-use-https.ts | 16 +-
.../settings/automatic-https-rewrites.ts | 16 +-
.../automatic-platform-optimization.ts | 20 +-
src/resources/settings/brotli.ts | 16 +-
src/resources/settings/browser-cache-ttl.ts | 16 +-
src/resources/settings/browser-check.ts | 16 +-
src/resources/settings/cache-level.ts | 16 +-
src/resources/settings/challenge-ttl.ts | 16 +-
src/resources/settings/ciphers.ts | 16 +-
src/resources/settings/development-mode.ts | 16 +-
src/resources/settings/early-hints.ts | 16 +-
src/resources/settings/email-obfuscation.ts | 16 +-
src/resources/settings/font-settings.ts | 16 +-
src/resources/settings/h2-prioritization.ts | 20 +-
src/resources/settings/hotlink-protection.ts | 16 +-
src/resources/settings/http2.ts | 16 +-
src/resources/settings/http3.ts | 16 +-
src/resources/settings/image-resizing.ts | 20 +-
src/resources/settings/index.ts | 173 +-
src/resources/settings/ip-geolocation.ts | 16 +-
src/resources/settings/ipv6.ts | 16 +-
src/resources/settings/min-tls-version.ts | 16 +-
src/resources/settings/minify.ts | 24 +-
src/resources/settings/mirage.ts | 16 +-
src/resources/settings/mobile-redirect.ts | 24 +-
src/resources/settings/nel.ts | 24 +-
.../settings/opportunistic-encryption.ts | 16 +-
src/resources/settings/opportunistic-onion.ts | 16 +-
src/resources/settings/orange-to-orange.ts | 20 +-
.../settings/origin-error-page-pass-thru.ts | 16 +-
.../settings/origin-max-http-version.ts | 16 +-
src/resources/settings/polish.ts | 20 +-
src/resources/settings/prefetch-preload.ts | 16 +-
src/resources/settings/proxy-read-timeout.ts | 20 +-
src/resources/settings/pseudo-ipv4.ts | 16 +-
src/resources/settings/response-buffering.ts | 16 +-
src/resources/settings/rocket-loader.ts | 20 +-
src/resources/settings/security-headers.ts | 24 +-
src/resources/settings/security-level.ts | 16 +-
.../settings/server-side-excludes.ts | 16 +-
src/resources/settings/settings.ts | 200 +-
.../settings/sort-query-string-for-cache.ts | 16 +-
src/resources/settings/ssl-recommender.ts | 20 +-
src/resources/settings/ssl.ts | 16 +-
src/resources/settings/tls-1-3.ts | 16 +-
src/resources/settings/tls-client-auth.ts | 16 +-
.../settings/true-client-ip-header.ts | 16 +-
src/resources/settings/waf.ts | 16 +-
src/resources/settings/webp.ts | 16 +-
src/resources/settings/websocket.ts | 16 +-
src/resources/settings/zero-rtt.ts | 16 +-
src/resources/snippets/index.ts | 16 +-
src/resources/snippets/snippet-rules.ts | 62 +-
src/resources/snippets/snippets.ts | 110 +-
src/resources/spectrum/apps.ts | 104 +-
src/resources/spectrum/index.ts | 4 +-
src/resources/spectrum/spectrum.ts | 4 +-
.../certificate-packs/certificate-packs.ts | 58 +-
src/resources/ssl/certificate-packs/index.ts | 2 +-
src/resources/ssl/index.ts | 6 +-
src/resources/ssl/ssl.ts | 6 +-
src/resources/ssl/universal/index.ts | 2 +-
src/resources/ssl/universal/settings.ts | 16 +-
src/resources/ssl/universal/universal.ts | 4 +-
src/resources/ssl/verification.ts | 66 +-
src/resources/storage/kv/index.ts | 4 +-
src/resources/storage/kv/kv.ts | 4 +-
src/resources/storage/kv/namespaces/bulk.ts | 52 +-
src/resources/storage/kv/namespaces/index.ts | 10 +-
.../storage/kv/namespaces/namespaces.ts | 64 +-
src/resources/storage/kv/namespaces/values.ts | 56 +-
src/resources/stream/audio-tracks.ts | 88 +-
src/resources/stream/captions.ts | 48 +-
src/resources/stream/index.ts | 16 +-
src/resources/stream/live-inputs/index.ts | 8 +-
.../stream/live-inputs/live-inputs.ts | 196 +-
src/resources/stream/live-inputs/outputs.ts | 90 +-
src/resources/stream/stream.ts | 16 +-
src/resources/stream/webhooks.ts | 40 +-
src/resources/subscriptions.ts | 54 +-
src/resources/teamnet/index.ts | 4 +-
src/resources/teamnet/routes.ts | 40 +-
src/resources/teamnet/teamnet.ts | 4 +-
src/resources/teamnets/index.ts | 4 +-
src/resources/teamnets/teamnets.ts | 4 +-
src/resources/teamnets/virtual-networks.ts | 74 +-
src/resources/tunnels/configurations.ts | 44 +-
src/resources/tunnels/index.ts | 8 +-
src/resources/tunnels/tunnels.ts | 184 +-
src/resources/url-normalizations.ts | 30 +-
.../firewall/access-rules/access-rules.ts | 4 +-
.../users/firewall/access-rules/index.ts | 4 +-
.../users/firewall/access-rules/rules.ts | 104 +-
src/resources/users/index.ts | 14 +-
src/resources/users/invites.ts | 34 +-
src/resources/users/load-balancers/index.ts | 8 +-
.../users/load-balancers/load-balancers.ts | 8 +-
.../users/load-balancers/monitors/index.ts | 4 +-
.../users/load-balancers/monitors/monitors.ts | 248 +-
.../users/load-balancers/pools/index.ts | 4 +-
.../users/load-balancers/pools/pools.ts | 964 ++--
src/resources/users/subscriptions.ts | 50 +-
src/resources/users/tokens/index.ts | 6 +-
src/resources/users/tokens/tokens.ts | 64 +-
src/resources/users/tokens/values.ts | 16 +-
src/resources/users/users.ts | 40 +-
src/resources/vectorize/index.ts | 4 +-
src/resources/vectorize/indexes.ts | 122 +-
src/resources/vectorize/vectorize.ts | 4 +-
src/resources/waiting-rooms/events/events.ts | 222 +-
src/resources/waiting-rooms/events/index.ts | 4 +-
src/resources/waiting-rooms/index.ts | 16 +-
src/resources/waiting-rooms/rules.ts | 88 +-
src/resources/waiting-rooms/settings.ts | 16 +-
src/resources/waiting-rooms/waiting-rooms.ts | 1298 ++---
src/resources/warp-connector.ts | 88 +-
src/resources/web3/hostnames/hostnames.ts | 112 +-
src/resources/web3/hostnames/index.ts | 4 +-
.../content-lists/content-lists.ts | 44 +-
.../content-lists/entries.ts | 96 +-
.../content-lists/index.ts | 8 +-
.../hostnames/ipfs-universal-paths/index.ts | 4 +-
.../ipfs-universal-paths.ts | 4 +-
src/resources/web3/index.ts | 4 +-
src/resources/web3/web3.ts | 4 +-
src/resources/worker-scripts/content.ts | 24 +-
src/resources/worker-scripts/index.ts | 4 +-
src/resources/worker-scripts/settings.ts | 46 +-
.../worker-scripts/worker-scripts.ts | 8 +-
.../dispatch/namespaces/scripts/content.ts | 56 +-
.../dispatch/namespaces/scripts/index.ts | 4 +-
.../dispatch/namespaces/scripts/scripts.ts | 8 +-
.../dispatch/namespaces/scripts/settings.ts | 50 +-
src/resources/workers/account-settings.ts | 40 +-
src/resources/workers/domains.ts | 102 +-
src/resources/workers/filters.ts | 58 +-
src/resources/workers/index.ts | 28 +-
src/resources/workers/queues/consumers.ts | 90 +-
src/resources/workers/queues/index.ts | 8 +-
src/resources/workers/queues/queues.ts | 64 +-
src/resources/workers/routes.ts | 66 +-
src/resources/workers/scripts/index.ts | 10 +-
src/resources/workers/scripts/schedules.ts | 48 +-
src/resources/workers/scripts/scripts.ts | 202 +-
src/resources/workers/scripts/usage-model.ts | 42 +-
.../workers/services/environments/content.ts | 54 +-
.../services/environments/environments.ts | 8 +-
.../workers/services/environments/index.ts | 4 +-
.../workers/services/environments/settings.ts | 50 +-
src/resources/workers/subdomains.ts | 34 +-
src/resources/workers/workers.ts | 28 +-
src/resources/zaraz/config.ts | 78 +-
src/resources/zaraz/history/history.ts | 114 +-
src/resources/zaraz/history/index.ts | 4 +-
src/resources/zaraz/index.ts | 8 +-
src/resources/zaraz/zaraz.ts | 24 +-
.../zerotrust/connectivity-settings.ts | 16 +-
src/resources/zerotrust/index.ts | 4 +-
src/resources/zerotrust/zerotrust.ts | 4 +-
src/resources/zones/index.ts | 4 +-
src/resources/zones/zones.ts | 142 +-
.../access/applications/applications.test.ts | 134 +-
.../access/applications/policies.test.ts | 146 +-
tests/api-resources/access/bookmarks.test.ts | 30 +-
.../access/certificates/certificates.test.ts | 60 +-
.../access/certificates/settings.test.ts | 52 +-
.../api-resources/access/custom-pages.test.ts | 68 +-
tests/api-resources/access/groups.test.ts | 104 +-
.../access/identity-providers.test.ts | 92 +-
tests/api-resources/access/keys.test.ts | 30 +-
.../access/organizations.test.ts | 30 +-
tests/api-resources/access/seats.test.ts | 8 +-
.../access/service-tokens.test.ts | 34 +-
tests/api-resources/access/tags.test.ts | 42 +-
tests/api-resources/account-members.test.ts | 58 +-
tests/api-resources/accounts.test.ts | 54 +-
tests/api-resources/activation-checks.test.ts | 8 +-
.../addresses/address-maps/accounts.test.ts | 8 +-
.../address-maps/address-maps.test.ts | 32 +-
.../addresses/address-maps/ips.test.ts | 8 +-
.../addresses/address-maps/zones.test.ts | 8 +-
.../addresses/prefixes/bgps/statuses.test.ts | 8 +-
.../addresses/prefixes/prefixes.test.ts | 50 +-
.../addressing/prefixes/bgp-prefixes.test.ts | 34 +-
.../alerting/v3/destinations/webhooks.test.ts | 58 +-
.../alerting/v3/policies.test.ts | 32 +-
.../api-resources/argo/smart-routing.test.ts | 8 +-
.../api-resources/argo/tiered-caching.test.ts | 8 +-
tests/api-resources/bot-management.test.ts | 24 +-
.../cache/cache-reserves.test.ts | 34 +-
tests/api-resources/cache/cache.test.ts | 26 +
.../cache/regional-tiered-cache.test.ts | 8 +-
.../cache/tiered-cache-smart-topology.test.ts | 24 +-
tests/api-resources/cache/variants.test.ts | 64 +-
tests/api-resources/calls.test.ts | 32 +-
.../hostname-associations.test.ts | 30 +-
.../api-resources/challenges/widgets.test.ts | 72 +-
.../api-resources/client-certificates.test.ts | 54 +-
.../custom-certificates.test.ts | 32 +-
.../custom-certificates/prioritize.test.ts | 8 +-
.../custom-hostnames/custom-hostnames.test.ts | 32 +-
.../custom-hostnames/fallback-origin.test.ts | 46 +-
tests/api-resources/devices/dex-tests.test.ts | 62 +-
tests/api-resources/devices/networks.test.ts | 32 +-
.../devices/policies/excludes.test.ts | 52 +-
.../devices/policies/fallback-domains.test.ts | 62 +-
.../devices/policies/includes.test.ts | 52 +-
.../devices/policies/policies.test.ts | 32 +-
.../devices/postures/integrations.test.ts | 10 +-
.../devices/postures/postures.test.ts | 78 +-
tests/api-resources/devices/settings.test.ts | 24 +-
.../api-resources/dispatchers/scripts.test.ts | 34 +-
.../dlp/datasets/datasets.test.ts | 32 +-
.../api-resources/dlp/datasets/upload.test.ts | 4 +-
tests/api-resources/dlp/payload-logs.test.ts | 34 +-
.../dlp/profiles/customs.test.ts | 32 +-
.../dlp/profiles/predefineds.test.ts | 32 +-
.../dns-firewall/dns-firewall.test.ts | 100 +-
tests/api-resources/dns-records.test.ts | 66 +-
tests/api-resources/dnssec.test.ts | 8 +-
.../emails/routing/rules/catch-alls.test.ts | 52 +-
.../emails/routing/rules/rules.test.ts | 184 +-
tests/api-resources/filters.test.ts | 50 +-
.../firewall/waf/packages/groups.test.ts | 34 +-
.../firewall/waf/packages/rules.test.ts | 4 +-
.../firewalls/access-rules.test.ts | 56 +-
.../api-resources/firewalls/lockdowns.test.ts | 50 +-
tests/api-resources/firewalls/rules.test.ts | 46 +-
.../api-resources/firewalls/ua-rules.test.ts | 50 +-
.../firewalls/waf/overrides.test.ts | 50 +-
.../firewalls/waf/packages/groups.test.ts | 34 +-
.../firewalls/waf/packages/rules.test.ts | 4 +-
.../gateways/audit-ssh-settings.test.ts | 36 +-
.../gateways/configurations.test.ts | 27 +-
.../gateways/lists/lists.test.ts | 50 +-
.../api-resources/gateways/locations.test.ts | 60 +-
tests/api-resources/gateways/loggings.test.ts | 24 +-
.../gateways/proxy-endpoints.test.ts | 32 +-
tests/api-resources/gateways/rules.test.ts | 136 +-
.../healthchecks/healthchecks.test.ts | 96 +-
.../hostnames/settings/tls.test.ts | 54 +-
.../api-resources/hyperdrive/configs.test.ts | 50 +-
tests/api-resources/images/v1s/v1s.test.ts | 24 +-
.../api-resources/images/v1s/variants.test.ts | 46 +-
.../indicator-feeds/indicator-feeds.test.ts | 32 +-
.../keyless-certificates.test.ts | 32 +-
.../load-balancers/load-balancers.test.ts | 32 +-
.../load-balancers/monitors/monitors.test.ts | 82 +-
.../load-balancers/pools/pools.test.ts | 32 +-
tests/api-resources/logpush/jobs.test.ts | 34 +-
.../magics/cf-interconnects.test.ts | 32 +-
.../api-resources/magics/gre-tunnels.test.ts | 90 +-
.../ipsec-tunnels/ipsec-tunnels.test.ts | 66 +-
tests/api-resources/magics/routes.test.ts | 64 +-
tests/api-resources/managed-headers.test.ts | 52 +-
tests/api-resources/memberships.test.ts | 42 +-
.../mnms/configs/configs.test.ts | 4 +-
.../mnms/rules/advertisements.test.ts | 4 +-
tests/api-resources/mnms/rules/rules.test.ts | 32 +-
.../origin-post-quantum-encryption.test.ts | 37 +-
.../hostnames/hostnames.test.ts | 48 +-
.../origin-tls-client-auth/settings.test.ts | 38 +-
.../page-shield/page-shield.test.ts | 24 +-
.../page-shield/policies.test.ts | 32 +-
.../api-resources/pagerules/pagerules.test.ts | 82 +-
.../pages/projects/domains.test.ts | 32 +-
.../pages/projects/projects.test.ts | 82 +-
tests/api-resources/rate-limits.test.ts | 50 +-
tests/api-resources/registrar/domains.test.ts | 32 +-
tests/api-resources/rules/lists/items.test.ts | 142 +-
tests/api-resources/rules/lists/lists.test.ts | 32 +-
tests/api-resources/rulesets/rules.test.ts | 70 +-
tests/api-resources/rulesets/rulesets.test.ts | 166 +-
tests/api-resources/rum/rules.test.ts | 34 +-
tests/api-resources/rum/site-infos.test.ts | 32 +-
.../api-resources/secondary-dns/acls.test.ts | 50 +-
.../secondary-dns/incoming.test.ts | 50 +-
.../secondary-dns/outgoing/outgoing.test.ts | 46 +-
.../api-resources/secondary-dns/peers.test.ts | 62 +-
.../api-resources/secondary-dns/tsigs.test.ts | 70 +-
.../settings/always-online.test.ts | 8 +-
.../settings/always-use-https.test.ts | 8 +-
.../settings/automatic-https-rewrites.test.ts | 8 +-
.../automatic-platform-optimization.test.ts | 8 +-
tests/api-resources/settings/brotli.test.ts | 8 +-
.../settings/browser-cache-ttl.test.ts | 8 +-
.../settings/browser-check.test.ts | 8 +-
.../settings/cache-level.test.ts | 8 +-
.../settings/challenge-ttl.test.ts | 8 +-
tests/api-resources/settings/ciphers.test.ts | 8 +-
.../settings/development-mode.test.ts | 8 +-
.../settings/early-hints.test.ts | 8 +-
.../settings/email-obfuscation.test.ts | 8 +-
.../settings/font-settings.test.ts | 8 +-
.../settings/h2-prioritization.test.ts | 8 +-
.../settings/hotlink-protection.test.ts | 8 +-
tests/api-resources/settings/http2.test.ts | 8 +-
tests/api-resources/settings/http3.test.ts | 8 +-
.../settings/image-resizing.test.ts | 8 +-
.../settings/ip-geolocation.test.ts | 8 +-
tests/api-resources/settings/ipv6.test.ts | 8 +-
.../settings/min-tls-version.test.ts | 8 +-
tests/api-resources/settings/minify.test.ts | 8 +-
tests/api-resources/settings/mirage.test.ts | 8 +-
.../settings/mobile-redirect.test.ts | 8 +-
tests/api-resources/settings/nel.test.ts | 8 +-
.../settings/opportunistic-encryption.test.ts | 8 +-
.../settings/opportunistic-onion.test.ts | 13 +-
.../settings/orange-to-orange.test.ts | 8 +-
.../origin-error-page-pass-thru.test.ts | 8 +-
.../settings/origin-max-http-version.test.ts | 13 +-
tests/api-resources/settings/polish.test.ts | 8 +-
.../settings/prefetch-preload.test.ts | 8 +-
.../settings/proxy-read-timeout.test.ts | 8 +-
.../settings/pseudo-ipv4.test.ts | 8 +-
.../settings/response-buffering.test.ts | 8 +-
.../settings/rocket-loader.test.ts | 8 +-
.../settings/security-headers.test.ts | 8 +-
.../settings/security-level.test.ts | 8 +-
.../settings/server-side-excludes.test.ts | 13 +-
.../sort-query-string-for-cache.test.ts | 8 +-
.../settings/ssl-recommender.test.ts | 8 +-
tests/api-resources/settings/ssl.test.ts | 10 +-
tests/api-resources/settings/tls-1-3.test.ts | 8 +-
.../settings/tls-client-auth.test.ts | 8 +-
.../settings/true-client-ip-header.test.ts | 13 +-
tests/api-resources/settings/waf.test.ts | 12 +-
tests/api-resources/settings/webp.test.ts | 8 +-
.../api-resources/settings/websocket.test.ts | 8 +-
tests/api-resources/settings/zero-rtt.test.ts | 8 +-
.../snippets/snippet-rules.test.ts | 56 +-
tests/api-resources/snippets/snippets.test.ts | 71 +-
tests/api-resources/spectrum/apps.test.ts | 72 +-
.../certificate-packs.test.ts | 30 +-
.../ssl/universal/settings.test.ts | 4 +-
tests/api-resources/ssl/verification.test.ts | 50 +-
.../storage/kv/namespaces/bulk.test.ts | 58 +-
.../storage/kv/namespaces/namespaces.test.ts | 50 +-
.../storage/kv/namespaces/values.test.ts | 54 +-
.../api-resources/stream/audio-tracks.test.ts | 34 +-
tests/api-resources/stream/captions.test.ts | 54 +-
.../stream/live-inputs/live-inputs.test.ts | 32 +-
.../stream/live-inputs/outputs.test.ts | 54 +-
tests/api-resources/stream/webhooks.test.ts | 42 +-
tests/api-resources/subscriptions.test.ts | 32 +-
tests/api-resources/teamnet/routes.test.ts | 32 +-
.../teamnets/virtual-networks.test.ts | 32 +-
.../tunnels/configurations.test.ts | 32 +-
tests/api-resources/tunnels/tunnels.test.ts | 32 +-
.../api-resources/url-normalizations.test.ts | 24 +-
.../users/firewall/access-rules/rules.test.ts | 30 +-
tests/api-resources/users/invites.test.ts | 30 +-
.../load-balancers/monitors/monitors.test.ts | 76 +-
.../users/load-balancers/pools/pools.test.ts | 27 +-
.../api-resources/users/subscriptions.test.ts | 24 +-
.../api-resources/users/tokens/tokens.test.ts | 134 +-
.../api-resources/users/tokens/values.test.ts | 8 +-
tests/api-resources/users/users.test.ts | 24 +-
tests/api-resources/vectorize/indexes.test.ts | 50 +-
.../waiting-rooms/events/events.test.ts | 92 +-
.../api-resources/waiting-rooms/rules.test.ts | 78 +-
.../waiting-rooms/settings.test.ts | 4 +-
.../waiting-rooms/waiting-rooms.test.ts | 108 +-
tests/api-resources/warp-connector.test.ts | 32 +-
.../web3/hostnames/hostnames.test.ts | 32 +-
.../content-lists/content-lists.test.ts | 62 +-
.../content-lists/entries.test.ts | 62 +-
.../worker-scripts/content.test.ts | 4 +-
.../worker-scripts/settings.test.ts | 4 +-
.../namespaces/scripts/content.test.ts | 30 +-
.../namespaces/scripts/settings.test.ts | 8 +-
.../workers/account-settings.test.ts | 38 +-
tests/api-resources/workers/domains.test.ts | 54 +-
tests/api-resources/workers/filters.test.ts | 50 +-
.../workers/queues/consumers.test.ts | 70 +-
.../workers/queues/queues.test.ts | 50 +-
tests/api-resources/workers/routes.test.ts | 50 +-
.../workers/scripts/schedules.test.ts | 36 +-
.../workers/scripts/scripts.test.ts | 32 +-
.../workers/scripts/usage-model.test.ts | 36 +-
.../services/environments/content.test.ts | 30 +-
.../services/environments/settings.test.ts | 8 +-
.../api-resources/workers/subdomains.test.ts | 38 +-
tests/api-resources/zaraz/config.test.ts | 48 +-
.../zaraz/history/history.test.ts | 34 +-
tests/api-resources/zaraz/zaraz.test.ts | 8 +-
.../zerotrust/connectivity-settings.test.ts | 4 +-
tests/api-resources/zones/zones.test.ts | 24 +-
609 files changed, 21854 insertions(+), 21834 deletions(-)
create mode 100644 tests/api-resources/cache/cache.test.ts
diff --git a/.stats.yml b/.stats.yml
index 961e096a51..42d2723898 100644
--- a/.stats.yml
+++ b/.stats.yml
@@ -1 +1 @@
-configured_endpoints: 1110
+configured_endpoints: 1111
diff --git a/README.md b/README.md
index 88ef8ccbfe..2e54bd548f 100644
--- a/README.md
+++ b/README.md
@@ -130,7 +130,7 @@ const cloudflare = new Cloudflare({
});
// Override per-request:
-await cloudflare.zones.update('023e105f4ecef8ad9ca31a8372d0c353', {
+await cloudflare.zones.edit('023e105f4ecef8ad9ca31a8372d0c353', {
timeout: 5 * 1000,
});
```
diff --git a/api.md b/api.md
index b92205c6b9..9163c43603 100644
--- a/api.md
+++ b/api.md
@@ -2,15 +2,15 @@
Types:
+- AccountUpdateResponse
- AccountListResponse
- AccountGetResponse
-- AccountReplaceResponse
Methods:
+- client.accounts.update(accountId, { ...params }) -> AccountUpdateResponse
- client.accounts.list({ ...params }) -> AccountListResponsesV4PagePaginationArray
- client.accounts.get(accountId) -> AccountGetResponse
-- client.accounts.replace(accountId, { ...params }) -> AccountReplaceResponse
# Certificates
@@ -42,29 +42,29 @@ Methods:
Types:
+- MembershipUpdateResponse
- MembershipListResponse
- MembershipDeleteResponse
- MembershipGetResponse
-- MembershipReplaceResponse
Methods:
+- client.memberships.update(membershipId, { ...params }) -> MembershipUpdateResponse
- client.memberships.list({ ...params }) -> MembershipListResponsesV4PagePaginationArray
- client.memberships.delete(membershipId) -> MembershipDeleteResponse
- client.memberships.get(membershipId) -> MembershipGetResponse
-- client.memberships.replace(membershipId, { ...params }) -> MembershipReplaceResponse
# Users
Types:
-- UserUpdateResponse
- UserListResponse
+- UserEditResponse
Methods:
-- client.users.update({ ...params }) -> UserUpdateResponse
- client.users.list() -> UserListResponse
+- client.users.edit({ ...params }) -> UserEditResponse
## AuditLogs
@@ -107,29 +107,29 @@ Methods:
Types:
- RuleCreateResponse
-- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
+- RuleEditResponse
Methods:
- client.users.firewall.accessRules.rules.create({ ...params }) -> RuleCreateResponse | null
-- client.users.firewall.accessRules.rules.update(identifier, { ...params }) -> RuleUpdateResponse | null
- client.users.firewall.accessRules.rules.list({ ...params }) -> RuleListResponsesV4PagePaginationArray
- client.users.firewall.accessRules.rules.delete(identifier) -> RuleDeleteResponse | null
+- client.users.firewall.accessRules.rules.edit(identifier, { ...params }) -> RuleEditResponse | null
## Invites
Types:
-- InviteUpdateResponse
- InviteListResponse
+- InviteEditResponse
- InviteGetResponse
Methods:
-- client.users.invites.update(inviteId, { ...params }) -> InviteUpdateResponse
- client.users.invites.list() -> InviteListResponse | null
+- client.users.invites.edit(inviteId, { ...params }) -> InviteEditResponse
- client.users.invites.get(inviteId) -> InviteGetResponse
## LoadBalancers
@@ -139,17 +139,17 @@ Methods:
Types:
- MonitorCreateResponse
-- MonitorUpdateResponse
- MonitorListResponse
- MonitorDeleteResponse
+- MonitorEditResponse
- MonitorGetResponse
Methods:
- client.users.loadBalancers.monitors.create({ ...params }) -> MonitorCreateResponse
-- client.users.loadBalancers.monitors.update(monitorId, { ...params }) -> MonitorUpdateResponse
- client.users.loadBalancers.monitors.list() -> MonitorListResponse | null
- client.users.loadBalancers.monitors.delete(monitorId) -> MonitorDeleteResponse
+- client.users.loadBalancers.monitors.edit(monitorId, { ...params }) -> MonitorEditResponse
- client.users.loadBalancers.monitors.get(monitorId) -> MonitorGetResponse
#### Previews
@@ -177,17 +177,17 @@ Methods:
Types:
- PoolCreateResponse
-- PoolUpdateResponse
- PoolListResponse
- PoolDeleteResponse
+- PoolEditResponse
- PoolGetResponse
Methods:
- client.users.loadBalancers.pools.create({ ...params }) -> PoolCreateResponse
-- client.users.loadBalancers.pools.update(poolId, { ...params }) -> PoolUpdateResponse
- client.users.loadBalancers.pools.list({ ...params }) -> PoolListResponse | null
- client.users.loadBalancers.pools.delete(poolId) -> PoolDeleteResponse
+- client.users.loadBalancers.pools.edit(poolId, { ...params }) -> PoolEditResponse
- client.users.loadBalancers.pools.get(poolId) -> PoolGetResponse
#### Health
@@ -260,34 +260,34 @@ Methods:
Types:
+- SubscriptionUpdateResponse
- SubscriptionListResponse
- SubscriptionDeleteResponse
-- SubscriptionReplaceResponse
Methods:
+- client.users.subscriptions.update(identifier, { ...params }) -> SubscriptionUpdateResponse
- client.users.subscriptions.list() -> SubscriptionListResponse | null
- client.users.subscriptions.delete(identifier) -> SubscriptionDeleteResponse
-- client.users.subscriptions.replace(identifier, { ...params }) -> SubscriptionReplaceResponse
## Tokens
Types:
- TokenCreateResponse
+- TokenUpdateResponse
- TokenListResponse
- TokenDeleteResponse
- TokenGetResponse
-- TokenReplaceResponse
- TokenVerifyResponse
Methods:
- client.users.tokens.create({ ...params }) -> TokenCreateResponse
+- client.users.tokens.update(tokenId, { ...params }) -> TokenUpdateResponse
- client.users.tokens.list({ ...params }) -> TokenListResponsesV4PagePaginationArray
- client.users.tokens.delete(tokenId) -> TokenDeleteResponse | null
- client.users.tokens.get(tokenId) -> TokenGetResponse
-- client.users.tokens.replace(tokenId, { ...params }) -> TokenReplaceResponse
- client.users.tokens.verify() -> TokenVerifyResponse
### PermissionGroups
@@ -304,28 +304,28 @@ Methods:
Types:
-- ValueReplaceResponse
+- ValueUpdateResponse
Methods:
-- client.users.tokens.values.replace(tokenId, { ...params }) -> ValueReplaceResponse
+- client.users.tokens.values.update(tokenId, { ...params }) -> ValueUpdateResponse
# Zones
Types:
- ZoneCreateResponse
-- ZoneUpdateResponse
- ZoneListResponse
- ZoneDeleteResponse
+- ZoneEditResponse
- ZoneGetResponse
Methods:
- client.zones.create({ ...params }) -> ZoneCreateResponse
-- client.zones.update(zoneId, { ...params }) -> ZoneUpdateResponse
- client.zones.list({ ...params }) -> ZoneListResponsesV4PagePaginationArray
- client.zones.delete(zoneId) -> ZoneDeleteResponse | null
+- client.zones.edit(zoneId, { ...params }) -> ZoneEditResponse
- client.zones.get(zoneId) -> ZoneGetResponse
## Holds
@@ -357,17 +357,17 @@ Methods:
Types:
- LoadBalancerCreateResponse
-- LoadBalancerUpdateResponse
- LoadBalancerListResponse
- LoadBalancerDeleteResponse
+- LoadBalancerEditResponse
- LoadBalancerGetResponse
Methods:
- client.loadBalancers.create(zoneId, { ...params }) -> LoadBalancerCreateResponse
-- client.loadBalancers.update(zoneId, loadBalancerId, { ...params }) -> LoadBalancerUpdateResponse
- client.loadBalancers.list(zoneId) -> LoadBalancerListResponse | null
- client.loadBalancers.delete(zoneId, loadBalancerId) -> LoadBalancerDeleteResponse
+- client.loadBalancers.edit(zoneId, loadBalancerId, { ...params }) -> LoadBalancerEditResponse
- client.loadBalancers.get(zoneId, loadBalancerId) -> LoadBalancerGetResponse
## Monitors
@@ -375,17 +375,17 @@ Methods:
Types:
- MonitorCreateResponse
-- MonitorUpdateResponse
- MonitorListResponse
- MonitorDeleteResponse
+- MonitorEditResponse
- MonitorGetResponse
Methods:
- client.loadBalancers.monitors.create(accountId, { ...params }) -> MonitorCreateResponse
-- client.loadBalancers.monitors.update(accountId, monitorId, { ...params }) -> MonitorUpdateResponse
- client.loadBalancers.monitors.list(accountId) -> MonitorListResponse | null
- client.loadBalancers.monitors.delete(accountId, monitorId) -> MonitorDeleteResponse
+- client.loadBalancers.monitors.edit(accountId, monitorId, { ...params }) -> MonitorEditResponse
- client.loadBalancers.monitors.get(accountId, monitorId) -> MonitorGetResponse
### Previews
@@ -413,17 +413,17 @@ Methods:
Types:
- PoolCreateResponse
-- PoolUpdateResponse
- PoolListResponse
- PoolDeleteResponse
+- PoolEditResponse
- PoolGetResponse
Methods:
- client.loadBalancers.pools.create(accountId, { ...params }) -> PoolCreateResponse
-- client.loadBalancers.pools.update(accountId, poolId, { ...params }) -> PoolUpdateResponse
- client.loadBalancers.pools.list(accountId, { ...params }) -> PoolListResponse | null
- client.loadBalancers.pools.delete(accountId, poolId) -> PoolDeleteResponse
+- client.loadBalancers.pools.edit(accountId, poolId, { ...params }) -> PoolEditResponse
- client.loadBalancers.pools.get(accountId, poolId) -> PoolGetResponse
### Health
@@ -487,19 +487,19 @@ Methods:
Types:
- ApplicationCreateResponse
+- ApplicationUpdateResponse
- ApplicationListResponse
- ApplicationDeleteResponse
- ApplicationGetResponse
-- ApplicationReplaceResponse
- ApplicationRevokeTokensResponse
Methods:
- client.access.applications.create(accountOrZone, accountOrZoneId, { ...params }) -> ApplicationCreateResponse
+- client.access.applications.update(accountOrZone, accountOrZoneId, appId, { ...params }) -> ApplicationUpdateResponse
- client.access.applications.list(accountOrZone, accountOrZoneId) -> ApplicationListResponse | null
- client.access.applications.delete(accountOrZone, accountOrZoneId, appId) -> ApplicationDeleteResponse
- client.access.applications.get(accountOrZone, accountOrZoneId, appId) -> ApplicationGetResponse
-- client.access.applications.replace(accountOrZone, accountOrZoneId, appId, { ...params }) -> ApplicationReplaceResponse
- client.access.applications.revokeTokens(accountOrZone, accountOrZoneId, appId) -> ApplicationRevokeTokensResponse | null
### Cas
@@ -533,99 +533,99 @@ Methods:
Types:
- PolicyCreateResponse
+- PolicyUpdateResponse
- PolicyListResponse
- PolicyDeleteResponse
- PolicyGetResponse
-- PolicyReplaceResponse
Methods:
- client.access.applications.policies.create(accountOrZone, accountOrZoneId, uuid, { ...params }) -> PolicyCreateResponse
+- client.access.applications.policies.update(accountOrZone, accountOrZoneId, uuid1, uuid, { ...params }) -> PolicyUpdateResponse
- client.access.applications.policies.list(accountOrZone, accountOrZoneId, uuid) -> PolicyListResponse | null
- client.access.applications.policies.delete(accountOrZone, accountOrZoneId, uuid1, uuid) -> PolicyDeleteResponse
- client.access.applications.policies.get(accountOrZone, accountOrZoneId, uuid1, uuid) -> PolicyGetResponse
-- client.access.applications.policies.replace(accountOrZone, accountOrZoneId, uuid1, uuid, { ...params }) -> PolicyReplaceResponse
## Certificates
Types:
- CertificateCreateResponse
+- CertificateUpdateResponse
- CertificateListResponse
- CertificateDeleteResponse
- CertificateGetResponse
-- CertificateReplaceResponse
Methods:
- client.access.certificates.create(accountOrZone, accountOrZoneId, { ...params }) -> CertificateCreateResponse
+- client.access.certificates.update(accountOrZone, accountOrZoneId, uuid, { ...params }) -> CertificateUpdateResponse
- client.access.certificates.list(accountOrZone, accountOrZoneId) -> CertificateListResponse | null
- client.access.certificates.delete(accountOrZone, accountOrZoneId, uuid) -> CertificateDeleteResponse
- client.access.certificates.get(accountOrZone, accountOrZoneId, uuid) -> CertificateGetResponse
-- client.access.certificates.replace(accountOrZone, accountOrZoneId, uuid, { ...params }) -> CertificateReplaceResponse
### Settings
Types:
+- SettingUpdateResponse
- SettingListResponse
-- SettingReplaceResponse
Methods:
+- client.access.certificates.settings.update(accountOrZone, accountOrZoneId, { ...params }) -> SettingUpdateResponse | null
- client.access.certificates.settings.list(accountOrZone, accountOrZoneId) -> SettingListResponse | null
-- client.access.certificates.settings.replace(accountOrZone, accountOrZoneId, { ...params }) -> SettingReplaceResponse | null
## Groups
Types:
- GroupCreateResponse
+- GroupUpdateResponse
- GroupListResponse
- GroupDeleteResponse
- GroupGetResponse
-- GroupReplaceResponse
Methods:
- client.access.groups.create(accountOrZone, accountOrZoneId, { ...params }) -> GroupCreateResponse
+- client.access.groups.update(accountOrZone, accountOrZoneId, uuid, { ...params }) -> GroupUpdateResponse
- client.access.groups.list(accountOrZone, accountOrZoneId) -> GroupListResponse | null
- client.access.groups.delete(accountOrZone, accountOrZoneId, uuid) -> GroupDeleteResponse
- client.access.groups.get(accountOrZone, accountOrZoneId, uuid) -> GroupGetResponse
-- client.access.groups.replace(accountOrZone, accountOrZoneId, uuid, { ...params }) -> GroupReplaceResponse
## IdentityProviders
Types:
- IdentityProviderCreateResponse
+- IdentityProviderUpdateResponse
- IdentityProviderListResponse
- IdentityProviderDeleteResponse
- IdentityProviderGetResponse
-- IdentityProviderReplaceResponse
Methods:
- client.access.identityProviders.create(accountOrZone, accountOrZoneId, { ...params }) -> IdentityProviderCreateResponse
+- client.access.identityProviders.update(accountOrZone, accountOrZoneId, uuid, { ...params }) -> IdentityProviderUpdateResponse
- client.access.identityProviders.list(accountOrZone, accountOrZoneId) -> IdentityProviderListResponse | null
- client.access.identityProviders.delete(accountOrZone, accountOrZoneId, uuid) -> IdentityProviderDeleteResponse
- client.access.identityProviders.get(accountOrZone, accountOrZoneId, uuid) -> IdentityProviderGetResponse
-- client.access.identityProviders.replace(accountOrZone, accountOrZoneId, uuid, { ...params }) -> IdentityProviderReplaceResponse
## Organizations
Types:
- OrganizationCreateResponse
+- OrganizationUpdateResponse
- OrganizationListResponse
-- OrganizationReplaceResponse
- OrganizationRevokeUsersResponse
Methods:
- client.access.organizations.create(accountOrZone, accountOrZoneId, { ...params }) -> OrganizationCreateResponse
+- client.access.organizations.update(accountOrZone, accountOrZoneId, { ...params }) -> OrganizationUpdateResponse
- client.access.organizations.list(accountOrZone, accountOrZoneId) -> OrganizationListResponse
-- client.access.organizations.replace(accountOrZone, accountOrZoneId, { ...params }) -> OrganizationReplaceResponse
- client.access.organizations.revokeUsers(accountOrZone, accountOrZoneId, { ...params }) -> OrganizationRevokeUsersResponse
## ServiceTokens
@@ -633,49 +633,49 @@ Methods:
Types:
- ServiceTokenCreateResponse
+- ServiceTokenUpdateResponse
- ServiceTokenListResponse
- ServiceTokenDeleteResponse
- ServiceTokenRefreshResponse
-- ServiceTokenReplaceResponse
- ServiceTokenRotateResponse
Methods:
- client.access.serviceTokens.create(accountOrZone, accountOrZoneId, { ...params }) -> ServiceTokenCreateResponse
+- client.access.serviceTokens.update(accountOrZone, accountOrZoneId, uuid, { ...params }) -> ServiceTokenUpdateResponse
- client.access.serviceTokens.list(accountOrZone, accountOrZoneId) -> ServiceTokenListResponse | null
- client.access.serviceTokens.delete(accountOrZone, accountOrZoneId, uuid) -> ServiceTokenDeleteResponse
- client.access.serviceTokens.refresh(identifier, uuid) -> ServiceTokenRefreshResponse
-- client.access.serviceTokens.replace(accountOrZone, accountOrZoneId, uuid, { ...params }) -> ServiceTokenReplaceResponse
- client.access.serviceTokens.rotate(identifier, uuid) -> ServiceTokenRotateResponse
## Bookmarks
Types:
+- BookmarkUpdateResponse
- BookmarkListResponse
- BookmarkDeleteResponse
- BookmarkGetResponse
-- BookmarkReplaceResponse
Methods:
+- client.access.bookmarks.update(identifier, uuid) -> BookmarkUpdateResponse
- client.access.bookmarks.list(identifier) -> BookmarkListResponse | null
- client.access.bookmarks.delete(identifier, uuid) -> BookmarkDeleteResponse
- client.access.bookmarks.get(identifier, uuid) -> BookmarkGetResponse
-- client.access.bookmarks.replace(identifier, uuid) -> BookmarkReplaceResponse
## Keys
Types:
+- KeyUpdateResponse
- KeyListResponse
-- KeyReplaceResponse
- KeyRotateResponse
Methods:
+- client.access.keys.update(identifier, { ...params }) -> KeyUpdateResponse
- client.access.keys.list(identifier) -> KeyListResponse
-- client.access.keys.replace(identifier, { ...params }) -> KeyReplaceResponse
- client.access.keys.rotate(identifier) -> KeyRotateResponse
## Logs
@@ -694,11 +694,11 @@ Methods:
Types:
-- SeatUpdateResponse
+- SeatEditResponse
Methods:
-- client.access.seats.update(identifier, [ ...body ]) -> SeatUpdateResponse | null
+- client.access.seats.edit(identifier, [ ...body ]) -> SeatEditResponse | null
## Users
@@ -747,36 +747,36 @@ Methods:
Types:
- CustomPageCreateResponse
+- CustomPageUpdateResponse
- CustomPageListResponse
- CustomPageDeleteResponse
- CustomPageGetResponse
-- CustomPageReplaceResponse
Methods:
- client.access.customPages.create(identifier, { ...params }) -> CustomPageCreateResponse
+- client.access.customPages.update(identifier, uuid, { ...params }) -> CustomPageUpdateResponse
- client.access.customPages.list(identifier) -> CustomPageListResponse | null
- client.access.customPages.delete(identifier, uuid) -> CustomPageDeleteResponse
- client.access.customPages.get(identifier, uuid) -> CustomPageGetResponse
-- client.access.customPages.replace(identifier, uuid, { ...params }) -> CustomPageReplaceResponse
## Tags
Types:
- TagCreateResponse
+- TagUpdateResponse
- TagListResponse
- TagDeleteResponse
- TagGetResponse
-- TagReplaceResponse
Methods:
- client.access.tags.create(identifier, { ...params }) -> TagCreateResponse
+- client.access.tags.update(identifier, tagName, { ...params }) -> TagUpdateResponse
- client.access.tags.list(identifier) -> TagListResponse | null
- client.access.tags.delete(identifier, name) -> TagDeleteResponse
- client.access.tags.get(identifier, name) -> TagGetResponse
-- client.access.tags.replace(identifier, tagName, { ...params }) -> TagReplaceResponse
# DNSAnalytics
@@ -802,56 +802,64 @@ Methods:
# Cache
+Types:
+
+- CachePurgeResponse
+
+Methods:
+
+- client.cache.purge(zoneId, { ...params }) -> CachePurgeResponse | null
+
## CacheReserves
Types:
-- CacheReserveUpdateResponse
- CacheReserveListResponse
+- CacheReserveEditResponse
Methods:
-- client.cache.cacheReserves.update(zoneId, { ...params }) -> CacheReserveUpdateResponse
- client.cache.cacheReserves.list(zoneId) -> CacheReserveListResponse
+- client.cache.cacheReserves.edit(zoneId, { ...params }) -> CacheReserveEditResponse
## TieredCacheSmartTopology
Types:
-- TieredCacheSmartTopologyUpdateResponse
- TieredCacheSmartTopologyDeleteResponse
+- TieredCacheSmartTopologyEditResponse
- TieredCacheSmartTopologyGetResponse
Methods:
-- client.cache.tieredCacheSmartTopology.update(zoneId, { ...params }) -> TieredCacheSmartTopologyUpdateResponse
- client.cache.tieredCacheSmartTopology.delete(zoneId) -> TieredCacheSmartTopologyDeleteResponse
+- client.cache.tieredCacheSmartTopology.edit(zoneId, { ...params }) -> TieredCacheSmartTopologyEditResponse
- client.cache.tieredCacheSmartTopology.get(zoneId) -> TieredCacheSmartTopologyGetResponse
## Variants
Types:
-- VariantUpdateResponse
- VariantListResponse
- VariantDeleteResponse
+- VariantEditResponse
Methods:
-- client.cache.variants.update(zoneId, { ...params }) -> VariantUpdateResponse
- client.cache.variants.list(zoneId) -> VariantListResponse
- client.cache.variants.delete(zoneId) -> VariantDeleteResponse
+- client.cache.variants.edit(zoneId, { ...params }) -> VariantEditResponse
## RegionalTieredCache
Types:
-- RegionalTieredCacheUpdateResponse
+- RegionalTieredCacheEditResponse
- RegionalTieredCacheGetResponse
Methods:
-- client.cache.regionalTieredCache.update(zoneId, { ...params }) -> RegionalTieredCacheUpdateResponse
+- client.cache.regionalTieredCache.edit(zoneId, { ...params }) -> RegionalTieredCacheEditResponse
- client.cache.regionalTieredCache.get(zoneId) -> RegionalTieredCacheGetResponse
# SSL
@@ -870,16 +878,16 @@ Methods:
Types:
-- CertificatePackUpdateResponse
- CertificatePackListResponse
- CertificatePackDeleteResponse
+- CertificatePackEditResponse
- CertificatePackGetResponse
Methods:
-- client.ssl.certificatePacks.update(zoneId, certificatePackId) -> CertificatePackUpdateResponse
- client.ssl.certificatePacks.list(zoneId, { ...params }) -> CertificatePackListResponse | null
- client.ssl.certificatePacks.delete(zoneId, certificatePackId) -> CertificatePackDeleteResponse
+- client.ssl.certificatePacks.edit(zoneId, certificatePackId) -> CertificatePackEditResponse
- client.ssl.certificatePacks.get(zoneId, certificatePackId) -> CertificatePackGetResponse
### Order
@@ -918,43 +926,43 @@ Methods:
Types:
-- SettingUpdateResponse
+- SettingEditResponse
- SettingGetResponse
Methods:
-- client.ssl.universal.settings.update(zoneId, { ...params }) -> SettingUpdateResponse
+- client.ssl.universal.settings.edit(zoneId, { ...params }) -> SettingEditResponse
- client.ssl.universal.settings.get(zoneId) -> SettingGetResponse
## Verification
Types:
-- VerificationUpdateResponse
- VerificationListResponse
+- VerificationEditResponse
Methods:
-- client.ssl.verification.update(zoneId, certificatePackId, { ...params }) -> VerificationUpdateResponse
- client.ssl.verification.list(zoneId, { ...params }) -> VerificationListResponse
+- client.ssl.verification.edit(zoneId, certificatePackId, { ...params }) -> VerificationEditResponse
# Subscriptions
Types:
- SubscriptionCreateResponse
+- SubscriptionUpdateResponse
- SubscriptionListResponse
- SubscriptionDeleteResponse
- SubscriptionGetResponse
-- SubscriptionReplaceResponse
Methods:
- client.subscriptions.create(identifier, { ...params }) -> SubscriptionCreateResponse
+- client.subscriptions.update(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionUpdateResponse
- client.subscriptions.list(accountIdentifier) -> SubscriptionListResponse | null
- client.subscriptions.delete(accountIdentifier, subscriptionIdentifier) -> SubscriptionDeleteResponse
- client.subscriptions.get(identifier) -> SubscriptionGetResponse
-- client.subscriptions.replace(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionReplaceResponse
# Acm
@@ -976,24 +984,24 @@ Methods:
Types:
-- SmartRoutingUpdateResponse
+- SmartRoutingEditResponse
- SmartRoutingGetResponse
Methods:
-- client.argo.smartRouting.update(zoneId, { ...params }) -> SmartRoutingUpdateResponse
+- client.argo.smartRouting.edit(zoneId, { ...params }) -> SmartRoutingEditResponse
- client.argo.smartRouting.get(zoneId) -> SmartRoutingGetResponse
## TieredCaching
Types:
-- TieredCachingUpdateResponse
+- TieredCachingEditResponse
- TieredCachingGetResponse
Methods:
-- client.argo.tieredCaching.update(zoneId, { ...params }) -> TieredCachingUpdateResponse
+- client.argo.tieredCaching.edit(zoneId, { ...params }) -> TieredCachingEditResponse
- client.argo.tieredCaching.get(zoneId) -> TieredCachingGetResponse
# AvailablePlans
@@ -1024,30 +1032,30 @@ Methods:
Types:
+- HostnameAssociationUpdateResponse
- HostnameAssociationListResponse
-- HostnameAssociationReplaceResponse
Methods:
+- client.certificateAuthorities.hostnameAssociations.update(zoneId, { ...params }) -> HostnameAssociationUpdateResponse
- client.certificateAuthorities.hostnameAssociations.list(zoneId, { ...params }) -> HostnameAssociationListResponse
-- client.certificateAuthorities.hostnameAssociations.replace(zoneId, { ...params }) -> HostnameAssociationReplaceResponse
# ClientCertificates
Types:
- ClientCertificateCreateResponse
-- ClientCertificateUpdateResponse
- ClientCertificateListResponse
- ClientCertificateDeleteResponse
+- ClientCertificateEditResponse
- ClientCertificateGetResponse
Methods:
- client.clientCertificates.create(zoneId, { ...params }) -> ClientCertificateCreateResponse
-- client.clientCertificates.update(zoneId, clientCertificateId) -> ClientCertificateUpdateResponse
- client.clientCertificates.list(zoneId, { ...params }) -> ClientCertificateListResponsesV4PagePaginationArray
- client.clientCertificates.delete(zoneId, clientCertificateId) -> ClientCertificateDeleteResponse
+- client.clientCertificates.edit(zoneId, clientCertificateId) -> ClientCertificateEditResponse
- client.clientCertificates.get(zoneId, clientCertificateId) -> ClientCertificateGetResponse
# CustomCertificates
@@ -1055,60 +1063,60 @@ Methods:
Types:
- CustomCertificateCreateResponse
-- CustomCertificateUpdateResponse
- CustomCertificateListResponse
- CustomCertificateDeleteResponse
+- CustomCertificateEditResponse
- CustomCertificateGetResponse
Methods:
- client.customCertificates.create(zoneId, { ...params }) -> CustomCertificateCreateResponse
-- client.customCertificates.update(zoneId, customCertificateId, { ...params }) -> CustomCertificateUpdateResponse
- client.customCertificates.list(zoneId, { ...params }) -> CustomCertificateListResponsesV4PagePaginationArray
- client.customCertificates.delete(zoneId, customCertificateId) -> CustomCertificateDeleteResponse
+- client.customCertificates.edit(zoneId, customCertificateId, { ...params }) -> CustomCertificateEditResponse
- client.customCertificates.get(zoneId, customCertificateId) -> CustomCertificateGetResponse
## Prioritize
Types:
-- PrioritizeReplaceResponse
+- PrioritizeUpdateResponse
Methods:
-- client.customCertificates.prioritize.replace(zoneId, { ...params }) -> PrioritizeReplaceResponse | null
+- client.customCertificates.prioritize.update(zoneId, { ...params }) -> PrioritizeUpdateResponse | null
# CustomHostnames
Types:
- CustomHostnameCreateResponse
-- CustomHostnameUpdateResponse
- CustomHostnameListResponse
- CustomHostnameDeleteResponse
+- CustomHostnameEditResponse
- CustomHostnameGetResponse
Methods:
- client.customHostnames.create(zoneId, { ...params }) -> CustomHostnameCreateResponse
-- client.customHostnames.update(zoneId, customHostnameId, { ...params }) -> CustomHostnameUpdateResponse
- client.customHostnames.list(zoneId, { ...params }) -> CustomHostnameListResponsesV4PagePaginationArray
- client.customHostnames.delete(zoneId, customHostnameId) -> CustomHostnameDeleteResponse
+- client.customHostnames.edit(zoneId, customHostnameId, { ...params }) -> CustomHostnameEditResponse
- client.customHostnames.get(zoneId, customHostnameId) -> CustomHostnameGetResponse
## FallbackOrigin
Types:
+- FallbackOriginUpdateResponse
- FallbackOriginDeleteResponse
- FallbackOriginGetResponse
-- FallbackOriginReplaceResponse
Methods:
+- client.customHostnames.fallbackOrigin.update(zoneId, { ...params }) -> FallbackOriginUpdateResponse
- client.customHostnames.fallbackOrigin.delete(zoneId) -> FallbackOriginDeleteResponse
- client.customHostnames.fallbackOrigin.get(zoneId) -> FallbackOriginGetResponse
-- client.customHostnames.fallbackOrigin.replace(zoneId, { ...params }) -> FallbackOriginReplaceResponse
# CustomNameservers
@@ -1133,37 +1141,37 @@ Methods:
Types:
- DNSRecordCreateResponse
+- DNSRecordUpdateResponse
- DNSRecordListResponse
- DNSRecordDeleteResponse
- DNSRecordExportResponse
- DNSRecordGetResponse
- DNSRecordImportResponse
-- DNSRecordReplaceResponse
- DNSRecordScanResponse
Methods:
- client.dnsRecords.create(zoneId, { ...params }) -> DNSRecordCreateResponse
+- client.dnsRecords.update(zoneId, dnsRecordId, { ...params }) -> DNSRecordUpdateResponse
- client.dnsRecords.list(zoneId, { ...params }) -> DNSRecordListResponsesV4PagePaginationArray
- client.dnsRecords.delete(zoneId, dnsRecordId) -> DNSRecordDeleteResponse
- client.dnsRecords.export(zoneId) -> string
- client.dnsRecords.get(zoneId, dnsRecordId) -> DNSRecordGetResponse
- client.dnsRecords.import(zoneId, { ...params }) -> DNSRecordImportResponse
-- client.dnsRecords.replace(zoneId, dnsRecordId, { ...params }) -> DNSRecordReplaceResponse
- client.dnsRecords.scan(zoneId) -> DNSRecordScanResponse
# DNSSEC
Types:
-- DNSSECUpdateResponse
- DNSSECDeleteResponse
+- DNSSECEditResponse
- DNSSECGetResponse
Methods:
-- client.dnssec.update(zoneId, { ...params }) -> DNSSECUpdateResponse
- client.dnssec.delete(zoneId) -> DNSSECDeleteResponse
+- client.dnssec.edit(zoneId, { ...params }) -> DNSSECEditResponse
- client.dnssec.get(zoneId) -> DNSSECGetResponse
# Emails
@@ -1213,30 +1221,30 @@ Methods:
Types:
- RuleCreateResponse
+- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
- RuleGetResponse
-- RuleReplaceResponse
Methods:
- client.emails.routing.rules.create(zoneIdentifier, { ...params }) -> RuleCreateResponse
+- client.emails.routing.rules.update(zoneIdentifier, ruleIdentifier, { ...params }) -> RuleUpdateResponse
- client.emails.routing.rules.list(zoneIdentifier, { ...params }) -> RuleListResponsesV4PagePaginationArray
- client.emails.routing.rules.delete(zoneIdentifier, ruleIdentifier) -> RuleDeleteResponse
- client.emails.routing.rules.get(zoneIdentifier, ruleIdentifier) -> RuleGetResponse
-- client.emails.routing.rules.replace(zoneIdentifier, ruleIdentifier, { ...params }) -> RuleReplaceResponse
#### CatchAlls
Types:
+- CatchAllUpdateResponse
- CatchAllGetResponse
-- CatchAllReplaceResponse
Methods:
+- client.emails.routing.rules.catchAlls.update(zoneIdentifier, { ...params }) -> CatchAllUpdateResponse
- client.emails.routing.rules.catchAlls.get(zoneIdentifier) -> CatchAllGetResponse
-- client.emails.routing.rules.catchAlls.replace(zoneIdentifier, { ...params }) -> CatchAllReplaceResponse
### Addresses
@@ -1259,18 +1267,18 @@ Methods:
Types:
- FilterCreateResponse
+- FilterUpdateResponse
- FilterListResponse
- FilterDeleteResponse
- FilterGetResponse
-- FilterReplaceResponse
Methods:
- client.filters.create(zoneIdentifier, { ...params }) -> FilterCreateResponse | null
+- client.filters.update(zoneIdentifier, id, { ...params }) -> FilterUpdateResponse | null
- client.filters.list(zoneIdentifier, { ...params }) -> FilterListResponsesV4PagePaginationArray
- client.filters.delete(zoneIdentifier, id) -> FilterDeleteResponse | null
- client.filters.get(zoneIdentifier, id) -> FilterGetResponse | null
-- client.filters.replace(zoneIdentifier, id, { ...params }) -> FilterReplaceResponse | null
# Firewalls
@@ -1279,18 +1287,18 @@ Methods:
Types:
- LockdownCreateResponse
+- LockdownUpdateResponse
- LockdownListResponse
- LockdownDeleteResponse
- LockdownGetResponse
-- LockdownReplaceResponse
Methods:
- client.firewalls.lockdowns.create(zoneIdentifier, { ...params }) -> LockdownCreateResponse | null
+- client.firewalls.lockdowns.update(zoneIdentifier, id, { ...params }) -> LockdownUpdateResponse | null
- client.firewalls.lockdowns.list(zoneIdentifier, { ...params }) -> LockdownListResponsesV4PagePaginationArray
- client.firewalls.lockdowns.delete(zoneIdentifier, id) -> LockdownDeleteResponse
- client.firewalls.lockdowns.get(zoneIdentifier, id) -> LockdownGetResponse | null
-- client.firewalls.lockdowns.replace(zoneIdentifier, id, { ...params }) -> LockdownReplaceResponse | null
## Rules
@@ -1300,34 +1308,34 @@ Types:
- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
+- RuleEditResponse
- RuleGetResponse
-- RuleReplaceResponse
Methods:
- client.firewalls.rules.create(zoneIdentifier, { ...params }) -> RuleCreateResponse | null
-- client.firewalls.rules.update(zoneIdentifier, { ...params }) -> RuleUpdateResponse | null
+- client.firewalls.rules.update(zoneIdentifier, id, { ...params }) -> RuleUpdateResponse | null
- client.firewalls.rules.list(zoneIdentifier, { ...params }) -> RuleListResponsesV4PagePaginationArray
- client.firewalls.rules.delete(zoneIdentifier, id, { ...params }) -> RuleDeleteResponse | null
+- client.firewalls.rules.edit(zoneIdentifier, { ...params }) -> RuleEditResponse | null
- client.firewalls.rules.get(zoneIdentifier, id) -> RuleGetResponse | null
-- client.firewalls.rules.replace(zoneIdentifier, id, { ...params }) -> RuleReplaceResponse | null
## AccessRules
Types:
- AccessRuleCreateResponse
-- AccessRuleUpdateResponse
- AccessRuleListResponse
- AccessRuleDeleteResponse
+- AccessRuleEditResponse
- AccessRuleGetResponse
Methods:
- client.firewalls.accessRules.create(accountOrZone, accountOrZoneId, { ...params }) -> AccessRuleCreateResponse | null
-- client.firewalls.accessRules.update(identifier, { ...params }) -> AccessRuleUpdateResponse | null
- client.firewalls.accessRules.list(accountOrZone, accountOrZoneId, { ...params }) -> AccessRuleListResponsesV4PagePaginationArray
- client.firewalls.accessRules.delete(accountOrZone, accountOrZoneId, identifier) -> AccessRuleDeleteResponse | null
+- client.firewalls.accessRules.edit(identifier, { ...params }) -> AccessRuleEditResponse | null
- client.firewalls.accessRules.get(accountOrZone, accountOrZoneId, identifier) -> AccessRuleGetResponse | null
## UaRules
@@ -1335,18 +1343,18 @@ Methods:
Types:
- UaRuleCreateResponse
+- UaRuleUpdateResponse
- UaRuleListResponse
- UaRuleDeleteResponse
- UaRuleGetResponse
-- UaRuleReplaceResponse
Methods:
- client.firewalls.uaRules.create(zoneIdentifier, { ...params }) -> UaRuleCreateResponse | null
+- client.firewalls.uaRules.update(zoneIdentifier, id, { ...params }) -> UaRuleUpdateResponse | null
- client.firewalls.uaRules.list(zoneIdentifier, { ...params }) -> UaRuleListResponsesV4PagePaginationArray
- client.firewalls.uaRules.delete(zoneIdentifier, id) -> UaRuleDeleteResponse | null
- client.firewalls.uaRules.get(zoneIdentifier, id) -> UaRuleGetResponse | null
-- client.firewalls.uaRules.replace(zoneIdentifier, id, { ...params }) -> UaRuleReplaceResponse | null
## WAF
@@ -1355,18 +1363,18 @@ Methods:
Types:
- OverrideCreateResponse
+- OverrideUpdateResponse
- OverrideListResponse
- OverrideDeleteResponse
- OverrideGetResponse
-- OverrideReplaceResponse
Methods:
- client.firewalls.waf.overrides.create(zoneIdentifier, { ...params }) -> OverrideCreateResponse | null
+- client.firewalls.waf.overrides.update(zoneIdentifier, id, { ...params }) -> OverrideUpdateResponse | null
- client.firewalls.waf.overrides.list(zoneIdentifier, { ...params }) -> OverrideListResponsesV4PagePaginationArray
- client.firewalls.waf.overrides.delete(zoneIdentifier, id) -> OverrideDeleteResponse
- client.firewalls.waf.overrides.get(zoneIdentifier, id) -> OverrideGetResponse | null
-- client.firewalls.waf.overrides.replace(zoneIdentifier, id, { ...params }) -> OverrideReplaceResponse | null
### Packages
@@ -1384,27 +1392,27 @@ Methods:
Types:
-- GroupUpdateResponse
- GroupListResponse
+- GroupEditResponse
- GroupGetResponse
Methods:
-- client.firewalls.waf.packages.groups.update(zoneId, packageId, groupId, { ...params }) -> GroupUpdateResponse
- client.firewalls.waf.packages.groups.list(zoneId, packageId, { ...params }) -> GroupListResponsesV4PagePaginationArray
+- client.firewalls.waf.packages.groups.edit(zoneId, packageId, groupId, { ...params }) -> GroupEditResponse
- client.firewalls.waf.packages.groups.get(zoneId, packageId, groupId) -> GroupGetResponse
#### Rules
Types:
-- RuleUpdateResponse
+- RuleEditResponse
- RuleGetResponse
- RuleWAFRulesListWAFRulesResponse
Methods:
-- client.firewalls.waf.packages.rules.update(zoneId, packageId, ruleId, { ...params }) -> RuleUpdateResponse
+- client.firewalls.waf.packages.rules.edit(zoneId, packageId, ruleId, { ...params }) -> RuleEditResponse
- client.firewalls.waf.packages.rules.get(zoneId, packageId, ruleId) -> RuleGetResponse
- client.firewalls.waf.packages.rules.wafRulesListWAFRules(zoneId, packageId, { ...params }) -> RuleWAFRulesListWAFRulesResponse | null
@@ -1413,18 +1421,18 @@ Methods:
Types:
- HealthcheckCreateResponse
+- HealthcheckUpdateResponse
- HealthcheckListResponse
- HealthcheckDeleteResponse
- HealthcheckGetResponse
-- HealthcheckReplaceResponse
Methods:
- client.healthchecks.create(zoneIdentifier, { ...params }) -> HealthcheckCreateResponse
+- client.healthchecks.update(zoneIdentifier, identifier, { ...params }) -> HealthcheckUpdateResponse
- client.healthchecks.list(zoneIdentifier) -> HealthcheckListResponse | null
- client.healthchecks.delete(zoneIdentifier, identifier) -> HealthcheckDeleteResponse
- client.healthchecks.get(zoneIdentifier, identifier) -> HealthcheckGetResponse
-- client.healthchecks.replace(zoneIdentifier, identifier, { ...params }) -> HealthcheckReplaceResponse
## Previews
@@ -1445,17 +1453,17 @@ Methods:
Types:
- KeylessCertificateCreateResponse
-- KeylessCertificateUpdateResponse
- KeylessCertificateListResponse
- KeylessCertificateDeleteResponse
+- KeylessCertificateEditResponse
- KeylessCertificateGetResponse
Methods:
- client.keylessCertificates.create(zoneId, { ...params }) -> KeylessCertificateCreateResponse
-- client.keylessCertificates.update(zoneId, keylessCertificateId, { ...params }) -> KeylessCertificateUpdateResponse
- client.keylessCertificates.list(zoneId) -> KeylessCertificateListResponse | null
- client.keylessCertificates.delete(zoneId, keylessCertificateId) -> KeylessCertificateDeleteResponse
+- client.keylessCertificates.edit(zoneId, keylessCertificateId, { ...params }) -> KeylessCertificateEditResponse
- client.keylessCertificates.get(zoneId, keylessCertificateId) -> KeylessCertificateGetResponse
# Logpush
@@ -1499,18 +1507,18 @@ Methods:
Types:
- JobCreateResponse
+- JobUpdateResponse
- JobListResponse
- JobDeleteResponse
- JobGetResponse
-- JobReplaceResponse
Methods:
- client.logpush.jobs.create(accountOrZone, accountOrZoneId, { ...params }) -> JobCreateResponse | null
+- client.logpush.jobs.update(accountOrZone, accountOrZoneId, jobId, { ...params }) -> JobUpdateResponse | null
- client.logpush.jobs.list(accountOrZone, accountOrZoneId) -> JobListResponse
- client.logpush.jobs.delete(accountOrZone, accountOrZoneId, jobId) -> JobDeleteResponse | null
- client.logpush.jobs.get(accountOrZone, accountOrZoneId, jobId) -> JobGetResponse | null
-- client.logpush.jobs.replace(accountOrZone, accountOrZoneId, jobId, { ...params }) -> JobReplaceResponse | null
## Ownership
@@ -1620,13 +1628,13 @@ Methods:
Types:
+- HostnameUpdateResponse
- HostnameGetResponse
-- HostnameReplaceResponse
Methods:
+- client.originTLSClientAuth.hostnames.update(zoneId, { ...params }) -> HostnameUpdateResponse | null
- client.originTLSClientAuth.hostnames.get(zoneId, hostname) -> HostnameGetResponse
-- client.originTLSClientAuth.hostnames.replace(zoneId, { ...params }) -> HostnameReplaceResponse | null
### Certificates
@@ -1648,31 +1656,31 @@ Methods:
Types:
+- SettingUpdateResponse
- SettingGetResponse
-- SettingReplaceResponse
Methods:
+- client.originTLSClientAuth.settings.update(zoneId, { ...params }) -> SettingUpdateResponse
- client.originTLSClientAuth.settings.get(zoneId) -> SettingGetResponse
-- client.originTLSClientAuth.settings.replace(zoneId, { ...params }) -> SettingReplaceResponse
# Pagerules
Types:
- PageruleCreateResponse
+- PageruleUpdateResponse
- PageruleListResponse
- PageruleDeleteResponse
- PageruleGetResponse
-- PageruleReplaceResponse
Methods:
- client.pagerules.create(zoneId, { ...params }) -> PageruleCreateResponse
+- client.pagerules.update(zoneId, pageruleId, { ...params }) -> PageruleUpdateResponse
- client.pagerules.list(zoneId, { ...params }) -> PageruleListResponse
- client.pagerules.delete(zoneId, pageruleId) -> PageruleDeleteResponse | null
- client.pagerules.get(zoneId, pageruleId) -> PageruleGetResponse
-- client.pagerules.replace(zoneId, pageruleId, { ...params }) -> PageruleReplaceResponse
## Settings
@@ -1689,17 +1697,17 @@ Methods:
Types:
- RateLimitCreateResponse
-- RateLimitUpdateResponse
- RateLimitListResponse
- RateLimitDeleteResponse
+- RateLimitEditResponse
- RateLimitGetResponse
Methods:
- client.rateLimits.create(zoneIdentifier, { ...params }) -> RateLimitCreateResponse | null
-- client.rateLimits.update(zoneIdentifier, id, { ...params }) -> RateLimitUpdateResponse | 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
# SecondaryDNS
@@ -1719,38 +1727,38 @@ Methods:
Types:
- IncomingCreateResponse
+- IncomingUpdateResponse
- IncomingDeleteResponse
- IncomingGetResponse
-- IncomingReplaceResponse
Methods:
- client.secondaryDNS.incoming.create(zoneId, { ...params }) -> IncomingCreateResponse
+- client.secondaryDNS.incoming.update(zoneId, { ...params }) -> IncomingUpdateResponse
- client.secondaryDNS.incoming.delete(zoneId) -> IncomingDeleteResponse
- client.secondaryDNS.incoming.get(zoneId) -> IncomingGetResponse
-- client.secondaryDNS.incoming.replace(zoneId, { ...params }) -> IncomingReplaceResponse
## Outgoing
Types:
- OutgoingCreateResponse
+- OutgoingUpdateResponse
- OutgoingDeleteResponse
- OutgoingDisableResponse
- OutgoingEnableResponse
- OutgoingForceNotifyResponse
- OutgoingGetResponse
-- OutgoingReplaceResponse
Methods:
- client.secondaryDNS.outgoing.create(zoneId, { ...params }) -> OutgoingCreateResponse
+- client.secondaryDNS.outgoing.update(zoneId, { ...params }) -> OutgoingUpdateResponse
- client.secondaryDNS.outgoing.delete(zoneId) -> OutgoingDeleteResponse
- client.secondaryDNS.outgoing.disable(zoneId) -> OutgoingDisableResponse
- client.secondaryDNS.outgoing.enable(zoneId) -> OutgoingEnableResponse
- client.secondaryDNS.outgoing.forceNotify(zoneId) -> OutgoingForceNotifyResponse
- client.secondaryDNS.outgoing.get(zoneId) -> OutgoingGetResponse
-- client.secondaryDNS.outgoing.replace(zoneId, { ...params }) -> OutgoingReplaceResponse
### Status
@@ -1767,54 +1775,54 @@ Methods:
Types:
- ACLCreateResponse
+- ACLUpdateResponse
- ACLListResponse
- ACLDeleteResponse
- ACLGetResponse
-- ACLReplaceResponse
Methods:
- client.secondaryDNS.acls.create(accountId, { ...params }) -> ACLCreateResponse
+- client.secondaryDNS.acls.update(accountId, aclId, { ...params }) -> ACLUpdateResponse
- client.secondaryDNS.acls.list(accountId) -> ACLListResponse | null
- client.secondaryDNS.acls.delete(accountId, aclId) -> ACLDeleteResponse
- client.secondaryDNS.acls.get(accountId, aclId) -> ACLGetResponse
-- client.secondaryDNS.acls.replace(accountId, aclId, { ...params }) -> ACLReplaceResponse
## Peers
Types:
- PeerCreateResponse
+- PeerUpdateResponse
- PeerListResponse
- PeerDeleteResponse
- PeerGetResponse
-- PeerReplaceResponse
Methods:
- client.secondaryDNS.peers.create(accountId, { ...params }) -> PeerCreateResponse
+- client.secondaryDNS.peers.update(accountId, peerId, { ...params }) -> PeerUpdateResponse
- client.secondaryDNS.peers.list(accountId) -> PeerListResponse | null
- client.secondaryDNS.peers.delete(accountId, peerId) -> PeerDeleteResponse
- client.secondaryDNS.peers.get(accountId, peerId) -> PeerGetResponse
-- client.secondaryDNS.peers.replace(accountId, peerId, { ...params }) -> PeerReplaceResponse
## Tsigs
Types:
- TsigCreateResponse
+- TsigUpdateResponse
- TsigListResponse
- TsigDeleteResponse
- TsigGetResponse
-- TsigReplaceResponse
Methods:
- client.secondaryDNS.tsigs.create(accountId, { ...params }) -> TsigCreateResponse
+- client.secondaryDNS.tsigs.update(accountId, tsigId, { ...params }) -> TsigUpdateResponse
- client.secondaryDNS.tsigs.list(accountId) -> TsigListResponse | null
- client.secondaryDNS.tsigs.delete(accountId, tsigId) -> TsigDeleteResponse
- client.secondaryDNS.tsigs.get(accountId, tsigId) -> TsigGetResponse
-- client.secondaryDNS.tsigs.replace(accountId, tsigId, { ...params }) -> TsigReplaceResponse
# Settings
@@ -1832,12 +1840,12 @@ Methods:
Types:
-- ZeroRttUpdateResponse
+- ZeroRttEditResponse
- ZeroRttGetResponse
Methods:
-- client.settings.zeroRtt.update(zoneId, { ...params }) -> ZeroRttUpdateResponse
+- client.settings.zeroRtt.edit(zoneId, { ...params }) -> ZeroRttEditResponse
- client.settings.zeroRtt.get(zoneId) -> ZeroRttGetResponse
## AdvancedDDOS
@@ -1854,588 +1862,588 @@ Methods:
Types:
-- AlwaysOnlineUpdateResponse
+- AlwaysOnlineEditResponse
- AlwaysOnlineGetResponse
Methods:
-- client.settings.alwaysOnline.update(zoneId, { ...params }) -> AlwaysOnlineUpdateResponse
+- client.settings.alwaysOnline.edit(zoneId, { ...params }) -> AlwaysOnlineEditResponse
- client.settings.alwaysOnline.get(zoneId) -> AlwaysOnlineGetResponse
## AlwaysUseHTTPS
Types:
-- AlwaysUseHTTPSUpdateResponse
+- AlwaysUseHTTPSEditResponse
- AlwaysUseHTTPSGetResponse
Methods:
-- client.settings.alwaysUseHTTPS.update(zoneId, { ...params }) -> AlwaysUseHTTPSUpdateResponse
+- client.settings.alwaysUseHTTPS.edit(zoneId, { ...params }) -> AlwaysUseHTTPSEditResponse
- client.settings.alwaysUseHTTPS.get(zoneId) -> AlwaysUseHTTPSGetResponse
## AutomaticHTTPSRewrites
Types:
-- AutomaticHTTPSRewriteUpdateResponse
+- AutomaticHTTPSRewriteEditResponse
- AutomaticHTTPSRewriteGetResponse
Methods:
-- client.settings.automaticHTTPSRewrites.update(zoneId, { ...params }) -> AutomaticHTTPSRewriteUpdateResponse
+- client.settings.automaticHTTPSRewrites.edit(zoneId, { ...params }) -> AutomaticHTTPSRewriteEditResponse
- client.settings.automaticHTTPSRewrites.get(zoneId) -> AutomaticHTTPSRewriteGetResponse
## AutomaticPlatformOptimization
Types:
-- AutomaticPlatformOptimizationUpdateResponse
+- AutomaticPlatformOptimizationEditResponse
- AutomaticPlatformOptimizationGetResponse
Methods:
-- client.settings.automaticPlatformOptimization.update(zoneId, { ...params }) -> AutomaticPlatformOptimizationUpdateResponse
+- client.settings.automaticPlatformOptimization.edit(zoneId, { ...params }) -> AutomaticPlatformOptimizationEditResponse
- client.settings.automaticPlatformOptimization.get(zoneId) -> AutomaticPlatformOptimizationGetResponse
## Brotli
Types:
-- BrotliUpdateResponse
+- BrotliEditResponse
- BrotliGetResponse
Methods:
-- client.settings.brotli.update(zoneId, { ...params }) -> BrotliUpdateResponse
+- client.settings.brotli.edit(zoneId, { ...params }) -> BrotliEditResponse
- client.settings.brotli.get(zoneId) -> BrotliGetResponse
## BrowserCacheTTL
Types:
-- BrowserCacheTTLUpdateResponse
+- BrowserCacheTTLEditResponse
- BrowserCacheTTLGetResponse
Methods:
-- client.settings.browserCacheTTL.update(zoneId, { ...params }) -> BrowserCacheTTLUpdateResponse
+- client.settings.browserCacheTTL.edit(zoneId, { ...params }) -> BrowserCacheTTLEditResponse
- client.settings.browserCacheTTL.get(zoneId) -> BrowserCacheTTLGetResponse
## BrowserCheck
Types:
-- BrowserCheckUpdateResponse
+- BrowserCheckEditResponse
- BrowserCheckGetResponse
Methods:
-- client.settings.browserCheck.update(zoneId, { ...params }) -> BrowserCheckUpdateResponse
+- client.settings.browserCheck.edit(zoneId, { ...params }) -> BrowserCheckEditResponse
- client.settings.browserCheck.get(zoneId) -> BrowserCheckGetResponse
## CacheLevel
Types:
-- CacheLevelUpdateResponse
+- CacheLevelEditResponse
- CacheLevelGetResponse
Methods:
-- client.settings.cacheLevel.update(zoneId, { ...params }) -> CacheLevelUpdateResponse
+- client.settings.cacheLevel.edit(zoneId, { ...params }) -> CacheLevelEditResponse
- client.settings.cacheLevel.get(zoneId) -> CacheLevelGetResponse
## ChallengeTTL
Types:
-- ChallengeTTLUpdateResponse
+- ChallengeTTLEditResponse
- ChallengeTTLGetResponse
Methods:
-- client.settings.challengeTTL.update(zoneId, { ...params }) -> ChallengeTTLUpdateResponse
+- client.settings.challengeTTL.edit(zoneId, { ...params }) -> ChallengeTTLEditResponse
- client.settings.challengeTTL.get(zoneId) -> ChallengeTTLGetResponse
## Ciphers
Types:
-- CipherUpdateResponse
+- CipherEditResponse
- CipherGetResponse
Methods:
-- client.settings.ciphers.update(zoneId, { ...params }) -> CipherUpdateResponse
+- client.settings.ciphers.edit(zoneId, { ...params }) -> CipherEditResponse
- client.settings.ciphers.get(zoneId) -> CipherGetResponse
## DevelopmentMode
Types:
-- DevelopmentModeUpdateResponse
+- DevelopmentModeEditResponse
- DevelopmentModeGetResponse
Methods:
-- client.settings.developmentMode.update(zoneId, { ...params }) -> DevelopmentModeUpdateResponse
+- client.settings.developmentMode.edit(zoneId, { ...params }) -> DevelopmentModeEditResponse
- client.settings.developmentMode.get(zoneId) -> DevelopmentModeGetResponse
## EarlyHints
Types:
-- EarlyHintUpdateResponse
+- EarlyHintEditResponse
- EarlyHintGetResponse
Methods:
-- client.settings.earlyHints.update(zoneId, { ...params }) -> EarlyHintUpdateResponse
+- client.settings.earlyHints.edit(zoneId, { ...params }) -> EarlyHintEditResponse
- client.settings.earlyHints.get(zoneId) -> EarlyHintGetResponse
## EmailObfuscation
Types:
-- EmailObfuscationUpdateResponse
+- EmailObfuscationEditResponse
- EmailObfuscationGetResponse
Methods:
-- client.settings.emailObfuscation.update(zoneId, { ...params }) -> EmailObfuscationUpdateResponse
+- client.settings.emailObfuscation.edit(zoneId, { ...params }) -> EmailObfuscationEditResponse
- client.settings.emailObfuscation.get(zoneId) -> EmailObfuscationGetResponse
## H2Prioritization
Types:
-- H2PrioritizationUpdateResponse
+- H2PrioritizationEditResponse
- H2PrioritizationGetResponse
Methods:
-- client.settings.h2Prioritization.update(zoneId, { ...params }) -> H2PrioritizationUpdateResponse
+- client.settings.h2Prioritization.edit(zoneId, { ...params }) -> H2PrioritizationEditResponse
- client.settings.h2Prioritization.get(zoneId) -> H2PrioritizationGetResponse
## HotlinkProtection
Types:
-- HotlinkProtectionUpdateResponse
+- HotlinkProtectionEditResponse
- HotlinkProtectionGetResponse
Methods:
-- client.settings.hotlinkProtection.update(zoneId, { ...params }) -> HotlinkProtectionUpdateResponse
+- client.settings.hotlinkProtection.edit(zoneId, { ...params }) -> HotlinkProtectionEditResponse
- client.settings.hotlinkProtection.get(zoneId) -> HotlinkProtectionGetResponse
## HTTP2
Types:
-- HTTP2UpdateResponse
+- HTTP2EditResponse
- HTTP2GetResponse
Methods:
-- client.settings.http2.update(zoneId, { ...params }) -> HTTP2UpdateResponse
+- client.settings.http2.edit(zoneId, { ...params }) -> HTTP2EditResponse
- client.settings.http2.get(zoneId) -> HTTP2GetResponse
## HTTP3
Types:
-- HTTP3UpdateResponse
+- HTTP3EditResponse
- HTTP3GetResponse
Methods:
-- client.settings.http3.update(zoneId, { ...params }) -> HTTP3UpdateResponse
+- client.settings.http3.edit(zoneId, { ...params }) -> HTTP3EditResponse
- client.settings.http3.get(zoneId) -> HTTP3GetResponse
## ImageResizing
Types:
-- ImageResizingUpdateResponse
+- ImageResizingEditResponse
- ImageResizingGetResponse
Methods:
-- client.settings.imageResizing.update(zoneId, { ...params }) -> ImageResizingUpdateResponse
+- client.settings.imageResizing.edit(zoneId, { ...params }) -> ImageResizingEditResponse
- client.settings.imageResizing.get(zoneId) -> ImageResizingGetResponse
## IPGeolocation
Types:
-- IPGeolocationUpdateResponse
+- IPGeolocationEditResponse
- IPGeolocationGetResponse
Methods:
-- client.settings.ipGeolocation.update(zoneId, { ...params }) -> IPGeolocationUpdateResponse
+- client.settings.ipGeolocation.edit(zoneId, { ...params }) -> IPGeolocationEditResponse
- client.settings.ipGeolocation.get(zoneId) -> IPGeolocationGetResponse
## IPV6
Types:
-- IPV6UpdateResponse
+- IPV6EditResponse
- IPV6GetResponse
Methods:
-- client.settings.ipv6.update(zoneId, { ...params }) -> IPV6UpdateResponse
+- client.settings.ipv6.edit(zoneId, { ...params }) -> IPV6EditResponse
- client.settings.ipv6.get(zoneId) -> IPV6GetResponse
## MinTLSVersion
Types:
-- MinTLSVersionUpdateResponse
+- MinTLSVersionEditResponse
- MinTLSVersionGetResponse
Methods:
-- client.settings.minTLSVersion.update(zoneId, { ...params }) -> MinTLSVersionUpdateResponse
+- client.settings.minTLSVersion.edit(zoneId, { ...params }) -> MinTLSVersionEditResponse
- client.settings.minTLSVersion.get(zoneId) -> MinTLSVersionGetResponse
## Minify
Types:
-- MinifyUpdateResponse
+- MinifyEditResponse
- MinifyGetResponse
Methods:
-- client.settings.minify.update(zoneId, { ...params }) -> MinifyUpdateResponse
+- client.settings.minify.edit(zoneId, { ...params }) -> MinifyEditResponse
- client.settings.minify.get(zoneId) -> MinifyGetResponse
## Mirage
Types:
-- MirageUpdateResponse
+- MirageEditResponse
- MirageGetResponse
Methods:
-- client.settings.mirage.update(zoneId, { ...params }) -> MirageUpdateResponse
+- client.settings.mirage.edit(zoneId, { ...params }) -> MirageEditResponse
- client.settings.mirage.get(zoneId) -> MirageGetResponse
## MobileRedirect
Types:
-- MobileRedirectUpdateResponse
+- MobileRedirectEditResponse
- MobileRedirectGetResponse
Methods:
-- client.settings.mobileRedirect.update(zoneId, { ...params }) -> MobileRedirectUpdateResponse
+- client.settings.mobileRedirect.edit(zoneId, { ...params }) -> MobileRedirectEditResponse
- client.settings.mobileRedirect.get(zoneId) -> MobileRedirectGetResponse
## NEL
Types:
-- NELUpdateResponse
+- NELEditResponse
- NELGetResponse
Methods:
-- client.settings.nel.update(zoneId, { ...params }) -> NELUpdateResponse
+- client.settings.nel.edit(zoneId, { ...params }) -> NELEditResponse
- client.settings.nel.get(zoneId) -> NELGetResponse
## OpportunisticEncryption
Types:
-- OpportunisticEncryptionUpdateResponse
+- OpportunisticEncryptionEditResponse
- OpportunisticEncryptionGetResponse
Methods:
-- client.settings.opportunisticEncryption.update(zoneId, { ...params }) -> OpportunisticEncryptionUpdateResponse
+- client.settings.opportunisticEncryption.edit(zoneId, { ...params }) -> OpportunisticEncryptionEditResponse
- client.settings.opportunisticEncryption.get(zoneId) -> OpportunisticEncryptionGetResponse
## OpportunisticOnion
Types:
-- OpportunisticOnionUpdateResponse
+- OpportunisticOnionEditResponse
- OpportunisticOnionGetResponse
Methods:
-- client.settings.opportunisticOnion.update(zoneId, { ...params }) -> OpportunisticOnionUpdateResponse
+- client.settings.opportunisticOnion.edit(zoneId, { ...params }) -> OpportunisticOnionEditResponse
- client.settings.opportunisticOnion.get(zoneId) -> OpportunisticOnionGetResponse
## OrangeToOrange
Types:
-- OrangeToOrangeUpdateResponse
+- OrangeToOrangeEditResponse
- OrangeToOrangeGetResponse
Methods:
-- client.settings.orangeToOrange.update(zoneId, { ...params }) -> OrangeToOrangeUpdateResponse
+- client.settings.orangeToOrange.edit(zoneId, { ...params }) -> OrangeToOrangeEditResponse
- client.settings.orangeToOrange.get(zoneId) -> OrangeToOrangeGetResponse
## OriginErrorPagePassThru
Types:
-- OriginErrorPagePassThruUpdateResponse
+- OriginErrorPagePassThruEditResponse
- OriginErrorPagePassThruGetResponse
Methods:
-- client.settings.originErrorPagePassThru.update(zoneId, { ...params }) -> OriginErrorPagePassThruUpdateResponse
+- client.settings.originErrorPagePassThru.edit(zoneId, { ...params }) -> OriginErrorPagePassThruEditResponse
- client.settings.originErrorPagePassThru.get(zoneId) -> OriginErrorPagePassThruGetResponse
## OriginMaxHTTPVersion
Types:
-- OriginMaxHTTPVersionUpdateResponse
+- OriginMaxHTTPVersionEditResponse
- OriginMaxHTTPVersionGetResponse
Methods:
-- client.settings.originMaxHTTPVersion.update(zoneId, { ...params }) -> OriginMaxHTTPVersionUpdateResponse
+- client.settings.originMaxHTTPVersion.edit(zoneId, { ...params }) -> OriginMaxHTTPVersionEditResponse
- client.settings.originMaxHTTPVersion.get(zoneId) -> OriginMaxHTTPVersionGetResponse
## Polish
Types:
-- PolishUpdateResponse
+- PolishEditResponse
- PolishGetResponse
Methods:
-- client.settings.polish.update(zoneId, { ...params }) -> PolishUpdateResponse
+- client.settings.polish.edit(zoneId, { ...params }) -> PolishEditResponse
- client.settings.polish.get(zoneId) -> PolishGetResponse
## PrefetchPreload
Types:
-- PrefetchPreloadUpdateResponse
+- PrefetchPreloadEditResponse
- PrefetchPreloadGetResponse
Methods:
-- client.settings.prefetchPreload.update(zoneId, { ...params }) -> PrefetchPreloadUpdateResponse
+- client.settings.prefetchPreload.edit(zoneId, { ...params }) -> PrefetchPreloadEditResponse
- client.settings.prefetchPreload.get(zoneId) -> PrefetchPreloadGetResponse
## ProxyReadTimeout
Types:
-- ProxyReadTimeoutUpdateResponse
+- ProxyReadTimeoutEditResponse
- ProxyReadTimeoutGetResponse
Methods:
-- client.settings.proxyReadTimeout.update(zoneId, { ...params }) -> ProxyReadTimeoutUpdateResponse
+- client.settings.proxyReadTimeout.edit(zoneId, { ...params }) -> ProxyReadTimeoutEditResponse
- client.settings.proxyReadTimeout.get(zoneId) -> ProxyReadTimeoutGetResponse
## PseudoIPV4
Types:
-- PseudoIPV4UpdateResponse
+- PseudoIPV4EditResponse
- PseudoIPV4GetResponse
Methods:
-- client.settings.pseudoIPV4.update(zoneId, { ...params }) -> PseudoIPV4UpdateResponse
+- client.settings.pseudoIPV4.edit(zoneId, { ...params }) -> PseudoIPV4EditResponse
- client.settings.pseudoIPV4.get(zoneId) -> PseudoIPV4GetResponse
## ResponseBuffering
Types:
-- ResponseBufferingUpdateResponse
+- ResponseBufferingEditResponse
- ResponseBufferingGetResponse
Methods:
-- client.settings.responseBuffering.update(zoneId, { ...params }) -> ResponseBufferingUpdateResponse
+- client.settings.responseBuffering.edit(zoneId, { ...params }) -> ResponseBufferingEditResponse
- client.settings.responseBuffering.get(zoneId) -> ResponseBufferingGetResponse
## RocketLoader
Types:
-- RocketLoaderUpdateResponse
+- RocketLoaderEditResponse
- RocketLoaderGetResponse
Methods:
-- client.settings.rocketLoader.update(zoneId, { ...params }) -> RocketLoaderUpdateResponse
+- client.settings.rocketLoader.edit(zoneId, { ...params }) -> RocketLoaderEditResponse
- client.settings.rocketLoader.get(zoneId) -> RocketLoaderGetResponse
## SecurityHeaders
Types:
-- SecurityHeaderUpdateResponse
+- SecurityHeaderEditResponse
- SecurityHeaderGetResponse
Methods:
-- client.settings.securityHeaders.update(zoneId, { ...params }) -> SecurityHeaderUpdateResponse
+- client.settings.securityHeaders.edit(zoneId, { ...params }) -> SecurityHeaderEditResponse
- client.settings.securityHeaders.get(zoneId) -> SecurityHeaderGetResponse
## SecurityLevel
Types:
-- SecurityLevelUpdateResponse
+- SecurityLevelEditResponse
- SecurityLevelGetResponse
Methods:
-- client.settings.securityLevel.update(zoneId, { ...params }) -> SecurityLevelUpdateResponse
+- client.settings.securityLevel.edit(zoneId, { ...params }) -> SecurityLevelEditResponse
- client.settings.securityLevel.get(zoneId) -> SecurityLevelGetResponse
## ServerSideExcludes
Types:
-- ServerSideExcludeUpdateResponse
+- ServerSideExcludeEditResponse
- ServerSideExcludeGetResponse
Methods:
-- client.settings.serverSideExcludes.update(zoneId, { ...params }) -> ServerSideExcludeUpdateResponse
+- client.settings.serverSideExcludes.edit(zoneId, { ...params }) -> ServerSideExcludeEditResponse
- client.settings.serverSideExcludes.get(zoneId) -> ServerSideExcludeGetResponse
## SortQueryStringForCache
Types:
-- SortQueryStringForCacheUpdateResponse
+- SortQueryStringForCacheEditResponse
- SortQueryStringForCacheGetResponse
Methods:
-- client.settings.sortQueryStringForCache.update(zoneId, { ...params }) -> SortQueryStringForCacheUpdateResponse
+- client.settings.sortQueryStringForCache.edit(zoneId, { ...params }) -> SortQueryStringForCacheEditResponse
- client.settings.sortQueryStringForCache.get(zoneId) -> SortQueryStringForCacheGetResponse
## SSL
Types:
-- SSLUpdateResponse
+- SSLEditResponse
- SSLGetResponse
Methods:
-- client.settings.ssl.update(zoneId, { ...params }) -> SSLUpdateResponse
+- client.settings.ssl.edit(zoneId, { ...params }) -> SSLEditResponse
- client.settings.ssl.get(zoneId) -> SSLGetResponse
## SSLRecommender
Types:
-- SSLRecommenderUpdateResponse
+- SSLRecommenderEditResponse
- SSLRecommenderGetResponse
Methods:
-- client.settings.sslRecommender.update(zoneId, { ...params }) -> SSLRecommenderUpdateResponse
+- client.settings.sslRecommender.edit(zoneId, { ...params }) -> SSLRecommenderEditResponse
- client.settings.sslRecommender.get(zoneId) -> SSLRecommenderGetResponse
## TLS1_3
Types:
-- TLS1_3UpdateResponse
+- TLS1_3EditResponse
- TLS1_3GetResponse
Methods:
-- client.settings.tls1_3.update(zoneId, { ...params }) -> TLS1_3UpdateResponse
+- client.settings.tls1_3.edit(zoneId, { ...params }) -> TLS1_3EditResponse
- client.settings.tls1_3.get(zoneId) -> TLS1_3GetResponse
## TLSClientAuth
Types:
-- TLSClientAuthUpdateResponse
+- TLSClientAuthEditResponse
- TLSClientAuthGetResponse
Methods:
-- client.settings.tlsClientAuth.update(zoneId, { ...params }) -> TLSClientAuthUpdateResponse
+- client.settings.tlsClientAuth.edit(zoneId, { ...params }) -> TLSClientAuthEditResponse
- client.settings.tlsClientAuth.get(zoneId) -> TLSClientAuthGetResponse
## TrueClientIPHeader
Types:
-- TrueClientIPHeaderUpdateResponse
+- TrueClientIPHeaderEditResponse
- TrueClientIPHeaderGetResponse
Methods:
-- client.settings.trueClientIPHeader.update(zoneId, { ...params }) -> TrueClientIPHeaderUpdateResponse
+- client.settings.trueClientIPHeader.edit(zoneId, { ...params }) -> TrueClientIPHeaderEditResponse
- client.settings.trueClientIPHeader.get(zoneId) -> TrueClientIPHeaderGetResponse
## WAF
Types:
-- WAFUpdateResponse
+- WAFEditResponse
- WAFGetResponse
Methods:
-- client.settings.waf.update(zoneId, { ...params }) -> WAFUpdateResponse
+- client.settings.waf.edit(zoneId, { ...params }) -> WAFEditResponse
- client.settings.waf.get(zoneId) -> WAFGetResponse
## Webp
Types:
-- WebpUpdateResponse
+- WebpEditResponse
- WebpGetResponse
Methods:
-- client.settings.webp.update(zoneId, { ...params }) -> WebpUpdateResponse
+- client.settings.webp.edit(zoneId, { ...params }) -> WebpEditResponse
- client.settings.webp.get(zoneId) -> WebpGetResponse
## Websocket
Types:
-- WebsocketUpdateResponse
+- WebsocketEditResponse
- WebsocketGetResponse
Methods:
-- client.settings.websocket.update(zoneId, { ...params }) -> WebsocketUpdateResponse
+- client.settings.websocket.edit(zoneId, { ...params }) -> WebsocketEditResponse
- client.settings.websocket.get(zoneId) -> WebsocketGetResponse
## FontSettings
Types:
-- FontSettingUpdateResponse
+- FontSettingEditResponse
- FontSettingGetResponse
Methods:
-- client.settings.fontSettings.update(zoneId, { ...params }) -> FontSettingUpdateResponse
+- client.settings.fontSettings.edit(zoneId, { ...params }) -> FontSettingEditResponse
- client.settings.fontSettings.get(zoneId) -> FontSettingGetResponse
# WaitingRooms
@@ -2443,38 +2451,38 @@ Methods:
Types:
- WaitingRoomCreateResponse
+- WaitingRoomUpdateResponse
- WaitingRoomListResponse
- WaitingRoomDeleteResponse
- WaitingRoomGetResponse
- WaitingRoomPreviewResponse
-- WaitingRoomReplaceResponse
Methods:
- client.waitingRooms.create(zoneIdentifier, { ...params }) -> WaitingRoomCreateResponse
+- client.waitingRooms.update(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingRoomUpdateResponse
- client.waitingRooms.list(zoneIdentifier) -> WaitingRoomListResponse | null
- client.waitingRooms.delete(zoneIdentifier, waitingRoomId) -> WaitingRoomDeleteResponse
- client.waitingRooms.get(zoneIdentifier, waitingRoomId) -> WaitingRoomGetResponse
- client.waitingRooms.preview(zoneIdentifier, { ...params }) -> WaitingRoomPreviewResponse
-- client.waitingRooms.replace(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingRoomReplaceResponse
## Events
Types:
- EventCreateResponse
+- EventUpdateResponse
- EventListResponse
- EventDeleteResponse
- EventGetResponse
-- EventReplaceResponse
Methods:
- client.waitingRooms.events.create(zoneIdentifier, waitingRoomId, { ...params }) -> EventCreateResponse
+- client.waitingRooms.events.update(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> EventUpdateResponse
- client.waitingRooms.events.list(zoneIdentifier, waitingRoomId) -> EventListResponse | null
- client.waitingRooms.events.delete(zoneIdentifier, waitingRoomId, eventId) -> EventDeleteResponse
- client.waitingRooms.events.get(zoneIdentifier, waitingRoomId, eventId) -> EventGetResponse
-- client.waitingRooms.events.replace(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> EventReplaceResponse
### Details
@@ -2494,15 +2502,15 @@ Types:
- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
-- RuleReplaceResponse
+- RuleEditResponse
Methods:
- client.waitingRooms.rules.create(zoneIdentifier, waitingRoomId, { ...params }) -> RuleCreateResponse | null
-- client.waitingRooms.rules.update(zoneIdentifier, waitingRoomId, ruleId, { ...params }) -> RuleUpdateResponse | null
+- client.waitingRooms.rules.update(zoneIdentifier, waitingRoomId, [ ...body ]) -> RuleUpdateResponse | null
- client.waitingRooms.rules.list(zoneIdentifier, waitingRoomId) -> RuleListResponse | null
- client.waitingRooms.rules.delete(zoneIdentifier, waitingRoomId, ruleId) -> RuleDeleteResponse | null
-- client.waitingRooms.rules.replace(zoneIdentifier, waitingRoomId, [ ...body ]) -> RuleReplaceResponse | null
+- client.waitingRooms.rules.edit(zoneIdentifier, waitingRoomId, ruleId, { ...params }) -> RuleEditResponse | null
## Statuses
@@ -2519,12 +2527,12 @@ Methods:
Types:
- WaitingroomZoneSettingsResponse
-- SettingUpdateResponse
+- SettingEditResponse
- SettingGetResponse
Methods:
-- client.waitingRooms.settings.update(zoneIdentifier, { ...params }) -> SettingUpdateResponse
+- client.waitingRooms.settings.edit(zoneIdentifier, { ...params }) -> SettingEditResponse
- client.waitingRooms.settings.get(zoneIdentifier) -> SettingGetResponse
# Web3
@@ -2534,17 +2542,17 @@ Methods:
Types:
- HostnameCreateResponse
-- HostnameUpdateResponse
- HostnameListResponse
- HostnameDeleteResponse
+- HostnameEditResponse
- HostnameGetResponse
Methods:
- client.web3.hostnames.create(zoneIdentifier, { ...params }) -> HostnameCreateResponse
-- client.web3.hostnames.update(zoneIdentifier, identifier, { ...params }) -> HostnameUpdateResponse
- client.web3.hostnames.list(zoneIdentifier) -> HostnameListResponse | null
- client.web3.hostnames.delete(zoneIdentifier, identifier) -> HostnameDeleteResponse | null
+- client.web3.hostnames.edit(zoneIdentifier, identifier, { ...params }) -> HostnameEditResponse
- client.web3.hostnames.get(zoneIdentifier, identifier) -> HostnameGetResponse
### IpfsUniversalPaths
@@ -2553,31 +2561,31 @@ Methods:
Types:
+- ContentListUpdateResponse
- ContentListListResponse
-- ContentListReplaceResponse
Methods:
+- client.web3.hostnames.ipfsUniversalPaths.contentLists.update(zoneIdentifier, identifier, { ...params }) -> ContentListUpdateResponse
- client.web3.hostnames.ipfsUniversalPaths.contentLists.list(zoneIdentifier, identifier) -> ContentListListResponse
-- client.web3.hostnames.ipfsUniversalPaths.contentLists.replace(zoneIdentifier, identifier, { ...params }) -> ContentListReplaceResponse
##### Entries
Types:
- EntryCreateResponse
+- EntryUpdateResponse
- EntryListResponse
- EntryDeleteResponse
- EntryGetResponse
-- EntryReplaceResponse
Methods:
- 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) -> EntryGetResponse
-- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.replace(zoneIdentifier, identifier, contentListEntryIdentifier, { ...params }) -> EntryReplaceResponse
# Workers
@@ -2585,15 +2593,15 @@ Methods:
Types:
+- ScriptUpdateResponse
- ScriptListResponse
-- ScriptReplaceResponse
Methods:
+- client.workers.scripts.update(accountId, scriptName, { ...params }) -> ScriptUpdateResponse
- client.workers.scripts.list(accountId) -> ScriptListResponse
- client.workers.scripts.delete(accountId, scriptName, { ...params }) -> void
- client.workers.scripts.get(accountId, scriptName) -> Response
-- client.workers.scripts.replace(accountId, scriptName, { ...params }) -> ScriptReplaceResponse
### Bindings
@@ -2609,13 +2617,13 @@ Methods:
Types:
+- ScheduleUpdateResponse
- ScheduleListResponse
-- ScheduleReplaceResponse
Methods:
+- client.workers.scripts.schedules.update(accountId, scriptName, { ...params }) -> ScheduleUpdateResponse
- client.workers.scripts.schedules.list(accountId, scriptName) -> ScheduleListResponse
-- client.workers.scripts.schedules.replace(accountId, scriptName, { ...params }) -> ScheduleReplaceResponse
### Tail
@@ -2635,59 +2643,59 @@ Methods:
Types:
+- UsageModelUpdateResponse
- UsageModelGetResponse
-- UsageModelReplaceResponse
Methods:
+- client.workers.scripts.usageModel.update(accountId, scriptName, { ...params }) -> UsageModelUpdateResponse
- client.workers.scripts.usageModel.get(accountId, scriptName) -> UsageModelGetResponse
-- client.workers.scripts.usageModel.replace(accountId, scriptName, { ...params }) -> UsageModelReplaceResponse
## Filters
Types:
- FilterCreateResponse
+- FilterUpdateResponse
- FilterListResponse
- FilterDeleteResponse
-- FilterReplaceResponse
Methods:
- client.workers.filters.create(zoneId, { ...params }) -> FilterCreateResponse | null
+- client.workers.filters.update(zoneId, filterId, { ...params }) -> FilterUpdateResponse
- client.workers.filters.list(zoneId) -> FilterListResponse
- client.workers.filters.delete(zoneId, filterId) -> FilterDeleteResponse | null
-- client.workers.filters.replace(zoneId, filterId, { ...params }) -> FilterReplaceResponse
## Routes
Types:
- RouteCreateResponse
+- RouteUpdateResponse
- RouteListResponse
- RouteDeleteResponse
- RouteGetResponse
-- RouteReplaceResponse
Methods:
- client.workers.routes.create(zoneId, { ...params }) -> RouteCreateResponse
+- client.workers.routes.update(zoneId, routeId, { ...params }) -> RouteUpdateResponse
- client.workers.routes.list(zoneId) -> RouteListResponse
- client.workers.routes.delete(zoneId, routeId) -> RouteDeleteResponse
- client.workers.routes.get(zoneId, routeId) -> RouteGetResponse
-- client.workers.routes.replace(zoneId, routeId, { ...params }) -> RouteReplaceResponse
## AccountSettings
Types:
+- AccountSettingUpdateResponse
- AccountSettingGetResponse
-- AccountSettingReplaceResponse
Methods:
+- client.workers.accountSettings.update(accountId, { ...params }) -> AccountSettingUpdateResponse
- client.workers.accountSettings.get(accountId) -> AccountSettingGetResponse
-- client.workers.accountSettings.replace(accountId, { ...params }) -> AccountSettingReplaceResponse
## Deployments
@@ -2707,16 +2715,16 @@ Methods:
Types:
+- DomainUpdateResponse
- DomainListResponse
- DomainGetResponse
-- DomainReplaceResponse
Methods:
+- client.workers.domains.update(accountId, { ...params }) -> DomainUpdateResponse
- client.workers.domains.list(accountId, { ...params }) -> DomainListResponse
- client.workers.domains.delete(accountId, domainId) -> void
- client.workers.domains.get(accountId, domainId) -> DomainGetResponse
-- client.workers.domains.replace(accountId, { ...params }) -> DomainReplaceResponse
## DurableObjects
@@ -2745,46 +2753,46 @@ Methods:
Types:
- QueueCreateResponse
+- QueueUpdateResponse
- QueueListResponse
- QueueDeleteResponse
- QueueGetResponse
-- QueueReplaceResponse
Methods:
- client.workers.queues.create(accountId, { ...params }) -> QueueCreateResponse | null
+- client.workers.queues.update(accountId, name, { ...params }) -> QueueUpdateResponse | null
- client.workers.queues.list(accountId) -> QueueListResponse | null
- client.workers.queues.delete(accountId, name) -> QueueDeleteResponse | null
- client.workers.queues.get(accountId, name) -> QueueGetResponse | null
-- client.workers.queues.replace(accountId, name, { ...params }) -> QueueReplaceResponse | null
### Consumers
Types:
- ConsumerCreateResponse
+- ConsumerUpdateResponse
- ConsumerListResponse
- ConsumerDeleteResponse
-- ConsumerReplaceResponse
Methods:
- client.workers.queues.consumers.create(accountId, name, { ...params }) -> ConsumerCreateResponse | null
+- client.workers.queues.consumers.update(accountId, name, consumerName, { ...params }) -> ConsumerUpdateResponse | null
- client.workers.queues.consumers.list(accountId, name) -> ConsumerListResponse | null
- client.workers.queues.consumers.delete(accountId, name, consumerName) -> ConsumerDeleteResponse | null
-- client.workers.queues.consumers.replace(accountId, name, consumerName, { ...params }) -> ConsumerReplaceResponse | null
## Subdomains
Types:
+- SubdomainUpdateResponse
- SubdomainGetResponse
-- SubdomainReplaceResponse
Methods:
+- client.workers.subdomains.update(accountId, { ...params }) -> SubdomainUpdateResponse
- client.workers.subdomains.get(accountId) -> SubdomainGetResponse
-- client.workers.subdomains.replace(accountId, { ...params }) -> SubdomainReplaceResponse
## DeploymentsByScript
@@ -2806,23 +2814,23 @@ Methods:
Types:
-- ContentReplaceResponse
+- ContentUpdateResponse
Methods:
+- client.workers.services.environments.content.update(accountId, serviceName, environmentName, { ...params }) -> ContentUpdateResponse
- client.workers.services.environments.content.get(accountId, serviceName, environmentName) -> Response
-- client.workers.services.environments.content.replace(accountId, serviceName, environmentName, { ...params }) -> ContentReplaceResponse
#### Settings
Types:
-- SettingUpdateResponse
+- SettingEditResponse
- SettingGetResponse
Methods:
-- client.workers.services.environments.settings.update(accountId, serviceName, environmentName, { ...params }) -> SettingUpdateResponse
+- client.workers.services.environments.settings.edit(accountId, serviceName, environmentName, { ...params }) -> SettingEditResponse
- client.workers.services.environments.settings.get(accountId, serviceName, environmentName) -> SettingGetResponse
## Script
@@ -2835,52 +2843,52 @@ Methods:
Types:
-- ActivationCheckReplaceResponse
+- ActivationCheckUpdateResponse
Methods:
-- client.activationChecks.replace(zoneId) -> ActivationCheckReplaceResponse
+- client.activationChecks.update(zoneId) -> ActivationCheckUpdateResponse
# ManagedHeaders
Types:
-- ManagedHeaderUpdateResponse
- ManagedHeaderListResponse
+- ManagedHeaderEditResponse
Methods:
-- client.managedHeaders.update(zoneId, { ...params }) -> ManagedHeaderUpdateResponse
- client.managedHeaders.list(zoneId) -> ManagedHeaderListResponse
+- client.managedHeaders.edit(zoneId, { ...params }) -> ManagedHeaderEditResponse
# PageShield
Types:
+- PageShieldUpdateResponse
- PageShieldListResponse
-- PageShieldReplaceResponse
Methods:
+- client.pageShield.update(zoneId, { ...params }) -> PageShieldUpdateResponse
- client.pageShield.list(zoneId) -> PageShieldListResponse
-- client.pageShield.replace(zoneId, { ...params }) -> PageShieldReplaceResponse
## Policies
Types:
- PolicyCreateResponse
+- PolicyUpdateResponse
- PolicyListResponse
- PolicyGetResponse
-- PolicyReplaceResponse
Methods:
- client.pageShield.policies.create(zoneId, { ...params }) -> PolicyCreateResponse
+- client.pageShield.policies.update(zoneId, policyId, { ...params }) -> PolicyUpdateResponse
- client.pageShield.policies.list(zoneId) -> PolicyListResponse | null
- client.pageShield.policies.delete(zoneId, policyId) -> void
- client.pageShield.policies.get(zoneId, policyId) -> PolicyGetResponse
-- client.pageShield.policies.replace(zoneId, policyId, { ...params }) -> PolicyReplaceResponse
## Connections
@@ -2911,17 +2919,17 @@ Methods:
Types:
- RulesetCreateResponse
+- RulesetUpdateResponse
- RulesetListResponse
- RulesetGetResponse
-- RulesetReplaceResponse
Methods:
- client.rulesets.create(accountOrZone, accountOrZoneId, { ...params }) -> RulesetCreateResponse
+- client.rulesets.update(accountOrZone, accountOrZoneId, rulesetId, { ...params }) -> RulesetUpdateResponse
- client.rulesets.list(accountOrZone, accountOrZoneId) -> RulesetListResponse
- client.rulesets.delete(accountOrZone, accountOrZoneId, rulesetId) -> void
- client.rulesets.get(accountOrZone, accountOrZoneId, rulesetId) -> RulesetGetResponse
-- client.rulesets.replace(accountOrZone, accountOrZoneId, rulesetId, { ...params }) -> RulesetReplaceResponse
## Phases
@@ -2938,14 +2946,14 @@ Methods:
Types:
- RuleCreateResponse
-- RuleUpdateResponse
- RuleDeleteResponse
+- RuleEditResponse
Methods:
- client.rulesets.rules.create(accountOrZone, accountOrZoneId, rulesetId, { ...params }) -> RuleCreateResponse
-- client.rulesets.rules.update(rulesetId, ruleId, { ...params }) -> RuleUpdateResponse
- client.rulesets.rules.delete(accountOrZone, accountOrZoneId, rulesetId, ruleId) -> RuleDeleteResponse
+- client.rulesets.rules.edit(rulesetId, ruleId, { ...params }) -> RuleEditResponse
## Versions
@@ -2974,13 +2982,13 @@ Methods:
Types:
+- URLNormalizationUpdateResponse
- URLNormalizationGetResponse
-- URLNormalizationReplaceResponse
Methods:
+- client.urlNormalizations.update(zoneId, { ...params }) -> URLNormalizationUpdateResponse
- client.urlNormalizations.get(zoneId) -> URLNormalizationGetResponse
-- client.urlNormalizations.replace(zoneId, { ...params }) -> URLNormalizationReplaceResponse
# Spectrum
@@ -3025,18 +3033,18 @@ Methods:
Types:
- AppCreateResponse
+- AppUpdateResponse
- AppListResponse
- AppDeleteResponse
- AppGetResponse
-- AppReplaceResponse
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.replace(zone, appId, { ...params }) -> AppReplaceResponse | null
# Addresses
@@ -3045,54 +3053,54 @@ Methods:
Types:
- AddressMapCreateResponse
-- AddressMapUpdateResponse
- AddressMapListResponse
- AddressMapDeleteResponse
+- AddressMapEditResponse
- AddressMapGetResponse
Methods:
- client.addresses.addressMaps.create(accountId, { ...params }) -> AddressMapCreateResponse
-- client.addresses.addressMaps.update(accountId, addressMapId, { ...params }) -> AddressMapUpdateResponse
- client.addresses.addressMaps.list(accountId) -> AddressMapListResponse | null
- client.addresses.addressMaps.delete(accountId, addressMapId) -> AddressMapDeleteResponse | null
+- client.addresses.addressMaps.edit(accountId, addressMapId, { ...params }) -> AddressMapEditResponse
- client.addresses.addressMaps.get(accountId, addressMapId) -> AddressMapGetResponse
### Accounts
Types:
+- AccountUpdateResponse
- AccountDeleteResponse
-- AccountReplaceResponse
Methods:
+- client.addresses.addressMaps.accounts.update(accountId, addressMapId) -> AccountUpdateResponse | null
- client.addresses.addressMaps.accounts.delete(accountId, addressMapId) -> AccountDeleteResponse | null
-- client.addresses.addressMaps.accounts.replace(accountId, addressMapId) -> AccountReplaceResponse | null
### IPs
Types:
+- IPUpdateResponse
- IPDeleteResponse
-- IPReplaceResponse
Methods:
+- client.addresses.addressMaps.ips.update(accountId, addressMapId, ipAddress) -> IPUpdateResponse | null
- client.addresses.addressMaps.ips.delete(accountId, addressMapId, ipAddress) -> IPDeleteResponse | null
-- client.addresses.addressMaps.ips.replace(accountId, addressMapId, ipAddress) -> IPReplaceResponse | null
### Zones
Types:
+- ZoneUpdateResponse
- ZoneDeleteResponse
-- ZoneReplaceResponse
Methods:
+- client.addresses.addressMaps.zones.update(accountId, addressMapId, zoneId) -> ZoneUpdateResponse | null
- client.addresses.addressMaps.zones.delete(accountId, addressMapId, zoneId) -> ZoneDeleteResponse | null
-- client.addresses.addressMaps.zones.replace(accountId, addressMapId, zoneId) -> ZoneReplaceResponse | null
## LoaDocuments
@@ -3119,17 +3127,17 @@ Methods:
Types:
- PrefixCreateResponse
-- PrefixUpdateResponse
- PrefixListResponse
- PrefixDeleteResponse
+- PrefixEditResponse
- PrefixGetResponse
Methods:
- client.addresses.prefixes.create(accountId, { ...params }) -> PrefixCreateResponse
-- client.addresses.prefixes.update(accountId, prefixId, { ...params }) -> PrefixUpdateResponse
- client.addresses.prefixes.list(accountId) -> PrefixListResponse | null
- client.addresses.prefixes.delete(accountId, prefixId) -> PrefixDeleteResponse | null
+- client.addresses.prefixes.edit(accountId, prefixId, { ...params }) -> PrefixEditResponse
- client.addresses.prefixes.get(accountId, prefixId) -> PrefixGetResponse
### BGPs
@@ -3138,12 +3146,12 @@ Methods:
Types:
-- StatusUpdateResponse
+- StatusEditResponse
- StatusGetResponse
Methods:
-- client.addresses.prefixes.bgps.statuses.update(accountId, prefixId, { ...params }) -> StatusUpdateResponse
+- client.addresses.prefixes.bgps.statuses.edit(accountId, prefixId, { ...params }) -> StatusEditResponse
- client.addresses.prefixes.bgps.statuses.get(accountId, prefixId) -> StatusGetResponse
### Delegations
@@ -3209,30 +3217,30 @@ Methods:
Types:
- TunnelCreateResponse
-- TunnelUpdateResponse
- TunnelListResponse
- TunnelDeleteResponse
+- TunnelEditResponse
- TunnelGetResponse
Methods:
- client.tunnels.create(accountId, { ...params }) -> TunnelCreateResponse
-- client.tunnels.update(accountId, tunnelId, { ...params }) -> TunnelUpdateResponse
- client.tunnels.list(accountId, { ...params }) -> TunnelListResponsesV4PagePaginationArray
- client.tunnels.delete(accountId, tunnelId, { ...params }) -> TunnelDeleteResponse
+- client.tunnels.edit(accountId, tunnelId, { ...params }) -> TunnelEditResponse
- client.tunnels.get(accountId, tunnelId) -> TunnelGetResponse
## Configurations
Types:
+- ConfigurationUpdateResponse
- ConfigurationListResponse
-- ConfigurationReplaceResponse
Methods:
+- client.tunnels.configurations.update(accountId, tunnelId, { ...params }) -> ConfigurationUpdateResponse
- client.tunnels.configurations.list(accountId, tunnelId) -> ConfigurationListResponse
-- client.tunnels.configurations.replace(accountId, tunnelId, { ...params }) -> ConfigurationReplaceResponse
## Connections
@@ -3295,29 +3303,29 @@ Methods:
Types:
- DatasetCreateResponse
+- DatasetUpdateResponse
- DatasetListResponse
- DatasetGetResponse
-- DatasetReplaceResponse
Methods:
- client.dlp.datasets.create(accountId, { ...params }) -> DatasetCreateResponse
+- client.dlp.datasets.update(accountId, datasetId, { ...params }) -> DatasetUpdateResponse
- client.dlp.datasets.list(accountId) -> DatasetListResponse
- client.dlp.datasets.delete(accountId, datasetId) -> void
- client.dlp.datasets.get(accountId, datasetId) -> DatasetGetResponse
-- client.dlp.datasets.replace(accountId, datasetId, { ...params }) -> DatasetReplaceResponse
### Upload
Types:
- UploadCreateResponse
-- UploadUpdateResponse
+- UploadEditResponse
Methods:
- client.dlp.datasets.upload.create(accountId, datasetId) -> UploadCreateResponse
-- client.dlp.datasets.upload.update(accountId, datasetId, version) -> UploadUpdateResponse
+- client.dlp.datasets.upload.edit(accountId, datasetId, version) -> UploadEditResponse
## Patterns
@@ -3333,13 +3341,13 @@ Methods:
Types:
+- PayloadLogUpdateResponse
- PayloadLogGetResponse
-- PayloadLogReplaceResponse
Methods:
+- client.dlp.payloadLogs.update(accountId, { ...params }) -> PayloadLogUpdateResponse
- client.dlp.payloadLogs.get(accountId) -> PayloadLogGetResponse
-- client.dlp.payloadLogs.replace(accountId, { ...params }) -> PayloadLogReplaceResponse
## Profiles
@@ -3358,45 +3366,45 @@ Methods:
Types:
- CustomCreateResponse
+- CustomUpdateResponse
- CustomDeleteResponse
- CustomGetResponse
-- CustomReplaceResponse
Methods:
- client.dlp.profiles.customs.create(accountId, { ...params }) -> CustomCreateResponse | null
+- client.dlp.profiles.customs.update(accountId, profileId, { ...params }) -> CustomUpdateResponse
- client.dlp.profiles.customs.delete(accountId, profileId) -> CustomDeleteResponse
- client.dlp.profiles.customs.get(accountId, profileId) -> CustomGetResponse
-- client.dlp.profiles.customs.replace(accountId, profileId, { ...params }) -> CustomReplaceResponse
### Predefineds
Types:
+- PredefinedUpdateResponse
- PredefinedGetResponse
-- PredefinedReplaceResponse
Methods:
+- client.dlp.profiles.predefineds.update(accountId, profileId, { ...params }) -> PredefinedUpdateResponse
- client.dlp.profiles.predefineds.get(accountId, profileId) -> PredefinedGetResponse
-- client.dlp.profiles.predefineds.replace(accountId, profileId, { ...params }) -> PredefinedReplaceResponse
# DNSFirewall
Types:
- DNSFirewallCreateResponse
-- DNSFirewallUpdateResponse
- DNSFirewallListResponse
- DNSFirewallDeleteResponse
+- DNSFirewallEditResponse
- DNSFirewallGetResponse
Methods:
- client.dnsFirewall.create(accountId, { ...params }) -> DNSFirewallCreateResponse
-- client.dnsFirewall.update(accountId, dnsFirewallId, { ...params }) -> DNSFirewallUpdateResponse
- client.dnsFirewall.list(accountId, { ...params }) -> DNSFirewallListResponsesV4PagePaginationArray
- client.dnsFirewall.delete(accountId, dnsFirewallId) -> DNSFirewallDeleteResponse
+- client.dnsFirewall.edit(accountId, dnsFirewallId, { ...params }) -> DNSFirewallEditResponse
- client.dnsFirewall.get(accountId, dnsFirewallId) -> DNSFirewallGetResponse
## DNSAnalytics
@@ -3428,17 +3436,17 @@ Methods:
Types:
- V1CreateResponse
-- V1UpdateResponse
- V1ListResponse
- V1DeleteResponse
+- V1EditResponse
- V1GetResponse
Methods:
- client.images.v1s.create(accountId, { ...params }) -> V1CreateResponse
-- client.images.v1s.update(accountId, imageId, { ...params }) -> V1UpdateResponse
- client.images.v1s.list(accountId, { ...params }) -> V1ListResponsesV4PagePagination
- client.images.v1s.delete(accountId, imageId) -> V1DeleteResponse
+- client.images.v1s.edit(accountId, imageId, { ...params }) -> V1EditResponse
- client.images.v1s.get(accountId, imageId) -> V1GetResponse
### Keys
@@ -3466,17 +3474,17 @@ Methods:
Types:
- VariantCreateResponse
-- VariantUpdateResponse
- VariantListResponse
- VariantDeleteResponse
+- VariantEditResponse
- VariantGetResponse
Methods:
- client.images.v1s.variants.create(accountId, { ...params }) -> VariantCreateResponse
-- client.images.v1s.variants.update(accountId, variantId, { ...params }) -> VariantUpdateResponse
- client.images.v1s.variants.list(accountId) -> VariantListResponse
- client.images.v1s.variants.delete(accountId, variantId) -> VariantDeleteResponse
+- client.images.v1s.variants.edit(accountId, variantId, { ...params }) -> VariantEditResponse
- client.images.v1s.variants.get(accountId, variantId) -> VariantGetResponse
### Blobs
@@ -3613,18 +3621,18 @@ Methods:
Types:
- IndicatorFeedCreateResponse
+- IndicatorFeedUpdateResponse
- IndicatorFeedListResponse
- IndicatorFeedDataResponse
- IndicatorFeedGetResponse
-- IndicatorFeedReplaceResponse
Methods:
- client.intel.indicatorFeeds.create(accountId, { ...params }) -> IndicatorFeedCreateResponse
+- client.intel.indicatorFeeds.update(accountId, feedId, { ...params }) -> IndicatorFeedUpdateResponse
- client.intel.indicatorFeeds.list(accountId) -> IndicatorFeedListResponse
- client.intel.indicatorFeeds.data(accountId, feedId) -> string
- client.intel.indicatorFeeds.get(accountId, feedId) -> IndicatorFeedGetResponse
-- client.intel.indicatorFeeds.replace(accountId, feedId, { ...params }) -> IndicatorFeedReplaceResponse
### Permissions
@@ -3656,51 +3664,51 @@ Methods:
Types:
+- CfInterconnectUpdateResponse
- CfInterconnectListResponse
- CfInterconnectGetResponse
-- CfInterconnectReplaceResponse
Methods:
+- client.magics.cfInterconnects.update(accountIdentifier, tunnelIdentifier, { ...params }) -> CfInterconnectUpdateResponse
- client.magics.cfInterconnects.list(accountIdentifier) -> CfInterconnectListResponse
- client.magics.cfInterconnects.get(accountIdentifier, tunnelIdentifier) -> CfInterconnectGetResponse
-- client.magics.cfInterconnects.replace(accountIdentifier, tunnelIdentifier, { ...params }) -> CfInterconnectReplaceResponse
## GreTunnels
Types:
- GreTunnelCreateResponse
+- GreTunnelUpdateResponse
- GreTunnelListResponse
- GreTunnelDeleteResponse
- GreTunnelGetResponse
-- GreTunnelReplaceResponse
Methods:
- client.magics.greTunnels.create(accountIdentifier, { ...params }) -> GreTunnelCreateResponse
+- client.magics.greTunnels.update(accountIdentifier, tunnelIdentifier, { ...params }) -> GreTunnelUpdateResponse
- client.magics.greTunnels.list(accountIdentifier) -> GreTunnelListResponse
- client.magics.greTunnels.delete(accountIdentifier, tunnelIdentifier) -> GreTunnelDeleteResponse
- client.magics.greTunnels.get(accountIdentifier, tunnelIdentifier) -> GreTunnelGetResponse
-- client.magics.greTunnels.replace(accountIdentifier, tunnelIdentifier, { ...params }) -> GreTunnelReplaceResponse
## IpsecTunnels
Types:
- IpsecTunnelCreateResponse
+- IpsecTunnelUpdateResponse
- IpsecTunnelListResponse
- IpsecTunnelDeleteResponse
- IpsecTunnelGetResponse
-- IpsecTunnelReplaceResponse
Methods:
- client.magics.ipsecTunnels.create(accountIdentifier, { ...params }) -> IpsecTunnelCreateResponse
+- client.magics.ipsecTunnels.update(accountIdentifier, tunnelIdentifier, { ...params }) -> IpsecTunnelUpdateResponse
- client.magics.ipsecTunnels.list(accountIdentifier) -> IpsecTunnelListResponse
- client.magics.ipsecTunnels.delete(accountIdentifier, tunnelIdentifier) -> IpsecTunnelDeleteResponse
- client.magics.ipsecTunnels.get(accountIdentifier, tunnelIdentifier) -> IpsecTunnelGetResponse
-- client.magics.ipsecTunnels.replace(accountIdentifier, tunnelIdentifier, { ...params }) -> IpsecTunnelReplaceResponse
### PskGenerates
@@ -3717,36 +3725,36 @@ Methods:
Types:
- RouteCreateResponse
+- RouteUpdateResponse
- RouteDeleteResponse
- RouteGetResponse
- RouteMagicStaticRoutesListRoutesResponse
-- RouteReplaceResponse
Methods:
- client.magics.routes.create(accountIdentifier, { ...params }) -> RouteCreateResponse
+- client.magics.routes.update(accountIdentifier, routeIdentifier, { ...params }) -> RouteUpdateResponse
- client.magics.routes.delete(accountIdentifier, routeIdentifier) -> RouteDeleteResponse
- client.magics.routes.get(accountIdentifier, routeIdentifier) -> RouteGetResponse
- client.magics.routes.magicStaticRoutesListRoutes(accountIdentifier) -> RouteMagicStaticRoutesListRoutesResponse
-- client.magics.routes.replace(accountIdentifier, routeIdentifier, { ...params }) -> RouteReplaceResponse
# AccountMembers
Types:
- AccountMemberCreateResponse
+- AccountMemberUpdateResponse
- AccountMemberListResponse
- AccountMemberDeleteResponse
- AccountMemberGetResponse
-- AccountMemberReplaceResponse
Methods:
- client.accountMembers.create(accountId, { ...params }) -> AccountMemberCreateResponse
+- client.accountMembers.update(accountId, memberId, { ...params }) -> AccountMemberUpdateResponse
- client.accountMembers.list(accountId, { ...params }) -> AccountMemberListResponsesV4PagePaginationArray
- client.accountMembers.delete(accountId, memberId) -> AccountMemberDeleteResponse | null
- client.accountMembers.get(accountId, memberId) -> AccountMemberGetResponse
-- client.accountMembers.replace(accountId, memberId, { ...params }) -> AccountMemberReplaceResponse
# Mnms
@@ -3758,15 +3766,15 @@ Types:
- ConfigUpdateResponse
- ConfigListResponse
- ConfigDeleteResponse
-- ConfigReplaceResponse
+- ConfigEditResponse
Methods:
- client.mnms.configs.create(accountIdentifier) -> ConfigCreateResponse
-- client.mnms.configs.update(accountIdentifier) -> ConfigUpdateResponse
+- client.mnms.configs.update(accountIdentifier) -> ConfigUpdateResponse
- client.mnms.configs.list(accountIdentifier) -> ConfigListResponse
- client.mnms.configs.delete(accountIdentifier) -> ConfigDeleteResponse
-- client.mnms.configs.replace(accountIdentifier) -> ConfigReplaceResponse
+- client.mnms.configs.edit(accountIdentifier) -> ConfigEditResponse
### Fulls
@@ -3786,27 +3794,27 @@ Types:
- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
+- RuleEditResponse
- RuleGetResponse
-- RuleReplaceResponse
Methods:
- client.mnms.rules.create(accountIdentifier) -> RuleCreateResponse | null
-- client.mnms.rules.update(accountIdentifier, ruleIdentifier) -> RuleUpdateResponse | null
+- client.mnms.rules.update(accountIdentifier) -> RuleUpdateResponse | null
- client.mnms.rules.list(accountIdentifier) -> RuleListResponse | null
- client.mnms.rules.delete(accountIdentifier, ruleIdentifier) -> RuleDeleteResponse | null
+- client.mnms.rules.edit(accountIdentifier, ruleIdentifier) -> RuleEditResponse | null
- client.mnms.rules.get(accountIdentifier, ruleIdentifier) -> RuleGetResponse | null
-- client.mnms.rules.replace(accountIdentifier) -> RuleReplaceResponse | null
### Advertisements
Types:
-- AdvertisementUpdateResponse
+- AdvertisementEditResponse
Methods:
-- client.mnms.rules.advertisements.update(accountIdentifier, ruleIdentifier) -> AdvertisementUpdateResponse | null
+- client.mnms.rules.advertisements.edit(accountIdentifier, ruleIdentifier) -> AdvertisementEditResponse | null
# MtlsCertificates
@@ -3841,18 +3849,18 @@ Methods:
Types:
- ProjectCreateResponse
-- ProjectUpdateResponse
- ProjectListResponse
- ProjectDeleteResponse
+- ProjectEditResponse
- ProjectGetResponse
- ProjectPurgeBuildCacheResponse
Methods:
- client.pages.projects.create(accountId, { ...params }) -> ProjectCreateResponse
-- client.pages.projects.update(accountId, projectName, { ...params }) -> ProjectUpdateResponse
- client.pages.projects.list(accountId) -> ProjectListResponse
- client.pages.projects.delete(accountId, projectName) -> unknown
+- client.pages.projects.edit(accountId, projectName, { ...params }) -> ProjectEditResponse
- client.pages.projects.get(accountId, projectName) -> ProjectGetResponse
- client.pages.projects.purgeBuildCache(accountId, projectName) -> unknown
@@ -3893,17 +3901,17 @@ Methods:
Types:
- DomainCreateResponse
-- DomainUpdateResponse
- DomainListResponse
- DomainDeleteResponse
+- DomainEditResponse
- DomainGetResponse
Methods:
- client.pages.projects.domains.create(accountId, projectName, { ...params }) -> DomainCreateResponse | null
-- client.pages.projects.domains.update(accountId, projectName, domainName) -> DomainUpdateResponse | null
- client.pages.projects.domains.list(accountId, projectName) -> DomainListResponse
- client.pages.projects.domains.delete(accountId, projectName, domainName) -> unknown
+- client.pages.projects.domains.edit(accountId, projectName, domainName) -> DomainEditResponse | null
- client.pages.projects.domains.get(accountId, projectName, domainName) -> DomainGetResponse | null
# Pcaps
@@ -3947,15 +3955,15 @@ Methods:
Types:
+- DomainUpdateResponse
- DomainListResponse
- DomainGetResponse
-- DomainReplaceResponse
Methods:
+- client.registrar.domains.update(accountId, domainName, { ...params }) -> DomainUpdateResponse | null
- client.registrar.domains.list(accountId) -> DomainListResponse | null
- client.registrar.domains.get(accountId, domainName) -> DomainGetResponse | null
-- client.registrar.domains.replace(accountId, domainName, { ...params }) -> DomainReplaceResponse | null
# RequestTracers
@@ -3963,6 +3971,7 @@ Methods:
Types:
+- Bz6um997Trace
- TraceCreateResponse
Methods:
@@ -3988,18 +3997,18 @@ Methods:
Types:
- ListCreateResponse
+- ListUpdateResponse
- ListListResponse
- ListDeleteResponse
- ListGetResponse
-- ListReplaceResponse
Methods:
- client.rules.lists.create(accountId, { ...params }) -> ListCreateResponse | null
+- client.rules.lists.update(accountId, listId, { ...params }) -> ListUpdateResponse | null
- client.rules.lists.list(accountId) -> ListListResponse | null
- client.rules.lists.delete(accountId, listId) -> ListDeleteResponse | null
- client.rules.lists.get(accountId, listId) -> ListGetResponse | null
-- client.rules.lists.replace(accountId, listId, { ...params }) -> ListReplaceResponse | null
### BulkOperations
@@ -4016,18 +4025,18 @@ Methods:
Types:
- ItemCreateResponse
+- ItemUpdateResponse
- ItemListResponse
- ItemDeleteResponse
- ItemGetResponse
-- ItemReplaceResponse
Methods:
- client.rules.lists.items.create(accountId, listId, [ ...body ]) -> ItemCreateResponse | null
+- client.rules.lists.items.update(accountId, listId, [ ...body ]) -> ItemUpdateResponse | null
- client.rules.lists.items.list(accountId, listId, { ...params }) -> ItemListResponse | null
- client.rules.lists.items.delete(accountId, listId, { ...params }) -> ItemDeleteResponse | null
- client.rules.lists.items.get(accountIdentifier, listId, itemId) -> ItemGetResponse | null
-- client.rules.lists.items.replace(accountId, listId, [ ...body ]) -> ItemReplaceResponse | null
# Storage
@@ -4050,28 +4059,28 @@ Methods:
Types:
- NamespaceCreateResponse
+- NamespaceUpdateResponse
- NamespaceListResponse
- NamespaceDeleteResponse
-- NamespaceReplaceResponse
Methods:
- client.storage.kv.namespaces.create(accountId, { ...params }) -> NamespaceCreateResponse
+- client.storage.kv.namespaces.update(accountId, namespaceId, { ...params }) -> NamespaceUpdateResponse
- client.storage.kv.namespaces.list(accountId, { ...params }) -> NamespaceListResponsesV4PagePaginationArray
- client.storage.kv.namespaces.delete(accountId, namespaceId) -> NamespaceDeleteResponse
-- client.storage.kv.namespaces.replace(accountId, namespaceId, { ...params }) -> NamespaceReplaceResponse
#### Bulk
Types:
+- BulkUpdateResponse
- BulkDeleteResponse
-- BulkReplaceResponse
Methods:
+- client.storage.kv.namespaces.bulk.update(accountId, namespaceId, [ ...body ]) -> BulkUpdateResponse
- client.storage.kv.namespaces.bulk.delete(accountId, namespaceId, [ ...body ]) -> BulkDeleteResponse
-- client.storage.kv.namespaces.bulk.replace(accountId, namespaceId, [ ...body ]) -> BulkReplaceResponse
#### Keys
@@ -4097,15 +4106,15 @@ Methods:
Types:
+- ValueUpdateResponse
- ValueDeleteResponse
- ValueGetResponse
-- ValueReplaceResponse
Methods:
+- client.storage.kv.namespaces.values.update(accountId, namespaceId, keyName, { ...params }) -> ValueUpdateResponse
- client.storage.kv.namespaces.values.delete(accountId, namespaceId, keyName) -> ValueDeleteResponse
- client.storage.kv.namespaces.values.get(accountId, namespaceId, keyName) -> string
-- client.storage.kv.namespaces.values.replace(accountId, namespaceId, keyName, { ...params }) -> ValueReplaceResponse
# Stream
@@ -4126,16 +4135,16 @@ Methods:
Types:
- AudioTrackCreateResponse
-- AudioTrackUpdateResponse
- AudioTrackListResponse
- AudioTrackDeleteResponse
+- AudioTrackEditResponse
Methods:
- client.stream.audioTracks.create(accountId, identifier, { ...params }) -> AudioTrackCreateResponse
-- client.stream.audioTracks.update(accountId, identifier, audioIdentifier, { ...params }) -> AudioTrackUpdateResponse
- client.stream.audioTracks.list(accountId, identifier) -> AudioTrackListResponse
- client.stream.audioTracks.delete(accountId, identifier, audioIdentifier) -> AudioTrackDeleteResponse
+- client.stream.audioTracks.edit(accountId, identifier, audioIdentifier, { ...params }) -> AudioTrackEditResponse
## Videos
@@ -4196,32 +4205,32 @@ Methods:
Types:
- LiveInputCreateResponse
+- LiveInputUpdateResponse
- LiveInputListResponse
- LiveInputGetResponse
-- LiveInputReplaceResponse
Methods:
- client.stream.liveInputs.create(accountId, { ...params }) -> LiveInputCreateResponse
+- client.stream.liveInputs.update(accountId, liveInputIdentifier, { ...params }) -> LiveInputUpdateResponse
- client.stream.liveInputs.list(accountId, { ...params }) -> LiveInputListResponse
- client.stream.liveInputs.delete(accountId, liveInputIdentifier) -> void
- client.stream.liveInputs.get(accountId, liveInputIdentifier) -> LiveInputGetResponse
-- client.stream.liveInputs.replace(accountId, liveInputIdentifier, { ...params }) -> LiveInputReplaceResponse
### Outputs
Types:
- OutputCreateResponse
+- OutputUpdateResponse
- OutputListResponse
-- OutputReplaceResponse
Methods:
- client.stream.liveInputs.outputs.create(accountId, liveInputIdentifier, { ...params }) -> OutputCreateResponse
+- client.stream.liveInputs.outputs.update(accountId, liveInputIdentifier, outputIdentifier, { ...params }) -> OutputUpdateResponse
- client.stream.liveInputs.outputs.list(accountId, liveInputIdentifier) -> OutputListResponse
- client.stream.liveInputs.outputs.delete(accountId, liveInputIdentifier, outputIdentifier) -> void
-- client.stream.liveInputs.outputs.replace(accountId, liveInputIdentifier, outputIdentifier, { ...params }) -> OutputReplaceResponse
## Watermarks
@@ -4243,29 +4252,29 @@ Methods:
Types:
+- WebhookUpdateResponse
- WebhookDeleteResponse
- WebhookGetResponse
-- WebhookReplaceResponse
Methods:
+- client.stream.webhooks.update(accountId, { ...params }) -> WebhookUpdateResponse
- client.stream.webhooks.delete(accountId) -> WebhookDeleteResponse
- client.stream.webhooks.get(accountId) -> WebhookGetResponse
-- client.stream.webhooks.replace(accountId, { ...params }) -> WebhookReplaceResponse
## Captions
Types:
+- CaptionUpdateResponse
- CaptionListResponse
- CaptionDeleteResponse
-- CaptionReplaceResponse
Methods:
+- client.stream.captions.update(accountId, identifier, language, { ...params }) -> CaptionUpdateResponse
- client.stream.captions.list(accountId, identifier) -> CaptionListResponse
- client.stream.captions.delete(accountId, identifier, language) -> CaptionDeleteResponse
-- client.stream.captions.replace(accountId, identifier, language, { ...params }) -> CaptionReplaceResponse
## Downloads
@@ -4340,16 +4349,16 @@ Methods:
Types:
- VirtualNetworkCreateResponse
-- VirtualNetworkUpdateResponse
- VirtualNetworkListResponse
- VirtualNetworkDeleteResponse
+- VirtualNetworkEditResponse
Methods:
- client.teamnets.virtualNetworks.create(accountId, { ...params }) -> VirtualNetworkCreateResponse
-- client.teamnets.virtualNetworks.update(accountId, virtualNetworkId, { ...params }) -> VirtualNetworkUpdateResponse
- client.teamnets.virtualNetworks.list(accountId, { ...params }) -> VirtualNetworkListResponse | null
- client.teamnets.virtualNetworks.delete(accountId, virtualNetworkId) -> VirtualNetworkDeleteResponse
+- client.teamnets.virtualNetworks.edit(accountId, virtualNetworkId, { ...params }) -> VirtualNetworkEditResponse
# Gateways
@@ -4367,13 +4376,13 @@ Methods:
Types:
+- AuditSSHSettingUpdateResponse
- AuditSSHSettingGetResponse
-- AuditSSHSettingReplaceResponse
Methods:
+- client.gateways.auditSSHSettings.update(accountId, { ...params }) -> AuditSSHSettingUpdateResponse
- client.gateways.auditSSHSettings.get(accountId) -> AuditSSHSettingGetResponse
-- client.gateways.auditSSHSettings.replace(accountId, { ...params }) -> AuditSSHSettingReplaceResponse
## Categories
@@ -4400,32 +4409,32 @@ Methods:
Types:
- ConfigurationUpdateResponse
+- ConfigurationEditResponse
- ConfigurationGetResponse
-- ConfigurationReplaceResponse
Methods:
-- client.gateways.configurations.update(accountId, { ...params }) -> ConfigurationUpdateResponse
+- client.gateways.configurations.update(accountId, { ...params }) -> ConfigurationUpdateResponse
+- client.gateways.configurations.edit(accountId, { ...params }) -> ConfigurationEditResponse
- client.gateways.configurations.get(accountId) -> ConfigurationGetResponse
-- client.gateways.configurations.replace(accountId, { ...params }) -> ConfigurationReplaceResponse
## Lists
Types:
- ListCreateResponse
+- ListUpdateResponse
- ListListResponse
- ListDeleteResponse
- ListGetResponse
-- ListReplaceResponse
Methods:
- client.gateways.lists.create(accountId, { ...params }) -> ListCreateResponse
+- client.gateways.lists.update(accountId, listId, { ...params }) -> ListUpdateResponse
- client.gateways.lists.list(accountId) -> ListListResponse | null
- client.gateways.lists.delete(accountId, listId) -> ListDeleteResponse
- client.gateways.lists.get(accountId, listId) -> ListGetResponse
-- client.gateways.lists.replace(accountId, listId, { ...params }) -> ListReplaceResponse
### Items
@@ -4442,47 +4451,47 @@ Methods:
Types:
- LocationCreateResponse
+- LocationUpdateResponse
- LocationListResponse
- LocationDeleteResponse
- LocationGetResponse
-- LocationReplaceResponse
Methods:
- client.gateways.locations.create(accountId, { ...params }) -> LocationCreateResponse
+- client.gateways.locations.update(accountId, locationId, { ...params }) -> LocationUpdateResponse
- client.gateways.locations.list(accountId) -> LocationListResponse | null
- client.gateways.locations.delete(accountId, locationId) -> LocationDeleteResponse
- client.gateways.locations.get(accountId, locationId) -> LocationGetResponse
-- client.gateways.locations.replace(accountId, locationId, { ...params }) -> LocationReplaceResponse
## Loggings
Types:
+- LoggingUpdateResponse
- LoggingGetResponse
-- LoggingReplaceResponse
Methods:
+- client.gateways.loggings.update(accountId, { ...params }) -> LoggingUpdateResponse
- client.gateways.loggings.get(accountId) -> LoggingGetResponse
-- client.gateways.loggings.replace(accountId, { ...params }) -> LoggingReplaceResponse
## ProxyEndpoints
Types:
- ProxyEndpointCreateResponse
-- ProxyEndpointUpdateResponse
- ProxyEndpointListResponse
- ProxyEndpointDeleteResponse
+- ProxyEndpointEditResponse
- ProxyEndpointGetResponse
Methods:
- client.gateways.proxyEndpoints.create(accountId, { ...params }) -> ProxyEndpointCreateResponse
-- client.gateways.proxyEndpoints.update(accountId, proxyEndpointId, { ...params }) -> ProxyEndpointUpdateResponse
- client.gateways.proxyEndpoints.list(accountId) -> ProxyEndpointListResponse | null
- client.gateways.proxyEndpoints.delete(accountId, proxyEndpointId) -> ProxyEndpointDeleteResponse
+- client.gateways.proxyEndpoints.edit(accountId, proxyEndpointId, { ...params }) -> ProxyEndpointEditResponse
- client.gateways.proxyEndpoints.get(accountId, proxyEndpointId) -> ProxyEndpointGetResponse
## Rules
@@ -4490,18 +4499,18 @@ Methods:
Types:
- RuleCreateResponse
+- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
- RuleGetResponse
-- RuleReplaceResponse
Methods:
- client.gateways.rules.create(accountId, { ...params }) -> RuleCreateResponse
+- client.gateways.rules.update(accountId, ruleId, { ...params }) -> RuleUpdateResponse
- client.gateways.rules.list(accountId) -> RuleListResponse | null
- client.gateways.rules.delete(accountId, ruleId) -> RuleDeleteResponse
- client.gateways.rules.get(accountId, ruleId) -> RuleGetResponse
-- client.gateways.rules.replace(accountId, ruleId, { ...params }) -> RuleReplaceResponse
# Alerting
@@ -4548,18 +4557,18 @@ Methods:
Types:
- WebhookCreateResponse
+- WebhookUpdateResponse
- WebhookListResponse
- WebhookDeleteResponse
- WebhookGetResponse
-- WebhookReplaceResponse
Methods:
- client.alerting.v3.destinations.webhooks.create(accountId, { ...params }) -> WebhookCreateResponse
+- client.alerting.v3.destinations.webhooks.update(accountId, webhookId, { ...params }) -> WebhookUpdateResponse
- client.alerting.v3.destinations.webhooks.list(accountId) -> WebhookListResponse | null
- client.alerting.v3.destinations.webhooks.delete(accountId, webhookId) -> WebhookDeleteResponse | null
- client.alerting.v3.destinations.webhooks.get(accountId, webhookId) -> WebhookGetResponse
-- client.alerting.v3.destinations.webhooks.replace(accountId, webhookId, { ...params }) -> WebhookReplaceResponse
### Histories
@@ -4576,18 +4585,18 @@ Methods:
Types:
- PolicyCreateResponse
+- PolicyUpdateResponse
- PolicyListResponse
- PolicyDeleteResponse
- PolicyGetResponse
-- PolicyReplaceResponse
Methods:
- client.alerting.v3.policies.create(accountId, { ...params }) -> PolicyCreateResponse
+- client.alerting.v3.policies.update(accountId, policyId, { ...params }) -> PolicyUpdateResponse
- client.alerting.v3.policies.list(accountId) -> PolicyListResponse | null
- client.alerting.v3.policies.delete(accountId, policyId) -> PolicyDeleteResponse | null
- client.alerting.v3.policies.get(accountId, policyId) -> PolicyGetResponse
-- client.alerting.v3.policies.replace(accountId, policyId, { ...params }) -> PolicyReplaceResponse
# Devices
@@ -4606,53 +4615,53 @@ Methods:
Types:
- DEXTestCreateResponse
+- DEXTestUpdateResponse
- DEXTestListResponse
- DEXTestDeleteResponse
- DEXTestGetResponse
-- DEXTestReplaceResponse
Methods:
- client.devices.dexTests.create(identifier, { ...params }) -> DEXTestCreateResponse | null
+- client.devices.dexTests.update(identifier, uuid, { ...params }) -> DEXTestUpdateResponse | null
- client.devices.dexTests.list(identifier) -> DEXTestListResponse | null
- client.devices.dexTests.delete(identifier, uuid) -> DEXTestDeleteResponse | null
- client.devices.dexTests.get(identifier, uuid) -> DEXTestGetResponse | null
-- client.devices.dexTests.replace(identifier, uuid, { ...params }) -> DEXTestReplaceResponse | null
## Networks
Types:
- NetworkCreateResponse
+- NetworkUpdateResponse
- NetworkListResponse
- NetworkDeleteResponse
- NetworkGetResponse
-- NetworkReplaceResponse
Methods:
- client.devices.networks.create(identifier, { ...params }) -> NetworkCreateResponse | null
+- client.devices.networks.update(identifier, uuid, { ...params }) -> NetworkUpdateResponse | null
- client.devices.networks.list(identifier) -> NetworkListResponse | null
- client.devices.networks.delete(identifier, uuid) -> NetworkDeleteResponse | null
- client.devices.networks.get(identifier, uuid) -> NetworkGetResponse | null
-- client.devices.networks.replace(identifier, uuid, { ...params }) -> NetworkReplaceResponse | null
## Policies
Types:
- PolicyCreateResponse
-- PolicyUpdateResponse
- PolicyListResponse
- PolicyDeleteResponse
+- PolicyEditResponse
- PolicyGetResponse
Methods:
- client.devices.policies.create(identifier, { ...params }) -> PolicyCreateResponse | null
-- client.devices.policies.update(identifier, uuid, { ...params }) -> PolicyUpdateResponse | null
- client.devices.policies.list(identifier) -> PolicyListResponse | null
- client.devices.policies.delete(identifier, uuid) -> PolicyDeleteResponse | null
+- client.devices.policies.edit(identifier, uuid, { ...params }) -> PolicyEditResponse | null
- client.devices.policies.get(identifier, uuid) -> PolicyGetResponse | null
### DefaultPolicy
@@ -4669,70 +4678,70 @@ Methods:
Types:
+- ExcludeUpdateResponse
- ExcludeListResponse
-- ExcludeReplaceResponse
Methods:
+- client.devices.policies.excludes.update(identifier, [ ...body ]) -> ExcludeUpdateResponse | null
- client.devices.policies.excludes.list(identifier) -> ExcludeListResponse | null
-- client.devices.policies.excludes.replace(identifier, [ ...body ]) -> ExcludeReplaceResponse | null
### FallbackDomains
Types:
+- FallbackDomainUpdateResponse
- FallbackDomainListResponse
-- FallbackDomainReplaceResponse
Methods:
+- client.devices.policies.fallbackDomains.update(identifier, uuid, [ ...body ]) -> FallbackDomainUpdateResponse | null
- client.devices.policies.fallbackDomains.list(identifier, uuid) -> FallbackDomainListResponse | null
-- client.devices.policies.fallbackDomains.replace(identifier, uuid, [ ...body ]) -> FallbackDomainReplaceResponse | null
### Includes
Types:
+- IncludeUpdateResponse
- IncludeListResponse
-- IncludeReplaceResponse
Methods:
+- client.devices.policies.includes.update(identifier, [ ...body ]) -> IncludeUpdateResponse | null
- client.devices.policies.includes.list(identifier) -> IncludeListResponse | null
-- client.devices.policies.includes.replace(identifier, [ ...body ]) -> IncludeReplaceResponse | null
## Postures
Types:
- PostureCreateResponse
+- PostureUpdateResponse
- PostureListResponse
- PostureDeleteResponse
- PostureGetResponse
-- PostureReplaceResponse
Methods:
- client.devices.postures.create(identifier, { ...params }) -> PostureCreateResponse | null
+- client.devices.postures.update(identifier, uuid, { ...params }) -> PostureUpdateResponse | null
- client.devices.postures.list(identifier) -> PostureListResponse | null
- client.devices.postures.delete(identifier, uuid) -> PostureDeleteResponse | null
- client.devices.postures.get(identifier, uuid) -> PostureGetResponse | null
-- client.devices.postures.replace(identifier, uuid, { ...params }) -> PostureReplaceResponse | null
### Integrations
Types:
- IntegrationCreateResponse
-- IntegrationUpdateResponse
- IntegrationDeleteResponse
+- IntegrationEditResponse
- IntegrationGetResponse
Methods:
- client.devices.postures.integrations.create(identifier, { ...params }) -> IntegrationCreateResponse | null
-- client.devices.postures.integrations.update(identifier, uuid, { ...params }) -> IntegrationUpdateResponse | null
- client.devices.postures.integrations.delete(identifier, uuid) -> IntegrationDeleteResponse | null
+- client.devices.postures.integrations.edit(identifier, uuid, { ...params }) -> IntegrationEditResponse | null
- client.devices.postures.integrations.get(identifier, uuid) -> IntegrationGetResponse | null
## Revokes
@@ -4749,13 +4758,13 @@ Methods:
Types:
+- SettingUpdateResponse
- SettingListResponse
-- SettingReplaceResponse
Methods:
+- client.devices.settings.update(identifier, { ...params }) -> SettingUpdateResponse | null
- client.devices.settings.list(identifier) -> SettingListResponse | null
-- client.devices.settings.replace(identifier, { ...params }) -> SettingReplaceResponse | null
## Unrevokes
@@ -4936,31 +4945,31 @@ Methods:
Types:
- RouteCreateResponse
-- RouteUpdateResponse
- RouteDeleteResponse
+- RouteEditResponse
Methods:
- client.teamnet.routes.create(accountId, { ...params }) -> RouteCreateResponse
-- client.teamnet.routes.update(accountId, routeId, { ...params }) -> RouteUpdateResponse
- client.teamnet.routes.delete(accountId, routeId) -> RouteDeleteResponse
+- client.teamnet.routes.edit(accountId, routeId, { ...params }) -> RouteEditResponse
# WarpConnector
Types:
- WarpConnectorCreateResponse
-- WarpConnectorUpdateResponse
- WarpConnectorListResponse
- WarpConnectorDeleteResponse
+- WarpConnectorEditResponse
- WarpConnectorGetResponse
Methods:
- client.warpConnector.create(accountId, { ...params }) -> WarpConnectorCreateResponse
-- client.warpConnector.update(accountId, tunnelId, { ...params }) -> WarpConnectorUpdateResponse
- client.warpConnector.list(accountId, { ...params }) -> WarpConnectorListResponsesV4PagePaginationArray
- client.warpConnector.delete(accountId, tunnelId, { ...params }) -> WarpConnectorDeleteResponse
+- client.warpConnector.edit(accountId, tunnelId, { ...params }) -> WarpConnectorEditResponse
- client.warpConnector.get(accountId, tunnelId) -> WarpConnectorGetResponse
# Dispatchers
@@ -4969,14 +4978,14 @@ Methods:
Types:
+- ScriptUpdateResponse
- ScriptGetResponse
-- ScriptReplaceResponse
Methods:
+- client.dispatchers.scripts.update(accountId, dispatchNamespace, scriptName, { ...params }) -> ScriptUpdateResponse
- client.dispatchers.scripts.delete(accountId, dispatchNamespace, scriptName, { ...params }) -> void
- client.dispatchers.scripts.get(accountId, dispatchNamespace, scriptName) -> ScriptGetResponse
-- client.dispatchers.scripts.replace(accountId, dispatchNamespace, scriptName, { ...params }) -> ScriptReplaceResponse
# WorkersForPlatforms
@@ -4990,23 +4999,23 @@ Methods:
Types:
-- ContentReplaceResponse
+- ContentUpdateResponse
Methods:
+- client.workersForPlatforms.dispatch.namespaces.scripts.content.update(accountId, dispatchNamespace, scriptName, { ...params }) -> ContentUpdateResponse
- client.workersForPlatforms.dispatch.namespaces.scripts.content.get(accountId, dispatchNamespace, scriptName) -> Response
-- client.workersForPlatforms.dispatch.namespaces.scripts.content.replace(accountId, dispatchNamespace, scriptName, { ...params }) -> ContentReplaceResponse
##### Settings
Types:
-- SettingUpdateResponse
+- SettingEditResponse
- SettingGetResponse
Methods:
-- client.workersForPlatforms.dispatch.namespaces.scripts.settings.update(accountId, dispatchNamespace, scriptName, { ...params }) -> SettingUpdateResponse
+- client.workersForPlatforms.dispatch.namespaces.scripts.settings.edit(accountId, dispatchNamespace, scriptName, { ...params }) -> SettingEditResponse
- client.workersForPlatforms.dispatch.namespaces.scripts.settings.get(accountId, dispatchNamespace, scriptName) -> SettingGetResponse
# WorkerDomains
@@ -5026,11 +5035,11 @@ Methods:
Types:
-- ContentReplaceResponse
+- ContentUpdateResponse
Methods:
-- client.workerScripts.content.replace(accountId, scriptName, { ...params }) -> ContentReplaceResponse
+- client.workerScripts.content.update(accountId, scriptName, { ...params }) -> ContentUpdateResponse
## ContentV2
@@ -5042,12 +5051,12 @@ Methods:
Types:
-- SettingUpdateResponse
+- SettingEditResponse
- SettingGetResponse
Methods:
-- client.workerScripts.settings.update(accountId, scriptName, { ...params }) -> SettingUpdateResponse
+- client.workerScripts.settings.edit(accountId, scriptName, { ...params }) -> SettingEditResponse
- client.workerScripts.settings.get(accountId, scriptName) -> SettingGetResponse
# Zerotrust
@@ -5056,12 +5065,12 @@ Methods:
Types:
-- ConnectivitySettingUpdateResponse
+- ConnectivitySettingEditResponse
- ConnectivitySettingGetResponse
Methods:
-- client.zerotrust.connectivitySettings.update(accountId, { ...params }) -> ConnectivitySettingUpdateResponse
+- client.zerotrust.connectivitySettings.edit(accountId, { ...params }) -> ConnectivitySettingEditResponse
- client.zerotrust.connectivitySettings.get(accountId) -> ConnectivitySettingGetResponse
# Addressing
@@ -5072,14 +5081,14 @@ Methods:
Types:
-- BGPPrefixUpdateResponse
- BGPPrefixListResponse
+- BGPPrefixEditResponse
- BGPPrefixGetResponse
Methods:
-- client.addressing.prefixes.bgpPrefixes.update(accountId, prefixId, bgpPrefixId, { ...params }) -> BGPPrefixUpdateResponse
- client.addressing.prefixes.bgpPrefixes.list(accountId, prefixId) -> BGPPrefixListResponse | null
+- client.addressing.prefixes.bgpPrefixes.edit(accountId, prefixId, bgpPrefixId, { ...params }) -> BGPPrefixEditResponse
- client.addressing.prefixes.bgpPrefixes.get(accountId, prefixId, bgpPrefixId) -> BGPPrefixGetResponse
### Bindings
@@ -5115,19 +5124,19 @@ Methods:
Types:
- WidgetCreateResponse
+- WidgetUpdateResponse
- WidgetListResponse
- WidgetDeleteResponse
- WidgetGetResponse
-- WidgetReplaceResponse
- WidgetRotateSecretResponse
Methods:
- client.challenges.widgets.create(accountIdentifier, { ...params }) -> WidgetCreateResponse
+- client.challenges.widgets.update(accountIdentifier, sitekey, { ...params }) -> WidgetUpdateResponse
- client.challenges.widgets.list(accountIdentifier, { ...params }) -> WidgetListResponsesV4PagePaginationArray
- client.challenges.widgets.delete(accountIdentifier, sitekey) -> WidgetDeleteResponse
- client.challenges.widgets.get(accountIdentifier, sitekey) -> WidgetGetResponse
-- client.challenges.widgets.replace(accountIdentifier, sitekey, { ...params }) -> WidgetReplaceResponse
- client.challenges.widgets.rotateSecret(accountIdentifier, sitekey, { ...params }) -> WidgetRotateSecretResponse
# Hyperdrive
@@ -5137,18 +5146,18 @@ Methods:
Types:
- ConfigCreateResponse
+- ConfigUpdateResponse
- ConfigListResponse
- ConfigDeleteResponse
- ConfigGetResponse
-- ConfigReplaceResponse
Methods:
- client.hyperdrive.configs.create(accountId, { ...params }) -> ConfigCreateResponse | null
+- client.hyperdrive.configs.update(accountId, hyperdriveId, { ...params }) -> ConfigUpdateResponse | null
- client.hyperdrive.configs.list(accountId) -> ConfigListResponse
- client.hyperdrive.configs.delete(accountId, hyperdriveId) -> ConfigDeleteResponse | null
- client.hyperdrive.configs.get(accountId, hyperdriveId) -> ConfigGetResponse | null
-- client.hyperdrive.configs.replace(accountId, hyperdriveId, { ...params }) -> ConfigReplaceResponse | null
# Rum
@@ -5157,34 +5166,34 @@ Methods:
Types:
- SiteInfoCreateResponse
+- SiteInfoUpdateResponse
- SiteInfoListResponse
- SiteInfoDeleteResponse
- SiteInfoGetResponse
-- SiteInfoReplaceResponse
Methods:
- client.rum.siteInfos.create(accountId, { ...params }) -> SiteInfoCreateResponse
+- client.rum.siteInfos.update(accountId, siteId, { ...params }) -> SiteInfoUpdateResponse
- client.rum.siteInfos.list(accountId, { ...params }) -> SiteInfoListResponsesV4PagePaginationArray
- client.rum.siteInfos.delete(accountId, siteId) -> SiteInfoDeleteResponse
- client.rum.siteInfos.get(accountId, siteId) -> SiteInfoGetResponse
-- client.rum.siteInfos.replace(accountId, siteId, { ...params }) -> SiteInfoReplaceResponse
## Rules
Types:
- RuleCreateResponse
+- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
-- RuleReplaceResponse
Methods:
- client.rum.rules.create(accountId, rulesetId, { ...params }) -> RuleCreateResponse
+- client.rum.rules.update(accountId, rulesetId, ruleId, { ...params }) -> RuleUpdateResponse
- client.rum.rules.list(accountId, rulesetId) -> RuleListResponse
- client.rum.rules.delete(accountId, rulesetId, ruleId) -> RuleDeleteResponse
-- client.rum.rules.replace(accountId, rulesetId, ruleId, { ...params }) -> RuleReplaceResponse
# Vectorize
@@ -5193,23 +5202,23 @@ Methods:
Types:
- IndexCreateResponse
+- IndexUpdateResponse
- IndexListResponse
- IndexDeleteResponse
- IndexGetResponse
- IndexInsertResponse
- IndexQueryResponse
-- IndexReplaceResponse
- IndexUpsertResponse
Methods:
- client.vectorize.indexes.create(accountIdentifier, { ...params }) -> IndexCreateResponse | null
+- client.vectorize.indexes.update(accountIdentifier, indexName, { ...params }) -> IndexUpdateResponse | null
- client.vectorize.indexes.list(accountIdentifier) -> IndexListResponse
- client.vectorize.indexes.delete(accountIdentifier, indexName) -> IndexDeleteResponse | null
- client.vectorize.indexes.get(accountIdentifier, indexName) -> IndexGetResponse | null
- client.vectorize.indexes.insert(accountIdentifier, indexName) -> IndexInsertResponse | null
- client.vectorize.indexes.query(accountIdentifier, indexName, { ...params }) -> IndexQueryResponse | null
-- client.vectorize.indexes.replace(accountIdentifier, indexName, { ...params }) -> IndexReplaceResponse | null
- client.vectorize.indexes.upsert(accountIdentifier, indexName) -> IndexUpsertResponse | null
# URLScanner
@@ -5967,13 +5976,13 @@ Methods:
Types:
+- BotManagementUpdateResponse
- BotManagementGetResponse
-- BotManagementReplaceResponse
Methods:
+- client.botManagement.update(zoneId, { ...params }) -> BotManagementUpdateResponse
- client.botManagement.get(zoneId) -> BotManagementGetResponse
-- client.botManagement.replace(zoneId, { ...params }) -> BotManagementReplaceResponse
# CacheReserve
@@ -5991,13 +6000,13 @@ Methods:
Types:
+- OriginPostQuantumEncryptionUpdateResponse
- OriginPostQuantumEncryptionGetResponse
-- OriginPostQuantumEncryptionReplaceResponse
Methods:
+- client.originPostQuantumEncryption.update(zoneId, { ...params }) -> OriginPostQuantumEncryptionUpdateResponse
- client.originPostQuantumEncryption.get(zoneId) -> OriginPostQuantumEncryptionGetResponse
-- client.originPostQuantumEncryption.replace(zoneId, { ...params }) -> OriginPostQuantumEncryptionReplaceResponse
# Firewall
@@ -6009,49 +6018,49 @@ Methods:
Types:
-- GroupUpdateResponse
- GroupListResponse
+- GroupEditResponse
- GroupGetResponse
Methods:
-- client.firewall.waf.packages.groups.update(zoneId, packageId, groupId, { ...params }) -> GroupUpdateResponse
- client.firewall.waf.packages.groups.list(zoneId, packageId, { ...params }) -> GroupListResponsesV4PagePaginationArray
+- client.firewall.waf.packages.groups.edit(zoneId, packageId, groupId, { ...params }) -> GroupEditResponse
- client.firewall.waf.packages.groups.get(zoneId, packageId, groupId) -> GroupGetResponse
#### Rules
Types:
-- RuleUpdateResponse
+- RuleEditResponse
- RuleGetResponse
Methods:
-- client.firewall.waf.packages.rules.update(zoneId, packageId, ruleId, { ...params }) -> RuleUpdateResponse
+- client.firewall.waf.packages.rules.edit(zoneId, packageId, ruleId, { ...params }) -> RuleEditResponse
- client.firewall.waf.packages.rules.get(zoneId, packageId, ruleId) -> RuleGetResponse
# Zaraz
Types:
-- ZarazReplaceResponse
+- ZarazUpdateResponse
Methods:
-- client.zaraz.replace(zoneId, { ...params }) -> ZarazReplaceResponse
+- client.zaraz.update(zoneId, { ...params }) -> ZarazUpdateResponse
## Config
Types:
+- ConfigUpdateResponse
- ConfigGetResponse
-- ConfigReplaceResponse
Methods:
+- client.zaraz.config.update(zoneId, { ...params }) -> ConfigUpdateResponse
- client.zaraz.config.get(zoneId) -> ConfigGetResponse
-- client.zaraz.config.replace(zoneId, { ...params }) -> ConfigReplaceResponse
## Default
@@ -6077,13 +6086,13 @@ Methods:
Types:
+- HistoryUpdateResponse
- HistoryListResponse
-- HistoryReplaceResponse
Methods:
+- client.zaraz.history.update(zoneId, { ...params }) -> HistoryUpdateResponse
- client.zaraz.history.list(zoneId, { ...params }) -> HistoryListResponse
-- client.zaraz.history.replace(zoneId, { ...params }) -> HistoryReplaceResponse
### Configs
@@ -6193,31 +6202,31 @@ Methods:
Types:
+- TLSUpdateResponse
- TLSDeleteResponse
- TLSGetResponse
-- TLSReplaceResponse
Methods:
+- client.hostnames.settings.tls.update(zoneId, settingId, hostname, { ...params }) -> TLSUpdateResponse
- client.hostnames.settings.tls.delete(zoneId, settingId, hostname) -> TLSDeleteResponse
- client.hostnames.settings.tls.get(zoneId, settingId) -> TLSGetResponse | null
-- client.hostnames.settings.tls.replace(zoneId, settingId, hostname, { ...params }) -> TLSReplaceResponse
# Snippets
Types:
+- SnippetUpdateResponse
- SnippetListResponse
- SnippetDeleteResponse
- SnippetGetResponse
-- SnippetReplaceResponse
Methods:
+- client.snippets.update(zoneIdentifier, snippetName, { ...params }) -> SnippetUpdateResponse
- client.snippets.list(zoneIdentifier) -> SnippetListResponse
- client.snippets.delete(zoneIdentifier, snippetName) -> SnippetDeleteResponse
- client.snippets.get(zoneIdentifier, snippetName) -> SnippetGetResponse
-- client.snippets.replace(zoneIdentifier, snippetName, { ...params }) -> SnippetReplaceResponse
## Content
@@ -6229,28 +6238,28 @@ Methods:
Types:
+- SnippetRuleUpdateResponse
- SnippetRuleListResponse
-- SnippetRuleReplaceResponse
Methods:
+- client.snippets.snippetRules.update(zoneIdentifier, { ...params }) -> SnippetRuleUpdateResponse
- client.snippets.snippetRules.list(zoneIdentifier) -> SnippetRuleListResponse
-- client.snippets.snippetRules.replace(zoneIdentifier, { ...params }) -> SnippetRuleReplaceResponse
# Calls
Types:
- CallCreateResponse
+- CallUpdateResponse
- CallListResponse
- CallDeleteResponse
- CallGetResponse
-- CallReplaceResponse
Methods:
- client.calls.create(accountId, { ...params }) -> CallCreateResponse
+- client.calls.update(accountId, appId, { ...params }) -> CallUpdateResponse
- client.calls.list(accountId) -> CallListResponse
- client.calls.delete(accountId, appId) -> CallDeleteResponse
- client.calls.get(accountId, appId) -> CallGetResponse
-- client.calls.replace(accountId, appId, { ...params }) -> CallReplaceResponse
diff --git a/src/index.ts b/src/index.ts
index 33dff65a5e..271868970a 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -354,12 +354,12 @@ export namespace Cloudflare {
export import V4PagePaginationArrayResponse = Pagination.V4PagePaginationArrayResponse;
export import Accounts = API.Accounts;
+ export import AccountUpdateResponse = API.AccountUpdateResponse;
export import AccountListResponse = API.AccountListResponse;
export import AccountGetResponse = API.AccountGetResponse;
- export import AccountReplaceResponse = API.AccountReplaceResponse;
export import AccountListResponsesV4PagePaginationArray = API.AccountListResponsesV4PagePaginationArray;
+ export import AccountUpdateParams = API.AccountUpdateParams;
export import AccountListParams = API.AccountListParams;
- export import AccountReplaceParams = API.AccountReplaceParams;
export import Certificates = API.Certificates;
export import CertificateCreateResponse = API.CertificateCreateResponse;
@@ -373,29 +373,29 @@ export namespace Cloudflare {
export import IPListParams = API.IPListParams;
export import Memberships = API.Memberships;
+ export import MembershipUpdateResponse = API.MembershipUpdateResponse;
export import MembershipListResponse = API.MembershipListResponse;
export import MembershipDeleteResponse = API.MembershipDeleteResponse;
export import MembershipGetResponse = API.MembershipGetResponse;
- export import MembershipReplaceResponse = API.MembershipReplaceResponse;
export import MembershipListResponsesV4PagePaginationArray = API.MembershipListResponsesV4PagePaginationArray;
+ export import MembershipUpdateParams = API.MembershipUpdateParams;
export import MembershipListParams = API.MembershipListParams;
- export import MembershipReplaceParams = API.MembershipReplaceParams;
export import Users = API.Users;
- export import UserUpdateResponse = API.UserUpdateResponse;
export import UserListResponse = API.UserListResponse;
- export import UserUpdateParams = API.UserUpdateParams;
+ export import UserEditResponse = API.UserEditResponse;
+ export import UserEditParams = API.UserEditParams;
export import Zones = API.Zones;
export import ZoneCreateResponse = API.ZoneCreateResponse;
- export import ZoneUpdateResponse = API.ZoneUpdateResponse;
export import ZoneListResponse = API.ZoneListResponse;
export import ZoneDeleteResponse = API.ZoneDeleteResponse;
+ export import ZoneEditResponse = API.ZoneEditResponse;
export import ZoneGetResponse = API.ZoneGetResponse;
export import ZoneListResponsesV4PagePaginationArray = API.ZoneListResponsesV4PagePaginationArray;
export import ZoneCreateParams = API.ZoneCreateParams;
- export import ZoneUpdateParams = API.ZoneUpdateParams;
export import ZoneListParams = API.ZoneListParams;
+ export import ZoneEditParams = API.ZoneEditParams;
export import AI = API.AI;
export import AICreateResponse = API.AICreateResponse;
@@ -403,29 +403,31 @@ export namespace Cloudflare {
export import LoadBalancers = API.LoadBalancers;
export import LoadBalancerCreateResponse = API.LoadBalancerCreateResponse;
- export import LoadBalancerUpdateResponse = API.LoadBalancerUpdateResponse;
export import LoadBalancerListResponse = API.LoadBalancerListResponse;
export import LoadBalancerDeleteResponse = API.LoadBalancerDeleteResponse;
+ export import LoadBalancerEditResponse = API.LoadBalancerEditResponse;
export import LoadBalancerGetResponse = API.LoadBalancerGetResponse;
export import LoadBalancerCreateParams = API.LoadBalancerCreateParams;
- export import LoadBalancerUpdateParams = API.LoadBalancerUpdateParams;
+ export import LoadBalancerEditParams = API.LoadBalancerEditParams;
export import Access = API.Access;
export import DNSAnalytics = API.DNSAnalytics;
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 SubscriptionReplaceResponse = API.SubscriptionReplaceResponse;
export import SubscriptionCreateParams = API.SubscriptionCreateParams;
- export import SubscriptionReplaceParams = API.SubscriptionReplaceParams;
+ export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
export import Acm = API.Acm;
@@ -442,9 +444,9 @@ export namespace Cloudflare {
export import ClientCertificates = API.ClientCertificates;
export import ClientCertificateCreateResponse = API.ClientCertificateCreateResponse;
- export import ClientCertificateUpdateResponse = API.ClientCertificateUpdateResponse;
export import ClientCertificateListResponse = API.ClientCertificateListResponse;
export import ClientCertificateDeleteResponse = API.ClientCertificateDeleteResponse;
+ export import ClientCertificateEditResponse = API.ClientCertificateEditResponse;
export import ClientCertificateGetResponse = API.ClientCertificateGetResponse;
export import ClientCertificateListResponsesV4PagePaginationArray = API.ClientCertificateListResponsesV4PagePaginationArray;
export import ClientCertificateCreateParams = API.ClientCertificateCreateParams;
@@ -452,25 +454,25 @@ export namespace Cloudflare {
export import CustomCertificates = API.CustomCertificates;
export import CustomCertificateCreateResponse = API.CustomCertificateCreateResponse;
- export import CustomCertificateUpdateResponse = API.CustomCertificateUpdateResponse;
export import CustomCertificateListResponse = API.CustomCertificateListResponse;
export import CustomCertificateDeleteResponse = API.CustomCertificateDeleteResponse;
+ export import CustomCertificateEditResponse = API.CustomCertificateEditResponse;
export import CustomCertificateGetResponse = API.CustomCertificateGetResponse;
export import CustomCertificateListResponsesV4PagePaginationArray = API.CustomCertificateListResponsesV4PagePaginationArray;
export import CustomCertificateCreateParams = API.CustomCertificateCreateParams;
- export import CustomCertificateUpdateParams = API.CustomCertificateUpdateParams;
export import CustomCertificateListParams = API.CustomCertificateListParams;
+ export import CustomCertificateEditParams = API.CustomCertificateEditParams;
export import CustomHostnames = API.CustomHostnames;
export import CustomHostnameCreateResponse = API.CustomHostnameCreateResponse;
- export import CustomHostnameUpdateResponse = API.CustomHostnameUpdateResponse;
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 CustomHostnameUpdateParams = API.CustomHostnameUpdateParams;
export import CustomHostnameListParams = API.CustomHostnameListParams;
+ export import CustomHostnameEditParams = API.CustomHostnameEditParams;
export import CustomNameservers = API.CustomNameservers;
export import CustomNameserverCreateResponse = API.CustomNameserverCreateResponse;
@@ -482,57 +484,57 @@ export namespace Cloudflare {
export import DNSRecords = API.DNSRecords;
export import DNSRecordCreateResponse = API.DNSRecordCreateResponse;
+ export import DNSRecordUpdateResponse = API.DNSRecordUpdateResponse;
export import DNSRecordListResponse = API.DNSRecordListResponse;
export import DNSRecordDeleteResponse = API.DNSRecordDeleteResponse;
export import DNSRecordExportResponse = API.DNSRecordExportResponse;
export import DNSRecordGetResponse = API.DNSRecordGetResponse;
export import DNSRecordImportResponse = API.DNSRecordImportResponse;
- export import DNSRecordReplaceResponse = API.DNSRecordReplaceResponse;
export import DNSRecordScanResponse = API.DNSRecordScanResponse;
export import DNSRecordListResponsesV4PagePaginationArray = API.DNSRecordListResponsesV4PagePaginationArray;
export import DNSRecordCreateParams = API.DNSRecordCreateParams;
+ export import DNSRecordUpdateParams = API.DNSRecordUpdateParams;
export import DNSRecordListParams = API.DNSRecordListParams;
export import DNSRecordImportParams = API.DNSRecordImportParams;
- export import DNSRecordReplaceParams = API.DNSRecordReplaceParams;
export import DNSSEC = API.DNSSEC;
- export import DNSSECUpdateResponse = API.DNSSECUpdateResponse;
export import DNSSECDeleteResponse = API.DNSSECDeleteResponse;
+ export import DNSSECEditResponse = API.DNSSECEditResponse;
export import DNSSECGetResponse = API.DNSSECGetResponse;
- export import DNSSECUpdateParams = API.DNSSECUpdateParams;
+ export import DNSSECEditParams = API.DNSSECEditParams;
export import Emails = API.Emails;
export import Filters = API.Filters;
export import FilterCreateResponse = API.FilterCreateResponse;
+ export import FilterUpdateResponse = API.FilterUpdateResponse;
export import FilterListResponse = API.FilterListResponse;
export import FilterDeleteResponse = API.FilterDeleteResponse;
export import FilterGetResponse = API.FilterGetResponse;
- export import FilterReplaceResponse = API.FilterReplaceResponse;
export import FilterListResponsesV4PagePaginationArray = API.FilterListResponsesV4PagePaginationArray;
export import FilterCreateParams = API.FilterCreateParams;
+ export import FilterUpdateParams = API.FilterUpdateParams;
export import FilterListParams = API.FilterListParams;
- export import FilterReplaceParams = API.FilterReplaceParams;
export import Firewalls = API.Firewalls;
export import Healthchecks = API.Healthchecks;
export import HealthcheckCreateResponse = API.HealthcheckCreateResponse;
+ export import HealthcheckUpdateResponse = API.HealthcheckUpdateResponse;
export import HealthcheckListResponse = API.HealthcheckListResponse;
export import HealthcheckDeleteResponse = API.HealthcheckDeleteResponse;
export import HealthcheckGetResponse = API.HealthcheckGetResponse;
- export import HealthcheckReplaceResponse = API.HealthcheckReplaceResponse;
export import HealthcheckCreateParams = API.HealthcheckCreateParams;
- export import HealthcheckReplaceParams = API.HealthcheckReplaceParams;
+ export import HealthcheckUpdateParams = API.HealthcheckUpdateParams;
export import KeylessCertificates = API.KeylessCertificates;
export import KeylessCertificateCreateResponse = API.KeylessCertificateCreateResponse;
- export import KeylessCertificateUpdateResponse = API.KeylessCertificateUpdateResponse;
export import KeylessCertificateListResponse = API.KeylessCertificateListResponse;
export import KeylessCertificateDeleteResponse = API.KeylessCertificateDeleteResponse;
+ export import KeylessCertificateEditResponse = API.KeylessCertificateEditResponse;
export import KeylessCertificateGetResponse = API.KeylessCertificateGetResponse;
export import KeylessCertificateCreateParams = API.KeylessCertificateCreateParams;
- export import KeylessCertificateUpdateParams = API.KeylessCertificateUpdateParams;
+ export import KeylessCertificateEditParams = API.KeylessCertificateEditParams;
export import Logpush = API.Logpush;
@@ -547,24 +549,24 @@ export namespace Cloudflare {
export import Pagerules = API.Pagerules;
export import PageruleCreateResponse = API.PageruleCreateResponse;
+ export import PageruleUpdateResponse = API.PageruleUpdateResponse;
export import PageruleListResponse = API.PageruleListResponse;
export import PageruleDeleteResponse = API.PageruleDeleteResponse;
export import PageruleGetResponse = API.PageruleGetResponse;
- export import PageruleReplaceResponse = API.PageruleReplaceResponse;
export import PageruleCreateParams = API.PageruleCreateParams;
+ export import PageruleUpdateParams = API.PageruleUpdateParams;
export import PageruleListParams = API.PageruleListParams;
- export import PageruleReplaceParams = API.PageruleReplaceParams;
export import RateLimits = API.RateLimits;
export import RateLimitCreateResponse = API.RateLimitCreateResponse;
- export import RateLimitUpdateResponse = API.RateLimitUpdateResponse;
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 RateLimitUpdateParams = API.RateLimitUpdateParams;
export import RateLimitListParams = API.RateLimitListParams;
+ export import RateLimitEditParams = API.RateLimitEditParams;
export import SecondaryDNS = API.SecondaryDNS;
@@ -575,44 +577,44 @@ export namespace Cloudflare {
export import WaitingRooms = API.WaitingRooms;
export import WaitingRoomCreateResponse = API.WaitingRoomCreateResponse;
+ export import WaitingRoomUpdateResponse = API.WaitingRoomUpdateResponse;
export import WaitingRoomListResponse = API.WaitingRoomListResponse;
export import WaitingRoomDeleteResponse = API.WaitingRoomDeleteResponse;
export import WaitingRoomGetResponse = API.WaitingRoomGetResponse;
export import WaitingRoomPreviewResponse = API.WaitingRoomPreviewResponse;
- export import WaitingRoomReplaceResponse = API.WaitingRoomReplaceResponse;
export import WaitingRoomCreateParams = API.WaitingRoomCreateParams;
+ export import WaitingRoomUpdateParams = API.WaitingRoomUpdateParams;
export import WaitingRoomPreviewParams = API.WaitingRoomPreviewParams;
- export import WaitingRoomReplaceParams = API.WaitingRoomReplaceParams;
export import Web3 = API.Web3;
export import Workers = API.Workers;
export import ActivationChecks = API.ActivationChecks;
- export import ActivationCheckReplaceResponse = API.ActivationCheckReplaceResponse;
+ export import ActivationCheckUpdateResponse = API.ActivationCheckUpdateResponse;
export import ManagedHeaders = API.ManagedHeaders;
- export import ManagedHeaderUpdateResponse = API.ManagedHeaderUpdateResponse;
export import ManagedHeaderListResponse = API.ManagedHeaderListResponse;
- export import ManagedHeaderUpdateParams = API.ManagedHeaderUpdateParams;
+ export import ManagedHeaderEditResponse = API.ManagedHeaderEditResponse;
+ export import ManagedHeaderEditParams = API.ManagedHeaderEditParams;
export import PageShield = API.PageShield;
+ export import PageShieldUpdateResponse = API.PageShieldUpdateResponse;
export import PageShieldListResponse = API.PageShieldListResponse;
- export import PageShieldReplaceResponse = API.PageShieldReplaceResponse;
- export import PageShieldReplaceParams = API.PageShieldReplaceParams;
+ export import PageShieldUpdateParams = API.PageShieldUpdateParams;
export import Rulesets = API.Rulesets;
export import RulesetCreateResponse = API.RulesetCreateResponse;
+ export import RulesetUpdateResponse = API.RulesetUpdateResponse;
export import RulesetListResponse = API.RulesetListResponse;
export import RulesetGetResponse = API.RulesetGetResponse;
- export import RulesetReplaceResponse = API.RulesetReplaceResponse;
export import RulesetCreateParams = API.RulesetCreateParams;
- export import RulesetReplaceParams = API.RulesetReplaceParams;
+ export import RulesetUpdateParams = API.RulesetUpdateParams;
export import URLNormalizations = API.URLNormalizations;
+ export import URLNormalizationUpdateResponse = API.URLNormalizationUpdateResponse;
export import URLNormalizationGetResponse = API.URLNormalizationGetResponse;
- export import URLNormalizationReplaceResponse = API.URLNormalizationReplaceResponse;
- export import URLNormalizationReplaceParams = API.URLNormalizationReplaceParams;
+ export import URLNormalizationUpdateParams = API.URLNormalizationUpdateParams;
export import Spectrum = API.Spectrum;
@@ -629,15 +631,15 @@ export namespace Cloudflare {
export import Tunnels = API.Tunnels;
export import TunnelCreateResponse = API.TunnelCreateResponse;
- export import TunnelUpdateResponse = API.TunnelUpdateResponse;
export import TunnelListResponse = API.TunnelListResponse;
export import TunnelDeleteResponse = API.TunnelDeleteResponse;
+ export import TunnelEditResponse = API.TunnelEditResponse;
export import TunnelGetResponse = API.TunnelGetResponse;
export import TunnelListResponsesV4PagePaginationArray = API.TunnelListResponsesV4PagePaginationArray;
export import TunnelCreateParams = API.TunnelCreateParams;
- export import TunnelUpdateParams = API.TunnelUpdateParams;
export import TunnelListParams = API.TunnelListParams;
export import TunnelDeleteParams = API.TunnelDeleteParams;
+ export import TunnelEditParams = API.TunnelEditParams;
export import Diagnostics = API.Diagnostics;
@@ -645,14 +647,14 @@ export namespace Cloudflare {
export import DNSFirewall = API.DNSFirewall;
export import DNSFirewallCreateResponse = API.DNSFirewallCreateResponse;
- export import DNSFirewallUpdateResponse = API.DNSFirewallUpdateResponse;
export import DNSFirewallListResponse = API.DNSFirewallListResponse;
export import DNSFirewallDeleteResponse = API.DNSFirewallDeleteResponse;
+ export import DNSFirewallEditResponse = API.DNSFirewallEditResponse;
export import DNSFirewallGetResponse = API.DNSFirewallGetResponse;
export import DNSFirewallListResponsesV4PagePaginationArray = API.DNSFirewallListResponsesV4PagePaginationArray;
export import DNSFirewallCreateParams = API.DNSFirewallCreateParams;
- export import DNSFirewallUpdateParams = API.DNSFirewallUpdateParams;
export import DNSFirewallListParams = API.DNSFirewallListParams;
+ export import DNSFirewallEditParams = API.DNSFirewallEditParams;
export import Images = API.Images;
@@ -662,14 +664,14 @@ export namespace Cloudflare {
export import AccountMembers = API.AccountMembers;
export import AccountMemberCreateResponse = API.AccountMemberCreateResponse;
+ export import AccountMemberUpdateResponse = API.AccountMemberUpdateResponse;
export import AccountMemberListResponse = API.AccountMemberListResponse;
export import AccountMemberDeleteResponse = API.AccountMemberDeleteResponse;
export import AccountMemberGetResponse = API.AccountMemberGetResponse;
- export import AccountMemberReplaceResponse = API.AccountMemberReplaceResponse;
export import AccountMemberListResponsesV4PagePaginationArray = API.AccountMemberListResponsesV4PagePaginationArray;
export import AccountMemberCreateParams = API.AccountMemberCreateParams;
+ export import AccountMemberUpdateParams = API.AccountMemberUpdateParams;
export import AccountMemberListParams = API.AccountMemberListParams;
- export import AccountMemberReplaceParams = API.AccountMemberReplaceParams;
export import Mnms = API.Mnms;
@@ -728,15 +730,15 @@ export namespace Cloudflare {
export import WarpConnector = API.WarpConnector;
export import WarpConnectorCreateResponse = API.WarpConnectorCreateResponse;
- export import WarpConnectorUpdateResponse = API.WarpConnectorUpdateResponse;
export import WarpConnectorListResponse = API.WarpConnectorListResponse;
export import WarpConnectorDeleteResponse = API.WarpConnectorDeleteResponse;
+ export import WarpConnectorEditResponse = API.WarpConnectorEditResponse;
export import WarpConnectorGetResponse = API.WarpConnectorGetResponse;
export import WarpConnectorListResponsesV4PagePaginationArray = API.WarpConnectorListResponsesV4PagePaginationArray;
export import WarpConnectorCreateParams = API.WarpConnectorCreateParams;
- export import WarpConnectorUpdateParams = API.WarpConnectorUpdateParams;
export import WarpConnectorListParams = API.WarpConnectorListParams;
export import WarpConnectorDeleteParams = API.WarpConnectorDeleteParams;
+ export import WarpConnectorEditParams = API.WarpConnectorEditParams;
export import Dispatchers = API.Dispatchers;
@@ -766,24 +768,24 @@ export namespace Cloudflare {
export import Radar = API.Radar;
export import BotManagement = API.BotManagement;
+ export import BotManagementUpdateResponse = API.BotManagementUpdateResponse;
export import BotManagementGetResponse = API.BotManagementGetResponse;
- export import BotManagementReplaceResponse = API.BotManagementReplaceResponse;
- export import BotManagementReplaceParams = API.BotManagementReplaceParams;
+ export import BotManagementUpdateParams = API.BotManagementUpdateParams;
export import CacheReserve = API.CacheReserve;
export import CacheReserveCreateResponse = API.CacheReserveCreateResponse;
export import CacheReserveGetResponse = API.CacheReserveGetResponse;
export import OriginPostQuantumEncryption = API.OriginPostQuantumEncryption;
+ export import OriginPostQuantumEncryptionUpdateResponse = API.OriginPostQuantumEncryptionUpdateResponse;
export import OriginPostQuantumEncryptionGetResponse = API.OriginPostQuantumEncryptionGetResponse;
- export import OriginPostQuantumEncryptionReplaceResponse = API.OriginPostQuantumEncryptionReplaceResponse;
- export import OriginPostQuantumEncryptionReplaceParams = API.OriginPostQuantumEncryptionReplaceParams;
+ export import OriginPostQuantumEncryptionUpdateParams = API.OriginPostQuantumEncryptionUpdateParams;
export import Firewall = API.Firewall;
export import Zaraz = API.Zaraz;
- export import ZarazReplaceResponse = API.ZarazReplaceResponse;
- export import ZarazReplaceParams = API.ZarazReplaceParams;
+ export import ZarazUpdateResponse = API.ZarazUpdateResponse;
+ export import ZarazUpdateParams = API.ZarazUpdateParams;
export import Speed = API.Speed;
export import SpeedCreateResponse = API.SpeedCreateResponse;
@@ -801,20 +803,20 @@ export namespace Cloudflare {
export import Hostnames = API.Hostnames;
export import Snippets = API.Snippets;
+ export import SnippetUpdateResponse = API.SnippetUpdateResponse;
export import SnippetListResponse = API.SnippetListResponse;
export import SnippetDeleteResponse = API.SnippetDeleteResponse;
export import SnippetGetResponse = API.SnippetGetResponse;
- export import SnippetReplaceResponse = API.SnippetReplaceResponse;
- export import SnippetReplaceParams = API.SnippetReplaceParams;
+ export import SnippetUpdateParams = API.SnippetUpdateParams;
export import Calls = API.Calls;
export import CallCreateResponse = API.CallCreateResponse;
+ export import CallUpdateResponse = API.CallUpdateResponse;
export import CallListResponse = API.CallListResponse;
export import CallDeleteResponse = API.CallDeleteResponse;
export import CallGetResponse = API.CallGetResponse;
- export import CallReplaceResponse = API.CallReplaceResponse;
export import CallCreateParams = API.CallCreateParams;
- export import CallReplaceParams = API.CallReplaceParams;
+ export import CallUpdateParams = API.CallUpdateParams;
}
export default Cloudflare;
diff --git a/src/resources/access/access.ts b/src/resources/access/access.ts
index 26900d7286..3a71c55afb 100644
--- a/src/resources/access/access.ts
+++ b/src/resources/access/access.ts
@@ -36,84 +36,84 @@ export class Access extends APIResource {
export namespace Access {
export import Applications = ApplicationsAPI.Applications;
export import ApplicationCreateResponse = ApplicationsAPI.ApplicationCreateResponse;
+ export import ApplicationUpdateResponse = ApplicationsAPI.ApplicationUpdateResponse;
export import ApplicationListResponse = ApplicationsAPI.ApplicationListResponse;
export import ApplicationDeleteResponse = ApplicationsAPI.ApplicationDeleteResponse;
export import ApplicationGetResponse = ApplicationsAPI.ApplicationGetResponse;
- export import ApplicationReplaceResponse = ApplicationsAPI.ApplicationReplaceResponse;
export import ApplicationRevokeTokensResponse = ApplicationsAPI.ApplicationRevokeTokensResponse;
export import ApplicationCreateParams = ApplicationsAPI.ApplicationCreateParams;
- export import ApplicationReplaceParams = ApplicationsAPI.ApplicationReplaceParams;
+ export import ApplicationUpdateParams = ApplicationsAPI.ApplicationUpdateParams;
export import Certificates = CertificatesAPI.Certificates;
export import CertificateCreateResponse = CertificatesAPI.CertificateCreateResponse;
+ export import CertificateUpdateResponse = CertificatesAPI.CertificateUpdateResponse;
export import CertificateListResponse = CertificatesAPI.CertificateListResponse;
export import CertificateDeleteResponse = CertificatesAPI.CertificateDeleteResponse;
export import CertificateGetResponse = CertificatesAPI.CertificateGetResponse;
- export import CertificateReplaceResponse = CertificatesAPI.CertificateReplaceResponse;
export import CertificateCreateParams = CertificatesAPI.CertificateCreateParams;
- export import CertificateReplaceParams = CertificatesAPI.CertificateReplaceParams;
+ export import CertificateUpdateParams = CertificatesAPI.CertificateUpdateParams;
export import Groups = GroupsAPI.Groups;
export import GroupCreateResponse = GroupsAPI.GroupCreateResponse;
+ export import GroupUpdateResponse = GroupsAPI.GroupUpdateResponse;
export import GroupListResponse = GroupsAPI.GroupListResponse;
export import GroupDeleteResponse = GroupsAPI.GroupDeleteResponse;
export import GroupGetResponse = GroupsAPI.GroupGetResponse;
- export import GroupReplaceResponse = GroupsAPI.GroupReplaceResponse;
export import GroupCreateParams = GroupsAPI.GroupCreateParams;
- export import GroupReplaceParams = GroupsAPI.GroupReplaceParams;
+ export import GroupUpdateParams = GroupsAPI.GroupUpdateParams;
export import IdentityProviders = IdentityProvidersAPI.IdentityProviders;
export import IdentityProviderCreateResponse = IdentityProvidersAPI.IdentityProviderCreateResponse;
+ export import IdentityProviderUpdateResponse = IdentityProvidersAPI.IdentityProviderUpdateResponse;
export import IdentityProviderListResponse = IdentityProvidersAPI.IdentityProviderListResponse;
export import IdentityProviderDeleteResponse = IdentityProvidersAPI.IdentityProviderDeleteResponse;
export import IdentityProviderGetResponse = IdentityProvidersAPI.IdentityProviderGetResponse;
- export import IdentityProviderReplaceResponse = IdentityProvidersAPI.IdentityProviderReplaceResponse;
export import IdentityProviderCreateParams = IdentityProvidersAPI.IdentityProviderCreateParams;
- export import IdentityProviderReplaceParams = IdentityProvidersAPI.IdentityProviderReplaceParams;
+ export import IdentityProviderUpdateParams = IdentityProvidersAPI.IdentityProviderUpdateParams;
export import Organizations = OrganizationsAPI.Organizations;
export import OrganizationCreateResponse = OrganizationsAPI.OrganizationCreateResponse;
+ export import OrganizationUpdateResponse = OrganizationsAPI.OrganizationUpdateResponse;
export import OrganizationListResponse = OrganizationsAPI.OrganizationListResponse;
- export import OrganizationReplaceResponse = OrganizationsAPI.OrganizationReplaceResponse;
export import OrganizationRevokeUsersResponse = OrganizationsAPI.OrganizationRevokeUsersResponse;
export import OrganizationCreateParams = OrganizationsAPI.OrganizationCreateParams;
- export import OrganizationReplaceParams = OrganizationsAPI.OrganizationReplaceParams;
+ export import OrganizationUpdateParams = OrganizationsAPI.OrganizationUpdateParams;
export import OrganizationRevokeUsersParams = OrganizationsAPI.OrganizationRevokeUsersParams;
export import ServiceTokens = ServiceTokensAPI.ServiceTokens;
export import ServiceTokenCreateResponse = ServiceTokensAPI.ServiceTokenCreateResponse;
+ export import ServiceTokenUpdateResponse = ServiceTokensAPI.ServiceTokenUpdateResponse;
export import ServiceTokenListResponse = ServiceTokensAPI.ServiceTokenListResponse;
export import ServiceTokenDeleteResponse = ServiceTokensAPI.ServiceTokenDeleteResponse;
export import ServiceTokenRefreshResponse = ServiceTokensAPI.ServiceTokenRefreshResponse;
- export import ServiceTokenReplaceResponse = ServiceTokensAPI.ServiceTokenReplaceResponse;
export import ServiceTokenRotateResponse = ServiceTokensAPI.ServiceTokenRotateResponse;
export import ServiceTokenCreateParams = ServiceTokensAPI.ServiceTokenCreateParams;
- export import ServiceTokenReplaceParams = ServiceTokensAPI.ServiceTokenReplaceParams;
+ export import ServiceTokenUpdateParams = ServiceTokensAPI.ServiceTokenUpdateParams;
export import Bookmarks = BookmarksAPI.Bookmarks;
+ export import BookmarkUpdateResponse = BookmarksAPI.BookmarkUpdateResponse;
export import BookmarkListResponse = BookmarksAPI.BookmarkListResponse;
export import BookmarkDeleteResponse = BookmarksAPI.BookmarkDeleteResponse;
export import BookmarkGetResponse = BookmarksAPI.BookmarkGetResponse;
- export import BookmarkReplaceResponse = BookmarksAPI.BookmarkReplaceResponse;
export import Keys = KeysAPI.Keys;
+ export import KeyUpdateResponse = KeysAPI.KeyUpdateResponse;
export import KeyListResponse = KeysAPI.KeyListResponse;
- export import KeyReplaceResponse = KeysAPI.KeyReplaceResponse;
export import KeyRotateResponse = KeysAPI.KeyRotateResponse;
- export import KeyReplaceParams = KeysAPI.KeyReplaceParams;
+ export import KeyUpdateParams = KeysAPI.KeyUpdateParams;
export import Logs = LogsAPI.Logs;
export import Seats = SeatsAPI.Seats;
- export import SeatUpdateResponse = SeatsAPI.SeatUpdateResponse;
- export import SeatUpdateParams = SeatsAPI.SeatUpdateParams;
+ export import SeatEditResponse = SeatsAPI.SeatEditResponse;
+ export import SeatEditParams = SeatsAPI.SeatEditParams;
export import Users = UsersAPI.Users;
export import UserListResponse = UsersAPI.UserListResponse;
export import CustomPages = CustomPagesAPI.CustomPages;
export import CustomPageCreateResponse = CustomPagesAPI.CustomPageCreateResponse;
+ export import CustomPageUpdateResponse = CustomPagesAPI.CustomPageUpdateResponse;
export import CustomPageListResponse = CustomPagesAPI.CustomPageListResponse;
export import CustomPageDeleteResponse = CustomPagesAPI.CustomPageDeleteResponse;
export import CustomPageGetResponse = CustomPagesAPI.CustomPageGetResponse;
- export import CustomPageReplaceResponse = CustomPagesAPI.CustomPageReplaceResponse;
export import CustomPageCreateParams = CustomPagesAPI.CustomPageCreateParams;
- export import CustomPageReplaceParams = CustomPagesAPI.CustomPageReplaceParams;
+ export import CustomPageUpdateParams = CustomPagesAPI.CustomPageUpdateParams;
export import Tags = TagsAPI.Tags;
export import TagCreateResponse = TagsAPI.TagCreateResponse;
+ export import TagUpdateResponse = TagsAPI.TagUpdateResponse;
export import TagListResponse = TagsAPI.TagListResponse;
export import TagDeleteResponse = TagsAPI.TagDeleteResponse;
export import TagGetResponse = TagsAPI.TagGetResponse;
- export import TagReplaceResponse = TagsAPI.TagReplaceResponse;
export import TagCreateParams = TagsAPI.TagCreateParams;
- export import TagReplaceParams = TagsAPI.TagReplaceParams;
+ export import TagUpdateParams = TagsAPI.TagUpdateParams;
}
diff --git a/src/resources/access/applications/applications.ts b/src/resources/access/applications/applications.ts
index 602f72c588..f1e49c54f9 100644
--- a/src/resources/access/applications/applications.ts
+++ b/src/resources/access/applications/applications.ts
@@ -31,6 +31,24 @@ export class Applications extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates an Access application.
+ */
+ update(
+ accountOrZone: string,
+ accountOrZoneId: string,
+ appId: string | string,
+ body: ApplicationUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/apps/${appId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: ApplicationUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all Access applications in an account or zone.
*/
@@ -80,24 +98,6 @@ export class Applications extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Updates an Access application.
- */
- replace(
- accountOrZone: string,
- accountOrZoneId: string,
- appId: string | string,
- body: ApplicationReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/apps/${appId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: ApplicationReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Revokes all tokens issued for an application.
*/
@@ -1086,18 +1086,17 @@ export namespace ApplicationCreateResponse {
}
}
-export type ApplicationListResponse = Array<
- | ApplicationListResponse.SelfHostedApplication
- | ApplicationListResponse.SaaSApplication
- | ApplicationListResponse.BrowserSSHApplication
- | ApplicationListResponse.BrowserVncApplication
- | ApplicationListResponse.AppLauncherApplication
- | ApplicationListResponse.DeviceEnrollmentPermissionsApplication
- | ApplicationListResponse.BrowserIsolationPermissionsApplication
- | ApplicationListResponse.BookmarkApplication
->;
-
-export namespace ApplicationListResponse {
+export type ApplicationUpdateResponse =
+ | ApplicationUpdateResponse.SelfHostedApplication
+ | ApplicationUpdateResponse.SaaSApplication
+ | ApplicationUpdateResponse.BrowserSSHApplication
+ | ApplicationUpdateResponse.BrowserVncApplication
+ | ApplicationUpdateResponse.AppLauncherApplication
+ | ApplicationUpdateResponse.DeviceEnrollmentPermissionsApplication
+ | ApplicationUpdateResponse.BrowserIsolationPermissionsApplication
+ | ApplicationUpdateResponse.BookmarkApplication;
+
+export namespace ApplicationUpdateResponse {
export interface SelfHostedApplication {
/**
* The primary hostname and path that Access will secure. If the app is visible in
@@ -2057,24 +2056,18 @@ export namespace ApplicationListResponse {
}
}
-export interface ApplicationDeleteResponse {
- /**
- * UUID
- */
- id?: string;
-}
-
-export type ApplicationGetResponse =
- | ApplicationGetResponse.SelfHostedApplication
- | ApplicationGetResponse.SaaSApplication
- | ApplicationGetResponse.BrowserSSHApplication
- | ApplicationGetResponse.BrowserVncApplication
- | ApplicationGetResponse.AppLauncherApplication
- | ApplicationGetResponse.DeviceEnrollmentPermissionsApplication
- | ApplicationGetResponse.BrowserIsolationPermissionsApplication
- | ApplicationGetResponse.BookmarkApplication;
+export type ApplicationListResponse = Array<
+ | ApplicationListResponse.SelfHostedApplication
+ | ApplicationListResponse.SaaSApplication
+ | ApplicationListResponse.BrowserSSHApplication
+ | ApplicationListResponse.BrowserVncApplication
+ | ApplicationListResponse.AppLauncherApplication
+ | ApplicationListResponse.DeviceEnrollmentPermissionsApplication
+ | ApplicationListResponse.BrowserIsolationPermissionsApplication
+ | ApplicationListResponse.BookmarkApplication
+>;
-export namespace ApplicationGetResponse {
+export namespace ApplicationListResponse {
export interface SelfHostedApplication {
/**
* The primary hostname and path that Access will secure. If the app is visible in
@@ -3034,17 +3027,24 @@ export namespace ApplicationGetResponse {
}
}
-export type ApplicationReplaceResponse =
- | ApplicationReplaceResponse.SelfHostedApplication
- | ApplicationReplaceResponse.SaaSApplication
- | ApplicationReplaceResponse.BrowserSSHApplication
- | ApplicationReplaceResponse.BrowserVncApplication
- | ApplicationReplaceResponse.AppLauncherApplication
- | ApplicationReplaceResponse.DeviceEnrollmentPermissionsApplication
- | ApplicationReplaceResponse.BrowserIsolationPermissionsApplication
- | ApplicationReplaceResponse.BookmarkApplication;
-
-export namespace ApplicationReplaceResponse {
+export interface ApplicationDeleteResponse {
+ /**
+ * UUID
+ */
+ id?: string;
+}
+
+export type ApplicationGetResponse =
+ | ApplicationGetResponse.SelfHostedApplication
+ | ApplicationGetResponse.SaaSApplication
+ | ApplicationGetResponse.BrowserSSHApplication
+ | ApplicationGetResponse.BrowserVncApplication
+ | ApplicationGetResponse.AppLauncherApplication
+ | ApplicationGetResponse.DeviceEnrollmentPermissionsApplication
+ | ApplicationGetResponse.BrowserIsolationPermissionsApplication
+ | ApplicationGetResponse.BookmarkApplication;
+
+export namespace ApplicationGetResponse {
export interface SelfHostedApplication {
/**
* The primary hostname and path that Access will secure. If the app is visible in
@@ -4825,17 +4825,17 @@ export namespace ApplicationCreateParams {
}
}
-export type ApplicationReplaceParams =
- | ApplicationReplaceParams.Variant0
- | ApplicationReplaceParams.Variant1
- | ApplicationReplaceParams.Variant2
- | ApplicationReplaceParams.Variant3
- | ApplicationReplaceParams.Variant4
- | ApplicationReplaceParams.Variant5
- | ApplicationReplaceParams.Variant6
- | ApplicationReplaceParams.Variant7;
-
-export namespace ApplicationReplaceParams {
+export type ApplicationUpdateParams =
+ | ApplicationUpdateParams.Variant0
+ | ApplicationUpdateParams.Variant1
+ | ApplicationUpdateParams.Variant2
+ | ApplicationUpdateParams.Variant3
+ | ApplicationUpdateParams.Variant4
+ | ApplicationUpdateParams.Variant5
+ | ApplicationUpdateParams.Variant6
+ | ApplicationUpdateParams.Variant7;
+
+export namespace ApplicationUpdateParams {
export interface Variant0 {
/**
* The primary hostname and path that Access will secure. If the app is visible in
@@ -4873,7 +4873,7 @@ export namespace ApplicationReplaceParams {
*/
auto_redirect_to_identity?: boolean;
- cors_headers?: ApplicationReplaceParams.Variant0.CorsHeaders;
+ cors_headers?: ApplicationUpdateParams.Variant0.CorsHeaders;
/**
* The custom error message shown to a user when they are denied access to the
@@ -5042,8 +5042,8 @@ export namespace ApplicationReplaceParams {
name?: string;
saas_app?:
- | ApplicationReplaceParams.Variant1.AccessSamlSaasApp
- | ApplicationReplaceParams.Variant1.AccessOidcSaasApp;
+ | ApplicationUpdateParams.Variant1.AccessSamlSaasApp
+ | ApplicationUpdateParams.Variant1.AccessOidcSaasApp;
/**
* The tags you want assigned to an application. Tags are used to filter
@@ -5228,7 +5228,7 @@ export namespace ApplicationReplaceParams {
*/
auto_redirect_to_identity?: boolean;
- cors_headers?: ApplicationReplaceParams.Variant2.CorsHeaders;
+ cors_headers?: ApplicationUpdateParams.Variant2.CorsHeaders;
/**
* The custom error message shown to a user when they are denied access to the
@@ -5400,7 +5400,7 @@ export namespace ApplicationReplaceParams {
*/
auto_redirect_to_identity?: boolean;
- cors_headers?: ApplicationReplaceParams.Variant3.CorsHeaders;
+ cors_headers?: ApplicationUpdateParams.Variant3.CorsHeaders;
/**
* The custom error message shown to a user when they are denied access to the
@@ -5646,13 +5646,13 @@ export namespace ApplicationReplaceParams {
export namespace Applications {
export import ApplicationCreateResponse = ApplicationsAPI.ApplicationCreateResponse;
+ export import ApplicationUpdateResponse = ApplicationsAPI.ApplicationUpdateResponse;
export import ApplicationListResponse = ApplicationsAPI.ApplicationListResponse;
export import ApplicationDeleteResponse = ApplicationsAPI.ApplicationDeleteResponse;
export import ApplicationGetResponse = ApplicationsAPI.ApplicationGetResponse;
- export import ApplicationReplaceResponse = ApplicationsAPI.ApplicationReplaceResponse;
export import ApplicationRevokeTokensResponse = ApplicationsAPI.ApplicationRevokeTokensResponse;
export import ApplicationCreateParams = ApplicationsAPI.ApplicationCreateParams;
- export import ApplicationReplaceParams = ApplicationsAPI.ApplicationReplaceParams;
+ export import ApplicationUpdateParams = ApplicationsAPI.ApplicationUpdateParams;
export import Cas = CasAPI.Cas;
export import CaCreateResponse = CasAPI.CaCreateResponse;
export import CaListResponse = CasAPI.CaListResponse;
@@ -5662,10 +5662,10 @@ export namespace Applications {
export import UserPolicyCheckListResponse = UserPolicyChecksAPI.UserPolicyCheckListResponse;
export import Policies = PoliciesAPI.Policies;
export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
+ export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
- export import PolicyReplaceResponse = PoliciesAPI.PolicyReplaceResponse;
export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
- export import PolicyReplaceParams = PoliciesAPI.PolicyReplaceParams;
+ export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
}
diff --git a/src/resources/access/applications/index.ts b/src/resources/access/applications/index.ts
index b709cff48d..488b7c6a5e 100644
--- a/src/resources/access/applications/index.ts
+++ b/src/resources/access/applications/index.ts
@@ -2,24 +2,24 @@
export {
ApplicationCreateResponse,
+ ApplicationUpdateResponse,
ApplicationListResponse,
ApplicationDeleteResponse,
ApplicationGetResponse,
- ApplicationReplaceResponse,
ApplicationRevokeTokensResponse,
ApplicationCreateParams,
- ApplicationReplaceParams,
+ ApplicationUpdateParams,
Applications,
} from './applications';
export { CaCreateResponse, CaListResponse, CaDeleteResponse, CaGetResponse, Cas } from './cas';
export {
PolicyCreateResponse,
+ PolicyUpdateResponse,
PolicyListResponse,
PolicyDeleteResponse,
PolicyGetResponse,
- PolicyReplaceResponse,
PolicyCreateParams,
- PolicyReplaceParams,
+ PolicyUpdateParams,
Policies,
} from './policies';
export { UserPolicyCheckListResponse, UserPolicyChecks } from './user-policy-checks';
diff --git a/src/resources/access/applications/policies.ts b/src/resources/access/applications/policies.ts
index 9e52d0c6a9..44a3f90deb 100644
--- a/src/resources/access/applications/policies.ts
+++ b/src/resources/access/applications/policies.ts
@@ -23,6 +23,25 @@ export class Policies extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update a configured Access policy.
+ */
+ update(
+ accountOrZone: string,
+ accountOrZoneId: string,
+ uuid1: string,
+ uuid: string,
+ body: PolicyUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/apps/${uuid1}/policies/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: PolicyUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists Access policies configured for an application.
*/
@@ -75,25 +94,6 @@ export class Policies extends APIResource {
) as Core.APIPromise<{ result: PolicyGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Update a configured Access policy.
- */
- replace(
- accountOrZone: string,
- accountOrZoneId: string,
- uuid1: string,
- uuid: string,
- body: PolicyReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/apps/${uuid1}/policies/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: PolicyReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export interface PolicyCreateResponse {
@@ -1202,2230 +1202,2230 @@ export namespace PolicyCreateResponse {
}
}
-export type PolicyListResponse = Array;
+export interface PolicyUpdateResponse {
+ /**
+ * UUID
+ */
+ id?: string;
-export namespace PolicyListResponse {
- export interface PolicyListResponseItem {
- /**
- * UUID
- */
- id?: string;
+ /**
+ * Administrators who can approve a temporary authentication request.
+ */
+ approval_groups?: Array;
- /**
- * Administrators who can approve a temporary authentication request.
- */
- approval_groups?: Array;
+ /**
+ * Requires the user to request access from an administrator at the start of each
+ * session.
+ */
+ approval_required?: boolean;
- /**
- * Requires the user to request access from an administrator at the start of each
- * session.
- */
- approval_required?: boolean;
+ created_at?: string;
- created_at?: string;
+ /**
+ * The action Access will take if a user matches this policy.
+ */
+ decision?: 'allow' | 'deny' | 'non_identity' | 'bypass';
- /**
- * The action Access will take if a user matches this policy.
- */
- decision?: 'allow' | 'deny' | 'non_identity' | 'bypass';
+ /**
+ * Rules evaluated with a NOT logical operator. To match the policy, a user cannot
+ * meet any of the Exclude rules.
+ */
+ exclude?: Array<
+ | PolicyUpdateResponse.AccessEmailRule
+ | PolicyUpdateResponse.AccessEmailListRule
+ | PolicyUpdateResponse.AccessDomainRule
+ | PolicyUpdateResponse.AccessEveryoneRule
+ | PolicyUpdateResponse.AccessIPRule
+ | PolicyUpdateResponse.AccessIPListRule
+ | PolicyUpdateResponse.AccessCertificateRule
+ | PolicyUpdateResponse.AccessAccessGroupRule
+ | PolicyUpdateResponse.AccessAzureGroupRule
+ | PolicyUpdateResponse.AccessGitHubOrganizationRule
+ | PolicyUpdateResponse.AccessGsuiteGroupRule
+ | PolicyUpdateResponse.AccessOktaGroupRule
+ | PolicyUpdateResponse.AccessSamlGroupRule
+ | PolicyUpdateResponse.AccessServiceTokenRule
+ | PolicyUpdateResponse.AccessAnyValidServiceTokenRule
+ | PolicyUpdateResponse.AccessExternalEvaluationRule
+ | PolicyUpdateResponse.AccessCountryRule
+ | PolicyUpdateResponse.AccessAuthenticationMethodRule
+ | PolicyUpdateResponse.AccessDevicePostureRule
+ >;
- /**
- * Rules evaluated with a NOT logical operator. To match the policy, a user cannot
- * meet any of the Exclude rules.
- */
- exclude?: Array<
- | PolicyListResponseItem.AccessEmailRule
- | PolicyListResponseItem.AccessEmailListRule
- | PolicyListResponseItem.AccessDomainRule
- | PolicyListResponseItem.AccessEveryoneRule
- | PolicyListResponseItem.AccessIPRule
- | PolicyListResponseItem.AccessIPListRule
- | PolicyListResponseItem.AccessCertificateRule
- | PolicyListResponseItem.AccessAccessGroupRule
- | PolicyListResponseItem.AccessAzureGroupRule
- | PolicyListResponseItem.AccessGitHubOrganizationRule
- | PolicyListResponseItem.AccessGsuiteGroupRule
- | PolicyListResponseItem.AccessOktaGroupRule
- | PolicyListResponseItem.AccessSamlGroupRule
- | PolicyListResponseItem.AccessServiceTokenRule
- | PolicyListResponseItem.AccessAnyValidServiceTokenRule
- | PolicyListResponseItem.AccessExternalEvaluationRule
- | PolicyListResponseItem.AccessCountryRule
- | PolicyListResponseItem.AccessAuthenticationMethodRule
- | PolicyListResponseItem.AccessDevicePostureRule
- >;
+ /**
+ * Rules evaluated with an OR logical operator. A user needs to meet only one of
+ * the Include rules.
+ */
+ include?: Array<
+ | PolicyUpdateResponse.AccessEmailRule
+ | PolicyUpdateResponse.AccessEmailListRule
+ | PolicyUpdateResponse.AccessDomainRule
+ | PolicyUpdateResponse.AccessEveryoneRule
+ | PolicyUpdateResponse.AccessIPRule
+ | PolicyUpdateResponse.AccessIPListRule
+ | PolicyUpdateResponse.AccessCertificateRule
+ | PolicyUpdateResponse.AccessAccessGroupRule
+ | PolicyUpdateResponse.AccessAzureGroupRule
+ | PolicyUpdateResponse.AccessGitHubOrganizationRule
+ | PolicyUpdateResponse.AccessGsuiteGroupRule
+ | PolicyUpdateResponse.AccessOktaGroupRule
+ | PolicyUpdateResponse.AccessSamlGroupRule
+ | PolicyUpdateResponse.AccessServiceTokenRule
+ | PolicyUpdateResponse.AccessAnyValidServiceTokenRule
+ | PolicyUpdateResponse.AccessExternalEvaluationRule
+ | PolicyUpdateResponse.AccessCountryRule
+ | PolicyUpdateResponse.AccessAuthenticationMethodRule
+ | PolicyUpdateResponse.AccessDevicePostureRule
+ >;
- /**
- * Rules evaluated with an OR logical operator. A user needs to meet only one of
- * the Include rules.
- */
- include?: Array<
- | PolicyListResponseItem.AccessEmailRule
- | PolicyListResponseItem.AccessEmailListRule
- | PolicyListResponseItem.AccessDomainRule
- | PolicyListResponseItem.AccessEveryoneRule
- | PolicyListResponseItem.AccessIPRule
- | PolicyListResponseItem.AccessIPListRule
- | PolicyListResponseItem.AccessCertificateRule
- | PolicyListResponseItem.AccessAccessGroupRule
- | PolicyListResponseItem.AccessAzureGroupRule
- | PolicyListResponseItem.AccessGitHubOrganizationRule
- | PolicyListResponseItem.AccessGsuiteGroupRule
- | PolicyListResponseItem.AccessOktaGroupRule
- | PolicyListResponseItem.AccessSamlGroupRule
- | PolicyListResponseItem.AccessServiceTokenRule
- | PolicyListResponseItem.AccessAnyValidServiceTokenRule
- | PolicyListResponseItem.AccessExternalEvaluationRule
- | PolicyListResponseItem.AccessCountryRule
- | PolicyListResponseItem.AccessAuthenticationMethodRule
- | PolicyListResponseItem.AccessDevicePostureRule
- >;
+ /**
+ * Require this application to be served in an isolated browser for users matching
+ * this policy. 'Client Web Isolation' must be on for the account in order to use
+ * this feature.
+ */
+ isolation_required?: boolean;
- /**
- * Require this application to be served in an isolated browser for users matching
- * this policy. 'Client Web Isolation' must be on for the account in order to use
- * this feature.
- */
- isolation_required?: boolean;
+ /**
+ * The name of the Access policy.
+ */
+ name?: string;
- /**
- * The name of the Access policy.
- */
- name?: string;
+ /**
+ * The order of execution for this policy. Must be unique for each policy.
+ */
+ precedence?: number;
- /**
- * The order of execution for this policy. Must be unique for each policy.
- */
- precedence?: number;
+ /**
+ * A custom message that will appear on the purpose justification screen.
+ */
+ purpose_justification_prompt?: string;
- /**
- * A custom message that will appear on the purpose justification screen.
- */
- purpose_justification_prompt?: string;
+ /**
+ * Require users to enter a justification when they log in to the application.
+ */
+ purpose_justification_required?: boolean;
- /**
- * Require users to enter a justification when they log in to the application.
- */
- purpose_justification_required?: boolean;
+ /**
+ * Rules evaluated with an AND logical operator. To match the policy, a user must
+ * meet all of the Require rules.
+ */
+ require?: Array<
+ | PolicyUpdateResponse.AccessEmailRule
+ | PolicyUpdateResponse.AccessEmailListRule
+ | PolicyUpdateResponse.AccessDomainRule
+ | PolicyUpdateResponse.AccessEveryoneRule
+ | PolicyUpdateResponse.AccessIPRule
+ | PolicyUpdateResponse.AccessIPListRule
+ | PolicyUpdateResponse.AccessCertificateRule
+ | PolicyUpdateResponse.AccessAccessGroupRule
+ | PolicyUpdateResponse.AccessAzureGroupRule
+ | PolicyUpdateResponse.AccessGitHubOrganizationRule
+ | PolicyUpdateResponse.AccessGsuiteGroupRule
+ | PolicyUpdateResponse.AccessOktaGroupRule
+ | PolicyUpdateResponse.AccessSamlGroupRule
+ | PolicyUpdateResponse.AccessServiceTokenRule
+ | PolicyUpdateResponse.AccessAnyValidServiceTokenRule
+ | PolicyUpdateResponse.AccessExternalEvaluationRule
+ | PolicyUpdateResponse.AccessCountryRule
+ | PolicyUpdateResponse.AccessAuthenticationMethodRule
+ | PolicyUpdateResponse.AccessDevicePostureRule
+ >;
+
+ /**
+ * The amount of time that tokens issued for the application will be valid. Must be
+ * in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
+ * m, h.
+ */
+ session_duration?: string;
+
+ updated_at?: string;
+}
+export namespace PolicyUpdateResponse {
+ /**
+ * A group of email addresses that can approve a temporary authentication request.
+ */
+ export interface ApprovalGroup {
/**
- * Rules evaluated with an AND logical operator. To match the policy, a user must
- * meet all of the Require rules.
+ * The number of approvals needed to obtain access.
*/
- require?: Array<
- | PolicyListResponseItem.AccessEmailRule
- | PolicyListResponseItem.AccessEmailListRule
- | PolicyListResponseItem.AccessDomainRule
- | PolicyListResponseItem.AccessEveryoneRule
- | PolicyListResponseItem.AccessIPRule
- | PolicyListResponseItem.AccessIPListRule
- | PolicyListResponseItem.AccessCertificateRule
- | PolicyListResponseItem.AccessAccessGroupRule
- | PolicyListResponseItem.AccessAzureGroupRule
- | PolicyListResponseItem.AccessGitHubOrganizationRule
- | PolicyListResponseItem.AccessGsuiteGroupRule
- | PolicyListResponseItem.AccessOktaGroupRule
- | PolicyListResponseItem.AccessSamlGroupRule
- | PolicyListResponseItem.AccessServiceTokenRule
- | PolicyListResponseItem.AccessAnyValidServiceTokenRule
- | PolicyListResponseItem.AccessExternalEvaluationRule
- | PolicyListResponseItem.AccessCountryRule
- | PolicyListResponseItem.AccessAuthenticationMethodRule
- | PolicyListResponseItem.AccessDevicePostureRule
- >;
+ approvals_needed: number;
/**
- * The amount of time that tokens issued for the application will be valid. Must be
- * in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
- * m, h.
+ * A list of emails that can approve the access request.
*/
- session_duration?: string;
-
- updated_at?: string;
- }
+ email_addresses?: Array;
- export namespace PolicyListResponseItem {
/**
- * A group of email addresses that can approve a temporary authentication request.
+ * The UUID of an re-usable email list.
*/
- export interface ApprovalGroup {
- /**
- * The number of approvals needed to obtain access.
- */
- approvals_needed: number;
+ email_list_uuid?: string;
+ }
- /**
- * A list of emails that can approve the access request.
- */
- email_addresses?: Array;
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
+ export namespace AccessEmailRule {
+ export interface Email {
/**
- * The UUID of an re-usable email list.
+ * The email of the user.
*/
- email_list_uuid?: string;
+ email: string;
}
+ }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Match an entire email domain.
+ * An empty object which matches on all users.
*/
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ everyone: unknown;
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPRule {
+ export interface IP {
/**
- * An empty object which matches on all users.
+ * An IPv4 or IPv6 CIDR block.
*/
- everyone: unknown;
+ ip: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a specific Access Service Token
+ * An empty object which matches on all service tokens.
*/
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
- }
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
/**
- * An empty object which matches on all service tokens.
+ * The API endpoint containing your business logic.
*/
- any_valid_service_token: unknown;
- }
+ evaluate_url: string;
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
}
+ }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
}
+ }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
}
+ }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Match an entire email domain.
+ * An empty object which matches on all users.
*/
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ everyone: unknown;
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPRule {
+ export interface IP {
/**
- * An empty object which matches on all users.
+ * An IPv4 or IPv6 CIDR block.
*/
- everyone: unknown;
+ ip: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
-
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
- }
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
+
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a specific Access Service Token
+ * An empty object which matches on all service tokens.
*/
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
- }
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
/**
- * An empty object which matches on all service tokens.
+ * The API endpoint containing your business logic.
*/
- any_valid_service_token: unknown;
- }
+ evaluate_url: string;
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
}
+ }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
}
+ }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
}
+ }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
+
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
+
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Matches an email address from a list.
+ * An empty object which matches on all users.
*/
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ everyone: unknown;
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
}
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPListRule {
+ export interface IPList {
/**
- * An empty object which matches on all users.
+ * The ID of a previously created IP list.
*/
- everyone: unknown;
+ id: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
+
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a SAML group. Requires a SAML identity provider.
+ * An empty object which matches on all service tokens.
*/
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
- }
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ export namespace AccessCountryRule {
+ export interface Geo {
/**
- * An empty object which matches on all service tokens.
+ * The country code that should be matched.
*/
- any_valid_service_token: unknown;
+ country_code: string;
}
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
+
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
}
+ }
+}
+export type PolicyListResponse = Array;
+
+export namespace PolicyListResponse {
+ export interface PolicyListResponseItem {
/**
- * Matches a specific country
+ * UUID
*/
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ id?: string;
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
- }
+ /**
+ * Administrators who can approve a temporary authentication request.
+ */
+ approval_groups?: Array;
/**
- * Enforce different MFA options
+ * Requires the user to request access from an administrator at the start of each
+ * session.
*/
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ approval_required?: boolean;
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
- }
+ created_at?: string;
/**
- * Enforces a device posture rule has run successfully
+ * The action Access will take if a user matches this policy.
*/
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ decision?: 'allow' | 'deny' | 'non_identity' | 'bypass';
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
- }
- }
-}
+ /**
+ * Rules evaluated with a NOT logical operator. To match the policy, a user cannot
+ * meet any of the Exclude rules.
+ */
+ exclude?: Array<
+ | PolicyListResponseItem.AccessEmailRule
+ | PolicyListResponseItem.AccessEmailListRule
+ | PolicyListResponseItem.AccessDomainRule
+ | PolicyListResponseItem.AccessEveryoneRule
+ | PolicyListResponseItem.AccessIPRule
+ | PolicyListResponseItem.AccessIPListRule
+ | PolicyListResponseItem.AccessCertificateRule
+ | PolicyListResponseItem.AccessAccessGroupRule
+ | PolicyListResponseItem.AccessAzureGroupRule
+ | PolicyListResponseItem.AccessGitHubOrganizationRule
+ | PolicyListResponseItem.AccessGsuiteGroupRule
+ | PolicyListResponseItem.AccessOktaGroupRule
+ | PolicyListResponseItem.AccessSamlGroupRule
+ | PolicyListResponseItem.AccessServiceTokenRule
+ | PolicyListResponseItem.AccessAnyValidServiceTokenRule
+ | PolicyListResponseItem.AccessExternalEvaluationRule
+ | PolicyListResponseItem.AccessCountryRule
+ | PolicyListResponseItem.AccessAuthenticationMethodRule
+ | PolicyListResponseItem.AccessDevicePostureRule
+ >;
-export interface PolicyDeleteResponse {
- /**
- * UUID
- */
- id?: string;
-}
-
-export interface PolicyGetResponse {
- /**
- * UUID
- */
- id?: string;
-
- /**
- * Administrators who can approve a temporary authentication request.
- */
- approval_groups?: Array;
-
- /**
- * Requires the user to request access from an administrator at the start of each
- * session.
- */
- approval_required?: boolean;
-
- created_at?: string;
-
- /**
- * The action Access will take if a user matches this policy.
- */
- decision?: 'allow' | 'deny' | 'non_identity' | 'bypass';
-
- /**
- * Rules evaluated with a NOT logical operator. To match the policy, a user cannot
- * meet any of the Exclude rules.
- */
- exclude?: Array<
- | PolicyGetResponse.AccessEmailRule
- | PolicyGetResponse.AccessEmailListRule
- | PolicyGetResponse.AccessDomainRule
- | PolicyGetResponse.AccessEveryoneRule
- | PolicyGetResponse.AccessIPRule
- | PolicyGetResponse.AccessIPListRule
- | PolicyGetResponse.AccessCertificateRule
- | PolicyGetResponse.AccessAccessGroupRule
- | PolicyGetResponse.AccessAzureGroupRule
- | PolicyGetResponse.AccessGitHubOrganizationRule
- | PolicyGetResponse.AccessGsuiteGroupRule
- | PolicyGetResponse.AccessOktaGroupRule
- | PolicyGetResponse.AccessSamlGroupRule
- | PolicyGetResponse.AccessServiceTokenRule
- | PolicyGetResponse.AccessAnyValidServiceTokenRule
- | PolicyGetResponse.AccessExternalEvaluationRule
- | PolicyGetResponse.AccessCountryRule
- | PolicyGetResponse.AccessAuthenticationMethodRule
- | PolicyGetResponse.AccessDevicePostureRule
- >;
-
- /**
- * Rules evaluated with an OR logical operator. A user needs to meet only one of
- * the Include rules.
- */
- include?: Array<
- | PolicyGetResponse.AccessEmailRule
- | PolicyGetResponse.AccessEmailListRule
- | PolicyGetResponse.AccessDomainRule
- | PolicyGetResponse.AccessEveryoneRule
- | PolicyGetResponse.AccessIPRule
- | PolicyGetResponse.AccessIPListRule
- | PolicyGetResponse.AccessCertificateRule
- | PolicyGetResponse.AccessAccessGroupRule
- | PolicyGetResponse.AccessAzureGroupRule
- | PolicyGetResponse.AccessGitHubOrganizationRule
- | PolicyGetResponse.AccessGsuiteGroupRule
- | PolicyGetResponse.AccessOktaGroupRule
- | PolicyGetResponse.AccessSamlGroupRule
- | PolicyGetResponse.AccessServiceTokenRule
- | PolicyGetResponse.AccessAnyValidServiceTokenRule
- | PolicyGetResponse.AccessExternalEvaluationRule
- | PolicyGetResponse.AccessCountryRule
- | PolicyGetResponse.AccessAuthenticationMethodRule
- | PolicyGetResponse.AccessDevicePostureRule
- >;
-
- /**
- * Require this application to be served in an isolated browser for users matching
- * this policy. 'Client Web Isolation' must be on for the account in order to use
- * this feature.
- */
- isolation_required?: boolean;
-
- /**
- * The name of the Access policy.
- */
- name?: string;
-
- /**
- * The order of execution for this policy. Must be unique for each policy.
- */
- precedence?: number;
-
- /**
- * A custom message that will appear on the purpose justification screen.
- */
- purpose_justification_prompt?: string;
+ /**
+ * Rules evaluated with an OR logical operator. A user needs to meet only one of
+ * the Include rules.
+ */
+ include?: Array<
+ | PolicyListResponseItem.AccessEmailRule
+ | PolicyListResponseItem.AccessEmailListRule
+ | PolicyListResponseItem.AccessDomainRule
+ | PolicyListResponseItem.AccessEveryoneRule
+ | PolicyListResponseItem.AccessIPRule
+ | PolicyListResponseItem.AccessIPListRule
+ | PolicyListResponseItem.AccessCertificateRule
+ | PolicyListResponseItem.AccessAccessGroupRule
+ | PolicyListResponseItem.AccessAzureGroupRule
+ | PolicyListResponseItem.AccessGitHubOrganizationRule
+ | PolicyListResponseItem.AccessGsuiteGroupRule
+ | PolicyListResponseItem.AccessOktaGroupRule
+ | PolicyListResponseItem.AccessSamlGroupRule
+ | PolicyListResponseItem.AccessServiceTokenRule
+ | PolicyListResponseItem.AccessAnyValidServiceTokenRule
+ | PolicyListResponseItem.AccessExternalEvaluationRule
+ | PolicyListResponseItem.AccessCountryRule
+ | PolicyListResponseItem.AccessAuthenticationMethodRule
+ | PolicyListResponseItem.AccessDevicePostureRule
+ >;
- /**
- * Require users to enter a justification when they log in to the application.
- */
- purpose_justification_required?: boolean;
+ /**
+ * Require this application to be served in an isolated browser for users matching
+ * this policy. 'Client Web Isolation' must be on for the account in order to use
+ * this feature.
+ */
+ isolation_required?: boolean;
- /**
- * Rules evaluated with an AND logical operator. To match the policy, a user must
- * meet all of the Require rules.
- */
- require?: Array<
- | PolicyGetResponse.AccessEmailRule
- | PolicyGetResponse.AccessEmailListRule
- | PolicyGetResponse.AccessDomainRule
- | PolicyGetResponse.AccessEveryoneRule
- | PolicyGetResponse.AccessIPRule
- | PolicyGetResponse.AccessIPListRule
- | PolicyGetResponse.AccessCertificateRule
- | PolicyGetResponse.AccessAccessGroupRule
- | PolicyGetResponse.AccessAzureGroupRule
- | PolicyGetResponse.AccessGitHubOrganizationRule
- | PolicyGetResponse.AccessGsuiteGroupRule
- | PolicyGetResponse.AccessOktaGroupRule
- | PolicyGetResponse.AccessSamlGroupRule
- | PolicyGetResponse.AccessServiceTokenRule
- | PolicyGetResponse.AccessAnyValidServiceTokenRule
- | PolicyGetResponse.AccessExternalEvaluationRule
- | PolicyGetResponse.AccessCountryRule
- | PolicyGetResponse.AccessAuthenticationMethodRule
- | PolicyGetResponse.AccessDevicePostureRule
- >;
+ /**
+ * The name of the Access policy.
+ */
+ name?: string;
- /**
- * The amount of time that tokens issued for the application will be valid. Must be
- * in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
- * m, h.
- */
- session_duration?: string;
+ /**
+ * The order of execution for this policy. Must be unique for each policy.
+ */
+ precedence?: number;
- updated_at?: string;
-}
+ /**
+ * A custom message that will appear on the purpose justification screen.
+ */
+ purpose_justification_prompt?: string;
-export namespace PolicyGetResponse {
- /**
- * A group of email addresses that can approve a temporary authentication request.
- */
- export interface ApprovalGroup {
/**
- * The number of approvals needed to obtain access.
+ * Require users to enter a justification when they log in to the application.
*/
- approvals_needed: number;
+ purpose_justification_required?: boolean;
/**
- * A list of emails that can approve the access request.
+ * Rules evaluated with an AND logical operator. To match the policy, a user must
+ * meet all of the Require rules.
*/
- email_addresses?: Array;
+ require?: Array<
+ | PolicyListResponseItem.AccessEmailRule
+ | PolicyListResponseItem.AccessEmailListRule
+ | PolicyListResponseItem.AccessDomainRule
+ | PolicyListResponseItem.AccessEveryoneRule
+ | PolicyListResponseItem.AccessIPRule
+ | PolicyListResponseItem.AccessIPListRule
+ | PolicyListResponseItem.AccessCertificateRule
+ | PolicyListResponseItem.AccessAccessGroupRule
+ | PolicyListResponseItem.AccessAzureGroupRule
+ | PolicyListResponseItem.AccessGitHubOrganizationRule
+ | PolicyListResponseItem.AccessGsuiteGroupRule
+ | PolicyListResponseItem.AccessOktaGroupRule
+ | PolicyListResponseItem.AccessSamlGroupRule
+ | PolicyListResponseItem.AccessServiceTokenRule
+ | PolicyListResponseItem.AccessAnyValidServiceTokenRule
+ | PolicyListResponseItem.AccessExternalEvaluationRule
+ | PolicyListResponseItem.AccessCountryRule
+ | PolicyListResponseItem.AccessAuthenticationMethodRule
+ | PolicyListResponseItem.AccessDevicePostureRule
+ >;
/**
- * The UUID of an re-usable email list.
+ * The amount of time that tokens issued for the application will be valid. Must be
+ * in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
+ * m, h.
*/
- email_list_uuid?: string;
- }
+ session_duration?: string;
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
+ updated_at?: string;
}
- export namespace AccessEmailRule {
- export interface Email {
+ export namespace PolicyListResponseItem {
+ /**
+ * A group of email addresses that can approve a temporary authentication request.
+ */
+ export interface ApprovalGroup {
/**
- * The email of the user.
+ * The number of approvals needed to obtain access.
*/
- email: string;
+ approvals_needed: number;
+
+ /**
+ * A list of emails that can approve the access request.
+ */
+ email_addresses?: Array;
+
+ /**
+ * The UUID of an re-usable email list.
+ */
+ email_list_uuid?: string;
+ }
+
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
+
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
+ }
+ }
+
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
}
- }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The ID of a Service Token.
+ * An empty object which matches on all service tokens.
*/
- token_id: string;
+ any_valid_service_token: unknown;
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
*/
- any_valid_service_token: unknown;
- }
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
}
- }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
+ }
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
}
- }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The ID of a Service Token.
+ * An empty object which matches on all service tokens.
*/
- token_id: string;
+ any_valid_service_token: unknown;
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
*/
- any_valid_service_token: unknown;
- }
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
}
- }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
+ }
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
}
- }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The ID of a Service Token.
+ * An empty object which matches on all service tokens.
*/
- token_id: string;
+ any_valid_service_token: unknown;
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
*/
- any_valid_service_token: unknown;
- }
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
+
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
}
}
+}
+export interface PolicyDeleteResponse {
/**
- * Enforces a device posture rule has run successfully
+ * UUID
*/
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
-
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
- }
+ id?: string;
}
-export interface PolicyReplaceResponse {
+export interface PolicyGetResponse {
/**
* UUID
*/
@@ -3434,7 +3434,7 @@ export interface PolicyReplaceResponse {
/**
* Administrators who can approve a temporary authentication request.
*/
- approval_groups?: Array;
+ approval_groups?: Array;
/**
* Requires the user to request access from an administrator at the start of each
@@ -3454,25 +3454,25 @@ export interface PolicyReplaceResponse {
* meet any of the Exclude rules.
*/
exclude?: Array<
- | PolicyReplaceResponse.AccessEmailRule
- | PolicyReplaceResponse.AccessEmailListRule
- | PolicyReplaceResponse.AccessDomainRule
- | PolicyReplaceResponse.AccessEveryoneRule
- | PolicyReplaceResponse.AccessIPRule
- | PolicyReplaceResponse.AccessIPListRule
- | PolicyReplaceResponse.AccessCertificateRule
- | PolicyReplaceResponse.AccessAccessGroupRule
- | PolicyReplaceResponse.AccessAzureGroupRule
- | PolicyReplaceResponse.AccessGitHubOrganizationRule
- | PolicyReplaceResponse.AccessGsuiteGroupRule
- | PolicyReplaceResponse.AccessOktaGroupRule
- | PolicyReplaceResponse.AccessSamlGroupRule
- | PolicyReplaceResponse.AccessServiceTokenRule
- | PolicyReplaceResponse.AccessAnyValidServiceTokenRule
- | PolicyReplaceResponse.AccessExternalEvaluationRule
- | PolicyReplaceResponse.AccessCountryRule
- | PolicyReplaceResponse.AccessAuthenticationMethodRule
- | PolicyReplaceResponse.AccessDevicePostureRule
+ | PolicyGetResponse.AccessEmailRule
+ | PolicyGetResponse.AccessEmailListRule
+ | PolicyGetResponse.AccessDomainRule
+ | PolicyGetResponse.AccessEveryoneRule
+ | PolicyGetResponse.AccessIPRule
+ | PolicyGetResponse.AccessIPListRule
+ | PolicyGetResponse.AccessCertificateRule
+ | PolicyGetResponse.AccessAccessGroupRule
+ | PolicyGetResponse.AccessAzureGroupRule
+ | PolicyGetResponse.AccessGitHubOrganizationRule
+ | PolicyGetResponse.AccessGsuiteGroupRule
+ | PolicyGetResponse.AccessOktaGroupRule
+ | PolicyGetResponse.AccessSamlGroupRule
+ | PolicyGetResponse.AccessServiceTokenRule
+ | PolicyGetResponse.AccessAnyValidServiceTokenRule
+ | PolicyGetResponse.AccessExternalEvaluationRule
+ | PolicyGetResponse.AccessCountryRule
+ | PolicyGetResponse.AccessAuthenticationMethodRule
+ | PolicyGetResponse.AccessDevicePostureRule
>;
/**
@@ -3480,25 +3480,25 @@ export interface PolicyReplaceResponse {
* the Include rules.
*/
include?: Array<
- | PolicyReplaceResponse.AccessEmailRule
- | PolicyReplaceResponse.AccessEmailListRule
- | PolicyReplaceResponse.AccessDomainRule
- | PolicyReplaceResponse.AccessEveryoneRule
- | PolicyReplaceResponse.AccessIPRule
- | PolicyReplaceResponse.AccessIPListRule
- | PolicyReplaceResponse.AccessCertificateRule
- | PolicyReplaceResponse.AccessAccessGroupRule
- | PolicyReplaceResponse.AccessAzureGroupRule
- | PolicyReplaceResponse.AccessGitHubOrganizationRule
- | PolicyReplaceResponse.AccessGsuiteGroupRule
- | PolicyReplaceResponse.AccessOktaGroupRule
- | PolicyReplaceResponse.AccessSamlGroupRule
- | PolicyReplaceResponse.AccessServiceTokenRule
- | PolicyReplaceResponse.AccessAnyValidServiceTokenRule
- | PolicyReplaceResponse.AccessExternalEvaluationRule
- | PolicyReplaceResponse.AccessCountryRule
- | PolicyReplaceResponse.AccessAuthenticationMethodRule
- | PolicyReplaceResponse.AccessDevicePostureRule
+ | PolicyGetResponse.AccessEmailRule
+ | PolicyGetResponse.AccessEmailListRule
+ | PolicyGetResponse.AccessDomainRule
+ | PolicyGetResponse.AccessEveryoneRule
+ | PolicyGetResponse.AccessIPRule
+ | PolicyGetResponse.AccessIPListRule
+ | PolicyGetResponse.AccessCertificateRule
+ | PolicyGetResponse.AccessAccessGroupRule
+ | PolicyGetResponse.AccessAzureGroupRule
+ | PolicyGetResponse.AccessGitHubOrganizationRule
+ | PolicyGetResponse.AccessGsuiteGroupRule
+ | PolicyGetResponse.AccessOktaGroupRule
+ | PolicyGetResponse.AccessSamlGroupRule
+ | PolicyGetResponse.AccessServiceTokenRule
+ | PolicyGetResponse.AccessAnyValidServiceTokenRule
+ | PolicyGetResponse.AccessExternalEvaluationRule
+ | PolicyGetResponse.AccessCountryRule
+ | PolicyGetResponse.AccessAuthenticationMethodRule
+ | PolicyGetResponse.AccessDevicePostureRule
>;
/**
@@ -3533,25 +3533,25 @@ export interface PolicyReplaceResponse {
* meet all of the Require rules.
*/
require?: Array<
- | PolicyReplaceResponse.AccessEmailRule
- | PolicyReplaceResponse.AccessEmailListRule
- | PolicyReplaceResponse.AccessDomainRule
- | PolicyReplaceResponse.AccessEveryoneRule
- | PolicyReplaceResponse.AccessIPRule
- | PolicyReplaceResponse.AccessIPListRule
- | PolicyReplaceResponse.AccessCertificateRule
- | PolicyReplaceResponse.AccessAccessGroupRule
- | PolicyReplaceResponse.AccessAzureGroupRule
- | PolicyReplaceResponse.AccessGitHubOrganizationRule
- | PolicyReplaceResponse.AccessGsuiteGroupRule
- | PolicyReplaceResponse.AccessOktaGroupRule
- | PolicyReplaceResponse.AccessSamlGroupRule
- | PolicyReplaceResponse.AccessServiceTokenRule
- | PolicyReplaceResponse.AccessAnyValidServiceTokenRule
- | PolicyReplaceResponse.AccessExternalEvaluationRule
- | PolicyReplaceResponse.AccessCountryRule
- | PolicyReplaceResponse.AccessAuthenticationMethodRule
- | PolicyReplaceResponse.AccessDevicePostureRule
+ | PolicyGetResponse.AccessEmailRule
+ | PolicyGetResponse.AccessEmailListRule
+ | PolicyGetResponse.AccessDomainRule
+ | PolicyGetResponse.AccessEveryoneRule
+ | PolicyGetResponse.AccessIPRule
+ | PolicyGetResponse.AccessIPListRule
+ | PolicyGetResponse.AccessCertificateRule
+ | PolicyGetResponse.AccessAccessGroupRule
+ | PolicyGetResponse.AccessAzureGroupRule
+ | PolicyGetResponse.AccessGitHubOrganizationRule
+ | PolicyGetResponse.AccessGsuiteGroupRule
+ | PolicyGetResponse.AccessOktaGroupRule
+ | PolicyGetResponse.AccessSamlGroupRule
+ | PolicyGetResponse.AccessServiceTokenRule
+ | PolicyGetResponse.AccessAnyValidServiceTokenRule
+ | PolicyGetResponse.AccessExternalEvaluationRule
+ | PolicyGetResponse.AccessCountryRule
+ | PolicyGetResponse.AccessAuthenticationMethodRule
+ | PolicyGetResponse.AccessDevicePostureRule
>;
/**
@@ -3564,7 +3564,7 @@ export interface PolicyReplaceResponse {
updated_at?: string;
}
-export namespace PolicyReplaceResponse {
+export namespace PolicyGetResponse {
/**
* A group of email addresses that can approve a temporary authentication request.
*/
@@ -5628,7 +5628,7 @@ export namespace PolicyCreateParams {
}
}
-export interface PolicyReplaceParams {
+export interface PolicyUpdateParams {
/**
* The action Access will take if a user matches this policy.
*/
@@ -5639,25 +5639,25 @@ export interface PolicyReplaceParams {
* the Include rules.
*/
include: Array<
- | PolicyReplaceParams.AccessEmailRule
- | PolicyReplaceParams.AccessEmailListRule
- | PolicyReplaceParams.AccessDomainRule
- | PolicyReplaceParams.AccessEveryoneRule
- | PolicyReplaceParams.AccessIPRule
- | PolicyReplaceParams.AccessIPListRule
- | PolicyReplaceParams.AccessCertificateRule
- | PolicyReplaceParams.AccessAccessGroupRule
- | PolicyReplaceParams.AccessAzureGroupRule
- | PolicyReplaceParams.AccessGitHubOrganizationRule
- | PolicyReplaceParams.AccessGsuiteGroupRule
- | PolicyReplaceParams.AccessOktaGroupRule
- | PolicyReplaceParams.AccessSamlGroupRule
- | PolicyReplaceParams.AccessServiceTokenRule
- | PolicyReplaceParams.AccessAnyValidServiceTokenRule
- | PolicyReplaceParams.AccessExternalEvaluationRule
- | PolicyReplaceParams.AccessCountryRule
- | PolicyReplaceParams.AccessAuthenticationMethodRule
- | PolicyReplaceParams.AccessDevicePostureRule
+ | PolicyUpdateParams.AccessEmailRule
+ | PolicyUpdateParams.AccessEmailListRule
+ | PolicyUpdateParams.AccessDomainRule
+ | PolicyUpdateParams.AccessEveryoneRule
+ | PolicyUpdateParams.AccessIPRule
+ | PolicyUpdateParams.AccessIPListRule
+ | PolicyUpdateParams.AccessCertificateRule
+ | PolicyUpdateParams.AccessAccessGroupRule
+ | PolicyUpdateParams.AccessAzureGroupRule
+ | PolicyUpdateParams.AccessGitHubOrganizationRule
+ | PolicyUpdateParams.AccessGsuiteGroupRule
+ | PolicyUpdateParams.AccessOktaGroupRule
+ | PolicyUpdateParams.AccessSamlGroupRule
+ | PolicyUpdateParams.AccessServiceTokenRule
+ | PolicyUpdateParams.AccessAnyValidServiceTokenRule
+ | PolicyUpdateParams.AccessExternalEvaluationRule
+ | PolicyUpdateParams.AccessCountryRule
+ | PolicyUpdateParams.AccessAuthenticationMethodRule
+ | PolicyUpdateParams.AccessDevicePostureRule
>;
/**
@@ -5668,7 +5668,7 @@ export interface PolicyReplaceParams {
/**
* Administrators who can approve a temporary authentication request.
*/
- approval_groups?: Array;
+ approval_groups?: Array;
/**
* Requires the user to request access from an administrator at the start of each
@@ -5681,25 +5681,25 @@ export interface PolicyReplaceParams {
* meet any of the Exclude rules.
*/
exclude?: Array<
- | PolicyReplaceParams.AccessEmailRule
- | PolicyReplaceParams.AccessEmailListRule
- | PolicyReplaceParams.AccessDomainRule
- | PolicyReplaceParams.AccessEveryoneRule
- | PolicyReplaceParams.AccessIPRule
- | PolicyReplaceParams.AccessIPListRule
- | PolicyReplaceParams.AccessCertificateRule
- | PolicyReplaceParams.AccessAccessGroupRule
- | PolicyReplaceParams.AccessAzureGroupRule
- | PolicyReplaceParams.AccessGitHubOrganizationRule
- | PolicyReplaceParams.AccessGsuiteGroupRule
- | PolicyReplaceParams.AccessOktaGroupRule
- | PolicyReplaceParams.AccessSamlGroupRule
- | PolicyReplaceParams.AccessServiceTokenRule
- | PolicyReplaceParams.AccessAnyValidServiceTokenRule
- | PolicyReplaceParams.AccessExternalEvaluationRule
- | PolicyReplaceParams.AccessCountryRule
- | PolicyReplaceParams.AccessAuthenticationMethodRule
- | PolicyReplaceParams.AccessDevicePostureRule
+ | PolicyUpdateParams.AccessEmailRule
+ | PolicyUpdateParams.AccessEmailListRule
+ | PolicyUpdateParams.AccessDomainRule
+ | PolicyUpdateParams.AccessEveryoneRule
+ | PolicyUpdateParams.AccessIPRule
+ | PolicyUpdateParams.AccessIPListRule
+ | PolicyUpdateParams.AccessCertificateRule
+ | PolicyUpdateParams.AccessAccessGroupRule
+ | PolicyUpdateParams.AccessAzureGroupRule
+ | PolicyUpdateParams.AccessGitHubOrganizationRule
+ | PolicyUpdateParams.AccessGsuiteGroupRule
+ | PolicyUpdateParams.AccessOktaGroupRule
+ | PolicyUpdateParams.AccessSamlGroupRule
+ | PolicyUpdateParams.AccessServiceTokenRule
+ | PolicyUpdateParams.AccessAnyValidServiceTokenRule
+ | PolicyUpdateParams.AccessExternalEvaluationRule
+ | PolicyUpdateParams.AccessCountryRule
+ | PolicyUpdateParams.AccessAuthenticationMethodRule
+ | PolicyUpdateParams.AccessDevicePostureRule
>;
/**
@@ -5729,25 +5729,25 @@ export interface PolicyReplaceParams {
* meet all of the Require rules.
*/
require?: Array<
- | PolicyReplaceParams.AccessEmailRule
- | PolicyReplaceParams.AccessEmailListRule
- | PolicyReplaceParams.AccessDomainRule
- | PolicyReplaceParams.AccessEveryoneRule
- | PolicyReplaceParams.AccessIPRule
- | PolicyReplaceParams.AccessIPListRule
- | PolicyReplaceParams.AccessCertificateRule
- | PolicyReplaceParams.AccessAccessGroupRule
- | PolicyReplaceParams.AccessAzureGroupRule
- | PolicyReplaceParams.AccessGitHubOrganizationRule
- | PolicyReplaceParams.AccessGsuiteGroupRule
- | PolicyReplaceParams.AccessOktaGroupRule
- | PolicyReplaceParams.AccessSamlGroupRule
- | PolicyReplaceParams.AccessServiceTokenRule
- | PolicyReplaceParams.AccessAnyValidServiceTokenRule
- | PolicyReplaceParams.AccessExternalEvaluationRule
- | PolicyReplaceParams.AccessCountryRule
- | PolicyReplaceParams.AccessAuthenticationMethodRule
- | PolicyReplaceParams.AccessDevicePostureRule
+ | PolicyUpdateParams.AccessEmailRule
+ | PolicyUpdateParams.AccessEmailListRule
+ | PolicyUpdateParams.AccessDomainRule
+ | PolicyUpdateParams.AccessEveryoneRule
+ | PolicyUpdateParams.AccessIPRule
+ | PolicyUpdateParams.AccessIPListRule
+ | PolicyUpdateParams.AccessCertificateRule
+ | PolicyUpdateParams.AccessAccessGroupRule
+ | PolicyUpdateParams.AccessAzureGroupRule
+ | PolicyUpdateParams.AccessGitHubOrganizationRule
+ | PolicyUpdateParams.AccessGsuiteGroupRule
+ | PolicyUpdateParams.AccessOktaGroupRule
+ | PolicyUpdateParams.AccessSamlGroupRule
+ | PolicyUpdateParams.AccessServiceTokenRule
+ | PolicyUpdateParams.AccessAnyValidServiceTokenRule
+ | PolicyUpdateParams.AccessExternalEvaluationRule
+ | PolicyUpdateParams.AccessCountryRule
+ | PolicyUpdateParams.AccessAuthenticationMethodRule
+ | PolicyUpdateParams.AccessDevicePostureRule
>;
/**
@@ -5758,7 +5758,7 @@ export interface PolicyReplaceParams {
session_duration?: string;
}
-export namespace PolicyReplaceParams {
+export namespace PolicyUpdateParams {
/**
* Matches a specific email.
*/
@@ -6727,10 +6727,10 @@ export namespace PolicyReplaceParams {
export namespace Policies {
export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
+ export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
- export import PolicyReplaceResponse = PoliciesAPI.PolicyReplaceResponse;
export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
- export import PolicyReplaceParams = PoliciesAPI.PolicyReplaceParams;
+ export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
}
diff --git a/src/resources/access/bookmarks.ts b/src/resources/access/bookmarks.ts
index 4549f46b94..aca8000bbf 100644
--- a/src/resources/access/bookmarks.ts
+++ b/src/resources/access/bookmarks.ts
@@ -5,6 +5,21 @@ import { APIResource } from 'cloudflare/resource';
import * as BookmarksAPI from 'cloudflare/resources/access/bookmarks';
export class Bookmarks extends APIResource {
+ /**
+ * Updates a configured Bookmark application.
+ */
+ update(
+ identifier: unknown,
+ uuid: string,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${identifier}/access/bookmarks/${uuid}`, options) as Core.APIPromise<{
+ result: BookmarkUpdateResponse;
+ }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists Bookmark applications.
*/
@@ -45,21 +60,37 @@ export class Bookmarks extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface BookmarkUpdateResponse {
/**
- * Updates a configured Bookmark application.
+ * The unique identifier for the Bookmark application.
*/
- replace(
- identifier: unknown,
- uuid: string,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${identifier}/access/bookmarks/${uuid}`, options) as Core.APIPromise<{
- result: BookmarkReplaceResponse;
- }>
- )._thenUnwrap((obj) => obj.result);
- }
+ id?: unknown;
+
+ /**
+ * Displays the application in the App Launcher.
+ */
+ app_launcher_visible?: boolean;
+
+ created_at?: string;
+
+ /**
+ * The domain of the Bookmark application.
+ */
+ domain?: string;
+
+ /**
+ * The image URL for the logo shown in the App Launcher dashboard.
+ */
+ logo_url?: string;
+
+ /**
+ * The name of the Bookmark application.
+ */
+ name?: string;
+
+ updated_at?: string;
}
export type BookmarkListResponse = Array;
@@ -135,40 +166,9 @@ export interface BookmarkGetResponse {
updated_at?: string;
}
-export interface BookmarkReplaceResponse {
- /**
- * The unique identifier for the Bookmark application.
- */
- id?: unknown;
-
- /**
- * Displays the application in the App Launcher.
- */
- app_launcher_visible?: boolean;
-
- created_at?: string;
-
- /**
- * The domain of the Bookmark application.
- */
- domain?: string;
-
- /**
- * The image URL for the logo shown in the App Launcher dashboard.
- */
- logo_url?: string;
-
- /**
- * The name of the Bookmark application.
- */
- name?: string;
-
- updated_at?: string;
-}
-
export namespace Bookmarks {
+ export import BookmarkUpdateResponse = BookmarksAPI.BookmarkUpdateResponse;
export import BookmarkListResponse = BookmarksAPI.BookmarkListResponse;
export import BookmarkDeleteResponse = BookmarksAPI.BookmarkDeleteResponse;
export import BookmarkGetResponse = BookmarksAPI.BookmarkGetResponse;
- export import BookmarkReplaceResponse = BookmarksAPI.BookmarkReplaceResponse;
}
diff --git a/src/resources/access/certificates/certificates.ts b/src/resources/access/certificates/certificates.ts
index 0717dedbcd..908adf479b 100644
--- a/src/resources/access/certificates/certificates.ts
+++ b/src/resources/access/certificates/certificates.ts
@@ -25,6 +25,24 @@ export class Certificates extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a configured mTLS certificate.
+ */
+ update(
+ accountOrZone: string,
+ accountOrZoneId: string,
+ uuid: string,
+ body: CertificateUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/certificates/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: CertificateUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all mTLS root certificates.
*/
@@ -74,27 +92,37 @@ export class Certificates extends APIResource {
) as Core.APIPromise<{ result: CertificateGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface CertificateCreateResponse {
/**
- * Updates a configured mTLS certificate.
+ * The ID of the application that will use this certificate.
*/
- replace(
- accountOrZone: string,
- accountOrZoneId: string,
- uuid: string,
- body: CertificateReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/certificates/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: CertificateReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
+ id?: unknown;
+
+ /**
+ * The hostnames of the applications that will use this certificate.
+ */
+ associated_hostnames?: Array;
+
+ created_at?: string;
+
+ expires_on?: string;
+
+ /**
+ * The MD5 fingerprint of the certificate.
+ */
+ fingerprint?: string;
+
+ /**
+ * The name of the certificate.
+ */
+ name?: string;
+
+ updated_at?: string;
}
-export interface CertificateCreateResponse {
+export interface CertificateUpdateResponse {
/**
* The ID of the application that will use this certificate.
*/
@@ -189,34 +217,6 @@ export interface CertificateGetResponse {
updated_at?: string;
}
-export interface CertificateReplaceResponse {
- /**
- * The ID of the application that will use this certificate.
- */
- id?: unknown;
-
- /**
- * The hostnames of the applications that will use this certificate.
- */
- associated_hostnames?: Array;
-
- created_at?: string;
-
- expires_on?: string;
-
- /**
- * The MD5 fingerprint of the certificate.
- */
- fingerprint?: string;
-
- /**
- * The name of the certificate.
- */
- name?: string;
-
- updated_at?: string;
-}
-
export interface CertificateCreateParams {
/**
* The certificate content.
@@ -234,7 +234,7 @@ export interface CertificateCreateParams {
associated_hostnames?: Array;
}
-export interface CertificateReplaceParams {
+export interface CertificateUpdateParams {
/**
* The hostnames of the applications that will use this certificate.
*/
@@ -248,14 +248,14 @@ export interface CertificateReplaceParams {
export namespace Certificates {
export import CertificateCreateResponse = CertificatesAPI.CertificateCreateResponse;
+ export import CertificateUpdateResponse = CertificatesAPI.CertificateUpdateResponse;
export import CertificateListResponse = CertificatesAPI.CertificateListResponse;
export import CertificateDeleteResponse = CertificatesAPI.CertificateDeleteResponse;
export import CertificateGetResponse = CertificatesAPI.CertificateGetResponse;
- export import CertificateReplaceResponse = CertificatesAPI.CertificateReplaceResponse;
export import CertificateCreateParams = CertificatesAPI.CertificateCreateParams;
- export import CertificateReplaceParams = CertificatesAPI.CertificateReplaceParams;
+ export import CertificateUpdateParams = CertificatesAPI.CertificateUpdateParams;
export import Settings = SettingsAPI.Settings;
+ export import SettingUpdateResponse = SettingsAPI.SettingUpdateResponse;
export import SettingListResponse = SettingsAPI.SettingListResponse;
- export import SettingReplaceResponse = SettingsAPI.SettingReplaceResponse;
- export import SettingReplaceParams = SettingsAPI.SettingReplaceParams;
+ export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
}
diff --git a/src/resources/access/certificates/index.ts b/src/resources/access/certificates/index.ts
index 9baee4c5b9..e381ae5ffe 100644
--- a/src/resources/access/certificates/index.ts
+++ b/src/resources/access/certificates/index.ts
@@ -2,12 +2,12 @@
export {
CertificateCreateResponse,
+ CertificateUpdateResponse,
CertificateListResponse,
CertificateDeleteResponse,
CertificateGetResponse,
- CertificateReplaceResponse,
CertificateCreateParams,
- CertificateReplaceParams,
+ CertificateUpdateParams,
Certificates,
} from './certificates';
-export { SettingListResponse, SettingReplaceResponse, SettingReplaceParams, Settings } from './settings';
+export { SettingUpdateResponse, SettingListResponse, SettingUpdateParams, Settings } from './settings';
diff --git a/src/resources/access/certificates/settings.ts b/src/resources/access/certificates/settings.ts
index 058a9c0a19..6c95df02c1 100644
--- a/src/resources/access/certificates/settings.ts
+++ b/src/resources/access/certificates/settings.ts
@@ -6,43 +6,43 @@ import * as SettingsAPI from 'cloudflare/resources/access/certificates/settings'
export class Settings extends APIResource {
/**
- * List all mTLS hostname settings for this account or zone.
+ * Updates an mTLS certificate's hostname settings.
*/
- list(
+ update(
accountOrZone: string,
accountOrZoneId: string,
+ body: SettingUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.get(
- `/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`,
- options,
- ) as Core.APIPromise<{ result: SettingListResponse | null }>
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: SettingUpdateResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Updates an mTLS certificate's hostname settings.
+ * List all mTLS hostname settings for this account or zone.
*/
- replace(
+ list(
accountOrZone: string,
accountOrZoneId: string,
- body: SettingReplaceParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: SettingReplaceResponse | null }>
+ this._client.get(
+ `/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`,
+ options,
+ ) as Core.APIPromise<{ result: SettingListResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type SettingListResponse = Array;
+export type SettingUpdateResponse = Array;
-export namespace SettingListResponse {
- export interface SettingListResponseItem {
+export namespace SettingUpdateResponse {
+ export interface SettingUpdateResponseItem {
/**
* Request client certificates for this hostname in China. Can only be set to true
* if this zone is china network enabled.
@@ -63,10 +63,10 @@ export namespace SettingListResponse {
}
}
-export type SettingReplaceResponse = Array;
+export type SettingListResponse = Array;
-export namespace SettingReplaceResponse {
- export interface SettingReplaceResponseItem {
+export namespace SettingListResponse {
+ export interface SettingListResponseItem {
/**
* Request client certificates for this hostname in China. Can only be set to true
* if this zone is china network enabled.
@@ -87,11 +87,11 @@ export namespace SettingReplaceResponse {
}
}
-export interface SettingReplaceParams {
- settings: Array;
+export interface SettingUpdateParams {
+ settings: Array;
}
-export namespace SettingReplaceParams {
+export namespace SettingUpdateParams {
export interface Setting {
/**
* Request client certificates for this hostname in China. Can only be set to true
@@ -114,7 +114,7 @@ export namespace SettingReplaceParams {
}
export namespace Settings {
+ export import SettingUpdateResponse = SettingsAPI.SettingUpdateResponse;
export import SettingListResponse = SettingsAPI.SettingListResponse;
- export import SettingReplaceResponse = SettingsAPI.SettingReplaceResponse;
- export import SettingReplaceParams = SettingsAPI.SettingReplaceParams;
+ export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
}
diff --git a/src/resources/access/custom-pages.ts b/src/resources/access/custom-pages.ts
index 671ec659b5..8eb09c4033 100644
--- a/src/resources/access/custom-pages.ts
+++ b/src/resources/access/custom-pages.ts
@@ -21,6 +21,23 @@ export class CustomPages extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update a custom page
+ */
+ update(
+ identifier: string,
+ uuid: string,
+ body: CustomPageUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${identifier}/access/custom_pages/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: CustomPageUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* List custom pages
*/
@@ -61,26 +78,35 @@ export class CustomPages extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface CustomPageCreateResponse {
/**
- * Update a custom page
+ * Custom page name.
*/
- replace(
- identifier: string,
- uuid: string,
- body: CustomPageReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${identifier}/access/custom_pages/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: CustomPageReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
+ name: string;
+
+ /**
+ * Custom page type.
+ */
+ type: 'identity_denied' | 'forbidden';
+
+ /**
+ * Number of apps the custom page is assigned to.
+ */
+ app_count?: number;
+
+ created_at?: string;
+
+ /**
+ * UUID
+ */
+ uid?: string;
+
+ updated_at?: string;
}
-export interface CustomPageCreateResponse {
+export interface CustomPageUpdateResponse {
/**
* Custom page name.
*/
@@ -174,32 +200,6 @@ export interface CustomPageGetResponse {
updated_at?: string;
}
-export interface CustomPageReplaceResponse {
- /**
- * Custom page name.
- */
- name: string;
-
- /**
- * Custom page type.
- */
- type: 'identity_denied' | 'forbidden';
-
- /**
- * Number of apps the custom page is assigned to.
- */
- app_count?: number;
-
- created_at?: string;
-
- /**
- * UUID
- */
- uid?: string;
-
- updated_at?: string;
-}
-
export interface CustomPageCreateParams {
/**
* Custom page HTML.
@@ -222,7 +222,7 @@ export interface CustomPageCreateParams {
app_count?: number;
}
-export interface CustomPageReplaceParams {
+export interface CustomPageUpdateParams {
/**
* Custom page HTML.
*/
@@ -246,10 +246,10 @@ export interface CustomPageReplaceParams {
export namespace CustomPages {
export import CustomPageCreateResponse = CustomPagesAPI.CustomPageCreateResponse;
+ export import CustomPageUpdateResponse = CustomPagesAPI.CustomPageUpdateResponse;
export import CustomPageListResponse = CustomPagesAPI.CustomPageListResponse;
export import CustomPageDeleteResponse = CustomPagesAPI.CustomPageDeleteResponse;
export import CustomPageGetResponse = CustomPagesAPI.CustomPageGetResponse;
- export import CustomPageReplaceResponse = CustomPagesAPI.CustomPageReplaceResponse;
export import CustomPageCreateParams = CustomPagesAPI.CustomPageCreateParams;
- export import CustomPageReplaceParams = CustomPagesAPI.CustomPageReplaceParams;
+ export import CustomPageUpdateParams = CustomPagesAPI.CustomPageUpdateParams;
}
diff --git a/src/resources/access/groups.ts b/src/resources/access/groups.ts
index d97add1b83..b7baa957a4 100644
--- a/src/resources/access/groups.ts
+++ b/src/resources/access/groups.ts
@@ -22,6 +22,24 @@ export class Groups extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a configured Access group.
+ */
+ update(
+ accountOrZone: string,
+ accountOrZoneId: string,
+ uuid: string,
+ body: GroupUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/groups/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: GroupUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all Access groups.
*/
@@ -70,24 +88,6 @@ export class Groups extends APIResource {
) as Core.APIPromise<{ result: GroupGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Updates a configured Access group.
- */
- replace(
- accountOrZone: string,
- accountOrZoneId: string,
- uuid: string,
- body: GroupReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/groups/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: GroupReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export interface GroupCreateResponse {
@@ -1472,2782 +1472,2782 @@ export namespace GroupCreateResponse {
}
}
-export type GroupListResponse = Array;
+export interface GroupUpdateResponse {
+ /**
+ * UUID
+ */
+ id?: string;
-export namespace GroupListResponse {
- export interface GroupListResponseItem {
- /**
- * UUID
- */
- id?: string;
+ created_at?: string;
- created_at?: string;
+ /**
+ * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
+ * meet any of the Exclude rules.
+ */
+ exclude?: Array<
+ | GroupUpdateResponse.AccessEmailRule
+ | GroupUpdateResponse.AccessEmailListRule
+ | GroupUpdateResponse.AccessDomainRule
+ | GroupUpdateResponse.AccessEveryoneRule
+ | GroupUpdateResponse.AccessIPRule
+ | GroupUpdateResponse.AccessIPListRule
+ | GroupUpdateResponse.AccessCertificateRule
+ | GroupUpdateResponse.AccessAccessGroupRule
+ | GroupUpdateResponse.AccessAzureGroupRule
+ | GroupUpdateResponse.AccessGitHubOrganizationRule
+ | GroupUpdateResponse.AccessGsuiteGroupRule
+ | GroupUpdateResponse.AccessOktaGroupRule
+ | GroupUpdateResponse.AccessSamlGroupRule
+ | GroupUpdateResponse.AccessServiceTokenRule
+ | GroupUpdateResponse.AccessAnyValidServiceTokenRule
+ | GroupUpdateResponse.AccessExternalEvaluationRule
+ | GroupUpdateResponse.AccessCountryRule
+ | GroupUpdateResponse.AccessAuthenticationMethodRule
+ | GroupUpdateResponse.AccessDevicePostureRule
+ >;
- /**
- * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
- * meet any of the Exclude rules.
- */
- exclude?: Array<
- | GroupListResponseItem.AccessEmailRule
- | GroupListResponseItem.AccessEmailListRule
- | GroupListResponseItem.AccessDomainRule
- | GroupListResponseItem.AccessEveryoneRule
- | GroupListResponseItem.AccessIPRule
- | GroupListResponseItem.AccessIPListRule
- | GroupListResponseItem.AccessCertificateRule
- | GroupListResponseItem.AccessAccessGroupRule
- | GroupListResponseItem.AccessAzureGroupRule
- | GroupListResponseItem.AccessGitHubOrganizationRule
- | GroupListResponseItem.AccessGsuiteGroupRule
- | GroupListResponseItem.AccessOktaGroupRule
- | GroupListResponseItem.AccessSamlGroupRule
- | GroupListResponseItem.AccessServiceTokenRule
- | GroupListResponseItem.AccessAnyValidServiceTokenRule
- | GroupListResponseItem.AccessExternalEvaluationRule
- | GroupListResponseItem.AccessCountryRule
- | GroupListResponseItem.AccessAuthenticationMethodRule
- | GroupListResponseItem.AccessDevicePostureRule
- >;
+ /**
+ * Rules evaluated with an OR logical operator. A user needs to meet only one of
+ * the Include rules.
+ */
+ include?: Array<
+ | GroupUpdateResponse.AccessEmailRule
+ | GroupUpdateResponse.AccessEmailListRule
+ | GroupUpdateResponse.AccessDomainRule
+ | GroupUpdateResponse.AccessEveryoneRule
+ | GroupUpdateResponse.AccessIPRule
+ | GroupUpdateResponse.AccessIPListRule
+ | GroupUpdateResponse.AccessCertificateRule
+ | GroupUpdateResponse.AccessAccessGroupRule
+ | GroupUpdateResponse.AccessAzureGroupRule
+ | GroupUpdateResponse.AccessGitHubOrganizationRule
+ | GroupUpdateResponse.AccessGsuiteGroupRule
+ | GroupUpdateResponse.AccessOktaGroupRule
+ | GroupUpdateResponse.AccessSamlGroupRule
+ | GroupUpdateResponse.AccessServiceTokenRule
+ | GroupUpdateResponse.AccessAnyValidServiceTokenRule
+ | GroupUpdateResponse.AccessExternalEvaluationRule
+ | GroupUpdateResponse.AccessCountryRule
+ | GroupUpdateResponse.AccessAuthenticationMethodRule
+ | GroupUpdateResponse.AccessDevicePostureRule
+ >;
- /**
- * Rules evaluated with an OR logical operator. A user needs to meet only one of
- * the Include rules.
- */
- include?: Array<
- | GroupListResponseItem.AccessEmailRule
- | GroupListResponseItem.AccessEmailListRule
- | GroupListResponseItem.AccessDomainRule
- | GroupListResponseItem.AccessEveryoneRule
- | GroupListResponseItem.AccessIPRule
- | GroupListResponseItem.AccessIPListRule
- | GroupListResponseItem.AccessCertificateRule
- | GroupListResponseItem.AccessAccessGroupRule
- | GroupListResponseItem.AccessAzureGroupRule
- | GroupListResponseItem.AccessGitHubOrganizationRule
- | GroupListResponseItem.AccessGsuiteGroupRule
- | GroupListResponseItem.AccessOktaGroupRule
- | GroupListResponseItem.AccessSamlGroupRule
- | GroupListResponseItem.AccessServiceTokenRule
- | GroupListResponseItem.AccessAnyValidServiceTokenRule
- | GroupListResponseItem.AccessExternalEvaluationRule
- | GroupListResponseItem.AccessCountryRule
- | GroupListResponseItem.AccessAuthenticationMethodRule
- | GroupListResponseItem.AccessDevicePostureRule
- >;
+ /**
+ * Rules evaluated with an AND logical operator. To match a policy, a user must
+ * meet all of the Require rules.
+ */
+ is_default?: Array<
+ | GroupUpdateResponse.AccessEmailRule
+ | GroupUpdateResponse.AccessEmailListRule
+ | GroupUpdateResponse.AccessDomainRule
+ | GroupUpdateResponse.AccessEveryoneRule
+ | GroupUpdateResponse.AccessIPRule
+ | GroupUpdateResponse.AccessIPListRule
+ | GroupUpdateResponse.AccessCertificateRule
+ | GroupUpdateResponse.AccessAccessGroupRule
+ | GroupUpdateResponse.AccessAzureGroupRule
+ | GroupUpdateResponse.AccessGitHubOrganizationRule
+ | GroupUpdateResponse.AccessGsuiteGroupRule
+ | GroupUpdateResponse.AccessOktaGroupRule
+ | GroupUpdateResponse.AccessSamlGroupRule
+ | GroupUpdateResponse.AccessServiceTokenRule
+ | GroupUpdateResponse.AccessAnyValidServiceTokenRule
+ | GroupUpdateResponse.AccessExternalEvaluationRule
+ | GroupUpdateResponse.AccessCountryRule
+ | GroupUpdateResponse.AccessAuthenticationMethodRule
+ | GroupUpdateResponse.AccessDevicePostureRule
+ >;
- /**
- * Rules evaluated with an AND logical operator. To match a policy, a user must
- * meet all of the Require rules.
- */
- is_default?: Array<
- | GroupListResponseItem.AccessEmailRule
- | GroupListResponseItem.AccessEmailListRule
- | GroupListResponseItem.AccessDomainRule
- | GroupListResponseItem.AccessEveryoneRule
- | GroupListResponseItem.AccessIPRule
- | GroupListResponseItem.AccessIPListRule
- | GroupListResponseItem.AccessCertificateRule
- | GroupListResponseItem.AccessAccessGroupRule
- | GroupListResponseItem.AccessAzureGroupRule
- | GroupListResponseItem.AccessGitHubOrganizationRule
- | GroupListResponseItem.AccessGsuiteGroupRule
- | GroupListResponseItem.AccessOktaGroupRule
- | GroupListResponseItem.AccessSamlGroupRule
- | GroupListResponseItem.AccessServiceTokenRule
- | GroupListResponseItem.AccessAnyValidServiceTokenRule
- | GroupListResponseItem.AccessExternalEvaluationRule
- | GroupListResponseItem.AccessCountryRule
- | GroupListResponseItem.AccessAuthenticationMethodRule
- | GroupListResponseItem.AccessDevicePostureRule
- >;
+ /**
+ * The name of the Access group.
+ */
+ name?: string;
- /**
- * The name of the Access group.
- */
- name?: string;
+ /**
+ * Rules evaluated with an AND logical operator. To match a policy, a user must
+ * meet all of the Require rules.
+ */
+ require?: Array<
+ | GroupUpdateResponse.AccessEmailRule
+ | GroupUpdateResponse.AccessEmailListRule
+ | GroupUpdateResponse.AccessDomainRule
+ | GroupUpdateResponse.AccessEveryoneRule
+ | GroupUpdateResponse.AccessIPRule
+ | GroupUpdateResponse.AccessIPListRule
+ | GroupUpdateResponse.AccessCertificateRule
+ | GroupUpdateResponse.AccessAccessGroupRule
+ | GroupUpdateResponse.AccessAzureGroupRule
+ | GroupUpdateResponse.AccessGitHubOrganizationRule
+ | GroupUpdateResponse.AccessGsuiteGroupRule
+ | GroupUpdateResponse.AccessOktaGroupRule
+ | GroupUpdateResponse.AccessSamlGroupRule
+ | GroupUpdateResponse.AccessServiceTokenRule
+ | GroupUpdateResponse.AccessAnyValidServiceTokenRule
+ | GroupUpdateResponse.AccessExternalEvaluationRule
+ | GroupUpdateResponse.AccessCountryRule
+ | GroupUpdateResponse.AccessAuthenticationMethodRule
+ | GroupUpdateResponse.AccessDevicePostureRule
+ >;
- /**
- * Rules evaluated with an AND logical operator. To match a policy, a user must
- * meet all of the Require rules.
- */
- require?: Array<
- | GroupListResponseItem.AccessEmailRule
- | GroupListResponseItem.AccessEmailListRule
- | GroupListResponseItem.AccessDomainRule
- | GroupListResponseItem.AccessEveryoneRule
- | GroupListResponseItem.AccessIPRule
- | GroupListResponseItem.AccessIPListRule
- | GroupListResponseItem.AccessCertificateRule
- | GroupListResponseItem.AccessAccessGroupRule
- | GroupListResponseItem.AccessAzureGroupRule
- | GroupListResponseItem.AccessGitHubOrganizationRule
- | GroupListResponseItem.AccessGsuiteGroupRule
- | GroupListResponseItem.AccessOktaGroupRule
- | GroupListResponseItem.AccessSamlGroupRule
- | GroupListResponseItem.AccessServiceTokenRule
- | GroupListResponseItem.AccessAnyValidServiceTokenRule
- | GroupListResponseItem.AccessExternalEvaluationRule
- | GroupListResponseItem.AccessCountryRule
- | GroupListResponseItem.AccessAuthenticationMethodRule
- | GroupListResponseItem.AccessDevicePostureRule
- >;
+ updated_at?: string;
+}
- updated_at?: string;
+export namespace GroupUpdateResponse {
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- export namespace GroupListResponseItem {
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
}
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
- }
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
+
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Match an entire email domain.
+ * An empty object which matches on all users.
*/
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ everyone: unknown;
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPRule {
+ export interface IP {
/**
- * An empty object which matches on all users.
+ * An IPv4 or IPv6 CIDR block.
*/
- everyone: unknown;
+ ip: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
+
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
-
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a specific Access Service Token
+ * An empty object which matches on all service tokens.
*/
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
- }
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
/**
- * An empty object which matches on all service tokens.
+ * The API endpoint containing your business logic.
*/
- any_valid_service_token: unknown;
- }
+ evaluate_url: string;
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
}
+ }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
}
+ }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
}
+ }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Match an entire email domain.
+ * An empty object which matches on all users.
*/
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ everyone: unknown;
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPRule {
+ export interface IP {
/**
- * An empty object which matches on all users.
+ * An IPv4 or IPv6 CIDR block.
*/
- everyone: unknown;
+ ip: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
-
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
+
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a specific Access Service Token
+ * An empty object which matches on all service tokens.
*/
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
- }
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
/**
- * An empty object which matches on all service tokens.
+ * The API endpoint containing your business logic.
*/
- any_valid_service_token: unknown;
- }
+ evaluate_url: string;
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
}
+ }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
}
+ }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
}
+ }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Match an entire email domain.
+ * An empty object which matches on all users.
*/
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ everyone: unknown;
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPRule {
+ export interface IP {
/**
- * An empty object which matches on all users.
+ * An IPv4 or IPv6 CIDR block.
*/
- everyone: unknown;
+ ip: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
+
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
+
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
+
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a SAML group. Requires a SAML identity provider.
+ * An empty object which matches on all service tokens.
*/
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
-
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
-
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
- }
-
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
- }
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
/**
- * An empty object which matches on all service tokens.
+ * The API endpoint containing your business logic.
*/
- any_valid_service_token: unknown;
- }
+ evaluate_url: string;
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
}
+ }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
}
+ }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
}
+ }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
}
+ }
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * Match an entire email domain.
+ * An empty object which matches on all users.
*/
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ everyone: unknown;
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
- /**
- * The email domain to match.
- */
- domain: string;
- }
- }
+ /**
+ * Matches an IP address block.
+ */
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
+ export namespace AccessIPRule {
+ export interface IP {
/**
- * An empty object which matches on all users.
+ * An IPv4 or IPv6 CIDR block.
*/
- everyone: unknown;
+ ip: string;
}
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
}
+ }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
- }
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
}
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
- }
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
}
+ }
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
- }
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
+ /**
+ * The name of the organization.
+ */
+ name: string;
}
+ }
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
+ }
- /**
- * The name of the organization.
- */
- name: string;
- }
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
}
+ }
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
+
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
}
+ }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
+
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
+
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
}
+ }
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
}
+ }
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * Matches a SAML group. Requires a SAML identity provider.
+ * An empty object which matches on all service tokens.
*/
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ any_valid_service_token: unknown;
+ }
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
+
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
}
+ }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
+
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
}
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
+
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
}
+ }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
+
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
/**
- * An empty object which matches on all service tokens.
+ * The ID of a device posture integration.
*/
- any_valid_service_token: unknown;
+ integration_uid: string;
}
+ }
+}
+
+export type GroupListResponse = Array;
+export namespace GroupListResponse {
+ export interface GroupListResponseItem {
/**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
+ * UUID
*/
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ id?: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ created_at?: string;
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
- }
- }
+ /**
+ * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
+ * meet any of the Exclude rules.
+ */
+ exclude?: Array<
+ | GroupListResponseItem.AccessEmailRule
+ | GroupListResponseItem.AccessEmailListRule
+ | GroupListResponseItem.AccessDomainRule
+ | GroupListResponseItem.AccessEveryoneRule
+ | GroupListResponseItem.AccessIPRule
+ | GroupListResponseItem.AccessIPListRule
+ | GroupListResponseItem.AccessCertificateRule
+ | GroupListResponseItem.AccessAccessGroupRule
+ | GroupListResponseItem.AccessAzureGroupRule
+ | GroupListResponseItem.AccessGitHubOrganizationRule
+ | GroupListResponseItem.AccessGsuiteGroupRule
+ | GroupListResponseItem.AccessOktaGroupRule
+ | GroupListResponseItem.AccessSamlGroupRule
+ | GroupListResponseItem.AccessServiceTokenRule
+ | GroupListResponseItem.AccessAnyValidServiceTokenRule
+ | GroupListResponseItem.AccessExternalEvaluationRule
+ | GroupListResponseItem.AccessCountryRule
+ | GroupListResponseItem.AccessAuthenticationMethodRule
+ | GroupListResponseItem.AccessDevicePostureRule
+ >;
/**
- * Matches a specific country
+ * Rules evaluated with an OR logical operator. A user needs to meet only one of
+ * the Include rules.
*/
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ include?: Array<
+ | GroupListResponseItem.AccessEmailRule
+ | GroupListResponseItem.AccessEmailListRule
+ | GroupListResponseItem.AccessDomainRule
+ | GroupListResponseItem.AccessEveryoneRule
+ | GroupListResponseItem.AccessIPRule
+ | GroupListResponseItem.AccessIPListRule
+ | GroupListResponseItem.AccessCertificateRule
+ | GroupListResponseItem.AccessAccessGroupRule
+ | GroupListResponseItem.AccessAzureGroupRule
+ | GroupListResponseItem.AccessGitHubOrganizationRule
+ | GroupListResponseItem.AccessGsuiteGroupRule
+ | GroupListResponseItem.AccessOktaGroupRule
+ | GroupListResponseItem.AccessSamlGroupRule
+ | GroupListResponseItem.AccessServiceTokenRule
+ | GroupListResponseItem.AccessAnyValidServiceTokenRule
+ | GroupListResponseItem.AccessExternalEvaluationRule
+ | GroupListResponseItem.AccessCountryRule
+ | GroupListResponseItem.AccessAuthenticationMethodRule
+ | GroupListResponseItem.AccessDevicePostureRule
+ >;
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
- }
- }
+ /**
+ * Rules evaluated with an AND logical operator. To match a policy, a user must
+ * meet all of the Require rules.
+ */
+ is_default?: Array<
+ | GroupListResponseItem.AccessEmailRule
+ | GroupListResponseItem.AccessEmailListRule
+ | GroupListResponseItem.AccessDomainRule
+ | GroupListResponseItem.AccessEveryoneRule
+ | GroupListResponseItem.AccessIPRule
+ | GroupListResponseItem.AccessIPListRule
+ | GroupListResponseItem.AccessCertificateRule
+ | GroupListResponseItem.AccessAccessGroupRule
+ | GroupListResponseItem.AccessAzureGroupRule
+ | GroupListResponseItem.AccessGitHubOrganizationRule
+ | GroupListResponseItem.AccessGsuiteGroupRule
+ | GroupListResponseItem.AccessOktaGroupRule
+ | GroupListResponseItem.AccessSamlGroupRule
+ | GroupListResponseItem.AccessServiceTokenRule
+ | GroupListResponseItem.AccessAnyValidServiceTokenRule
+ | GroupListResponseItem.AccessExternalEvaluationRule
+ | GroupListResponseItem.AccessCountryRule
+ | GroupListResponseItem.AccessAuthenticationMethodRule
+ | GroupListResponseItem.AccessDevicePostureRule
+ >;
/**
- * Enforce different MFA options
+ * The name of the Access group.
*/
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ name?: string;
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
- }
- }
+ /**
+ * Rules evaluated with an AND logical operator. To match a policy, a user must
+ * meet all of the Require rules.
+ */
+ require?: Array<
+ | GroupListResponseItem.AccessEmailRule
+ | GroupListResponseItem.AccessEmailListRule
+ | GroupListResponseItem.AccessDomainRule
+ | GroupListResponseItem.AccessEveryoneRule
+ | GroupListResponseItem.AccessIPRule
+ | GroupListResponseItem.AccessIPListRule
+ | GroupListResponseItem.AccessCertificateRule
+ | GroupListResponseItem.AccessAccessGroupRule
+ | GroupListResponseItem.AccessAzureGroupRule
+ | GroupListResponseItem.AccessGitHubOrganizationRule
+ | GroupListResponseItem.AccessGsuiteGroupRule
+ | GroupListResponseItem.AccessOktaGroupRule
+ | GroupListResponseItem.AccessSamlGroupRule
+ | GroupListResponseItem.AccessServiceTokenRule
+ | GroupListResponseItem.AccessAnyValidServiceTokenRule
+ | GroupListResponseItem.AccessExternalEvaluationRule
+ | GroupListResponseItem.AccessCountryRule
+ | GroupListResponseItem.AccessAuthenticationMethodRule
+ | GroupListResponseItem.AccessDevicePostureRule
+ >;
+ updated_at?: string;
+ }
+
+ export namespace GroupListResponseItem {
/**
- * Enforces a device posture rule has run successfully
+ * Matches a specific email.
*/
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
+ export namespace AccessEmailRule {
+ export interface Email {
/**
- * The ID of a device posture integration.
+ * The email of the user.
*/
- integration_uid: string;
+ email: string;
}
}
- }
-}
-export interface GroupDeleteResponse {
- /**
- * UUID
- */
- id?: string;
-}
-
-export interface GroupGetResponse {
- /**
- * UUID
- */
- id?: string;
-
- created_at?: string;
-
- /**
- * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
- * meet any of the Exclude rules.
- */
- exclude?: Array<
- | GroupGetResponse.AccessEmailRule
- | GroupGetResponse.AccessEmailListRule
- | GroupGetResponse.AccessDomainRule
- | GroupGetResponse.AccessEveryoneRule
- | GroupGetResponse.AccessIPRule
- | GroupGetResponse.AccessIPListRule
- | GroupGetResponse.AccessCertificateRule
- | GroupGetResponse.AccessAccessGroupRule
- | GroupGetResponse.AccessAzureGroupRule
- | GroupGetResponse.AccessGitHubOrganizationRule
- | GroupGetResponse.AccessGsuiteGroupRule
- | GroupGetResponse.AccessOktaGroupRule
- | GroupGetResponse.AccessSamlGroupRule
- | GroupGetResponse.AccessServiceTokenRule
- | GroupGetResponse.AccessAnyValidServiceTokenRule
- | GroupGetResponse.AccessExternalEvaluationRule
- | GroupGetResponse.AccessCountryRule
- | GroupGetResponse.AccessAuthenticationMethodRule
- | GroupGetResponse.AccessDevicePostureRule
- >;
-
- /**
- * Rules evaluated with an OR logical operator. A user needs to meet only one of
- * the Include rules.
- */
- include?: Array<
- | GroupGetResponse.AccessEmailRule
- | GroupGetResponse.AccessEmailListRule
- | GroupGetResponse.AccessDomainRule
- | GroupGetResponse.AccessEveryoneRule
- | GroupGetResponse.AccessIPRule
- | GroupGetResponse.AccessIPListRule
- | GroupGetResponse.AccessCertificateRule
- | GroupGetResponse.AccessAccessGroupRule
- | GroupGetResponse.AccessAzureGroupRule
- | GroupGetResponse.AccessGitHubOrganizationRule
- | GroupGetResponse.AccessGsuiteGroupRule
- | GroupGetResponse.AccessOktaGroupRule
- | GroupGetResponse.AccessSamlGroupRule
- | GroupGetResponse.AccessServiceTokenRule
- | GroupGetResponse.AccessAnyValidServiceTokenRule
- | GroupGetResponse.AccessExternalEvaluationRule
- | GroupGetResponse.AccessCountryRule
- | GroupGetResponse.AccessAuthenticationMethodRule
- | GroupGetResponse.AccessDevicePostureRule
- >;
-
- /**
- * Rules evaluated with an AND logical operator. To match a policy, a user must
- * meet all of the Require rules.
- */
- is_default?: Array<
- | GroupGetResponse.AccessEmailRule
- | GroupGetResponse.AccessEmailListRule
- | GroupGetResponse.AccessDomainRule
- | GroupGetResponse.AccessEveryoneRule
- | GroupGetResponse.AccessIPRule
- | GroupGetResponse.AccessIPListRule
- | GroupGetResponse.AccessCertificateRule
- | GroupGetResponse.AccessAccessGroupRule
- | GroupGetResponse.AccessAzureGroupRule
- | GroupGetResponse.AccessGitHubOrganizationRule
- | GroupGetResponse.AccessGsuiteGroupRule
- | GroupGetResponse.AccessOktaGroupRule
- | GroupGetResponse.AccessSamlGroupRule
- | GroupGetResponse.AccessServiceTokenRule
- | GroupGetResponse.AccessAnyValidServiceTokenRule
- | GroupGetResponse.AccessExternalEvaluationRule
- | GroupGetResponse.AccessCountryRule
- | GroupGetResponse.AccessAuthenticationMethodRule
- | GroupGetResponse.AccessDevicePostureRule
- >;
-
- /**
- * The name of the Access group.
- */
- name?: string;
-
- /**
- * Rules evaluated with an AND logical operator. To match a policy, a user must
- * meet all of the Require rules.
- */
- require?: Array<
- | GroupGetResponse.AccessEmailRule
- | GroupGetResponse.AccessEmailListRule
- | GroupGetResponse.AccessDomainRule
- | GroupGetResponse.AccessEveryoneRule
- | GroupGetResponse.AccessIPRule
- | GroupGetResponse.AccessIPListRule
- | GroupGetResponse.AccessCertificateRule
- | GroupGetResponse.AccessAccessGroupRule
- | GroupGetResponse.AccessAzureGroupRule
- | GroupGetResponse.AccessGitHubOrganizationRule
- | GroupGetResponse.AccessGsuiteGroupRule
- | GroupGetResponse.AccessOktaGroupRule
- | GroupGetResponse.AccessSamlGroupRule
- | GroupGetResponse.AccessServiceTokenRule
- | GroupGetResponse.AccessAnyValidServiceTokenRule
- | GroupGetResponse.AccessExternalEvaluationRule
- | GroupGetResponse.AccessCountryRule
- | GroupGetResponse.AccessAuthenticationMethodRule
- | GroupGetResponse.AccessDevicePostureRule
- >;
-
- updated_at?: string;
-}
-
-export namespace GroupGetResponse {
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
-
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
}
- }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The ID of a Service Token.
+ * An empty object which matches on all service tokens.
*/
- token_id: string;
+ any_valid_service_token: unknown;
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
*/
- any_valid_service_token: unknown;
- }
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
}
- }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
+ }
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
}
- }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The ID of a Service Token.
+ * An empty object which matches on all service tokens.
*/
- token_id: string;
+ any_valid_service_token: unknown;
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
*/
- any_valid_service_token: unknown;
- }
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
}
- }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
+ }
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
+ }
+
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
}
- }
-
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
- export namespace AccessSamlGroupRule {
- export interface Saml {
- /**
- * The name of the SAML attribute.
- */
- attribute_name: string;
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The ID of a Service Token.
+ * An empty object which matches on all service tokens.
*/
- token_id: string;
+ any_valid_service_token: unknown;
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
*/
- any_valid_service_token: unknown;
- }
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
+ }
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ /**
+ * Matches a specific country
+ */
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
}
- }
- /**
- * Enforces a device posture rule has run successfully
- */
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
+ }
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
+ /**
+ * Matches a specific email.
+ */
+ export interface AccessEmailRule {
+ email: AccessEmailRule.Email;
}
- }
- /**
- * Matches a specific email.
- */
- export interface AccessEmailRule {
- email: AccessEmailRule.Email;
- }
+ export namespace AccessEmailRule {
+ export interface Email {
+ /**
+ * The email of the user.
+ */
+ email: string;
+ }
+ }
- export namespace AccessEmailRule {
- export interface Email {
- /**
- * The email of the user.
- */
- email: string;
+ /**
+ * Matches an email address from a list.
+ */
+ export interface AccessEmailListRule {
+ email_list: AccessEmailListRule.EmailList;
}
- }
- /**
- * Matches an email address from a list.
- */
- export interface AccessEmailListRule {
- email_list: AccessEmailListRule.EmailList;
- }
+ export namespace AccessEmailListRule {
+ export interface EmailList {
+ /**
+ * The ID of a previously created email list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessEmailListRule {
- export interface EmailList {
- /**
- * The ID of a previously created email list.
- */
- id: string;
+ /**
+ * Match an entire email domain.
+ */
+ export interface AccessDomainRule {
+ email_domain: AccessDomainRule.EmailDomain;
}
- }
- /**
- * Match an entire email domain.
- */
- export interface AccessDomainRule {
- email_domain: AccessDomainRule.EmailDomain;
- }
+ export namespace AccessDomainRule {
+ export interface EmailDomain {
+ /**
+ * The email domain to match.
+ */
+ domain: string;
+ }
+ }
- export namespace AccessDomainRule {
- export interface EmailDomain {
+ /**
+ * Matches everyone.
+ */
+ export interface AccessEveryoneRule {
/**
- * The email domain to match.
+ * An empty object which matches on all users.
*/
- domain: string;
+ everyone: unknown;
}
- }
- /**
- * Matches everyone.
- */
- export interface AccessEveryoneRule {
/**
- * An empty object which matches on all users.
+ * Matches an IP address block.
*/
- everyone: unknown;
- }
+ export interface AccessIPRule {
+ ip: AccessIPRule.IP;
+ }
- /**
- * Matches an IP address block.
- */
- export interface AccessIPRule {
- ip: AccessIPRule.IP;
- }
+ export namespace AccessIPRule {
+ export interface IP {
+ /**
+ * An IPv4 or IPv6 CIDR block.
+ */
+ ip: string;
+ }
+ }
- export namespace AccessIPRule {
- export interface IP {
- /**
- * An IPv4 or IPv6 CIDR block.
- */
- ip: string;
+ /**
+ * Matches an IP address from a list.
+ */
+ export interface AccessIPListRule {
+ ip_list: AccessIPListRule.IPList;
}
- }
- /**
- * Matches an IP address from a list.
- */
- export interface AccessIPListRule {
- ip_list: AccessIPListRule.IPList;
- }
+ export namespace AccessIPListRule {
+ export interface IPList {
+ /**
+ * The ID of a previously created IP list.
+ */
+ id: string;
+ }
+ }
- export namespace AccessIPListRule {
- export interface IPList {
- /**
- * The ID of a previously created IP list.
- */
- id: string;
+ /**
+ * Matches any valid client certificate.
+ */
+ export interface AccessCertificateRule {
+ certificate: unknown;
}
- }
- /**
- * Matches any valid client certificate.
- */
- export interface AccessCertificateRule {
- certificate: unknown;
- }
+ /**
+ * Matches an Access group.
+ */
+ export interface AccessAccessGroupRule {
+ group: AccessAccessGroupRule.Group;
+ }
- /**
- * Matches an Access group.
- */
- export interface AccessAccessGroupRule {
- group: AccessAccessGroupRule.Group;
- }
+ export namespace AccessAccessGroupRule {
+ export interface Group {
+ /**
+ * The ID of a previously created Access group.
+ */
+ id: string;
+ }
+ }
- export namespace AccessAccessGroupRule {
- export interface Group {
- /**
- * The ID of a previously created Access group.
- */
- id: string;
+ /**
+ * Matches an Azure group. Requires an Azure identity provider.
+ */
+ export interface AccessAzureGroupRule {
+ azureAD: AccessAzureGroupRule.AzureAd;
}
- }
- /**
- * Matches an Azure group. Requires an Azure identity provider.
- */
- export interface AccessAzureGroupRule {
- azureAD: AccessAzureGroupRule.AzureAd;
- }
+ export namespace AccessAzureGroupRule {
+ export interface AzureAd {
+ /**
+ * The ID of an Azure group.
+ */
+ id: string;
- export namespace AccessAzureGroupRule {
- export interface AzureAd {
- /**
- * The ID of an Azure group.
- */
- id: string;
+ /**
+ * The ID of your Azure identity provider.
+ */
+ connection_id: string;
+ }
+ }
- /**
- * The ID of your Azure identity provider.
- */
- connection_id: string;
+ /**
+ * Matches a Github organization. Requires a Github identity provider.
+ */
+ export interface AccessGitHubOrganizationRule {
+ 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
}
- }
- /**
- * Matches a Github organization. Requires a Github identity provider.
- */
- export interface AccessGitHubOrganizationRule {
- 'github-organization': AccessGitHubOrganizationRule.GitHubOrganization;
- }
+ export namespace AccessGitHubOrganizationRule {
+ export interface GitHubOrganization {
+ /**
+ * The ID of your Github identity provider.
+ */
+ connection_id: string;
- export namespace AccessGitHubOrganizationRule {
- export interface GitHubOrganization {
- /**
- * The ID of your Github identity provider.
- */
- connection_id: string;
+ /**
+ * The name of the organization.
+ */
+ name: string;
+ }
+ }
- /**
- * The name of the organization.
- */
- name: string;
+ /**
+ * Matches a group in Google Workspace. Requires a Google Workspace identity
+ * provider.
+ */
+ export interface AccessGsuiteGroupRule {
+ gsuite: AccessGsuiteGroupRule.Gsuite;
}
- }
- /**
- * Matches a group in Google Workspace. Requires a Google Workspace identity
- * provider.
- */
- export interface AccessGsuiteGroupRule {
- gsuite: AccessGsuiteGroupRule.Gsuite;
- }
+ export namespace AccessGsuiteGroupRule {
+ export interface Gsuite {
+ /**
+ * The ID of your Google Workspace identity provider.
+ */
+ connection_id: string;
- export namespace AccessGsuiteGroupRule {
- export interface Gsuite {
- /**
- * The ID of your Google Workspace identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Google Workspace group.
+ */
+ email: string;
+ }
+ }
- /**
- * The email of the Google Workspace group.
- */
- email: string;
+ /**
+ * Matches an Okta group. Requires an Okta identity provider.
+ */
+ export interface AccessOktaGroupRule {
+ okta: AccessOktaGroupRule.Okta;
}
- }
- /**
- * Matches an Okta group. Requires an Okta identity provider.
- */
- export interface AccessOktaGroupRule {
- okta: AccessOktaGroupRule.Okta;
- }
+ export namespace AccessOktaGroupRule {
+ export interface Okta {
+ /**
+ * The ID of your Okta identity provider.
+ */
+ connection_id: string;
- export namespace AccessOktaGroupRule {
- export interface Okta {
- /**
- * The ID of your Okta identity provider.
- */
- connection_id: string;
+ /**
+ * The email of the Okta group.
+ */
+ email: string;
+ }
+ }
+
+ /**
+ * Matches a SAML group. Requires a SAML identity provider.
+ */
+ export interface AccessSamlGroupRule {
+ saml: AccessSamlGroupRule.Saml;
+ }
+
+ export namespace AccessSamlGroupRule {
+ export interface Saml {
+ /**
+ * The name of the SAML attribute.
+ */
+ attribute_name: string;
+
+ /**
+ * The SAML attribute value to look for.
+ */
+ attribute_value: string;
+ }
+ }
- /**
- * The email of the Okta group.
- */
- email: string;
+ /**
+ * Matches a specific Access Service Token
+ */
+ export interface AccessServiceTokenRule {
+ service_token: AccessServiceTokenRule.ServiceToken;
}
- }
- /**
- * Matches a SAML group. Requires a SAML identity provider.
- */
- export interface AccessSamlGroupRule {
- saml: AccessSamlGroupRule.Saml;
- }
+ export namespace AccessServiceTokenRule {
+ export interface ServiceToken {
+ /**
+ * The ID of a Service Token.
+ */
+ token_id: string;
+ }
+ }
- export namespace AccessSamlGroupRule {
- export interface Saml {
+ /**
+ * Matches any valid Access Service Token
+ */
+ export interface AccessAnyValidServiceTokenRule {
/**
- * The name of the SAML attribute.
+ * An empty object which matches on all service tokens.
*/
- attribute_name: string;
+ any_valid_service_token: unknown;
+ }
- /**
- * The SAML attribute value to look for.
- */
- attribute_value: string;
+ /**
+ * Create Allow or Block policies which evaluate the user based on custom criteria.
+ */
+ export interface AccessExternalEvaluationRule {
+ external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
}
- }
- /**
- * Matches a specific Access Service Token
- */
- export interface AccessServiceTokenRule {
- service_token: AccessServiceTokenRule.ServiceToken;
- }
+ export namespace AccessExternalEvaluationRule {
+ export interface ExternalEvaluation {
+ /**
+ * The API endpoint containing your business logic.
+ */
+ evaluate_url: string;
- export namespace AccessServiceTokenRule {
- export interface ServiceToken {
- /**
- * The ID of a Service Token.
- */
- token_id: string;
+ /**
+ * The API endpoint containing the key that Access uses to verify that the response
+ * came from your API.
+ */
+ keys_url: string;
+ }
}
- }
- /**
- * Matches any valid Access Service Token
- */
- export interface AccessAnyValidServiceTokenRule {
/**
- * An empty object which matches on all service tokens.
+ * Matches a specific country
*/
- any_valid_service_token: unknown;
- }
-
- /**
- * Create Allow or Block policies which evaluate the user based on custom criteria.
- */
- export interface AccessExternalEvaluationRule {
- external_evaluation: AccessExternalEvaluationRule.ExternalEvaluation;
- }
-
- export namespace AccessExternalEvaluationRule {
- export interface ExternalEvaluation {
- /**
- * The API endpoint containing your business logic.
- */
- evaluate_url: string;
+ export interface AccessCountryRule {
+ geo: AccessCountryRule.Geo;
+ }
- /**
- * The API endpoint containing the key that Access uses to verify that the response
- * came from your API.
- */
- keys_url: string;
+ export namespace AccessCountryRule {
+ export interface Geo {
+ /**
+ * The country code that should be matched.
+ */
+ country_code: string;
+ }
}
- }
- /**
- * Matches a specific country
- */
- export interface AccessCountryRule {
- geo: AccessCountryRule.Geo;
- }
+ /**
+ * Enforce different MFA options
+ */
+ export interface AccessAuthenticationMethodRule {
+ auth_method: AccessAuthenticationMethodRule.AuthMethod;
+ }
- export namespace AccessCountryRule {
- export interface Geo {
- /**
- * The country code that should be matched.
- */
- country_code: string;
+ export namespace AccessAuthenticationMethodRule {
+ export interface AuthMethod {
+ /**
+ * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
+ */
+ auth_method: string;
+ }
}
- }
- /**
- * Enforce different MFA options
- */
- export interface AccessAuthenticationMethodRule {
- auth_method: AccessAuthenticationMethodRule.AuthMethod;
- }
+ /**
+ * Enforces a device posture rule has run successfully
+ */
+ export interface AccessDevicePostureRule {
+ device_posture: AccessDevicePostureRule.DevicePosture;
+ }
- export namespace AccessAuthenticationMethodRule {
- export interface AuthMethod {
- /**
- * The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
- */
- auth_method: string;
+ export namespace AccessDevicePostureRule {
+ export interface DevicePosture {
+ /**
+ * The ID of a device posture integration.
+ */
+ integration_uid: string;
+ }
}
}
+}
+export interface GroupDeleteResponse {
/**
- * Enforces a device posture rule has run successfully
+ * UUID
*/
- export interface AccessDevicePostureRule {
- device_posture: AccessDevicePostureRule.DevicePosture;
- }
-
- export namespace AccessDevicePostureRule {
- export interface DevicePosture {
- /**
- * The ID of a device posture integration.
- */
- integration_uid: string;
- }
- }
+ id?: string;
}
-export interface GroupReplaceResponse {
+export interface GroupGetResponse {
/**
* UUID
*/
@@ -4260,25 +4260,25 @@ export interface GroupReplaceResponse {
* meet any of the Exclude rules.
*/
exclude?: Array<
- | GroupReplaceResponse.AccessEmailRule
- | GroupReplaceResponse.AccessEmailListRule
- | GroupReplaceResponse.AccessDomainRule
- | GroupReplaceResponse.AccessEveryoneRule
- | GroupReplaceResponse.AccessIPRule
- | GroupReplaceResponse.AccessIPListRule
- | GroupReplaceResponse.AccessCertificateRule
- | GroupReplaceResponse.AccessAccessGroupRule
- | GroupReplaceResponse.AccessAzureGroupRule
- | GroupReplaceResponse.AccessGitHubOrganizationRule
- | GroupReplaceResponse.AccessGsuiteGroupRule
- | GroupReplaceResponse.AccessOktaGroupRule
- | GroupReplaceResponse.AccessSamlGroupRule
- | GroupReplaceResponse.AccessServiceTokenRule
- | GroupReplaceResponse.AccessAnyValidServiceTokenRule
- | GroupReplaceResponse.AccessExternalEvaluationRule
- | GroupReplaceResponse.AccessCountryRule
- | GroupReplaceResponse.AccessAuthenticationMethodRule
- | GroupReplaceResponse.AccessDevicePostureRule
+ | GroupGetResponse.AccessEmailRule
+ | GroupGetResponse.AccessEmailListRule
+ | GroupGetResponse.AccessDomainRule
+ | GroupGetResponse.AccessEveryoneRule
+ | GroupGetResponse.AccessIPRule
+ | GroupGetResponse.AccessIPListRule
+ | GroupGetResponse.AccessCertificateRule
+ | GroupGetResponse.AccessAccessGroupRule
+ | GroupGetResponse.AccessAzureGroupRule
+ | GroupGetResponse.AccessGitHubOrganizationRule
+ | GroupGetResponse.AccessGsuiteGroupRule
+ | GroupGetResponse.AccessOktaGroupRule
+ | GroupGetResponse.AccessSamlGroupRule
+ | GroupGetResponse.AccessServiceTokenRule
+ | GroupGetResponse.AccessAnyValidServiceTokenRule
+ | GroupGetResponse.AccessExternalEvaluationRule
+ | GroupGetResponse.AccessCountryRule
+ | GroupGetResponse.AccessAuthenticationMethodRule
+ | GroupGetResponse.AccessDevicePostureRule
>;
/**
@@ -4286,25 +4286,25 @@ export interface GroupReplaceResponse {
* the Include rules.
*/
include?: Array<
- | GroupReplaceResponse.AccessEmailRule
- | GroupReplaceResponse.AccessEmailListRule
- | GroupReplaceResponse.AccessDomainRule
- | GroupReplaceResponse.AccessEveryoneRule
- | GroupReplaceResponse.AccessIPRule
- | GroupReplaceResponse.AccessIPListRule
- | GroupReplaceResponse.AccessCertificateRule
- | GroupReplaceResponse.AccessAccessGroupRule
- | GroupReplaceResponse.AccessAzureGroupRule
- | GroupReplaceResponse.AccessGitHubOrganizationRule
- | GroupReplaceResponse.AccessGsuiteGroupRule
- | GroupReplaceResponse.AccessOktaGroupRule
- | GroupReplaceResponse.AccessSamlGroupRule
- | GroupReplaceResponse.AccessServiceTokenRule
- | GroupReplaceResponse.AccessAnyValidServiceTokenRule
- | GroupReplaceResponse.AccessExternalEvaluationRule
- | GroupReplaceResponse.AccessCountryRule
- | GroupReplaceResponse.AccessAuthenticationMethodRule
- | GroupReplaceResponse.AccessDevicePostureRule
+ | GroupGetResponse.AccessEmailRule
+ | GroupGetResponse.AccessEmailListRule
+ | GroupGetResponse.AccessDomainRule
+ | GroupGetResponse.AccessEveryoneRule
+ | GroupGetResponse.AccessIPRule
+ | GroupGetResponse.AccessIPListRule
+ | GroupGetResponse.AccessCertificateRule
+ | GroupGetResponse.AccessAccessGroupRule
+ | GroupGetResponse.AccessAzureGroupRule
+ | GroupGetResponse.AccessGitHubOrganizationRule
+ | GroupGetResponse.AccessGsuiteGroupRule
+ | GroupGetResponse.AccessOktaGroupRule
+ | GroupGetResponse.AccessSamlGroupRule
+ | GroupGetResponse.AccessServiceTokenRule
+ | GroupGetResponse.AccessAnyValidServiceTokenRule
+ | GroupGetResponse.AccessExternalEvaluationRule
+ | GroupGetResponse.AccessCountryRule
+ | GroupGetResponse.AccessAuthenticationMethodRule
+ | GroupGetResponse.AccessDevicePostureRule
>;
/**
@@ -4312,25 +4312,25 @@ export interface GroupReplaceResponse {
* meet all of the Require rules.
*/
is_default?: Array<
- | GroupReplaceResponse.AccessEmailRule
- | GroupReplaceResponse.AccessEmailListRule
- | GroupReplaceResponse.AccessDomainRule
- | GroupReplaceResponse.AccessEveryoneRule
- | GroupReplaceResponse.AccessIPRule
- | GroupReplaceResponse.AccessIPListRule
- | GroupReplaceResponse.AccessCertificateRule
- | GroupReplaceResponse.AccessAccessGroupRule
- | GroupReplaceResponse.AccessAzureGroupRule
- | GroupReplaceResponse.AccessGitHubOrganizationRule
- | GroupReplaceResponse.AccessGsuiteGroupRule
- | GroupReplaceResponse.AccessOktaGroupRule
- | GroupReplaceResponse.AccessSamlGroupRule
- | GroupReplaceResponse.AccessServiceTokenRule
- | GroupReplaceResponse.AccessAnyValidServiceTokenRule
- | GroupReplaceResponse.AccessExternalEvaluationRule
- | GroupReplaceResponse.AccessCountryRule
- | GroupReplaceResponse.AccessAuthenticationMethodRule
- | GroupReplaceResponse.AccessDevicePostureRule
+ | GroupGetResponse.AccessEmailRule
+ | GroupGetResponse.AccessEmailListRule
+ | GroupGetResponse.AccessDomainRule
+ | GroupGetResponse.AccessEveryoneRule
+ | GroupGetResponse.AccessIPRule
+ | GroupGetResponse.AccessIPListRule
+ | GroupGetResponse.AccessCertificateRule
+ | GroupGetResponse.AccessAccessGroupRule
+ | GroupGetResponse.AccessAzureGroupRule
+ | GroupGetResponse.AccessGitHubOrganizationRule
+ | GroupGetResponse.AccessGsuiteGroupRule
+ | GroupGetResponse.AccessOktaGroupRule
+ | GroupGetResponse.AccessSamlGroupRule
+ | GroupGetResponse.AccessServiceTokenRule
+ | GroupGetResponse.AccessAnyValidServiceTokenRule
+ | GroupGetResponse.AccessExternalEvaluationRule
+ | GroupGetResponse.AccessCountryRule
+ | GroupGetResponse.AccessAuthenticationMethodRule
+ | GroupGetResponse.AccessDevicePostureRule
>;
/**
@@ -4343,31 +4343,31 @@ export interface GroupReplaceResponse {
* meet all of the Require rules.
*/
require?: Array<
- | GroupReplaceResponse.AccessEmailRule
- | GroupReplaceResponse.AccessEmailListRule
- | GroupReplaceResponse.AccessDomainRule
- | GroupReplaceResponse.AccessEveryoneRule
- | GroupReplaceResponse.AccessIPRule
- | GroupReplaceResponse.AccessIPListRule
- | GroupReplaceResponse.AccessCertificateRule
- | GroupReplaceResponse.AccessAccessGroupRule
- | GroupReplaceResponse.AccessAzureGroupRule
- | GroupReplaceResponse.AccessGitHubOrganizationRule
- | GroupReplaceResponse.AccessGsuiteGroupRule
- | GroupReplaceResponse.AccessOktaGroupRule
- | GroupReplaceResponse.AccessSamlGroupRule
- | GroupReplaceResponse.AccessServiceTokenRule
- | GroupReplaceResponse.AccessAnyValidServiceTokenRule
- | GroupReplaceResponse.AccessExternalEvaluationRule
- | GroupReplaceResponse.AccessCountryRule
- | GroupReplaceResponse.AccessAuthenticationMethodRule
- | GroupReplaceResponse.AccessDevicePostureRule
+ | GroupGetResponse.AccessEmailRule
+ | GroupGetResponse.AccessEmailListRule
+ | GroupGetResponse.AccessDomainRule
+ | GroupGetResponse.AccessEveryoneRule
+ | GroupGetResponse.AccessIPRule
+ | GroupGetResponse.AccessIPListRule
+ | GroupGetResponse.AccessCertificateRule
+ | GroupGetResponse.AccessAccessGroupRule
+ | GroupGetResponse.AccessAzureGroupRule
+ | GroupGetResponse.AccessGitHubOrganizationRule
+ | GroupGetResponse.AccessGsuiteGroupRule
+ | GroupGetResponse.AccessOktaGroupRule
+ | GroupGetResponse.AccessSamlGroupRule
+ | GroupGetResponse.AccessServiceTokenRule
+ | GroupGetResponse.AccessAnyValidServiceTokenRule
+ | GroupGetResponse.AccessExternalEvaluationRule
+ | GroupGetResponse.AccessCountryRule
+ | GroupGetResponse.AccessAuthenticationMethodRule
+ | GroupGetResponse.AccessDevicePostureRule
>;
updated_at?: string;
}
-export namespace GroupReplaceResponse {
+export namespace GroupGetResponse {
/**
* Matches a specific email.
*/
@@ -6666,31 +6666,31 @@ export namespace GroupCreateParams {
}
}
-export interface GroupReplaceParams {
+export interface GroupUpdateParams {
/**
* Rules evaluated with an OR logical operator. A user needs to meet only one of
* the Include rules.
*/
include: Array<
- | GroupReplaceParams.AccessEmailRule
- | GroupReplaceParams.AccessEmailListRule
- | GroupReplaceParams.AccessDomainRule
- | GroupReplaceParams.AccessEveryoneRule
- | GroupReplaceParams.AccessIPRule
- | GroupReplaceParams.AccessIPListRule
- | GroupReplaceParams.AccessCertificateRule
- | GroupReplaceParams.AccessAccessGroupRule
- | GroupReplaceParams.AccessAzureGroupRule
- | GroupReplaceParams.AccessGitHubOrganizationRule
- | GroupReplaceParams.AccessGsuiteGroupRule
- | GroupReplaceParams.AccessOktaGroupRule
- | GroupReplaceParams.AccessSamlGroupRule
- | GroupReplaceParams.AccessServiceTokenRule
- | GroupReplaceParams.AccessAnyValidServiceTokenRule
- | GroupReplaceParams.AccessExternalEvaluationRule
- | GroupReplaceParams.AccessCountryRule
- | GroupReplaceParams.AccessAuthenticationMethodRule
- | GroupReplaceParams.AccessDevicePostureRule
+ | GroupUpdateParams.AccessEmailRule
+ | GroupUpdateParams.AccessEmailListRule
+ | GroupUpdateParams.AccessDomainRule
+ | GroupUpdateParams.AccessEveryoneRule
+ | GroupUpdateParams.AccessIPRule
+ | GroupUpdateParams.AccessIPListRule
+ | GroupUpdateParams.AccessCertificateRule
+ | GroupUpdateParams.AccessAccessGroupRule
+ | GroupUpdateParams.AccessAzureGroupRule
+ | GroupUpdateParams.AccessGitHubOrganizationRule
+ | GroupUpdateParams.AccessGsuiteGroupRule
+ | GroupUpdateParams.AccessOktaGroupRule
+ | GroupUpdateParams.AccessSamlGroupRule
+ | GroupUpdateParams.AccessServiceTokenRule
+ | GroupUpdateParams.AccessAnyValidServiceTokenRule
+ | GroupUpdateParams.AccessExternalEvaluationRule
+ | GroupUpdateParams.AccessCountryRule
+ | GroupUpdateParams.AccessAuthenticationMethodRule
+ | GroupUpdateParams.AccessDevicePostureRule
>;
/**
@@ -6703,25 +6703,25 @@ export interface GroupReplaceParams {
* meet any of the Exclude rules.
*/
exclude?: Array<
- | GroupReplaceParams.AccessEmailRule
- | GroupReplaceParams.AccessEmailListRule
- | GroupReplaceParams.AccessDomainRule
- | GroupReplaceParams.AccessEveryoneRule
- | GroupReplaceParams.AccessIPRule
- | GroupReplaceParams.AccessIPListRule
- | GroupReplaceParams.AccessCertificateRule
- | GroupReplaceParams.AccessAccessGroupRule
- | GroupReplaceParams.AccessAzureGroupRule
- | GroupReplaceParams.AccessGitHubOrganizationRule
- | GroupReplaceParams.AccessGsuiteGroupRule
- | GroupReplaceParams.AccessOktaGroupRule
- | GroupReplaceParams.AccessSamlGroupRule
- | GroupReplaceParams.AccessServiceTokenRule
- | GroupReplaceParams.AccessAnyValidServiceTokenRule
- | GroupReplaceParams.AccessExternalEvaluationRule
- | GroupReplaceParams.AccessCountryRule
- | GroupReplaceParams.AccessAuthenticationMethodRule
- | GroupReplaceParams.AccessDevicePostureRule
+ | GroupUpdateParams.AccessEmailRule
+ | GroupUpdateParams.AccessEmailListRule
+ | GroupUpdateParams.AccessDomainRule
+ | GroupUpdateParams.AccessEveryoneRule
+ | GroupUpdateParams.AccessIPRule
+ | GroupUpdateParams.AccessIPListRule
+ | GroupUpdateParams.AccessCertificateRule
+ | GroupUpdateParams.AccessAccessGroupRule
+ | GroupUpdateParams.AccessAzureGroupRule
+ | GroupUpdateParams.AccessGitHubOrganizationRule
+ | GroupUpdateParams.AccessGsuiteGroupRule
+ | GroupUpdateParams.AccessOktaGroupRule
+ | GroupUpdateParams.AccessSamlGroupRule
+ | GroupUpdateParams.AccessServiceTokenRule
+ | GroupUpdateParams.AccessAnyValidServiceTokenRule
+ | GroupUpdateParams.AccessExternalEvaluationRule
+ | GroupUpdateParams.AccessCountryRule
+ | GroupUpdateParams.AccessAuthenticationMethodRule
+ | GroupUpdateParams.AccessDevicePostureRule
>;
/**
@@ -6734,29 +6734,29 @@ export interface GroupReplaceParams {
* meet all of the Require rules.
*/
require?: Array<
- | GroupReplaceParams.AccessEmailRule
- | GroupReplaceParams.AccessEmailListRule
- | GroupReplaceParams.AccessDomainRule
- | GroupReplaceParams.AccessEveryoneRule
- | GroupReplaceParams.AccessIPRule
- | GroupReplaceParams.AccessIPListRule
- | GroupReplaceParams.AccessCertificateRule
- | GroupReplaceParams.AccessAccessGroupRule
- | GroupReplaceParams.AccessAzureGroupRule
- | GroupReplaceParams.AccessGitHubOrganizationRule
- | GroupReplaceParams.AccessGsuiteGroupRule
- | GroupReplaceParams.AccessOktaGroupRule
- | GroupReplaceParams.AccessSamlGroupRule
- | GroupReplaceParams.AccessServiceTokenRule
- | GroupReplaceParams.AccessAnyValidServiceTokenRule
- | GroupReplaceParams.AccessExternalEvaluationRule
- | GroupReplaceParams.AccessCountryRule
- | GroupReplaceParams.AccessAuthenticationMethodRule
- | GroupReplaceParams.AccessDevicePostureRule
+ | GroupUpdateParams.AccessEmailRule
+ | GroupUpdateParams.AccessEmailListRule
+ | GroupUpdateParams.AccessDomainRule
+ | GroupUpdateParams.AccessEveryoneRule
+ | GroupUpdateParams.AccessIPRule
+ | GroupUpdateParams.AccessIPListRule
+ | GroupUpdateParams.AccessCertificateRule
+ | GroupUpdateParams.AccessAccessGroupRule
+ | GroupUpdateParams.AccessAzureGroupRule
+ | GroupUpdateParams.AccessGitHubOrganizationRule
+ | GroupUpdateParams.AccessGsuiteGroupRule
+ | GroupUpdateParams.AccessOktaGroupRule
+ | GroupUpdateParams.AccessSamlGroupRule
+ | GroupUpdateParams.AccessServiceTokenRule
+ | GroupUpdateParams.AccessAnyValidServiceTokenRule
+ | GroupUpdateParams.AccessExternalEvaluationRule
+ | GroupUpdateParams.AccessCountryRule
+ | GroupUpdateParams.AccessAuthenticationMethodRule
+ | GroupUpdateParams.AccessDevicePostureRule
>;
}
-export namespace GroupReplaceParams {
+export namespace GroupUpdateParams {
/**
* Matches a specific email.
*/
@@ -7705,10 +7705,10 @@ export namespace GroupReplaceParams {
export namespace Groups {
export import GroupCreateResponse = GroupsAPI.GroupCreateResponse;
+ export import GroupUpdateResponse = GroupsAPI.GroupUpdateResponse;
export import GroupListResponse = GroupsAPI.GroupListResponse;
export import GroupDeleteResponse = GroupsAPI.GroupDeleteResponse;
export import GroupGetResponse = GroupsAPI.GroupGetResponse;
- export import GroupReplaceResponse = GroupsAPI.GroupReplaceResponse;
export import GroupCreateParams = GroupsAPI.GroupCreateParams;
- export import GroupReplaceParams = GroupsAPI.GroupReplaceParams;
+ export import GroupUpdateParams = GroupsAPI.GroupUpdateParams;
}
diff --git a/src/resources/access/identity-providers.ts b/src/resources/access/identity-providers.ts
index 4ed9bcca63..8911137e80 100644
--- a/src/resources/access/identity-providers.ts
+++ b/src/resources/access/identity-providers.ts
@@ -22,6 +22,24 @@ export class IdentityProviders extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a configured identity provider.
+ */
+ update(
+ accountOrZone: string,
+ accountOrZoneId: string,
+ uuid: string,
+ body: IdentityProviderUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/identity_providers/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: IdentityProviderUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all configured identity providers.
*/
@@ -71,24 +89,6 @@ export class IdentityProviders extends APIResource {
) as Core.APIPromise<{ result: IdentityProviderGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Updates a configured identity provider.
- */
- replace(
- accountOrZone: string,
- accountOrZoneId: string,
- uuid: string,
- body: IdentityProviderReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/identity_providers/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: IdentityProviderReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export type IdentityProviderCreateResponse =
@@ -1726,23 +1726,23 @@ export namespace IdentityProviderCreateResponse {
}
}
-export type IdentityProviderListResponse = Array<
- | IdentityProviderListResponse.AccessAzureAd
- | IdentityProviderListResponse.AccessCentrify
- | IdentityProviderListResponse.AccessFacebook
- | IdentityProviderListResponse.AccessGitHub
- | IdentityProviderListResponse.AccessGoogle
- | IdentityProviderListResponse.AccessGoogleApps
- | IdentityProviderListResponse.AccessLinkedin
- | IdentityProviderListResponse.AccessOidc
- | IdentityProviderListResponse.AccessOkta
- | IdentityProviderListResponse.AccessOnelogin
- | IdentityProviderListResponse.AccessPingone
- | IdentityProviderListResponse.AccessSaml
- | IdentityProviderListResponse.AccessYandex
->;
-
-export namespace IdentityProviderListResponse {
+export type IdentityProviderUpdateResponse =
+ | IdentityProviderUpdateResponse.AccessAzureAd
+ | IdentityProviderUpdateResponse.AccessCentrify
+ | IdentityProviderUpdateResponse.AccessFacebook
+ | IdentityProviderUpdateResponse.AccessGitHub
+ | IdentityProviderUpdateResponse.AccessGoogle
+ | IdentityProviderUpdateResponse.AccessGoogleApps
+ | IdentityProviderUpdateResponse.AccessLinkedin
+ | IdentityProviderUpdateResponse.AccessOidc
+ | IdentityProviderUpdateResponse.AccessOkta
+ | IdentityProviderUpdateResponse.AccessOnelogin
+ | IdentityProviderUpdateResponse.AccessPingone
+ | IdentityProviderUpdateResponse.AccessSaml
+ | IdentityProviderUpdateResponse.AccessYandex
+ | IdentityProviderUpdateResponse.AccessOnetimepin;
+
+export namespace IdentityProviderUpdateResponse {
export interface AccessAzureAd {
/**
* The configuration parameters for the identity provider. To view the required
@@ -3273,32 +3273,111 @@ export namespace IdentityProviderListResponse {
user_deprovision?: boolean;
}
}
-}
-export interface IdentityProviderDeleteResponse {
- /**
- * UUID
- */
- id?: string;
+ export interface AccessOnetimepin {
+ /**
+ * The configuration parameters for the identity provider. To view the required
+ * parameters for a specific provider, refer to our
+ * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
+ */
+ config: unknown;
+
+ /**
+ * The name of the identity provider, shown to users on the login page.
+ */
+ name: string;
+
+ /**
+ * The type of identity provider. To determine the value for a specific provider,
+ * refer to our
+ * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
+ */
+ type:
+ | 'onetimepin'
+ | 'azureAD'
+ | 'saml'
+ | 'centrify'
+ | 'facebook'
+ | 'github'
+ | 'google-apps'
+ | 'google'
+ | 'linkedin'
+ | 'oidc'
+ | 'okta'
+ | 'onelogin'
+ | 'pingone'
+ | 'yandex';
+
+ /**
+ * UUID
+ */
+ id?: string;
+
+ /**
+ * The configuration settings for enabling a System for Cross-Domain Identity
+ * Management (SCIM) with the identity provider.
+ */
+ scim_config?: AccessOnetimepin.ScimConfig;
+ }
+
+ export namespace AccessOnetimepin {
+ /**
+ * The configuration settings for enabling a System for Cross-Domain Identity
+ * Management (SCIM) with the identity provider.
+ */
+ export interface ScimConfig {
+ /**
+ * A flag to enable or disable SCIM for the identity provider.
+ */
+ enabled?: boolean;
+
+ /**
+ * A flag to revoke a user's session in Access and force a reauthentication on the
+ * user's Gateway session when they have been added or removed from a group in the
+ * Identity Provider.
+ */
+ group_member_deprovision?: boolean;
+
+ /**
+ * A flag to remove a user's seat in Zero Trust when they have been deprovisioned
+ * in the Identity Provider. This cannot be enabled unless user_deprovision is also
+ * enabled.
+ */
+ seat_deprovision?: boolean;
+
+ /**
+ * A read-only token generated when the SCIM integration is enabled for the first
+ * time. It is redacted on subsequent requests. If you lose this you will need to
+ * refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
+ */
+ secret?: string;
+
+ /**
+ * A flag to enable revoking a user's session in Access and Gateway when they have
+ * been deprovisioned in the Identity Provider.
+ */
+ user_deprovision?: boolean;
+ }
+ }
}
-export type IdentityProviderGetResponse =
- | IdentityProviderGetResponse.AccessAzureAd
- | IdentityProviderGetResponse.AccessCentrify
- | IdentityProviderGetResponse.AccessFacebook
- | IdentityProviderGetResponse.AccessGitHub
- | IdentityProviderGetResponse.AccessGoogle
- | IdentityProviderGetResponse.AccessGoogleApps
- | IdentityProviderGetResponse.AccessLinkedin
- | IdentityProviderGetResponse.AccessOidc
- | IdentityProviderGetResponse.AccessOkta
- | IdentityProviderGetResponse.AccessOnelogin
- | IdentityProviderGetResponse.AccessPingone
- | IdentityProviderGetResponse.AccessSaml
- | IdentityProviderGetResponse.AccessYandex
- | IdentityProviderGetResponse.AccessOnetimepin;
+export type IdentityProviderListResponse = Array<
+ | IdentityProviderListResponse.AccessAzureAd
+ | IdentityProviderListResponse.AccessCentrify
+ | IdentityProviderListResponse.AccessFacebook
+ | IdentityProviderListResponse.AccessGitHub
+ | IdentityProviderListResponse.AccessGoogle
+ | IdentityProviderListResponse.AccessGoogleApps
+ | IdentityProviderListResponse.AccessLinkedin
+ | IdentityProviderListResponse.AccessOidc
+ | IdentityProviderListResponse.AccessOkta
+ | IdentityProviderListResponse.AccessOnelogin
+ | IdentityProviderListResponse.AccessPingone
+ | IdentityProviderListResponse.AccessSaml
+ | IdentityProviderListResponse.AccessYandex
+>;
-export namespace IdentityProviderGetResponse {
+export namespace IdentityProviderListResponse {
export interface AccessAzureAd {
/**
* The configuration parameters for the identity provider. To view the required
@@ -4829,111 +4908,32 @@ export namespace IdentityProviderGetResponse {
user_deprovision?: boolean;
}
}
+}
- export interface AccessOnetimepin {
- /**
- * The configuration parameters for the identity provider. To view the required
- * parameters for a specific provider, refer to our
- * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
- */
- config: unknown;
-
- /**
- * The name of the identity provider, shown to users on the login page.
- */
- name: string;
-
- /**
- * The type of identity provider. To determine the value for a specific provider,
- * refer to our
- * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
- */
- type:
- | 'onetimepin'
- | 'azureAD'
- | 'saml'
- | 'centrify'
- | 'facebook'
- | 'github'
- | 'google-apps'
- | 'google'
- | 'linkedin'
- | 'oidc'
- | 'okta'
- | 'onelogin'
- | 'pingone'
- | 'yandex';
-
- /**
- * UUID
- */
- id?: string;
-
- /**
- * The configuration settings for enabling a System for Cross-Domain Identity
- * Management (SCIM) with the identity provider.
- */
- scim_config?: AccessOnetimepin.ScimConfig;
- }
-
- export namespace AccessOnetimepin {
- /**
- * The configuration settings for enabling a System for Cross-Domain Identity
- * Management (SCIM) with the identity provider.
- */
- export interface ScimConfig {
- /**
- * A flag to enable or disable SCIM for the identity provider.
- */
- enabled?: boolean;
-
- /**
- * A flag to revoke a user's session in Access and force a reauthentication on the
- * user's Gateway session when they have been added or removed from a group in the
- * Identity Provider.
- */
- group_member_deprovision?: boolean;
-
- /**
- * A flag to remove a user's seat in Zero Trust when they have been deprovisioned
- * in the Identity Provider. This cannot be enabled unless user_deprovision is also
- * enabled.
- */
- seat_deprovision?: boolean;
-
- /**
- * A read-only token generated when the SCIM integration is enabled for the first
- * time. It is redacted on subsequent requests. If you lose this you will need to
- * refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
- */
- secret?: string;
-
- /**
- * A flag to enable revoking a user's session in Access and Gateway when they have
- * been deprovisioned in the Identity Provider.
- */
- user_deprovision?: boolean;
- }
- }
+export interface IdentityProviderDeleteResponse {
+ /**
+ * UUID
+ */
+ id?: string;
}
-export type IdentityProviderReplaceResponse =
- | IdentityProviderReplaceResponse.AccessAzureAd
- | IdentityProviderReplaceResponse.AccessCentrify
- | IdentityProviderReplaceResponse.AccessFacebook
- | IdentityProviderReplaceResponse.AccessGitHub
- | IdentityProviderReplaceResponse.AccessGoogle
- | IdentityProviderReplaceResponse.AccessGoogleApps
- | IdentityProviderReplaceResponse.AccessLinkedin
- | IdentityProviderReplaceResponse.AccessOidc
- | IdentityProviderReplaceResponse.AccessOkta
- | IdentityProviderReplaceResponse.AccessOnelogin
- | IdentityProviderReplaceResponse.AccessPingone
- | IdentityProviderReplaceResponse.AccessSaml
- | IdentityProviderReplaceResponse.AccessYandex
- | IdentityProviderReplaceResponse.AccessOnetimepin;
-
-export namespace IdentityProviderReplaceResponse {
+export type IdentityProviderGetResponse =
+ | IdentityProviderGetResponse.AccessAzureAd
+ | IdentityProviderGetResponse.AccessCentrify
+ | IdentityProviderGetResponse.AccessFacebook
+ | IdentityProviderGetResponse.AccessGitHub
+ | IdentityProviderGetResponse.AccessGoogle
+ | IdentityProviderGetResponse.AccessGoogleApps
+ | IdentityProviderGetResponse.AccessLinkedin
+ | IdentityProviderGetResponse.AccessOidc
+ | IdentityProviderGetResponse.AccessOkta
+ | IdentityProviderGetResponse.AccessOnelogin
+ | IdentityProviderGetResponse.AccessPingone
+ | IdentityProviderGetResponse.AccessSaml
+ | IdentityProviderGetResponse.AccessYandex
+ | IdentityProviderGetResponse.AccessOnetimepin;
+
+export namespace IdentityProviderGetResponse {
export interface AccessAzureAd {
/**
* The configuration parameters for the identity provider. To view the required
@@ -8117,30 +8117,30 @@ export namespace IdentityProviderCreateParams {
}
}
-export type IdentityProviderReplaceParams =
- | IdentityProviderReplaceParams.AccessAzureAd
- | IdentityProviderReplaceParams.AccessCentrify
- | IdentityProviderReplaceParams.AccessFacebook
- | IdentityProviderReplaceParams.AccessGitHub
- | IdentityProviderReplaceParams.AccessGoogle
- | IdentityProviderReplaceParams.AccessGoogleApps
- | IdentityProviderReplaceParams.AccessLinkedin
- | IdentityProviderReplaceParams.AccessOidc
- | IdentityProviderReplaceParams.AccessOkta
- | IdentityProviderReplaceParams.AccessOnelogin
- | IdentityProviderReplaceParams.AccessPingone
- | IdentityProviderReplaceParams.AccessSaml
- | IdentityProviderReplaceParams.AccessYandex
- | IdentityProviderReplaceParams.AccessOnetimepin;
-
-export namespace IdentityProviderReplaceParams {
+export type IdentityProviderUpdateParams =
+ | IdentityProviderUpdateParams.AccessAzureAd
+ | IdentityProviderUpdateParams.AccessCentrify
+ | IdentityProviderUpdateParams.AccessFacebook
+ | IdentityProviderUpdateParams.AccessGitHub
+ | IdentityProviderUpdateParams.AccessGoogle
+ | IdentityProviderUpdateParams.AccessGoogleApps
+ | IdentityProviderUpdateParams.AccessLinkedin
+ | IdentityProviderUpdateParams.AccessOidc
+ | IdentityProviderUpdateParams.AccessOkta
+ | IdentityProviderUpdateParams.AccessOnelogin
+ | IdentityProviderUpdateParams.AccessPingone
+ | IdentityProviderUpdateParams.AccessSaml
+ | IdentityProviderUpdateParams.AccessYandex
+ | IdentityProviderUpdateParams.AccessOnetimepin;
+
+export namespace IdentityProviderUpdateParams {
export interface AccessAzureAd {
/**
* The configuration parameters for the identity provider. To view the required
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessAzureAd.Config;
+ config: IdentityProviderUpdateParams.AccessAzureAd.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8172,7 +8172,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessAzureAd.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessAzureAd.ScimConfig;
}
export namespace AccessAzureAd {
@@ -8263,7 +8263,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessCentrify.Config;
+ config: IdentityProviderUpdateParams.AccessCentrify.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8295,7 +8295,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessCentrify.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessCentrify.ScimConfig;
}
export namespace AccessCentrify {
@@ -8381,7 +8381,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessFacebook.Config;
+ config: IdentityProviderUpdateParams.AccessFacebook.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8413,7 +8413,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessFacebook.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessFacebook.ScimConfig;
}
export namespace AccessFacebook {
@@ -8479,7 +8479,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessGitHub.Config;
+ config: IdentityProviderUpdateParams.AccessGitHub.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8511,7 +8511,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessGitHub.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessGitHub.ScimConfig;
}
export namespace AccessGitHub {
@@ -8577,7 +8577,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessGoogle.Config;
+ config: IdentityProviderUpdateParams.AccessGoogle.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8609,7 +8609,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessGoogle.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessGoogle.ScimConfig;
}
export namespace AccessGoogle {
@@ -8685,7 +8685,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessGoogleApps.Config;
+ config: IdentityProviderUpdateParams.AccessGoogleApps.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8717,7 +8717,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessGoogleApps.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessGoogleApps.ScimConfig;
}
export namespace AccessGoogleApps {
@@ -8798,7 +8798,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessLinkedin.Config;
+ config: IdentityProviderUpdateParams.AccessLinkedin.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8830,7 +8830,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessLinkedin.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessLinkedin.ScimConfig;
}
export namespace AccessLinkedin {
@@ -8896,7 +8896,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessOidc.Config;
+ config: IdentityProviderUpdateParams.AccessOidc.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -8928,7 +8928,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessOidc.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessOidc.ScimConfig;
}
export namespace AccessOidc {
@@ -9024,7 +9024,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessOkta.Config;
+ config: IdentityProviderUpdateParams.AccessOkta.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -9056,7 +9056,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessOkta.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessOkta.ScimConfig;
}
export namespace AccessOkta {
@@ -9142,7 +9142,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessOnelogin.Config;
+ config: IdentityProviderUpdateParams.AccessOnelogin.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -9174,7 +9174,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessOnelogin.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessOnelogin.ScimConfig;
}
export namespace AccessOnelogin {
@@ -9255,7 +9255,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessPingone.Config;
+ config: IdentityProviderUpdateParams.AccessPingone.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -9287,7 +9287,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessPingone.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessPingone.ScimConfig;
}
export namespace AccessPingone {
@@ -9368,7 +9368,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessSaml.Config;
+ config: IdentityProviderUpdateParams.AccessSaml.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -9400,7 +9400,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessSaml.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessSaml.ScimConfig;
}
export namespace AccessSaml {
@@ -9508,7 +9508,7 @@ export namespace IdentityProviderReplaceParams {
* parameters for a specific provider, refer to our
* [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
*/
- config: IdentityProviderReplaceParams.AccessYandex.Config;
+ config: IdentityProviderUpdateParams.AccessYandex.Config;
/**
* The name of the identity provider, shown to users on the login page.
@@ -9540,7 +9540,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessYandex.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessYandex.ScimConfig;
}
export namespace AccessYandex {
@@ -9638,7 +9638,7 @@ export namespace IdentityProviderReplaceParams {
* The configuration settings for enabling a System for Cross-Domain Identity
* Management (SCIM) with the identity provider.
*/
- scim_config?: IdentityProviderReplaceParams.AccessOnetimepin.ScimConfig;
+ scim_config?: IdentityProviderUpdateParams.AccessOnetimepin.ScimConfig;
}
export namespace AccessOnetimepin {
@@ -9684,10 +9684,10 @@ export namespace IdentityProviderReplaceParams {
export namespace IdentityProviders {
export import IdentityProviderCreateResponse = IdentityProvidersAPI.IdentityProviderCreateResponse;
+ export import IdentityProviderUpdateResponse = IdentityProvidersAPI.IdentityProviderUpdateResponse;
export import IdentityProviderListResponse = IdentityProvidersAPI.IdentityProviderListResponse;
export import IdentityProviderDeleteResponse = IdentityProvidersAPI.IdentityProviderDeleteResponse;
export import IdentityProviderGetResponse = IdentityProvidersAPI.IdentityProviderGetResponse;
- export import IdentityProviderReplaceResponse = IdentityProvidersAPI.IdentityProviderReplaceResponse;
export import IdentityProviderCreateParams = IdentityProvidersAPI.IdentityProviderCreateParams;
- export import IdentityProviderReplaceParams = IdentityProvidersAPI.IdentityProviderReplaceParams;
+ export import IdentityProviderUpdateParams = IdentityProvidersAPI.IdentityProviderUpdateParams;
}
diff --git a/src/resources/access/index.ts b/src/resources/access/index.ts
index 057e1ca6cc..bb6019ca54 100644
--- a/src/resources/access/index.ts
+++ b/src/resources/access/index.ts
@@ -3,94 +3,94 @@
export { Access } from './access';
export {
ApplicationCreateResponse,
+ ApplicationUpdateResponse,
ApplicationListResponse,
ApplicationDeleteResponse,
ApplicationGetResponse,
- ApplicationReplaceResponse,
ApplicationRevokeTokensResponse,
ApplicationCreateParams,
- ApplicationReplaceParams,
+ ApplicationUpdateParams,
Applications,
} from './applications/index';
export {
+ BookmarkUpdateResponse,
BookmarkListResponse,
BookmarkDeleteResponse,
BookmarkGetResponse,
- BookmarkReplaceResponse,
Bookmarks,
} from './bookmarks';
export {
CertificateCreateResponse,
+ CertificateUpdateResponse,
CertificateListResponse,
CertificateDeleteResponse,
CertificateGetResponse,
- CertificateReplaceResponse,
CertificateCreateParams,
- CertificateReplaceParams,
+ CertificateUpdateParams,
Certificates,
} from './certificates/index';
export {
CustomPageCreateResponse,
+ CustomPageUpdateResponse,
CustomPageListResponse,
CustomPageDeleteResponse,
CustomPageGetResponse,
- CustomPageReplaceResponse,
CustomPageCreateParams,
- CustomPageReplaceParams,
+ CustomPageUpdateParams,
CustomPages,
} from './custom-pages';
export {
GroupCreateResponse,
+ GroupUpdateResponse,
GroupListResponse,
GroupDeleteResponse,
GroupGetResponse,
- GroupReplaceResponse,
GroupCreateParams,
- GroupReplaceParams,
+ GroupUpdateParams,
Groups,
} from './groups';
export {
IdentityProviderCreateResponse,
+ IdentityProviderUpdateResponse,
IdentityProviderListResponse,
IdentityProviderDeleteResponse,
IdentityProviderGetResponse,
- IdentityProviderReplaceResponse,
IdentityProviderCreateParams,
- IdentityProviderReplaceParams,
+ IdentityProviderUpdateParams,
IdentityProviders,
} from './identity-providers';
-export { KeyListResponse, KeyReplaceResponse, KeyRotateResponse, KeyReplaceParams, Keys } from './keys';
+export { KeyUpdateResponse, KeyListResponse, KeyRotateResponse, KeyUpdateParams, Keys } from './keys';
export { Logs } from './logs/index';
export {
OrganizationCreateResponse,
+ OrganizationUpdateResponse,
OrganizationListResponse,
- OrganizationReplaceResponse,
OrganizationRevokeUsersResponse,
OrganizationCreateParams,
- OrganizationReplaceParams,
+ OrganizationUpdateParams,
OrganizationRevokeUsersParams,
Organizations,
} from './organizations';
-export { SeatUpdateResponse, SeatUpdateParams, Seats } from './seats';
+export { SeatEditResponse, SeatEditParams, Seats } from './seats';
export {
ServiceTokenCreateResponse,
+ ServiceTokenUpdateResponse,
ServiceTokenListResponse,
ServiceTokenDeleteResponse,
ServiceTokenRefreshResponse,
- ServiceTokenReplaceResponse,
ServiceTokenRotateResponse,
ServiceTokenCreateParams,
- ServiceTokenReplaceParams,
+ ServiceTokenUpdateParams,
ServiceTokens,
} from './service-tokens';
export {
TagCreateResponse,
+ TagUpdateResponse,
TagListResponse,
TagDeleteResponse,
TagGetResponse,
- TagReplaceResponse,
TagCreateParams,
- TagReplaceParams,
+ TagUpdateParams,
Tags,
} from './tags';
export { UserListResponse, Users } from './users/index';
diff --git a/src/resources/access/keys.ts b/src/resources/access/keys.ts
index bcfc3e41c7..8f869229f2 100644
--- a/src/resources/access/keys.ts
+++ b/src/resources/access/keys.ts
@@ -6,27 +6,27 @@ import * as KeysAPI from 'cloudflare/resources/access/keys';
export class Keys extends APIResource {
/**
- * Gets the Access key rotation settings for an account.
+ * Updates the Access key rotation settings for an account.
*/
- list(identifier: string, options?: Core.RequestOptions): Core.APIPromise {
+ update(
+ identifier: string,
+ body: KeyUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
return (
- this._client.get(`/accounts/${identifier}/access/keys`, options) as Core.APIPromise<{
- result: KeyListResponse;
+ this._client.put(`/accounts/${identifier}/access/keys`, { body, ...options }) as Core.APIPromise<{
+ result: KeyUpdateResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Updates the Access key rotation settings for an account.
+ * Gets the Access key rotation settings for an account.
*/
- replace(
- identifier: string,
- body: KeyReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
+ list(identifier: string, options?: Core.RequestOptions): Core.APIPromise {
return (
- this._client.put(`/accounts/${identifier}/access/keys`, { body, ...options }) as Core.APIPromise<{
- result: KeyReplaceResponse;
+ this._client.get(`/accounts/${identifier}/access/keys`, options) as Core.APIPromise<{
+ result: KeyListResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -43,13 +43,13 @@ export class Keys extends APIResource {
}
}
-export type KeyListResponse = unknown | string;
+export type KeyUpdateResponse = unknown | string;
-export type KeyReplaceResponse = unknown | string;
+export type KeyListResponse = unknown | string;
export type KeyRotateResponse = unknown | string;
-export interface KeyReplaceParams {
+export interface KeyUpdateParams {
/**
* The number of days between key rotations.
*/
@@ -57,8 +57,8 @@ export interface KeyReplaceParams {
}
export namespace Keys {
+ export import KeyUpdateResponse = KeysAPI.KeyUpdateResponse;
export import KeyListResponse = KeysAPI.KeyListResponse;
- export import KeyReplaceResponse = KeysAPI.KeyReplaceResponse;
export import KeyRotateResponse = KeysAPI.KeyRotateResponse;
- export import KeyReplaceParams = KeysAPI.KeyReplaceParams;
+ export import KeyUpdateParams = KeysAPI.KeyUpdateParams;
}
diff --git a/src/resources/access/organizations.ts b/src/resources/access/organizations.ts
index 527089807a..f82f8fa79b 100644
--- a/src/resources/access/organizations.ts
+++ b/src/resources/access/organizations.ts
@@ -23,35 +23,35 @@ export class Organizations extends APIResource {
}
/**
- * Returns the configuration for your Zero Trust organization.
+ * Updates the configuration for your Zero Trust organization.
*/
- list(
+ update(
accountOrZone: string,
accountOrZoneId: string,
+ body: OrganizationUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.get(
- `/${accountOrZone}/${accountOrZoneId}/access/organizations`,
- options,
- ) as Core.APIPromise<{ result: OrganizationListResponse }>
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/organizations`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: OrganizationUpdateResponse }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Updates the configuration for your Zero Trust organization.
+ * Returns the configuration for your Zero Trust organization.
*/
- replace(
+ list(
accountOrZone: string,
accountOrZoneId: string,
- body: OrganizationReplaceParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/organizations`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: OrganizationReplaceResponse }>
+ this._client.get(
+ `/${accountOrZone}/${accountOrZoneId}/access/organizations`,
+ options,
+ ) as Core.APIPromise<{ result: OrganizationListResponse }>
)._thenUnwrap((obj) => obj.result);
}
@@ -179,7 +179,7 @@ export namespace OrganizationCreateResponse {
}
}
-export interface OrganizationListResponse {
+export interface OrganizationUpdateResponse {
/**
* When set to true, users can authenticate via WARP for any application in your
* organization. Application settings will take precedence over this value.
@@ -199,7 +199,7 @@ export interface OrganizationListResponse {
created_at?: string;
- custom_pages?: OrganizationListResponse.CustomPages;
+ custom_pages?: OrganizationUpdateResponse.CustomPages;
/**
* Lock all settings as Read-Only in the Dashboard, regardless of user permission.
@@ -207,7 +207,7 @@ export interface OrganizationListResponse {
*/
is_ui_read_only?: boolean;
- login_design?: OrganizationListResponse.LoginDesign;
+ login_design?: OrganizationUpdateResponse.LoginDesign;
/**
* The name of your Zero Trust organization.
@@ -243,7 +243,7 @@ export interface OrganizationListResponse {
warp_auth_session_duration?: string;
}
-export namespace OrganizationListResponse {
+export namespace OrganizationUpdateResponse {
export interface CustomPages {
/**
* The uid of the custom page to use when a user is denied access after failing a
@@ -285,7 +285,7 @@ export namespace OrganizationListResponse {
}
}
-export interface OrganizationReplaceResponse {
+export interface OrganizationListResponse {
/**
* When set to true, users can authenticate via WARP for any application in your
* organization. Application settings will take precedence over this value.
@@ -305,7 +305,7 @@ export interface OrganizationReplaceResponse {
created_at?: string;
- custom_pages?: OrganizationReplaceResponse.CustomPages;
+ custom_pages?: OrganizationListResponse.CustomPages;
/**
* Lock all settings as Read-Only in the Dashboard, regardless of user permission.
@@ -313,7 +313,7 @@ export interface OrganizationReplaceResponse {
*/
is_ui_read_only?: boolean;
- login_design?: OrganizationReplaceResponse.LoginDesign;
+ login_design?: OrganizationListResponse.LoginDesign;
/**
* The name of your Zero Trust organization.
@@ -349,7 +349,7 @@ export interface OrganizationReplaceResponse {
warp_auth_session_duration?: string;
}
-export namespace OrganizationReplaceResponse {
+export namespace OrganizationListResponse {
export interface CustomPages {
/**
* The uid of the custom page to use when a user is denied access after failing a
@@ -480,7 +480,7 @@ export namespace OrganizationCreateParams {
}
}
-export interface OrganizationReplaceParams {
+export interface OrganizationUpdateParams {
/**
* When set to true, users can authenticate via WARP for any application in your
* organization. Application settings will take precedence over this value.
@@ -498,7 +498,7 @@ export interface OrganizationReplaceParams {
*/
auto_redirect_to_identity?: boolean;
- custom_pages?: OrganizationReplaceParams.CustomPages;
+ custom_pages?: OrganizationUpdateParams.CustomPages;
/**
* Lock all settings as Read-Only in the Dashboard, regardless of user permission.
@@ -506,7 +506,7 @@ export interface OrganizationReplaceParams {
*/
is_ui_read_only?: boolean;
- login_design?: OrganizationReplaceParams.LoginDesign;
+ login_design?: OrganizationUpdateParams.LoginDesign;
/**
* The name of your Zero Trust organization.
@@ -540,7 +540,7 @@ export interface OrganizationReplaceParams {
warp_auth_session_duration?: string;
}
-export namespace OrganizationReplaceParams {
+export namespace OrganizationUpdateParams {
export interface CustomPages {
/**
* The uid of the custom page to use when a user is denied access after failing a
@@ -591,10 +591,10 @@ export interface OrganizationRevokeUsersParams {
export namespace Organizations {
export import OrganizationCreateResponse = OrganizationsAPI.OrganizationCreateResponse;
+ export import OrganizationUpdateResponse = OrganizationsAPI.OrganizationUpdateResponse;
export import OrganizationListResponse = OrganizationsAPI.OrganizationListResponse;
- export import OrganizationReplaceResponse = OrganizationsAPI.OrganizationReplaceResponse;
export import OrganizationRevokeUsersResponse = OrganizationsAPI.OrganizationRevokeUsersResponse;
export import OrganizationCreateParams = OrganizationsAPI.OrganizationCreateParams;
- export import OrganizationReplaceParams = OrganizationsAPI.OrganizationReplaceParams;
+ export import OrganizationUpdateParams = OrganizationsAPI.OrganizationUpdateParams;
export import OrganizationRevokeUsersParams = OrganizationsAPI.OrganizationRevokeUsersParams;
}
diff --git a/src/resources/access/seats.ts b/src/resources/access/seats.ts
index 536e097d0e..51be553768 100644
--- a/src/resources/access/seats.ts
+++ b/src/resources/access/seats.ts
@@ -9,23 +9,23 @@ export class Seats extends APIResource {
* Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat`
* are set to false.
*/
- update(
+ edit(
identifier: string,
- body: SeatUpdateParams,
+ body: SeatEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.patch(`/accounts/${identifier}/access/seats`, { body, ...options }) as Core.APIPromise<{
- result: SeatUpdateResponse | null;
+ result: SeatEditResponse | null;
}>
)._thenUnwrap((obj) => obj.result);
}
}
-export type SeatUpdateResponse = Array;
+export type SeatEditResponse = Array;
-export namespace SeatUpdateResponse {
- export interface SeatUpdateResponseItem {
+export namespace SeatEditResponse {
+ export interface SeatEditResponseItem {
/**
* True if the seat is part of Access.
*/
@@ -47,9 +47,9 @@ export namespace SeatUpdateResponse {
}
}
-export type SeatUpdateParams = Array;
+export type SeatEditParams = Array;
-export namespace SeatUpdateParams {
+export namespace SeatEditParams {
export interface Body {
/**
* True if the seat is part of Access.
@@ -64,6 +64,6 @@ export namespace SeatUpdateParams {
}
export namespace Seats {
- export import SeatUpdateResponse = SeatsAPI.SeatUpdateResponse;
- export import SeatUpdateParams = SeatsAPI.SeatUpdateParams;
+ export import SeatEditResponse = SeatsAPI.SeatEditResponse;
+ export import SeatEditParams = SeatsAPI.SeatEditParams;
}
diff --git a/src/resources/access/service-tokens.ts b/src/resources/access/service-tokens.ts
index c322e5a4cf..c3c2f7ed56 100644
--- a/src/resources/access/service-tokens.ts
+++ b/src/resources/access/service-tokens.ts
@@ -24,6 +24,24 @@ export class ServiceTokens extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a configured service token.
+ */
+ update(
+ accountOrZone: string,
+ accountOrZoneId: string,
+ uuid: string,
+ body: ServiceTokenUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/service_tokens/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: ServiceTokenUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all service tokens.
*/
@@ -73,24 +91,6 @@ export class ServiceTokens extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Updates a configured service token.
- */
- replace(
- accountOrZone: string,
- accountOrZoneId: string,
- uuid: string,
- body: ServiceTokenReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/service_tokens/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: ServiceTokenReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Generates a new Client Secret for a service token and revokes the old one.
*/
@@ -143,6 +143,35 @@ export interface ServiceTokenCreateResponse {
updated_at?: string;
}
+export interface ServiceTokenUpdateResponse {
+ /**
+ * The ID of the service token.
+ */
+ id?: unknown;
+
+ /**
+ * The Client ID for the service token. Access will check for this value in the
+ * `CF-Access-Client-ID` request header.
+ */
+ client_id?: string;
+
+ created_at?: string;
+
+ /**
+ * The duration for how long the service token will be valid. Must be in the format
+ * `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
+ * default is 1 year in hours (8760h).
+ */
+ duration?: string;
+
+ /**
+ * The name of the service token.
+ */
+ name?: string;
+
+ updated_at?: string;
+}
+
export type ServiceTokenListResponse = Array;
export namespace ServiceTokenListResponse {
@@ -234,35 +263,6 @@ export interface ServiceTokenRefreshResponse {
updated_at?: string;
}
-export interface ServiceTokenReplaceResponse {
- /**
- * The ID of the service token.
- */
- id?: unknown;
-
- /**
- * The Client ID for the service token. Access will check for this value in the
- * `CF-Access-Client-ID` request header.
- */
- client_id?: string;
-
- created_at?: string;
-
- /**
- * The duration for how long the service token will be valid. Must be in the format
- * `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
- * default is 1 year in hours (8760h).
- */
- duration?: string;
-
- /**
- * The name of the service token.
- */
- name?: string;
-
- updated_at?: string;
-}
-
export interface ServiceTokenRotateResponse {
/**
* The ID of the service token.
@@ -312,7 +312,7 @@ export interface ServiceTokenCreateParams {
duration?: string;
}
-export interface ServiceTokenReplaceParams {
+export interface ServiceTokenUpdateParams {
/**
* The duration for how long the service token will be valid. Must be in the format
* `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
@@ -328,11 +328,11 @@ export interface ServiceTokenReplaceParams {
export namespace ServiceTokens {
export import ServiceTokenCreateResponse = ServiceTokensAPI.ServiceTokenCreateResponse;
+ export import ServiceTokenUpdateResponse = ServiceTokensAPI.ServiceTokenUpdateResponse;
export import ServiceTokenListResponse = ServiceTokensAPI.ServiceTokenListResponse;
export import ServiceTokenDeleteResponse = ServiceTokensAPI.ServiceTokenDeleteResponse;
export import ServiceTokenRefreshResponse = ServiceTokensAPI.ServiceTokenRefreshResponse;
- export import ServiceTokenReplaceResponse = ServiceTokensAPI.ServiceTokenReplaceResponse;
export import ServiceTokenRotateResponse = ServiceTokensAPI.ServiceTokenRotateResponse;
export import ServiceTokenCreateParams = ServiceTokensAPI.ServiceTokenCreateParams;
- export import ServiceTokenReplaceParams = ServiceTokensAPI.ServiceTokenReplaceParams;
+ export import ServiceTokenUpdateParams = ServiceTokensAPI.ServiceTokenUpdateParams;
}
diff --git a/src/resources/access/tags.ts b/src/resources/access/tags.ts
index 6d963a4b38..c1222e4505 100644
--- a/src/resources/access/tags.ts
+++ b/src/resources/access/tags.ts
@@ -20,6 +20,23 @@ export class Tags extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update a tag
+ */
+ update(
+ identifier: string,
+ tagName: string,
+ body: TagUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${identifier}/access/tags/${tagName}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: TagUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* List tags
*/
@@ -56,29 +73,31 @@ export class Tags extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
+}
+/**
+ * A tag
+ */
+export interface TagCreateResponse {
/**
- * Update a tag
+ * The name of the tag
*/
- replace(
- identifier: string,
- tagName: string,
- body: TagReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${identifier}/access/tags/${tagName}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: TagReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
+ name: string;
+
+ /**
+ * The number of applications that have this tag
+ */
+ app_count?: number;
+
+ created_at?: string;
+
+ updated_at?: string;
}
/**
* A tag
*/
-export interface TagCreateResponse {
+export interface TagUpdateResponse {
/**
* The name of the tag
*/
@@ -143,25 +162,6 @@ export interface TagGetResponse {
updated_at?: string;
}
-/**
- * A tag
- */
-export interface TagReplaceResponse {
- /**
- * The name of the tag
- */
- name: string;
-
- /**
- * The number of applications that have this tag
- */
- app_count?: number;
-
- created_at?: string;
-
- updated_at?: string;
-}
-
export interface TagCreateParams {
/**
* The name of the tag
@@ -169,7 +169,7 @@ export interface TagCreateParams {
name: string;
}
-export interface TagReplaceParams {
+export interface TagUpdateParams {
/**
* The name of the tag
*/
@@ -178,10 +178,10 @@ export interface TagReplaceParams {
export namespace Tags {
export import TagCreateResponse = TagsAPI.TagCreateResponse;
+ export import TagUpdateResponse = TagsAPI.TagUpdateResponse;
export import TagListResponse = TagsAPI.TagListResponse;
export import TagDeleteResponse = TagsAPI.TagDeleteResponse;
export import TagGetResponse = TagsAPI.TagGetResponse;
- export import TagReplaceResponse = TagsAPI.TagReplaceResponse;
export import TagCreateParams = TagsAPI.TagCreateParams;
- export import TagReplaceParams = TagsAPI.TagReplaceParams;
+ export import TagUpdateParams = TagsAPI.TagUpdateParams;
}
diff --git a/src/resources/account-members.ts b/src/resources/account-members.ts
index f029c12f58..0d9d415597 100644
--- a/src/resources/account-members.ts
+++ b/src/resources/account-members.ts
@@ -22,6 +22,23 @@ export class AccountMembers extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Modify an account member.
+ */
+ update(
+ accountId: unknown,
+ memberId: string,
+ body: AccountMemberUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountId}/members/${memberId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: AccountMemberUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* List all members of an account.
*/
@@ -78,23 +95,6 @@ export class AccountMembers extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Modify an account member.
- */
- replace(
- accountId: unknown,
- memberId: string,
- body: AccountMemberReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountId}/members/${memberId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: AccountMemberReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export class AccountMemberListResponsesV4PagePaginationArray extends V4PagePaginationArray {}
@@ -271,65 +271,7 @@ export namespace AccountMemberCreateResponse {
}
}
-export interface AccountMemberListResponse {
- /**
- * Identifier
- */
- id: string;
-
- /**
- * The contact email address of the user.
- */
- email: string;
-
- /**
- * Member Name.
- */
- name: string | null;
-
- /**
- * Roles assigned to this Member.
- */
- roles: Array;
-
- /**
- * A member's status in the organization.
- */
- status: 'accepted' | 'invited';
-}
-
-export namespace AccountMemberListResponse {
- 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 interface AccountMemberDeleteResponse {
- /**
- * Identifier
- */
- id: string;
-}
-
-export interface AccountMemberGetResponse {
+export interface AccountMemberUpdateResponse {
/**
* Membership identifier tag.
*/
@@ -338,14 +280,14 @@ export interface AccountMemberGetResponse {
/**
* Roles assigned to this member.
*/
- roles: Array;
+ roles: Array;
status: unknown;
- user: AccountMemberGetResponse.User;
+ user: AccountMemberUpdateResponse.User;
}
-export namespace AccountMemberGetResponse {
+export namespace AccountMemberUpdateResponse {
export interface Role {
/**
* Role identifier tag.
@@ -496,7 +438,65 @@ export namespace AccountMemberGetResponse {
}
}
-export interface AccountMemberReplaceResponse {
+export interface AccountMemberListResponse {
+ /**
+ * Identifier
+ */
+ id: string;
+
+ /**
+ * The contact email address of the user.
+ */
+ email: string;
+
+ /**
+ * Member Name.
+ */
+ name: string | null;
+
+ /**
+ * Roles assigned to this Member.
+ */
+ roles: Array;
+
+ /**
+ * A member's status in the organization.
+ */
+ status: 'accepted' | 'invited';
+}
+
+export namespace AccountMemberListResponse {
+ 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 interface AccountMemberDeleteResponse {
+ /**
+ * Identifier
+ */
+ id: string;
+}
+
+export interface AccountMemberGetResponse {
/**
* Membership identifier tag.
*/
@@ -505,14 +505,14 @@ export interface AccountMemberReplaceResponse {
/**
* Roles assigned to this member.
*/
- roles: Array;
+ roles: Array;
status: unknown;
- user: AccountMemberReplaceResponse.User;
+ user: AccountMemberGetResponse.User;
}
-export namespace AccountMemberReplaceResponse {
+export namespace AccountMemberGetResponse {
export interface Role {
/**
* Role identifier tag.
@@ -677,6 +677,22 @@ export interface AccountMemberCreateParams {
status?: 'accepted' | 'pending';
}
+export interface AccountMemberUpdateParams {
+ /**
+ * Roles assigned to this member.
+ */
+ roles: Array;
+}
+
+export namespace AccountMemberUpdateParams {
+ export interface Role {
+ /**
+ * Role identifier tag.
+ */
+ id: string;
+ }
+}
+
export interface AccountMemberListParams extends V4PagePaginationArrayParams {
/**
* Direction to order results.
@@ -694,30 +710,14 @@ export interface AccountMemberListParams extends V4PagePaginationArrayParams {
status?: 'accepted' | 'pending' | 'rejected';
}
-export interface AccountMemberReplaceParams {
- /**
- * Roles assigned to this member.
- */
- roles: Array;
-}
-
-export namespace AccountMemberReplaceParams {
- export interface Role {
- /**
- * Role identifier tag.
- */
- id: string;
- }
-}
-
export namespace AccountMembers {
export import AccountMemberCreateResponse = AccountMembersAPI.AccountMemberCreateResponse;
+ export import AccountMemberUpdateResponse = AccountMembersAPI.AccountMemberUpdateResponse;
export import AccountMemberListResponse = AccountMembersAPI.AccountMemberListResponse;
export import AccountMemberDeleteResponse = AccountMembersAPI.AccountMemberDeleteResponse;
export import AccountMemberGetResponse = AccountMembersAPI.AccountMemberGetResponse;
- export import AccountMemberReplaceResponse = AccountMembersAPI.AccountMemberReplaceResponse;
export import AccountMemberListResponsesV4PagePaginationArray = AccountMembersAPI.AccountMemberListResponsesV4PagePaginationArray;
export import AccountMemberCreateParams = AccountMembersAPI.AccountMemberCreateParams;
+ export import AccountMemberUpdateParams = AccountMembersAPI.AccountMemberUpdateParams;
export import AccountMemberListParams = AccountMembersAPI.AccountMemberListParams;
- export import AccountMemberReplaceParams = AccountMembersAPI.AccountMemberReplaceParams;
}
diff --git a/src/resources/accounts.ts b/src/resources/accounts.ts
index 7a4a57df7a..77daa91a59 100644
--- a/src/resources/accounts.ts
+++ b/src/resources/accounts.ts
@@ -7,6 +7,21 @@ import * as AccountsAPI from 'cloudflare/resources/accounts';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export class Accounts extends APIResource {
+ /**
+ * Update an existing account.
+ */
+ update(
+ accountId: unknown,
+ body: AccountUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountId}`, { body, ...options }) as Core.APIPromise<{
+ result: AccountUpdateResponse;
+ }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* List all accounts you have ownership or verified access to.
*/
@@ -38,39 +53,17 @@ export class Accounts extends APIResource {
this._client.get(`/accounts/${accountId}`, options) as Core.APIPromise<{ result: AccountGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Update an existing account.
- */
- replace(
- accountId: unknown,
- body: AccountReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountId}`, { body, ...options }) as Core.APIPromise<{
- result: AccountReplaceResponse;
- }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export class AccountListResponsesV4PagePaginationArray extends V4PagePaginationArray {}
+export type AccountUpdateResponse = unknown | string | null;
+
export type AccountListResponse = unknown;
export type AccountGetResponse = unknown | string | null;
-export type AccountReplaceResponse = unknown | string | null;
-
-export interface AccountListParams extends V4PagePaginationArrayParams {
- /**
- * Direction to order results.
- */
- direction?: 'asc' | 'desc';
-}
-
-export interface AccountReplaceParams {
+export interface AccountUpdateParams {
/**
* Account name
*/
@@ -79,10 +72,10 @@ export interface AccountReplaceParams {
/**
* Account settings
*/
- settings?: AccountReplaceParams.Settings;
+ settings?: AccountUpdateParams.Settings;
}
-export namespace AccountReplaceParams {
+export namespace AccountUpdateParams {
/**
* Account settings
*/
@@ -117,11 +110,18 @@ export namespace AccountReplaceParams {
}
}
+export interface AccountListParams extends V4PagePaginationArrayParams {
+ /**
+ * Direction to order results.
+ */
+ direction?: 'asc' | 'desc';
+}
+
export namespace Accounts {
+ export import AccountUpdateResponse = AccountsAPI.AccountUpdateResponse;
export import AccountListResponse = AccountsAPI.AccountListResponse;
export import AccountGetResponse = AccountsAPI.AccountGetResponse;
- export import AccountReplaceResponse = AccountsAPI.AccountReplaceResponse;
export import AccountListResponsesV4PagePaginationArray = AccountsAPI.AccountListResponsesV4PagePaginationArray;
+ export import AccountUpdateParams = AccountsAPI.AccountUpdateParams;
export import AccountListParams = AccountsAPI.AccountListParams;
- export import AccountReplaceParams = AccountsAPI.AccountReplaceParams;
}
diff --git a/src/resources/activation-checks.ts b/src/resources/activation-checks.ts
index 1121c78314..ef7251bcad 100644
--- a/src/resources/activation-checks.ts
+++ b/src/resources/activation-checks.ts
@@ -9,16 +9,16 @@ export class ActivationChecks extends APIResource {
* Triggeres a new activation check for a PENDING Zone. This can be triggered every
* 5 min for paygo/ent customers, every hour for FREE Zones.
*/
- replace(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
+ update(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
return (
this._client.put(`/zones/${zoneId}/activation_check`, options) as Core.APIPromise<{
- result: ActivationCheckReplaceResponse;
+ result: ActivationCheckUpdateResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
-export interface ActivationCheckReplaceResponse {
+export interface ActivationCheckUpdateResponse {
/**
* Identifier
*/
@@ -26,5 +26,5 @@ export interface ActivationCheckReplaceResponse {
}
export namespace ActivationChecks {
- export import ActivationCheckReplaceResponse = ActivationChecksAPI.ActivationCheckReplaceResponse;
+ export import ActivationCheckUpdateResponse = ActivationChecksAPI.ActivationCheckUpdateResponse;
}
diff --git a/src/resources/addresses/address-maps/accounts.ts b/src/resources/addresses/address-maps/accounts.ts
index 09615127c6..1249583725 100644
--- a/src/resources/addresses/address-maps/accounts.ts
+++ b/src/resources/addresses/address-maps/accounts.ts
@@ -6,43 +6,43 @@ import * as AccountsAPI from 'cloudflare/resources/addresses/address-maps/accoun
export class Accounts extends APIResource {
/**
- * Remove an account as a member of a particular address map.
+ * Add an account as a member of a particular address map.
*/
- delete(
+ update(
accountId: string,
addressMapId: string,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.delete(
+ this._client.put(
`/accounts/${accountId}/addressing/address_maps/${addressMapId}/accounts/:account_id`,
options,
- ) as Core.APIPromise<{ result: AccountDeleteResponse | null }>
+ ) as Core.APIPromise<{ result: AccountUpdateResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Add an account as a member of a particular address map.
+ * Remove an account as a member of a particular address map.
*/
- replace(
+ delete(
accountId: string,
addressMapId: string,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.put(
+ this._client.delete(
`/accounts/${accountId}/addressing/address_maps/${addressMapId}/accounts/:account_id`,
options,
- ) as Core.APIPromise<{ result: AccountReplaceResponse | null }>
+ ) as Core.APIPromise<{ result: AccountDeleteResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type AccountDeleteResponse = unknown | Array | string;
+export type AccountUpdateResponse = unknown | Array | string;
-export type AccountReplaceResponse = unknown | Array | string;
+export type AccountDeleteResponse = unknown | Array | string;
export namespace Accounts {
+ export import AccountUpdateResponse = AccountsAPI.AccountUpdateResponse;
export import AccountDeleteResponse = AccountsAPI.AccountDeleteResponse;
- export import AccountReplaceResponse = AccountsAPI.AccountReplaceResponse;
}
diff --git a/src/resources/addresses/address-maps/address-maps.ts b/src/resources/addresses/address-maps/address-maps.ts
index d9ed094f63..3ce08cfdc6 100644
--- a/src/resources/addresses/address-maps/address-maps.ts
+++ b/src/resources/addresses/address-maps/address-maps.ts
@@ -28,23 +28,6 @@ export class AddressMaps extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Modify properties of an address map owned by the account.
- */
- update(
- accountId: string,
- addressMapId: string,
- body: AddressMapUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(`/accounts/${accountId}/addressing/address_maps/${addressMapId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: AddressMapUpdateResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* List all address maps owned by the account.
*/
@@ -73,6 +56,23 @@ export class AddressMaps extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Modify properties of an address map owned by the account.
+ */
+ edit(
+ accountId: string,
+ addressMapId: string,
+ body: AddressMapEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(`/accounts/${accountId}/addressing/address_maps/${addressMapId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: AddressMapEditResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Show a particular address map owned by the account.
*/
@@ -175,50 +175,6 @@ export namespace AddressMapCreateResponse {
}
}
-export interface AddressMapUpdateResponse {
- /**
- * Identifier
- */
- id?: string;
-
- /**
- * If set to false, then the Address Map cannot be deleted via API. This is true
- * for Cloudflare-managed maps.
- */
- can_delete?: boolean;
-
- /**
- * If set to false, then the IPs on the Address Map cannot be modified via the API.
- * This is true for Cloudflare-managed maps.
- */
- can_modify_ips?: boolean;
-
- created_at?: string;
-
- /**
- * If you have legacy TLS clients which do not send the TLS server name indicator,
- * then you can specify one default SNI on the map. If Cloudflare receives a TLS
- * handshake from a client without an SNI, it will respond with the default SNI on
- * those IPs. The default SNI can be any valid zone or subdomain owned by the
- * account.
- */
- default_sni?: string | null;
-
- /**
- * An optional description field which may be used to describe the types of IPs or
- * zones on the map.
- */
- description?: string | null;
-
- /**
- * Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
- * with IP addresses on an Address Map until the map is enabled.
- */
- enabled?: boolean | null;
-
- modified_at?: string;
-}
-
export type AddressMapListResponse = Array;
export namespace AddressMapListResponse {
@@ -269,6 +225,50 @@ export namespace AddressMapListResponse {
export type AddressMapDeleteResponse = unknown | Array | string;
+export interface AddressMapEditResponse {
+ /**
+ * Identifier
+ */
+ id?: string;
+
+ /**
+ * If set to false, then the Address Map cannot be deleted via API. This is true
+ * for Cloudflare-managed maps.
+ */
+ can_delete?: boolean;
+
+ /**
+ * If set to false, then the IPs on the Address Map cannot be modified via the API.
+ * This is true for Cloudflare-managed maps.
+ */
+ can_modify_ips?: boolean;
+
+ created_at?: string;
+
+ /**
+ * If you have legacy TLS clients which do not send the TLS server name indicator,
+ * then you can specify one default SNI on the map. If Cloudflare receives a TLS
+ * handshake from a client without an SNI, it will respond with the default SNI on
+ * those IPs. The default SNI can be any valid zone or subdomain owned by the
+ * account.
+ */
+ default_sni?: string | null;
+
+ /**
+ * An optional description field which may be used to describe the types of IPs or
+ * zones on the map.
+ */
+ description?: string | null;
+
+ /**
+ * Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
+ * with IP addresses on an Address Map until the map is enabled.
+ */
+ enabled?: boolean | null;
+
+ modified_at?: string;
+}
+
export interface AddressMapGetResponse {
/**
* Identifier
@@ -368,7 +368,7 @@ export interface AddressMapCreateParams {
enabled?: boolean | null;
}
-export interface AddressMapUpdateParams {
+export interface AddressMapEditParams {
/**
* If you have legacy TLS clients which do not send the TLS server name indicator,
* then you can specify one default SNI on the map. If Cloudflare receives a TLS
@@ -393,19 +393,19 @@ export interface AddressMapUpdateParams {
export namespace AddressMaps {
export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse;
- export import AddressMapUpdateResponse = AddressMapsAPI.AddressMapUpdateResponse;
export import AddressMapListResponse = AddressMapsAPI.AddressMapListResponse;
export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse;
+ export import AddressMapEditResponse = AddressMapsAPI.AddressMapEditResponse;
export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse;
export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams;
- export import AddressMapUpdateParams = AddressMapsAPI.AddressMapUpdateParams;
+ export import AddressMapEditParams = AddressMapsAPI.AddressMapEditParams;
export import Accounts = AccountsAPI.Accounts;
+ export import AccountUpdateResponse = AccountsAPI.AccountUpdateResponse;
export import AccountDeleteResponse = AccountsAPI.AccountDeleteResponse;
- export import AccountReplaceResponse = AccountsAPI.AccountReplaceResponse;
export import IPs = IPsAPI.IPs;
+ export import IPUpdateResponse = IPsAPI.IPUpdateResponse;
export import IPDeleteResponse = IPsAPI.IPDeleteResponse;
- export import IPReplaceResponse = IPsAPI.IPReplaceResponse;
export import Zones = ZonesAPI.Zones;
+ export import ZoneUpdateResponse = ZonesAPI.ZoneUpdateResponse;
export import ZoneDeleteResponse = ZonesAPI.ZoneDeleteResponse;
- export import ZoneReplaceResponse = ZonesAPI.ZoneReplaceResponse;
}
diff --git a/src/resources/addresses/address-maps/index.ts b/src/resources/addresses/address-maps/index.ts
index 74261c09ae..55c30479f7 100644
--- a/src/resources/addresses/address-maps/index.ts
+++ b/src/resources/addresses/address-maps/index.ts
@@ -1,15 +1,15 @@
// File generated from our OpenAPI spec by Stainless.
-export { AccountDeleteResponse, AccountReplaceResponse, Accounts } from './accounts';
+export { AccountUpdateResponse, AccountDeleteResponse, Accounts } from './accounts';
export {
AddressMapCreateResponse,
- AddressMapUpdateResponse,
AddressMapListResponse,
AddressMapDeleteResponse,
+ AddressMapEditResponse,
AddressMapGetResponse,
AddressMapCreateParams,
- AddressMapUpdateParams,
+ AddressMapEditParams,
AddressMaps,
} from './address-maps';
-export { IPDeleteResponse, IPReplaceResponse, IPs } from './ips';
-export { ZoneDeleteResponse, ZoneReplaceResponse, Zones } from './zones';
+export { IPUpdateResponse, IPDeleteResponse, IPs } from './ips';
+export { ZoneUpdateResponse, ZoneDeleteResponse, Zones } from './zones';
diff --git a/src/resources/addresses/address-maps/ips.ts b/src/resources/addresses/address-maps/ips.ts
index feed34a51b..d34941a5d3 100644
--- a/src/resources/addresses/address-maps/ips.ts
+++ b/src/resources/addresses/address-maps/ips.ts
@@ -6,45 +6,45 @@ import * as IPsAPI from 'cloudflare/resources/addresses/address-maps/ips';
export class IPs extends APIResource {
/**
- * Remove an IP from a particular address map.
+ * Add an IP from a prefix owned by the account to a particular address map.
*/
- delete(
+ update(
accountId: string,
addressMapId: string,
ipAddress: string,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.delete(
+ this._client.put(
`/accounts/${accountId}/addressing/address_maps/${addressMapId}/ips/${ipAddress}`,
options,
- ) as Core.APIPromise<{ result: IPDeleteResponse | null }>
+ ) as Core.APIPromise<{ result: IPUpdateResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Add an IP from a prefix owned by the account to a particular address map.
+ * Remove an IP from a particular address map.
*/
- replace(
+ delete(
accountId: string,
addressMapId: string,
ipAddress: string,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.put(
+ this._client.delete(
`/accounts/${accountId}/addressing/address_maps/${addressMapId}/ips/${ipAddress}`,
options,
- ) as Core.APIPromise<{ result: IPReplaceResponse | null }>
+ ) as Core.APIPromise<{ result: IPDeleteResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type IPDeleteResponse = unknown | Array | string;
+export type IPUpdateResponse = unknown | Array | string;
-export type IPReplaceResponse = unknown | Array | string;
+export type IPDeleteResponse = unknown | Array | string;
export namespace IPs {
+ export import IPUpdateResponse = IPsAPI.IPUpdateResponse;
export import IPDeleteResponse = IPsAPI.IPDeleteResponse;
- export import IPReplaceResponse = IPsAPI.IPReplaceResponse;
}
diff --git a/src/resources/addresses/address-maps/zones.ts b/src/resources/addresses/address-maps/zones.ts
index 3a03d3c76e..b2fe8bd66b 100644
--- a/src/resources/addresses/address-maps/zones.ts
+++ b/src/resources/addresses/address-maps/zones.ts
@@ -6,45 +6,45 @@ import * as ZonesAPI from 'cloudflare/resources/addresses/address-maps/zones';
export class Zones extends APIResource {
/**
- * Remove a zone as a member of a particular address map.
+ * Add a zone as a member of a particular address map.
*/
- delete(
+ update(
accountId: string,
addressMapId: string,
zoneId: string,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.delete(
+ this._client.put(
`/accounts/${accountId}/addressing/address_maps/${addressMapId}/zones/${zoneId}`,
options,
- ) as Core.APIPromise<{ result: ZoneDeleteResponse | null }>
+ ) as Core.APIPromise<{ result: ZoneUpdateResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Add a zone as a member of a particular address map.
+ * Remove a zone as a member of a particular address map.
*/
- replace(
+ delete(
accountId: string,
addressMapId: string,
zoneId: string,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.put(
+ this._client.delete(
`/accounts/${accountId}/addressing/address_maps/${addressMapId}/zones/${zoneId}`,
options,
- ) as Core.APIPromise<{ result: ZoneReplaceResponse | null }>
+ ) as Core.APIPromise<{ result: ZoneDeleteResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type ZoneDeleteResponse = unknown | Array | string;
+export type ZoneUpdateResponse = unknown | Array | string;
-export type ZoneReplaceResponse = unknown | Array | string;
+export type ZoneDeleteResponse = unknown | Array | string;
export namespace Zones {
+ export import ZoneUpdateResponse = ZonesAPI.ZoneUpdateResponse;
export import ZoneDeleteResponse = ZonesAPI.ZoneDeleteResponse;
- export import ZoneReplaceResponse = ZonesAPI.ZoneReplaceResponse;
}
diff --git a/src/resources/addresses/addresses.ts b/src/resources/addresses/addresses.ts
index 6725683ca1..1c1ba328c4 100644
--- a/src/resources/addresses/addresses.ts
+++ b/src/resources/addresses/addresses.ts
@@ -14,21 +14,21 @@ export class Addresses extends APIResource {
export namespace Addresses {
export import AddressMaps = AddressMapsAPI.AddressMaps;
export import AddressMapCreateResponse = AddressMapsAPI.AddressMapCreateResponse;
- export import AddressMapUpdateResponse = AddressMapsAPI.AddressMapUpdateResponse;
export import AddressMapListResponse = AddressMapsAPI.AddressMapListResponse;
export import AddressMapDeleteResponse = AddressMapsAPI.AddressMapDeleteResponse;
+ export import AddressMapEditResponse = AddressMapsAPI.AddressMapEditResponse;
export import AddressMapGetResponse = AddressMapsAPI.AddressMapGetResponse;
export import AddressMapCreateParams = AddressMapsAPI.AddressMapCreateParams;
- export import AddressMapUpdateParams = AddressMapsAPI.AddressMapUpdateParams;
+ export import AddressMapEditParams = AddressMapsAPI.AddressMapEditParams;
export import LoaDocuments = LoaDocumentsAPI.LoaDocuments;
export import LoaDocumentCreateResponse = LoaDocumentsAPI.LoaDocumentCreateResponse;
export import LoaDocumentCreateParams = LoaDocumentsAPI.LoaDocumentCreateParams;
export import Prefixes = PrefixesAPI.Prefixes;
export import PrefixCreateResponse = PrefixesAPI.PrefixCreateResponse;
- export import PrefixUpdateResponse = PrefixesAPI.PrefixUpdateResponse;
export import PrefixListResponse = PrefixesAPI.PrefixListResponse;
export import PrefixDeleteResponse = PrefixesAPI.PrefixDeleteResponse;
+ export import PrefixEditResponse = PrefixesAPI.PrefixEditResponse;
export import PrefixGetResponse = PrefixesAPI.PrefixGetResponse;
export import PrefixCreateParams = PrefixesAPI.PrefixCreateParams;
- export import PrefixUpdateParams = PrefixesAPI.PrefixUpdateParams;
+ export import PrefixEditParams = PrefixesAPI.PrefixEditParams;
}
diff --git a/src/resources/addresses/index.ts b/src/resources/addresses/index.ts
index 0ac3f30ba1..a8ae2707eb 100644
--- a/src/resources/addresses/index.ts
+++ b/src/resources/addresses/index.ts
@@ -2,23 +2,23 @@
export {
AddressMapCreateResponse,
- AddressMapUpdateResponse,
AddressMapListResponse,
AddressMapDeleteResponse,
+ AddressMapEditResponse,
AddressMapGetResponse,
AddressMapCreateParams,
- AddressMapUpdateParams,
+ AddressMapEditParams,
AddressMaps,
} from './address-maps/index';
export { Addresses } from './addresses';
export { LoaDocumentCreateResponse, LoaDocumentCreateParams, LoaDocuments } from './loa-documents/index';
export {
PrefixCreateResponse,
- PrefixUpdateResponse,
PrefixListResponse,
PrefixDeleteResponse,
+ PrefixEditResponse,
PrefixGetResponse,
PrefixCreateParams,
- PrefixUpdateParams,
+ PrefixEditParams,
Prefixes,
} from './prefixes/index';
diff --git a/src/resources/addresses/prefixes/bgps/bgps.ts b/src/resources/addresses/prefixes/bgps/bgps.ts
index 1f361aca42..ec6de9d6d3 100644
--- a/src/resources/addresses/prefixes/bgps/bgps.ts
+++ b/src/resources/addresses/prefixes/bgps/bgps.ts
@@ -9,7 +9,7 @@ export class BGPs extends APIResource {
export namespace BGPs {
export import Statuses = StatusesAPI.Statuses;
- export import StatusUpdateResponse = StatusesAPI.StatusUpdateResponse;
+ export import StatusEditResponse = StatusesAPI.StatusEditResponse;
export import StatusGetResponse = StatusesAPI.StatusGetResponse;
- export import StatusUpdateParams = StatusesAPI.StatusUpdateParams;
+ export import StatusEditParams = StatusesAPI.StatusEditParams;
}
diff --git a/src/resources/addresses/prefixes/bgps/index.ts b/src/resources/addresses/prefixes/bgps/index.ts
index 18f1cadfd1..b69350f718 100644
--- a/src/resources/addresses/prefixes/bgps/index.ts
+++ b/src/resources/addresses/prefixes/bgps/index.ts
@@ -1,4 +1,4 @@
// File generated from our OpenAPI spec by Stainless.
export { BGPs } from './bgps';
-export { StatusUpdateResponse, StatusGetResponse, StatusUpdateParams, Statuses } from './statuses';
+export { StatusEditResponse, StatusGetResponse, StatusEditParams, Statuses } from './statuses';
diff --git a/src/resources/addresses/prefixes/bgps/statuses.ts b/src/resources/addresses/prefixes/bgps/statuses.ts
index b618ba8f9d..ed22ce855f 100644
--- a/src/resources/addresses/prefixes/bgps/statuses.ts
+++ b/src/resources/addresses/prefixes/bgps/statuses.ts
@@ -8,17 +8,17 @@ export class Statuses extends APIResource {
/**
* Advertise or withdraw BGP route for a prefix.
*/
- update(
+ edit(
accountId: string,
prefixId: string,
- body: StatusUpdateParams,
+ body: StatusEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.patch(`/accounts/${accountId}/addressing/prefixes/${prefixId}/bgp/status`, {
body,
...options,
- }) as Core.APIPromise<{ result: StatusUpdateResponse }>
+ }) as Core.APIPromise<{ result: StatusEditResponse }>
)._thenUnwrap((obj) => obj.result);
}
@@ -39,7 +39,7 @@ export class Statuses extends APIResource {
}
}
-export interface StatusUpdateResponse {
+export interface StatusEditResponse {
/**
* Enablement of prefix advertisement to the Internet.
*/
@@ -65,7 +65,7 @@ export interface StatusGetResponse {
advertised_modified_at?: string | null;
}
-export interface StatusUpdateParams {
+export interface StatusEditParams {
/**
* Enablement of prefix advertisement to the Internet.
*/
@@ -73,7 +73,7 @@ export interface StatusUpdateParams {
}
export namespace Statuses {
- export import StatusUpdateResponse = StatusesAPI.StatusUpdateResponse;
+ export import StatusEditResponse = StatusesAPI.StatusEditResponse;
export import StatusGetResponse = StatusesAPI.StatusGetResponse;
- export import StatusUpdateParams = StatusesAPI.StatusUpdateParams;
+ export import StatusEditParams = StatusesAPI.StatusEditParams;
}
diff --git a/src/resources/addresses/prefixes/index.ts b/src/resources/addresses/prefixes/index.ts
index 938cedfbe8..c583cf9c5e 100644
--- a/src/resources/addresses/prefixes/index.ts
+++ b/src/resources/addresses/prefixes/index.ts
@@ -10,11 +10,11 @@ export {
} from './delegations';
export {
PrefixCreateResponse,
- PrefixUpdateResponse,
PrefixListResponse,
PrefixDeleteResponse,
+ PrefixEditResponse,
PrefixGetResponse,
PrefixCreateParams,
- PrefixUpdateParams,
+ PrefixEditParams,
Prefixes,
} from './prefixes';
diff --git a/src/resources/addresses/prefixes/prefixes.ts b/src/resources/addresses/prefixes/prefixes.ts
index eeb31ce056..df1c25163c 100644
--- a/src/resources/addresses/prefixes/prefixes.ts
+++ b/src/resources/addresses/prefixes/prefixes.ts
@@ -26,23 +26,6 @@ export class Prefixes extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Modify the description for a prefix owned by the account.
- */
- update(
- accountId: string,
- prefixId: string,
- body: PrefixUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(`/accounts/${accountId}/addressing/prefixes/${prefixId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: PrefixUpdateResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* List all prefixes owned by the account.
*/
@@ -70,6 +53,23 @@ export class Prefixes extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Modify the description for a prefix owned by the account.
+ */
+ edit(
+ accountId: string,
+ prefixId: string,
+ body: PrefixEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(`/accounts/${accountId}/addressing/prefixes/${prefixId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: PrefixEditResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* List a particular prefix owned by the account.
*/
@@ -151,71 +151,6 @@ export interface PrefixCreateResponse {
on_demand_locked?: boolean;
}
-export interface PrefixUpdateResponse {
- /**
- * Identifier
- */
- id?: string;
-
- /**
- * Identifier
- */
- account_id?: string;
-
- /**
- * Prefix advertisement status to the Internet. This field is only not 'null' if on
- * demand is enabled.
- */
- advertised?: boolean | null;
-
- /**
- * Last time the advertisement status was changed. This field is only not 'null' if
- * on demand is enabled.
- */
- advertised_modified_at?: string | null;
-
- /**
- * Approval state of the prefix (P = pending, V = active).
- */
- approved?: string;
-
- /**
- * Autonomous System Number (ASN) the prefix will be advertised under.
- */
- asn?: number | null;
-
- /**
- * IP Prefix in Classless Inter-Domain Routing format.
- */
- cidr?: string;
-
- created_at?: string;
-
- /**
- * Description of the prefix.
- */
- description?: string;
-
- /**
- * Identifier for the uploaded LOA document.
- */
- loa_document_id?: string | null;
-
- modified_at?: string;
-
- /**
- * Whether advertisement of the prefix to the Internet may be dynamically enabled
- * or disabled.
- */
- on_demand_enabled?: boolean;
-
- /**
- * Whether advertisement status of the prefix is locked, meaning it cannot be
- * changed.
- */
- on_demand_locked?: boolean;
-}
-
export type PrefixListResponse = Array;
export namespace PrefixListResponse {
@@ -287,6 +222,71 @@ export namespace PrefixListResponse {
export type PrefixDeleteResponse = unknown | Array | string;
+export interface PrefixEditResponse {
+ /**
+ * Identifier
+ */
+ id?: string;
+
+ /**
+ * Identifier
+ */
+ account_id?: string;
+
+ /**
+ * Prefix advertisement status to the Internet. This field is only not 'null' if on
+ * demand is enabled.
+ */
+ advertised?: boolean | null;
+
+ /**
+ * Last time the advertisement status was changed. This field is only not 'null' if
+ * on demand is enabled.
+ */
+ advertised_modified_at?: string | null;
+
+ /**
+ * Approval state of the prefix (P = pending, V = active).
+ */
+ approved?: string;
+
+ /**
+ * Autonomous System Number (ASN) the prefix will be advertised under.
+ */
+ asn?: number | null;
+
+ /**
+ * IP Prefix in Classless Inter-Domain Routing format.
+ */
+ cidr?: string;
+
+ created_at?: string;
+
+ /**
+ * Description of the prefix.
+ */
+ description?: string;
+
+ /**
+ * Identifier for the uploaded LOA document.
+ */
+ loa_document_id?: string | null;
+
+ modified_at?: string;
+
+ /**
+ * Whether advertisement of the prefix to the Internet may be dynamically enabled
+ * or disabled.
+ */
+ on_demand_enabled?: boolean;
+
+ /**
+ * Whether advertisement status of the prefix is locked, meaning it cannot be
+ * changed.
+ */
+ on_demand_locked?: boolean;
+}
+
export interface PrefixGetResponse {
/**
* Identifier
@@ -369,7 +369,7 @@ export interface PrefixCreateParams {
loa_document_id: string | null;
}
-export interface PrefixUpdateParams {
+export interface PrefixEditParams {
/**
* Description of the prefix.
*/
@@ -378,12 +378,12 @@ export interface PrefixUpdateParams {
export namespace Prefixes {
export import PrefixCreateResponse = PrefixesAPI.PrefixCreateResponse;
- export import PrefixUpdateResponse = PrefixesAPI.PrefixUpdateResponse;
export import PrefixListResponse = PrefixesAPI.PrefixListResponse;
export import PrefixDeleteResponse = PrefixesAPI.PrefixDeleteResponse;
+ export import PrefixEditResponse = PrefixesAPI.PrefixEditResponse;
export import PrefixGetResponse = PrefixesAPI.PrefixGetResponse;
export import PrefixCreateParams = PrefixesAPI.PrefixCreateParams;
- export import PrefixUpdateParams = PrefixesAPI.PrefixUpdateParams;
+ export import PrefixEditParams = PrefixesAPI.PrefixEditParams;
export import BGPs = BGPsAPI.BGPs;
export import Delegations = DelegationsAPI.Delegations;
export import DelegationCreateResponse = DelegationsAPI.DelegationCreateResponse;
diff --git a/src/resources/addressing/prefixes/bgp-prefixes.ts b/src/resources/addressing/prefixes/bgp-prefixes.ts
index 75a9662123..faf11cd008 100644
--- a/src/resources/addressing/prefixes/bgp-prefixes.ts
+++ b/src/resources/addressing/prefixes/bgp-prefixes.ts
@@ -5,25 +5,6 @@ import { APIResource } from 'cloudflare/resource';
import * as BGPPrefixesAPI from 'cloudflare/resources/addressing/prefixes/bgp-prefixes';
export class BGPPrefixes extends APIResource {
- /**
- * Update the properties of a BGP Prefix, such as the on demand advertisement
- * status (advertised or withdrawn).
- */
- update(
- accountId: string,
- prefixId: string,
- bgpPrefixId: string,
- body: BGPPrefixUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(
- `/accounts/${accountId}/addressing/prefixes/${prefixId}/bgp/prefixes/${bgpPrefixId}`,
- { body, ...options },
- ) as Core.APIPromise<{ result: BGPPrefixUpdateResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to
* control which specific subnets are advertised to the Internet. It is possible to
@@ -43,6 +24,25 @@ export class BGPPrefixes extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update the properties of a BGP Prefix, such as the on demand advertisement
+ * status (advertised or withdrawn).
+ */
+ edit(
+ accountId: string,
+ prefixId: string,
+ bgpPrefixId: string,
+ body: BGPPrefixEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(
+ `/accounts/${accountId}/addressing/prefixes/${prefixId}/bgp/prefixes/${bgpPrefixId}`,
+ { body, ...options },
+ ) as Core.APIPromise<{ result: BGPPrefixEditResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Retrieve a single BGP Prefix according to its identifier
*/
@@ -61,73 +61,6 @@ export class BGPPrefixes extends APIResource {
}
}
-export interface BGPPrefixUpdateResponse {
- /**
- * Identifier
- */
- id?: string;
-
- /**
- * Autonomous System Number (ASN) the prefix will be advertised under.
- */
- asn?: number | null;
-
- bgp_signal_opts?: BGPPrefixUpdateResponse.BGPSignalOpts;
-
- /**
- * IP Prefix in Classless Inter-Domain Routing format.
- */
- cidr?: string;
-
- created_at?: string;
-
- modified_at?: string;
-
- on_demand?: BGPPrefixUpdateResponse.OnDemand;
-}
-
-export namespace BGPPrefixUpdateResponse {
- export interface BGPSignalOpts {
- /**
- * Whether control of advertisement of the prefix to the Internet is enabled to be
- * performed via BGP signal
- */
- enabled?: boolean;
-
- /**
- * Last time BGP signaling control was toggled. This field is null if BGP signaling
- * has never been enabled.
- */
- modified_at?: string | null;
- }
-
- export interface OnDemand {
- /**
- * Prefix advertisement status to the Internet. This field is only not 'null' if on
- * demand is enabled.
- */
- advertised?: boolean | null;
-
- /**
- * Last time the advertisement status was changed. This field is only not 'null' if
- * on demand is enabled.
- */
- advertised_modified_at?: string | null;
-
- /**
- * Whether advertisement of the prefix to the Internet may be dynamically enabled
- * or disabled.
- */
- on_demand_enabled?: boolean;
-
- /**
- * Whether advertisement status of the prefix is locked, meaning it cannot be
- * changed.
- */
- on_demand_locked?: boolean;
- }
-}
-
export type BGPPrefixListResponse = Array;
export namespace BGPPrefixListResponse {
@@ -199,6 +132,73 @@ export namespace BGPPrefixListResponse {
}
}
+export interface BGPPrefixEditResponse {
+ /**
+ * Identifier
+ */
+ id?: string;
+
+ /**
+ * Autonomous System Number (ASN) the prefix will be advertised under.
+ */
+ asn?: number | null;
+
+ bgp_signal_opts?: BGPPrefixEditResponse.BGPSignalOpts;
+
+ /**
+ * IP Prefix in Classless Inter-Domain Routing format.
+ */
+ cidr?: string;
+
+ created_at?: string;
+
+ modified_at?: string;
+
+ on_demand?: BGPPrefixEditResponse.OnDemand;
+}
+
+export namespace BGPPrefixEditResponse {
+ export interface BGPSignalOpts {
+ /**
+ * Whether control of advertisement of the prefix to the Internet is enabled to be
+ * performed via BGP signal
+ */
+ enabled?: boolean;
+
+ /**
+ * Last time BGP signaling control was toggled. This field is null if BGP signaling
+ * has never been enabled.
+ */
+ modified_at?: string | null;
+ }
+
+ export interface OnDemand {
+ /**
+ * Prefix advertisement status to the Internet. This field is only not 'null' if on
+ * demand is enabled.
+ */
+ advertised?: boolean | null;
+
+ /**
+ * Last time the advertisement status was changed. This field is only not 'null' if
+ * on demand is enabled.
+ */
+ advertised_modified_at?: string | null;
+
+ /**
+ * Whether advertisement of the prefix to the Internet may be dynamically enabled
+ * or disabled.
+ */
+ on_demand_enabled?: boolean;
+
+ /**
+ * Whether advertisement status of the prefix is locked, meaning it cannot be
+ * changed.
+ */
+ on_demand_locked?: boolean;
+ }
+}
+
export interface BGPPrefixGetResponse {
/**
* Identifier
@@ -266,19 +266,19 @@ export namespace BGPPrefixGetResponse {
}
}
-export interface BGPPrefixUpdateParams {
- on_demand?: BGPPrefixUpdateParams.OnDemand;
+export interface BGPPrefixEditParams {
+ on_demand?: BGPPrefixEditParams.OnDemand;
}
-export namespace BGPPrefixUpdateParams {
+export namespace BGPPrefixEditParams {
export interface OnDemand {
advertised?: boolean;
}
}
export namespace BGPPrefixes {
- export import BGPPrefixUpdateResponse = BGPPrefixesAPI.BGPPrefixUpdateResponse;
export import BGPPrefixListResponse = BGPPrefixesAPI.BGPPrefixListResponse;
+ export import BGPPrefixEditResponse = BGPPrefixesAPI.BGPPrefixEditResponse;
export import BGPPrefixGetResponse = BGPPrefixesAPI.BGPPrefixGetResponse;
- export import BGPPrefixUpdateParams = BGPPrefixesAPI.BGPPrefixUpdateParams;
+ export import BGPPrefixEditParams = BGPPrefixesAPI.BGPPrefixEditParams;
}
diff --git a/src/resources/addressing/prefixes/index.ts b/src/resources/addressing/prefixes/index.ts
index 42508f7e71..9981e5dad7 100644
--- a/src/resources/addressing/prefixes/index.ts
+++ b/src/resources/addressing/prefixes/index.ts
@@ -1,10 +1,10 @@
// File generated from our OpenAPI spec by Stainless.
export {
- BGPPrefixUpdateResponse,
BGPPrefixListResponse,
+ BGPPrefixEditResponse,
BGPPrefixGetResponse,
- BGPPrefixUpdateParams,
+ BGPPrefixEditParams,
BGPPrefixes,
} from './bgp-prefixes';
export {
diff --git a/src/resources/addressing/prefixes/prefixes.ts b/src/resources/addressing/prefixes/prefixes.ts
index ad5b6d0a84..bc70fb12c9 100644
--- a/src/resources/addressing/prefixes/prefixes.ts
+++ b/src/resources/addressing/prefixes/prefixes.ts
@@ -11,10 +11,10 @@ export class Prefixes extends APIResource {
export namespace Prefixes {
export import BGPPrefixes = BGPPrefixesAPI.BGPPrefixes;
- export import BGPPrefixUpdateResponse = BGPPrefixesAPI.BGPPrefixUpdateResponse;
export import BGPPrefixListResponse = BGPPrefixesAPI.BGPPrefixListResponse;
+ export import BGPPrefixEditResponse = BGPPrefixesAPI.BGPPrefixEditResponse;
export import BGPPrefixGetResponse = BGPPrefixesAPI.BGPPrefixGetResponse;
- export import BGPPrefixUpdateParams = BGPPrefixesAPI.BGPPrefixUpdateParams;
+ export import BGPPrefixEditParams = BGPPrefixesAPI.BGPPrefixEditParams;
export import Bindings = BindingsAPI.Bindings;
export import BindingCreateResponse = BindingsAPI.BindingCreateResponse;
export import BindingListResponse = BindingsAPI.BindingListResponse;
diff --git a/src/resources/alerting/v3/destinations/destinations.ts b/src/resources/alerting/v3/destinations/destinations.ts
index 7c56bfbabd..907dfee08c 100644
--- a/src/resources/alerting/v3/destinations/destinations.ts
+++ b/src/resources/alerting/v3/destinations/destinations.ts
@@ -21,10 +21,10 @@ export namespace Destinations {
export import PagerdutyLinkResponse = PagerdutyAPI.PagerdutyLinkResponse;
export import Webhooks = WebhooksAPI.Webhooks;
export import WebhookCreateResponse = WebhooksAPI.WebhookCreateResponse;
+ export import WebhookUpdateResponse = WebhooksAPI.WebhookUpdateResponse;
export import WebhookListResponse = WebhooksAPI.WebhookListResponse;
export import WebhookDeleteResponse = WebhooksAPI.WebhookDeleteResponse;
export import WebhookGetResponse = WebhooksAPI.WebhookGetResponse;
- export import WebhookReplaceResponse = WebhooksAPI.WebhookReplaceResponse;
export import WebhookCreateParams = WebhooksAPI.WebhookCreateParams;
- export import WebhookReplaceParams = WebhooksAPI.WebhookReplaceParams;
+ export import WebhookUpdateParams = WebhooksAPI.WebhookUpdateParams;
}
diff --git a/src/resources/alerting/v3/destinations/index.ts b/src/resources/alerting/v3/destinations/index.ts
index 445c920bfe..c902804024 100644
--- a/src/resources/alerting/v3/destinations/index.ts
+++ b/src/resources/alerting/v3/destinations/index.ts
@@ -11,11 +11,11 @@ export {
} from './pagerduty';
export {
WebhookCreateResponse,
+ WebhookUpdateResponse,
WebhookListResponse,
WebhookDeleteResponse,
WebhookGetResponse,
- WebhookReplaceResponse,
WebhookCreateParams,
- WebhookReplaceParams,
+ WebhookUpdateParams,
Webhooks,
} from './webhooks';
diff --git a/src/resources/alerting/v3/destinations/webhooks.ts b/src/resources/alerting/v3/destinations/webhooks.ts
index 65cfee88d7..13aa4215c3 100644
--- a/src/resources/alerting/v3/destinations/webhooks.ts
+++ b/src/resources/alerting/v3/destinations/webhooks.ts
@@ -21,6 +21,23 @@ export class Webhooks extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update a webhook destination.
+ */
+ update(
+ accountId: string,
+ webhookId: string,
+ body: WebhookUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountId}/alerting/v3/destinations/webhooks/${webhookId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: WebhookUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Gets a list of all configured webhook destinations.
*/
@@ -64,26 +81,16 @@ export class Webhooks extends APIResource {
) as Core.APIPromise<{ result: WebhookGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface WebhookCreateResponse {
/**
- * Update a webhook destination.
+ * UUID
*/
- replace(
- accountId: string,
- webhookId: string,
- body: WebhookReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountId}/alerting/v3/destinations/webhooks/${webhookId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: WebhookReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
+ id?: string;
}
-export interface WebhookCreateResponse {
+export interface WebhookUpdateResponse {
/**
* UUID
*/
@@ -190,13 +197,6 @@ export interface WebhookGetResponse {
url?: string;
}
-export interface WebhookReplaceResponse {
- /**
- * UUID
- */
- id?: string;
-}
-
export interface WebhookCreateParams {
/**
* The name of the webhook destination. This will be included in the request body
@@ -217,7 +217,7 @@ export interface WebhookCreateParams {
secret?: string;
}
-export interface WebhookReplaceParams {
+export interface WebhookUpdateParams {
/**
* The name of the webhook destination. This will be included in the request body
* when you receive a webhook notification.
@@ -239,10 +239,10 @@ export interface WebhookReplaceParams {
export namespace Webhooks {
export import WebhookCreateResponse = WebhooksAPI.WebhookCreateResponse;
+ export import WebhookUpdateResponse = WebhooksAPI.WebhookUpdateResponse;
export import WebhookListResponse = WebhooksAPI.WebhookListResponse;
export import WebhookDeleteResponse = WebhooksAPI.WebhookDeleteResponse;
export import WebhookGetResponse = WebhooksAPI.WebhookGetResponse;
- export import WebhookReplaceResponse = WebhooksAPI.WebhookReplaceResponse;
export import WebhookCreateParams = WebhooksAPI.WebhookCreateParams;
- export import WebhookReplaceParams = WebhooksAPI.WebhookReplaceParams;
+ export import WebhookUpdateParams = WebhooksAPI.WebhookUpdateParams;
}
diff --git a/src/resources/alerting/v3/index.ts b/src/resources/alerting/v3/index.ts
index 01a40a9876..0596245947 100644
--- a/src/resources/alerting/v3/index.ts
+++ b/src/resources/alerting/v3/index.ts
@@ -9,12 +9,12 @@ export {
} from './histories';
export {
PolicyCreateResponse,
+ PolicyUpdateResponse,
PolicyListResponse,
PolicyDeleteResponse,
PolicyGetResponse,
- PolicyReplaceResponse,
PolicyCreateParams,
- PolicyReplaceParams,
+ PolicyUpdateParams,
Policies,
} from './policies';
export { V3ListResponse, V3 } from './v3';
diff --git a/src/resources/alerting/v3/policies.ts b/src/resources/alerting/v3/policies.ts
index 65bdef8706..764b29e4bc 100644
--- a/src/resources/alerting/v3/policies.ts
+++ b/src/resources/alerting/v3/policies.ts
@@ -21,6 +21,23 @@ export class Policies extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update a Notification policy.
+ */
+ update(
+ accountId: string,
+ policyId: string,
+ body: PolicyUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountId}/alerting/v3/policies/${policyId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: PolicyUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Get a list of all Notification policies.
*/
@@ -63,26 +80,16 @@ export class Policies extends APIResource {
) as Core.APIPromise<{ result: PolicyGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface PolicyCreateResponse {
/**
- * Update a Notification policy.
+ * UUID
*/
- replace(
- accountId: string,
- policyId: string,
- body: PolicyReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountId}/alerting/v3/policies/${policyId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: PolicyReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
+ id?: string;
}
-export interface PolicyCreateResponse {
+export interface PolicyUpdateResponse {
/**
* UUID
*/
@@ -734,13 +741,6 @@ export namespace PolicyGetResponse {
}
}
-export interface PolicyReplaceResponse {
- /**
- * UUID
- */
- id?: string;
-}
-
export interface PolicyCreateParams {
/**
* Refers to which event will trigger a Notification dispatch. You can use the
@@ -1050,7 +1050,7 @@ export namespace PolicyCreateParams {
}
}
-export interface PolicyReplaceParams {
+export interface PolicyUpdateParams {
/**
* Refers to which event will trigger a Notification dispatch. You can use the
* endpoint to get available alert types which then will give you a list of
@@ -1127,13 +1127,13 @@ export interface PolicyReplaceParams {
* that alert type based on some criteria. This is only available for select alert
* types. See alert type documentation for more details.
*/
- filters?: PolicyReplaceParams.Filters;
+ filters?: PolicyUpdateParams.Filters;
/**
* List of IDs that will be used when dispatching a notification. IDs for email
* type will be the email address.
*/
- mechanisms?: Record>;
+ mechanisms?: Record>;
/**
* Name of the policy.
@@ -1141,7 +1141,7 @@ export interface PolicyReplaceParams {
name?: string;
}
-export namespace PolicyReplaceParams {
+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
@@ -1361,10 +1361,10 @@ export namespace PolicyReplaceParams {
export namespace Policies {
export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
+ export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
- export import PolicyReplaceResponse = PoliciesAPI.PolicyReplaceResponse;
export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
- export import PolicyReplaceParams = PoliciesAPI.PolicyReplaceParams;
+ export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
}
diff --git a/src/resources/alerting/v3/v3.ts b/src/resources/alerting/v3/v3.ts
index 1d363914b2..cca26041f2 100644
--- a/src/resources/alerting/v3/v3.ts
+++ b/src/resources/alerting/v3/v3.ts
@@ -35,10 +35,10 @@ export namespace V3 {
export import HistoryListParams = HistoriesAPI.HistoryListParams;
export import Policies = PoliciesAPI.Policies;
export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
+ export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
- export import PolicyReplaceResponse = PoliciesAPI.PolicyReplaceResponse;
export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
- export import PolicyReplaceParams = PoliciesAPI.PolicyReplaceParams;
+ export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
}
diff --git a/src/resources/argo/argo.ts b/src/resources/argo/argo.ts
index c09a4c7338..72541c8660 100644
--- a/src/resources/argo/argo.ts
+++ b/src/resources/argo/argo.ts
@@ -11,11 +11,11 @@ export class Argo extends APIResource {
export namespace Argo {
export import SmartRouting = SmartRoutingAPI.SmartRouting;
- export import SmartRoutingUpdateResponse = SmartRoutingAPI.SmartRoutingUpdateResponse;
+ export import SmartRoutingEditResponse = SmartRoutingAPI.SmartRoutingEditResponse;
export import SmartRoutingGetResponse = SmartRoutingAPI.SmartRoutingGetResponse;
- export import SmartRoutingUpdateParams = SmartRoutingAPI.SmartRoutingUpdateParams;
+ export import SmartRoutingEditParams = SmartRoutingAPI.SmartRoutingEditParams;
export import TieredCaching = TieredCachingAPI.TieredCaching;
- export import TieredCachingUpdateResponse = TieredCachingAPI.TieredCachingUpdateResponse;
+ export import TieredCachingEditResponse = TieredCachingAPI.TieredCachingEditResponse;
export import TieredCachingGetResponse = TieredCachingAPI.TieredCachingGetResponse;
- export import TieredCachingUpdateParams = TieredCachingAPI.TieredCachingUpdateParams;
+ export import TieredCachingEditParams = TieredCachingAPI.TieredCachingEditParams;
}
diff --git a/src/resources/argo/index.ts b/src/resources/argo/index.ts
index 2b765b1e8c..14f276282e 100644
--- a/src/resources/argo/index.ts
+++ b/src/resources/argo/index.ts
@@ -2,14 +2,14 @@
export { Argo } from './argo';
export {
- SmartRoutingUpdateResponse,
+ SmartRoutingEditResponse,
SmartRoutingGetResponse,
- SmartRoutingUpdateParams,
+ SmartRoutingEditParams,
SmartRouting,
} from './smart-routing';
export {
- TieredCachingUpdateResponse,
+ TieredCachingEditResponse,
TieredCachingGetResponse,
- TieredCachingUpdateParams,
+ TieredCachingEditParams,
TieredCaching,
} from './tiered-caching';
diff --git a/src/resources/argo/smart-routing.ts b/src/resources/argo/smart-routing.ts
index 47d4f66c49..7bd998f942 100644
--- a/src/resources/argo/smart-routing.ts
+++ b/src/resources/argo/smart-routing.ts
@@ -8,14 +8,14 @@ export class SmartRouting extends APIResource {
/**
* Updates enablement of Argo Smart Routing.
*/
- update(
+ edit(
zoneId: string,
- body: SmartRoutingUpdateParams,
+ body: SmartRoutingEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.patch(`/zones/${zoneId}/argo/smart_routing`, { body, ...options }) as Core.APIPromise<{
- result: SmartRoutingUpdateResponse;
+ result: SmartRoutingEditResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -32,11 +32,11 @@ export class SmartRouting extends APIResource {
}
}
-export type SmartRoutingUpdateResponse = unknown | string | null;
+export type SmartRoutingEditResponse = unknown | string | null;
export type SmartRoutingGetResponse = unknown | string | null;
-export interface SmartRoutingUpdateParams {
+export interface SmartRoutingEditParams {
/**
* Enables Argo Smart Routing.
*/
@@ -44,7 +44,7 @@ export interface SmartRoutingUpdateParams {
}
export namespace SmartRouting {
- export import SmartRoutingUpdateResponse = SmartRoutingAPI.SmartRoutingUpdateResponse;
+ export import SmartRoutingEditResponse = SmartRoutingAPI.SmartRoutingEditResponse;
export import SmartRoutingGetResponse = SmartRoutingAPI.SmartRoutingGetResponse;
- export import SmartRoutingUpdateParams = SmartRoutingAPI.SmartRoutingUpdateParams;
+ export import SmartRoutingEditParams = SmartRoutingAPI.SmartRoutingEditParams;
}
diff --git a/src/resources/argo/tiered-caching.ts b/src/resources/argo/tiered-caching.ts
index a4a5c89643..62b1a88845 100644
--- a/src/resources/argo/tiered-caching.ts
+++ b/src/resources/argo/tiered-caching.ts
@@ -8,14 +8,14 @@ export class TieredCaching extends APIResource {
/**
* Updates enablement of Tiered Caching
*/
- update(
+ edit(
zoneId: string,
- body: TieredCachingUpdateParams,
+ body: TieredCachingEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.patch(`/zones/${zoneId}/argo/tiered_caching`, { body, ...options }) as Core.APIPromise<{
- result: TieredCachingUpdateResponse;
+ result: TieredCachingEditResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -32,11 +32,11 @@ export class TieredCaching extends APIResource {
}
}
-export type TieredCachingUpdateResponse = unknown | string | null;
+export type TieredCachingEditResponse = unknown | string | null;
export type TieredCachingGetResponse = unknown | string | null;
-export interface TieredCachingUpdateParams {
+export interface TieredCachingEditParams {
/**
* Enables Tiered Caching.
*/
@@ -44,7 +44,7 @@ export interface TieredCachingUpdateParams {
}
export namespace TieredCaching {
- export import TieredCachingUpdateResponse = TieredCachingAPI.TieredCachingUpdateResponse;
+ export import TieredCachingEditResponse = TieredCachingAPI.TieredCachingEditResponse;
export import TieredCachingGetResponse = TieredCachingAPI.TieredCachingGetResponse;
- export import TieredCachingUpdateParams = TieredCachingAPI.TieredCachingUpdateParams;
+ export import TieredCachingEditParams = TieredCachingAPI.TieredCachingEditParams;
}
diff --git a/src/resources/bot-management.ts b/src/resources/bot-management.ts
index ee277adc14..f032957b46 100644
--- a/src/resources/bot-management.ts
+++ b/src/resources/bot-management.ts
@@ -5,17 +5,6 @@ import { APIResource } from 'cloudflare/resource';
import * as BotManagementAPI from 'cloudflare/resources/bot-management';
export class BotManagement extends APIResource {
- /**
- * Retrieve a zone's Bot Management Config
- */
- get(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
- return (
- this._client.get(`/zones/${zoneId}/bot_management`, options) as Core.APIPromise<{
- result: BotManagementGetResponse;
- }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Updates the Bot Management configuration for a zone.
*
@@ -28,26 +17,37 @@ export class BotManagement extends APIResource {
* See [Bot Plans](https://developers.cloudflare.com/bots/plans/) for more
* information on the different plans
*/
- replace(
+ update(
zoneId: string,
- body: BotManagementReplaceParams,
+ body: BotManagementUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.put(`/zones/${zoneId}/bot_management`, { body, ...options }) as Core.APIPromise<{
- result: BotManagementReplaceResponse;
+ result: BotManagementUpdateResponse;
+ }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
+ /**
+ * Retrieve a zone's Bot Management Config
+ */
+ get(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
+ return (
+ this._client.get(`/zones/${zoneId}/bot_management`, options) as Core.APIPromise<{
+ result: BotManagementGetResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
-export type BotManagementGetResponse =
- | BotManagementGetResponse.BotManagementBotFightModeConfig
- | BotManagementGetResponse.BotManagementSbfmDefinitelyConfig
- | BotManagementGetResponse.BotManagementSbfmLikelyConfig
- | BotManagementGetResponse.BotManagementBmSubscriptionConfig;
+export type BotManagementUpdateResponse =
+ | BotManagementUpdateResponse.BotManagementBotFightModeConfig
+ | BotManagementUpdateResponse.BotManagementSbfmDefinitelyConfig
+ | BotManagementUpdateResponse.BotManagementSbfmLikelyConfig
+ | BotManagementUpdateResponse.BotManagementBmSubscriptionConfig;
-export namespace BotManagementGetResponse {
+export namespace BotManagementUpdateResponse {
export interface BotManagementBotFightModeConfig {
/**
* Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -172,13 +172,13 @@ export namespace BotManagementGetResponse {
}
}
-export type BotManagementReplaceResponse =
- | BotManagementReplaceResponse.BotManagementBotFightModeConfig
- | BotManagementReplaceResponse.BotManagementSbfmDefinitelyConfig
- | BotManagementReplaceResponse.BotManagementSbfmLikelyConfig
- | BotManagementReplaceResponse.BotManagementBmSubscriptionConfig;
+export type BotManagementGetResponse =
+ | BotManagementGetResponse.BotManagementBotFightModeConfig
+ | BotManagementGetResponse.BotManagementSbfmDefinitelyConfig
+ | BotManagementGetResponse.BotManagementSbfmLikelyConfig
+ | BotManagementGetResponse.BotManagementBmSubscriptionConfig;
-export namespace BotManagementReplaceResponse {
+export namespace BotManagementGetResponse {
export interface BotManagementBotFightModeConfig {
/**
* Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -303,13 +303,13 @@ export namespace BotManagementReplaceResponse {
}
}
-export type BotManagementReplaceParams =
- | BotManagementReplaceParams.BotManagementBotFightModeConfig
- | BotManagementReplaceParams.BotManagementSbfmDefinitelyConfig
- | BotManagementReplaceParams.BotManagementSbfmLikelyConfig
- | BotManagementReplaceParams.BotManagementBmSubscriptionConfig;
+export type BotManagementUpdateParams =
+ | BotManagementUpdateParams.BotManagementBotFightModeConfig
+ | BotManagementUpdateParams.BotManagementSbfmDefinitelyConfig
+ | BotManagementUpdateParams.BotManagementSbfmLikelyConfig
+ | BotManagementUpdateParams.BotManagementBmSubscriptionConfig;
-export namespace BotManagementReplaceParams {
+export namespace BotManagementUpdateParams {
export interface BotManagementBotFightModeConfig {
/**
* Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -411,7 +411,7 @@ export namespace BotManagementReplaceParams {
}
export namespace BotManagement {
+ export import BotManagementUpdateResponse = BotManagementAPI.BotManagementUpdateResponse;
export import BotManagementGetResponse = BotManagementAPI.BotManagementGetResponse;
- export import BotManagementReplaceResponse = BotManagementAPI.BotManagementReplaceResponse;
- export import BotManagementReplaceParams = BotManagementAPI.BotManagementReplaceParams;
+ export import BotManagementUpdateParams = BotManagementAPI.BotManagementUpdateParams;
}
diff --git a/src/resources/cache/cache-reserves.ts b/src/resources/cache/cache-reserves.ts
index 01d3a01320..71a2e9aa35 100644
--- a/src/resources/cache/cache-reserves.ts
+++ b/src/resources/cache/cache-reserves.ts
@@ -13,14 +13,10 @@ export class CacheReserves extends APIResource {
* [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
* for more information.
*/
- update(
- zoneId: string,
- body: CacheReserveUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
+ list(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
return (
- this._client.patch(`/zones/${zoneId}/cache/cache_reserve`, { body, ...options }) as Core.APIPromise<{
- result: CacheReserveUpdateResponse;
+ this._client.get(`/zones/${zoneId}/cache/cache_reserve`, options) as Core.APIPromise<{
+ result: CacheReserveListResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -33,10 +29,14 @@ export class CacheReserves extends APIResource {
* [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
* for more information.
*/
- list(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
+ edit(
+ zoneId: string,
+ body: CacheReserveEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
return (
- this._client.get(`/zones/${zoneId}/cache/cache_reserve`, options) as Core.APIPromise<{
- result: CacheReserveListResponse;
+ this._client.patch(`/zones/${zoneId}/cache/cache_reserve`, { body, ...options }) as Core.APIPromise<{
+ result: CacheReserveEditResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -50,7 +50,7 @@ export class CacheReserves extends APIResource {
* [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
* for more information.
*/
-export interface CacheReserveUpdateResponse {
+export interface CacheReserveListResponse {
/**
* ID of the zone setting.
*/
@@ -75,7 +75,7 @@ export interface CacheReserveUpdateResponse {
* [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
* for more information.
*/
-export interface CacheReserveListResponse {
+export interface CacheReserveEditResponse {
/**
* ID of the zone setting.
*/
@@ -92,7 +92,7 @@ export interface CacheReserveListResponse {
value: 'on' | 'off';
}
-export interface CacheReserveUpdateParams {
+export interface CacheReserveEditParams {
/**
* Value of the Cache Reserve zone setting.
*/
@@ -100,7 +100,7 @@ export interface CacheReserveUpdateParams {
}
export namespace CacheReserves {
- export import CacheReserveUpdateResponse = CacheReservesAPI.CacheReserveUpdateResponse;
export import CacheReserveListResponse = CacheReservesAPI.CacheReserveListResponse;
- export import CacheReserveUpdateParams = CacheReservesAPI.CacheReserveUpdateParams;
+ export import CacheReserveEditResponse = CacheReservesAPI.CacheReserveEditResponse;
+ export import CacheReserveEditParams = CacheReservesAPI.CacheReserveEditParams;
}
diff --git a/src/resources/cache/cache.ts b/src/resources/cache/cache.ts
index 789dd75fe2..04da9f7d58 100644
--- a/src/resources/cache/cache.ts
+++ b/src/resources/cache/cache.ts
@@ -1,6 +1,8 @@
// File generated from our OpenAPI spec by Stainless.
+import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
+import * as CacheAPI from 'cloudflare/resources/cache/cache';
import * as CacheReservesAPI from 'cloudflare/resources/cache/cache-reserves';
import * as RegionalTieredCacheAPI from 'cloudflare/resources/cache/regional-tiered-cache';
import * as TieredCacheSmartTopologyAPI from 'cloudflare/resources/cache/tiered-cache-smart-topology';
@@ -13,25 +15,107 @@ export class Cache extends APIResource {
variants: VariantsAPI.Variants = new VariantsAPI.Variants(this._client);
regionalTieredCache: RegionalTieredCacheAPI.RegionalTieredCache =
new RegionalTieredCacheAPI.RegionalTieredCache(this._client);
+
+ /**
+ * ### Purge All Cached Content
+ *
+ * Removes ALL files from Cloudflare's cache. All tiers can purge everything.
+ *
+ * ### Purge Cached Content by URL
+ *
+ * Granularly removes one or more files from Cloudflare's cache by specifying URLs.
+ * All tiers can purge by URL.
+ *
+ * To purge files with custom cache keys, include the headers used to compute the
+ * cache key as in the example. If you have a device type or geo in your cache key,
+ * you will need to include the CF-Device-Type or CF-IPCountry headers. If you have
+ * lang in your cache key, you will need to include the Accept-Language header.
+ *
+ * **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.
+ *
+ * ### Purge Cached Content by Tag, Host or Prefix
+ *
+ * Granularly removes one or more files from Cloudflare's cache either by
+ * specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise
+ * customers are permitted to purge by Tag, Host or Prefix.
+ *
+ * **NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000
+ * purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or
+ * prefixes in one API call. This rate limit can be raised for customers who need
+ * to purge at higher volume.
+ */
+ purge(
+ zoneId: string,
+ body: CachePurgeParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.post(`/zones/${zoneId}/purge_cache`, { body, ...options }) as Core.APIPromise<{
+ result: CachePurgeResponse | null;
+ }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+}
+
+export interface CachePurgeResponse {
+ /**
+ * Identifier
+ */
+ id: string;
+}
+
+export type CachePurgeParams =
+ | CachePurgeParams.CachePurgeFlex
+ | CachePurgeParams.CachePurgeEverything
+ | CachePurgeParams.CachePurgeFiles;
+
+export namespace CachePurgeParams {
+ export interface CachePurgeFlex {
+ hosts?: Array;
+
+ prefixes?: Array;
+
+ tags?: Array;
+ }
+
+ export interface CachePurgeEverything {
+ purge_everything?: boolean;
+ }
+
+ export interface CachePurgeFiles {
+ files?: Array;
+ }
+
+ export namespace CachePurgeFiles {
+ export interface CachePurgeURLAndHeaders {
+ headers?: unknown;
+
+ url?: string;
+ }
+ }
}
export namespace Cache {
+ export import CachePurgeResponse = CacheAPI.CachePurgeResponse;
+ export import CachePurgeParams = CacheAPI.CachePurgeParams;
export import CacheReserves = CacheReservesAPI.CacheReserves;
- export import CacheReserveUpdateResponse = CacheReservesAPI.CacheReserveUpdateResponse;
export import CacheReserveListResponse = CacheReservesAPI.CacheReserveListResponse;
- export import CacheReserveUpdateParams = CacheReservesAPI.CacheReserveUpdateParams;
+ export import CacheReserveEditResponse = CacheReservesAPI.CacheReserveEditResponse;
+ export import CacheReserveEditParams = CacheReservesAPI.CacheReserveEditParams;
export import TieredCacheSmartTopology = TieredCacheSmartTopologyAPI.TieredCacheSmartTopology;
- export import TieredCacheSmartTopologyUpdateResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyUpdateResponse;
export import TieredCacheSmartTopologyDeleteResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyDeleteResponse;
+ export import TieredCacheSmartTopologyEditResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyEditResponse;
export import TieredCacheSmartTopologyGetResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyGetResponse;
- export import TieredCacheSmartTopologyUpdateParams = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyUpdateParams;
+ export import TieredCacheSmartTopologyEditParams = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyEditParams;
export import Variants = VariantsAPI.Variants;
- export import VariantUpdateResponse = VariantsAPI.VariantUpdateResponse;
export import VariantListResponse = VariantsAPI.VariantListResponse;
export import VariantDeleteResponse = VariantsAPI.VariantDeleteResponse;
- export import VariantUpdateParams = VariantsAPI.VariantUpdateParams;
+ export import VariantEditResponse = VariantsAPI.VariantEditResponse;
+ export import VariantEditParams = VariantsAPI.VariantEditParams;
export import RegionalTieredCache = RegionalTieredCacheAPI.RegionalTieredCache;
- export import RegionalTieredCacheUpdateResponse = RegionalTieredCacheAPI.RegionalTieredCacheUpdateResponse;
+ export import RegionalTieredCacheEditResponse = RegionalTieredCacheAPI.RegionalTieredCacheEditResponse;
export import RegionalTieredCacheGetResponse = RegionalTieredCacheAPI.RegionalTieredCacheGetResponse;
- export import RegionalTieredCacheUpdateParams = RegionalTieredCacheAPI.RegionalTieredCacheUpdateParams;
+ export import RegionalTieredCacheEditParams = RegionalTieredCacheAPI.RegionalTieredCacheEditParams;
}
diff --git a/src/resources/cache/index.ts b/src/resources/cache/index.ts
index 3447948bb6..aa8cfdd787 100644
--- a/src/resources/cache/index.ts
+++ b/src/resources/cache/index.ts
@@ -1,29 +1,29 @@
// File generated from our OpenAPI spec by Stainless.
-export { Cache } from './cache';
+export { CachePurgeResponse, CachePurgeParams, Cache } from './cache';
export {
- CacheReserveUpdateResponse,
CacheReserveListResponse,
- CacheReserveUpdateParams,
+ CacheReserveEditResponse,
+ CacheReserveEditParams,
CacheReserves,
} from './cache-reserves';
export {
- RegionalTieredCacheUpdateResponse,
+ RegionalTieredCacheEditResponse,
RegionalTieredCacheGetResponse,
- RegionalTieredCacheUpdateParams,
+ RegionalTieredCacheEditParams,
RegionalTieredCache,
} from './regional-tiered-cache';
export {
- TieredCacheSmartTopologyUpdateResponse,
TieredCacheSmartTopologyDeleteResponse,
+ TieredCacheSmartTopologyEditResponse,
TieredCacheSmartTopologyGetResponse,
- TieredCacheSmartTopologyUpdateParams,
+ TieredCacheSmartTopologyEditParams,
TieredCacheSmartTopology,
} from './tiered-cache-smart-topology';
export {
- VariantUpdateResponse,
VariantListResponse,
VariantDeleteResponse,
- VariantUpdateParams,
+ VariantEditResponse,
+ VariantEditParams,
Variants,
} from './variants';
diff --git a/src/resources/cache/regional-tiered-cache.ts b/src/resources/cache/regional-tiered-cache.ts
index efe99042ac..cc929b8573 100644
--- a/src/resources/cache/regional-tiered-cache.ts
+++ b/src/resources/cache/regional-tiered-cache.ts
@@ -10,16 +10,16 @@ export class RegionalTieredCache extends APIResource {
* upper tier. This can help improve performance for smart and custom tiered cache
* topologies.
*/
- update(
+ edit(
zoneId: string,
- body: RegionalTieredCacheUpdateParams,
+ body: RegionalTieredCacheEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.patch(`/zones/${zoneId}/cache/regional_tiered_cache`, {
body,
...options,
- }) as Core.APIPromise<{ result: RegionalTieredCacheUpdateResponse }>
+ }) as Core.APIPromise<{ result: RegionalTieredCacheEditResponse }>
)._thenUnwrap((obj) => obj.result);
}
@@ -42,7 +42,7 @@ export class RegionalTieredCache extends APIResource {
* upper tier. This can help improve performance for smart and custom tiered cache
* topologies.
*/
-export interface RegionalTieredCacheUpdateResponse {
+export interface RegionalTieredCacheEditResponse {
/**
* ID of the zone setting.
*/
@@ -58,10 +58,10 @@ export interface RegionalTieredCacheUpdateResponse {
* upper tier. This can help improve performance for smart and custom tiered cache
* topologies.
*/
- value: RegionalTieredCacheUpdateResponse.Value;
+ value: RegionalTieredCacheEditResponse.Value;
}
-export namespace RegionalTieredCacheUpdateResponse {
+export namespace RegionalTieredCacheEditResponse {
/**
* 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
@@ -123,7 +123,7 @@ export namespace RegionalTieredCacheGetResponse {
}
}
-export interface RegionalTieredCacheUpdateParams {
+export interface RegionalTieredCacheEditParams {
/**
* Value of the Regional Tiered Cache zone setting.
*/
@@ -131,7 +131,7 @@ export interface RegionalTieredCacheUpdateParams {
}
export namespace RegionalTieredCache {
- export import RegionalTieredCacheUpdateResponse = RegionalTieredCacheAPI.RegionalTieredCacheUpdateResponse;
+ export import RegionalTieredCacheEditResponse = RegionalTieredCacheAPI.RegionalTieredCacheEditResponse;
export import RegionalTieredCacheGetResponse = RegionalTieredCacheAPI.RegionalTieredCacheGetResponse;
- export import RegionalTieredCacheUpdateParams = RegionalTieredCacheAPI.RegionalTieredCacheUpdateParams;
+ export import RegionalTieredCacheEditParams = RegionalTieredCacheAPI.RegionalTieredCacheEditParams;
}
diff --git a/src/resources/cache/tiered-cache-smart-topology.ts b/src/resources/cache/tiered-cache-smart-topology.ts
index f7e553e4f6..0191e36902 100644
--- a/src/resources/cache/tiered-cache-smart-topology.ts
+++ b/src/resources/cache/tiered-cache-smart-topology.ts
@@ -6,33 +6,33 @@ import * as TieredCacheSmartTopologyAPI from 'cloudflare/resources/cache/tiered-
export class TieredCacheSmartTopology extends APIResource {
/**
- * Updates enablement of Tiered Cache
+ * Remvoves enablement of Smart Tiered Cache
*/
- update(
+ delete(
zoneId: string,
- body: TieredCacheSmartTopologyUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.patch(`/zones/${zoneId}/cache/tiered_cache_smart_topology_enable`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: TieredCacheSmartTopologyUpdateResponse }>
+ this._client.delete(
+ `/zones/${zoneId}/cache/tiered_cache_smart_topology_enable`,
+ options,
+ ) as Core.APIPromise<{ result: TieredCacheSmartTopologyDeleteResponse }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Remvoves enablement of Smart Tiered Cache
+ * Updates enablement of Tiered Cache
*/
- delete(
+ edit(
zoneId: string,
+ body: TieredCacheSmartTopologyEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.delete(
- `/zones/${zoneId}/cache/tiered_cache_smart_topology_enable`,
- options,
- ) as Core.APIPromise<{ result: TieredCacheSmartTopologyDeleteResponse }>
+ this._client.patch(`/zones/${zoneId}/cache/tiered_cache_smart_topology_enable`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: TieredCacheSmartTopologyEditResponse }>
)._thenUnwrap((obj) => obj.result);
}
@@ -49,13 +49,13 @@ export class TieredCacheSmartTopology extends APIResource {
}
}
-export type TieredCacheSmartTopologyUpdateResponse = unknown | string | null;
-
export type TieredCacheSmartTopologyDeleteResponse = unknown | string | null;
+export type TieredCacheSmartTopologyEditResponse = unknown | string | null;
+
export type TieredCacheSmartTopologyGetResponse = unknown | string | null;
-export interface TieredCacheSmartTopologyUpdateParams {
+export interface TieredCacheSmartTopologyEditParams {
/**
* Enables Tiered Cache.
*/
@@ -63,8 +63,8 @@ export interface TieredCacheSmartTopologyUpdateParams {
}
export namespace TieredCacheSmartTopology {
- export import TieredCacheSmartTopologyUpdateResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyUpdateResponse;
export import TieredCacheSmartTopologyDeleteResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyDeleteResponse;
+ export import TieredCacheSmartTopologyEditResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyEditResponse;
export import TieredCacheSmartTopologyGetResponse = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyGetResponse;
- export import TieredCacheSmartTopologyUpdateParams = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyUpdateParams;
+ export import TieredCacheSmartTopologyEditParams = TieredCacheSmartTopologyAPI.TieredCacheSmartTopologyEditParams;
}
diff --git a/src/resources/cache/variants.ts b/src/resources/cache/variants.ts
index 968a3f1ef5..a95c707083 100644
--- a/src/resources/cache/variants.ts
+++ b/src/resources/cache/variants.ts
@@ -12,14 +12,10 @@ 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.
*/
- update(
- zoneId: string,
- body: VariantUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
+ list(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
return (
- this._client.patch(`/zones/${zoneId}/cache/variants`, { body, ...options }) as Core.APIPromise<{
- result: VariantUpdateResponse;
+ this._client.get(`/zones/${zoneId}/cache/variants`, options) as Core.APIPromise<{
+ result: VariantListResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -31,10 +27,10 @@ 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.
*/
- list(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
+ delete(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
return (
- this._client.get(`/zones/${zoneId}/cache/variants`, options) as Core.APIPromise<{
- result: VariantListResponse;
+ this._client.delete(`/zones/${zoneId}/cache/variants`, options) as Core.APIPromise<{
+ result: VariantDeleteResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -46,10 +42,14 @@ 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(zoneId: string, options?: Core.RequestOptions): Core.APIPromise {
+ edit(
+ zoneId: string,
+ body: VariantEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
return (
- this._client.delete(`/zones/${zoneId}/cache/variants`, options) as Core.APIPromise<{
- result: VariantDeleteResponse;
+ this._client.patch(`/zones/${zoneId}/cache/variants`, { body, ...options }) as Core.APIPromise<{
+ result: VariantEditResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
@@ -62,7 +62,7 @@ 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 VariantUpdateResponse {
+export interface VariantListResponse {
/**
* ID of the zone setting.
*/
@@ -76,10 +76,10 @@ export interface VariantUpdateResponse {
/**
* Value of the zone setting.
*/
- value: VariantUpdateResponse.Value;
+ value: VariantListResponse.Value;
}
-export namespace VariantUpdateResponse {
+export namespace VariantListResponse {
/**
* Value of the zone setting.
*/
@@ -159,7 +159,26 @@ export namespace VariantUpdateResponse {
* 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 VariantListResponse {
+export interface VariantDeleteResponse {
+ /**
+ * ID of the zone setting.
+ */
+ id: 'variants';
+
+ /**
+ * last time this setting was modified.
+ */
+ modified_on: string | null;
+}
+
+/**
+ * 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
+ * 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but
+ * 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 VariantEditResponse {
/**
* ID of the zone setting.
*/
@@ -173,10 +192,10 @@ export interface VariantListResponse {
/**
* Value of the zone setting.
*/
- value: VariantListResponse.Value;
+ value: VariantEditResponse.Value;
}
-export namespace VariantListResponse {
+export namespace VariantEditResponse {
/**
* Value of the zone setting.
*/
@@ -249,33 +268,14 @@ export namespace VariantListResponse {
}
}
-/**
- * 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
- * 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but
- * 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 VariantDeleteResponse {
- /**
- * ID of the zone setting.
- */
- id: 'variants';
-
- /**
- * last time this setting was modified.
- */
- modified_on: string | null;
-}
-
-export interface VariantUpdateParams {
+export interface VariantEditParams {
/**
* Value of the zone setting.
*/
- value: VariantUpdateParams.Value;
+ value: VariantEditParams.Value;
}
-export namespace VariantUpdateParams {
+export namespace VariantEditParams {
/**
* Value of the zone setting.
*/
@@ -349,8 +349,8 @@ export namespace VariantUpdateParams {
}
export namespace Variants {
- export import VariantUpdateResponse = VariantsAPI.VariantUpdateResponse;
export import VariantListResponse = VariantsAPI.VariantListResponse;
export import VariantDeleteResponse = VariantsAPI.VariantDeleteResponse;
- export import VariantUpdateParams = VariantsAPI.VariantUpdateParams;
+ export import VariantEditResponse = VariantsAPI.VariantEditResponse;
+ export import VariantEditParams = VariantsAPI.VariantEditParams;
}
diff --git a/src/resources/calls.ts b/src/resources/calls.ts
index 065e875194..6ce5ddaf64 100644
--- a/src/resources/calls.ts
+++ b/src/resources/calls.ts
@@ -21,6 +21,23 @@ export class Calls extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Edit details for a single app.
+ */
+ update(
+ accountId: string,
+ appId: string,
+ body: CallUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountId}/calls/apps/${appId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: CallUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all apps in the Cloudflare account
*/
@@ -57,23 +74,6 @@ export class Calls extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Edit details for a single app.
- */
- replace(
- accountId: string,
- appId: string,
- body: CallReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountId}/calls/apps/${appId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: CallReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export interface CallCreateResponse {
@@ -103,6 +103,28 @@ export interface CallCreateResponse {
uid?: string;
}
+export interface CallUpdateResponse {
+ /**
+ * The date and time the item was created.
+ */
+ created?: string;
+
+ /**
+ * The date and time the item was last modified.
+ */
+ modified?: string;
+
+ /**
+ * A short description of Calls app, not shown to end users.
+ */
+ name?: string;
+
+ /**
+ * A Cloudflare-generated unique identifier for a item.
+ */
+ uid?: string;
+}
+
export type CallListResponse = Array;
export namespace CallListResponse {
@@ -173,28 +195,6 @@ export interface CallGetResponse {
uid?: string;
}
-export interface CallReplaceResponse {
- /**
- * The date and time the item was created.
- */
- created?: string;
-
- /**
- * The date and time the item was last modified.
- */
- modified?: string;
-
- /**
- * A short description of Calls app, not shown to end users.
- */
- name?: string;
-
- /**
- * A Cloudflare-generated unique identifier for a item.
- */
- uid?: string;
-}
-
export interface CallCreateParams {
/**
* A short description of Calls app, not shown to end users.
@@ -202,7 +202,7 @@ export interface CallCreateParams {
name?: string;
}
-export interface CallReplaceParams {
+export interface CallUpdateParams {
/**
* A short description of Calls app, not shown to end users.
*/
@@ -211,10 +211,10 @@ export interface CallReplaceParams {
export namespace Calls {
export import CallCreateResponse = CallsAPI.CallCreateResponse;
+ export import CallUpdateResponse = CallsAPI.CallUpdateResponse;
export import CallListResponse = CallsAPI.CallListResponse;
export import CallDeleteResponse = CallsAPI.CallDeleteResponse;
export import CallGetResponse = CallsAPI.CallGetResponse;
- export import CallReplaceResponse = CallsAPI.CallReplaceResponse;
export import CallCreateParams = CallsAPI.CallCreateParams;
- export import CallReplaceParams = CallsAPI.CallReplaceParams;
+ export import CallUpdateParams = CallsAPI.CallUpdateParams;
}
diff --git a/src/resources/certificate-authorities/certificate-authorities.ts b/src/resources/certificate-authorities/certificate-authorities.ts
index 539f616aec..dc53dd21d0 100644
--- a/src/resources/certificate-authorities/certificate-authorities.ts
+++ b/src/resources/certificate-authorities/certificate-authorities.ts
@@ -10,8 +10,8 @@ export class CertificateAuthorities extends APIResource {
export namespace CertificateAuthorities {
export import HostnameAssociations = HostnameAssociationsAPI.HostnameAssociations;
+ export import HostnameAssociationUpdateResponse = HostnameAssociationsAPI.HostnameAssociationUpdateResponse;
export import HostnameAssociationListResponse = HostnameAssociationsAPI.HostnameAssociationListResponse;
- export import HostnameAssociationReplaceResponse = HostnameAssociationsAPI.HostnameAssociationReplaceResponse;
+ export import HostnameAssociationUpdateParams = HostnameAssociationsAPI.HostnameAssociationUpdateParams;
export import HostnameAssociationListParams = HostnameAssociationsAPI.HostnameAssociationListParams;
- export import HostnameAssociationReplaceParams = HostnameAssociationsAPI.HostnameAssociationReplaceParams;
}
diff --git a/src/resources/certificate-authorities/hostname-associations.ts b/src/resources/certificate-authorities/hostname-associations.ts
index 672e7e3c9b..ba7d38b05c 100644
--- a/src/resources/certificate-authorities/hostname-associations.ts
+++ b/src/resources/certificate-authorities/hostname-associations.ts
@@ -6,6 +6,22 @@ import { isRequestOptions } from 'cloudflare/core';
import * as HostnameAssociationsAPI from 'cloudflare/resources/certificate-authorities/hostname-associations';
export class HostnameAssociations extends APIResource {
+ /**
+ * Replace Hostname Associations
+ */
+ update(
+ zoneId: string,
+ body: HostnameAssociationUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/zones/${zoneId}/certificate_authorities/hostname_associations`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: HostnameAssociationUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* List Hostname Associations
*/
@@ -30,22 +46,17 @@ export class HostnameAssociations extends APIResource {
}) as Core.APIPromise<{ result: HostnameAssociationListResponse }>
)._thenUnwrap((obj) => obj.result);
}
+}
+
+export interface HostnameAssociationUpdateResponse {
+ hostnames?: Array;
/**
- * Replace Hostname Associations
+ * The UUID for a certificate that was uploaded to the mTLS Certificate Management
+ * endpoint. If no mtls_certificate_id is given, the hostnames will be associated
+ * to your active Cloudflare Managed CA.
*/
- replace(
- zoneId: string,
- body: HostnameAssociationReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/zones/${zoneId}/certificate_authorities/hostname_associations`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: HostnameAssociationReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
+ mtls_certificate_id?: string;
}
export interface HostnameAssociationListResponse {
@@ -59,7 +70,7 @@ export interface HostnameAssociationListResponse {
mtls_certificate_id?: string;
}
-export interface HostnameAssociationReplaceResponse {
+export interface HostnameAssociationUpdateParams {
hostnames?: Array;
/**
@@ -79,20 +90,9 @@ export interface HostnameAssociationListParams {
mtls_certificate_id?: string;
}
-export interface HostnameAssociationReplaceParams {
- hostnames?: Array;
-
- /**
- * The UUID for a certificate that was uploaded to the mTLS Certificate Management
- * endpoint. If no mtls_certificate_id is given, the hostnames will be associated
- * to your active Cloudflare Managed CA.
- */
- mtls_certificate_id?: string;
-}
-
export namespace HostnameAssociations {
+ export import HostnameAssociationUpdateResponse = HostnameAssociationsAPI.HostnameAssociationUpdateResponse;
export import HostnameAssociationListResponse = HostnameAssociationsAPI.HostnameAssociationListResponse;
- export import HostnameAssociationReplaceResponse = HostnameAssociationsAPI.HostnameAssociationReplaceResponse;
+ export import HostnameAssociationUpdateParams = HostnameAssociationsAPI.HostnameAssociationUpdateParams;
export import HostnameAssociationListParams = HostnameAssociationsAPI.HostnameAssociationListParams;
- export import HostnameAssociationReplaceParams = HostnameAssociationsAPI.HostnameAssociationReplaceParams;
}
diff --git a/src/resources/certificate-authorities/index.ts b/src/resources/certificate-authorities/index.ts
index 768d917732..f9f3fa9712 100644
--- a/src/resources/certificate-authorities/index.ts
+++ b/src/resources/certificate-authorities/index.ts
@@ -2,9 +2,9 @@
export { CertificateAuthorities } from './certificate-authorities';
export {
+ HostnameAssociationUpdateResponse,
HostnameAssociationListResponse,
- HostnameAssociationReplaceResponse,
+ HostnameAssociationUpdateParams,
HostnameAssociationListParams,
- HostnameAssociationReplaceParams,
HostnameAssociations,
} from './hostname-associations';
diff --git a/src/resources/challenges/challenges.ts b/src/resources/challenges/challenges.ts
index 3c9c544eda..10a943f87f 100644
--- a/src/resources/challenges/challenges.ts
+++ b/src/resources/challenges/challenges.ts
@@ -10,14 +10,14 @@ export class Challenges extends APIResource {
export namespace Challenges {
export import Widgets = WidgetsAPI.Widgets;
export import WidgetCreateResponse = WidgetsAPI.WidgetCreateResponse;
+ export import WidgetUpdateResponse = WidgetsAPI.WidgetUpdateResponse;
export import WidgetListResponse = WidgetsAPI.WidgetListResponse;
export import WidgetDeleteResponse = WidgetsAPI.WidgetDeleteResponse;
export import WidgetGetResponse = WidgetsAPI.WidgetGetResponse;
- export import WidgetReplaceResponse = WidgetsAPI.WidgetReplaceResponse;
export import WidgetRotateSecretResponse = WidgetsAPI.WidgetRotateSecretResponse;
export import WidgetListResponsesV4PagePaginationArray = WidgetsAPI.WidgetListResponsesV4PagePaginationArray;
export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams;
+ export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams;
export import WidgetListParams = WidgetsAPI.WidgetListParams;
- export import WidgetReplaceParams = WidgetsAPI.WidgetReplaceParams;
export import WidgetRotateSecretParams = WidgetsAPI.WidgetRotateSecretParams;
}
diff --git a/src/resources/challenges/index.ts b/src/resources/challenges/index.ts
index d1db622839..08dd43ba3d 100644
--- a/src/resources/challenges/index.ts
+++ b/src/resources/challenges/index.ts
@@ -3,14 +3,14 @@
export { Challenges } from './challenges';
export {
WidgetCreateResponse,
+ WidgetUpdateResponse,
WidgetListResponse,
WidgetDeleteResponse,
WidgetGetResponse,
- WidgetReplaceResponse,
WidgetRotateSecretResponse,
WidgetCreateParams,
+ WidgetUpdateParams,
WidgetListParams,
- WidgetReplaceParams,
WidgetRotateSecretParams,
WidgetListResponsesV4PagePaginationArray,
Widgets,
diff --git a/src/resources/challenges/widgets.ts b/src/resources/challenges/widgets.ts
index 98c10c3a68..3044459b03 100644
--- a/src/resources/challenges/widgets.ts
+++ b/src/resources/challenges/widgets.ts
@@ -25,6 +25,23 @@ export class Widgets extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update the configuration of a widget.
+ */
+ update(
+ accountIdentifier: string,
+ sitekey: string,
+ body: WidgetUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountIdentifier}/challenges/widgets/${sitekey}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: WidgetUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Lists all turnstile widgets of an account.
*/
@@ -84,23 +101,6 @@ export class Widgets extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Update the configuration of a widget.
- */
- replace(
- accountIdentifier: string,
- sitekey: string,
- body: WidgetReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountIdentifier}/challenges/widgets/${sitekey}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: WidgetReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Generate a new secret key for this widget. If `invalidate_immediately` is set to
* `false`, the previous secret remains valid for 2 hours.
@@ -186,9 +186,9 @@ export interface WidgetCreateResponse {
}
/**
- * A Turnstile Widgets configuration as it appears in listings
+ * A Turnstile widget's detailed configuration
*/
-export interface WidgetListResponse {
+export interface WidgetUpdateResponse {
/**
* If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
* challenges in response to malicious bots (ENT only).
@@ -235,6 +235,11 @@ export interface WidgetListResponse {
*/
region: 'world';
+ /**
+ * Secret key for this widget.
+ */
+ secret: string;
+
/**
* Widget item identifier tag.
*/
@@ -242,9 +247,9 @@ export interface WidgetListResponse {
}
/**
- * A Turnstile widget's detailed configuration
+ * A Turnstile Widgets configuration as it appears in listings
*/
-export interface WidgetDeleteResponse {
+export interface WidgetListResponse {
/**
* If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
* challenges in response to malicious bots (ENT only).
@@ -291,11 +296,6 @@ export interface WidgetDeleteResponse {
*/
region: 'world';
- /**
- * Secret key for this widget.
- */
- secret: string;
-
/**
* Widget item identifier tag.
*/
@@ -305,7 +305,7 @@ export interface WidgetDeleteResponse {
/**
* A Turnstile widget's detailed configuration
*/
-export interface WidgetGetResponse {
+export interface WidgetDeleteResponse {
/**
* If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
* challenges in response to malicious bots (ENT only).
@@ -366,7 +366,7 @@ export interface WidgetGetResponse {
/**
* A Turnstile widget's detailed configuration
*/
-export interface WidgetReplaceResponse {
+export interface WidgetGetResponse {
/**
* If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
* challenges in response to malicious bots (ENT only).
@@ -547,19 +547,7 @@ export interface WidgetCreateParams {
region?: 'world';
}
-export interface WidgetListParams extends V4PagePaginationArrayParams {
- /**
- * Direction to order widgets.
- */
- direction?: 'asc' | 'desc';
-
- /**
- * Field to order widgets by.
- */
- order?: 'id' | 'sitekey' | 'name' | 'created_on' | 'modified_on';
-}
-
-export interface WidgetReplaceParams {
+export interface WidgetUpdateParams {
domains: Array;
/**
@@ -592,6 +580,18 @@ export interface WidgetReplaceParams {
offlabel?: boolean;
}
+export interface WidgetListParams extends V4PagePaginationArrayParams {
+ /**
+ * Direction to order widgets.
+ */
+ direction?: 'asc' | 'desc';
+
+ /**
+ * Field to order widgets by.
+ */
+ order?: 'id' | 'sitekey' | 'name' | 'created_on' | 'modified_on';
+}
+
export interface WidgetRotateSecretParams {
/**
* If `invalidate_immediately` is set to `false`, the previous secret will remain
@@ -603,14 +603,14 @@ export interface WidgetRotateSecretParams {
export namespace Widgets {
export import WidgetCreateResponse = WidgetsAPI.WidgetCreateResponse;
+ export import WidgetUpdateResponse = WidgetsAPI.WidgetUpdateResponse;
export import WidgetListResponse = WidgetsAPI.WidgetListResponse;
export import WidgetDeleteResponse = WidgetsAPI.WidgetDeleteResponse;
export import WidgetGetResponse = WidgetsAPI.WidgetGetResponse;
- export import WidgetReplaceResponse = WidgetsAPI.WidgetReplaceResponse;
export import WidgetRotateSecretResponse = WidgetsAPI.WidgetRotateSecretResponse;
export import WidgetListResponsesV4PagePaginationArray = WidgetsAPI.WidgetListResponsesV4PagePaginationArray;
export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams;
+ export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams;
export import WidgetListParams = WidgetsAPI.WidgetListParams;
- export import WidgetReplaceParams = WidgetsAPI.WidgetReplaceParams;
export import WidgetRotateSecretParams = WidgetsAPI.WidgetRotateSecretParams;
}
diff --git a/src/resources/client-certificates.ts b/src/resources/client-certificates.ts
index 70bf5cbb17..5c7f71381c 100644
--- a/src/resources/client-certificates.ts
+++ b/src/resources/client-certificates.ts
@@ -22,23 +22,6 @@ export class ClientCertificates extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * If a API Shield mTLS Client Certificate is in a pending_revocation state, you
- * may reactivate it with this endpoint.
- */
- update(
- zoneId: string,
- clientCertificateId: string,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(
- `/zones/${zoneId}/client_certificates/${clientCertificateId}`,
- options,
- ) as Core.APIPromise<{ result: ClientCertificateUpdateResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* List all of your Zone's API Shield mTLS Client Certificates by Status and/or
* using Pagination
@@ -84,6 +67,23 @@ export class ClientCertificates extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * If a API Shield mTLS Client Certificate is in a pending_revocation state, you
+ * may reactivate it with this endpoint.
+ */
+ edit(
+ zoneId: string,
+ clientCertificateId: string,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(
+ `/zones/${zoneId}/client_certificates/${clientCertificateId}`,
+ options,
+ ) as Core.APIPromise<{ result: ClientCertificateEditResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Get Details for a single mTLS API Shield Client Certificate
*/
@@ -207,7 +207,7 @@ export namespace ClientCertificateCreateResponse {
}
}
-export interface ClientCertificateUpdateResponse {
+export interface ClientCertificateListResponse {
/**
* Identifier
*/
@@ -221,7 +221,7 @@ export interface ClientCertificateUpdateResponse {
/**
* Certificate Authority used to issue the Client Certificate
*/
- certificate_authority?: ClientCertificateUpdateResponse.CertificateAuthority;
+ certificate_authority?: ClientCertificateListResponse.CertificateAuthority;
/**
* Common Name of the Client Certificate
@@ -300,7 +300,7 @@ export interface ClientCertificateUpdateResponse {
validity_days?: number;
}
-export namespace ClientCertificateUpdateResponse {
+export namespace ClientCertificateListResponse {
/**
* Certificate Authority used to issue the Client Certificate
*/
@@ -311,7 +311,7 @@ export namespace ClientCertificateUpdateResponse {
}
}
-export interface ClientCertificateListResponse {
+export interface ClientCertificateDeleteResponse {
/**
* Identifier
*/
@@ -325,7 +325,7 @@ export interface ClientCertificateListResponse {
/**
* Certificate Authority used to issue the Client Certificate
*/
- certificate_authority?: ClientCertificateListResponse.CertificateAuthority;
+ certificate_authority?: ClientCertificateDeleteResponse.CertificateAuthority;
/**
* Common Name of the Client Certificate
@@ -404,7 +404,7 @@ export interface ClientCertificateListResponse {
validity_days?: number;
}
-export namespace ClientCertificateListResponse {
+export namespace ClientCertificateDeleteResponse {
/**
* Certificate Authority used to issue the Client Certificate
*/
@@ -415,7 +415,7 @@ export namespace ClientCertificateListResponse {
}
}
-export interface ClientCertificateDeleteResponse {
+export interface ClientCertificateEditResponse {
/**
* Identifier
*/
@@ -429,7 +429,7 @@ export interface ClientCertificateDeleteResponse {
/**
* Certificate Authority used to issue the Client Certificate
*/
- certificate_authority?: ClientCertificateDeleteResponse.CertificateAuthority;
+ certificate_authority?: ClientCertificateEditResponse.CertificateAuthority;
/**
* Common Name of the Client Certificate
@@ -508,7 +508,7 @@ export interface ClientCertificateDeleteResponse {
validity_days?: number;
}
-export namespace ClientCertificateDeleteResponse {
+export namespace ClientCertificateEditResponse {
/**
* Certificate Authority used to issue the Client Certificate
*/
@@ -654,9 +654,9 @@ export interface ClientCertificateListParams extends V4PagePaginationArrayParams
export namespace ClientCertificates {
export import ClientCertificateCreateResponse = ClientCertificatesAPI.ClientCertificateCreateResponse;
- export import ClientCertificateUpdateResponse = ClientCertificatesAPI.ClientCertificateUpdateResponse;
export import ClientCertificateListResponse = ClientCertificatesAPI.ClientCertificateListResponse;
export import ClientCertificateDeleteResponse = ClientCertificatesAPI.ClientCertificateDeleteResponse;
+ export import ClientCertificateEditResponse = ClientCertificatesAPI.ClientCertificateEditResponse;
export import ClientCertificateGetResponse = ClientCertificatesAPI.ClientCertificateGetResponse;
export import ClientCertificateListResponsesV4PagePaginationArray = ClientCertificatesAPI.ClientCertificateListResponsesV4PagePaginationArray;
export import ClientCertificateCreateParams = ClientCertificatesAPI.ClientCertificateCreateParams;
diff --git a/src/resources/custom-certificates/custom-certificates.ts b/src/resources/custom-certificates/custom-certificates.ts
index a2626eff55..3061635d27 100644
--- a/src/resources/custom-certificates/custom-certificates.ts
+++ b/src/resources/custom-certificates/custom-certificates.ts
@@ -25,25 +25,6 @@ export class CustomCertificates extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing
- * a configuration for sni_custom certificates will result in a new resource id
- * being returned, and the previous one being deleted.
- */
- update(
- zoneId: string,
- customCertificateId: string,
- body: CustomCertificateUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(`/zones/${zoneId}/custom_certificates/${customCertificateId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: CustomCertificateUpdateResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* List, search, and filter all of your custom SSL certificates. The higher
* priority will break ties across overlapping 'legacy_custom' certificates, but
@@ -89,6 +70,25 @@ export class CustomCertificates extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing
+ * a configuration for sni_custom certificates will result in a new resource id
+ * being returned, and the previous one being deleted.
+ */
+ edit(
+ zoneId: string,
+ customCertificateId: string,
+ body: CustomCertificateEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(`/zones/${zoneId}/custom_certificates/${customCertificateId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: CustomCertificateEditResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* SSL Configuration Details
*/
@@ -110,8 +110,6 @@ export class CustomCertificateListResponsesV4PagePaginationArray extends V4PageP
export type CustomCertificateCreateResponse = unknown | string;
-export type CustomCertificateUpdateResponse = unknown | string;
-
export interface CustomCertificateListResponse {
/**
* Identifier
@@ -291,6 +289,8 @@ export interface CustomCertificateDeleteResponse {
id?: string;
}
+export type CustomCertificateEditResponse = unknown | string;
+
export type CustomCertificateGetResponse = unknown | string;
export interface CustomCertificateCreateParams {
@@ -358,7 +358,14 @@ export namespace CustomCertificateCreateParams {
}
}
-export interface CustomCertificateUpdateParams {
+export interface CustomCertificateListParams extends V4PagePaginationArrayParams {
+ /**
+ * Whether to match all search requirements or at least one (any).
+ */
+ match?: 'any' | 'all';
+}
+
+export interface CustomCertificateEditParams {
/**
* A ubiquitous bundle has the highest probability of being verified everywhere,
* even by clients using outdated or unusual trust stores. An optimal bundle uses
@@ -381,7 +388,7 @@ export interface CustomCertificateUpdateParams {
* security data centers. Default distribution is to all Cloudflare datacenters,
* for optimal performance.
*/
- geo_restrictions?: CustomCertificateUpdateParams.GeoRestrictions;
+ geo_restrictions?: CustomCertificateEditParams.GeoRestrictions;
/**
* Specify the policy that determines the region where your private key will be
@@ -402,7 +409,7 @@ export interface CustomCertificateUpdateParams {
private_key?: string;
}
-export namespace CustomCertificateUpdateParams {
+export namespace CustomCertificateEditParams {
/**
* Specify the region where your private key can be held locally for optimal TLS
* performance. HTTPS connections to any excluded data center will still be fully
@@ -417,24 +424,17 @@ export namespace CustomCertificateUpdateParams {
}
}
-export interface CustomCertificateListParams extends V4PagePaginationArrayParams {
- /**
- * Whether to match all search requirements or at least one (any).
- */
- match?: 'any' | 'all';
-}
-
export namespace CustomCertificates {
export import CustomCertificateCreateResponse = CustomCertificatesAPI.CustomCertificateCreateResponse;
- export import CustomCertificateUpdateResponse = CustomCertificatesAPI.CustomCertificateUpdateResponse;
export import CustomCertificateListResponse = CustomCertificatesAPI.CustomCertificateListResponse;
export import CustomCertificateDeleteResponse = CustomCertificatesAPI.CustomCertificateDeleteResponse;
+ export import CustomCertificateEditResponse = CustomCertificatesAPI.CustomCertificateEditResponse;
export import CustomCertificateGetResponse = CustomCertificatesAPI.CustomCertificateGetResponse;
export import CustomCertificateListResponsesV4PagePaginationArray = CustomCertificatesAPI.CustomCertificateListResponsesV4PagePaginationArray;
export import CustomCertificateCreateParams = CustomCertificatesAPI.CustomCertificateCreateParams;
- export import CustomCertificateUpdateParams = CustomCertificatesAPI.CustomCertificateUpdateParams;
export import CustomCertificateListParams = CustomCertificatesAPI.CustomCertificateListParams;
+ export import CustomCertificateEditParams = CustomCertificatesAPI.CustomCertificateEditParams;
export import Prioritize = PrioritizeAPI.Prioritize;
- export import PrioritizeReplaceResponse = PrioritizeAPI.PrioritizeReplaceResponse;
- export import PrioritizeReplaceParams = PrioritizeAPI.PrioritizeReplaceParams;
+ export import PrioritizeUpdateResponse = PrioritizeAPI.PrioritizeUpdateResponse;
+ export import PrioritizeUpdateParams = PrioritizeAPI.PrioritizeUpdateParams;
}
diff --git a/src/resources/custom-certificates/index.ts b/src/resources/custom-certificates/index.ts
index 8b003ea770..0d012b7b72 100644
--- a/src/resources/custom-certificates/index.ts
+++ b/src/resources/custom-certificates/index.ts
@@ -2,14 +2,14 @@
export {
CustomCertificateCreateResponse,
- CustomCertificateUpdateResponse,
CustomCertificateListResponse,
CustomCertificateDeleteResponse,
+ CustomCertificateEditResponse,
CustomCertificateGetResponse,
CustomCertificateCreateParams,
- CustomCertificateUpdateParams,
CustomCertificateListParams,
+ CustomCertificateEditParams,
CustomCertificateListResponsesV4PagePaginationArray,
CustomCertificates,
} from './custom-certificates';
-export { PrioritizeReplaceResponse, PrioritizeReplaceParams, Prioritize } from './prioritize';
+export { PrioritizeUpdateResponse, PrioritizeUpdateParams, Prioritize } from './prioritize';
diff --git a/src/resources/custom-certificates/prioritize.ts b/src/resources/custom-certificates/prioritize.ts
index 4db50348af..6374f76d24 100644
--- a/src/resources/custom-certificates/prioritize.ts
+++ b/src/resources/custom-certificates/prioritize.ts
@@ -10,24 +10,24 @@ export class Prioritize extends APIResource {
* should be used during a request. The higher priority will break ties across
* overlapping 'legacy_custom' certificates.
*/
- replace(
+ update(
zoneId: string,
- body: PrioritizeReplaceParams,
+ body: PrioritizeUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.put(`/zones/${zoneId}/custom_certificates/prioritize`, {
body,
...options,
- }) as Core.APIPromise<{ result: PrioritizeReplaceResponse | null }>
+ }) as Core.APIPromise<{ result: PrioritizeUpdateResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type PrioritizeReplaceResponse = Array;
+export type PrioritizeUpdateResponse = Array;
-export namespace PrioritizeReplaceResponse {
- export interface PrioritizeReplaceResponseItem {
+export namespace PrioritizeUpdateResponse {
+ export interface PrioritizeUpdateResponseItem {
/**
* Identifier
*/
@@ -95,9 +95,9 @@ export namespace PrioritizeReplaceResponse {
* security data centers. Default distribution is to all Cloudflare datacenters,
* for optimal performance.
*/
- geo_restrictions?: PrioritizeReplaceResponseItem.GeoRestrictions;
+ geo_restrictions?: PrioritizeUpdateResponseItem.GeoRestrictions;
- keyless_server?: PrioritizeReplaceResponseItem.KeylessServer;
+ keyless_server?: PrioritizeUpdateResponseItem.KeylessServer;
/**
* Specify the policy that determines the region where your private key will be
@@ -113,7 +113,7 @@ export namespace PrioritizeReplaceResponse {
policy?: string;
}
- export namespace PrioritizeReplaceResponseItem {
+ export namespace PrioritizeUpdateResponseItem {
/**
* Specify the region where your private key can be held locally for optimal TLS
* performance. HTTPS connections to any excluded data center will still be fully
@@ -200,14 +200,14 @@ export namespace PrioritizeReplaceResponse {
}
}
-export interface PrioritizeReplaceParams {
+export interface PrioritizeUpdateParams {
/**
* Array of ordered certificates.
*/
- certificates: Array;
+ certificates: Array;
}
-export namespace PrioritizeReplaceParams {
+export namespace PrioritizeUpdateParams {
export interface Certificate {
/**
* The order/priority in which the certificate will be used in a request. The
@@ -220,6 +220,6 @@ export namespace PrioritizeReplaceParams {
}
export namespace Prioritize {
- export import PrioritizeReplaceResponse = PrioritizeAPI.PrioritizeReplaceResponse;
- export import PrioritizeReplaceParams = PrioritizeAPI.PrioritizeReplaceParams;
+ export import PrioritizeUpdateResponse = PrioritizeAPI.PrioritizeUpdateResponse;
+ export import PrioritizeUpdateParams = PrioritizeAPI.PrioritizeUpdateParams;
}
diff --git a/src/resources/custom-hostnames/custom-hostnames.ts b/src/resources/custom-hostnames/custom-hostnames.ts
index 822dd7d830..1373aa2948 100644
--- a/src/resources/custom-hostnames/custom-hostnames.ts
+++ b/src/resources/custom-hostnames/custom-hostnames.ts
@@ -31,26 +31,6 @@ export class CustomHostnames extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Modify SSL configuration for a custom hostname. When sent with SSL config that
- * matches existing config, used to indicate that hostname should pass domain
- * control validation (DCV). Can also be used to change validation type, e.g., from
- * 'http' to 'email'.
- */
- update(
- zoneId: string,
- customHostnameId: string,
- body: CustomHostnameUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(`/zones/${zoneId}/custom_hostnames/${customHostnameId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: CustomHostnameUpdateResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* List, search, sort, and filter all of your custom hostnames.
*/
@@ -89,6 +69,26 @@ export class CustomHostnames extends APIResource {
return this._client.delete(`/zones/${zoneId}/custom_hostnames/${customHostnameId}`, options);
}
+ /**
+ * Modify SSL configuration for a custom hostname. When sent with SSL config that
+ * matches existing config, used to indicate that hostname should pass domain
+ * control validation (DCV). Can also be used to change validation type, e.g., from
+ * 'http' to 'email'.
+ */
+ edit(
+ zoneId: string,
+ customHostnameId: string,
+ body: CustomHostnameEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(`/zones/${zoneId}/custom_hostnames/${customHostnameId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: CustomHostnameEditResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Custom Hostname Details
*/
@@ -323,7 +323,7 @@ export namespace CustomHostnameCreateResponse {
}
}
-export interface CustomHostnameUpdateResponse {
+export interface CustomHostnameListResponse {
/**
* Identifier
*/
@@ -337,10 +337,10 @@ export interface CustomHostnameUpdateResponse {
/**
* SSL properties for the custom hostname.
*/
- ssl: CustomHostnameUpdateResponse.SSL;
+ ssl: CustomHostnameListResponse.SSL;
}
-export namespace CustomHostnameUpdateResponse {
+export namespace CustomHostnameListResponse {
/**
* SSL properties for the custom hostname.
*/
@@ -539,7 +539,14 @@ export namespace CustomHostnameUpdateResponse {
}
}
-export interface CustomHostnameListResponse {
+export interface CustomHostnameDeleteResponse {
+ /**
+ * Identifier
+ */
+ id?: string;
+}
+
+export interface CustomHostnameEditResponse {
/**
* Identifier
*/
@@ -553,10 +560,10 @@ export interface CustomHostnameListResponse {
/**
* SSL properties for the custom hostname.
*/
- ssl: CustomHostnameListResponse.SSL;
+ ssl: CustomHostnameEditResponse.SSL;
}
-export namespace CustomHostnameListResponse {
+export namespace CustomHostnameEditResponse {
/**
* SSL properties for the custom hostname.
*/
@@ -755,13 +762,6 @@ export namespace CustomHostnameListResponse {
}
}
-export interface CustomHostnameDeleteResponse {
- /**
- * Identifier
- */
- id?: string;
-}
-
export interface CustomHostnameGetResponse {
/**
* Identifier
@@ -1089,11 +1089,41 @@ export namespace CustomHostnameCreateParams {
}
}
-export interface CustomHostnameUpdateParams {
+export interface CustomHostnameListParams extends V4PagePaginationArrayParams {
+ /**
+ * Hostname ID to match against. This ID was generated and returned during the
+ * initial custom_hostname creation. This parameter cannot be used with the
+ * 'hostname' parameter.
+ */
+ id?: string;
+
+ /**
+ * Direction to order hostnames.
+ */
+ direction?: 'asc' | 'desc';
+
+ /**
+ * Fully qualified domain name to match against. This parameter cannot be used with
+ * the 'id' parameter.
+ */
+ hostname?: string;
+
+ /**
+ * Field to order hostnames by.
+ */
+ order?: 'ssl' | 'ssl_status';
+
+ /**
+ * Whether to filter hostnames based on if they have SSL enabled.
+ */
+ ssl?: 0 | 1;
+}
+
+export interface CustomHostnameEditParams {
/**
* These are per-hostname (customer) settings.
*/
- custom_metadata?: CustomHostnameUpdateParams.CustomMetadata;
+ custom_metadata?: CustomHostnameEditParams.CustomMetadata;
/**
* a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -1113,10 +1143,10 @@ export interface CustomHostnameUpdateParams {
/**
* SSL properties used when creating the custom hostname.
*/
- ssl?: CustomHostnameUpdateParams.SSL;
+ ssl?: CustomHostnameEditParams.SSL;
}
-export namespace CustomHostnameUpdateParams {
+export namespace CustomHostnameEditParams {
/**
* These are per-hostname (customer) settings.
*/
@@ -1210,49 +1240,19 @@ export namespace CustomHostnameUpdateParams {
}
}
-export interface CustomHostnameListParams extends V4PagePaginationArrayParams {
- /**
- * Hostname ID to match against. This ID was generated and returned during the
- * initial custom_hostname creation. This parameter cannot be used with the
- * 'hostname' parameter.
- */
- id?: string;
-
- /**
- * Direction to order hostnames.
- */
- direction?: 'asc' | 'desc';
-
- /**
- * Fully qualified domain name to match against. This parameter cannot be used with
- * the 'id' parameter.
- */
- hostname?: string;
-
- /**
- * Field to order hostnames by.
- */
- order?: 'ssl' | 'ssl_status';
-
- /**
- * Whether to filter hostnames based on if they have SSL enabled.
- */
- ssl?: 0 | 1;
-}
-
export namespace CustomHostnames {
export import CustomHostnameCreateResponse = CustomHostnamesAPI.CustomHostnameCreateResponse;
- export import CustomHostnameUpdateResponse = CustomHostnamesAPI.CustomHostnameUpdateResponse;
export import CustomHostnameListResponse = CustomHostnamesAPI.CustomHostnameListResponse;
export import CustomHostnameDeleteResponse = CustomHostnamesAPI.CustomHostnameDeleteResponse;
+ export import CustomHostnameEditResponse = CustomHostnamesAPI.CustomHostnameEditResponse;
export import CustomHostnameGetResponse = CustomHostnamesAPI.CustomHostnameGetResponse;
export import CustomHostnameListResponsesV4PagePaginationArray = CustomHostnamesAPI.CustomHostnameListResponsesV4PagePaginationArray;
export import CustomHostnameCreateParams = CustomHostnamesAPI.CustomHostnameCreateParams;
- export import CustomHostnameUpdateParams = CustomHostnamesAPI.CustomHostnameUpdateParams;
export import CustomHostnameListParams = CustomHostnamesAPI.CustomHostnameListParams;
+ export import CustomHostnameEditParams = CustomHostnamesAPI.CustomHostnameEditParams;
export import FallbackOrigin = FallbackOriginAPI.FallbackOrigin;
+ export import FallbackOriginUpdateResponse = FallbackOriginAPI.FallbackOriginUpdateResponse;
export import FallbackOriginDeleteResponse = FallbackOriginAPI.FallbackOriginDeleteResponse;
export import FallbackOriginGetResponse = FallbackOriginAPI.FallbackOriginGetResponse;
- export import FallbackOriginReplaceResponse = FallbackOriginAPI.FallbackOriginReplaceResponse;
- export import FallbackOriginReplaceParams = FallbackOriginAPI.FallbackOriginReplaceParams;
+ export import FallbackOriginUpdateParams = FallbackOriginAPI.FallbackOriginUpdateParams;
}
diff --git a/src/resources/custom-hostnames/fallback-origin.ts b/src/resources/custom-hostnames/fallback-origin.ts
index f7ce1f1256..9471e0ff3e 100644
--- a/src/resources/custom-hostnames/fallback-origin.ts
+++ b/src/resources/custom-hostnames/fallback-origin.ts
@@ -5,6 +5,22 @@ import { APIResource } from 'cloudflare/resource';
import * as FallbackOriginAPI from 'cloudflare/resources/custom-hostnames/fallback-origin';
export class FallbackOrigin extends APIResource {
+ /**
+ * Update Fallback Origin for Custom Hostnames
+ */
+ update(
+ zoneId: string,
+ body: FallbackOriginUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/zones/${zoneId}/custom_hostnames/fallback_origin`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: FallbackOriginUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Delete Fallback Origin for Custom Hostnames
*/
@@ -26,31 +42,15 @@ export class FallbackOrigin extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Update Fallback Origin for Custom Hostnames
- */
- replace(
- zoneId: string,
- body: FallbackOriginReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/zones/${zoneId}/custom_hostnames/fallback_origin`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: FallbackOriginReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
+export type FallbackOriginUpdateResponse = unknown | string;
+
export type FallbackOriginDeleteResponse = unknown | string;
export type FallbackOriginGetResponse = unknown | string;
-export type FallbackOriginReplaceResponse = unknown | string;
-
-export interface FallbackOriginReplaceParams {
+export interface FallbackOriginUpdateParams {
/**
* Your origin hostname that requests to your custom hostnames will be sent to.
*/
@@ -58,8 +58,8 @@ export interface FallbackOriginReplaceParams {
}
export namespace FallbackOrigin {
+ export import FallbackOriginUpdateResponse = FallbackOriginAPI.FallbackOriginUpdateResponse;
export import FallbackOriginDeleteResponse = FallbackOriginAPI.FallbackOriginDeleteResponse;
export import FallbackOriginGetResponse = FallbackOriginAPI.FallbackOriginGetResponse;
- export import FallbackOriginReplaceResponse = FallbackOriginAPI.FallbackOriginReplaceResponse;
- export import FallbackOriginReplaceParams = FallbackOriginAPI.FallbackOriginReplaceParams;
+ export import FallbackOriginUpdateParams = FallbackOriginAPI.FallbackOriginUpdateParams;
}
diff --git a/src/resources/custom-hostnames/index.ts b/src/resources/custom-hostnames/index.ts
index 3bc5aa7801..8030b233cc 100644
--- a/src/resources/custom-hostnames/index.ts
+++ b/src/resources/custom-hostnames/index.ts
@@ -2,20 +2,20 @@
export {
CustomHostnameCreateResponse,
- CustomHostnameUpdateResponse,
CustomHostnameListResponse,
CustomHostnameDeleteResponse,
+ CustomHostnameEditResponse,
CustomHostnameGetResponse,
CustomHostnameCreateParams,
- CustomHostnameUpdateParams,
CustomHostnameListParams,
+ CustomHostnameEditParams,
CustomHostnameListResponsesV4PagePaginationArray,
CustomHostnames,
} from './custom-hostnames';
export {
+ FallbackOriginUpdateResponse,
FallbackOriginDeleteResponse,
FallbackOriginGetResponse,
- FallbackOriginReplaceResponse,
- FallbackOriginReplaceParams,
+ FallbackOriginUpdateParams,
FallbackOrigin,
} from './fallback-origin';
diff --git a/src/resources/devices/devices.ts b/src/resources/devices/devices.ts
index c63e30f106..4eff880a6b 100644
--- a/src/resources/devices/devices.ts
+++ b/src/resources/devices/devices.ts
@@ -179,43 +179,43 @@ export namespace Devices {
export import DeviceGetResponse = DevicesAPI.DeviceGetResponse;
export import DEXTests = DEXTestsAPI.DEXTests;
export import DEXTestCreateResponse = DEXTestsAPI.DEXTestCreateResponse;
+ export import DEXTestUpdateResponse = DEXTestsAPI.DEXTestUpdateResponse;
export import DEXTestListResponse = DEXTestsAPI.DEXTestListResponse;
export import DEXTestDeleteResponse = DEXTestsAPI.DEXTestDeleteResponse;
export import DEXTestGetResponse = DEXTestsAPI.DEXTestGetResponse;
- export import DEXTestReplaceResponse = DEXTestsAPI.DEXTestReplaceResponse;
export import DEXTestCreateParams = DEXTestsAPI.DEXTestCreateParams;
- export import DEXTestReplaceParams = DEXTestsAPI.DEXTestReplaceParams;
+ export import DEXTestUpdateParams = DEXTestsAPI.DEXTestUpdateParams;
export import Networks = NetworksAPI.Networks;
export import NetworkCreateResponse = NetworksAPI.NetworkCreateResponse;
+ export import NetworkUpdateResponse = NetworksAPI.NetworkUpdateResponse;
export import NetworkListResponse = NetworksAPI.NetworkListResponse;
export import NetworkDeleteResponse = NetworksAPI.NetworkDeleteResponse;
export import NetworkGetResponse = NetworksAPI.NetworkGetResponse;
- export import NetworkReplaceResponse = NetworksAPI.NetworkReplaceResponse;
export import NetworkCreateParams = NetworksAPI.NetworkCreateParams;
- export import NetworkReplaceParams = NetworksAPI.NetworkReplaceParams;
+ export import NetworkUpdateParams = NetworksAPI.NetworkUpdateParams;
export import Policies = PoliciesAPI.Policies;
export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
- export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
+ export import PolicyEditResponse = PoliciesAPI.PolicyEditResponse;
export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
- export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
+ export import PolicyEditParams = PoliciesAPI.PolicyEditParams;
export import Postures = PosturesAPI.Postures;
export import PostureCreateResponse = PosturesAPI.PostureCreateResponse;
+ export import PostureUpdateResponse = PosturesAPI.PostureUpdateResponse;
export import PostureListResponse = PosturesAPI.PostureListResponse;
export import PostureDeleteResponse = PosturesAPI.PostureDeleteResponse;
export import PostureGetResponse = PosturesAPI.PostureGetResponse;
- export import PostureReplaceResponse = PosturesAPI.PostureReplaceResponse;
export import PostureCreateParams = PosturesAPI.PostureCreateParams;
- export import PostureReplaceParams = PosturesAPI.PostureReplaceParams;
+ export import PostureUpdateParams = PosturesAPI.PostureUpdateParams;
export import Revokes = RevokesAPI.Revokes;
export import RevokeCreateResponse = RevokesAPI.RevokeCreateResponse;
export import RevokeCreateParams = RevokesAPI.RevokeCreateParams;
export import Settings = SettingsAPI.Settings;
+ export import SettingUpdateResponse = SettingsAPI.SettingUpdateResponse;
export import SettingListResponse = SettingsAPI.SettingListResponse;
- export import SettingReplaceResponse = SettingsAPI.SettingReplaceResponse;
- export import SettingReplaceParams = SettingsAPI.SettingReplaceParams;
+ export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
export import Unrevokes = UnrevokesAPI.Unrevokes;
export import UnrevokeCreateResponse = UnrevokesAPI.UnrevokeCreateResponse;
export import UnrevokeCreateParams = UnrevokesAPI.UnrevokeCreateParams;
diff --git a/src/resources/devices/dex-tests.ts b/src/resources/devices/dex-tests.ts
index 6faa471132..42fdc2f3db 100644
--- a/src/resources/devices/dex-tests.ts
+++ b/src/resources/devices/dex-tests.ts
@@ -21,6 +21,23 @@ export class DEXTests extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update a DEX test.
+ */
+ update(
+ identifier: unknown,
+ uuid: string,
+ body: DEXTestUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${identifier}/devices/dex_tests/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: DEXTestUpdateResponse | null }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Fetch all DEX tests.
*/
@@ -62,31 +79,65 @@ export class DEXTests extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface DEXTestCreateResponse {
/**
- * Update a DEX test.
+ * The configuration object which contains the details for the WARP client to
+ * conduct the test.
*/
- replace(
- identifier: unknown,
- uuid: string,
- body: DEXTestReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${identifier}/devices/dex_tests/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: DEXTestReplaceResponse | null }>
- )._thenUnwrap((obj) => obj.result);
+ data: DEXTestCreateResponse.Data;
+
+ /**
+ * Determines whether or not the test is active.
+ */
+ enabled: boolean;
+
+ /**
+ * How often the test will run.
+ */
+ interval: string;
+
+ /**
+ * The name of the DEX test. Must be unique.
+ */
+ name: string;
+
+ /**
+ * Additional details about the test.
+ */
+ description?: string;
+}
+
+export namespace DEXTestCreateResponse {
+ /**
+ * The configuration object which contains the details for the WARP client to
+ * conduct the test.
+ */
+ export interface Data {
+ /**
+ * The desired endpoint to test.
+ */
+ host?: string;
+
+ /**
+ * The type of test.
+ */
+ kind?: string;
+
+ /**
+ * The HTTP request method type.
+ */
+ method?: string;
}
}
-export interface DEXTestCreateResponse {
+export interface DEXTestUpdateResponse {
/**
* The configuration object which contains the details for the WARP client to
* conduct the test.
*/
- data: DEXTestCreateResponse.Data;
+ data: DEXTestUpdateResponse.Data;
/**
* Determines whether or not the test is active.
@@ -109,7 +160,7 @@ export interface DEXTestCreateResponse {
description?: string;
}
-export namespace DEXTestCreateResponse {
+export namespace DEXTestUpdateResponse {
/**
* The configuration object which contains the details for the WARP client to
* conduct the test.
@@ -293,57 +344,6 @@ export namespace DEXTestGetResponse {
}
}
-export interface DEXTestReplaceResponse {
- /**
- * The configuration object which contains the details for the WARP client to
- * conduct the test.
- */
- data: DEXTestReplaceResponse.Data;
-
- /**
- * Determines whether or not the test is active.
- */
- enabled: boolean;
-
- /**
- * How often the test will run.
- */
- interval: string;
-
- /**
- * The name of the DEX test. Must be unique.
- */
- name: string;
-
- /**
- * Additional details about the test.
- */
- description?: string;
-}
-
-export namespace DEXTestReplaceResponse {
- /**
- * The configuration object which contains the details for the WARP client to
- * conduct the test.
- */
- export interface Data {
- /**
- * The desired endpoint to test.
- */
- host?: string;
-
- /**
- * The type of test.
- */
- kind?: string;
-
- /**
- * The HTTP request method type.
- */
- method?: string;
- }
-}
-
export interface DEXTestCreateParams {
/**
* The configuration object which contains the details for the WARP client to
@@ -395,12 +395,12 @@ export namespace DEXTestCreateParams {
}
}
-export interface DEXTestReplaceParams {
+export interface DEXTestUpdateParams {
/**
* The configuration object which contains the details for the WARP client to
* conduct the test.
*/
- data: DEXTestReplaceParams.Data;
+ data: DEXTestUpdateParams.Data;
/**
* Determines whether or not the test is active.
@@ -423,7 +423,7 @@ export interface DEXTestReplaceParams {
description?: string;
}
-export namespace DEXTestReplaceParams {
+export namespace DEXTestUpdateParams {
/**
* The configuration object which contains the details for the WARP client to
* conduct the test.
@@ -448,10 +448,10 @@ export namespace DEXTestReplaceParams {
export namespace DEXTests {
export import DEXTestCreateResponse = DEXTestsAPI.DEXTestCreateResponse;
+ export import DEXTestUpdateResponse = DEXTestsAPI.DEXTestUpdateResponse;
export import DEXTestListResponse = DEXTestsAPI.DEXTestListResponse;
export import DEXTestDeleteResponse = DEXTestsAPI.DEXTestDeleteResponse;
export import DEXTestGetResponse = DEXTestsAPI.DEXTestGetResponse;
- export import DEXTestReplaceResponse = DEXTestsAPI.DEXTestReplaceResponse;
export import DEXTestCreateParams = DEXTestsAPI.DEXTestCreateParams;
- export import DEXTestReplaceParams = DEXTestsAPI.DEXTestReplaceParams;
+ export import DEXTestUpdateParams = DEXTestsAPI.DEXTestUpdateParams;
}
diff --git a/src/resources/devices/index.ts b/src/resources/devices/index.ts
index 3c57b6bd0a..0497b2dd45 100644
--- a/src/resources/devices/index.ts
+++ b/src/resources/devices/index.ts
@@ -2,46 +2,46 @@
export {
DEXTestCreateResponse,
+ DEXTestUpdateResponse,
DEXTestListResponse,
DEXTestDeleteResponse,
DEXTestGetResponse,
- DEXTestReplaceResponse,
DEXTestCreateParams,
- DEXTestReplaceParams,
+ DEXTestUpdateParams,
DEXTests,
} from './dex-tests';
export { DeviceDevicesListDevicesResponse, DeviceGetResponse, Devices } from './devices';
export {
NetworkCreateResponse,
+ NetworkUpdateResponse,
NetworkListResponse,
NetworkDeleteResponse,
NetworkGetResponse,
- NetworkReplaceResponse,
NetworkCreateParams,
- NetworkReplaceParams,
+ NetworkUpdateParams,
Networks,
} from './networks';
export { OverrideCodeListResponse, OverrideCodes } from './override-codes';
export {
PolicyCreateResponse,
- PolicyUpdateResponse,
PolicyListResponse,
PolicyDeleteResponse,
+ PolicyEditResponse,
PolicyGetResponse,
PolicyCreateParams,
- PolicyUpdateParams,
+ PolicyEditParams,
Policies,
} from './policies/index';
export {
PostureCreateResponse,
+ PostureUpdateResponse,
PostureListResponse,
PostureDeleteResponse,
PostureGetResponse,
- PostureReplaceResponse,
PostureCreateParams,
- PostureReplaceParams,
+ PostureUpdateParams,
Postures,
} from './postures/index';
export { RevokeCreateResponse, RevokeCreateParams, Revokes } from './revokes';
-export { SettingListResponse, SettingReplaceResponse, SettingReplaceParams, Settings } from './settings';
+export { SettingUpdateResponse, SettingListResponse, SettingUpdateParams, Settings } from './settings';
export { UnrevokeCreateResponse, UnrevokeCreateParams, Unrevokes } from './unrevokes';
diff --git a/src/resources/devices/networks.ts b/src/resources/devices/networks.ts
index c91c95cc61..cf96406d03 100644
--- a/src/resources/devices/networks.ts
+++ b/src/resources/devices/networks.ts
@@ -20,6 +20,23 @@ export class Networks extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a configured device managed network.
+ */
+ update(
+ identifier: unknown,
+ uuid: string,
+ body: NetworkUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${identifier}/devices/networks/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: NetworkUpdateResponse | null }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Fetches a list of managed networks for an account.
*/
@@ -61,31 +78,58 @@ export class Networks extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface NetworkCreateResponse {
/**
- * Updates a configured device managed network.
+ * The configuration object containing information for the WARP client to detect
+ * the managed network.
*/
- replace(
- identifier: unknown,
- uuid: string,
- body: NetworkReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${identifier}/devices/networks/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: NetworkReplaceResponse | null }>
- )._thenUnwrap((obj) => obj.result);
+ config?: NetworkCreateResponse.Config;
+
+ /**
+ * The name of the device managed network. This name must be unique.
+ */
+ name?: string;
+
+ /**
+ * API UUID.
+ */
+ network_id?: string;
+
+ /**
+ * The type of device managed network.
+ */
+ type?: 'tls';
+}
+
+export namespace NetworkCreateResponse {
+ /**
+ * The configuration object containing information for the WARP client to detect
+ * the managed network.
+ */
+ export interface Config {
+ /**
+ * A network address of the form "host:port" that the WARP client will use to
+ * detect the presence of a TLS host.
+ */
+ tls_sockaddr: string;
+
+ /**
+ * The SHA-256 hash of the TLS certificate presented by the host found at
+ * tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
+ * timestamp, etc) will be used to validate the certificate.
+ */
+ sha256?: string;
}
}
-export interface NetworkCreateResponse {
+export interface NetworkUpdateResponse {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
*/
- config?: NetworkCreateResponse.Config;
+ config?: NetworkUpdateResponse.Config;
/**
* The name of the device managed network. This name must be unique.
@@ -103,7 +147,7 @@ export interface NetworkCreateResponse {
type?: 'tls';
}
-export namespace NetworkCreateResponse {
+export namespace NetworkUpdateResponse {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
@@ -264,50 +308,6 @@ export namespace NetworkGetResponse {
}
}
-export interface NetworkReplaceResponse {
- /**
- * The configuration object containing information for the WARP client to detect
- * the managed network.
- */
- config?: NetworkReplaceResponse.Config;
-
- /**
- * The name of the device managed network. This name must be unique.
- */
- name?: string;
-
- /**
- * API UUID.
- */
- network_id?: string;
-
- /**
- * The type of device managed network.
- */
- type?: 'tls';
-}
-
-export namespace NetworkReplaceResponse {
- /**
- * The configuration object containing information for the WARP client to detect
- * the managed network.
- */
- export interface Config {
- /**
- * A network address of the form "host:port" that the WARP client will use to
- * detect the presence of a TLS host.
- */
- tls_sockaddr: string;
-
- /**
- * The SHA-256 hash of the TLS certificate presented by the host found at
- * tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
- * timestamp, etc) will be used to validate the certificate.
- */
- sha256?: string;
- }
-}
-
export interface NetworkCreateParams {
/**
* The configuration object containing information for the WARP client to detect
@@ -347,12 +347,12 @@ export namespace NetworkCreateParams {
}
}
-export interface NetworkReplaceParams {
+export interface NetworkUpdateParams {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
*/
- config?: NetworkReplaceParams.Config;
+ config?: NetworkUpdateParams.Config;
/**
* The name of the device managed network. This name must be unique.
@@ -365,7 +365,7 @@ export interface NetworkReplaceParams {
type?: 'tls';
}
-export namespace NetworkReplaceParams {
+export namespace NetworkUpdateParams {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
@@ -388,10 +388,10 @@ export namespace NetworkReplaceParams {
export namespace Networks {
export import NetworkCreateResponse = NetworksAPI.NetworkCreateResponse;
+ export import NetworkUpdateResponse = NetworksAPI.NetworkUpdateResponse;
export import NetworkListResponse = NetworksAPI.NetworkListResponse;
export import NetworkDeleteResponse = NetworksAPI.NetworkDeleteResponse;
export import NetworkGetResponse = NetworksAPI.NetworkGetResponse;
- export import NetworkReplaceResponse = NetworksAPI.NetworkReplaceResponse;
export import NetworkCreateParams = NetworksAPI.NetworkCreateParams;
- export import NetworkReplaceParams = NetworksAPI.NetworkReplaceParams;
+ export import NetworkUpdateParams = NetworksAPI.NetworkUpdateParams;
}
diff --git a/src/resources/devices/policies/excludes.ts b/src/resources/devices/policies/excludes.ts
index 3af51bd907..8972d7fec6 100644
--- a/src/resources/devices/policies/excludes.ts
+++ b/src/resources/devices/policies/excludes.ts
@@ -5,38 +5,38 @@ import { APIResource } from 'cloudflare/resource';
import * as ExcludesAPI from 'cloudflare/resources/devices/policies/excludes';
export class Excludes extends APIResource {
- /**
- * Fetches the list of routes excluded from the WARP client's tunnel.
- */
- list(identifier: unknown, options?: Core.RequestOptions): Core.APIPromise {
- return (
- this._client.get(`/accounts/${identifier}/devices/policy/exclude`, options) as Core.APIPromise<{
- result: ExcludeListResponse | null;
- }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Sets the list of routes excluded from the WARP client's tunnel.
*/
- replace(
+ update(
identifier: unknown,
- body: ExcludeReplaceParams,
+ body: ExcludeUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.put(`/accounts/${identifier}/devices/policy/exclude`, {
body,
...options,
- }) as Core.APIPromise<{ result: ExcludeReplaceResponse | null }>
+ }) as Core.APIPromise<{ result: ExcludeUpdateResponse | null }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
+ /**
+ * Fetches the list of routes excluded from the WARP client's tunnel.
+ */
+ list(identifier: unknown, options?: Core.RequestOptions): Core.APIPromise {
+ return (
+ this._client.get(`/accounts/${identifier}/devices/policy/exclude`, options) as Core.APIPromise<{
+ result: ExcludeListResponse | null;
+ }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type ExcludeListResponse = Array;
+export type ExcludeUpdateResponse = Array;
-export namespace ExcludeListResponse {
- export interface ExcludeListResponseItem {
+export namespace ExcludeUpdateResponse {
+ export interface ExcludeUpdateResponseItem {
/**
* The address in CIDR format to exclude from the tunnel. If `address` is present,
* `host` must not be present.
@@ -56,10 +56,10 @@ export namespace ExcludeListResponse {
}
}
-export type ExcludeReplaceResponse = Array;
+export type ExcludeListResponse = Array;
-export namespace ExcludeReplaceResponse {
- export interface ExcludeReplaceResponseItem {
+export namespace ExcludeListResponse {
+ export interface ExcludeListResponseItem {
/**
* The address in CIDR format to exclude from the tunnel. If `address` is present,
* `host` must not be present.
@@ -79,9 +79,9 @@ export namespace ExcludeReplaceResponse {
}
}
-export type ExcludeReplaceParams = Array;
+export type ExcludeUpdateParams = Array;
-export namespace ExcludeReplaceParams {
+export namespace ExcludeUpdateParams {
export interface Body {
/**
* The address in CIDR format to exclude from the tunnel. If `address` is present,
@@ -103,7 +103,7 @@ export namespace ExcludeReplaceParams {
}
export namespace Excludes {
+ export import ExcludeUpdateResponse = ExcludesAPI.ExcludeUpdateResponse;
export import ExcludeListResponse = ExcludesAPI.ExcludeListResponse;
- export import ExcludeReplaceResponse = ExcludesAPI.ExcludeReplaceResponse;
- export import ExcludeReplaceParams = ExcludesAPI.ExcludeReplaceParams;
+ export import ExcludeUpdateParams = ExcludesAPI.ExcludeUpdateParams;
}
diff --git a/src/resources/devices/policies/fallback-domains.ts b/src/resources/devices/policies/fallback-domains.ts
index d9546d8bbb..bebbca5f06 100644
--- a/src/resources/devices/policies/fallback-domains.ts
+++ b/src/resources/devices/policies/fallback-domains.ts
@@ -6,47 +6,48 @@ import * as FallbackDomainsAPI from 'cloudflare/resources/devices/policies/fallb
export class FallbackDomains extends APIResource {
/**
- * Fetches the list of domains to bypass Gateway DNS resolution from a specified
- * device settings profile. These domains will use the specified local DNS resolver
- * instead.
+ * Sets the list of domains to bypass Gateway DNS resolution. These domains will
+ * use the specified local DNS resolver instead. This will only apply to the
+ * specified device settings profile.
*/
- list(
+ update(
identifier: unknown,
uuid: string,
+ body: FallbackDomainUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.get(
- `/accounts/${identifier}/devices/policy/${uuid}/fallback_domains`,
- options,
- ) as Core.APIPromise<{ result: FallbackDomainListResponse | null }>
+ this._client.put(`/accounts/${identifier}/devices/policy/${uuid}/fallback_domains`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: FallbackDomainUpdateResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Sets the list of domains to bypass Gateway DNS resolution. These domains will
- * use the specified local DNS resolver instead. This will only apply to the
- * specified device settings profile.
+ * Fetches the list of domains to bypass Gateway DNS resolution from a specified
+ * device settings profile. These domains will use the specified local DNS resolver
+ * instead.
*/
- replace(
+ list(
identifier: unknown,
uuid: string,
- body: FallbackDomainReplaceParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.put(`/accounts/${identifier}/devices/policy/${uuid}/fallback_domains`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: FallbackDomainReplaceResponse | null }>
+ this._client.get(
+ `/accounts/${identifier}/devices/policy/${uuid}/fallback_domains`,
+ options,
+ ) as Core.APIPromise<{ result: FallbackDomainListResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type FallbackDomainListResponse = Array;
+export type FallbackDomainUpdateResponse =
+ Array;
-export namespace FallbackDomainListResponse {
- export interface FallbackDomainListResponseItem {
+export namespace FallbackDomainUpdateResponse {
+ export interface FallbackDomainUpdateResponseItem {
/**
* The domain suffix to match when resolving locally.
*/
@@ -64,11 +65,10 @@ export namespace FallbackDomainListResponse {
}
}
-export type FallbackDomainReplaceResponse =
- Array;
+export type FallbackDomainListResponse = Array;
-export namespace FallbackDomainReplaceResponse {
- export interface FallbackDomainReplaceResponseItem {
+export namespace FallbackDomainListResponse {
+ export interface FallbackDomainListResponseItem {
/**
* The domain suffix to match when resolving locally.
*/
@@ -86,9 +86,9 @@ export namespace FallbackDomainReplaceResponse {
}
}
-export type FallbackDomainReplaceParams = Array;
+export type FallbackDomainUpdateParams = Array;
-export namespace FallbackDomainReplaceParams {
+export namespace FallbackDomainUpdateParams {
export interface Body {
/**
* The domain suffix to match when resolving locally.
@@ -108,7 +108,7 @@ export namespace FallbackDomainReplaceParams {
}
export namespace FallbackDomains {
+ export import FallbackDomainUpdateResponse = FallbackDomainsAPI.FallbackDomainUpdateResponse;
export import FallbackDomainListResponse = FallbackDomainsAPI.FallbackDomainListResponse;
- export import FallbackDomainReplaceResponse = FallbackDomainsAPI.FallbackDomainReplaceResponse;
- export import FallbackDomainReplaceParams = FallbackDomainsAPI.FallbackDomainReplaceParams;
+ export import FallbackDomainUpdateParams = FallbackDomainsAPI.FallbackDomainUpdateParams;
}
diff --git a/src/resources/devices/policies/includes.ts b/src/resources/devices/policies/includes.ts
index c3cfaa0434..3c0f0de2a3 100644
--- a/src/resources/devices/policies/includes.ts
+++ b/src/resources/devices/policies/includes.ts
@@ -5,38 +5,38 @@ import { APIResource } from 'cloudflare/resource';
import * as IncludesAPI from 'cloudflare/resources/devices/policies/includes';
export class Includes extends APIResource {
- /**
- * Fetches the list of routes included in the WARP client's tunnel.
- */
- list(identifier: unknown, options?: Core.RequestOptions): Core.APIPromise {
- return (
- this._client.get(`/accounts/${identifier}/devices/policy/include`, options) as Core.APIPromise<{
- result: IncludeListResponse | null;
- }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Sets the list of routes included in the WARP client's tunnel.
*/
- replace(
+ update(
identifier: unknown,
- body: IncludeReplaceParams,
+ body: IncludeUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
this._client.put(`/accounts/${identifier}/devices/policy/include`, {
body,
...options,
- }) as Core.APIPromise<{ result: IncludeReplaceResponse | null }>
+ }) as Core.APIPromise<{ result: IncludeUpdateResponse | null }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
+ /**
+ * Fetches the list of routes included in the WARP client's tunnel.
+ */
+ list(identifier: unknown, options?: Core.RequestOptions): Core.APIPromise {
+ return (
+ this._client.get(`/accounts/${identifier}/devices/policy/include`, options) as Core.APIPromise<{
+ result: IncludeListResponse | null;
+ }>
)._thenUnwrap((obj) => obj.result);
}
}
-export type IncludeListResponse = Array;
+export type IncludeUpdateResponse = Array;
-export namespace IncludeListResponse {
- export interface IncludeListResponseItem {
+export namespace IncludeUpdateResponse {
+ export interface IncludeUpdateResponseItem {
/**
* The address in CIDR format to include in the tunnel. If address is present, host
* must not be present.
@@ -56,10 +56,10 @@ export namespace IncludeListResponse {
}
}
-export type IncludeReplaceResponse = Array;
+export type IncludeListResponse = Array;
-export namespace IncludeReplaceResponse {
- export interface IncludeReplaceResponseItem {
+export namespace IncludeListResponse {
+ export interface IncludeListResponseItem {
/**
* The address in CIDR format to include in the tunnel. If address is present, host
* must not be present.
@@ -79,9 +79,9 @@ export namespace IncludeReplaceResponse {
}
}
-export type IncludeReplaceParams = Array;
+export type IncludeUpdateParams = Array;
-export namespace IncludeReplaceParams {
+export namespace IncludeUpdateParams {
export interface Body {
/**
* The address in CIDR format to include in the tunnel. If address is present, host
@@ -103,7 +103,7 @@ export namespace IncludeReplaceParams {
}
export namespace Includes {
+ export import IncludeUpdateResponse = IncludesAPI.IncludeUpdateResponse;
export import IncludeListResponse = IncludesAPI.IncludeListResponse;
- export import IncludeReplaceResponse = IncludesAPI.IncludeReplaceResponse;
- export import IncludeReplaceParams = IncludesAPI.IncludeReplaceParams;
+ export import IncludeUpdateParams = IncludesAPI.IncludeUpdateParams;
}
diff --git a/src/resources/devices/policies/index.ts b/src/resources/devices/policies/index.ts
index ff88f8c784..68d2b884de 100644
--- a/src/resources/devices/policies/index.ts
+++ b/src/resources/devices/policies/index.ts
@@ -1,21 +1,21 @@
// File generated from our OpenAPI spec by Stainless.
export { DefaultPolicyGetResponse, DefaultPolicy } from './default-policy';
-export { ExcludeListResponse, ExcludeReplaceResponse, ExcludeReplaceParams, Excludes } from './excludes';
+export { ExcludeUpdateResponse, ExcludeListResponse, ExcludeUpdateParams, Excludes } from './excludes';
export {
+ FallbackDomainUpdateResponse,
FallbackDomainListResponse,
- FallbackDomainReplaceResponse,
- FallbackDomainReplaceParams,
+ FallbackDomainUpdateParams,
FallbackDomains,
} from './fallback-domains';
-export { IncludeListResponse, IncludeReplaceResponse, IncludeReplaceParams, Includes } from './includes';
+export { IncludeUpdateResponse, IncludeListResponse, IncludeUpdateParams, Includes } from './includes';
export {
PolicyCreateResponse,
- PolicyUpdateResponse,
PolicyListResponse,
PolicyDeleteResponse,
+ PolicyEditResponse,
PolicyGetResponse,
PolicyCreateParams,
- PolicyUpdateParams,
+ PolicyEditParams,
Policies,
} from './policies';
diff --git a/src/resources/devices/policies/policies.ts b/src/resources/devices/policies/policies.ts
index fa9d6c118b..2af4ac4316 100644
--- a/src/resources/devices/policies/policies.ts
+++ b/src/resources/devices/policies/policies.ts
@@ -30,23 +30,6 @@ export class Policies extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
- /**
- * Updates a configured device settings profile.
- */
- update(
- identifier: unknown,
- uuid: string,
- body: PolicyUpdateParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.patch(`/accounts/${identifier}/devices/policy/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: PolicyUpdateResponse | null }>
- )._thenUnwrap((obj) => obj.result);
- }
-
/**
* Fetches a list of the device settings profiles for an account.
*/
@@ -74,6 +57,23 @@ export class Policies extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a configured device settings profile.
+ */
+ edit(
+ identifier: unknown,
+ uuid: string,
+ body: PolicyEditParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.patch(`/accounts/${identifier}/devices/policy/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: PolicyEditResponse | null }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Fetches a device settings profile by ID.
*/
@@ -92,8 +92,6 @@ export class Policies extends APIResource {
export type PolicyCreateResponse = Array;
-export type PolicyUpdateResponse = Array;
-
export type PolicyListResponse = Array;
export namespace PolicyListResponse {
@@ -460,6 +458,8 @@ export namespace PolicyDeleteResponse {
}
}
+export type PolicyEditResponse = Array;
+
export type PolicyGetResponse = Array;
export interface PolicyCreateParams {
@@ -568,7 +568,7 @@ export namespace PolicyCreateParams {
}
}
-export interface PolicyUpdateParams {
+export interface PolicyEditParams {
/**
* Whether to allow the user to switch WARP between modes.
*/
@@ -633,7 +633,7 @@ export interface PolicyUpdateParams {
*/
precedence?: number;
- service_mode_v2?: PolicyUpdateParams.ServiceModeV2;
+ service_mode_v2?: PolicyEditParams.ServiceModeV2;
/**
* The URL to launch when the Send Feedback button is clicked.
@@ -646,7 +646,7 @@ export interface PolicyUpdateParams {
switch_locked?: boolean;
}
-export namespace PolicyUpdateParams {
+export namespace PolicyEditParams {
export interface ServiceModeV2 {
/**
* The mode to run the WARP client under.
@@ -662,24 +662,24 @@ export namespace PolicyUpdateParams {
export namespace Policies {
export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
- export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
+ export import PolicyEditResponse = PoliciesAPI.PolicyEditResponse;
export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
- export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
+ export import PolicyEditParams = PoliciesAPI.PolicyEditParams;
export import DefaultPolicy = DefaultPolicyAPI.DefaultPolicy;
export import DefaultPolicyGetResponse = DefaultPolicyAPI.DefaultPolicyGetResponse;
export import Excludes = ExcludesAPI.Excludes;
+ export import ExcludeUpdateResponse = ExcludesAPI.ExcludeUpdateResponse;
export import ExcludeListResponse = ExcludesAPI.ExcludeListResponse;
- export import ExcludeReplaceResponse = ExcludesAPI.ExcludeReplaceResponse;
- export import ExcludeReplaceParams = ExcludesAPI.ExcludeReplaceParams;
+ export import ExcludeUpdateParams = ExcludesAPI.ExcludeUpdateParams;
export import FallbackDomains = FallbackDomainsAPI.FallbackDomains;
+ export import FallbackDomainUpdateResponse = FallbackDomainsAPI.FallbackDomainUpdateResponse;
export import FallbackDomainListResponse = FallbackDomainsAPI.FallbackDomainListResponse;
- export import FallbackDomainReplaceResponse = FallbackDomainsAPI.FallbackDomainReplaceResponse;
- export import FallbackDomainReplaceParams = FallbackDomainsAPI.FallbackDomainReplaceParams;
+ export import FallbackDomainUpdateParams = FallbackDomainsAPI.FallbackDomainUpdateParams;
export import Includes = IncludesAPI.Includes;
+ export import IncludeUpdateResponse = IncludesAPI.IncludeUpdateResponse;
export import IncludeListResponse = IncludesAPI.IncludeListResponse;
- export import IncludeReplaceResponse = IncludesAPI.IncludeReplaceResponse;
- export import IncludeReplaceParams = IncludesAPI.IncludeReplaceParams;
+ export import IncludeUpdateParams = IncludesAPI.IncludeUpdateParams;
}
diff --git a/src/resources/devices/postures/index.ts b/src/resources/devices/postures/index.ts
index a6b62ef630..f79dd97c3e 100644
--- a/src/resources/devices/postures/index.ts
+++ b/src/resources/devices/postures/index.ts
@@ -2,20 +2,20 @@
export {
IntegrationCreateResponse,
- IntegrationUpdateResponse,
IntegrationDeleteResponse,
+ IntegrationEditResponse,
IntegrationGetResponse,
IntegrationCreateParams,
- IntegrationUpdateParams,
+ IntegrationEditParams,
Integrations,
} from './integrations';
export {
PostureCreateResponse,
+ PostureUpdateResponse,
PostureListResponse,
PostureDeleteResponse,
PostureGetResponse,
- PostureReplaceResponse,
PostureCreateParams,
- PostureReplaceParams,
+ PostureUpdateParams,
Postures,
} from './postures';
diff --git a/src/resources/devices/postures/integrations.ts b/src/resources/devices/postures/integrations.ts
index 1f9b9c8451..40bac4d725 100644
--- a/src/resources/devices/postures/integrations.ts
+++ b/src/resources/devices/postures/integrations.ts
@@ -22,35 +22,35 @@ export class Integrations extends APIResource {
}
/**
- * Updates a configured device posture integration.
+ * Delete a configured device posture integration.
*/
- update(
+ delete(
identifier: unknown,
uuid: string,
- body: IntegrationUpdateParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.patch(`/accounts/${identifier}/devices/posture/integration/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: IntegrationUpdateResponse | null }>
+ this._client.delete(
+ `/accounts/${identifier}/devices/posture/integration/${uuid}`,
+ options,
+ ) as Core.APIPromise<{ result: IntegrationDeleteResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Delete a configured device posture integration.
+ * Updates a configured device posture integration.
*/
- delete(
+ edit(
identifier: unknown,
uuid: string,
+ body: IntegrationEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise {
return (
- this._client.delete(
- `/accounts/${identifier}/devices/posture/integration/${uuid}`,
- options,
- ) as Core.APIPromise<{ result: IntegrationDeleteResponse | null }>
+ this._client.patch(`/accounts/${identifier}/devices/posture/integration/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: IntegrationEditResponse | null }>
)._thenUnwrap((obj) => obj.result);
}
@@ -121,7 +121,9 @@ export namespace IntegrationCreateResponse {
}
}
-export interface IntegrationUpdateResponse {
+export type IntegrationDeleteResponse = unknown | string;
+
+export interface IntegrationEditResponse {
/**
* API UUID.
*/
@@ -130,7 +132,7 @@ export interface IntegrationUpdateResponse {
/**
* The configuration object containing third-party integration information.
*/
- config?: IntegrationUpdateResponse.Config;
+ config?: IntegrationEditResponse.Config;
/**
* The interval between each posture check with the third-party API. Use `m` for
@@ -149,7 +151,7 @@ export interface IntegrationUpdateResponse {
type?: 'workspace_one' | 'crowdstrike_s2s' | 'uptycs' | 'intune' | 'kolide' | 'tanium' | 'sentinelone_s2s';
}
-export namespace IntegrationUpdateResponse {
+export namespace IntegrationEditResponse {
/**
* The configuration object containing third-party integration information.
*/
@@ -171,8 +173,6 @@ export namespace IntegrationUpdateResponse {
}
}
-export type IntegrationDeleteResponse = unknown | string;
-
export interface IntegrationGetResponse {
/**
* API UUID.
@@ -386,18 +386,18 @@ export namespace IntegrationCreateParams {
}
}
-export interface IntegrationUpdateParams {
+export interface IntegrationEditParams {
/**
* The configuration object containing third-party integration information.
*/
config?:
- | IntegrationUpdateParams.TeamsDevicesWorkspaceOneConfigRequest
- | IntegrationUpdateParams.TeamsDevicesCrowdstrikeConfigRequest
- | IntegrationUpdateParams.TeamsDevicesUptycsConfigRequest
- | IntegrationUpdateParams.TeamsDevicesIntuneConfigRequest
- | IntegrationUpdateParams.TeamsDevicesKolideConfigRequest
- | IntegrationUpdateParams.TeamsDevicesTaniumConfigRequest
- | IntegrationUpdateParams.TeamsDevicesSentineloneS2sConfigRequest;
+ | IntegrationEditParams.TeamsDevicesWorkspaceOneConfigRequest
+ | IntegrationEditParams.TeamsDevicesCrowdstrikeConfigRequest
+ | IntegrationEditParams.TeamsDevicesUptycsConfigRequest
+ | IntegrationEditParams.TeamsDevicesIntuneConfigRequest
+ | IntegrationEditParams.TeamsDevicesKolideConfigRequest
+ | IntegrationEditParams.TeamsDevicesTaniumConfigRequest
+ | IntegrationEditParams.TeamsDevicesSentineloneS2sConfigRequest;
/**
* The interval between each posture check with the third-party API. Use `m` for
@@ -416,7 +416,7 @@ export interface IntegrationUpdateParams {
type?: 'workspace_one' | 'crowdstrike_s2s' | 'uptycs' | 'intune' | 'kolide' | 'tanium' | 'sentinelone_s2s';
}
-export namespace IntegrationUpdateParams {
+export namespace IntegrationEditParams {
export interface TeamsDevicesWorkspaceOneConfigRequest {
/**
* The Workspace One API URL provided in the Workspace One Admin Dashboard.
@@ -551,9 +551,9 @@ export namespace IntegrationUpdateParams {
export namespace Integrations {
export import IntegrationCreateResponse = IntegrationsAPI.IntegrationCreateResponse;
- export import IntegrationUpdateResponse = IntegrationsAPI.IntegrationUpdateResponse;
export import IntegrationDeleteResponse = IntegrationsAPI.IntegrationDeleteResponse;
+ export import IntegrationEditResponse = IntegrationsAPI.IntegrationEditResponse;
export import IntegrationGetResponse = IntegrationsAPI.IntegrationGetResponse;
export import IntegrationCreateParams = IntegrationsAPI.IntegrationCreateParams;
- export import IntegrationUpdateParams = IntegrationsAPI.IntegrationUpdateParams;
+ export import IntegrationEditParams = IntegrationsAPI.IntegrationEditParams;
}
diff --git a/src/resources/devices/postures/postures.ts b/src/resources/devices/postures/postures.ts
index 9e776c877a..b6ceb0801d 100644
--- a/src/resources/devices/postures/postures.ts
+++ b/src/resources/devices/postures/postures.ts
@@ -23,6 +23,23 @@ export class Postures extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Updates a device posture rule.
+ */
+ update(
+ identifier: unknown,
+ uuid: string,
+ body: PostureUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${identifier}/devices/posture/${uuid}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: PostureUpdateResponse | null }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Fetches device posture rules for a Zero Trust account.
*/
@@ -63,23 +80,6 @@ export class Postures extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Updates a device posture rule.
- */
- replace(
- identifier: unknown,
- uuid: string,
- body: PostureReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${identifier}/devices/posture/${uuid}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: PostureReplaceResponse | null }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export interface PostureCreateResponse {
@@ -495,850 +495,850 @@ export namespace PostureCreateResponse {
}
}
-export type PostureListResponse = Array;
+export interface PostureUpdateResponse {
+ /**
+ * API UUID.
+ */
+ id?: string;
-export namespace PostureListResponse {
- export interface PostureListResponseItem {
+ /**
+ * The description of the device posture rule.
+ */
+ description?: string;
+
+ /**
+ * Sets the expiration time for a posture check result. If empty, the result
+ * remains valid until it is overwritten by new data from the WARP client.
+ */
+ expiration?: string;
+
+ /**
+ * The value to be checked against.
+ */
+ input?:
+ | PostureUpdateResponse.TeamsDevicesFileInputRequest
+ | PostureUpdateResponse.TeamsDevicesUniqueClientIDInputRequest
+ | PostureUpdateResponse.TeamsDevicesDomainJoinedInputRequest
+ | PostureUpdateResponse.TeamsDevicesOsVersionInputRequest
+ | PostureUpdateResponse.TeamsDevicesFirewallInputRequest
+ | PostureUpdateResponse.TeamsDevicesSentineloneInputRequest
+ | PostureUpdateResponse.TeamsDevicesCarbonblackInputRequest
+ | PostureUpdateResponse.TeamsDevicesDiskEncryptionInputRequest
+ | PostureUpdateResponse.TeamsDevicesApplicationInputRequest
+ | PostureUpdateResponse.TeamsDevicesClientCertificateInputRequest
+ | PostureUpdateResponse.TeamsDevicesWorkspaceOneInputRequest
+ | PostureUpdateResponse.TeamsDevicesCrowdstrikeInputRequest
+ | PostureUpdateResponse.TeamsDevicesIntuneInputRequest
+ | PostureUpdateResponse.TeamsDevicesKolideInputRequest
+ | PostureUpdateResponse.TeamsDevicesTaniumInputRequest
+ | PostureUpdateResponse.TeamsDevicesSentineloneS2sInputRequest;
+
+ /**
+ * The conditions that the client must match to run the rule.
+ */
+ match?: Array;
+
+ /**
+ * The name of the device posture rule.
+ */
+ name?: string;
+
+ /**
+ * Polling frequency for the WARP client posture check. Default: `5m` (poll every
+ * five minutes). Minimum: `1m`.
+ */
+ schedule?: string;
+
+ /**
+ * The type of device posture rule.
+ */
+ type?:
+ | 'file'
+ | 'application'
+ | 'tanium'
+ | 'gateway'
+ | 'warp'
+ | 'disk_encryption'
+ | 'sentinelone'
+ | 'carbonblack'
+ | 'firewall'
+ | 'os_version'
+ | 'domain_joined'
+ | 'client_certificate'
+ | 'unique_client_id'
+ | 'kolide'
+ | 'tanium_s2s'
+ | 'crowdstrike_s2s'
+ | 'intune'
+ | 'workspace_one'
+ | 'sentinelone_s2s';
+}
+
+export namespace PostureUpdateResponse {
+ export interface TeamsDevicesFileInputRequest {
/**
- * API UUID.
+ * Operating system
*/
- id?: string;
+ operating_system: 'windows' | 'linux' | 'mac';
/**
- * The description of the device posture rule.
+ * File path.
*/
- description?: string;
+ path: string;
/**
- * Sets the expiration time for a posture check result. If empty, the result
- * remains valid until it is overwritten by new data from the WARP client.
+ * Whether or not file exists
*/
- expiration?: string;
+ exists?: boolean;
/**
- * The value to be checked against.
+ * SHA-256.
*/
- input?:
- | PostureListResponseItem.TeamsDevicesFileInputRequest
- | PostureListResponseItem.TeamsDevicesUniqueClientIDInputRequest
- | PostureListResponseItem.TeamsDevicesDomainJoinedInputRequest
- | PostureListResponseItem.TeamsDevicesOsVersionInputRequest
- | PostureListResponseItem.TeamsDevicesFirewallInputRequest
- | PostureListResponseItem.TeamsDevicesSentineloneInputRequest
- | PostureListResponseItem.TeamsDevicesCarbonblackInputRequest
- | PostureListResponseItem.TeamsDevicesDiskEncryptionInputRequest
- | PostureListResponseItem.TeamsDevicesApplicationInputRequest
- | PostureListResponseItem.TeamsDevicesClientCertificateInputRequest
- | PostureListResponseItem.TeamsDevicesWorkspaceOneInputRequest
- | PostureListResponseItem.TeamsDevicesCrowdstrikeInputRequest
- | PostureListResponseItem.TeamsDevicesIntuneInputRequest
- | PostureListResponseItem.TeamsDevicesKolideInputRequest
- | PostureListResponseItem.TeamsDevicesTaniumInputRequest
- | PostureListResponseItem.TeamsDevicesSentineloneS2sInputRequest;
+ sha256?: string;
/**
- * The conditions that the client must match to run the rule.
+ * Signing certificate thumbprint.
*/
- match?: Array;
+ thumbprint?: string;
+ }
+ export interface TeamsDevicesUniqueClientIDInputRequest {
/**
- * The name of the device posture rule.
+ * List ID.
*/
- name?: string;
+ id: string;
/**
- * Polling frequency for the WARP client posture check. Default: `5m` (poll every
- * five minutes). Minimum: `1m`.
+ * Operating System
*/
- schedule?: string;
+ operating_system: 'android' | 'ios' | 'chromeos';
+ }
+ export interface TeamsDevicesDomainJoinedInputRequest {
/**
- * The type of device posture rule.
+ * Operating System
*/
- type?:
- | 'file'
- | 'application'
- | 'tanium'
- | 'gateway'
- | 'warp'
- | 'disk_encryption'
- | 'sentinelone'
- | 'carbonblack'
- | 'firewall'
- | 'os_version'
- | 'domain_joined'
- | 'client_certificate'
- | 'unique_client_id'
- | 'kolide'
- | 'tanium_s2s'
- | 'crowdstrike_s2s'
- | 'intune'
- | 'workspace_one'
- | 'sentinelone_s2s';
+ operating_system: 'windows';
+
+ /**
+ * Domain
+ */
+ domain?: string;
}
- export namespace PostureListResponseItem {
- export interface TeamsDevicesFileInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
+ export interface TeamsDevicesOsVersionInputRequest {
+ /**
+ * Operating System
+ */
+ operating_system: 'windows';
- /**
- * File path.
- */
- path: string;
+ /**
+ * Operator
+ */
+ operator: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Whether or not file exists
- */
- exists?: boolean;
+ /**
+ * Version of OS
+ */
+ version: string;
- /**
- * SHA-256.
- */
- sha256?: string;
+ /**
+ * Operating System Distribution Name (linux only)
+ */
+ os_distro_name?: string;
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ /**
+ * Version of OS Distribution (linux only)
+ */
+ os_distro_revision?: string;
- export interface TeamsDevicesUniqueClientIDInputRequest {
- /**
- * List ID.
- */
- id: string;
+ /**
+ * Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
+ * the kernel release version. (Mac, iOS, and Linux only)
+ */
+ os_version_extra?: string;
+ }
- /**
- * Operating System
- */
- operating_system: 'android' | 'ios' | 'chromeos';
- }
+ export interface TeamsDevicesFirewallInputRequest {
+ /**
+ * Enabled
+ */
+ enabled: boolean;
- export interface TeamsDevicesDomainJoinedInputRequest {
- /**
- * Operating System
- */
- operating_system: 'windows';
+ /**
+ * Operating System
+ */
+ operating_system: 'windows' | 'mac';
+ }
- /**
- * Domain
- */
- domain?: string;
- }
+ export interface TeamsDevicesSentineloneInputRequest {
+ /**
+ * Operating system
+ */
+ operating_system: 'windows' | 'linux' | 'mac';
- export interface TeamsDevicesOsVersionInputRequest {
- /**
- * Operating System
- */
- operating_system: 'windows';
+ /**
+ * File path.
+ */
+ path: string;
- /**
- * Operator
- */
- operator: '<' | '<=' | '>' | '>=' | '==';
+ /**
+ * SHA-256.
+ */
+ sha256?: string;
- /**
- * Version of OS
- */
- version: string;
+ /**
+ * Signing certificate thumbprint.
+ */
+ thumbprint?: string;
+ }
- /**
- * Operating System Distribution Name (linux only)
- */
- os_distro_name?: string;
+ export interface TeamsDevicesCarbonblackInputRequest {
+ /**
+ * Operating system
+ */
+ operating_system: 'windows' | 'linux' | 'mac';
- /**
- * Version of OS Distribution (linux only)
- */
- os_distro_revision?: string;
+ /**
+ * File path.
+ */
+ path: string;
- /**
- * Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
- * the kernel release version. (Mac, iOS, and Linux only)
- */
- os_version_extra?: string;
- }
+ /**
+ * SHA-256.
+ */
+ sha256?: string;
- export interface TeamsDevicesFirewallInputRequest {
- /**
- * Enabled
- */
- enabled: boolean;
+ /**
+ * Signing certificate thumbprint.
+ */
+ thumbprint?: string;
+ }
- /**
- * Operating System
- */
- operating_system: 'windows' | 'mac';
- }
+ export interface TeamsDevicesDiskEncryptionInputRequest {
+ /**
+ * List of volume names to be checked for encryption.
+ */
+ checkDisks?: Array;
- export interface TeamsDevicesSentineloneInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
+ /**
+ * Whether to check all disks for encryption.
+ */
+ requireAll?: boolean;
+ }
- /**
- * File path.
- */
- path: string;
+ export interface TeamsDevicesApplicationInputRequest {
+ /**
+ * Operating system
+ */
+ operating_system: 'windows' | 'linux' | 'mac';
- /**
- * SHA-256.
- */
- sha256?: string;
+ /**
+ * Path for the application.
+ */
+ path: string;
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ /**
+ * SHA-256.
+ */
+ sha256?: string;
- export interface TeamsDevicesCarbonblackInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
+ /**
+ * Signing certificate thumbprint.
+ */
+ thumbprint?: string;
+ }
- /**
- * File path.
- */
- path: string;
+ export interface TeamsDevicesClientCertificateInputRequest {
+ /**
+ * UUID of Cloudflare managed certificate.
+ */
+ certificate_id: string;
- /**
- * SHA-256.
- */
- sha256?: string;
+ /**
+ * Common Name that is protected by the certificate
+ */
+ cn: string;
+ }
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ export interface TeamsDevicesWorkspaceOneInputRequest {
+ /**
+ * Compliance Status
+ */
+ compliance_status: 'compliant' | 'noncompliant' | 'unknown';
- export interface TeamsDevicesDiskEncryptionInputRequest {
- /**
- * List of volume names to be checked for encryption.
- */
- checkDisks?: Array;
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
+ }
- /**
- * Whether to check all disks for encryption.
- */
- requireAll?: boolean;
- }
+ export interface TeamsDevicesCrowdstrikeInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
- export interface TeamsDevicesApplicationInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
+ /**
+ * Operator
+ */
+ operator?: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Path for the application.
- */
- path: string;
+ /**
+ * Os Version
+ */
+ os?: string;
- /**
- * SHA-256.
- */
- sha256?: string;
+ /**
+ * overall
+ */
+ overall?: string;
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ /**
+ * SensorConfig
+ */
+ sensor_config?: string;
- export interface TeamsDevicesClientCertificateInputRequest {
- /**
- * UUID of Cloudflare managed certificate.
- */
- certificate_id: string;
+ /**
+ * Version
+ */
+ version?: string;
- /**
- * Common Name that is protected by the certificate
- */
- cn: string;
- }
+ /**
+ * Version Operator
+ */
+ versionOperator?: '<' | '<=' | '>' | '>=' | '==';
+ }
- export interface TeamsDevicesWorkspaceOneInputRequest {
- /**
- * Compliance Status
- */
- compliance_status: 'compliant' | 'noncompliant' | 'unknown';
+ export interface TeamsDevicesIntuneInputRequest {
+ /**
+ * Compliance Status
+ */
+ compliance_status: 'compliant' | 'noncompliant' | 'unknown' | 'notapplicable' | 'ingraceperiod' | 'error';
- /**
- * Posture Integration ID.
- */
- connection_id: string;
- }
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
+ }
- export interface TeamsDevicesCrowdstrikeInputRequest {
- /**
- * Posture Integration ID.
- */
- connection_id: string;
+ export interface TeamsDevicesKolideInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
- /**
- * Operator
- */
- operator?: '<' | '<=' | '>' | '>=' | '==';
+ /**
+ * Count Operator
+ */
+ countOperator: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Os Version
- */
- os?: string;
+ /**
+ * The Number of Issues.
+ */
+ issue_count: string;
+ }
+
+ export interface TeamsDevicesTaniumInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
+
+ /**
+ * For more details on eid last seen, refer to the Tanium documentation.
+ */
+ eid_last_seen?: string;
+
+ /**
+ * Operator to evaluate risk_level or eid_last_seen.
+ */
+ operator?: '<' | '<=' | '>' | '>=' | '==';
+
+ /**
+ * For more details on risk level, refer to the Tanium documentation.
+ */
+ risk_level?: 'low' | 'medium' | 'high' | 'critical';
+
+ /**
+ * Score Operator
+ */
+ scoreOperator?: '<' | '<=' | '>' | '>=' | '==';
+
+ /**
+ * For more details on total score, refer to the Tanium documentation.
+ */
+ total_score?: number;
+ }
+
+ export interface TeamsDevicesSentineloneS2sInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
+
+ /**
+ * The Number of active threats.
+ */
+ active_threats?: number;
+
+ /**
+ * Whether device is infected.
+ */
+ infected?: boolean;
+
+ /**
+ * Whether device is active.
+ */
+ is_active?: boolean;
+
+ /**
+ * Network status of device.
+ */
+ network_status?: 'connected' | 'disconnected' | 'disconnecting' | 'connecting';
+
+ /**
+ * operator
+ */
+ operator?: '<' | '<=' | '>' | '>=' | '==';
+ }
+
+ export interface Match {
+ platform?: 'windows' | 'mac' | 'linux' | 'android' | 'ios';
+ }
+}
+
+export type PostureListResponse = Array;
+
+export namespace PostureListResponse {
+ export interface PostureListResponseItem {
+ /**
+ * API UUID.
+ */
+ id?: string;
+
+ /**
+ * The description of the device posture rule.
+ */
+ description?: string;
+
+ /**
+ * Sets the expiration time for a posture check result. If empty, the result
+ * remains valid until it is overwritten by new data from the WARP client.
+ */
+ expiration?: string;
+
+ /**
+ * The value to be checked against.
+ */
+ input?:
+ | PostureListResponseItem.TeamsDevicesFileInputRequest
+ | PostureListResponseItem.TeamsDevicesUniqueClientIDInputRequest
+ | PostureListResponseItem.TeamsDevicesDomainJoinedInputRequest
+ | PostureListResponseItem.TeamsDevicesOsVersionInputRequest
+ | PostureListResponseItem.TeamsDevicesFirewallInputRequest
+ | PostureListResponseItem.TeamsDevicesSentineloneInputRequest
+ | PostureListResponseItem.TeamsDevicesCarbonblackInputRequest
+ | PostureListResponseItem.TeamsDevicesDiskEncryptionInputRequest
+ | PostureListResponseItem.TeamsDevicesApplicationInputRequest
+ | PostureListResponseItem.TeamsDevicesClientCertificateInputRequest
+ | PostureListResponseItem.TeamsDevicesWorkspaceOneInputRequest
+ | PostureListResponseItem.TeamsDevicesCrowdstrikeInputRequest
+ | PostureListResponseItem.TeamsDevicesIntuneInputRequest
+ | PostureListResponseItem.TeamsDevicesKolideInputRequest
+ | PostureListResponseItem.TeamsDevicesTaniumInputRequest
+ | PostureListResponseItem.TeamsDevicesSentineloneS2sInputRequest;
+
+ /**
+ * The conditions that the client must match to run the rule.
+ */
+ match?: Array;
+
+ /**
+ * The name of the device posture rule.
+ */
+ name?: string;
+ /**
+ * Polling frequency for the WARP client posture check. Default: `5m` (poll every
+ * five minutes). Minimum: `1m`.
+ */
+ schedule?: string;
+
+ /**
+ * The type of device posture rule.
+ */
+ type?:
+ | 'file'
+ | 'application'
+ | 'tanium'
+ | 'gateway'
+ | 'warp'
+ | 'disk_encryption'
+ | 'sentinelone'
+ | 'carbonblack'
+ | 'firewall'
+ | 'os_version'
+ | 'domain_joined'
+ | 'client_certificate'
+ | 'unique_client_id'
+ | 'kolide'
+ | 'tanium_s2s'
+ | 'crowdstrike_s2s'
+ | 'intune'
+ | 'workspace_one'
+ | 'sentinelone_s2s';
+ }
+
+ export namespace PostureListResponseItem {
+ export interface TeamsDevicesFileInputRequest {
/**
- * overall
+ * Operating system
*/
- overall?: string;
+ operating_system: 'windows' | 'linux' | 'mac';
/**
- * SensorConfig
+ * File path.
*/
- sensor_config?: string;
+ path: string;
/**
- * Version
+ * Whether or not file exists
*/
- version?: string;
+ exists?: boolean;
/**
- * Version Operator
+ * SHA-256.
*/
- versionOperator?: '<' | '<=' | '>' | '>=' | '==';
- }
+ sha256?: string;
- export interface TeamsDevicesIntuneInputRequest {
/**
- * Compliance Status
+ * Signing certificate thumbprint.
*/
- compliance_status:
- | 'compliant'
- | 'noncompliant'
- | 'unknown'
- | 'notapplicable'
- | 'ingraceperiod'
- | 'error';
+ thumbprint?: string;
+ }
+ export interface TeamsDevicesUniqueClientIDInputRequest {
/**
- * Posture Integration ID.
+ * List ID.
*/
- connection_id: string;
- }
+ id: string;
- export interface TeamsDevicesKolideInputRequest {
/**
- * Posture Integration ID.
+ * Operating System
*/
- connection_id: string;
+ operating_system: 'android' | 'ios' | 'chromeos';
+ }
+ export interface TeamsDevicesDomainJoinedInputRequest {
/**
- * Count Operator
+ * Operating System
*/
- countOperator: '<' | '<=' | '>' | '>=' | '==';
+ operating_system: 'windows';
/**
- * The Number of Issues.
+ * Domain
*/
- issue_count: string;
+ domain?: string;
}
- export interface TeamsDevicesTaniumInputRequest {
+ export interface TeamsDevicesOsVersionInputRequest {
/**
- * Posture Integration ID.
+ * Operating System
*/
- connection_id: string;
+ operating_system: 'windows';
/**
- * For more details on eid last seen, refer to the Tanium documentation.
+ * Operator
*/
- eid_last_seen?: string;
+ operator: '<' | '<=' | '>' | '>=' | '==';
/**
- * Operator to evaluate risk_level or eid_last_seen.
+ * Version of OS
*/
- operator?: '<' | '<=' | '>' | '>=' | '==';
+ version: string;
/**
- * For more details on risk level, refer to the Tanium documentation.
+ * Operating System Distribution Name (linux only)
*/
- risk_level?: 'low' | 'medium' | 'high' | 'critical';
+ os_distro_name?: string;
/**
- * Score Operator
+ * Version of OS Distribution (linux only)
*/
- scoreOperator?: '<' | '<=' | '>' | '>=' | '==';
+ os_distro_revision?: string;
/**
- * For more details on total score, refer to the Tanium documentation.
+ * Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
+ * the kernel release version. (Mac, iOS, and Linux only)
*/
- total_score?: number;
+ os_version_extra?: string;
}
- export interface TeamsDevicesSentineloneS2sInputRequest {
+ export interface TeamsDevicesFirewallInputRequest {
/**
- * Posture Integration ID.
+ * Enabled
*/
- connection_id: string;
+ enabled: boolean;
/**
- * The Number of active threats.
+ * Operating System
*/
- active_threats?: number;
+ operating_system: 'windows' | 'mac';
+ }
+ export interface TeamsDevicesSentineloneInputRequest {
/**
- * Whether device is infected.
+ * Operating system
*/
- infected?: boolean;
+ operating_system: 'windows' | 'linux' | 'mac';
/**
- * Whether device is active.
+ * File path.
*/
- is_active?: boolean;
+ path: string;
/**
- * Network status of device.
+ * SHA-256.
*/
- network_status?: 'connected' | 'disconnected' | 'disconnecting' | 'connecting';
+ sha256?: string;
/**
- * operator
+ * Signing certificate thumbprint.
*/
- operator?: '<' | '<=' | '>' | '>=' | '==';
- }
-
- export interface Match {
- platform?: 'windows' | 'mac' | 'linux' | 'android' | 'ios';
+ thumbprint?: string;
}
- }
-}
-
-export interface PostureDeleteResponse {
- /**
- * API UUID.
- */
- id?: string;
-}
-
-export interface PostureGetResponse {
- /**
- * API UUID.
- */
- id?: string;
-
- /**
- * The description of the device posture rule.
- */
- description?: string;
-
- /**
- * Sets the expiration time for a posture check result. If empty, the result
- * remains valid until it is overwritten by new data from the WARP client.
- */
- expiration?: string;
-
- /**
- * The value to be checked against.
- */
- input?:
- | PostureGetResponse.TeamsDevicesFileInputRequest
- | PostureGetResponse.TeamsDevicesUniqueClientIDInputRequest
- | PostureGetResponse.TeamsDevicesDomainJoinedInputRequest
- | PostureGetResponse.TeamsDevicesOsVersionInputRequest
- | PostureGetResponse.TeamsDevicesFirewallInputRequest
- | PostureGetResponse.TeamsDevicesSentineloneInputRequest
- | PostureGetResponse.TeamsDevicesCarbonblackInputRequest
- | PostureGetResponse.TeamsDevicesDiskEncryptionInputRequest
- | PostureGetResponse.TeamsDevicesApplicationInputRequest
- | PostureGetResponse.TeamsDevicesClientCertificateInputRequest
- | PostureGetResponse.TeamsDevicesWorkspaceOneInputRequest
- | PostureGetResponse.TeamsDevicesCrowdstrikeInputRequest
- | PostureGetResponse.TeamsDevicesIntuneInputRequest
- | PostureGetResponse.TeamsDevicesKolideInputRequest
- | PostureGetResponse.TeamsDevicesTaniumInputRequest
- | PostureGetResponse.TeamsDevicesSentineloneS2sInputRequest;
-
- /**
- * The conditions that the client must match to run the rule.
- */
- match?: Array;
-
- /**
- * The name of the device posture rule.
- */
- name?: string;
-
- /**
- * Polling frequency for the WARP client posture check. Default: `5m` (poll every
- * five minutes). Minimum: `1m`.
- */
- schedule?: string;
-
- /**
- * The type of device posture rule.
- */
- type?:
- | 'file'
- | 'application'
- | 'tanium'
- | 'gateway'
- | 'warp'
- | 'disk_encryption'
- | 'sentinelone'
- | 'carbonblack'
- | 'firewall'
- | 'os_version'
- | 'domain_joined'
- | 'client_certificate'
- | 'unique_client_id'
- | 'kolide'
- | 'tanium_s2s'
- | 'crowdstrike_s2s'
- | 'intune'
- | 'workspace_one'
- | 'sentinelone_s2s';
-}
-
-export namespace PostureGetResponse {
- export interface TeamsDevicesFileInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
-
- /**
- * File path.
- */
- path: string;
-
- /**
- * Whether or not file exists
- */
- exists?: boolean;
-
- /**
- * SHA-256.
- */
- sha256?: string;
-
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
-
- export interface TeamsDevicesUniqueClientIDInputRequest {
- /**
- * List ID.
- */
- id: string;
-
- /**
- * Operating System
- */
- operating_system: 'android' | 'ios' | 'chromeos';
- }
-
- export interface TeamsDevicesDomainJoinedInputRequest {
- /**
- * Operating System
- */
- operating_system: 'windows';
-
- /**
- * Domain
- */
- domain?: string;
- }
-
- export interface TeamsDevicesOsVersionInputRequest {
- /**
- * Operating System
- */
- operating_system: 'windows';
-
- /**
- * Operator
- */
- operator: '<' | '<=' | '>' | '>=' | '==';
-
- /**
- * Version of OS
- */
- version: string;
-
- /**
- * Operating System Distribution Name (linux only)
- */
- os_distro_name?: string;
-
- /**
- * Version of OS Distribution (linux only)
- */
- os_distro_revision?: string;
-
- /**
- * Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
- * the kernel release version. (Mac, iOS, and Linux only)
- */
- os_version_extra?: string;
- }
-
- export interface TeamsDevicesFirewallInputRequest {
- /**
- * Enabled
- */
- enabled: boolean;
-
- /**
- * Operating System
- */
- operating_system: 'windows' | 'mac';
- }
-
- export interface TeamsDevicesSentineloneInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
-
- /**
- * File path.
- */
- path: string;
-
- /**
- * SHA-256.
- */
- sha256?: string;
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ export interface TeamsDevicesCarbonblackInputRequest {
+ /**
+ * Operating system
+ */
+ operating_system: 'windows' | 'linux' | 'mac';
- export interface TeamsDevicesCarbonblackInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
+ /**
+ * File path.
+ */
+ path: string;
- /**
- * File path.
- */
- path: string;
+ /**
+ * SHA-256.
+ */
+ sha256?: string;
- /**
- * SHA-256.
- */
- sha256?: string;
+ /**
+ * Signing certificate thumbprint.
+ */
+ thumbprint?: string;
+ }
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ export interface TeamsDevicesDiskEncryptionInputRequest {
+ /**
+ * List of volume names to be checked for encryption.
+ */
+ checkDisks?: Array;
- export interface TeamsDevicesDiskEncryptionInputRequest {
- /**
- * List of volume names to be checked for encryption.
- */
- checkDisks?: Array;
+ /**
+ * Whether to check all disks for encryption.
+ */
+ requireAll?: boolean;
+ }
- /**
- * Whether to check all disks for encryption.
- */
- requireAll?: boolean;
- }
+ export interface TeamsDevicesApplicationInputRequest {
+ /**
+ * Operating system
+ */
+ operating_system: 'windows' | 'linux' | 'mac';
- export interface TeamsDevicesApplicationInputRequest {
- /**
- * Operating system
- */
- operating_system: 'windows' | 'linux' | 'mac';
+ /**
+ * Path for the application.
+ */
+ path: string;
- /**
- * Path for the application.
- */
- path: string;
+ /**
+ * SHA-256.
+ */
+ sha256?: string;
- /**
- * SHA-256.
- */
- sha256?: string;
+ /**
+ * Signing certificate thumbprint.
+ */
+ thumbprint?: string;
+ }
- /**
- * Signing certificate thumbprint.
- */
- thumbprint?: string;
- }
+ export interface TeamsDevicesClientCertificateInputRequest {
+ /**
+ * UUID of Cloudflare managed certificate.
+ */
+ certificate_id: string;
- export interface TeamsDevicesClientCertificateInputRequest {
- /**
- * UUID of Cloudflare managed certificate.
- */
- certificate_id: string;
+ /**
+ * Common Name that is protected by the certificate
+ */
+ cn: string;
+ }
- /**
- * Common Name that is protected by the certificate
- */
- cn: string;
- }
+ export interface TeamsDevicesWorkspaceOneInputRequest {
+ /**
+ * Compliance Status
+ */
+ compliance_status: 'compliant' | 'noncompliant' | 'unknown';
- export interface TeamsDevicesWorkspaceOneInputRequest {
- /**
- * Compliance Status
- */
- compliance_status: 'compliant' | 'noncompliant' | 'unknown';
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
+ }
- /**
- * Posture Integration ID.
- */
- connection_id: string;
- }
+ export interface TeamsDevicesCrowdstrikeInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
- export interface TeamsDevicesCrowdstrikeInputRequest {
- /**
- * Posture Integration ID.
- */
- connection_id: string;
+ /**
+ * Operator
+ */
+ operator?: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Operator
- */
- operator?: '<' | '<=' | '>' | '>=' | '==';
+ /**
+ * Os Version
+ */
+ os?: string;
- /**
- * Os Version
- */
- os?: string;
+ /**
+ * overall
+ */
+ overall?: string;
- /**
- * overall
- */
- overall?: string;
+ /**
+ * SensorConfig
+ */
+ sensor_config?: string;
- /**
- * SensorConfig
- */
- sensor_config?: string;
+ /**
+ * Version
+ */
+ version?: string;
- /**
- * Version
- */
- version?: string;
+ /**
+ * Version Operator
+ */
+ versionOperator?: '<' | '<=' | '>' | '>=' | '==';
+ }
- /**
- * Version Operator
- */
- versionOperator?: '<' | '<=' | '>' | '>=' | '==';
- }
+ export interface TeamsDevicesIntuneInputRequest {
+ /**
+ * Compliance Status
+ */
+ compliance_status:
+ | 'compliant'
+ | 'noncompliant'
+ | 'unknown'
+ | 'notapplicable'
+ | 'ingraceperiod'
+ | 'error';
- export interface TeamsDevicesIntuneInputRequest {
- /**
- * Compliance Status
- */
- compliance_status: 'compliant' | 'noncompliant' | 'unknown' | 'notapplicable' | 'ingraceperiod' | 'error';
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
+ }
- /**
- * Posture Integration ID.
- */
- connection_id: string;
- }
+ export interface TeamsDevicesKolideInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
- export interface TeamsDevicesKolideInputRequest {
- /**
- * Posture Integration ID.
- */
- connection_id: string;
+ /**
+ * Count Operator
+ */
+ countOperator: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Count Operator
- */
- countOperator: '<' | '<=' | '>' | '>=' | '==';
+ /**
+ * The Number of Issues.
+ */
+ issue_count: string;
+ }
- /**
- * The Number of Issues.
- */
- issue_count: string;
- }
+ export interface TeamsDevicesTaniumInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
- export interface TeamsDevicesTaniumInputRequest {
- /**
- * Posture Integration ID.
- */
- connection_id: string;
+ /**
+ * For more details on eid last seen, refer to the Tanium documentation.
+ */
+ eid_last_seen?: string;
- /**
- * For more details on eid last seen, refer to the Tanium documentation.
- */
- eid_last_seen?: string;
+ /**
+ * Operator to evaluate risk_level or eid_last_seen.
+ */
+ operator?: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Operator to evaluate risk_level or eid_last_seen.
- */
- operator?: '<' | '<=' | '>' | '>=' | '==';
+ /**
+ * For more details on risk level, refer to the Tanium documentation.
+ */
+ risk_level?: 'low' | 'medium' | 'high' | 'critical';
- /**
- * For more details on risk level, refer to the Tanium documentation.
- */
- risk_level?: 'low' | 'medium' | 'high' | 'critical';
+ /**
+ * Score Operator
+ */
+ scoreOperator?: '<' | '<=' | '>' | '>=' | '==';
- /**
- * Score Operator
- */
- scoreOperator?: '<' | '<=' | '>' | '>=' | '==';
+ /**
+ * For more details on total score, refer to the Tanium documentation.
+ */
+ total_score?: number;
+ }
- /**
- * For more details on total score, refer to the Tanium documentation.
- */
- total_score?: number;
- }
+ export interface TeamsDevicesSentineloneS2sInputRequest {
+ /**
+ * Posture Integration ID.
+ */
+ connection_id: string;
- export interface TeamsDevicesSentineloneS2sInputRequest {
- /**
- * Posture Integration ID.
- */
- connection_id: string;
+ /**
+ * The Number of active threats.
+ */
+ active_threats?: number;
- /**
- * The Number of active threats.
- */
- active_threats?: number;
+ /**
+ * Whether device is infected.
+ */
+ infected?: boolean;
- /**
- * Whether device is infected.
- */
- infected?: boolean;
+ /**
+ * Whether device is active.
+ */
+ is_active?: boolean;
- /**
- * Whether device is active.
- */
- is_active?: boolean;
+ /**
+ * Network status of device.
+ */
+ network_status?: 'connected' | 'disconnected' | 'disconnecting' | 'connecting';
- /**
- * Network status of device.
- */
- network_status?: 'connected' | 'disconnected' | 'disconnecting' | 'connecting';
+ /**
+ * operator
+ */
+ operator?: '<' | '<=' | '>' | '>=' | '==';
+ }
- /**
- * operator
- */
- operator?: '<' | '<=' | '>' | '>=' | '==';
+ export interface Match {
+ platform?: 'windows' | 'mac' | 'linux' | 'android' | 'ios';
+ }
}
+}
- export interface Match {
- platform?: 'windows' | 'mac' | 'linux' | 'android' | 'ios';
- }
+export interface PostureDeleteResponse {
+ /**
+ * API UUID.
+ */
+ id?: string;
}
-export interface PostureReplaceResponse {
+export interface PostureGetResponse {
/**
* API UUID.
*/
@@ -1359,27 +1359,27 @@ export interface PostureReplaceResponse {
* The value to be checked against.
*/
input?:
- | PostureReplaceResponse.TeamsDevicesFileInputRequest
- | PostureReplaceResponse.TeamsDevicesUniqueClientIDInputRequest
- | PostureReplaceResponse.TeamsDevicesDomainJoinedInputRequest
- | PostureReplaceResponse.TeamsDevicesOsVersionInputRequest
- | PostureReplaceResponse.TeamsDevicesFirewallInputRequest
- | PostureReplaceResponse.TeamsDevicesSentineloneInputRequest
- | PostureReplaceResponse.TeamsDevicesCarbonblackInputRequest
- | PostureReplaceResponse.TeamsDevicesDiskEncryptionInputRequest
- | PostureReplaceResponse.TeamsDevicesApplicationInputRequest
- | PostureReplaceResponse.TeamsDevicesClientCertificateInputRequest
- | PostureReplaceResponse.TeamsDevicesWorkspaceOneInputRequest
- | PostureReplaceResponse.TeamsDevicesCrowdstrikeInputRequest
- | PostureReplaceResponse.TeamsDevicesIntuneInputRequest
- | PostureReplaceResponse.TeamsDevicesKolideInputRequest
- | PostureReplaceResponse.TeamsDevicesTaniumInputRequest
- | PostureReplaceResponse.TeamsDevicesSentineloneS2sInputRequest;
+ | PostureGetResponse.TeamsDevicesFileInputRequest
+ | PostureGetResponse.TeamsDevicesUniqueClientIDInputRequest
+ | PostureGetResponse.TeamsDevicesDomainJoinedInputRequest
+ | PostureGetResponse.TeamsDevicesOsVersionInputRequest
+ | PostureGetResponse.TeamsDevicesFirewallInputRequest
+ | PostureGetResponse.TeamsDevicesSentineloneInputRequest
+ | PostureGetResponse.TeamsDevicesCarbonblackInputRequest
+ | PostureGetResponse.TeamsDevicesDiskEncryptionInputRequest
+ | PostureGetResponse.TeamsDevicesApplicationInputRequest
+ | PostureGetResponse.TeamsDevicesClientCertificateInputRequest
+ | PostureGetResponse.TeamsDevicesWorkspaceOneInputRequest
+ | PostureGetResponse.TeamsDevicesCrowdstrikeInputRequest
+ | PostureGetResponse.TeamsDevicesIntuneInputRequest
+ | PostureGetResponse.TeamsDevicesKolideInputRequest
+ | PostureGetResponse.TeamsDevicesTaniumInputRequest
+ | PostureGetResponse.TeamsDevicesSentineloneS2sInputRequest;
/**
* The conditions that the client must match to run the rule.
*/
- match?: Array;
+ match?: Array;
/**
* The name of the device posture rule.
@@ -1417,7 +1417,7 @@ export interface PostureReplaceResponse {
| 'sentinelone_s2s';
}
-export namespace PostureReplaceResponse {
+export namespace PostureGetResponse {
export interface TeamsDevicesFileInputRequest {
/**
* Operating system
@@ -2159,7 +2159,7 @@ export namespace PostureCreateParams {
}
}
-export interface PostureReplaceParams {
+export interface PostureUpdateParams {
/**
* The name of the device posture rule.
*/
@@ -2204,27 +2204,27 @@ export interface PostureReplaceParams {
* The value to be checked against.
*/
input?:
- | PostureReplaceParams.TeamsDevicesFileInputRequest
- | PostureReplaceParams.TeamsDevicesUniqueClientIDInputRequest
- | PostureReplaceParams.TeamsDevicesDomainJoinedInputRequest
- | PostureReplaceParams.TeamsDevicesOsVersionInputRequest
- | PostureReplaceParams.TeamsDevicesFirewallInputRequest
- | PostureReplaceParams.TeamsDevicesSentineloneInputRequest
- | PostureReplaceParams.TeamsDevicesCarbonblackInputRequest
- | PostureReplaceParams.TeamsDevicesDiskEncryptionInputRequest
- | PostureReplaceParams.TeamsDevicesApplicationInputRequest
- | PostureReplaceParams.TeamsDevicesClientCertificateInputRequest
- | PostureReplaceParams.TeamsDevicesWorkspaceOneInputRequest
- | PostureReplaceParams.TeamsDevicesCrowdstrikeInputRequest
- | PostureReplaceParams.TeamsDevicesIntuneInputRequest
- | PostureReplaceParams.TeamsDevicesKolideInputRequest
- | PostureReplaceParams.TeamsDevicesTaniumInputRequest
- | PostureReplaceParams.TeamsDevicesSentineloneS2sInputRequest;
+ | PostureUpdateParams.TeamsDevicesFileInputRequest
+ | PostureUpdateParams.TeamsDevicesUniqueClientIDInputRequest
+ | PostureUpdateParams.TeamsDevicesDomainJoinedInputRequest
+ | PostureUpdateParams.TeamsDevicesOsVersionInputRequest
+ | PostureUpdateParams.TeamsDevicesFirewallInputRequest
+ | PostureUpdateParams.TeamsDevicesSentineloneInputRequest
+ | PostureUpdateParams.TeamsDevicesCarbonblackInputRequest
+ | PostureUpdateParams.TeamsDevicesDiskEncryptionInputRequest
+ | PostureUpdateParams.TeamsDevicesApplicationInputRequest
+ | PostureUpdateParams.TeamsDevicesClientCertificateInputRequest
+ | PostureUpdateParams.TeamsDevicesWorkspaceOneInputRequest
+ | PostureUpdateParams.TeamsDevicesCrowdstrikeInputRequest
+ | PostureUpdateParams.TeamsDevicesIntuneInputRequest
+ | PostureUpdateParams.TeamsDevicesKolideInputRequest
+ | PostureUpdateParams.TeamsDevicesTaniumInputRequest
+ | PostureUpdateParams.TeamsDevicesSentineloneS2sInputRequest;
/**
* The conditions that the client must match to run the rule.
*/
- match?: Array;
+ match?: Array;
/**
* Polling frequency for the WARP client posture check. Default: `5m` (poll every
@@ -2233,7 +2233,7 @@ export interface PostureReplaceParams {
schedule?: string;
}
-export namespace PostureReplaceParams {
+export namespace PostureUpdateParams {
export interface TeamsDevicesFileInputRequest {
/**
* Operating system
@@ -2569,17 +2569,17 @@ export namespace PostureReplaceParams {
export namespace Postures {
export import PostureCreateResponse = PosturesAPI.PostureCreateResponse;
+ export import PostureUpdateResponse = PosturesAPI.PostureUpdateResponse;
export import PostureListResponse = PosturesAPI.PostureListResponse;
export import PostureDeleteResponse = PosturesAPI.PostureDeleteResponse;
export import PostureGetResponse = PosturesAPI.PostureGetResponse;
- export import PostureReplaceResponse = PosturesAPI.PostureReplaceResponse;
export import PostureCreateParams = PosturesAPI.PostureCreateParams;
- export import PostureReplaceParams = PosturesAPI.PostureReplaceParams;
+ export import PostureUpdateParams = PosturesAPI.PostureUpdateParams;
export import Integrations = IntegrationsAPI.Integrations;
export import IntegrationCreateResponse = IntegrationsAPI.IntegrationCreateResponse;
- export import IntegrationUpdateResponse = IntegrationsAPI.IntegrationUpdateResponse;
export import IntegrationDeleteResponse = IntegrationsAPI.IntegrationDeleteResponse;
+ export import IntegrationEditResponse = IntegrationsAPI.IntegrationEditResponse;
export import IntegrationGetResponse = IntegrationsAPI.IntegrationGetResponse;
export import IntegrationCreateParams = IntegrationsAPI.IntegrationCreateParams;
- export import IntegrationUpdateParams = IntegrationsAPI.IntegrationUpdateParams;
+ export import IntegrationEditParams = IntegrationsAPI.IntegrationEditParams;
}
diff --git a/src/resources/devices/settings.ts b/src/resources/devices/settings.ts
index 27bb9ae569..75504e929e 100644
--- a/src/resources/devices/settings.ts
+++ b/src/resources/devices/settings.ts
@@ -6,33 +6,33 @@ import * as SettingsAPI from 'cloudflare/resources/devices/settings';
export class Settings extends APIResource {
/**
- * Describes the current device settings for a Zero Trust account.
+ * Updates the current device settings for a Zero Trust account.
*/
- list(identifier: unknown, options?: Core.RequestOptions): Core.APIPromise {
+ update(
+ identifier: unknown,
+ body: SettingUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
return (
- this._client.get(`/accounts/${identifier}/devices/settings`, options) as Core.APIPromise<{
- result: SettingListResponse | null;
+ this._client.put(`/accounts/${identifier}/devices/settings`, { body, ...options }) as Core.APIPromise<{
+ result: SettingUpdateResponse | null;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
- * Updates the current device settings for a Zero Trust account.
+ * Describes the current device settings for a Zero Trust account.
*/
- replace(
- identifier: unknown,
- body: SettingReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
+ list(identifier: unknown, options?: Core.RequestOptions): Core.APIPromise {
return (
- this._client.put(`/accounts/${identifier}/devices/settings`, { body, ...options }) as Core.APIPromise<{
- result: SettingReplaceResponse | null;
+ this._client.get(`/accounts/${identifier}/devices/settings`, options) as Core.APIPromise<{
+ result: SettingListResponse | null;
}>
)._thenUnwrap((obj) => obj.result);
}
}
-export interface SettingListResponse {
+export interface SettingUpdateResponse {
/**
* Enable gateway proxy filtering on TCP.
*/
@@ -54,7 +54,7 @@ export interface SettingListResponse {
use_zt_virtual_ip?: boolean;
}
-export interface SettingReplaceResponse {
+export interface SettingListResponse {
/**
* Enable gateway proxy filtering on TCP.
*/
@@ -76,7 +76,7 @@ export interface SettingReplaceResponse {
use_zt_virtual_ip?: boolean;
}
-export interface SettingReplaceParams {
+export interface SettingUpdateParams {
/**
* Enable gateway proxy filtering on TCP.
*/
@@ -99,7 +99,7 @@ export interface SettingReplaceParams {
}
export namespace Settings {
+ export import SettingUpdateResponse = SettingsAPI.SettingUpdateResponse;
export import SettingListResponse = SettingsAPI.SettingListResponse;
- export import SettingReplaceResponse = SettingsAPI.SettingReplaceResponse;
- export import SettingReplaceParams = SettingsAPI.SettingReplaceParams;
+ export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
}
diff --git a/src/resources/dispatchers/dispatchers.ts b/src/resources/dispatchers/dispatchers.ts
index 10327e38e5..0f69f7ba9f 100644
--- a/src/resources/dispatchers/dispatchers.ts
+++ b/src/resources/dispatchers/dispatchers.ts
@@ -9,8 +9,8 @@ export class Dispatchers extends APIResource {
export namespace Dispatchers {
export import Scripts = ScriptsAPI.Scripts;
+ export import ScriptUpdateResponse = ScriptsAPI.ScriptUpdateResponse;
export import ScriptGetResponse = ScriptsAPI.ScriptGetResponse;
- export import ScriptReplaceResponse = ScriptsAPI.ScriptReplaceResponse;
+ export import ScriptUpdateParams = ScriptsAPI.ScriptUpdateParams;
export import ScriptDeleteParams = ScriptsAPI.ScriptDeleteParams;
- export import ScriptReplaceParams = ScriptsAPI.ScriptReplaceParams;
}
diff --git a/src/resources/dispatchers/index.ts b/src/resources/dispatchers/index.ts
index 7228562e30..9b2f148e0d 100644
--- a/src/resources/dispatchers/index.ts
+++ b/src/resources/dispatchers/index.ts
@@ -2,9 +2,9 @@
export { Dispatchers } from './dispatchers';
export {
+ ScriptUpdateResponse,
ScriptGetResponse,
- ScriptReplaceResponse,
+ ScriptUpdateParams,
ScriptDeleteParams,
- ScriptReplaceParams,
Scripts,
} from './scripts';
diff --git a/src/resources/dispatchers/scripts.ts b/src/resources/dispatchers/scripts.ts
index e7b3a8b37a..468254ca84 100644
--- a/src/resources/dispatchers/scripts.ts
+++ b/src/resources/dispatchers/scripts.ts
@@ -6,6 +6,24 @@ import * as ScriptsAPI from 'cloudflare/resources/dispatchers/scripts';
import { type Uploadable, maybeMultipartFormRequestOptions } from 'cloudflare/core';
export class Scripts extends APIResource {
+ /**
+ * Upload a worker module to a Workers for Platforms namespace.
+ */
+ update(
+ accountId: string,
+ dispatchNamespace: string,
+ scriptName: string,
+ body: ScriptUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(
+ `/accounts/${accountId}/workers/dispatch/namespaces/${dispatchNamespace}/scripts/${scriptName}`,
+ maybeMultipartFormRequestOptions({ body, ...options }),
+ ) as Core.APIPromise<{ result: ScriptUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Delete a worker from a Workers for Platforms namespace. This call has no
* response body on a successful delete.
@@ -40,23 +58,74 @@ export class Scripts extends APIResource {
) as Core.APIPromise<{ result: ScriptGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
+}
+export interface ScriptUpdateResponse {
/**
- * Upload a worker module to a Workers for Platforms namespace.
+ * The id of the script in the Workers system. Usually the script name.
*/
- replace(
- accountId: string,
- dispatchNamespace: string,
- scriptName: string,
- body: ScriptReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(
- `/accounts/${accountId}/workers/dispatch/namespaces/${dispatchNamespace}/scripts/${scriptName}`,
- maybeMultipartFormRequestOptions({ body, ...options }),
- ) as Core.APIPromise<{ result: ScriptReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
+ id?: string;
+
+ /**
+ * When the script was created.
+ */
+ created_on?: string;
+
+ /**
+ * Hashed script content, can be used in a If-None-Match header when updating.
+ */
+ etag?: string;
+
+ /**
+ * Whether Logpush is turned on for the Worker.
+ */
+ logpush?: boolean;
+
+ /**
+ * When the script was last modified.
+ */
+ modified_on?: string;
+
+ /**
+ * Deprecated. Deployment metadata for internal usage.
+ */
+ pipeline_hash?: string;
+
+ /**
+ * Specifies the placement mode for the Worker (e.g. 'smart').
+ */
+ placement_mode?: string;
+
+ /**
+ * List of Workers that will consume logs from the attached Worker.
+ */
+ tail_consumers?: Array;
+
+ /**
+ * Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
+ */
+ usage_model?: string;
+}
+
+export namespace ScriptUpdateResponse {
+ /**
+ * A reference to a script that will consume logs from the attached Worker.
+ */
+ export interface TailConsumer {
+ /**
+ * Name of Worker that is to be the consumer.
+ */
+ service: string;
+
+ /**
+ * Optional environment if the Worker utilizes one.
+ */
+ environment?: string;
+
+ /**
+ * Optional dispatch namespace the script belongs to.
+ */
+ namespace?: string;
}
}
@@ -153,87 +222,9 @@ export namespace ScriptGetResponse {
}
}
-export interface ScriptReplaceResponse {
- /**
- * The id of the script in the Workers system. Usually the script name.
- */
- id?: string;
-
- /**
- * When the script was created.
- */
- created_on?: string;
-
- /**
- * Hashed script content, can be used in a If-None-Match header when updating.
- */
- etag?: string;
+export type ScriptUpdateParams = ScriptUpdateParams.Variant0 | ScriptUpdateParams.Variant1;
- /**
- * Whether Logpush is turned on for the Worker.
- */
- logpush?: boolean;
-
- /**
- * When the script was last modified.
- */
- modified_on?: string;
-
- /**
- * Deprecated. Deployment metadata for internal usage.
- */
- pipeline_hash?: string;
-
- /**
- * Specifies the placement mode for the Worker (e.g. 'smart').
- */
- placement_mode?: string;
-
- /**
- * List of Workers that will consume logs from the attached Worker.
- */
- tail_consumers?: Array;
-
- /**
- * Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
- */
- usage_model?: string;
-}
-
-export namespace ScriptReplaceResponse {
- /**
- * A reference to a script that will consume logs from the attached Worker.
- */
- export interface TailConsumer {
- /**
- * Name of Worker that is to be the consumer.
- */
- service: string;
-
- /**
- * Optional environment if the Worker utilizes one.
- */
- environment?: string;
-
- /**
- * Optional dispatch namespace the script belongs to.
- */
- namespace?: string;
- }
-}
-
-export interface ScriptDeleteParams {
- /**
- * If set to true, delete will not be stopped by associated service binding,
- * durable object, or other binding. Any of these associated bindings/durable
- * objects will be deleted along with the script.
- */
- force?: boolean;
-}
-
-export type ScriptReplaceParams = ScriptReplaceParams.Variant0 | ScriptReplaceParams.Variant1;
-
-export namespace ScriptReplaceParams {
+export namespace ScriptUpdateParams {
export interface Variant0 {
/**
* A module comprising a Worker script, often a javascript file. Multiple modules
@@ -245,7 +236,7 @@ export namespace ScriptReplaceParams {
/**
* JSON encoded metadata about the uploaded parts and Worker configuration.
*/
- metadata?: ScriptReplaceParams.Variant0.Metadata;
+ metadata?: ScriptUpdateParams.Variant0.Metadata;
}
export namespace Variant0 {
@@ -475,9 +466,18 @@ export namespace ScriptReplaceParams {
}
}
+export interface ScriptDeleteParams {
+ /**
+ * If set to true, delete will not be stopped by associated service binding,
+ * durable object, or other binding. Any of these associated bindings/durable
+ * objects will be deleted along with the script.
+ */
+ force?: boolean;
+}
+
export namespace Scripts {
+ export import ScriptUpdateResponse = ScriptsAPI.ScriptUpdateResponse;
export import ScriptGetResponse = ScriptsAPI.ScriptGetResponse;
- export import ScriptReplaceResponse = ScriptsAPI.ScriptReplaceResponse;
+ export import ScriptUpdateParams = ScriptsAPI.ScriptUpdateParams;
export import ScriptDeleteParams = ScriptsAPI.ScriptDeleteParams;
- export import ScriptReplaceParams = ScriptsAPI.ScriptReplaceParams;
}
diff --git a/src/resources/dlp/datasets/datasets.ts b/src/resources/dlp/datasets/datasets.ts
index f051422a83..ead383a215 100644
--- a/src/resources/dlp/datasets/datasets.ts
+++ b/src/resources/dlp/datasets/datasets.ts
@@ -23,6 +23,23 @@ export class Datasets extends APIResource {
)._thenUnwrap((obj) => obj.result);
}
+ /**
+ * Update details about a dataset.
+ */
+ update(
+ accountId: string,
+ datasetId: string,
+ body: DatasetUpdateParams,
+ options?: Core.RequestOptions,
+ ): Core.APIPromise {
+ return (
+ this._client.put(`/accounts/${accountId}/dlp/datasets/${datasetId}`, {
+ body,
+ ...options,
+ }) as Core.APIPromise<{ result: DatasetUpdateResponse }>
+ )._thenUnwrap((obj) => obj.result);
+ }
+
/**
* Fetch all datasets with information about available versions.
*/
@@ -60,23 +77,6 @@ export class Datasets extends APIResource {
}>
)._thenUnwrap((obj) => obj.result);
}
-
- /**
- * Update details about a dataset.
- */
- replace(
- accountId: string,
- datasetId: string,
- body: DatasetReplaceParams,
- options?: Core.RequestOptions,
- ): Core.APIPromise {
- return (
- this._client.put(`/accounts/${accountId}/dlp/datasets/${datasetId}`, {
- body,
- ...options,
- }) as Core.APIPromise<{ result: DatasetReplaceResponse }>
- )._thenUnwrap((obj) => obj.result);
- }
}
export interface DatasetCreateResponse {
@@ -128,6 +128,36 @@ export namespace DatasetCreateResponse {
}
}
+export interface DatasetUpdateResponse {
+ id: string;
+
+ created_at: string;
+
+ name: string;
+
+ num_cells: number;
+
+ secret: boolean;
+
+ status: 'empty' | 'uploading' | 'failed' | 'complete';
+
+ updated_at: string;
+
+ uploads: Array;
+
+ description?: string | null;
+}
+
+export namespace DatasetUpdateResponse {
+ export interface Upload {
+ num_cells: number;
+
+ status: 'empty' | 'uploading' | 'failed' | 'complete';
+
+ version: number;
+ }
+}
+
export type DatasetListResponse = Array;
export namespace DatasetListResponse {
@@ -192,36 +222,6 @@ export namespace DatasetGetResponse {
}
}
-export interface DatasetReplaceResponse {
- id: string;
-
- created_at: string;
-
- name: string;
-
- num_cells: number;
-
- secret: boolean;
-
- status: 'empty' | 'uploading' | 'failed' | 'complete';
-
- updated_at: string;
-
- uploads: Array;
-
- description?: string | null;
-}
-
-export namespace DatasetReplaceResponse {
- export interface Upload {
- num_cells: number;
-
- status: 'empty' | 'uploading' | 'failed' | 'complete';
-
- version: number;
- }
-}
-
export interface DatasetCreateParams {
name: string;
@@ -236,7 +236,7 @@ export interface DatasetCreateParams {
secret?: boolean;
}
-export interface DatasetReplaceParams {
+export interface DatasetUpdateParams {
description?: string | null;
name?: string | null;
@@ -244,13 +244,13 @@ export interface DatasetReplaceParams {
export namespace Datasets {
export import DatasetCreateResponse = DatasetsAPI.DatasetCreateResponse;
+ export import DatasetUpdateResponse = DatasetsAPI.DatasetUpdateResponse;
export import DatasetListResponse = DatasetsAPI.DatasetListResponse;
export import DatasetGetResponse = DatasetsAPI.DatasetGetResponse;
- export import DatasetReplaceResponse = DatasetsAPI.DatasetReplaceResponse;
export import DatasetCreateParams = DatasetsAPI.DatasetCreateParams;
- export import DatasetReplaceParams = DatasetsAPI.DatasetReplaceParams;
+ export import DatasetUpdateParams = DatasetsAPI.DatasetUpdateParams;
export import Upload = UploadAPI.Upload;
export import UploadCreateResponse = UploadAPI.UploadCreateResponse;
- export import UploadUpdateResponse = UploadAPI.UploadUpdateResponse;
- export import UploadUpdateParams = UploadAPI.UploadUpdateParams;
+ export import UploadEditResponse = UploadAPI.UploadEditResponse;
+ export import UploadEditParams = UploadAPI.UploadEditParams;
}
diff --git a/src/resources/dlp/datasets/index.ts b/src/resources/dlp/datasets/index.ts
index 065b8b159e..608549c5fd 100644
--- a/src/resources/dlp/datasets/index.ts
+++ b/src/resources/dlp/datasets/index.ts
@@ -2,11 +2,11 @@
export {
DatasetCreateResponse,
+ DatasetUpdateResponse,
DatasetListResponse,
DatasetGetResponse,
- DatasetReplaceResponse,
DatasetCreateParams,
- DatasetReplaceParams,
+ DatasetUpdateParams,
Datasets,
} from './datasets';
-export { UploadCreateResponse, UploadUpdateResponse, UploadUpdateParams, Upload } from './upload';
+export { UploadCreateResponse, UploadEditResponse, UploadEditParams, Upload } from './upload';
diff --git a/src/resources/dlp/datasets/upload.ts b/src/resources/dlp/datasets/upload.ts
index bbf41adea3..f6ca79742f 100644
--- a/src/resources/dlp/datasets/upload.ts
+++ b/src/resources/dlp/datasets/upload.ts
@@ -24,18 +24,18 @@ export class Upload extends APIResource {
/**
* Upload a new version of a dataset.
*/
- update(
+ edit(
accountId: string,
datasetId: string,
version: number,
- body: UploadUpdateParams,
+ body: UploadEditParams,
options?: Core.RequestOptions,
- ): Core.APIPromise {
+ ): Core.APIPromise