@distilled.cloud/cloudflare 0.0.0-john
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/lib/auth.d.ts +14 -0
- package/lib/auth.d.ts.map +1 -0
- package/lib/auth.js +13 -0
- package/lib/auth.js.map +1 -0
- package/lib/category.d.ts +2 -0
- package/lib/category.d.ts.map +1 -0
- package/lib/category.js +2 -0
- package/lib/category.js.map +1 -0
- package/lib/client/api.d.ts +12 -0
- package/lib/client/api.d.ts.map +1 -0
- package/lib/client/api.js +292 -0
- package/lib/client/api.js.map +1 -0
- package/lib/client/index.d.ts +8 -0
- package/lib/client/index.d.ts.map +1 -0
- package/lib/client/index.js +8 -0
- package/lib/client/index.js.map +1 -0
- package/lib/credentials.d.ts +68 -0
- package/lib/credentials.d.ts.map +1 -0
- package/lib/credentials.js +136 -0
- package/lib/credentials.js.map +1 -0
- package/lib/errors.d.ts +48 -0
- package/lib/errors.d.ts.map +1 -0
- package/lib/errors.js +31 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +10 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +10 -0
- package/lib/index.js.map +1 -0
- package/lib/retry.d.ts +14 -0
- package/lib/retry.d.ts.map +1 -0
- package/lib/retry.js +14 -0
- package/lib/retry.js.map +1 -0
- package/lib/schemas.d.ts +29 -0
- package/lib/schemas.d.ts.map +1 -0
- package/lib/schemas.js +34 -0
- package/lib/schemas.js.map +1 -0
- package/lib/sensitive.d.ts +5 -0
- package/lib/sensitive.d.ts.map +1 -0
- package/lib/sensitive.js +5 -0
- package/lib/sensitive.js.map +1 -0
- package/lib/services/abuse-reports.d.ts +296 -0
- package/lib/services/abuse-reports.d.ts.map +1 -0
- package/lib/services/abuse-reports.js +414 -0
- package/lib/services/abuse-reports.js.map +1 -0
- package/lib/services/accounts.d.ts +766 -0
- package/lib/services/accounts.d.ts.map +1 -0
- package/lib/services/accounts.js +860 -0
- package/lib/services/accounts.js.map +1 -0
- package/lib/services/acm.d.ts +73 -0
- package/lib/services/acm.d.ts.map +1 -0
- package/lib/services/acm.js +80 -0
- package/lib/services/acm.js.map +1 -0
- package/lib/services/addressing.d.ts +1321 -0
- package/lib/services/addressing.d.ts.map +1 -0
- package/lib/services/addressing.js +1863 -0
- package/lib/services/addressing.js.map +1 -0
- package/lib/services/ai-gateway.d.ts +1137 -0
- package/lib/services/ai-gateway.d.ts.map +1 -0
- package/lib/services/ai-gateway.js +1830 -0
- package/lib/services/ai-gateway.js.map +1 -0
- package/lib/services/ai.d.ts +297 -0
- package/lib/services/ai.d.ts.map +1 -0
- package/lib/services/ai.js +352 -0
- package/lib/services/ai.js.map +1 -0
- package/lib/services/aisearch.d.ts +1069 -0
- package/lib/services/aisearch.d.ts.map +1 -0
- package/lib/services/aisearch.js +2542 -0
- package/lib/services/aisearch.js.map +1 -0
- package/lib/services/alerting.d.ts +855 -0
- package/lib/services/alerting.d.ts.map +1 -0
- package/lib/services/alerting.js +1445 -0
- package/lib/services/alerting.js.map +1 -0
- package/lib/services/api-gateway.d.ts +1088 -0
- package/lib/services/api-gateway.d.ts.map +1 -0
- package/lib/services/api-gateway.js +1655 -0
- package/lib/services/api-gateway.js.map +1 -0
- package/lib/services/argo.d.ts +101 -0
- package/lib/services/argo.d.ts.map +1 -0
- package/lib/services/argo.js +113 -0
- package/lib/services/argo.js.map +1 -0
- package/lib/services/audit-logs.d.ts +46 -0
- package/lib/services/audit-logs.d.ts.map +1 -0
- package/lib/services/audit-logs.js +37 -0
- package/lib/services/audit-logs.js.map +1 -0
- package/lib/services/billing.d.ts +62 -0
- package/lib/services/billing.d.ts.map +1 -0
- package/lib/services/billing.js +102 -0
- package/lib/services/billing.js.map +1 -0
- package/lib/services/bot-management.d.ts +124 -0
- package/lib/services/bot-management.d.ts.map +1 -0
- package/lib/services/bot-management.js +262 -0
- package/lib/services/bot-management.js.map +1 -0
- package/lib/services/botnet-feed.d.ts +65 -0
- package/lib/services/botnet-feed.d.ts.map +1 -0
- package/lib/services/botnet-feed.js +88 -0
- package/lib/services/botnet-feed.js.map +1 -0
- package/lib/services/brand-protection.d.ts +194 -0
- package/lib/services/brand-protection.d.ts.map +1 -0
- package/lib/services/brand-protection.js +221 -0
- package/lib/services/brand-protection.js.map +1 -0
- package/lib/services/browser-rendering.d.ts +857 -0
- package/lib/services/browser-rendering.d.ts.map +1 -0
- package/lib/services/browser-rendering.js +1142 -0
- package/lib/services/browser-rendering.js.map +1 -0
- package/lib/services/cache.d.ts +287 -0
- package/lib/services/cache.d.ts.map +1 -0
- package/lib/services/cache.js +354 -0
- package/lib/services/cache.js.map +1 -0
- package/lib/services/calls.d.ts +223 -0
- package/lib/services/calls.d.ts.map +1 -0
- package/lib/services/calls.js +188 -0
- package/lib/services/calls.js.map +1 -0
- package/lib/services/certificate-authorities.d.ts +40 -0
- package/lib/services/certificate-authorities.d.ts.map +1 -0
- package/lib/services/certificate-authorities.js +49 -0
- package/lib/services/certificate-authorities.js.map +1 -0
- package/lib/services/client-certificates.d.ts +288 -0
- package/lib/services/client-certificates.d.ts.map +1 -0
- package/lib/services/client-certificates.js +379 -0
- package/lib/services/client-certificates.js.map +1 -0
- package/lib/services/cloud-connector.d.ts +88 -0
- package/lib/services/cloud-connector.d.ts.map +1 -0
- package/lib/services/cloud-connector.js +97 -0
- package/lib/services/cloud-connector.js.map +1 -0
- package/lib/services/cloudforce-one.d.ts +1387 -0
- package/lib/services/cloudforce-one.d.ts.map +1 -0
- package/lib/services/cloudforce-one.js +1741 -0
- package/lib/services/cloudforce-one.js.map +1 -0
- package/lib/services/connectivity.d.ts +291 -0
- package/lib/services/connectivity.d.ts.map +1 -0
- package/lib/services/connectivity.js +404 -0
- package/lib/services/connectivity.js.map +1 -0
- package/lib/services/content-scanning.d.ts +156 -0
- package/lib/services/content-scanning.d.ts.map +1 -0
- package/lib/services/content-scanning.js +175 -0
- package/lib/services/content-scanning.js.map +1 -0
- package/lib/services/custom-certificates.d.ts +240 -0
- package/lib/services/custom-certificates.d.ts.map +1 -0
- package/lib/services/custom-certificates.js +336 -0
- package/lib/services/custom-certificates.js.map +1 -0
- package/lib/services/custom-hostnames.d.ts +590 -0
- package/lib/services/custom-hostnames.d.ts.map +1 -0
- package/lib/services/custom-hostnames.js +1204 -0
- package/lib/services/custom-hostnames.js.map +1 -0
- package/lib/services/custom-nameservers.d.ts +87 -0
- package/lib/services/custom-nameservers.d.ts.map +1 -0
- package/lib/services/custom-nameservers.js +95 -0
- package/lib/services/custom-nameservers.js.map +1 -0
- package/lib/services/custom-pages.d.ts +89 -0
- package/lib/services/custom-pages.d.ts.map +1 -0
- package/lib/services/custom-pages.js +140 -0
- package/lib/services/custom-pages.js.map +1 -0
- package/lib/services/d1.d.ts +392 -0
- package/lib/services/d1.d.ts.map +1 -0
- package/lib/services/d1.js +487 -0
- package/lib/services/d1.js.map +1 -0
- package/lib/services/dcv-delegation.d.ts +24 -0
- package/lib/services/dcv-delegation.d.ts.map +1 -0
- package/lib/services/dcv-delegation.js +24 -0
- package/lib/services/dcv-delegation.js.map +1 -0
- package/lib/services/diagnostics.d.ts +208 -0
- package/lib/services/diagnostics.d.ts.map +1 -0
- package/lib/services/diagnostics.js +288 -0
- package/lib/services/diagnostics.js.map +1 -0
- package/lib/services/dns-firewall.d.ts +317 -0
- package/lib/services/dns-firewall.d.ts.map +1 -0
- package/lib/services/dns-firewall.js +400 -0
- package/lib/services/dns-firewall.js.map +1 -0
- package/lib/services/dns.d.ts +3065 -0
- package/lib/services/dns.d.ts.map +1 -0
- package/lib/services/dns.js +4627 -0
- package/lib/services/dns.js.map +1 -0
- package/lib/services/durable-objects.d.ts +92 -0
- package/lib/services/durable-objects.d.ts.map +1 -0
- package/lib/services/durable-objects.js +103 -0
- package/lib/services/durable-objects.js.map +1 -0
- package/lib/services/email-routing.d.ts +598 -0
- package/lib/services/email-routing.d.ts.map +1 -0
- package/lib/services/email-routing.js +715 -0
- package/lib/services/email-routing.js.map +1 -0
- package/lib/services/email-security.d.ts +1389 -0
- package/lib/services/email-security.d.ts.map +1 -0
- package/lib/services/email-security.js +2261 -0
- package/lib/services/email-security.js.map +1 -0
- package/lib/services/filters.d.ts +197 -0
- package/lib/services/filters.d.ts.map +1 -0
- package/lib/services/filters.js +168 -0
- package/lib/services/filters.js.map +1 -0
- package/lib/services/firewall.d.ts +1352 -0
- package/lib/services/firewall.d.ts.map +1 -0
- package/lib/services/firewall.js +2084 -0
- package/lib/services/firewall.js.map +1 -0
- package/lib/services/healthchecks.d.ts +507 -0
- package/lib/services/healthchecks.d.ts.map +1 -0
- package/lib/services/healthchecks.js +867 -0
- package/lib/services/healthchecks.js.map +1 -0
- package/lib/services/hostnames.d.ts +86 -0
- package/lib/services/hostnames.d.ts.map +1 -0
- package/lib/services/hostnames.js +111 -0
- package/lib/services/hostnames.js.map +1 -0
- package/lib/services/hyperdrive.d.ts +203 -0
- package/lib/services/hyperdrive.d.ts.map +1 -0
- package/lib/services/hyperdrive.js +300 -0
- package/lib/services/hyperdrive.js.map +1 -0
- package/lib/services/iam.d.ts +657 -0
- package/lib/services/iam.d.ts.map +1 -0
- package/lib/services/iam.js +843 -0
- package/lib/services/iam.js.map +1 -0
- package/lib/services/images.d.ts +427 -0
- package/lib/services/images.d.ts.map +1 -0
- package/lib/services/images.js +444 -0
- package/lib/services/images.js.map +1 -0
- package/lib/services/intel.d.ts +865 -0
- package/lib/services/intel.d.ts.map +1 -0
- package/lib/services/intel.js +1266 -0
- package/lib/services/intel.js.map +1 -0
- package/lib/services/ips.d.ts +28 -0
- package/lib/services/ips.d.ts.map +1 -0
- package/lib/services/ips.js +39 -0
- package/lib/services/ips.js.map +1 -0
- package/lib/services/keyless-certificates.d.ts +197 -0
- package/lib/services/keyless-certificates.d.ts.map +1 -0
- package/lib/services/keyless-certificates.js +229 -0
- package/lib/services/keyless-certificates.js.map +1 -0
- package/lib/services/kv.d.ts +369 -0
- package/lib/services/kv.d.ts.map +1 -0
- package/lib/services/kv.js +453 -0
- package/lib/services/kv.js.map +1 -0
- package/lib/services/leaked-credential-checks.d.ts +129 -0
- package/lib/services/leaked-credential-checks.d.ts.map +1 -0
- package/lib/services/leaked-credential-checks.js +138 -0
- package/lib/services/leaked-credential-checks.js.map +1 -0
- package/lib/services/load-balancers.d.ts +1973 -0
- package/lib/services/load-balancers.d.ts.map +1 -0
- package/lib/services/load-balancers.js +3181 -0
- package/lib/services/load-balancers.js.map +1 -0
- package/lib/services/logpush.d.ts +401 -0
- package/lib/services/logpush.d.ts.map +1 -0
- package/lib/services/logpush.js +732 -0
- package/lib/services/logpush.js.map +1 -0
- package/lib/services/logs.d.ts +125 -0
- package/lib/services/logs.d.ts.map +1 -0
- package/lib/services/logs.js +149 -0
- package/lib/services/logs.js.map +1 -0
- package/lib/services/magic-cloud-networking.d.ts +1892 -0
- package/lib/services/magic-cloud-networking.d.ts.map +1 -0
- package/lib/services/magic-cloud-networking.js +5291 -0
- package/lib/services/magic-cloud-networking.js.map +1 -0
- package/lib/services/magic-network-monitoring.d.ts +379 -0
- package/lib/services/magic-network-monitoring.d.ts.map +1 -0
- package/lib/services/magic-network-monitoring.js +557 -0
- package/lib/services/magic-network-monitoring.js.map +1 -0
- package/lib/services/magic-transit.d.ts +3886 -0
- package/lib/services/magic-transit.d.ts.map +1 -0
- package/lib/services/magic-transit.js +6284 -0
- package/lib/services/magic-transit.js.map +1 -0
- package/lib/services/managed-transforms.d.ts +79 -0
- package/lib/services/managed-transforms.d.ts.map +1 -0
- package/lib/services/managed-transforms.js +111 -0
- package/lib/services/managed-transforms.js.map +1 -0
- package/lib/services/memberships.d.ts +204 -0
- package/lib/services/memberships.d.ts.map +1 -0
- package/lib/services/memberships.js +308 -0
- package/lib/services/memberships.js.map +1 -0
- package/lib/services/mtls-certificates.d.ts +164 -0
- package/lib/services/mtls-certificates.d.ts.map +1 -0
- package/lib/services/mtls-certificates.js +192 -0
- package/lib/services/mtls-certificates.js.map +1 -0
- package/lib/services/network-interconnects.d.ts +410 -0
- package/lib/services/network-interconnects.d.ts.map +1 -0
- package/lib/services/network-interconnects.js +583 -0
- package/lib/services/network-interconnects.js.map +1 -0
- package/lib/services/organizations.d.ts +232 -0
- package/lib/services/organizations.d.ts.map +1 -0
- package/lib/services/organizations.js +370 -0
- package/lib/services/organizations.js.map +1 -0
- package/lib/services/origin-ca-certificates.d.ts +119 -0
- package/lib/services/origin-ca-certificates.d.ts.map +1 -0
- package/lib/services/origin-ca-certificates.js +183 -0
- package/lib/services/origin-ca-certificates.js.map +1 -0
- package/lib/services/origin-post-quantum-encryption.d.ts +50 -0
- package/lib/services/origin-post-quantum-encryption.d.ts.map +1 -0
- package/lib/services/origin-post-quantum-encryption.js +64 -0
- package/lib/services/origin-post-quantum-encryption.js.map +1 -0
- package/lib/services/origin-tls-client-auth.d.ts +308 -0
- package/lib/services/origin-tls-client-auth.d.ts.map +1 -0
- package/lib/services/origin-tls-client-auth.js +435 -0
- package/lib/services/origin-tls-client-auth.js.map +1 -0
- package/lib/services/page-rules.d.ts +773 -0
- package/lib/services/page-rules.d.ts.map +1 -0
- package/lib/services/page-rules.js +1373 -0
- package/lib/services/page-rules.js.map +1 -0
- package/lib/services/page-shield.d.ts +505 -0
- package/lib/services/page-shield.d.ts.map +1 -0
- package/lib/services/page-shield.js +520 -0
- package/lib/services/page-shield.js.map +1 -0
- package/lib/services/pages.d.ts +1949 -0
- package/lib/services/pages.d.ts.map +1 -0
- package/lib/services/pages.js +3030 -0
- package/lib/services/pages.js.map +1 -0
- package/lib/services/pipelines.d.ts +1716 -0
- package/lib/services/pipelines.d.ts.map +1 -0
- package/lib/services/pipelines.js +2991 -0
- package/lib/services/pipelines.js.map +1 -0
- package/lib/services/queues.d.ts +904 -0
- package/lib/services/queues.d.ts.map +1 -0
- package/lib/services/queues.js +1250 -0
- package/lib/services/queues.js.map +1 -0
- package/lib/services/r2-data-catalog.d.ts +341 -0
- package/lib/services/r2-data-catalog.d.ts.map +1 -0
- package/lib/services/r2-data-catalog.js +513 -0
- package/lib/services/r2-data-catalog.js.map +1 -0
- package/lib/services/r2.d.ts +1087 -0
- package/lib/services/r2.d.ts.map +1 -0
- package/lib/services/r2.js +1404 -0
- package/lib/services/r2.js.map +1 -0
- package/lib/services/radar.d.ts +9365 -0
- package/lib/services/radar.d.ts.map +1 -0
- package/lib/services/radar.js +20552 -0
- package/lib/services/radar.js.map +1 -0
- package/lib/services/rate-limits.d.ts +360 -0
- package/lib/services/rate-limits.d.ts.map +1 -0
- package/lib/services/rate-limits.js +545 -0
- package/lib/services/rate-limits.js.map +1 -0
- package/lib/services/realtime-kit.d.ts +2728 -0
- package/lib/services/realtime-kit.d.ts.map +1 -0
- package/lib/services/realtime-kit.js +5402 -0
- package/lib/services/realtime-kit.js.map +1 -0
- package/lib/services/registrar.d.ts +121 -0
- package/lib/services/registrar.d.ts.map +1 -0
- package/lib/services/registrar.js +167 -0
- package/lib/services/registrar.js.map +1 -0
- package/lib/services/request-tracers.d.ts +61 -0
- package/lib/services/request-tracers.d.ts.map +1 -0
- package/lib/services/request-tracers.js +85 -0
- package/lib/services/request-tracers.js.map +1 -0
- package/lib/services/resource-sharing.d.ts +622 -0
- package/lib/services/resource-sharing.d.ts.map +1 -0
- package/lib/services/resource-sharing.js +929 -0
- package/lib/services/resource-sharing.js.map +1 -0
- package/lib/services/rules.d.ts +346 -0
- package/lib/services/rules.d.ts.map +1 -0
- package/lib/services/rules.js +431 -0
- package/lib/services/rules.js.map +1 -0
- package/lib/services/rulesets.d.ts +3345 -0
- package/lib/services/rulesets.d.ts.map +1 -0
- package/lib/services/rulesets.js +7904 -0
- package/lib/services/rulesets.js.map +1 -0
- package/lib/services/rum.d.ts +314 -0
- package/lib/services/rum.d.ts.map +1 -0
- package/lib/services/rum.js +442 -0
- package/lib/services/rum.js.map +1 -0
- package/lib/services/schema-validation.d.ts +273 -0
- package/lib/services/schema-validation.d.ts.map +1 -0
- package/lib/services/schema-validation.js +365 -0
- package/lib/services/schema-validation.js.map +1 -0
- package/lib/services/secrets-store.d.ts +393 -0
- package/lib/services/secrets-store.d.ts.map +1 -0
- package/lib/services/secrets-store.js +452 -0
- package/lib/services/secrets-store.js.map +1 -0
- package/lib/services/security-center.d.ts +136 -0
- package/lib/services/security-center.d.ts.map +1 -0
- package/lib/services/security-center.js +196 -0
- package/lib/services/security-center.js.map +1 -0
- package/lib/services/security-txt.d.ts +105 -0
- package/lib/services/security-txt.d.ts.map +1 -0
- package/lib/services/security-txt.js +136 -0
- package/lib/services/security-txt.js.map +1 -0
- package/lib/services/snippets.d.ts +190 -0
- package/lib/services/snippets.d.ts.map +1 -0
- package/lib/services/snippets.js +221 -0
- package/lib/services/snippets.js.map +1 -0
- package/lib/services/spectrum.d.ts +350 -0
- package/lib/services/spectrum.d.ts.map +1 -0
- package/lib/services/spectrum.js +535 -0
- package/lib/services/spectrum.js.map +1 -0
- package/lib/services/speed.d.ts +257 -0
- package/lib/services/speed.d.ts.map +1 -0
- package/lib/services/speed.js +471 -0
- package/lib/services/speed.js.map +1 -0
- package/lib/services/ssl.d.ts +412 -0
- package/lib/services/ssl.d.ts.map +1 -0
- package/lib/services/ssl.js +755 -0
- package/lib/services/ssl.js.map +1 -0
- package/lib/services/stream.d.ts +1110 -0
- package/lib/services/stream.d.ts.map +1 -0
- package/lib/services/stream.js +1085 -0
- package/lib/services/stream.js.map +1 -0
- package/lib/services/token-validation.d.ts +662 -0
- package/lib/services/token-validation.d.ts.map +1 -0
- package/lib/services/token-validation.js +834 -0
- package/lib/services/token-validation.js.map +1 -0
- package/lib/services/turnstile.d.ts +272 -0
- package/lib/services/turnstile.d.ts.map +1 -0
- package/lib/services/turnstile.js +339 -0
- package/lib/services/turnstile.js.map +1 -0
- package/lib/services/url-normalization.d.ts +53 -0
- package/lib/services/url-normalization.d.ts.map +1 -0
- package/lib/services/url-normalization.js +52 -0
- package/lib/services/url-normalization.js.map +1 -0
- package/lib/services/url-scanner.d.ts +612 -0
- package/lib/services/url-scanner.d.ts.map +1 -0
- package/lib/services/url-scanner.js +915 -0
- package/lib/services/url-scanner.js.map +1 -0
- package/lib/services/user.d.ts +507 -0
- package/lib/services/user.d.ts.map +1 -0
- package/lib/services/user.js +634 -0
- package/lib/services/user.js.map +1 -0
- package/lib/services/vectorize.d.ts +297 -0
- package/lib/services/vectorize.d.ts.map +1 -0
- package/lib/services/vectorize.js +351 -0
- package/lib/services/vectorize.js.map +1 -0
- package/lib/services/waiting-rooms.d.ts +1149 -0
- package/lib/services/waiting-rooms.d.ts.map +1 -0
- package/lib/services/waiting-rooms.js +1859 -0
- package/lib/services/waiting-rooms.js.map +1 -0
- package/lib/services/web3.d.ts +289 -0
- package/lib/services/web3.d.ts.map +1 -0
- package/lib/services/web3.js +381 -0
- package/lib/services/web3.js.map +1 -0
- package/lib/services/workers-for-platforms.d.ts +1394 -0
- package/lib/services/workers-for-platforms.d.ts.map +1 -0
- package/lib/services/workers-for-platforms.js +2121 -0
- package/lib/services/workers-for-platforms.js.map +1 -0
- package/lib/services/workers.d.ts +3827 -0
- package/lib/services/workers.d.ts.map +1 -0
- package/lib/services/workers.js +6105 -0
- package/lib/services/workers.js.map +1 -0
- package/lib/services/workflows.d.ts +442 -0
- package/lib/services/workflows.d.ts.map +1 -0
- package/lib/services/workflows.js +599 -0
- package/lib/services/workflows.js.map +1 -0
- package/lib/services/zaraz.d.ts +312 -0
- package/lib/services/zaraz.d.ts.map +1 -0
- package/lib/services/zaraz.js +305 -0
- package/lib/services/zaraz.js.map +1 -0
- package/lib/services/zero-trust.d.ts +18235 -0
- package/lib/services/zero-trust.d.ts.map +1 -0
- package/lib/services/zero-trust.js +30268 -0
- package/lib/services/zero-trust.js.map +1 -0
- package/lib/services/zones.d.ts +1382 -0
- package/lib/services/zones.d.ts.map +1 -0
- package/lib/services/zones.js +2477 -0
- package/lib/services/zones.js.map +1 -0
- package/lib/traits.d.ts +28 -0
- package/lib/traits.d.ts.map +1 -0
- package/lib/traits.js +26 -0
- package/lib/traits.js.map +1 -0
- package/package.json +82 -0
- package/src/auth.ts +15 -0
- package/src/category.ts +1 -0
- package/src/client/api.ts +421 -0
- package/src/client/index.ts +7 -0
- package/src/credentials.ts +271 -0
- package/src/errors.ts +73 -0
- package/src/index.ts +9 -0
- package/src/retry.ts +35 -0
- package/src/schemas.ts +51 -0
- package/src/sensitive.ts +4 -0
- package/src/services/abuse-reports.ts +955 -0
- package/src/services/accounts.ts +2152 -0
- package/src/services/acm.ts +178 -0
- package/src/services/addressing.ts +4262 -0
- package/src/services/ai-gateway.ts +3773 -0
- package/src/services/ai.ts +901 -0
- package/src/services/aisearch.ts +5215 -0
- package/src/services/alerting.ts +3303 -0
- package/src/services/api-gateway.ts +3890 -0
- package/src/services/argo.ts +270 -0
- package/src/services/audit-logs.ts +90 -0
- package/src/services/billing.ts +176 -0
- package/src/services/bot-management.ts +545 -0
- package/src/services/botnet-feed.ts +205 -0
- package/src/services/brand-protection.ts +575 -0
- package/src/services/browser-rendering.ts +2720 -0
- package/src/services/cache.ts +877 -0
- package/src/services/calls.ts +548 -0
- package/src/services/certificate-authorities.ts +114 -0
- package/src/services/client-certificates.ts +815 -0
- package/src/services/cloud-connector.ts +248 -0
- package/src/services/cloudforce-one.ts +4104 -0
- package/src/services/connectivity.ts +706 -0
- package/src/services/content-scanning.ts +458 -0
- package/src/services/custom-certificates.ts +690 -0
- package/src/services/custom-hostnames.ts +2641 -0
- package/src/services/custom-nameservers.ts +235 -0
- package/src/services/custom-pages.ts +311 -0
- package/src/services/d1.ts +1208 -0
- package/src/services/dcv-delegation.ts +54 -0
- package/src/services/diagnostics.ts +677 -0
- package/src/services/dns-firewall.ts +904 -0
- package/src/services/dns.ts +9277 -0
- package/src/services/durable-objects.ts +237 -0
- package/src/services/email-routing.ts +1796 -0
- package/src/services/email-security.ts +5052 -0
- package/src/services/filters.ts +488 -0
- package/src/services/firewall.ts +4728 -0
- package/src/services/healthchecks.ts +1866 -0
- package/src/services/hostnames.ts +254 -0
- package/src/services/hyperdrive.ts +595 -0
- package/src/services/iam.ts +1969 -0
- package/src/services/images.ts +1180 -0
- package/src/services/intel.ts +3072 -0
- package/src/services/ips.ts +88 -0
- package/src/services/keyless-certificates.ts +509 -0
- package/src/services/kv.ts +1129 -0
- package/src/services/leaked-credential-checks.ts +364 -0
- package/src/services/load-balancers.ts +6993 -0
- package/src/services/logpush.ts +1695 -0
- package/src/services/logs.ts +389 -0
- package/src/services/magic-cloud-networking.ts +10747 -0
- package/src/services/magic-network-monitoring.ts +1200 -0
- package/src/services/magic-transit.ts +13673 -0
- package/src/services/managed-transforms.ts +245 -0
- package/src/services/memberships.ts +698 -0
- package/src/services/mtls-certificates.ts +444 -0
- package/src/services/network-interconnects.ts +1253 -0
- package/src/services/organizations.ts +738 -0
- package/src/services/origin-ca-certificates.ts +369 -0
- package/src/services/origin-post-quantum-encryption.ts +136 -0
- package/src/services/origin-tls-client-auth.ts +1002 -0
- package/src/services/page-rules.ts +2632 -0
- package/src/services/page-shield.ts +1371 -0
- package/src/services/pages.ts +6167 -0
- package/src/services/pipelines.ts +6455 -0
- package/src/services/queues.ts +2827 -0
- package/src/services/r2-data-catalog.ts +1151 -0
- package/src/services/r2.ts +3529 -0
- package/src/services/radar.ts +42836 -0
- package/src/services/rate-limits.ts +1252 -0
- package/src/services/realtime-kit.ts +11080 -0
- package/src/services/registrar.ts +390 -0
- package/src/services/request-tracers.ts +161 -0
- package/src/services/resource-sharing.ts +2082 -0
- package/src/services/rules.ts +953 -0
- package/src/services/rulesets.ts +15361 -0
- package/src/services/rum.ts +994 -0
- package/src/services/schema-validation.ts +869 -0
- package/src/services/secrets-store.ts +1050 -0
- package/src/services/security-center.ts +495 -0
- package/src/services/security-txt.ts +317 -0
- package/src/services/snippets.ts +562 -0
- package/src/services/spectrum.ts +1190 -0
- package/src/services/speed.ts +1154 -0
- package/src/services/ssl.ts +1714 -0
- package/src/services/stream.ts +3008 -0
- package/src/services/token-validation.ts +1825 -0
- package/src/services/turnstile.ts +725 -0
- package/src/services/url-normalization.ts +133 -0
- package/src/services/url-scanner.ts +1851 -0
- package/src/services/user.ts +1587 -0
- package/src/services/vectorize.ts +875 -0
- package/src/services/waiting-rooms.ts +4216 -0
- package/src/services/web3.ts +899 -0
- package/src/services/workers-for-platforms.ts +4134 -0
- package/src/services/workers.ts +12298 -0
- package/src/services/workflows.ts +1372 -0
- package/src/services/zaraz.ts +833 -0
- package/src/services/zero-trust.ts +64685 -0
- package/src/services/zones.ts +5106 -0
- package/src/traits.ts +47 -0
|
@@ -0,0 +1,4216 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cloudflare WAITING-ROOMS API
|
|
3
|
+
*
|
|
4
|
+
* Generated from Cloudflare TypeScript SDK.
|
|
5
|
+
* DO NOT EDIT - regenerate with: bun scripts/generate.ts --service waiting-rooms
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import * as stream from "effect/Stream";
|
|
9
|
+
import * as Schema from "effect/Schema";
|
|
10
|
+
import type * as HttpClient from "effect/unstable/http/HttpClient";
|
|
11
|
+
import * as API from "../client/api.ts";
|
|
12
|
+
import * as T from "../traits.ts";
|
|
13
|
+
import type { Credentials } from "../credentials.ts";
|
|
14
|
+
import { type DefaultErrors } from "../errors.ts";
|
|
15
|
+
|
|
16
|
+
// =============================================================================
|
|
17
|
+
// Event
|
|
18
|
+
// =============================================================================
|
|
19
|
+
|
|
20
|
+
export interface GetEventRequest {
|
|
21
|
+
waitingRoomId: string;
|
|
22
|
+
eventId: string;
|
|
23
|
+
/** Identifier. */
|
|
24
|
+
zoneId: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export const GetEventRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
28
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
29
|
+
eventId: Schema.String.pipe(T.HttpPath("eventId")),
|
|
30
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
31
|
+
}).pipe(
|
|
32
|
+
T.Http({
|
|
33
|
+
method: "GET",
|
|
34
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events/{eventId}",
|
|
35
|
+
}),
|
|
36
|
+
) as unknown as Schema.Schema<GetEventRequest>;
|
|
37
|
+
|
|
38
|
+
export interface GetEventResponse {
|
|
39
|
+
id?: string | null;
|
|
40
|
+
createdOn?: string | null;
|
|
41
|
+
/** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
42
|
+
customPageHtml?: string | null;
|
|
43
|
+
/** A note that you can use to add more details about the event. */
|
|
44
|
+
description?: string | null;
|
|
45
|
+
/** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
46
|
+
disableSessionRenewal?: boolean | null;
|
|
47
|
+
/** An ISO 8601 timestamp that marks the end of the event. */
|
|
48
|
+
eventEndTime?: string | null;
|
|
49
|
+
/** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time` */
|
|
50
|
+
eventStartTime?: string | null;
|
|
51
|
+
modifiedOn?: string | null;
|
|
52
|
+
/** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
53
|
+
name?: string | null;
|
|
54
|
+
/** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` prop */
|
|
55
|
+
newUsersPerMinute?: number | null;
|
|
56
|
+
/** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
57
|
+
prequeueStartTime?: string | null;
|
|
58
|
+
/** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
59
|
+
queueingMethod?: string | null;
|
|
60
|
+
/** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
61
|
+
sessionDuration?: number | null;
|
|
62
|
+
/** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the even */
|
|
63
|
+
shuffleAtEventStart?: boolean | null;
|
|
64
|
+
/** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
65
|
+
suspended?: boolean | null;
|
|
66
|
+
/** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` prop */
|
|
67
|
+
totalActiveUsers?: number | null;
|
|
68
|
+
/** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
69
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
70
|
+
/** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
71
|
+
turnstileMode?:
|
|
72
|
+
| "off"
|
|
73
|
+
| "invisible"
|
|
74
|
+
| "visible_non_interactive"
|
|
75
|
+
| "visible_managed"
|
|
76
|
+
| null;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export const GetEventResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
80
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
81
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
82
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
83
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
84
|
+
disableSessionRenewal: Schema.optional(
|
|
85
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
86
|
+
),
|
|
87
|
+
eventEndTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
88
|
+
eventStartTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
89
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
90
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
91
|
+
newUsersPerMinute: Schema.optional(
|
|
92
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
93
|
+
),
|
|
94
|
+
prequeueStartTime: Schema.optional(
|
|
95
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
96
|
+
),
|
|
97
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
98
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
99
|
+
shuffleAtEventStart: Schema.optional(
|
|
100
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
101
|
+
),
|
|
102
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
103
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
104
|
+
turnstileAction: Schema.optional(
|
|
105
|
+
Schema.Union([
|
|
106
|
+
Schema.Literal("log"),
|
|
107
|
+
Schema.Literal("infinite_queue"),
|
|
108
|
+
Schema.Null,
|
|
109
|
+
]),
|
|
110
|
+
),
|
|
111
|
+
turnstileMode: Schema.optional(
|
|
112
|
+
Schema.Union([
|
|
113
|
+
Schema.Literal("off"),
|
|
114
|
+
Schema.Literal("invisible"),
|
|
115
|
+
Schema.Literal("visible_non_interactive"),
|
|
116
|
+
Schema.Literal("visible_managed"),
|
|
117
|
+
Schema.Null,
|
|
118
|
+
]),
|
|
119
|
+
),
|
|
120
|
+
})
|
|
121
|
+
.pipe(
|
|
122
|
+
Schema.encodeKeys({
|
|
123
|
+
id: "id",
|
|
124
|
+
createdOn: "created_on",
|
|
125
|
+
customPageHtml: "custom_page_html",
|
|
126
|
+
description: "description",
|
|
127
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
128
|
+
eventEndTime: "event_end_time",
|
|
129
|
+
eventStartTime: "event_start_time",
|
|
130
|
+
modifiedOn: "modified_on",
|
|
131
|
+
name: "name",
|
|
132
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
133
|
+
prequeueStartTime: "prequeue_start_time",
|
|
134
|
+
queueingMethod: "queueing_method",
|
|
135
|
+
sessionDuration: "session_duration",
|
|
136
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
137
|
+
suspended: "suspended",
|
|
138
|
+
totalActiveUsers: "total_active_users",
|
|
139
|
+
turnstileAction: "turnstile_action",
|
|
140
|
+
turnstileMode: "turnstile_mode",
|
|
141
|
+
}),
|
|
142
|
+
)
|
|
143
|
+
.pipe(T.ResponsePath("result")) as unknown as Schema.Schema<GetEventResponse>;
|
|
144
|
+
|
|
145
|
+
export type GetEventError = DefaultErrors;
|
|
146
|
+
|
|
147
|
+
export const getEvent: API.OperationMethod<
|
|
148
|
+
GetEventRequest,
|
|
149
|
+
GetEventResponse,
|
|
150
|
+
GetEventError,
|
|
151
|
+
Credentials | HttpClient.HttpClient
|
|
152
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
153
|
+
input: GetEventRequest,
|
|
154
|
+
output: GetEventResponse,
|
|
155
|
+
errors: [],
|
|
156
|
+
}));
|
|
157
|
+
|
|
158
|
+
export interface ListEventsRequest {
|
|
159
|
+
waitingRoomId: string;
|
|
160
|
+
/** Path param: Identifier. */
|
|
161
|
+
zoneId: string;
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
export const ListEventsRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
165
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
166
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
167
|
+
}).pipe(
|
|
168
|
+
T.Http({
|
|
169
|
+
method: "GET",
|
|
170
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events",
|
|
171
|
+
}),
|
|
172
|
+
) as unknown as Schema.Schema<ListEventsRequest>;
|
|
173
|
+
|
|
174
|
+
export interface ListEventsResponse {
|
|
175
|
+
result: {
|
|
176
|
+
id?: string | null;
|
|
177
|
+
createdOn?: string | null;
|
|
178
|
+
customPageHtml?: string | null;
|
|
179
|
+
description?: string | null;
|
|
180
|
+
disableSessionRenewal?: boolean | null;
|
|
181
|
+
eventEndTime?: string | null;
|
|
182
|
+
eventStartTime?: string | null;
|
|
183
|
+
modifiedOn?: string | null;
|
|
184
|
+
name?: string | null;
|
|
185
|
+
newUsersPerMinute?: number | null;
|
|
186
|
+
prequeueStartTime?: string | null;
|
|
187
|
+
queueingMethod?: string | null;
|
|
188
|
+
sessionDuration?: number | null;
|
|
189
|
+
shuffleAtEventStart?: boolean | null;
|
|
190
|
+
suspended?: boolean | null;
|
|
191
|
+
totalActiveUsers?: number | null;
|
|
192
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
193
|
+
turnstileMode?:
|
|
194
|
+
| "off"
|
|
195
|
+
| "invisible"
|
|
196
|
+
| "visible_non_interactive"
|
|
197
|
+
| "visible_managed"
|
|
198
|
+
| null;
|
|
199
|
+
}[];
|
|
200
|
+
resultInfo: {
|
|
201
|
+
count?: number | null;
|
|
202
|
+
page?: number | null;
|
|
203
|
+
perPage?: number | null;
|
|
204
|
+
totalCount?: number | null;
|
|
205
|
+
};
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
export const ListEventsResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
209
|
+
result: Schema.Array(
|
|
210
|
+
Schema.Struct({
|
|
211
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
212
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
213
|
+
customPageHtml: Schema.optional(
|
|
214
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
215
|
+
),
|
|
216
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
217
|
+
disableSessionRenewal: Schema.optional(
|
|
218
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
219
|
+
),
|
|
220
|
+
eventEndTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
221
|
+
eventStartTime: Schema.optional(
|
|
222
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
223
|
+
),
|
|
224
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
225
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
226
|
+
newUsersPerMinute: Schema.optional(
|
|
227
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
228
|
+
),
|
|
229
|
+
prequeueStartTime: Schema.optional(
|
|
230
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
231
|
+
),
|
|
232
|
+
queueingMethod: Schema.optional(
|
|
233
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
234
|
+
),
|
|
235
|
+
sessionDuration: Schema.optional(
|
|
236
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
237
|
+
),
|
|
238
|
+
shuffleAtEventStart: Schema.optional(
|
|
239
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
240
|
+
),
|
|
241
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
242
|
+
totalActiveUsers: Schema.optional(
|
|
243
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
244
|
+
),
|
|
245
|
+
turnstileAction: Schema.optional(
|
|
246
|
+
Schema.Union([
|
|
247
|
+
Schema.Literal("log"),
|
|
248
|
+
Schema.Literal("infinite_queue"),
|
|
249
|
+
Schema.Null,
|
|
250
|
+
]),
|
|
251
|
+
),
|
|
252
|
+
turnstileMode: Schema.optional(
|
|
253
|
+
Schema.Union([
|
|
254
|
+
Schema.Literal("off"),
|
|
255
|
+
Schema.Literal("invisible"),
|
|
256
|
+
Schema.Literal("visible_non_interactive"),
|
|
257
|
+
Schema.Literal("visible_managed"),
|
|
258
|
+
Schema.Null,
|
|
259
|
+
]),
|
|
260
|
+
),
|
|
261
|
+
}).pipe(
|
|
262
|
+
Schema.encodeKeys({
|
|
263
|
+
id: "id",
|
|
264
|
+
createdOn: "created_on",
|
|
265
|
+
customPageHtml: "custom_page_html",
|
|
266
|
+
description: "description",
|
|
267
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
268
|
+
eventEndTime: "event_end_time",
|
|
269
|
+
eventStartTime: "event_start_time",
|
|
270
|
+
modifiedOn: "modified_on",
|
|
271
|
+
name: "name",
|
|
272
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
273
|
+
prequeueStartTime: "prequeue_start_time",
|
|
274
|
+
queueingMethod: "queueing_method",
|
|
275
|
+
sessionDuration: "session_duration",
|
|
276
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
277
|
+
suspended: "suspended",
|
|
278
|
+
totalActiveUsers: "total_active_users",
|
|
279
|
+
turnstileAction: "turnstile_action",
|
|
280
|
+
turnstileMode: "turnstile_mode",
|
|
281
|
+
}),
|
|
282
|
+
),
|
|
283
|
+
),
|
|
284
|
+
resultInfo: Schema.Struct({
|
|
285
|
+
count: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
286
|
+
page: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
287
|
+
perPage: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
288
|
+
totalCount: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
289
|
+
}).pipe(
|
|
290
|
+
Schema.encodeKeys({
|
|
291
|
+
count: "count",
|
|
292
|
+
page: "page",
|
|
293
|
+
perPage: "per_page",
|
|
294
|
+
totalCount: "total_count",
|
|
295
|
+
}),
|
|
296
|
+
),
|
|
297
|
+
}).pipe(
|
|
298
|
+
Schema.encodeKeys({ result: "result", resultInfo: "result_info" }),
|
|
299
|
+
) as unknown as Schema.Schema<ListEventsResponse>;
|
|
300
|
+
|
|
301
|
+
export type ListEventsError = DefaultErrors;
|
|
302
|
+
|
|
303
|
+
export const listEvents: API.PaginatedOperationMethod<
|
|
304
|
+
ListEventsRequest,
|
|
305
|
+
ListEventsResponse,
|
|
306
|
+
ListEventsError,
|
|
307
|
+
Credentials | HttpClient.HttpClient
|
|
308
|
+
> & {
|
|
309
|
+
pages: (
|
|
310
|
+
input: ListEventsRequest,
|
|
311
|
+
) => stream.Stream<
|
|
312
|
+
ListEventsResponse,
|
|
313
|
+
ListEventsError,
|
|
314
|
+
Credentials | HttpClient.HttpClient
|
|
315
|
+
>;
|
|
316
|
+
items: (input: ListEventsRequest) => stream.Stream<
|
|
317
|
+
{
|
|
318
|
+
id?: string | null;
|
|
319
|
+
createdOn?: string | null;
|
|
320
|
+
customPageHtml?: string | null;
|
|
321
|
+
description?: string | null;
|
|
322
|
+
disableSessionRenewal?: boolean | null;
|
|
323
|
+
eventEndTime?: string | null;
|
|
324
|
+
eventStartTime?: string | null;
|
|
325
|
+
modifiedOn?: string | null;
|
|
326
|
+
name?: string | null;
|
|
327
|
+
newUsersPerMinute?: number | null;
|
|
328
|
+
prequeueStartTime?: string | null;
|
|
329
|
+
queueingMethod?: string | null;
|
|
330
|
+
sessionDuration?: number | null;
|
|
331
|
+
shuffleAtEventStart?: boolean | null;
|
|
332
|
+
suspended?: boolean | null;
|
|
333
|
+
totalActiveUsers?: number | null;
|
|
334
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
335
|
+
turnstileMode?:
|
|
336
|
+
| "off"
|
|
337
|
+
| "invisible"
|
|
338
|
+
| "visible_non_interactive"
|
|
339
|
+
| "visible_managed"
|
|
340
|
+
| null;
|
|
341
|
+
},
|
|
342
|
+
ListEventsError,
|
|
343
|
+
Credentials | HttpClient.HttpClient
|
|
344
|
+
>;
|
|
345
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
346
|
+
input: ListEventsRequest,
|
|
347
|
+
output: ListEventsResponse,
|
|
348
|
+
errors: [],
|
|
349
|
+
pagination: {
|
|
350
|
+
mode: "page",
|
|
351
|
+
inputToken: "page",
|
|
352
|
+
outputToken: "resultInfo.page",
|
|
353
|
+
items: "result",
|
|
354
|
+
pageSize: "perPage",
|
|
355
|
+
} as const,
|
|
356
|
+
}));
|
|
357
|
+
|
|
358
|
+
export interface CreateEventRequest {
|
|
359
|
+
waitingRoomId: string;
|
|
360
|
+
/** Path param: Identifier. */
|
|
361
|
+
zoneId: string;
|
|
362
|
+
/** Body param: An ISO 8601 timestamp that marks the end of the event. */
|
|
363
|
+
eventEndTime: string;
|
|
364
|
+
/** Body param: An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `eve */
|
|
365
|
+
eventStartTime: string;
|
|
366
|
+
/** Body param: A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
367
|
+
name: string;
|
|
368
|
+
/** Body param: If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
369
|
+
customPageHtml?: string | null;
|
|
370
|
+
/** Body param: A note that you can use to add more details about the event. */
|
|
371
|
+
description?: string;
|
|
372
|
+
/** Body param: If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
373
|
+
disableSessionRenewal?: boolean | null;
|
|
374
|
+
/** Body param: If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active */
|
|
375
|
+
newUsersPerMinute?: number | null;
|
|
376
|
+
/** Body param: An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
377
|
+
prequeueStartTime?: string | null;
|
|
378
|
+
/** Body param: If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
379
|
+
queueingMethod?: string | null;
|
|
380
|
+
/** Body param: If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
381
|
+
sessionDuration?: number | null;
|
|
382
|
+
/** Body param: If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will j */
|
|
383
|
+
shuffleAtEventStart?: boolean;
|
|
384
|
+
/** Body param: Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
385
|
+
suspended?: boolean;
|
|
386
|
+
/** Body param: If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_ */
|
|
387
|
+
totalActiveUsers?: number | null;
|
|
388
|
+
/** Body param: If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
389
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
390
|
+
/** Body param: If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
391
|
+
turnstileMode?:
|
|
392
|
+
| "off"
|
|
393
|
+
| "invisible"
|
|
394
|
+
| "visible_non_interactive"
|
|
395
|
+
| "visible_managed"
|
|
396
|
+
| null;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
export const CreateEventRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
400
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
401
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
402
|
+
eventEndTime: Schema.String,
|
|
403
|
+
eventStartTime: Schema.String,
|
|
404
|
+
name: Schema.String,
|
|
405
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
406
|
+
description: Schema.optional(Schema.String),
|
|
407
|
+
disableSessionRenewal: Schema.optional(
|
|
408
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
409
|
+
),
|
|
410
|
+
newUsersPerMinute: Schema.optional(
|
|
411
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
412
|
+
),
|
|
413
|
+
prequeueStartTime: Schema.optional(
|
|
414
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
415
|
+
),
|
|
416
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
417
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
418
|
+
shuffleAtEventStart: Schema.optional(Schema.Boolean),
|
|
419
|
+
suspended: Schema.optional(Schema.Boolean),
|
|
420
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
421
|
+
turnstileAction: Schema.optional(
|
|
422
|
+
Schema.Union([
|
|
423
|
+
Schema.Literal("log"),
|
|
424
|
+
Schema.Literal("infinite_queue"),
|
|
425
|
+
Schema.Null,
|
|
426
|
+
]),
|
|
427
|
+
),
|
|
428
|
+
turnstileMode: Schema.optional(
|
|
429
|
+
Schema.Union([
|
|
430
|
+
Schema.Literal("off"),
|
|
431
|
+
Schema.Literal("invisible"),
|
|
432
|
+
Schema.Literal("visible_non_interactive"),
|
|
433
|
+
Schema.Literal("visible_managed"),
|
|
434
|
+
Schema.Null,
|
|
435
|
+
]),
|
|
436
|
+
),
|
|
437
|
+
}).pipe(
|
|
438
|
+
Schema.encodeKeys({
|
|
439
|
+
eventEndTime: "event_end_time",
|
|
440
|
+
eventStartTime: "event_start_time",
|
|
441
|
+
name: "name",
|
|
442
|
+
customPageHtml: "custom_page_html",
|
|
443
|
+
description: "description",
|
|
444
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
445
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
446
|
+
prequeueStartTime: "prequeue_start_time",
|
|
447
|
+
queueingMethod: "queueing_method",
|
|
448
|
+
sessionDuration: "session_duration",
|
|
449
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
450
|
+
suspended: "suspended",
|
|
451
|
+
totalActiveUsers: "total_active_users",
|
|
452
|
+
turnstileAction: "turnstile_action",
|
|
453
|
+
turnstileMode: "turnstile_mode",
|
|
454
|
+
}),
|
|
455
|
+
T.Http({
|
|
456
|
+
method: "POST",
|
|
457
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events",
|
|
458
|
+
}),
|
|
459
|
+
) as unknown as Schema.Schema<CreateEventRequest>;
|
|
460
|
+
|
|
461
|
+
export interface CreateEventResponse {
|
|
462
|
+
id?: string | null;
|
|
463
|
+
createdOn?: string | null;
|
|
464
|
+
/** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
465
|
+
customPageHtml?: string | null;
|
|
466
|
+
/** A note that you can use to add more details about the event. */
|
|
467
|
+
description?: string | null;
|
|
468
|
+
/** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
469
|
+
disableSessionRenewal?: boolean | null;
|
|
470
|
+
/** An ISO 8601 timestamp that marks the end of the event. */
|
|
471
|
+
eventEndTime?: string | null;
|
|
472
|
+
/** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time` */
|
|
473
|
+
eventStartTime?: string | null;
|
|
474
|
+
modifiedOn?: string | null;
|
|
475
|
+
/** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
476
|
+
name?: string | null;
|
|
477
|
+
/** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` prop */
|
|
478
|
+
newUsersPerMinute?: number | null;
|
|
479
|
+
/** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
480
|
+
prequeueStartTime?: string | null;
|
|
481
|
+
/** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
482
|
+
queueingMethod?: string | null;
|
|
483
|
+
/** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
484
|
+
sessionDuration?: number | null;
|
|
485
|
+
/** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the even */
|
|
486
|
+
shuffleAtEventStart?: boolean | null;
|
|
487
|
+
/** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
488
|
+
suspended?: boolean | null;
|
|
489
|
+
/** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` prop */
|
|
490
|
+
totalActiveUsers?: number | null;
|
|
491
|
+
/** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
492
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
493
|
+
/** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
494
|
+
turnstileMode?:
|
|
495
|
+
| "off"
|
|
496
|
+
| "invisible"
|
|
497
|
+
| "visible_non_interactive"
|
|
498
|
+
| "visible_managed"
|
|
499
|
+
| null;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
export const CreateEventResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
503
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
504
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
505
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
506
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
507
|
+
disableSessionRenewal: Schema.optional(
|
|
508
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
509
|
+
),
|
|
510
|
+
eventEndTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
511
|
+
eventStartTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
512
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
513
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
514
|
+
newUsersPerMinute: Schema.optional(
|
|
515
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
516
|
+
),
|
|
517
|
+
prequeueStartTime: Schema.optional(
|
|
518
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
519
|
+
),
|
|
520
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
521
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
522
|
+
shuffleAtEventStart: Schema.optional(
|
|
523
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
524
|
+
),
|
|
525
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
526
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
527
|
+
turnstileAction: Schema.optional(
|
|
528
|
+
Schema.Union([
|
|
529
|
+
Schema.Literal("log"),
|
|
530
|
+
Schema.Literal("infinite_queue"),
|
|
531
|
+
Schema.Null,
|
|
532
|
+
]),
|
|
533
|
+
),
|
|
534
|
+
turnstileMode: Schema.optional(
|
|
535
|
+
Schema.Union([
|
|
536
|
+
Schema.Literal("off"),
|
|
537
|
+
Schema.Literal("invisible"),
|
|
538
|
+
Schema.Literal("visible_non_interactive"),
|
|
539
|
+
Schema.Literal("visible_managed"),
|
|
540
|
+
Schema.Null,
|
|
541
|
+
]),
|
|
542
|
+
),
|
|
543
|
+
})
|
|
544
|
+
.pipe(
|
|
545
|
+
Schema.encodeKeys({
|
|
546
|
+
id: "id",
|
|
547
|
+
createdOn: "created_on",
|
|
548
|
+
customPageHtml: "custom_page_html",
|
|
549
|
+
description: "description",
|
|
550
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
551
|
+
eventEndTime: "event_end_time",
|
|
552
|
+
eventStartTime: "event_start_time",
|
|
553
|
+
modifiedOn: "modified_on",
|
|
554
|
+
name: "name",
|
|
555
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
556
|
+
prequeueStartTime: "prequeue_start_time",
|
|
557
|
+
queueingMethod: "queueing_method",
|
|
558
|
+
sessionDuration: "session_duration",
|
|
559
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
560
|
+
suspended: "suspended",
|
|
561
|
+
totalActiveUsers: "total_active_users",
|
|
562
|
+
turnstileAction: "turnstile_action",
|
|
563
|
+
turnstileMode: "turnstile_mode",
|
|
564
|
+
}),
|
|
565
|
+
)
|
|
566
|
+
.pipe(
|
|
567
|
+
T.ResponsePath("result"),
|
|
568
|
+
) as unknown as Schema.Schema<CreateEventResponse>;
|
|
569
|
+
|
|
570
|
+
export type CreateEventError = DefaultErrors;
|
|
571
|
+
|
|
572
|
+
export const createEvent: API.OperationMethod<
|
|
573
|
+
CreateEventRequest,
|
|
574
|
+
CreateEventResponse,
|
|
575
|
+
CreateEventError,
|
|
576
|
+
Credentials | HttpClient.HttpClient
|
|
577
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
578
|
+
input: CreateEventRequest,
|
|
579
|
+
output: CreateEventResponse,
|
|
580
|
+
errors: [],
|
|
581
|
+
}));
|
|
582
|
+
|
|
583
|
+
export interface UpdateEventRequest {
|
|
584
|
+
waitingRoomId: string;
|
|
585
|
+
eventId: string;
|
|
586
|
+
/** Path param: Identifier. */
|
|
587
|
+
zoneId: string;
|
|
588
|
+
/** Body param: An ISO 8601 timestamp that marks the end of the event. */
|
|
589
|
+
eventEndTime: string;
|
|
590
|
+
/** Body param: An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `eve */
|
|
591
|
+
eventStartTime: string;
|
|
592
|
+
/** Body param: A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
593
|
+
name: string;
|
|
594
|
+
/** Body param: If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
595
|
+
customPageHtml?: string | null;
|
|
596
|
+
/** Body param: A note that you can use to add more details about the event. */
|
|
597
|
+
description?: string;
|
|
598
|
+
/** Body param: If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
599
|
+
disableSessionRenewal?: boolean | null;
|
|
600
|
+
/** Body param: If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active */
|
|
601
|
+
newUsersPerMinute?: number | null;
|
|
602
|
+
/** Body param: An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
603
|
+
prequeueStartTime?: string | null;
|
|
604
|
+
/** Body param: If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
605
|
+
queueingMethod?: string | null;
|
|
606
|
+
/** Body param: If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
607
|
+
sessionDuration?: number | null;
|
|
608
|
+
/** Body param: If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will j */
|
|
609
|
+
shuffleAtEventStart?: boolean;
|
|
610
|
+
/** Body param: Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
611
|
+
suspended?: boolean;
|
|
612
|
+
/** Body param: If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_ */
|
|
613
|
+
totalActiveUsers?: number | null;
|
|
614
|
+
/** Body param: If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
615
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
616
|
+
/** Body param: If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
617
|
+
turnstileMode?:
|
|
618
|
+
| "off"
|
|
619
|
+
| "invisible"
|
|
620
|
+
| "visible_non_interactive"
|
|
621
|
+
| "visible_managed"
|
|
622
|
+
| null;
|
|
623
|
+
}
|
|
624
|
+
|
|
625
|
+
export const UpdateEventRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
626
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
627
|
+
eventId: Schema.String.pipe(T.HttpPath("eventId")),
|
|
628
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
629
|
+
eventEndTime: Schema.String,
|
|
630
|
+
eventStartTime: Schema.String,
|
|
631
|
+
name: Schema.String,
|
|
632
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
633
|
+
description: Schema.optional(Schema.String),
|
|
634
|
+
disableSessionRenewal: Schema.optional(
|
|
635
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
636
|
+
),
|
|
637
|
+
newUsersPerMinute: Schema.optional(
|
|
638
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
639
|
+
),
|
|
640
|
+
prequeueStartTime: Schema.optional(
|
|
641
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
642
|
+
),
|
|
643
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
644
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
645
|
+
shuffleAtEventStart: Schema.optional(Schema.Boolean),
|
|
646
|
+
suspended: Schema.optional(Schema.Boolean),
|
|
647
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
648
|
+
turnstileAction: Schema.optional(
|
|
649
|
+
Schema.Union([
|
|
650
|
+
Schema.Literal("log"),
|
|
651
|
+
Schema.Literal("infinite_queue"),
|
|
652
|
+
Schema.Null,
|
|
653
|
+
]),
|
|
654
|
+
),
|
|
655
|
+
turnstileMode: Schema.optional(
|
|
656
|
+
Schema.Union([
|
|
657
|
+
Schema.Literal("off"),
|
|
658
|
+
Schema.Literal("invisible"),
|
|
659
|
+
Schema.Literal("visible_non_interactive"),
|
|
660
|
+
Schema.Literal("visible_managed"),
|
|
661
|
+
Schema.Null,
|
|
662
|
+
]),
|
|
663
|
+
),
|
|
664
|
+
}).pipe(
|
|
665
|
+
Schema.encodeKeys({
|
|
666
|
+
eventEndTime: "event_end_time",
|
|
667
|
+
eventStartTime: "event_start_time",
|
|
668
|
+
name: "name",
|
|
669
|
+
customPageHtml: "custom_page_html",
|
|
670
|
+
description: "description",
|
|
671
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
672
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
673
|
+
prequeueStartTime: "prequeue_start_time",
|
|
674
|
+
queueingMethod: "queueing_method",
|
|
675
|
+
sessionDuration: "session_duration",
|
|
676
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
677
|
+
suspended: "suspended",
|
|
678
|
+
totalActiveUsers: "total_active_users",
|
|
679
|
+
turnstileAction: "turnstile_action",
|
|
680
|
+
turnstileMode: "turnstile_mode",
|
|
681
|
+
}),
|
|
682
|
+
T.Http({
|
|
683
|
+
method: "PUT",
|
|
684
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events/{eventId}",
|
|
685
|
+
}),
|
|
686
|
+
) as unknown as Schema.Schema<UpdateEventRequest>;
|
|
687
|
+
|
|
688
|
+
export interface UpdateEventResponse {
|
|
689
|
+
id?: string | null;
|
|
690
|
+
createdOn?: string | null;
|
|
691
|
+
/** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
692
|
+
customPageHtml?: string | null;
|
|
693
|
+
/** A note that you can use to add more details about the event. */
|
|
694
|
+
description?: string | null;
|
|
695
|
+
/** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
696
|
+
disableSessionRenewal?: boolean | null;
|
|
697
|
+
/** An ISO 8601 timestamp that marks the end of the event. */
|
|
698
|
+
eventEndTime?: string | null;
|
|
699
|
+
/** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time` */
|
|
700
|
+
eventStartTime?: string | null;
|
|
701
|
+
modifiedOn?: string | null;
|
|
702
|
+
/** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
703
|
+
name?: string | null;
|
|
704
|
+
/** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` prop */
|
|
705
|
+
newUsersPerMinute?: number | null;
|
|
706
|
+
/** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
707
|
+
prequeueStartTime?: string | null;
|
|
708
|
+
/** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
709
|
+
queueingMethod?: string | null;
|
|
710
|
+
/** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
711
|
+
sessionDuration?: number | null;
|
|
712
|
+
/** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the even */
|
|
713
|
+
shuffleAtEventStart?: boolean | null;
|
|
714
|
+
/** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
715
|
+
suspended?: boolean | null;
|
|
716
|
+
/** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` prop */
|
|
717
|
+
totalActiveUsers?: number | null;
|
|
718
|
+
/** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
719
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
720
|
+
/** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
721
|
+
turnstileMode?:
|
|
722
|
+
| "off"
|
|
723
|
+
| "invisible"
|
|
724
|
+
| "visible_non_interactive"
|
|
725
|
+
| "visible_managed"
|
|
726
|
+
| null;
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
export const UpdateEventResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
730
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
731
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
732
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
733
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
734
|
+
disableSessionRenewal: Schema.optional(
|
|
735
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
736
|
+
),
|
|
737
|
+
eventEndTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
738
|
+
eventStartTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
739
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
740
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
741
|
+
newUsersPerMinute: Schema.optional(
|
|
742
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
743
|
+
),
|
|
744
|
+
prequeueStartTime: Schema.optional(
|
|
745
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
746
|
+
),
|
|
747
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
748
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
749
|
+
shuffleAtEventStart: Schema.optional(
|
|
750
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
751
|
+
),
|
|
752
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
753
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
754
|
+
turnstileAction: Schema.optional(
|
|
755
|
+
Schema.Union([
|
|
756
|
+
Schema.Literal("log"),
|
|
757
|
+
Schema.Literal("infinite_queue"),
|
|
758
|
+
Schema.Null,
|
|
759
|
+
]),
|
|
760
|
+
),
|
|
761
|
+
turnstileMode: Schema.optional(
|
|
762
|
+
Schema.Union([
|
|
763
|
+
Schema.Literal("off"),
|
|
764
|
+
Schema.Literal("invisible"),
|
|
765
|
+
Schema.Literal("visible_non_interactive"),
|
|
766
|
+
Schema.Literal("visible_managed"),
|
|
767
|
+
Schema.Null,
|
|
768
|
+
]),
|
|
769
|
+
),
|
|
770
|
+
})
|
|
771
|
+
.pipe(
|
|
772
|
+
Schema.encodeKeys({
|
|
773
|
+
id: "id",
|
|
774
|
+
createdOn: "created_on",
|
|
775
|
+
customPageHtml: "custom_page_html",
|
|
776
|
+
description: "description",
|
|
777
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
778
|
+
eventEndTime: "event_end_time",
|
|
779
|
+
eventStartTime: "event_start_time",
|
|
780
|
+
modifiedOn: "modified_on",
|
|
781
|
+
name: "name",
|
|
782
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
783
|
+
prequeueStartTime: "prequeue_start_time",
|
|
784
|
+
queueingMethod: "queueing_method",
|
|
785
|
+
sessionDuration: "session_duration",
|
|
786
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
787
|
+
suspended: "suspended",
|
|
788
|
+
totalActiveUsers: "total_active_users",
|
|
789
|
+
turnstileAction: "turnstile_action",
|
|
790
|
+
turnstileMode: "turnstile_mode",
|
|
791
|
+
}),
|
|
792
|
+
)
|
|
793
|
+
.pipe(
|
|
794
|
+
T.ResponsePath("result"),
|
|
795
|
+
) as unknown as Schema.Schema<UpdateEventResponse>;
|
|
796
|
+
|
|
797
|
+
export type UpdateEventError = DefaultErrors;
|
|
798
|
+
|
|
799
|
+
export const updateEvent: API.OperationMethod<
|
|
800
|
+
UpdateEventRequest,
|
|
801
|
+
UpdateEventResponse,
|
|
802
|
+
UpdateEventError,
|
|
803
|
+
Credentials | HttpClient.HttpClient
|
|
804
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
805
|
+
input: UpdateEventRequest,
|
|
806
|
+
output: UpdateEventResponse,
|
|
807
|
+
errors: [],
|
|
808
|
+
}));
|
|
809
|
+
|
|
810
|
+
export interface PatchEventRequest {
|
|
811
|
+
waitingRoomId: string;
|
|
812
|
+
eventId: string;
|
|
813
|
+
/** Path param: Identifier. */
|
|
814
|
+
zoneId: string;
|
|
815
|
+
/** Body param: An ISO 8601 timestamp that marks the end of the event. */
|
|
816
|
+
eventEndTime: string;
|
|
817
|
+
/** Body param: An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `eve */
|
|
818
|
+
eventStartTime: string;
|
|
819
|
+
/** Body param: A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
820
|
+
name: string;
|
|
821
|
+
/** Body param: If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
822
|
+
customPageHtml?: string | null;
|
|
823
|
+
/** Body param: A note that you can use to add more details about the event. */
|
|
824
|
+
description?: string;
|
|
825
|
+
/** Body param: If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
826
|
+
disableSessionRenewal?: boolean | null;
|
|
827
|
+
/** Body param: If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active */
|
|
828
|
+
newUsersPerMinute?: number | null;
|
|
829
|
+
/** Body param: An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
830
|
+
prequeueStartTime?: string | null;
|
|
831
|
+
/** Body param: If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
832
|
+
queueingMethod?: string | null;
|
|
833
|
+
/** Body param: If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
834
|
+
sessionDuration?: number | null;
|
|
835
|
+
/** Body param: If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will j */
|
|
836
|
+
shuffleAtEventStart?: boolean;
|
|
837
|
+
/** Body param: Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
838
|
+
suspended?: boolean;
|
|
839
|
+
/** Body param: If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_ */
|
|
840
|
+
totalActiveUsers?: number | null;
|
|
841
|
+
/** Body param: If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
842
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
843
|
+
/** Body param: If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
844
|
+
turnstileMode?:
|
|
845
|
+
| "off"
|
|
846
|
+
| "invisible"
|
|
847
|
+
| "visible_non_interactive"
|
|
848
|
+
| "visible_managed"
|
|
849
|
+
| null;
|
|
850
|
+
}
|
|
851
|
+
|
|
852
|
+
export const PatchEventRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
853
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
854
|
+
eventId: Schema.String.pipe(T.HttpPath("eventId")),
|
|
855
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
856
|
+
eventEndTime: Schema.String,
|
|
857
|
+
eventStartTime: Schema.String,
|
|
858
|
+
name: Schema.String,
|
|
859
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
860
|
+
description: Schema.optional(Schema.String),
|
|
861
|
+
disableSessionRenewal: Schema.optional(
|
|
862
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
863
|
+
),
|
|
864
|
+
newUsersPerMinute: Schema.optional(
|
|
865
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
866
|
+
),
|
|
867
|
+
prequeueStartTime: Schema.optional(
|
|
868
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
869
|
+
),
|
|
870
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
871
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
872
|
+
shuffleAtEventStart: Schema.optional(Schema.Boolean),
|
|
873
|
+
suspended: Schema.optional(Schema.Boolean),
|
|
874
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
875
|
+
turnstileAction: Schema.optional(
|
|
876
|
+
Schema.Union([
|
|
877
|
+
Schema.Literal("log"),
|
|
878
|
+
Schema.Literal("infinite_queue"),
|
|
879
|
+
Schema.Null,
|
|
880
|
+
]),
|
|
881
|
+
),
|
|
882
|
+
turnstileMode: Schema.optional(
|
|
883
|
+
Schema.Union([
|
|
884
|
+
Schema.Literal("off"),
|
|
885
|
+
Schema.Literal("invisible"),
|
|
886
|
+
Schema.Literal("visible_non_interactive"),
|
|
887
|
+
Schema.Literal("visible_managed"),
|
|
888
|
+
Schema.Null,
|
|
889
|
+
]),
|
|
890
|
+
),
|
|
891
|
+
}).pipe(
|
|
892
|
+
Schema.encodeKeys({
|
|
893
|
+
eventEndTime: "event_end_time",
|
|
894
|
+
eventStartTime: "event_start_time",
|
|
895
|
+
name: "name",
|
|
896
|
+
customPageHtml: "custom_page_html",
|
|
897
|
+
description: "description",
|
|
898
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
899
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
900
|
+
prequeueStartTime: "prequeue_start_time",
|
|
901
|
+
queueingMethod: "queueing_method",
|
|
902
|
+
sessionDuration: "session_duration",
|
|
903
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
904
|
+
suspended: "suspended",
|
|
905
|
+
totalActiveUsers: "total_active_users",
|
|
906
|
+
turnstileAction: "turnstile_action",
|
|
907
|
+
turnstileMode: "turnstile_mode",
|
|
908
|
+
}),
|
|
909
|
+
T.Http({
|
|
910
|
+
method: "PATCH",
|
|
911
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events/{eventId}",
|
|
912
|
+
}),
|
|
913
|
+
) as unknown as Schema.Schema<PatchEventRequest>;
|
|
914
|
+
|
|
915
|
+
export interface PatchEventResponse {
|
|
916
|
+
id?: string | null;
|
|
917
|
+
createdOn?: string | null;
|
|
918
|
+
/** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */
|
|
919
|
+
customPageHtml?: string | null;
|
|
920
|
+
/** A note that you can use to add more details about the event. */
|
|
921
|
+
description?: string | null;
|
|
922
|
+
/** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */
|
|
923
|
+
disableSessionRenewal?: boolean | null;
|
|
924
|
+
/** An ISO 8601 timestamp that marks the end of the event. */
|
|
925
|
+
eventEndTime?: string | null;
|
|
926
|
+
/** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time` */
|
|
927
|
+
eventStartTime?: string | null;
|
|
928
|
+
modifiedOn?: string | null;
|
|
929
|
+
/** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
930
|
+
name?: string | null;
|
|
931
|
+
/** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` prop */
|
|
932
|
+
newUsersPerMinute?: number | null;
|
|
933
|
+
/** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
934
|
+
prequeueStartTime?: string | null;
|
|
935
|
+
/** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */
|
|
936
|
+
queueingMethod?: string | null;
|
|
937
|
+
/** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */
|
|
938
|
+
sessionDuration?: number | null;
|
|
939
|
+
/** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the even */
|
|
940
|
+
shuffleAtEventStart?: boolean | null;
|
|
941
|
+
/** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
942
|
+
suspended?: boolean | null;
|
|
943
|
+
/** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` prop */
|
|
944
|
+
totalActiveUsers?: number | null;
|
|
945
|
+
/** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */
|
|
946
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
947
|
+
/** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */
|
|
948
|
+
turnstileMode?:
|
|
949
|
+
| "off"
|
|
950
|
+
| "invisible"
|
|
951
|
+
| "visible_non_interactive"
|
|
952
|
+
| "visible_managed"
|
|
953
|
+
| null;
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
export const PatchEventResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
957
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
958
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
959
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
960
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
961
|
+
disableSessionRenewal: Schema.optional(
|
|
962
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
963
|
+
),
|
|
964
|
+
eventEndTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
965
|
+
eventStartTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
966
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
967
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
968
|
+
newUsersPerMinute: Schema.optional(
|
|
969
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
970
|
+
),
|
|
971
|
+
prequeueStartTime: Schema.optional(
|
|
972
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
973
|
+
),
|
|
974
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
975
|
+
sessionDuration: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
976
|
+
shuffleAtEventStart: Schema.optional(
|
|
977
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
978
|
+
),
|
|
979
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
980
|
+
totalActiveUsers: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
981
|
+
turnstileAction: Schema.optional(
|
|
982
|
+
Schema.Union([
|
|
983
|
+
Schema.Literal("log"),
|
|
984
|
+
Schema.Literal("infinite_queue"),
|
|
985
|
+
Schema.Null,
|
|
986
|
+
]),
|
|
987
|
+
),
|
|
988
|
+
turnstileMode: Schema.optional(
|
|
989
|
+
Schema.Union([
|
|
990
|
+
Schema.Literal("off"),
|
|
991
|
+
Schema.Literal("invisible"),
|
|
992
|
+
Schema.Literal("visible_non_interactive"),
|
|
993
|
+
Schema.Literal("visible_managed"),
|
|
994
|
+
Schema.Null,
|
|
995
|
+
]),
|
|
996
|
+
),
|
|
997
|
+
})
|
|
998
|
+
.pipe(
|
|
999
|
+
Schema.encodeKeys({
|
|
1000
|
+
id: "id",
|
|
1001
|
+
createdOn: "created_on",
|
|
1002
|
+
customPageHtml: "custom_page_html",
|
|
1003
|
+
description: "description",
|
|
1004
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
1005
|
+
eventEndTime: "event_end_time",
|
|
1006
|
+
eventStartTime: "event_start_time",
|
|
1007
|
+
modifiedOn: "modified_on",
|
|
1008
|
+
name: "name",
|
|
1009
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
1010
|
+
prequeueStartTime: "prequeue_start_time",
|
|
1011
|
+
queueingMethod: "queueing_method",
|
|
1012
|
+
sessionDuration: "session_duration",
|
|
1013
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
1014
|
+
suspended: "suspended",
|
|
1015
|
+
totalActiveUsers: "total_active_users",
|
|
1016
|
+
turnstileAction: "turnstile_action",
|
|
1017
|
+
turnstileMode: "turnstile_mode",
|
|
1018
|
+
}),
|
|
1019
|
+
)
|
|
1020
|
+
.pipe(
|
|
1021
|
+
T.ResponsePath("result"),
|
|
1022
|
+
) as unknown as Schema.Schema<PatchEventResponse>;
|
|
1023
|
+
|
|
1024
|
+
export type PatchEventError = DefaultErrors;
|
|
1025
|
+
|
|
1026
|
+
export const patchEvent: API.OperationMethod<
|
|
1027
|
+
PatchEventRequest,
|
|
1028
|
+
PatchEventResponse,
|
|
1029
|
+
PatchEventError,
|
|
1030
|
+
Credentials | HttpClient.HttpClient
|
|
1031
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1032
|
+
input: PatchEventRequest,
|
|
1033
|
+
output: PatchEventResponse,
|
|
1034
|
+
errors: [],
|
|
1035
|
+
}));
|
|
1036
|
+
|
|
1037
|
+
export interface DeleteEventRequest {
|
|
1038
|
+
waitingRoomId: string;
|
|
1039
|
+
eventId: string;
|
|
1040
|
+
/** Identifier. */
|
|
1041
|
+
zoneId: string;
|
|
1042
|
+
}
|
|
1043
|
+
|
|
1044
|
+
export const DeleteEventRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1045
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1046
|
+
eventId: Schema.String.pipe(T.HttpPath("eventId")),
|
|
1047
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1048
|
+
}).pipe(
|
|
1049
|
+
T.Http({
|
|
1050
|
+
method: "DELETE",
|
|
1051
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events/{eventId}",
|
|
1052
|
+
}),
|
|
1053
|
+
) as unknown as Schema.Schema<DeleteEventRequest>;
|
|
1054
|
+
|
|
1055
|
+
export interface DeleteEventResponse {
|
|
1056
|
+
id?: string | null;
|
|
1057
|
+
}
|
|
1058
|
+
|
|
1059
|
+
export const DeleteEventResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1060
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1061
|
+
}).pipe(
|
|
1062
|
+
T.ResponsePath("result"),
|
|
1063
|
+
) as unknown as Schema.Schema<DeleteEventResponse>;
|
|
1064
|
+
|
|
1065
|
+
export type DeleteEventError = DefaultErrors;
|
|
1066
|
+
|
|
1067
|
+
export const deleteEvent: API.OperationMethod<
|
|
1068
|
+
DeleteEventRequest,
|
|
1069
|
+
DeleteEventResponse,
|
|
1070
|
+
DeleteEventError,
|
|
1071
|
+
Credentials | HttpClient.HttpClient
|
|
1072
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1073
|
+
input: DeleteEventRequest,
|
|
1074
|
+
output: DeleteEventResponse,
|
|
1075
|
+
errors: [],
|
|
1076
|
+
}));
|
|
1077
|
+
|
|
1078
|
+
// =============================================================================
|
|
1079
|
+
// EventDetail
|
|
1080
|
+
// =============================================================================
|
|
1081
|
+
|
|
1082
|
+
export interface GetEventDetailRequest {
|
|
1083
|
+
waitingRoomId: string;
|
|
1084
|
+
eventId: string;
|
|
1085
|
+
/** Identifier. */
|
|
1086
|
+
zoneId: string;
|
|
1087
|
+
}
|
|
1088
|
+
|
|
1089
|
+
export const GetEventDetailRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1090
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1091
|
+
eventId: Schema.String.pipe(T.HttpPath("eventId")),
|
|
1092
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1093
|
+
}).pipe(
|
|
1094
|
+
T.Http({
|
|
1095
|
+
method: "GET",
|
|
1096
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/events/{eventId}/details",
|
|
1097
|
+
}),
|
|
1098
|
+
) as unknown as Schema.Schema<GetEventDetailRequest>;
|
|
1099
|
+
|
|
1100
|
+
export interface GetEventDetailResponse {
|
|
1101
|
+
id?: string | null;
|
|
1102
|
+
createdOn?: string | null;
|
|
1103
|
+
customPageHtml?: string | null;
|
|
1104
|
+
/** A note that you can use to add more details about the event. */
|
|
1105
|
+
description?: string | null;
|
|
1106
|
+
disableSessionRenewal?: boolean | null;
|
|
1107
|
+
/** An ISO 8601 timestamp that marks the end of the event. */
|
|
1108
|
+
eventEndTime?: string | null;
|
|
1109
|
+
/** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time` */
|
|
1110
|
+
eventStartTime?: string | null;
|
|
1111
|
+
modifiedOn?: string | null;
|
|
1112
|
+
/** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
1113
|
+
name?: string | null;
|
|
1114
|
+
newUsersPerMinute?: number | null;
|
|
1115
|
+
/** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */
|
|
1116
|
+
prequeueStartTime?: string | null;
|
|
1117
|
+
queueingMethod?: string | null;
|
|
1118
|
+
sessionDuration?: number | null;
|
|
1119
|
+
/** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the even */
|
|
1120
|
+
shuffleAtEventStart?: boolean | null;
|
|
1121
|
+
/** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */
|
|
1122
|
+
suspended?: boolean | null;
|
|
1123
|
+
totalActiveUsers?: number | null;
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1126
|
+
export const GetEventDetailResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
|
|
1127
|
+
{
|
|
1128
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1129
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1130
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1131
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1132
|
+
disableSessionRenewal: Schema.optional(
|
|
1133
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
1134
|
+
),
|
|
1135
|
+
eventEndTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1136
|
+
eventStartTime: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1137
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1138
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1139
|
+
newUsersPerMinute: Schema.optional(
|
|
1140
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
1141
|
+
),
|
|
1142
|
+
prequeueStartTime: Schema.optional(
|
|
1143
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
1144
|
+
),
|
|
1145
|
+
queueingMethod: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1146
|
+
sessionDuration: Schema.optional(
|
|
1147
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
1148
|
+
),
|
|
1149
|
+
shuffleAtEventStart: Schema.optional(
|
|
1150
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
1151
|
+
),
|
|
1152
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
1153
|
+
totalActiveUsers: Schema.optional(
|
|
1154
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
1155
|
+
),
|
|
1156
|
+
},
|
|
1157
|
+
)
|
|
1158
|
+
.pipe(
|
|
1159
|
+
Schema.encodeKeys({
|
|
1160
|
+
id: "id",
|
|
1161
|
+
createdOn: "created_on",
|
|
1162
|
+
customPageHtml: "custom_page_html",
|
|
1163
|
+
description: "description",
|
|
1164
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
1165
|
+
eventEndTime: "event_end_time",
|
|
1166
|
+
eventStartTime: "event_start_time",
|
|
1167
|
+
modifiedOn: "modified_on",
|
|
1168
|
+
name: "name",
|
|
1169
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
1170
|
+
prequeueStartTime: "prequeue_start_time",
|
|
1171
|
+
queueingMethod: "queueing_method",
|
|
1172
|
+
sessionDuration: "session_duration",
|
|
1173
|
+
shuffleAtEventStart: "shuffle_at_event_start",
|
|
1174
|
+
suspended: "suspended",
|
|
1175
|
+
totalActiveUsers: "total_active_users",
|
|
1176
|
+
}),
|
|
1177
|
+
)
|
|
1178
|
+
.pipe(
|
|
1179
|
+
T.ResponsePath("result"),
|
|
1180
|
+
) as unknown as Schema.Schema<GetEventDetailResponse>;
|
|
1181
|
+
|
|
1182
|
+
export type GetEventDetailError = DefaultErrors;
|
|
1183
|
+
|
|
1184
|
+
export const getEventDetail: API.OperationMethod<
|
|
1185
|
+
GetEventDetailRequest,
|
|
1186
|
+
GetEventDetailResponse,
|
|
1187
|
+
GetEventDetailError,
|
|
1188
|
+
Credentials | HttpClient.HttpClient
|
|
1189
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1190
|
+
input: GetEventDetailRequest,
|
|
1191
|
+
output: GetEventDetailResponse,
|
|
1192
|
+
errors: [],
|
|
1193
|
+
}));
|
|
1194
|
+
|
|
1195
|
+
// =============================================================================
|
|
1196
|
+
// Page
|
|
1197
|
+
// =============================================================================
|
|
1198
|
+
|
|
1199
|
+
export interface PreviewPageRequest {
|
|
1200
|
+
/** Path param: Identifier. */
|
|
1201
|
+
zoneId: string;
|
|
1202
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will */
|
|
1203
|
+
customHtml: string;
|
|
1204
|
+
}
|
|
1205
|
+
|
|
1206
|
+
export const PreviewPageRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1207
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1208
|
+
customHtml: Schema.String,
|
|
1209
|
+
}).pipe(
|
|
1210
|
+
Schema.encodeKeys({ customHtml: "custom_html" }),
|
|
1211
|
+
T.Http({ method: "POST", path: "/zones/{zone_id}/waiting_rooms/preview" }),
|
|
1212
|
+
) as unknown as Schema.Schema<PreviewPageRequest>;
|
|
1213
|
+
|
|
1214
|
+
export interface PreviewPageResponse {
|
|
1215
|
+
/** URL where the custom waiting room page can temporarily be previewed. */
|
|
1216
|
+
previewUrl?: string | null;
|
|
1217
|
+
}
|
|
1218
|
+
|
|
1219
|
+
export const PreviewPageResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1220
|
+
previewUrl: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1221
|
+
})
|
|
1222
|
+
.pipe(Schema.encodeKeys({ previewUrl: "preview_url" }))
|
|
1223
|
+
.pipe(
|
|
1224
|
+
T.ResponsePath("result"),
|
|
1225
|
+
) as unknown as Schema.Schema<PreviewPageResponse>;
|
|
1226
|
+
|
|
1227
|
+
export type PreviewPageError = DefaultErrors;
|
|
1228
|
+
|
|
1229
|
+
export const previewPage: API.OperationMethod<
|
|
1230
|
+
PreviewPageRequest,
|
|
1231
|
+
PreviewPageResponse,
|
|
1232
|
+
PreviewPageError,
|
|
1233
|
+
Credentials | HttpClient.HttpClient
|
|
1234
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1235
|
+
input: PreviewPageRequest,
|
|
1236
|
+
output: PreviewPageResponse,
|
|
1237
|
+
errors: [],
|
|
1238
|
+
}));
|
|
1239
|
+
|
|
1240
|
+
// =============================================================================
|
|
1241
|
+
// Rule
|
|
1242
|
+
// =============================================================================
|
|
1243
|
+
|
|
1244
|
+
export interface GetRuleRequest {
|
|
1245
|
+
waitingRoomId: string;
|
|
1246
|
+
/** Identifier. */
|
|
1247
|
+
zoneId: string;
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1250
|
+
export const GetRuleRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1251
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1252
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1253
|
+
}).pipe(
|
|
1254
|
+
T.Http({
|
|
1255
|
+
method: "GET",
|
|
1256
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/rules",
|
|
1257
|
+
}),
|
|
1258
|
+
) as unknown as Schema.Schema<GetRuleRequest>;
|
|
1259
|
+
|
|
1260
|
+
export interface GetRuleResponse {
|
|
1261
|
+
result: {
|
|
1262
|
+
id?: string | null;
|
|
1263
|
+
action?: "bypass_waiting_room" | null;
|
|
1264
|
+
description?: string | null;
|
|
1265
|
+
enabled?: boolean | null;
|
|
1266
|
+
expression?: string | null;
|
|
1267
|
+
lastUpdated?: string | null;
|
|
1268
|
+
version?: string | null;
|
|
1269
|
+
}[];
|
|
1270
|
+
}
|
|
1271
|
+
|
|
1272
|
+
export const GetRuleResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1273
|
+
result: Schema.Array(
|
|
1274
|
+
Schema.Struct({
|
|
1275
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1276
|
+
action: Schema.optional(
|
|
1277
|
+
Schema.Union([Schema.Literal("bypass_waiting_room"), Schema.Null]),
|
|
1278
|
+
),
|
|
1279
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1280
|
+
enabled: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
1281
|
+
expression: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1282
|
+
lastUpdated: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1283
|
+
version: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1284
|
+
}).pipe(
|
|
1285
|
+
Schema.encodeKeys({
|
|
1286
|
+
id: "id",
|
|
1287
|
+
action: "action",
|
|
1288
|
+
description: "description",
|
|
1289
|
+
enabled: "enabled",
|
|
1290
|
+
expression: "expression",
|
|
1291
|
+
lastUpdated: "last_updated",
|
|
1292
|
+
version: "version",
|
|
1293
|
+
}),
|
|
1294
|
+
),
|
|
1295
|
+
),
|
|
1296
|
+
}) as unknown as Schema.Schema<GetRuleResponse>;
|
|
1297
|
+
|
|
1298
|
+
export type GetRuleError = DefaultErrors;
|
|
1299
|
+
|
|
1300
|
+
export const getRule: API.PaginatedOperationMethod<
|
|
1301
|
+
GetRuleRequest,
|
|
1302
|
+
GetRuleResponse,
|
|
1303
|
+
GetRuleError,
|
|
1304
|
+
Credentials | HttpClient.HttpClient
|
|
1305
|
+
> & {
|
|
1306
|
+
pages: (
|
|
1307
|
+
input: GetRuleRequest,
|
|
1308
|
+
) => stream.Stream<
|
|
1309
|
+
GetRuleResponse,
|
|
1310
|
+
GetRuleError,
|
|
1311
|
+
Credentials | HttpClient.HttpClient
|
|
1312
|
+
>;
|
|
1313
|
+
items: (input: GetRuleRequest) => stream.Stream<
|
|
1314
|
+
{
|
|
1315
|
+
id?: string | null;
|
|
1316
|
+
action?: "bypass_waiting_room" | null;
|
|
1317
|
+
description?: string | null;
|
|
1318
|
+
enabled?: boolean | null;
|
|
1319
|
+
expression?: string | null;
|
|
1320
|
+
lastUpdated?: string | null;
|
|
1321
|
+
version?: string | null;
|
|
1322
|
+
},
|
|
1323
|
+
GetRuleError,
|
|
1324
|
+
Credentials | HttpClient.HttpClient
|
|
1325
|
+
>;
|
|
1326
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
1327
|
+
input: GetRuleRequest,
|
|
1328
|
+
output: GetRuleResponse,
|
|
1329
|
+
errors: [],
|
|
1330
|
+
pagination: {
|
|
1331
|
+
mode: "single",
|
|
1332
|
+
items: "result",
|
|
1333
|
+
} as const,
|
|
1334
|
+
}));
|
|
1335
|
+
|
|
1336
|
+
export interface CreateRuleRequest {
|
|
1337
|
+
waitingRoomId: string;
|
|
1338
|
+
/** Path param: Identifier. */
|
|
1339
|
+
zoneId: string;
|
|
1340
|
+
/** Body param: */
|
|
1341
|
+
rules: {
|
|
1342
|
+
action: "bypass_waiting_room";
|
|
1343
|
+
expression: string;
|
|
1344
|
+
description?: string;
|
|
1345
|
+
enabled?: boolean;
|
|
1346
|
+
};
|
|
1347
|
+
}
|
|
1348
|
+
|
|
1349
|
+
export const CreateRuleRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1350
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1351
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1352
|
+
rules: Schema.Struct({
|
|
1353
|
+
action: Schema.Literal("bypass_waiting_room"),
|
|
1354
|
+
expression: Schema.String,
|
|
1355
|
+
description: Schema.optional(Schema.String),
|
|
1356
|
+
enabled: Schema.optional(Schema.Boolean),
|
|
1357
|
+
}),
|
|
1358
|
+
}).pipe(
|
|
1359
|
+
T.Http({
|
|
1360
|
+
method: "POST",
|
|
1361
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/rules",
|
|
1362
|
+
}),
|
|
1363
|
+
) as unknown as Schema.Schema<CreateRuleRequest>;
|
|
1364
|
+
|
|
1365
|
+
export interface CreateRuleResponse {
|
|
1366
|
+
result: {
|
|
1367
|
+
id?: string | null;
|
|
1368
|
+
action?: "bypass_waiting_room" | null;
|
|
1369
|
+
description?: string | null;
|
|
1370
|
+
enabled?: boolean | null;
|
|
1371
|
+
expression?: string | null;
|
|
1372
|
+
lastUpdated?: string | null;
|
|
1373
|
+
version?: string | null;
|
|
1374
|
+
}[];
|
|
1375
|
+
}
|
|
1376
|
+
|
|
1377
|
+
export const CreateRuleResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1378
|
+
result: Schema.Array(
|
|
1379
|
+
Schema.Struct({
|
|
1380
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1381
|
+
action: Schema.optional(
|
|
1382
|
+
Schema.Union([Schema.Literal("bypass_waiting_room"), Schema.Null]),
|
|
1383
|
+
),
|
|
1384
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1385
|
+
enabled: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
1386
|
+
expression: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1387
|
+
lastUpdated: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1388
|
+
version: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1389
|
+
}).pipe(
|
|
1390
|
+
Schema.encodeKeys({
|
|
1391
|
+
id: "id",
|
|
1392
|
+
action: "action",
|
|
1393
|
+
description: "description",
|
|
1394
|
+
enabled: "enabled",
|
|
1395
|
+
expression: "expression",
|
|
1396
|
+
lastUpdated: "last_updated",
|
|
1397
|
+
version: "version",
|
|
1398
|
+
}),
|
|
1399
|
+
),
|
|
1400
|
+
),
|
|
1401
|
+
}) as unknown as Schema.Schema<CreateRuleResponse>;
|
|
1402
|
+
|
|
1403
|
+
export type CreateRuleError = DefaultErrors;
|
|
1404
|
+
|
|
1405
|
+
export const createRule: API.PaginatedOperationMethod<
|
|
1406
|
+
CreateRuleRequest,
|
|
1407
|
+
CreateRuleResponse,
|
|
1408
|
+
CreateRuleError,
|
|
1409
|
+
Credentials | HttpClient.HttpClient
|
|
1410
|
+
> & {
|
|
1411
|
+
pages: (
|
|
1412
|
+
input: CreateRuleRequest,
|
|
1413
|
+
) => stream.Stream<
|
|
1414
|
+
CreateRuleResponse,
|
|
1415
|
+
CreateRuleError,
|
|
1416
|
+
Credentials | HttpClient.HttpClient
|
|
1417
|
+
>;
|
|
1418
|
+
items: (input: CreateRuleRequest) => stream.Stream<
|
|
1419
|
+
{
|
|
1420
|
+
id?: string | null;
|
|
1421
|
+
action?: "bypass_waiting_room" | null;
|
|
1422
|
+
description?: string | null;
|
|
1423
|
+
enabled?: boolean | null;
|
|
1424
|
+
expression?: string | null;
|
|
1425
|
+
lastUpdated?: string | null;
|
|
1426
|
+
version?: string | null;
|
|
1427
|
+
},
|
|
1428
|
+
CreateRuleError,
|
|
1429
|
+
Credentials | HttpClient.HttpClient
|
|
1430
|
+
>;
|
|
1431
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
1432
|
+
input: CreateRuleRequest,
|
|
1433
|
+
output: CreateRuleResponse,
|
|
1434
|
+
errors: [],
|
|
1435
|
+
pagination: {
|
|
1436
|
+
mode: "single",
|
|
1437
|
+
items: "result",
|
|
1438
|
+
} as const,
|
|
1439
|
+
}));
|
|
1440
|
+
|
|
1441
|
+
export interface UpdateRuleRequest {
|
|
1442
|
+
waitingRoomId: string;
|
|
1443
|
+
/** Path param: Identifier. */
|
|
1444
|
+
zoneId: string;
|
|
1445
|
+
/** Body param: */
|
|
1446
|
+
rules: {
|
|
1447
|
+
action: "bypass_waiting_room";
|
|
1448
|
+
expression: string;
|
|
1449
|
+
description?: string;
|
|
1450
|
+
enabled?: boolean;
|
|
1451
|
+
}[];
|
|
1452
|
+
}
|
|
1453
|
+
|
|
1454
|
+
export const UpdateRuleRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1455
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1456
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1457
|
+
rules: Schema.Array(
|
|
1458
|
+
Schema.Struct({
|
|
1459
|
+
action: Schema.Literal("bypass_waiting_room"),
|
|
1460
|
+
expression: Schema.String,
|
|
1461
|
+
description: Schema.optional(Schema.String),
|
|
1462
|
+
enabled: Schema.optional(Schema.Boolean),
|
|
1463
|
+
}),
|
|
1464
|
+
),
|
|
1465
|
+
}).pipe(
|
|
1466
|
+
T.Http({
|
|
1467
|
+
method: "PUT",
|
|
1468
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/rules",
|
|
1469
|
+
}),
|
|
1470
|
+
) as unknown as Schema.Schema<UpdateRuleRequest>;
|
|
1471
|
+
|
|
1472
|
+
export interface UpdateRuleResponse {
|
|
1473
|
+
result: {
|
|
1474
|
+
id?: string | null;
|
|
1475
|
+
action?: "bypass_waiting_room" | null;
|
|
1476
|
+
description?: string | null;
|
|
1477
|
+
enabled?: boolean | null;
|
|
1478
|
+
expression?: string | null;
|
|
1479
|
+
lastUpdated?: string | null;
|
|
1480
|
+
version?: string | null;
|
|
1481
|
+
}[];
|
|
1482
|
+
}
|
|
1483
|
+
|
|
1484
|
+
export const UpdateRuleResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1485
|
+
result: Schema.Array(
|
|
1486
|
+
Schema.Struct({
|
|
1487
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1488
|
+
action: Schema.optional(
|
|
1489
|
+
Schema.Union([Schema.Literal("bypass_waiting_room"), Schema.Null]),
|
|
1490
|
+
),
|
|
1491
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1492
|
+
enabled: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
1493
|
+
expression: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1494
|
+
lastUpdated: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1495
|
+
version: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1496
|
+
}).pipe(
|
|
1497
|
+
Schema.encodeKeys({
|
|
1498
|
+
id: "id",
|
|
1499
|
+
action: "action",
|
|
1500
|
+
description: "description",
|
|
1501
|
+
enabled: "enabled",
|
|
1502
|
+
expression: "expression",
|
|
1503
|
+
lastUpdated: "last_updated",
|
|
1504
|
+
version: "version",
|
|
1505
|
+
}),
|
|
1506
|
+
),
|
|
1507
|
+
),
|
|
1508
|
+
}) as unknown as Schema.Schema<UpdateRuleResponse>;
|
|
1509
|
+
|
|
1510
|
+
export type UpdateRuleError = DefaultErrors;
|
|
1511
|
+
|
|
1512
|
+
export const updateRule: API.PaginatedOperationMethod<
|
|
1513
|
+
UpdateRuleRequest,
|
|
1514
|
+
UpdateRuleResponse,
|
|
1515
|
+
UpdateRuleError,
|
|
1516
|
+
Credentials | HttpClient.HttpClient
|
|
1517
|
+
> & {
|
|
1518
|
+
pages: (
|
|
1519
|
+
input: UpdateRuleRequest,
|
|
1520
|
+
) => stream.Stream<
|
|
1521
|
+
UpdateRuleResponse,
|
|
1522
|
+
UpdateRuleError,
|
|
1523
|
+
Credentials | HttpClient.HttpClient
|
|
1524
|
+
>;
|
|
1525
|
+
items: (input: UpdateRuleRequest) => stream.Stream<
|
|
1526
|
+
{
|
|
1527
|
+
id?: string | null;
|
|
1528
|
+
action?: "bypass_waiting_room" | null;
|
|
1529
|
+
description?: string | null;
|
|
1530
|
+
enabled?: boolean | null;
|
|
1531
|
+
expression?: string | null;
|
|
1532
|
+
lastUpdated?: string | null;
|
|
1533
|
+
version?: string | null;
|
|
1534
|
+
},
|
|
1535
|
+
UpdateRuleError,
|
|
1536
|
+
Credentials | HttpClient.HttpClient
|
|
1537
|
+
>;
|
|
1538
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
1539
|
+
input: UpdateRuleRequest,
|
|
1540
|
+
output: UpdateRuleResponse,
|
|
1541
|
+
errors: [],
|
|
1542
|
+
pagination: {
|
|
1543
|
+
mode: "single",
|
|
1544
|
+
items: "result",
|
|
1545
|
+
} as const,
|
|
1546
|
+
}));
|
|
1547
|
+
|
|
1548
|
+
export interface PatchRuleRequest {
|
|
1549
|
+
waitingRoomId: string;
|
|
1550
|
+
ruleId: string;
|
|
1551
|
+
/** Path param: Identifier. */
|
|
1552
|
+
zoneId: string;
|
|
1553
|
+
/** Body param: The action to take when the expression matches. */
|
|
1554
|
+
action: "bypass_waiting_room";
|
|
1555
|
+
/** Body param: Criteria defining when there is a match for the current rule. */
|
|
1556
|
+
expression: string;
|
|
1557
|
+
/** Body param: The description of the rule. */
|
|
1558
|
+
description?: string;
|
|
1559
|
+
/** Body param: When set to true, the rule is enabled. */
|
|
1560
|
+
enabled?: boolean;
|
|
1561
|
+
/** Body param: Reorder the position of a rule */
|
|
1562
|
+
position?: { index?: number } | { before?: string } | { after?: string };
|
|
1563
|
+
}
|
|
1564
|
+
|
|
1565
|
+
export const PatchRuleRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1566
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1567
|
+
ruleId: Schema.String.pipe(T.HttpPath("ruleId")),
|
|
1568
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1569
|
+
action: Schema.Literal("bypass_waiting_room"),
|
|
1570
|
+
expression: Schema.String,
|
|
1571
|
+
description: Schema.optional(Schema.String),
|
|
1572
|
+
enabled: Schema.optional(Schema.Boolean),
|
|
1573
|
+
position: Schema.optional(
|
|
1574
|
+
Schema.Union([
|
|
1575
|
+
Schema.Struct({
|
|
1576
|
+
index: Schema.optional(Schema.Number),
|
|
1577
|
+
}),
|
|
1578
|
+
Schema.Struct({
|
|
1579
|
+
before: Schema.optional(Schema.String),
|
|
1580
|
+
}),
|
|
1581
|
+
Schema.Struct({
|
|
1582
|
+
after: Schema.optional(Schema.String),
|
|
1583
|
+
}),
|
|
1584
|
+
]),
|
|
1585
|
+
),
|
|
1586
|
+
}).pipe(
|
|
1587
|
+
T.Http({
|
|
1588
|
+
method: "PATCH",
|
|
1589
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/rules/{ruleId}",
|
|
1590
|
+
}),
|
|
1591
|
+
) as unknown as Schema.Schema<PatchRuleRequest>;
|
|
1592
|
+
|
|
1593
|
+
export interface PatchRuleResponse {
|
|
1594
|
+
result: {
|
|
1595
|
+
id?: string | null;
|
|
1596
|
+
action?: "bypass_waiting_room" | null;
|
|
1597
|
+
description?: string | null;
|
|
1598
|
+
enabled?: boolean | null;
|
|
1599
|
+
expression?: string | null;
|
|
1600
|
+
lastUpdated?: string | null;
|
|
1601
|
+
version?: string | null;
|
|
1602
|
+
}[];
|
|
1603
|
+
}
|
|
1604
|
+
|
|
1605
|
+
export const PatchRuleResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1606
|
+
result: Schema.Array(
|
|
1607
|
+
Schema.Struct({
|
|
1608
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1609
|
+
action: Schema.optional(
|
|
1610
|
+
Schema.Union([Schema.Literal("bypass_waiting_room"), Schema.Null]),
|
|
1611
|
+
),
|
|
1612
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1613
|
+
enabled: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
1614
|
+
expression: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1615
|
+
lastUpdated: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1616
|
+
version: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1617
|
+
}).pipe(
|
|
1618
|
+
Schema.encodeKeys({
|
|
1619
|
+
id: "id",
|
|
1620
|
+
action: "action",
|
|
1621
|
+
description: "description",
|
|
1622
|
+
enabled: "enabled",
|
|
1623
|
+
expression: "expression",
|
|
1624
|
+
lastUpdated: "last_updated",
|
|
1625
|
+
version: "version",
|
|
1626
|
+
}),
|
|
1627
|
+
),
|
|
1628
|
+
),
|
|
1629
|
+
}) as unknown as Schema.Schema<PatchRuleResponse>;
|
|
1630
|
+
|
|
1631
|
+
export type PatchRuleError = DefaultErrors;
|
|
1632
|
+
|
|
1633
|
+
export const patchRule: API.PaginatedOperationMethod<
|
|
1634
|
+
PatchRuleRequest,
|
|
1635
|
+
PatchRuleResponse,
|
|
1636
|
+
PatchRuleError,
|
|
1637
|
+
Credentials | HttpClient.HttpClient
|
|
1638
|
+
> & {
|
|
1639
|
+
pages: (
|
|
1640
|
+
input: PatchRuleRequest,
|
|
1641
|
+
) => stream.Stream<
|
|
1642
|
+
PatchRuleResponse,
|
|
1643
|
+
PatchRuleError,
|
|
1644
|
+
Credentials | HttpClient.HttpClient
|
|
1645
|
+
>;
|
|
1646
|
+
items: (input: PatchRuleRequest) => stream.Stream<
|
|
1647
|
+
{
|
|
1648
|
+
id?: string | null;
|
|
1649
|
+
action?: "bypass_waiting_room" | null;
|
|
1650
|
+
description?: string | null;
|
|
1651
|
+
enabled?: boolean | null;
|
|
1652
|
+
expression?: string | null;
|
|
1653
|
+
lastUpdated?: string | null;
|
|
1654
|
+
version?: string | null;
|
|
1655
|
+
},
|
|
1656
|
+
PatchRuleError,
|
|
1657
|
+
Credentials | HttpClient.HttpClient
|
|
1658
|
+
>;
|
|
1659
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
1660
|
+
input: PatchRuleRequest,
|
|
1661
|
+
output: PatchRuleResponse,
|
|
1662
|
+
errors: [],
|
|
1663
|
+
pagination: {
|
|
1664
|
+
mode: "single",
|
|
1665
|
+
items: "result",
|
|
1666
|
+
} as const,
|
|
1667
|
+
}));
|
|
1668
|
+
|
|
1669
|
+
export interface DeleteRuleRequest {
|
|
1670
|
+
waitingRoomId: string;
|
|
1671
|
+
ruleId: string;
|
|
1672
|
+
/** Identifier. */
|
|
1673
|
+
zoneId: string;
|
|
1674
|
+
}
|
|
1675
|
+
|
|
1676
|
+
export const DeleteRuleRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1677
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1678
|
+
ruleId: Schema.String.pipe(T.HttpPath("ruleId")),
|
|
1679
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1680
|
+
}).pipe(
|
|
1681
|
+
T.Http({
|
|
1682
|
+
method: "DELETE",
|
|
1683
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/rules/{ruleId}",
|
|
1684
|
+
}),
|
|
1685
|
+
) as unknown as Schema.Schema<DeleteRuleRequest>;
|
|
1686
|
+
|
|
1687
|
+
export interface DeleteRuleResponse {
|
|
1688
|
+
result: {
|
|
1689
|
+
id?: string | null;
|
|
1690
|
+
action?: "bypass_waiting_room" | null;
|
|
1691
|
+
description?: string | null;
|
|
1692
|
+
enabled?: boolean | null;
|
|
1693
|
+
expression?: string | null;
|
|
1694
|
+
lastUpdated?: string | null;
|
|
1695
|
+
version?: string | null;
|
|
1696
|
+
}[];
|
|
1697
|
+
}
|
|
1698
|
+
|
|
1699
|
+
export const DeleteRuleResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1700
|
+
result: Schema.Array(
|
|
1701
|
+
Schema.Struct({
|
|
1702
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1703
|
+
action: Schema.optional(
|
|
1704
|
+
Schema.Union([Schema.Literal("bypass_waiting_room"), Schema.Null]),
|
|
1705
|
+
),
|
|
1706
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1707
|
+
enabled: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
1708
|
+
expression: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1709
|
+
lastUpdated: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1710
|
+
version: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1711
|
+
}).pipe(
|
|
1712
|
+
Schema.encodeKeys({
|
|
1713
|
+
id: "id",
|
|
1714
|
+
action: "action",
|
|
1715
|
+
description: "description",
|
|
1716
|
+
enabled: "enabled",
|
|
1717
|
+
expression: "expression",
|
|
1718
|
+
lastUpdated: "last_updated",
|
|
1719
|
+
version: "version",
|
|
1720
|
+
}),
|
|
1721
|
+
),
|
|
1722
|
+
),
|
|
1723
|
+
}) as unknown as Schema.Schema<DeleteRuleResponse>;
|
|
1724
|
+
|
|
1725
|
+
export type DeleteRuleError = DefaultErrors;
|
|
1726
|
+
|
|
1727
|
+
export const deleteRule: API.PaginatedOperationMethod<
|
|
1728
|
+
DeleteRuleRequest,
|
|
1729
|
+
DeleteRuleResponse,
|
|
1730
|
+
DeleteRuleError,
|
|
1731
|
+
Credentials | HttpClient.HttpClient
|
|
1732
|
+
> & {
|
|
1733
|
+
pages: (
|
|
1734
|
+
input: DeleteRuleRequest,
|
|
1735
|
+
) => stream.Stream<
|
|
1736
|
+
DeleteRuleResponse,
|
|
1737
|
+
DeleteRuleError,
|
|
1738
|
+
Credentials | HttpClient.HttpClient
|
|
1739
|
+
>;
|
|
1740
|
+
items: (input: DeleteRuleRequest) => stream.Stream<
|
|
1741
|
+
{
|
|
1742
|
+
id?: string | null;
|
|
1743
|
+
action?: "bypass_waiting_room" | null;
|
|
1744
|
+
description?: string | null;
|
|
1745
|
+
enabled?: boolean | null;
|
|
1746
|
+
expression?: string | null;
|
|
1747
|
+
lastUpdated?: string | null;
|
|
1748
|
+
version?: string | null;
|
|
1749
|
+
},
|
|
1750
|
+
DeleteRuleError,
|
|
1751
|
+
Credentials | HttpClient.HttpClient
|
|
1752
|
+
>;
|
|
1753
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
1754
|
+
input: DeleteRuleRequest,
|
|
1755
|
+
output: DeleteRuleResponse,
|
|
1756
|
+
errors: [],
|
|
1757
|
+
pagination: {
|
|
1758
|
+
mode: "single",
|
|
1759
|
+
items: "result",
|
|
1760
|
+
} as const,
|
|
1761
|
+
}));
|
|
1762
|
+
|
|
1763
|
+
// =============================================================================
|
|
1764
|
+
// Setting
|
|
1765
|
+
// =============================================================================
|
|
1766
|
+
|
|
1767
|
+
export interface GetSettingRequest {
|
|
1768
|
+
/** Identifier. */
|
|
1769
|
+
zoneId: string;
|
|
1770
|
+
}
|
|
1771
|
+
|
|
1772
|
+
export const GetSettingRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1773
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1774
|
+
}).pipe(
|
|
1775
|
+
T.Http({ method: "GET", path: "/zones/{zone_id}/waiting_rooms/settings" }),
|
|
1776
|
+
) as unknown as Schema.Schema<GetSettingRequest>;
|
|
1777
|
+
|
|
1778
|
+
export interface GetSettingResponse {
|
|
1779
|
+
/** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appea */
|
|
1780
|
+
searchEngineCrawlerBypass: boolean;
|
|
1781
|
+
}
|
|
1782
|
+
|
|
1783
|
+
export const GetSettingResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1784
|
+
searchEngineCrawlerBypass: Schema.Boolean,
|
|
1785
|
+
})
|
|
1786
|
+
.pipe(
|
|
1787
|
+
Schema.encodeKeys({
|
|
1788
|
+
searchEngineCrawlerBypass: "search_engine_crawler_bypass",
|
|
1789
|
+
}),
|
|
1790
|
+
)
|
|
1791
|
+
.pipe(
|
|
1792
|
+
T.ResponsePath("result"),
|
|
1793
|
+
) as unknown as Schema.Schema<GetSettingResponse>;
|
|
1794
|
+
|
|
1795
|
+
export type GetSettingError = DefaultErrors;
|
|
1796
|
+
|
|
1797
|
+
export const getSetting: API.OperationMethod<
|
|
1798
|
+
GetSettingRequest,
|
|
1799
|
+
GetSettingResponse,
|
|
1800
|
+
GetSettingError,
|
|
1801
|
+
Credentials | HttpClient.HttpClient
|
|
1802
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1803
|
+
input: GetSettingRequest,
|
|
1804
|
+
output: GetSettingResponse,
|
|
1805
|
+
errors: [],
|
|
1806
|
+
}));
|
|
1807
|
+
|
|
1808
|
+
export interface PutSettingRequest {
|
|
1809
|
+
/** Path param: Identifier. */
|
|
1810
|
+
zoneId: string;
|
|
1811
|
+
/** Body param: Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and wi */
|
|
1812
|
+
searchEngineCrawlerBypass?: boolean;
|
|
1813
|
+
}
|
|
1814
|
+
|
|
1815
|
+
export const PutSettingRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1816
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1817
|
+
searchEngineCrawlerBypass: Schema.optional(Schema.Boolean),
|
|
1818
|
+
}).pipe(
|
|
1819
|
+
Schema.encodeKeys({
|
|
1820
|
+
searchEngineCrawlerBypass: "search_engine_crawler_bypass",
|
|
1821
|
+
}),
|
|
1822
|
+
T.Http({ method: "PUT", path: "/zones/{zone_id}/waiting_rooms/settings" }),
|
|
1823
|
+
) as unknown as Schema.Schema<PutSettingRequest>;
|
|
1824
|
+
|
|
1825
|
+
export interface PutSettingResponse {
|
|
1826
|
+
/** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appea */
|
|
1827
|
+
searchEngineCrawlerBypass: boolean;
|
|
1828
|
+
}
|
|
1829
|
+
|
|
1830
|
+
export const PutSettingResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1831
|
+
searchEngineCrawlerBypass: Schema.Boolean,
|
|
1832
|
+
})
|
|
1833
|
+
.pipe(
|
|
1834
|
+
Schema.encodeKeys({
|
|
1835
|
+
searchEngineCrawlerBypass: "search_engine_crawler_bypass",
|
|
1836
|
+
}),
|
|
1837
|
+
)
|
|
1838
|
+
.pipe(
|
|
1839
|
+
T.ResponsePath("result"),
|
|
1840
|
+
) as unknown as Schema.Schema<PutSettingResponse>;
|
|
1841
|
+
|
|
1842
|
+
export type PutSettingError = DefaultErrors;
|
|
1843
|
+
|
|
1844
|
+
export const putSetting: API.OperationMethod<
|
|
1845
|
+
PutSettingRequest,
|
|
1846
|
+
PutSettingResponse,
|
|
1847
|
+
PutSettingError,
|
|
1848
|
+
Credentials | HttpClient.HttpClient
|
|
1849
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1850
|
+
input: PutSettingRequest,
|
|
1851
|
+
output: PutSettingResponse,
|
|
1852
|
+
errors: [],
|
|
1853
|
+
}));
|
|
1854
|
+
|
|
1855
|
+
export interface PatchSettingRequest {
|
|
1856
|
+
/** Path param: Identifier. */
|
|
1857
|
+
zoneId: string;
|
|
1858
|
+
/** Body param: Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and wi */
|
|
1859
|
+
searchEngineCrawlerBypass?: boolean;
|
|
1860
|
+
}
|
|
1861
|
+
|
|
1862
|
+
export const PatchSettingRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1863
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1864
|
+
searchEngineCrawlerBypass: Schema.optional(Schema.Boolean),
|
|
1865
|
+
}).pipe(
|
|
1866
|
+
Schema.encodeKeys({
|
|
1867
|
+
searchEngineCrawlerBypass: "search_engine_crawler_bypass",
|
|
1868
|
+
}),
|
|
1869
|
+
T.Http({ method: "PATCH", path: "/zones/{zone_id}/waiting_rooms/settings" }),
|
|
1870
|
+
) as unknown as Schema.Schema<PatchSettingRequest>;
|
|
1871
|
+
|
|
1872
|
+
export interface PatchSettingResponse {
|
|
1873
|
+
/** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appea */
|
|
1874
|
+
searchEngineCrawlerBypass: boolean;
|
|
1875
|
+
}
|
|
1876
|
+
|
|
1877
|
+
export const PatchSettingResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1878
|
+
searchEngineCrawlerBypass: Schema.Boolean,
|
|
1879
|
+
})
|
|
1880
|
+
.pipe(
|
|
1881
|
+
Schema.encodeKeys({
|
|
1882
|
+
searchEngineCrawlerBypass: "search_engine_crawler_bypass",
|
|
1883
|
+
}),
|
|
1884
|
+
)
|
|
1885
|
+
.pipe(
|
|
1886
|
+
T.ResponsePath("result"),
|
|
1887
|
+
) as unknown as Schema.Schema<PatchSettingResponse>;
|
|
1888
|
+
|
|
1889
|
+
export type PatchSettingError = DefaultErrors;
|
|
1890
|
+
|
|
1891
|
+
export const patchSetting: API.OperationMethod<
|
|
1892
|
+
PatchSettingRequest,
|
|
1893
|
+
PatchSettingResponse,
|
|
1894
|
+
PatchSettingError,
|
|
1895
|
+
Credentials | HttpClient.HttpClient
|
|
1896
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1897
|
+
input: PatchSettingRequest,
|
|
1898
|
+
output: PatchSettingResponse,
|
|
1899
|
+
errors: [],
|
|
1900
|
+
}));
|
|
1901
|
+
|
|
1902
|
+
// =============================================================================
|
|
1903
|
+
// Status
|
|
1904
|
+
// =============================================================================
|
|
1905
|
+
|
|
1906
|
+
export interface GetStatusRequest {
|
|
1907
|
+
waitingRoomId: string;
|
|
1908
|
+
/** Identifier. */
|
|
1909
|
+
zoneId: string;
|
|
1910
|
+
}
|
|
1911
|
+
|
|
1912
|
+
export const GetStatusRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1913
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1914
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1915
|
+
}).pipe(
|
|
1916
|
+
T.Http({
|
|
1917
|
+
method: "GET",
|
|
1918
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}/status",
|
|
1919
|
+
}),
|
|
1920
|
+
) as unknown as Schema.Schema<GetStatusRequest>;
|
|
1921
|
+
|
|
1922
|
+
export interface GetStatusResponse {
|
|
1923
|
+
estimatedQueuedUsers?: number | null;
|
|
1924
|
+
estimatedTotalActiveUsers?: number | null;
|
|
1925
|
+
eventId?: string | null;
|
|
1926
|
+
maxEstimatedTimeMinutes?: number | null;
|
|
1927
|
+
status?:
|
|
1928
|
+
| "event_prequeueing"
|
|
1929
|
+
| "not_queueing"
|
|
1930
|
+
| "queueing"
|
|
1931
|
+
| "suspended"
|
|
1932
|
+
| null;
|
|
1933
|
+
}
|
|
1934
|
+
|
|
1935
|
+
export const GetStatusResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1936
|
+
estimatedQueuedUsers: Schema.optional(
|
|
1937
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
1938
|
+
),
|
|
1939
|
+
estimatedTotalActiveUsers: Schema.optional(
|
|
1940
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
1941
|
+
),
|
|
1942
|
+
eventId: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
1943
|
+
maxEstimatedTimeMinutes: Schema.optional(
|
|
1944
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
1945
|
+
),
|
|
1946
|
+
status: Schema.optional(
|
|
1947
|
+
Schema.Union([
|
|
1948
|
+
Schema.Literals([
|
|
1949
|
+
"event_prequeueing",
|
|
1950
|
+
"not_queueing",
|
|
1951
|
+
"queueing",
|
|
1952
|
+
"suspended",
|
|
1953
|
+
]),
|
|
1954
|
+
Schema.Null,
|
|
1955
|
+
]),
|
|
1956
|
+
),
|
|
1957
|
+
})
|
|
1958
|
+
.pipe(
|
|
1959
|
+
Schema.encodeKeys({
|
|
1960
|
+
estimatedQueuedUsers: "estimated_queued_users",
|
|
1961
|
+
estimatedTotalActiveUsers: "estimated_total_active_users",
|
|
1962
|
+
eventId: "event_id",
|
|
1963
|
+
maxEstimatedTimeMinutes: "max_estimated_time_minutes",
|
|
1964
|
+
status: "status",
|
|
1965
|
+
}),
|
|
1966
|
+
)
|
|
1967
|
+
.pipe(
|
|
1968
|
+
T.ResponsePath("result"),
|
|
1969
|
+
) as unknown as Schema.Schema<GetStatusResponse>;
|
|
1970
|
+
|
|
1971
|
+
export type GetStatusError = DefaultErrors;
|
|
1972
|
+
|
|
1973
|
+
export const getStatus: API.OperationMethod<
|
|
1974
|
+
GetStatusRequest,
|
|
1975
|
+
GetStatusResponse,
|
|
1976
|
+
GetStatusError,
|
|
1977
|
+
Credentials | HttpClient.HttpClient
|
|
1978
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
1979
|
+
input: GetStatusRequest,
|
|
1980
|
+
output: GetStatusResponse,
|
|
1981
|
+
errors: [],
|
|
1982
|
+
}));
|
|
1983
|
+
|
|
1984
|
+
// =============================================================================
|
|
1985
|
+
// WaitingRoom
|
|
1986
|
+
// =============================================================================
|
|
1987
|
+
|
|
1988
|
+
export interface GetWaitingRoomRequest {
|
|
1989
|
+
waitingRoomId: string;
|
|
1990
|
+
/** Identifier. */
|
|
1991
|
+
zoneId: string;
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1994
|
+
export const GetWaitingRoomRequest = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
1995
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
1996
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
1997
|
+
}).pipe(
|
|
1998
|
+
T.Http({
|
|
1999
|
+
method: "GET",
|
|
2000
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}",
|
|
2001
|
+
}),
|
|
2002
|
+
) as unknown as Schema.Schema<GetWaitingRoomRequest>;
|
|
2003
|
+
|
|
2004
|
+
export interface GetWaitingRoomResponse {
|
|
2005
|
+
id?: string | null;
|
|
2006
|
+
/** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. Th */
|
|
2007
|
+
additionalRoutes?: { host?: string | null; path?: string | null }[] | null;
|
|
2008
|
+
/** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
2009
|
+
cookieAttributes?: {
|
|
2010
|
+
samesite?: "auto" | "lax" | "none" | "strict" | null;
|
|
2011
|
+
secure?: "auto" | "always" | "never" | null;
|
|
2012
|
+
} | null;
|
|
2013
|
+
/** Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This field is req */
|
|
2014
|
+
cookieSuffix?: string | null;
|
|
2015
|
+
createdOn?: string | null;
|
|
2016
|
+
/** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. Th */
|
|
2017
|
+
customPageHtml?: string | null;
|
|
2018
|
+
/** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
2019
|
+
defaultTemplateLanguage?:
|
|
2020
|
+
| "en-US"
|
|
2021
|
+
| "es-ES"
|
|
2022
|
+
| "de-DE"
|
|
2023
|
+
| "fr-FR"
|
|
2024
|
+
| "it-IT"
|
|
2025
|
+
| "ja-JP"
|
|
2026
|
+
| "ko-KR"
|
|
2027
|
+
| "pt-BR"
|
|
2028
|
+
| "zh-CN"
|
|
2029
|
+
| "zh-TW"
|
|
2030
|
+
| "nl-NL"
|
|
2031
|
+
| "pl-PL"
|
|
2032
|
+
| "id-ID"
|
|
2033
|
+
| "tr-TR"
|
|
2034
|
+
| "ar-EG"
|
|
2035
|
+
| "ru-RU"
|
|
2036
|
+
| "fa-IR"
|
|
2037
|
+
| "bg-BG"
|
|
2038
|
+
| "hr-HR"
|
|
2039
|
+
| "cs-CZ"
|
|
2040
|
+
| "da-DK"
|
|
2041
|
+
| "fi-FI"
|
|
2042
|
+
| "lt-LT"
|
|
2043
|
+
| "ms-MY"
|
|
2044
|
+
| "nb-NO"
|
|
2045
|
+
| "ro-RO"
|
|
2046
|
+
| "el-GR"
|
|
2047
|
+
| "he-IL"
|
|
2048
|
+
| "hi-IN"
|
|
2049
|
+
| "hu-HU"
|
|
2050
|
+
| "sr-BA"
|
|
2051
|
+
| "sk-SK"
|
|
2052
|
+
| "sl-SI"
|
|
2053
|
+
| "sv-SE"
|
|
2054
|
+
| "tl-PH"
|
|
2055
|
+
| "th-TH"
|
|
2056
|
+
| "uk-UA"
|
|
2057
|
+
| "vi-VN"
|
|
2058
|
+
| null;
|
|
2059
|
+
/** A note that you can use to add more details about the waiting room. */
|
|
2060
|
+
description?: string | null;
|
|
2061
|
+
/** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, */
|
|
2062
|
+
disableSessionRenewal?: boolean | null;
|
|
2063
|
+
/** A list of enabled origin commands. */
|
|
2064
|
+
enabledOriginCommands?: "revoke"[] | null;
|
|
2065
|
+
/** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
2066
|
+
host?: string | null;
|
|
2067
|
+
/** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on th */
|
|
2068
|
+
jsonResponseEnabled?: boolean | null;
|
|
2069
|
+
modifiedOn?: string | null;
|
|
2070
|
+
/** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
2071
|
+
name?: string | null;
|
|
2072
|
+
/** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little m */
|
|
2073
|
+
newUsersPerMinute?: number | null;
|
|
2074
|
+
/** An ISO 8601 timestamp that marks when the next event will begin queueing. */
|
|
2075
|
+
nextEventPrequeueStartTime?: string | null;
|
|
2076
|
+
/** An ISO 8601 timestamp that marks when the next event will start. */
|
|
2077
|
+
nextEventStartTime?: string | null;
|
|
2078
|
+
/** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the mos */
|
|
2079
|
+
path?: string | null;
|
|
2080
|
+
/** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailabl */
|
|
2081
|
+
queueAll?: boolean | null;
|
|
2082
|
+
/** Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing m */
|
|
2083
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject" | null;
|
|
2084
|
+
/** HTTP status code returned to a user while in the queue. */
|
|
2085
|
+
queueingStatusCode?: "200" | "202" | "429" | null;
|
|
2086
|
+
/** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits */
|
|
2087
|
+
sessionDuration?: number | null;
|
|
2088
|
+
/** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
2089
|
+
suspended?: boolean | null;
|
|
2090
|
+
/** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the */
|
|
2091
|
+
totalActiveUsers?: number | null;
|
|
2092
|
+
/** Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. `infinite_que */
|
|
2093
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
2094
|
+
/** Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitions of these */
|
|
2095
|
+
turnstileMode?:
|
|
2096
|
+
| "off"
|
|
2097
|
+
| "invisible"
|
|
2098
|
+
| "visible_non_interactive"
|
|
2099
|
+
| "visible_managed"
|
|
2100
|
+
| null;
|
|
2101
|
+
}
|
|
2102
|
+
|
|
2103
|
+
export const GetWaitingRoomResponse = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
|
|
2104
|
+
{
|
|
2105
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2106
|
+
additionalRoutes: Schema.optional(
|
|
2107
|
+
Schema.Union([
|
|
2108
|
+
Schema.Array(
|
|
2109
|
+
Schema.Struct({
|
|
2110
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2111
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2112
|
+
}),
|
|
2113
|
+
),
|
|
2114
|
+
Schema.Null,
|
|
2115
|
+
]),
|
|
2116
|
+
),
|
|
2117
|
+
cookieAttributes: Schema.optional(
|
|
2118
|
+
Schema.Union([
|
|
2119
|
+
Schema.Struct({
|
|
2120
|
+
samesite: Schema.optional(
|
|
2121
|
+
Schema.Union([
|
|
2122
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
2123
|
+
Schema.Null,
|
|
2124
|
+
]),
|
|
2125
|
+
),
|
|
2126
|
+
secure: Schema.optional(
|
|
2127
|
+
Schema.Union([
|
|
2128
|
+
Schema.Literals(["auto", "always", "never"]),
|
|
2129
|
+
Schema.Null,
|
|
2130
|
+
]),
|
|
2131
|
+
),
|
|
2132
|
+
}),
|
|
2133
|
+
Schema.Null,
|
|
2134
|
+
]),
|
|
2135
|
+
),
|
|
2136
|
+
cookieSuffix: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2137
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2138
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2139
|
+
defaultTemplateLanguage: Schema.optional(
|
|
2140
|
+
Schema.Union([
|
|
2141
|
+
Schema.Literals([
|
|
2142
|
+
"en-US",
|
|
2143
|
+
"es-ES",
|
|
2144
|
+
"de-DE",
|
|
2145
|
+
"fr-FR",
|
|
2146
|
+
"it-IT",
|
|
2147
|
+
"ja-JP",
|
|
2148
|
+
"ko-KR",
|
|
2149
|
+
"pt-BR",
|
|
2150
|
+
"zh-CN",
|
|
2151
|
+
"zh-TW",
|
|
2152
|
+
"nl-NL",
|
|
2153
|
+
"pl-PL",
|
|
2154
|
+
"id-ID",
|
|
2155
|
+
"tr-TR",
|
|
2156
|
+
"ar-EG",
|
|
2157
|
+
"ru-RU",
|
|
2158
|
+
"fa-IR",
|
|
2159
|
+
"bg-BG",
|
|
2160
|
+
"hr-HR",
|
|
2161
|
+
"cs-CZ",
|
|
2162
|
+
"da-DK",
|
|
2163
|
+
"fi-FI",
|
|
2164
|
+
"lt-LT",
|
|
2165
|
+
"ms-MY",
|
|
2166
|
+
"nb-NO",
|
|
2167
|
+
"ro-RO",
|
|
2168
|
+
"el-GR",
|
|
2169
|
+
"he-IL",
|
|
2170
|
+
"hi-IN",
|
|
2171
|
+
"hu-HU",
|
|
2172
|
+
"sr-BA",
|
|
2173
|
+
"sk-SK",
|
|
2174
|
+
"sl-SI",
|
|
2175
|
+
"sv-SE",
|
|
2176
|
+
"tl-PH",
|
|
2177
|
+
"th-TH",
|
|
2178
|
+
"uk-UA",
|
|
2179
|
+
"vi-VN",
|
|
2180
|
+
]),
|
|
2181
|
+
Schema.Null,
|
|
2182
|
+
]),
|
|
2183
|
+
),
|
|
2184
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2185
|
+
disableSessionRenewal: Schema.optional(
|
|
2186
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
2187
|
+
),
|
|
2188
|
+
enabledOriginCommands: Schema.optional(
|
|
2189
|
+
Schema.Union([Schema.Array(Schema.Literal("revoke")), Schema.Null]),
|
|
2190
|
+
),
|
|
2191
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2192
|
+
jsonResponseEnabled: Schema.optional(
|
|
2193
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
2194
|
+
),
|
|
2195
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2196
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2197
|
+
newUsersPerMinute: Schema.optional(
|
|
2198
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
2199
|
+
),
|
|
2200
|
+
nextEventPrequeueStartTime: Schema.optional(
|
|
2201
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2202
|
+
),
|
|
2203
|
+
nextEventStartTime: Schema.optional(
|
|
2204
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2205
|
+
),
|
|
2206
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2207
|
+
queueAll: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
2208
|
+
queueingMethod: Schema.optional(
|
|
2209
|
+
Schema.Union([
|
|
2210
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
2211
|
+
Schema.Null,
|
|
2212
|
+
]),
|
|
2213
|
+
),
|
|
2214
|
+
queueingStatusCode: Schema.optional(
|
|
2215
|
+
Schema.Union([Schema.Literals(["200", "202", "429"]), Schema.Null]),
|
|
2216
|
+
),
|
|
2217
|
+
sessionDuration: Schema.optional(
|
|
2218
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
2219
|
+
),
|
|
2220
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
2221
|
+
totalActiveUsers: Schema.optional(
|
|
2222
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
2223
|
+
),
|
|
2224
|
+
turnstileAction: Schema.optional(
|
|
2225
|
+
Schema.Union([Schema.Literals(["log", "infinite_queue"]), Schema.Null]),
|
|
2226
|
+
),
|
|
2227
|
+
turnstileMode: Schema.optional(
|
|
2228
|
+
Schema.Union([
|
|
2229
|
+
Schema.Literals([
|
|
2230
|
+
"off",
|
|
2231
|
+
"invisible",
|
|
2232
|
+
"visible_non_interactive",
|
|
2233
|
+
"visible_managed",
|
|
2234
|
+
]),
|
|
2235
|
+
Schema.Null,
|
|
2236
|
+
]),
|
|
2237
|
+
),
|
|
2238
|
+
},
|
|
2239
|
+
)
|
|
2240
|
+
.pipe(
|
|
2241
|
+
Schema.encodeKeys({
|
|
2242
|
+
id: "id",
|
|
2243
|
+
additionalRoutes: "additional_routes",
|
|
2244
|
+
cookieAttributes: "cookie_attributes",
|
|
2245
|
+
cookieSuffix: "cookie_suffix",
|
|
2246
|
+
createdOn: "created_on",
|
|
2247
|
+
customPageHtml: "custom_page_html",
|
|
2248
|
+
defaultTemplateLanguage: "default_template_language",
|
|
2249
|
+
description: "description",
|
|
2250
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
2251
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
2252
|
+
host: "host",
|
|
2253
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
2254
|
+
modifiedOn: "modified_on",
|
|
2255
|
+
name: "name",
|
|
2256
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
2257
|
+
nextEventPrequeueStartTime: "next_event_prequeue_start_time",
|
|
2258
|
+
nextEventStartTime: "next_event_start_time",
|
|
2259
|
+
path: "path",
|
|
2260
|
+
queueAll: "queue_all",
|
|
2261
|
+
queueingMethod: "queueing_method",
|
|
2262
|
+
queueingStatusCode: "queueing_status_code",
|
|
2263
|
+
sessionDuration: "session_duration",
|
|
2264
|
+
suspended: "suspended",
|
|
2265
|
+
totalActiveUsers: "total_active_users",
|
|
2266
|
+
turnstileAction: "turnstile_action",
|
|
2267
|
+
turnstileMode: "turnstile_mode",
|
|
2268
|
+
}),
|
|
2269
|
+
)
|
|
2270
|
+
.pipe(
|
|
2271
|
+
T.ResponsePath("result"),
|
|
2272
|
+
) as unknown as Schema.Schema<GetWaitingRoomResponse>;
|
|
2273
|
+
|
|
2274
|
+
export type GetWaitingRoomError = DefaultErrors;
|
|
2275
|
+
|
|
2276
|
+
export const getWaitingRoom: API.OperationMethod<
|
|
2277
|
+
GetWaitingRoomRequest,
|
|
2278
|
+
GetWaitingRoomResponse,
|
|
2279
|
+
GetWaitingRoomError,
|
|
2280
|
+
Credentials | HttpClient.HttpClient
|
|
2281
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
2282
|
+
input: GetWaitingRoomRequest,
|
|
2283
|
+
output: GetWaitingRoomResponse,
|
|
2284
|
+
errors: [],
|
|
2285
|
+
}));
|
|
2286
|
+
|
|
2287
|
+
export interface ListWaitingRoomsRequest {}
|
|
2288
|
+
|
|
2289
|
+
export const ListWaitingRoomsRequest =
|
|
2290
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
|
|
2291
|
+
T.Http({
|
|
2292
|
+
method: "GET",
|
|
2293
|
+
path: "/{accountOrZone}/{accountOrZoneId}/waiting_rooms",
|
|
2294
|
+
}),
|
|
2295
|
+
) as unknown as Schema.Schema<ListWaitingRoomsRequest>;
|
|
2296
|
+
|
|
2297
|
+
export interface ListWaitingRoomsResponse {
|
|
2298
|
+
result: {
|
|
2299
|
+
id?: string | null;
|
|
2300
|
+
additionalRoutes?: { host?: string | null; path?: string | null }[] | null;
|
|
2301
|
+
cookieAttributes?: {
|
|
2302
|
+
samesite?: "auto" | "lax" | "none" | "strict" | null;
|
|
2303
|
+
secure?: "auto" | "always" | "never" | null;
|
|
2304
|
+
} | null;
|
|
2305
|
+
cookieSuffix?: string | null;
|
|
2306
|
+
createdOn?: string | null;
|
|
2307
|
+
customPageHtml?: string | null;
|
|
2308
|
+
defaultTemplateLanguage?:
|
|
2309
|
+
| "en-US"
|
|
2310
|
+
| "es-ES"
|
|
2311
|
+
| "de-DE"
|
|
2312
|
+
| "fr-FR"
|
|
2313
|
+
| "it-IT"
|
|
2314
|
+
| "ja-JP"
|
|
2315
|
+
| "ko-KR"
|
|
2316
|
+
| "pt-BR"
|
|
2317
|
+
| "zh-CN"
|
|
2318
|
+
| "zh-TW"
|
|
2319
|
+
| "nl-NL"
|
|
2320
|
+
| "pl-PL"
|
|
2321
|
+
| "id-ID"
|
|
2322
|
+
| "tr-TR"
|
|
2323
|
+
| "ar-EG"
|
|
2324
|
+
| "ru-RU"
|
|
2325
|
+
| "fa-IR"
|
|
2326
|
+
| "bg-BG"
|
|
2327
|
+
| "hr-HR"
|
|
2328
|
+
| "cs-CZ"
|
|
2329
|
+
| "da-DK"
|
|
2330
|
+
| "fi-FI"
|
|
2331
|
+
| "lt-LT"
|
|
2332
|
+
| "ms-MY"
|
|
2333
|
+
| "nb-NO"
|
|
2334
|
+
| "ro-RO"
|
|
2335
|
+
| "el-GR"
|
|
2336
|
+
| "he-IL"
|
|
2337
|
+
| "hi-IN"
|
|
2338
|
+
| "hu-HU"
|
|
2339
|
+
| "sr-BA"
|
|
2340
|
+
| "sk-SK"
|
|
2341
|
+
| "sl-SI"
|
|
2342
|
+
| "sv-SE"
|
|
2343
|
+
| "tl-PH"
|
|
2344
|
+
| "th-TH"
|
|
2345
|
+
| "uk-UA"
|
|
2346
|
+
| "vi-VN"
|
|
2347
|
+
| null;
|
|
2348
|
+
description?: string | null;
|
|
2349
|
+
disableSessionRenewal?: boolean | null;
|
|
2350
|
+
enabledOriginCommands?: "revoke"[] | null;
|
|
2351
|
+
host?: string | null;
|
|
2352
|
+
jsonResponseEnabled?: boolean | null;
|
|
2353
|
+
modifiedOn?: string | null;
|
|
2354
|
+
name?: string | null;
|
|
2355
|
+
newUsersPerMinute?: number | null;
|
|
2356
|
+
nextEventPrequeueStartTime?: string | null;
|
|
2357
|
+
nextEventStartTime?: string | null;
|
|
2358
|
+
path?: string | null;
|
|
2359
|
+
queueAll?: boolean | null;
|
|
2360
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject" | null;
|
|
2361
|
+
queueingStatusCode?: "200" | "202" | "429" | null;
|
|
2362
|
+
sessionDuration?: number | null;
|
|
2363
|
+
suspended?: boolean | null;
|
|
2364
|
+
totalActiveUsers?: number | null;
|
|
2365
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
2366
|
+
turnstileMode?:
|
|
2367
|
+
| "off"
|
|
2368
|
+
| "invisible"
|
|
2369
|
+
| "visible_non_interactive"
|
|
2370
|
+
| "visible_managed"
|
|
2371
|
+
| null;
|
|
2372
|
+
}[];
|
|
2373
|
+
resultInfo: {
|
|
2374
|
+
count?: number | null;
|
|
2375
|
+
page?: number | null;
|
|
2376
|
+
perPage?: number | null;
|
|
2377
|
+
totalCount?: number | null;
|
|
2378
|
+
};
|
|
2379
|
+
}
|
|
2380
|
+
|
|
2381
|
+
export const ListWaitingRoomsResponse =
|
|
2382
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
2383
|
+
result: Schema.Array(
|
|
2384
|
+
Schema.Struct({
|
|
2385
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2386
|
+
additionalRoutes: Schema.optional(
|
|
2387
|
+
Schema.Union([
|
|
2388
|
+
Schema.Array(
|
|
2389
|
+
Schema.Struct({
|
|
2390
|
+
host: Schema.optional(
|
|
2391
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2392
|
+
),
|
|
2393
|
+
path: Schema.optional(
|
|
2394
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2395
|
+
),
|
|
2396
|
+
}),
|
|
2397
|
+
),
|
|
2398
|
+
Schema.Null,
|
|
2399
|
+
]),
|
|
2400
|
+
),
|
|
2401
|
+
cookieAttributes: Schema.optional(
|
|
2402
|
+
Schema.Union([
|
|
2403
|
+
Schema.Struct({
|
|
2404
|
+
samesite: Schema.optional(
|
|
2405
|
+
Schema.Union([
|
|
2406
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
2407
|
+
Schema.Null,
|
|
2408
|
+
]),
|
|
2409
|
+
),
|
|
2410
|
+
secure: Schema.optional(
|
|
2411
|
+
Schema.Union([
|
|
2412
|
+
Schema.Literals(["auto", "always", "never"]),
|
|
2413
|
+
Schema.Null,
|
|
2414
|
+
]),
|
|
2415
|
+
),
|
|
2416
|
+
}),
|
|
2417
|
+
Schema.Null,
|
|
2418
|
+
]),
|
|
2419
|
+
),
|
|
2420
|
+
cookieSuffix: Schema.optional(
|
|
2421
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2422
|
+
),
|
|
2423
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2424
|
+
customPageHtml: Schema.optional(
|
|
2425
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2426
|
+
),
|
|
2427
|
+
defaultTemplateLanguage: Schema.optional(
|
|
2428
|
+
Schema.Union([
|
|
2429
|
+
Schema.Literals([
|
|
2430
|
+
"en-US",
|
|
2431
|
+
"es-ES",
|
|
2432
|
+
"de-DE",
|
|
2433
|
+
"fr-FR",
|
|
2434
|
+
"it-IT",
|
|
2435
|
+
"ja-JP",
|
|
2436
|
+
"ko-KR",
|
|
2437
|
+
"pt-BR",
|
|
2438
|
+
"zh-CN",
|
|
2439
|
+
"zh-TW",
|
|
2440
|
+
"nl-NL",
|
|
2441
|
+
"pl-PL",
|
|
2442
|
+
"id-ID",
|
|
2443
|
+
"tr-TR",
|
|
2444
|
+
"ar-EG",
|
|
2445
|
+
"ru-RU",
|
|
2446
|
+
"fa-IR",
|
|
2447
|
+
"bg-BG",
|
|
2448
|
+
"hr-HR",
|
|
2449
|
+
"cs-CZ",
|
|
2450
|
+
"da-DK",
|
|
2451
|
+
"fi-FI",
|
|
2452
|
+
"lt-LT",
|
|
2453
|
+
"ms-MY",
|
|
2454
|
+
"nb-NO",
|
|
2455
|
+
"ro-RO",
|
|
2456
|
+
"el-GR",
|
|
2457
|
+
"he-IL",
|
|
2458
|
+
"hi-IN",
|
|
2459
|
+
"hu-HU",
|
|
2460
|
+
"sr-BA",
|
|
2461
|
+
"sk-SK",
|
|
2462
|
+
"sl-SI",
|
|
2463
|
+
"sv-SE",
|
|
2464
|
+
"tl-PH",
|
|
2465
|
+
"th-TH",
|
|
2466
|
+
"uk-UA",
|
|
2467
|
+
"vi-VN",
|
|
2468
|
+
]),
|
|
2469
|
+
Schema.Null,
|
|
2470
|
+
]),
|
|
2471
|
+
),
|
|
2472
|
+
description: Schema.optional(
|
|
2473
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2474
|
+
),
|
|
2475
|
+
disableSessionRenewal: Schema.optional(
|
|
2476
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
2477
|
+
),
|
|
2478
|
+
enabledOriginCommands: Schema.optional(
|
|
2479
|
+
Schema.Union([Schema.Array(Schema.Literal("revoke")), Schema.Null]),
|
|
2480
|
+
),
|
|
2481
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2482
|
+
jsonResponseEnabled: Schema.optional(
|
|
2483
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
2484
|
+
),
|
|
2485
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2486
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2487
|
+
newUsersPerMinute: Schema.optional(
|
|
2488
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
2489
|
+
),
|
|
2490
|
+
nextEventPrequeueStartTime: Schema.optional(
|
|
2491
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2492
|
+
),
|
|
2493
|
+
nextEventStartTime: Schema.optional(
|
|
2494
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
2495
|
+
),
|
|
2496
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
2497
|
+
queueAll: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
2498
|
+
queueingMethod: Schema.optional(
|
|
2499
|
+
Schema.Union([
|
|
2500
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
2501
|
+
Schema.Null,
|
|
2502
|
+
]),
|
|
2503
|
+
),
|
|
2504
|
+
queueingStatusCode: Schema.optional(
|
|
2505
|
+
Schema.Union([Schema.Literals(["200", "202", "429"]), Schema.Null]),
|
|
2506
|
+
),
|
|
2507
|
+
sessionDuration: Schema.optional(
|
|
2508
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
2509
|
+
),
|
|
2510
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
2511
|
+
totalActiveUsers: Schema.optional(
|
|
2512
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
2513
|
+
),
|
|
2514
|
+
turnstileAction: Schema.optional(
|
|
2515
|
+
Schema.Union([
|
|
2516
|
+
Schema.Literals(["log", "infinite_queue"]),
|
|
2517
|
+
Schema.Null,
|
|
2518
|
+
]),
|
|
2519
|
+
),
|
|
2520
|
+
turnstileMode: Schema.optional(
|
|
2521
|
+
Schema.Union([
|
|
2522
|
+
Schema.Literals([
|
|
2523
|
+
"off",
|
|
2524
|
+
"invisible",
|
|
2525
|
+
"visible_non_interactive",
|
|
2526
|
+
"visible_managed",
|
|
2527
|
+
]),
|
|
2528
|
+
Schema.Null,
|
|
2529
|
+
]),
|
|
2530
|
+
),
|
|
2531
|
+
}).pipe(
|
|
2532
|
+
Schema.encodeKeys({
|
|
2533
|
+
id: "id",
|
|
2534
|
+
additionalRoutes: "additional_routes",
|
|
2535
|
+
cookieAttributes: "cookie_attributes",
|
|
2536
|
+
cookieSuffix: "cookie_suffix",
|
|
2537
|
+
createdOn: "created_on",
|
|
2538
|
+
customPageHtml: "custom_page_html",
|
|
2539
|
+
defaultTemplateLanguage: "default_template_language",
|
|
2540
|
+
description: "description",
|
|
2541
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
2542
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
2543
|
+
host: "host",
|
|
2544
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
2545
|
+
modifiedOn: "modified_on",
|
|
2546
|
+
name: "name",
|
|
2547
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
2548
|
+
nextEventPrequeueStartTime: "next_event_prequeue_start_time",
|
|
2549
|
+
nextEventStartTime: "next_event_start_time",
|
|
2550
|
+
path: "path",
|
|
2551
|
+
queueAll: "queue_all",
|
|
2552
|
+
queueingMethod: "queueing_method",
|
|
2553
|
+
queueingStatusCode: "queueing_status_code",
|
|
2554
|
+
sessionDuration: "session_duration",
|
|
2555
|
+
suspended: "suspended",
|
|
2556
|
+
totalActiveUsers: "total_active_users",
|
|
2557
|
+
turnstileAction: "turnstile_action",
|
|
2558
|
+
turnstileMode: "turnstile_mode",
|
|
2559
|
+
}),
|
|
2560
|
+
),
|
|
2561
|
+
),
|
|
2562
|
+
resultInfo: Schema.Struct({
|
|
2563
|
+
count: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
2564
|
+
page: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
2565
|
+
perPage: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
2566
|
+
totalCount: Schema.optional(Schema.Union([Schema.Number, Schema.Null])),
|
|
2567
|
+
}).pipe(
|
|
2568
|
+
Schema.encodeKeys({
|
|
2569
|
+
count: "count",
|
|
2570
|
+
page: "page",
|
|
2571
|
+
perPage: "per_page",
|
|
2572
|
+
totalCount: "total_count",
|
|
2573
|
+
}),
|
|
2574
|
+
),
|
|
2575
|
+
}).pipe(
|
|
2576
|
+
Schema.encodeKeys({ result: "result", resultInfo: "result_info" }),
|
|
2577
|
+
) as unknown as Schema.Schema<ListWaitingRoomsResponse>;
|
|
2578
|
+
|
|
2579
|
+
export type ListWaitingRoomsError = DefaultErrors;
|
|
2580
|
+
|
|
2581
|
+
export const listWaitingRooms: API.PaginatedOperationMethod<
|
|
2582
|
+
ListWaitingRoomsRequest,
|
|
2583
|
+
ListWaitingRoomsResponse,
|
|
2584
|
+
ListWaitingRoomsError,
|
|
2585
|
+
Credentials | HttpClient.HttpClient
|
|
2586
|
+
> & {
|
|
2587
|
+
pages: (
|
|
2588
|
+
input: ListWaitingRoomsRequest,
|
|
2589
|
+
) => stream.Stream<
|
|
2590
|
+
ListWaitingRoomsResponse,
|
|
2591
|
+
ListWaitingRoomsError,
|
|
2592
|
+
Credentials | HttpClient.HttpClient
|
|
2593
|
+
>;
|
|
2594
|
+
items: (input: ListWaitingRoomsRequest) => stream.Stream<
|
|
2595
|
+
{
|
|
2596
|
+
id?: string | null;
|
|
2597
|
+
additionalRoutes?:
|
|
2598
|
+
| { host?: string | null; path?: string | null }[]
|
|
2599
|
+
| null;
|
|
2600
|
+
cookieAttributes?: {
|
|
2601
|
+
samesite?: "auto" | "lax" | "none" | "strict" | null;
|
|
2602
|
+
secure?: "auto" | "always" | "never" | null;
|
|
2603
|
+
} | null;
|
|
2604
|
+
cookieSuffix?: string | null;
|
|
2605
|
+
createdOn?: string | null;
|
|
2606
|
+
customPageHtml?: string | null;
|
|
2607
|
+
defaultTemplateLanguage?:
|
|
2608
|
+
| "en-US"
|
|
2609
|
+
| "es-ES"
|
|
2610
|
+
| "de-DE"
|
|
2611
|
+
| "fr-FR"
|
|
2612
|
+
| "it-IT"
|
|
2613
|
+
| "ja-JP"
|
|
2614
|
+
| "ko-KR"
|
|
2615
|
+
| "pt-BR"
|
|
2616
|
+
| "zh-CN"
|
|
2617
|
+
| "zh-TW"
|
|
2618
|
+
| "nl-NL"
|
|
2619
|
+
| "pl-PL"
|
|
2620
|
+
| "id-ID"
|
|
2621
|
+
| "tr-TR"
|
|
2622
|
+
| "ar-EG"
|
|
2623
|
+
| "ru-RU"
|
|
2624
|
+
| "fa-IR"
|
|
2625
|
+
| "bg-BG"
|
|
2626
|
+
| "hr-HR"
|
|
2627
|
+
| "cs-CZ"
|
|
2628
|
+
| "da-DK"
|
|
2629
|
+
| "fi-FI"
|
|
2630
|
+
| "lt-LT"
|
|
2631
|
+
| "ms-MY"
|
|
2632
|
+
| "nb-NO"
|
|
2633
|
+
| "ro-RO"
|
|
2634
|
+
| "el-GR"
|
|
2635
|
+
| "he-IL"
|
|
2636
|
+
| "hi-IN"
|
|
2637
|
+
| "hu-HU"
|
|
2638
|
+
| "sr-BA"
|
|
2639
|
+
| "sk-SK"
|
|
2640
|
+
| "sl-SI"
|
|
2641
|
+
| "sv-SE"
|
|
2642
|
+
| "tl-PH"
|
|
2643
|
+
| "th-TH"
|
|
2644
|
+
| "uk-UA"
|
|
2645
|
+
| "vi-VN"
|
|
2646
|
+
| null;
|
|
2647
|
+
description?: string | null;
|
|
2648
|
+
disableSessionRenewal?: boolean | null;
|
|
2649
|
+
enabledOriginCommands?: "revoke"[] | null;
|
|
2650
|
+
host?: string | null;
|
|
2651
|
+
jsonResponseEnabled?: boolean | null;
|
|
2652
|
+
modifiedOn?: string | null;
|
|
2653
|
+
name?: string | null;
|
|
2654
|
+
newUsersPerMinute?: number | null;
|
|
2655
|
+
nextEventPrequeueStartTime?: string | null;
|
|
2656
|
+
nextEventStartTime?: string | null;
|
|
2657
|
+
path?: string | null;
|
|
2658
|
+
queueAll?: boolean | null;
|
|
2659
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject" | null;
|
|
2660
|
+
queueingStatusCode?: "200" | "202" | "429" | null;
|
|
2661
|
+
sessionDuration?: number | null;
|
|
2662
|
+
suspended?: boolean | null;
|
|
2663
|
+
totalActiveUsers?: number | null;
|
|
2664
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
2665
|
+
turnstileMode?:
|
|
2666
|
+
| "off"
|
|
2667
|
+
| "invisible"
|
|
2668
|
+
| "visible_non_interactive"
|
|
2669
|
+
| "visible_managed"
|
|
2670
|
+
| null;
|
|
2671
|
+
},
|
|
2672
|
+
ListWaitingRoomsError,
|
|
2673
|
+
Credentials | HttpClient.HttpClient
|
|
2674
|
+
>;
|
|
2675
|
+
} = /*@__PURE__*/ /*#__PURE__*/ API.makePaginated(() => ({
|
|
2676
|
+
input: ListWaitingRoomsRequest,
|
|
2677
|
+
output: ListWaitingRoomsResponse,
|
|
2678
|
+
errors: [],
|
|
2679
|
+
pagination: {
|
|
2680
|
+
mode: "page",
|
|
2681
|
+
inputToken: "page",
|
|
2682
|
+
outputToken: "resultInfo.page",
|
|
2683
|
+
items: "result",
|
|
2684
|
+
pageSize: "perPage",
|
|
2685
|
+
} as const,
|
|
2686
|
+
}));
|
|
2687
|
+
|
|
2688
|
+
export interface CreateWaitingRoomRequest {
|
|
2689
|
+
/** Path param: Identifier. */
|
|
2690
|
+
zoneId: string;
|
|
2691
|
+
/** Body param: The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
2692
|
+
host: string;
|
|
2693
|
+
/** Body param: A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
2694
|
+
name: string;
|
|
2695
|
+
/** Body param: Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there i */
|
|
2696
|
+
newUsersPerMinute: number;
|
|
2697
|
+
/** Body param: Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a basel */
|
|
2698
|
+
totalActiveUsers: number;
|
|
2699
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of */
|
|
2700
|
+
additionalRoutes?: { host?: string; path?: string }[];
|
|
2701
|
+
/** Body param: Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
2702
|
+
cookieAttributes?: {
|
|
2703
|
+
samesite?: "auto" | "lax" | "none" | "strict";
|
|
2704
|
+
secure?: "auto" | "always" | "never";
|
|
2705
|
+
};
|
|
2706
|
+
/** Body param: Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This */
|
|
2707
|
+
cookieSuffix?: string;
|
|
2708
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will */
|
|
2709
|
+
customPageHtml?: string;
|
|
2710
|
+
/** Body param: The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
2711
|
+
defaultTemplateLanguage?:
|
|
2712
|
+
| "en-US"
|
|
2713
|
+
| "es-ES"
|
|
2714
|
+
| "de-DE"
|
|
2715
|
+
| "fr-FR"
|
|
2716
|
+
| "it-IT"
|
|
2717
|
+
| "ja-JP"
|
|
2718
|
+
| "ko-KR"
|
|
2719
|
+
| "pt-BR"
|
|
2720
|
+
| "zh-CN"
|
|
2721
|
+
| "zh-TW"
|
|
2722
|
+
| "nl-NL"
|
|
2723
|
+
| "pl-PL"
|
|
2724
|
+
| "id-ID"
|
|
2725
|
+
| "tr-TR"
|
|
2726
|
+
| "ar-EG"
|
|
2727
|
+
| "ru-RU"
|
|
2728
|
+
| "fa-IR"
|
|
2729
|
+
| "bg-BG"
|
|
2730
|
+
| "hr-HR"
|
|
2731
|
+
| "cs-CZ"
|
|
2732
|
+
| "da-DK"
|
|
2733
|
+
| "fi-FI"
|
|
2734
|
+
| "lt-LT"
|
|
2735
|
+
| "ms-MY"
|
|
2736
|
+
| "nb-NO"
|
|
2737
|
+
| "ro-RO"
|
|
2738
|
+
| "el-GR"
|
|
2739
|
+
| "he-IL"
|
|
2740
|
+
| "hi-IN"
|
|
2741
|
+
| "hu-HU"
|
|
2742
|
+
| "sr-BA"
|
|
2743
|
+
| "sk-SK"
|
|
2744
|
+
| "sl-SI"
|
|
2745
|
+
| "sv-SE"
|
|
2746
|
+
| "tl-PH"
|
|
2747
|
+
| "th-TH"
|
|
2748
|
+
| "uk-UA"
|
|
2749
|
+
| "vi-VN";
|
|
2750
|
+
/** Body param: A note that you can use to add more details about the waiting room. */
|
|
2751
|
+
description?: string;
|
|
2752
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. */
|
|
2753
|
+
disableSessionRenewal?: boolean;
|
|
2754
|
+
/** Body param: A list of enabled origin commands. */
|
|
2755
|
+
enabledOriginCommands?: "revoke"[];
|
|
2756
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with infor */
|
|
2757
|
+
jsonResponseEnabled?: boolean;
|
|
2758
|
+
/** Body param: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room */
|
|
2759
|
+
path?: string;
|
|
2760
|
+
/** Body param: If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will becom */
|
|
2761
|
+
queueAll?: boolean;
|
|
2762
|
+
/** Body param: Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of th */
|
|
2763
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject";
|
|
2764
|
+
/** Body param: HTTP status code returned to a user while in the queue. */
|
|
2765
|
+
queueingStatusCode?: "200" | "202" | "429";
|
|
2766
|
+
/** Body param: Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user */
|
|
2767
|
+
sessionDuration?: number;
|
|
2768
|
+
/** Body param: Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
2769
|
+
suspended?: boolean;
|
|
2770
|
+
/** Body param: Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. ` */
|
|
2771
|
+
turnstileAction?: "log" | "infinite_queue";
|
|
2772
|
+
/** Body param: Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitio */
|
|
2773
|
+
turnstileMode?:
|
|
2774
|
+
| "off"
|
|
2775
|
+
| "invisible"
|
|
2776
|
+
| "visible_non_interactive"
|
|
2777
|
+
| "visible_managed";
|
|
2778
|
+
}
|
|
2779
|
+
|
|
2780
|
+
export const CreateWaitingRoomRequest =
|
|
2781
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
2782
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
2783
|
+
host: Schema.String,
|
|
2784
|
+
name: Schema.String,
|
|
2785
|
+
newUsersPerMinute: Schema.Number,
|
|
2786
|
+
totalActiveUsers: Schema.Number,
|
|
2787
|
+
additionalRoutes: Schema.optional(
|
|
2788
|
+
Schema.Array(
|
|
2789
|
+
Schema.Struct({
|
|
2790
|
+
host: Schema.optional(Schema.String),
|
|
2791
|
+
path: Schema.optional(Schema.String),
|
|
2792
|
+
}),
|
|
2793
|
+
),
|
|
2794
|
+
),
|
|
2795
|
+
cookieAttributes: Schema.optional(
|
|
2796
|
+
Schema.Struct({
|
|
2797
|
+
samesite: Schema.optional(
|
|
2798
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
2799
|
+
),
|
|
2800
|
+
secure: Schema.optional(Schema.Literals(["auto", "always", "never"])),
|
|
2801
|
+
}),
|
|
2802
|
+
),
|
|
2803
|
+
cookieSuffix: Schema.optional(Schema.String),
|
|
2804
|
+
customPageHtml: Schema.optional(Schema.String),
|
|
2805
|
+
defaultTemplateLanguage: Schema.optional(
|
|
2806
|
+
Schema.Literals([
|
|
2807
|
+
"en-US",
|
|
2808
|
+
"es-ES",
|
|
2809
|
+
"de-DE",
|
|
2810
|
+
"fr-FR",
|
|
2811
|
+
"it-IT",
|
|
2812
|
+
"ja-JP",
|
|
2813
|
+
"ko-KR",
|
|
2814
|
+
"pt-BR",
|
|
2815
|
+
"zh-CN",
|
|
2816
|
+
"zh-TW",
|
|
2817
|
+
"nl-NL",
|
|
2818
|
+
"pl-PL",
|
|
2819
|
+
"id-ID",
|
|
2820
|
+
"tr-TR",
|
|
2821
|
+
"ar-EG",
|
|
2822
|
+
"ru-RU",
|
|
2823
|
+
"fa-IR",
|
|
2824
|
+
"bg-BG",
|
|
2825
|
+
"hr-HR",
|
|
2826
|
+
"cs-CZ",
|
|
2827
|
+
"da-DK",
|
|
2828
|
+
"fi-FI",
|
|
2829
|
+
"lt-LT",
|
|
2830
|
+
"ms-MY",
|
|
2831
|
+
"nb-NO",
|
|
2832
|
+
"ro-RO",
|
|
2833
|
+
"el-GR",
|
|
2834
|
+
"he-IL",
|
|
2835
|
+
"hi-IN",
|
|
2836
|
+
"hu-HU",
|
|
2837
|
+
"sr-BA",
|
|
2838
|
+
"sk-SK",
|
|
2839
|
+
"sl-SI",
|
|
2840
|
+
"sv-SE",
|
|
2841
|
+
"tl-PH",
|
|
2842
|
+
"th-TH",
|
|
2843
|
+
"uk-UA",
|
|
2844
|
+
"vi-VN",
|
|
2845
|
+
]),
|
|
2846
|
+
),
|
|
2847
|
+
description: Schema.optional(Schema.String),
|
|
2848
|
+
disableSessionRenewal: Schema.optional(Schema.Boolean),
|
|
2849
|
+
enabledOriginCommands: Schema.optional(
|
|
2850
|
+
Schema.Array(Schema.Literal("revoke")),
|
|
2851
|
+
),
|
|
2852
|
+
jsonResponseEnabled: Schema.optional(Schema.Boolean),
|
|
2853
|
+
path: Schema.optional(Schema.String),
|
|
2854
|
+
queueAll: Schema.optional(Schema.Boolean),
|
|
2855
|
+
queueingMethod: Schema.optional(
|
|
2856
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
2857
|
+
),
|
|
2858
|
+
queueingStatusCode: Schema.optional(Schema.Literals(["200", "202", "429"])),
|
|
2859
|
+
sessionDuration: Schema.optional(Schema.Number),
|
|
2860
|
+
suspended: Schema.optional(Schema.Boolean),
|
|
2861
|
+
turnstileAction: Schema.optional(
|
|
2862
|
+
Schema.Literals(["log", "infinite_queue"]),
|
|
2863
|
+
),
|
|
2864
|
+
turnstileMode: Schema.optional(
|
|
2865
|
+
Schema.Literals([
|
|
2866
|
+
"off",
|
|
2867
|
+
"invisible",
|
|
2868
|
+
"visible_non_interactive",
|
|
2869
|
+
"visible_managed",
|
|
2870
|
+
]),
|
|
2871
|
+
),
|
|
2872
|
+
}).pipe(
|
|
2873
|
+
Schema.encodeKeys({
|
|
2874
|
+
host: "host",
|
|
2875
|
+
name: "name",
|
|
2876
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
2877
|
+
totalActiveUsers: "total_active_users",
|
|
2878
|
+
additionalRoutes: "additional_routes",
|
|
2879
|
+
cookieAttributes: "cookie_attributes",
|
|
2880
|
+
cookieSuffix: "cookie_suffix",
|
|
2881
|
+
customPageHtml: "custom_page_html",
|
|
2882
|
+
defaultTemplateLanguage: "default_template_language",
|
|
2883
|
+
description: "description",
|
|
2884
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
2885
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
2886
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
2887
|
+
path: "path",
|
|
2888
|
+
queueAll: "queue_all",
|
|
2889
|
+
queueingMethod: "queueing_method",
|
|
2890
|
+
queueingStatusCode: "queueing_status_code",
|
|
2891
|
+
sessionDuration: "session_duration",
|
|
2892
|
+
suspended: "suspended",
|
|
2893
|
+
turnstileAction: "turnstile_action",
|
|
2894
|
+
turnstileMode: "turnstile_mode",
|
|
2895
|
+
}),
|
|
2896
|
+
T.Http({ method: "POST", path: "/zones/{zone_id}/waiting_rooms" }),
|
|
2897
|
+
) as unknown as Schema.Schema<CreateWaitingRoomRequest>;
|
|
2898
|
+
|
|
2899
|
+
export interface CreateWaitingRoomResponse {
|
|
2900
|
+
id?: string | null;
|
|
2901
|
+
/** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. Th */
|
|
2902
|
+
additionalRoutes?: { host?: string | null; path?: string | null }[] | null;
|
|
2903
|
+
/** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
2904
|
+
cookieAttributes?: {
|
|
2905
|
+
samesite?: "auto" | "lax" | "none" | "strict" | null;
|
|
2906
|
+
secure?: "auto" | "always" | "never" | null;
|
|
2907
|
+
} | null;
|
|
2908
|
+
/** Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This field is req */
|
|
2909
|
+
cookieSuffix?: string | null;
|
|
2910
|
+
createdOn?: string | null;
|
|
2911
|
+
/** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. Th */
|
|
2912
|
+
customPageHtml?: string | null;
|
|
2913
|
+
/** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
2914
|
+
defaultTemplateLanguage?:
|
|
2915
|
+
| "en-US"
|
|
2916
|
+
| "es-ES"
|
|
2917
|
+
| "de-DE"
|
|
2918
|
+
| "fr-FR"
|
|
2919
|
+
| "it-IT"
|
|
2920
|
+
| "ja-JP"
|
|
2921
|
+
| "ko-KR"
|
|
2922
|
+
| "pt-BR"
|
|
2923
|
+
| "zh-CN"
|
|
2924
|
+
| "zh-TW"
|
|
2925
|
+
| "nl-NL"
|
|
2926
|
+
| "pl-PL"
|
|
2927
|
+
| "id-ID"
|
|
2928
|
+
| "tr-TR"
|
|
2929
|
+
| "ar-EG"
|
|
2930
|
+
| "ru-RU"
|
|
2931
|
+
| "fa-IR"
|
|
2932
|
+
| "bg-BG"
|
|
2933
|
+
| "hr-HR"
|
|
2934
|
+
| "cs-CZ"
|
|
2935
|
+
| "da-DK"
|
|
2936
|
+
| "fi-FI"
|
|
2937
|
+
| "lt-LT"
|
|
2938
|
+
| "ms-MY"
|
|
2939
|
+
| "nb-NO"
|
|
2940
|
+
| "ro-RO"
|
|
2941
|
+
| "el-GR"
|
|
2942
|
+
| "he-IL"
|
|
2943
|
+
| "hi-IN"
|
|
2944
|
+
| "hu-HU"
|
|
2945
|
+
| "sr-BA"
|
|
2946
|
+
| "sk-SK"
|
|
2947
|
+
| "sl-SI"
|
|
2948
|
+
| "sv-SE"
|
|
2949
|
+
| "tl-PH"
|
|
2950
|
+
| "th-TH"
|
|
2951
|
+
| "uk-UA"
|
|
2952
|
+
| "vi-VN"
|
|
2953
|
+
| null;
|
|
2954
|
+
/** A note that you can use to add more details about the waiting room. */
|
|
2955
|
+
description?: string | null;
|
|
2956
|
+
/** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, */
|
|
2957
|
+
disableSessionRenewal?: boolean | null;
|
|
2958
|
+
/** A list of enabled origin commands. */
|
|
2959
|
+
enabledOriginCommands?: "revoke"[] | null;
|
|
2960
|
+
/** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
2961
|
+
host?: string | null;
|
|
2962
|
+
/** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on th */
|
|
2963
|
+
jsonResponseEnabled?: boolean | null;
|
|
2964
|
+
modifiedOn?: string | null;
|
|
2965
|
+
/** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
2966
|
+
name?: string | null;
|
|
2967
|
+
/** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little m */
|
|
2968
|
+
newUsersPerMinute?: number | null;
|
|
2969
|
+
/** An ISO 8601 timestamp that marks when the next event will begin queueing. */
|
|
2970
|
+
nextEventPrequeueStartTime?: string | null;
|
|
2971
|
+
/** An ISO 8601 timestamp that marks when the next event will start. */
|
|
2972
|
+
nextEventStartTime?: string | null;
|
|
2973
|
+
/** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the mos */
|
|
2974
|
+
path?: string | null;
|
|
2975
|
+
/** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailabl */
|
|
2976
|
+
queueAll?: boolean | null;
|
|
2977
|
+
/** Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing m */
|
|
2978
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject" | null;
|
|
2979
|
+
/** HTTP status code returned to a user while in the queue. */
|
|
2980
|
+
queueingStatusCode?: "200" | "202" | "429" | null;
|
|
2981
|
+
/** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits */
|
|
2982
|
+
sessionDuration?: number | null;
|
|
2983
|
+
/** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
2984
|
+
suspended?: boolean | null;
|
|
2985
|
+
/** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the */
|
|
2986
|
+
totalActiveUsers?: number | null;
|
|
2987
|
+
/** Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. `infinite_que */
|
|
2988
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
2989
|
+
/** Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitions of these */
|
|
2990
|
+
turnstileMode?:
|
|
2991
|
+
| "off"
|
|
2992
|
+
| "invisible"
|
|
2993
|
+
| "visible_non_interactive"
|
|
2994
|
+
| "visible_managed"
|
|
2995
|
+
| null;
|
|
2996
|
+
}
|
|
2997
|
+
|
|
2998
|
+
export const CreateWaitingRoomResponse =
|
|
2999
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
3000
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3001
|
+
additionalRoutes: Schema.optional(
|
|
3002
|
+
Schema.Union([
|
|
3003
|
+
Schema.Array(
|
|
3004
|
+
Schema.Struct({
|
|
3005
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3006
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3007
|
+
}),
|
|
3008
|
+
),
|
|
3009
|
+
Schema.Null,
|
|
3010
|
+
]),
|
|
3011
|
+
),
|
|
3012
|
+
cookieAttributes: Schema.optional(
|
|
3013
|
+
Schema.Union([
|
|
3014
|
+
Schema.Struct({
|
|
3015
|
+
samesite: Schema.optional(
|
|
3016
|
+
Schema.Union([
|
|
3017
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
3018
|
+
Schema.Null,
|
|
3019
|
+
]),
|
|
3020
|
+
),
|
|
3021
|
+
secure: Schema.optional(
|
|
3022
|
+
Schema.Union([
|
|
3023
|
+
Schema.Literals(["auto", "always", "never"]),
|
|
3024
|
+
Schema.Null,
|
|
3025
|
+
]),
|
|
3026
|
+
),
|
|
3027
|
+
}),
|
|
3028
|
+
Schema.Null,
|
|
3029
|
+
]),
|
|
3030
|
+
),
|
|
3031
|
+
cookieSuffix: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3032
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3033
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3034
|
+
defaultTemplateLanguage: Schema.optional(
|
|
3035
|
+
Schema.Union([
|
|
3036
|
+
Schema.Literals([
|
|
3037
|
+
"en-US",
|
|
3038
|
+
"es-ES",
|
|
3039
|
+
"de-DE",
|
|
3040
|
+
"fr-FR",
|
|
3041
|
+
"it-IT",
|
|
3042
|
+
"ja-JP",
|
|
3043
|
+
"ko-KR",
|
|
3044
|
+
"pt-BR",
|
|
3045
|
+
"zh-CN",
|
|
3046
|
+
"zh-TW",
|
|
3047
|
+
"nl-NL",
|
|
3048
|
+
"pl-PL",
|
|
3049
|
+
"id-ID",
|
|
3050
|
+
"tr-TR",
|
|
3051
|
+
"ar-EG",
|
|
3052
|
+
"ru-RU",
|
|
3053
|
+
"fa-IR",
|
|
3054
|
+
"bg-BG",
|
|
3055
|
+
"hr-HR",
|
|
3056
|
+
"cs-CZ",
|
|
3057
|
+
"da-DK",
|
|
3058
|
+
"fi-FI",
|
|
3059
|
+
"lt-LT",
|
|
3060
|
+
"ms-MY",
|
|
3061
|
+
"nb-NO",
|
|
3062
|
+
"ro-RO",
|
|
3063
|
+
"el-GR",
|
|
3064
|
+
"he-IL",
|
|
3065
|
+
"hi-IN",
|
|
3066
|
+
"hu-HU",
|
|
3067
|
+
"sr-BA",
|
|
3068
|
+
"sk-SK",
|
|
3069
|
+
"sl-SI",
|
|
3070
|
+
"sv-SE",
|
|
3071
|
+
"tl-PH",
|
|
3072
|
+
"th-TH",
|
|
3073
|
+
"uk-UA",
|
|
3074
|
+
"vi-VN",
|
|
3075
|
+
]),
|
|
3076
|
+
Schema.Null,
|
|
3077
|
+
]),
|
|
3078
|
+
),
|
|
3079
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3080
|
+
disableSessionRenewal: Schema.optional(
|
|
3081
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
3082
|
+
),
|
|
3083
|
+
enabledOriginCommands: Schema.optional(
|
|
3084
|
+
Schema.Union([Schema.Array(Schema.Literal("revoke")), Schema.Null]),
|
|
3085
|
+
),
|
|
3086
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3087
|
+
jsonResponseEnabled: Schema.optional(
|
|
3088
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
3089
|
+
),
|
|
3090
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3091
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3092
|
+
newUsersPerMinute: Schema.optional(
|
|
3093
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
3094
|
+
),
|
|
3095
|
+
nextEventPrequeueStartTime: Schema.optional(
|
|
3096
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
3097
|
+
),
|
|
3098
|
+
nextEventStartTime: Schema.optional(
|
|
3099
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
3100
|
+
),
|
|
3101
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3102
|
+
queueAll: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
3103
|
+
queueingMethod: Schema.optional(
|
|
3104
|
+
Schema.Union([
|
|
3105
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
3106
|
+
Schema.Null,
|
|
3107
|
+
]),
|
|
3108
|
+
),
|
|
3109
|
+
queueingStatusCode: Schema.optional(
|
|
3110
|
+
Schema.Union([Schema.Literals(["200", "202", "429"]), Schema.Null]),
|
|
3111
|
+
),
|
|
3112
|
+
sessionDuration: Schema.optional(
|
|
3113
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
3114
|
+
),
|
|
3115
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
3116
|
+
totalActiveUsers: Schema.optional(
|
|
3117
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
3118
|
+
),
|
|
3119
|
+
turnstileAction: Schema.optional(
|
|
3120
|
+
Schema.Union([Schema.Literals(["log", "infinite_queue"]), Schema.Null]),
|
|
3121
|
+
),
|
|
3122
|
+
turnstileMode: Schema.optional(
|
|
3123
|
+
Schema.Union([
|
|
3124
|
+
Schema.Literals([
|
|
3125
|
+
"off",
|
|
3126
|
+
"invisible",
|
|
3127
|
+
"visible_non_interactive",
|
|
3128
|
+
"visible_managed",
|
|
3129
|
+
]),
|
|
3130
|
+
Schema.Null,
|
|
3131
|
+
]),
|
|
3132
|
+
),
|
|
3133
|
+
})
|
|
3134
|
+
.pipe(
|
|
3135
|
+
Schema.encodeKeys({
|
|
3136
|
+
id: "id",
|
|
3137
|
+
additionalRoutes: "additional_routes",
|
|
3138
|
+
cookieAttributes: "cookie_attributes",
|
|
3139
|
+
cookieSuffix: "cookie_suffix",
|
|
3140
|
+
createdOn: "created_on",
|
|
3141
|
+
customPageHtml: "custom_page_html",
|
|
3142
|
+
defaultTemplateLanguage: "default_template_language",
|
|
3143
|
+
description: "description",
|
|
3144
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
3145
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
3146
|
+
host: "host",
|
|
3147
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
3148
|
+
modifiedOn: "modified_on",
|
|
3149
|
+
name: "name",
|
|
3150
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
3151
|
+
nextEventPrequeueStartTime: "next_event_prequeue_start_time",
|
|
3152
|
+
nextEventStartTime: "next_event_start_time",
|
|
3153
|
+
path: "path",
|
|
3154
|
+
queueAll: "queue_all",
|
|
3155
|
+
queueingMethod: "queueing_method",
|
|
3156
|
+
queueingStatusCode: "queueing_status_code",
|
|
3157
|
+
sessionDuration: "session_duration",
|
|
3158
|
+
suspended: "suspended",
|
|
3159
|
+
totalActiveUsers: "total_active_users",
|
|
3160
|
+
turnstileAction: "turnstile_action",
|
|
3161
|
+
turnstileMode: "turnstile_mode",
|
|
3162
|
+
}),
|
|
3163
|
+
)
|
|
3164
|
+
.pipe(
|
|
3165
|
+
T.ResponsePath("result"),
|
|
3166
|
+
) as unknown as Schema.Schema<CreateWaitingRoomResponse>;
|
|
3167
|
+
|
|
3168
|
+
export type CreateWaitingRoomError = DefaultErrors;
|
|
3169
|
+
|
|
3170
|
+
export const createWaitingRoom: API.OperationMethod<
|
|
3171
|
+
CreateWaitingRoomRequest,
|
|
3172
|
+
CreateWaitingRoomResponse,
|
|
3173
|
+
CreateWaitingRoomError,
|
|
3174
|
+
Credentials | HttpClient.HttpClient
|
|
3175
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
3176
|
+
input: CreateWaitingRoomRequest,
|
|
3177
|
+
output: CreateWaitingRoomResponse,
|
|
3178
|
+
errors: [],
|
|
3179
|
+
}));
|
|
3180
|
+
|
|
3181
|
+
export interface UpdateWaitingRoomRequest {
|
|
3182
|
+
waitingRoomId: string;
|
|
3183
|
+
/** Path param: Identifier. */
|
|
3184
|
+
zoneId: string;
|
|
3185
|
+
/** Body param: The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
3186
|
+
host: string;
|
|
3187
|
+
/** Body param: A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
3188
|
+
name: string;
|
|
3189
|
+
/** Body param: Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there i */
|
|
3190
|
+
newUsersPerMinute: number;
|
|
3191
|
+
/** Body param: Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a basel */
|
|
3192
|
+
totalActiveUsers: number;
|
|
3193
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of */
|
|
3194
|
+
additionalRoutes?: { host?: string; path?: string }[];
|
|
3195
|
+
/** Body param: Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
3196
|
+
cookieAttributes?: {
|
|
3197
|
+
samesite?: "auto" | "lax" | "none" | "strict";
|
|
3198
|
+
secure?: "auto" | "always" | "never";
|
|
3199
|
+
};
|
|
3200
|
+
/** Body param: Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This */
|
|
3201
|
+
cookieSuffix?: string;
|
|
3202
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will */
|
|
3203
|
+
customPageHtml?: string;
|
|
3204
|
+
/** Body param: The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
3205
|
+
defaultTemplateLanguage?:
|
|
3206
|
+
| "en-US"
|
|
3207
|
+
| "es-ES"
|
|
3208
|
+
| "de-DE"
|
|
3209
|
+
| "fr-FR"
|
|
3210
|
+
| "it-IT"
|
|
3211
|
+
| "ja-JP"
|
|
3212
|
+
| "ko-KR"
|
|
3213
|
+
| "pt-BR"
|
|
3214
|
+
| "zh-CN"
|
|
3215
|
+
| "zh-TW"
|
|
3216
|
+
| "nl-NL"
|
|
3217
|
+
| "pl-PL"
|
|
3218
|
+
| "id-ID"
|
|
3219
|
+
| "tr-TR"
|
|
3220
|
+
| "ar-EG"
|
|
3221
|
+
| "ru-RU"
|
|
3222
|
+
| "fa-IR"
|
|
3223
|
+
| "bg-BG"
|
|
3224
|
+
| "hr-HR"
|
|
3225
|
+
| "cs-CZ"
|
|
3226
|
+
| "da-DK"
|
|
3227
|
+
| "fi-FI"
|
|
3228
|
+
| "lt-LT"
|
|
3229
|
+
| "ms-MY"
|
|
3230
|
+
| "nb-NO"
|
|
3231
|
+
| "ro-RO"
|
|
3232
|
+
| "el-GR"
|
|
3233
|
+
| "he-IL"
|
|
3234
|
+
| "hi-IN"
|
|
3235
|
+
| "hu-HU"
|
|
3236
|
+
| "sr-BA"
|
|
3237
|
+
| "sk-SK"
|
|
3238
|
+
| "sl-SI"
|
|
3239
|
+
| "sv-SE"
|
|
3240
|
+
| "tl-PH"
|
|
3241
|
+
| "th-TH"
|
|
3242
|
+
| "uk-UA"
|
|
3243
|
+
| "vi-VN";
|
|
3244
|
+
/** Body param: A note that you can use to add more details about the waiting room. */
|
|
3245
|
+
description?: string;
|
|
3246
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. */
|
|
3247
|
+
disableSessionRenewal?: boolean;
|
|
3248
|
+
/** Body param: A list of enabled origin commands. */
|
|
3249
|
+
enabledOriginCommands?: "revoke"[];
|
|
3250
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with infor */
|
|
3251
|
+
jsonResponseEnabled?: boolean;
|
|
3252
|
+
/** Body param: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room */
|
|
3253
|
+
path?: string;
|
|
3254
|
+
/** Body param: If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will becom */
|
|
3255
|
+
queueAll?: boolean;
|
|
3256
|
+
/** Body param: Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of th */
|
|
3257
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject";
|
|
3258
|
+
/** Body param: HTTP status code returned to a user while in the queue. */
|
|
3259
|
+
queueingStatusCode?: "200" | "202" | "429";
|
|
3260
|
+
/** Body param: Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user */
|
|
3261
|
+
sessionDuration?: number;
|
|
3262
|
+
/** Body param: Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
3263
|
+
suspended?: boolean;
|
|
3264
|
+
/** Body param: Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. ` */
|
|
3265
|
+
turnstileAction?: "log" | "infinite_queue";
|
|
3266
|
+
/** Body param: Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitio */
|
|
3267
|
+
turnstileMode?:
|
|
3268
|
+
| "off"
|
|
3269
|
+
| "invisible"
|
|
3270
|
+
| "visible_non_interactive"
|
|
3271
|
+
| "visible_managed";
|
|
3272
|
+
}
|
|
3273
|
+
|
|
3274
|
+
export const UpdateWaitingRoomRequest =
|
|
3275
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
3276
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
3277
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
3278
|
+
host: Schema.String,
|
|
3279
|
+
name: Schema.String,
|
|
3280
|
+
newUsersPerMinute: Schema.Number,
|
|
3281
|
+
totalActiveUsers: Schema.Number,
|
|
3282
|
+
additionalRoutes: Schema.optional(
|
|
3283
|
+
Schema.Array(
|
|
3284
|
+
Schema.Struct({
|
|
3285
|
+
host: Schema.optional(Schema.String),
|
|
3286
|
+
path: Schema.optional(Schema.String),
|
|
3287
|
+
}),
|
|
3288
|
+
),
|
|
3289
|
+
),
|
|
3290
|
+
cookieAttributes: Schema.optional(
|
|
3291
|
+
Schema.Struct({
|
|
3292
|
+
samesite: Schema.optional(
|
|
3293
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
3294
|
+
),
|
|
3295
|
+
secure: Schema.optional(Schema.Literals(["auto", "always", "never"])),
|
|
3296
|
+
}),
|
|
3297
|
+
),
|
|
3298
|
+
cookieSuffix: Schema.optional(Schema.String),
|
|
3299
|
+
customPageHtml: Schema.optional(Schema.String),
|
|
3300
|
+
defaultTemplateLanguage: Schema.optional(
|
|
3301
|
+
Schema.Literals([
|
|
3302
|
+
"en-US",
|
|
3303
|
+
"es-ES",
|
|
3304
|
+
"de-DE",
|
|
3305
|
+
"fr-FR",
|
|
3306
|
+
"it-IT",
|
|
3307
|
+
"ja-JP",
|
|
3308
|
+
"ko-KR",
|
|
3309
|
+
"pt-BR",
|
|
3310
|
+
"zh-CN",
|
|
3311
|
+
"zh-TW",
|
|
3312
|
+
"nl-NL",
|
|
3313
|
+
"pl-PL",
|
|
3314
|
+
"id-ID",
|
|
3315
|
+
"tr-TR",
|
|
3316
|
+
"ar-EG",
|
|
3317
|
+
"ru-RU",
|
|
3318
|
+
"fa-IR",
|
|
3319
|
+
"bg-BG",
|
|
3320
|
+
"hr-HR",
|
|
3321
|
+
"cs-CZ",
|
|
3322
|
+
"da-DK",
|
|
3323
|
+
"fi-FI",
|
|
3324
|
+
"lt-LT",
|
|
3325
|
+
"ms-MY",
|
|
3326
|
+
"nb-NO",
|
|
3327
|
+
"ro-RO",
|
|
3328
|
+
"el-GR",
|
|
3329
|
+
"he-IL",
|
|
3330
|
+
"hi-IN",
|
|
3331
|
+
"hu-HU",
|
|
3332
|
+
"sr-BA",
|
|
3333
|
+
"sk-SK",
|
|
3334
|
+
"sl-SI",
|
|
3335
|
+
"sv-SE",
|
|
3336
|
+
"tl-PH",
|
|
3337
|
+
"th-TH",
|
|
3338
|
+
"uk-UA",
|
|
3339
|
+
"vi-VN",
|
|
3340
|
+
]),
|
|
3341
|
+
),
|
|
3342
|
+
description: Schema.optional(Schema.String),
|
|
3343
|
+
disableSessionRenewal: Schema.optional(Schema.Boolean),
|
|
3344
|
+
enabledOriginCommands: Schema.optional(
|
|
3345
|
+
Schema.Array(Schema.Literal("revoke")),
|
|
3346
|
+
),
|
|
3347
|
+
jsonResponseEnabled: Schema.optional(Schema.Boolean),
|
|
3348
|
+
path: Schema.optional(Schema.String),
|
|
3349
|
+
queueAll: Schema.optional(Schema.Boolean),
|
|
3350
|
+
queueingMethod: Schema.optional(
|
|
3351
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
3352
|
+
),
|
|
3353
|
+
queueingStatusCode: Schema.optional(Schema.Literals(["200", "202", "429"])),
|
|
3354
|
+
sessionDuration: Schema.optional(Schema.Number),
|
|
3355
|
+
suspended: Schema.optional(Schema.Boolean),
|
|
3356
|
+
turnstileAction: Schema.optional(
|
|
3357
|
+
Schema.Literals(["log", "infinite_queue"]),
|
|
3358
|
+
),
|
|
3359
|
+
turnstileMode: Schema.optional(
|
|
3360
|
+
Schema.Literals([
|
|
3361
|
+
"off",
|
|
3362
|
+
"invisible",
|
|
3363
|
+
"visible_non_interactive",
|
|
3364
|
+
"visible_managed",
|
|
3365
|
+
]),
|
|
3366
|
+
),
|
|
3367
|
+
}).pipe(
|
|
3368
|
+
Schema.encodeKeys({
|
|
3369
|
+
host: "host",
|
|
3370
|
+
name: "name",
|
|
3371
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
3372
|
+
totalActiveUsers: "total_active_users",
|
|
3373
|
+
additionalRoutes: "additional_routes",
|
|
3374
|
+
cookieAttributes: "cookie_attributes",
|
|
3375
|
+
cookieSuffix: "cookie_suffix",
|
|
3376
|
+
customPageHtml: "custom_page_html",
|
|
3377
|
+
defaultTemplateLanguage: "default_template_language",
|
|
3378
|
+
description: "description",
|
|
3379
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
3380
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
3381
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
3382
|
+
path: "path",
|
|
3383
|
+
queueAll: "queue_all",
|
|
3384
|
+
queueingMethod: "queueing_method",
|
|
3385
|
+
queueingStatusCode: "queueing_status_code",
|
|
3386
|
+
sessionDuration: "session_duration",
|
|
3387
|
+
suspended: "suspended",
|
|
3388
|
+
turnstileAction: "turnstile_action",
|
|
3389
|
+
turnstileMode: "turnstile_mode",
|
|
3390
|
+
}),
|
|
3391
|
+
T.Http({
|
|
3392
|
+
method: "PUT",
|
|
3393
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}",
|
|
3394
|
+
}),
|
|
3395
|
+
) as unknown as Schema.Schema<UpdateWaitingRoomRequest>;
|
|
3396
|
+
|
|
3397
|
+
export interface UpdateWaitingRoomResponse {
|
|
3398
|
+
id?: string | null;
|
|
3399
|
+
/** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. Th */
|
|
3400
|
+
additionalRoutes?: { host?: string | null; path?: string | null }[] | null;
|
|
3401
|
+
/** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
3402
|
+
cookieAttributes?: {
|
|
3403
|
+
samesite?: "auto" | "lax" | "none" | "strict" | null;
|
|
3404
|
+
secure?: "auto" | "always" | "never" | null;
|
|
3405
|
+
} | null;
|
|
3406
|
+
/** Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This field is req */
|
|
3407
|
+
cookieSuffix?: string | null;
|
|
3408
|
+
createdOn?: string | null;
|
|
3409
|
+
/** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. Th */
|
|
3410
|
+
customPageHtml?: string | null;
|
|
3411
|
+
/** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
3412
|
+
defaultTemplateLanguage?:
|
|
3413
|
+
| "en-US"
|
|
3414
|
+
| "es-ES"
|
|
3415
|
+
| "de-DE"
|
|
3416
|
+
| "fr-FR"
|
|
3417
|
+
| "it-IT"
|
|
3418
|
+
| "ja-JP"
|
|
3419
|
+
| "ko-KR"
|
|
3420
|
+
| "pt-BR"
|
|
3421
|
+
| "zh-CN"
|
|
3422
|
+
| "zh-TW"
|
|
3423
|
+
| "nl-NL"
|
|
3424
|
+
| "pl-PL"
|
|
3425
|
+
| "id-ID"
|
|
3426
|
+
| "tr-TR"
|
|
3427
|
+
| "ar-EG"
|
|
3428
|
+
| "ru-RU"
|
|
3429
|
+
| "fa-IR"
|
|
3430
|
+
| "bg-BG"
|
|
3431
|
+
| "hr-HR"
|
|
3432
|
+
| "cs-CZ"
|
|
3433
|
+
| "da-DK"
|
|
3434
|
+
| "fi-FI"
|
|
3435
|
+
| "lt-LT"
|
|
3436
|
+
| "ms-MY"
|
|
3437
|
+
| "nb-NO"
|
|
3438
|
+
| "ro-RO"
|
|
3439
|
+
| "el-GR"
|
|
3440
|
+
| "he-IL"
|
|
3441
|
+
| "hi-IN"
|
|
3442
|
+
| "hu-HU"
|
|
3443
|
+
| "sr-BA"
|
|
3444
|
+
| "sk-SK"
|
|
3445
|
+
| "sl-SI"
|
|
3446
|
+
| "sv-SE"
|
|
3447
|
+
| "tl-PH"
|
|
3448
|
+
| "th-TH"
|
|
3449
|
+
| "uk-UA"
|
|
3450
|
+
| "vi-VN"
|
|
3451
|
+
| null;
|
|
3452
|
+
/** A note that you can use to add more details about the waiting room. */
|
|
3453
|
+
description?: string | null;
|
|
3454
|
+
/** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, */
|
|
3455
|
+
disableSessionRenewal?: boolean | null;
|
|
3456
|
+
/** A list of enabled origin commands. */
|
|
3457
|
+
enabledOriginCommands?: "revoke"[] | null;
|
|
3458
|
+
/** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
3459
|
+
host?: string | null;
|
|
3460
|
+
/** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on th */
|
|
3461
|
+
jsonResponseEnabled?: boolean | null;
|
|
3462
|
+
modifiedOn?: string | null;
|
|
3463
|
+
/** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
3464
|
+
name?: string | null;
|
|
3465
|
+
/** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little m */
|
|
3466
|
+
newUsersPerMinute?: number | null;
|
|
3467
|
+
/** An ISO 8601 timestamp that marks when the next event will begin queueing. */
|
|
3468
|
+
nextEventPrequeueStartTime?: string | null;
|
|
3469
|
+
/** An ISO 8601 timestamp that marks when the next event will start. */
|
|
3470
|
+
nextEventStartTime?: string | null;
|
|
3471
|
+
/** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the mos */
|
|
3472
|
+
path?: string | null;
|
|
3473
|
+
/** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailabl */
|
|
3474
|
+
queueAll?: boolean | null;
|
|
3475
|
+
/** Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing m */
|
|
3476
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject" | null;
|
|
3477
|
+
/** HTTP status code returned to a user while in the queue. */
|
|
3478
|
+
queueingStatusCode?: "200" | "202" | "429" | null;
|
|
3479
|
+
/** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits */
|
|
3480
|
+
sessionDuration?: number | null;
|
|
3481
|
+
/** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
3482
|
+
suspended?: boolean | null;
|
|
3483
|
+
/** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the */
|
|
3484
|
+
totalActiveUsers?: number | null;
|
|
3485
|
+
/** Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. `infinite_que */
|
|
3486
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
3487
|
+
/** Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitions of these */
|
|
3488
|
+
turnstileMode?:
|
|
3489
|
+
| "off"
|
|
3490
|
+
| "invisible"
|
|
3491
|
+
| "visible_non_interactive"
|
|
3492
|
+
| "visible_managed"
|
|
3493
|
+
| null;
|
|
3494
|
+
}
|
|
3495
|
+
|
|
3496
|
+
export const UpdateWaitingRoomResponse =
|
|
3497
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
3498
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3499
|
+
additionalRoutes: Schema.optional(
|
|
3500
|
+
Schema.Union([
|
|
3501
|
+
Schema.Array(
|
|
3502
|
+
Schema.Struct({
|
|
3503
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3504
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3505
|
+
}),
|
|
3506
|
+
),
|
|
3507
|
+
Schema.Null,
|
|
3508
|
+
]),
|
|
3509
|
+
),
|
|
3510
|
+
cookieAttributes: Schema.optional(
|
|
3511
|
+
Schema.Union([
|
|
3512
|
+
Schema.Struct({
|
|
3513
|
+
samesite: Schema.optional(
|
|
3514
|
+
Schema.Union([
|
|
3515
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
3516
|
+
Schema.Null,
|
|
3517
|
+
]),
|
|
3518
|
+
),
|
|
3519
|
+
secure: Schema.optional(
|
|
3520
|
+
Schema.Union([
|
|
3521
|
+
Schema.Literals(["auto", "always", "never"]),
|
|
3522
|
+
Schema.Null,
|
|
3523
|
+
]),
|
|
3524
|
+
),
|
|
3525
|
+
}),
|
|
3526
|
+
Schema.Null,
|
|
3527
|
+
]),
|
|
3528
|
+
),
|
|
3529
|
+
cookieSuffix: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3530
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3531
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3532
|
+
defaultTemplateLanguage: Schema.optional(
|
|
3533
|
+
Schema.Union([
|
|
3534
|
+
Schema.Literals([
|
|
3535
|
+
"en-US",
|
|
3536
|
+
"es-ES",
|
|
3537
|
+
"de-DE",
|
|
3538
|
+
"fr-FR",
|
|
3539
|
+
"it-IT",
|
|
3540
|
+
"ja-JP",
|
|
3541
|
+
"ko-KR",
|
|
3542
|
+
"pt-BR",
|
|
3543
|
+
"zh-CN",
|
|
3544
|
+
"zh-TW",
|
|
3545
|
+
"nl-NL",
|
|
3546
|
+
"pl-PL",
|
|
3547
|
+
"id-ID",
|
|
3548
|
+
"tr-TR",
|
|
3549
|
+
"ar-EG",
|
|
3550
|
+
"ru-RU",
|
|
3551
|
+
"fa-IR",
|
|
3552
|
+
"bg-BG",
|
|
3553
|
+
"hr-HR",
|
|
3554
|
+
"cs-CZ",
|
|
3555
|
+
"da-DK",
|
|
3556
|
+
"fi-FI",
|
|
3557
|
+
"lt-LT",
|
|
3558
|
+
"ms-MY",
|
|
3559
|
+
"nb-NO",
|
|
3560
|
+
"ro-RO",
|
|
3561
|
+
"el-GR",
|
|
3562
|
+
"he-IL",
|
|
3563
|
+
"hi-IN",
|
|
3564
|
+
"hu-HU",
|
|
3565
|
+
"sr-BA",
|
|
3566
|
+
"sk-SK",
|
|
3567
|
+
"sl-SI",
|
|
3568
|
+
"sv-SE",
|
|
3569
|
+
"tl-PH",
|
|
3570
|
+
"th-TH",
|
|
3571
|
+
"uk-UA",
|
|
3572
|
+
"vi-VN",
|
|
3573
|
+
]),
|
|
3574
|
+
Schema.Null,
|
|
3575
|
+
]),
|
|
3576
|
+
),
|
|
3577
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3578
|
+
disableSessionRenewal: Schema.optional(
|
|
3579
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
3580
|
+
),
|
|
3581
|
+
enabledOriginCommands: Schema.optional(
|
|
3582
|
+
Schema.Union([Schema.Array(Schema.Literal("revoke")), Schema.Null]),
|
|
3583
|
+
),
|
|
3584
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3585
|
+
jsonResponseEnabled: Schema.optional(
|
|
3586
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
3587
|
+
),
|
|
3588
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3589
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3590
|
+
newUsersPerMinute: Schema.optional(
|
|
3591
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
3592
|
+
),
|
|
3593
|
+
nextEventPrequeueStartTime: Schema.optional(
|
|
3594
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
3595
|
+
),
|
|
3596
|
+
nextEventStartTime: Schema.optional(
|
|
3597
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
3598
|
+
),
|
|
3599
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3600
|
+
queueAll: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
3601
|
+
queueingMethod: Schema.optional(
|
|
3602
|
+
Schema.Union([
|
|
3603
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
3604
|
+
Schema.Null,
|
|
3605
|
+
]),
|
|
3606
|
+
),
|
|
3607
|
+
queueingStatusCode: Schema.optional(
|
|
3608
|
+
Schema.Union([Schema.Literals(["200", "202", "429"]), Schema.Null]),
|
|
3609
|
+
),
|
|
3610
|
+
sessionDuration: Schema.optional(
|
|
3611
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
3612
|
+
),
|
|
3613
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
3614
|
+
totalActiveUsers: Schema.optional(
|
|
3615
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
3616
|
+
),
|
|
3617
|
+
turnstileAction: Schema.optional(
|
|
3618
|
+
Schema.Union([Schema.Literals(["log", "infinite_queue"]), Schema.Null]),
|
|
3619
|
+
),
|
|
3620
|
+
turnstileMode: Schema.optional(
|
|
3621
|
+
Schema.Union([
|
|
3622
|
+
Schema.Literals([
|
|
3623
|
+
"off",
|
|
3624
|
+
"invisible",
|
|
3625
|
+
"visible_non_interactive",
|
|
3626
|
+
"visible_managed",
|
|
3627
|
+
]),
|
|
3628
|
+
Schema.Null,
|
|
3629
|
+
]),
|
|
3630
|
+
),
|
|
3631
|
+
})
|
|
3632
|
+
.pipe(
|
|
3633
|
+
Schema.encodeKeys({
|
|
3634
|
+
id: "id",
|
|
3635
|
+
additionalRoutes: "additional_routes",
|
|
3636
|
+
cookieAttributes: "cookie_attributes",
|
|
3637
|
+
cookieSuffix: "cookie_suffix",
|
|
3638
|
+
createdOn: "created_on",
|
|
3639
|
+
customPageHtml: "custom_page_html",
|
|
3640
|
+
defaultTemplateLanguage: "default_template_language",
|
|
3641
|
+
description: "description",
|
|
3642
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
3643
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
3644
|
+
host: "host",
|
|
3645
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
3646
|
+
modifiedOn: "modified_on",
|
|
3647
|
+
name: "name",
|
|
3648
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
3649
|
+
nextEventPrequeueStartTime: "next_event_prequeue_start_time",
|
|
3650
|
+
nextEventStartTime: "next_event_start_time",
|
|
3651
|
+
path: "path",
|
|
3652
|
+
queueAll: "queue_all",
|
|
3653
|
+
queueingMethod: "queueing_method",
|
|
3654
|
+
queueingStatusCode: "queueing_status_code",
|
|
3655
|
+
sessionDuration: "session_duration",
|
|
3656
|
+
suspended: "suspended",
|
|
3657
|
+
totalActiveUsers: "total_active_users",
|
|
3658
|
+
turnstileAction: "turnstile_action",
|
|
3659
|
+
turnstileMode: "turnstile_mode",
|
|
3660
|
+
}),
|
|
3661
|
+
)
|
|
3662
|
+
.pipe(
|
|
3663
|
+
T.ResponsePath("result"),
|
|
3664
|
+
) as unknown as Schema.Schema<UpdateWaitingRoomResponse>;
|
|
3665
|
+
|
|
3666
|
+
export type UpdateWaitingRoomError = DefaultErrors;
|
|
3667
|
+
|
|
3668
|
+
export const updateWaitingRoom: API.OperationMethod<
|
|
3669
|
+
UpdateWaitingRoomRequest,
|
|
3670
|
+
UpdateWaitingRoomResponse,
|
|
3671
|
+
UpdateWaitingRoomError,
|
|
3672
|
+
Credentials | HttpClient.HttpClient
|
|
3673
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
3674
|
+
input: UpdateWaitingRoomRequest,
|
|
3675
|
+
output: UpdateWaitingRoomResponse,
|
|
3676
|
+
errors: [],
|
|
3677
|
+
}));
|
|
3678
|
+
|
|
3679
|
+
export interface PatchWaitingRoomRequest {
|
|
3680
|
+
waitingRoomId: string;
|
|
3681
|
+
/** Path param: Identifier. */
|
|
3682
|
+
zoneId: string;
|
|
3683
|
+
/** Body param: The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
3684
|
+
host: string;
|
|
3685
|
+
/** Body param: A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
3686
|
+
name: string;
|
|
3687
|
+
/** Body param: Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there i */
|
|
3688
|
+
newUsersPerMinute: number;
|
|
3689
|
+
/** Body param: Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a basel */
|
|
3690
|
+
totalActiveUsers: number;
|
|
3691
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of */
|
|
3692
|
+
additionalRoutes?: { host?: string; path?: string }[];
|
|
3693
|
+
/** Body param: Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
3694
|
+
cookieAttributes?: {
|
|
3695
|
+
samesite?: "auto" | "lax" | "none" | "strict";
|
|
3696
|
+
secure?: "auto" | "always" | "never";
|
|
3697
|
+
};
|
|
3698
|
+
/** Body param: Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This */
|
|
3699
|
+
cookieSuffix?: string;
|
|
3700
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will */
|
|
3701
|
+
customPageHtml?: string;
|
|
3702
|
+
/** Body param: The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
3703
|
+
defaultTemplateLanguage?:
|
|
3704
|
+
| "en-US"
|
|
3705
|
+
| "es-ES"
|
|
3706
|
+
| "de-DE"
|
|
3707
|
+
| "fr-FR"
|
|
3708
|
+
| "it-IT"
|
|
3709
|
+
| "ja-JP"
|
|
3710
|
+
| "ko-KR"
|
|
3711
|
+
| "pt-BR"
|
|
3712
|
+
| "zh-CN"
|
|
3713
|
+
| "zh-TW"
|
|
3714
|
+
| "nl-NL"
|
|
3715
|
+
| "pl-PL"
|
|
3716
|
+
| "id-ID"
|
|
3717
|
+
| "tr-TR"
|
|
3718
|
+
| "ar-EG"
|
|
3719
|
+
| "ru-RU"
|
|
3720
|
+
| "fa-IR"
|
|
3721
|
+
| "bg-BG"
|
|
3722
|
+
| "hr-HR"
|
|
3723
|
+
| "cs-CZ"
|
|
3724
|
+
| "da-DK"
|
|
3725
|
+
| "fi-FI"
|
|
3726
|
+
| "lt-LT"
|
|
3727
|
+
| "ms-MY"
|
|
3728
|
+
| "nb-NO"
|
|
3729
|
+
| "ro-RO"
|
|
3730
|
+
| "el-GR"
|
|
3731
|
+
| "he-IL"
|
|
3732
|
+
| "hi-IN"
|
|
3733
|
+
| "hu-HU"
|
|
3734
|
+
| "sr-BA"
|
|
3735
|
+
| "sk-SK"
|
|
3736
|
+
| "sl-SI"
|
|
3737
|
+
| "sv-SE"
|
|
3738
|
+
| "tl-PH"
|
|
3739
|
+
| "th-TH"
|
|
3740
|
+
| "uk-UA"
|
|
3741
|
+
| "vi-VN";
|
|
3742
|
+
/** Body param: A note that you can use to add more details about the waiting room. */
|
|
3743
|
+
description?: string;
|
|
3744
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. */
|
|
3745
|
+
disableSessionRenewal?: boolean;
|
|
3746
|
+
/** Body param: A list of enabled origin commands. */
|
|
3747
|
+
enabledOriginCommands?: "revoke"[];
|
|
3748
|
+
/** Body param: Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with infor */
|
|
3749
|
+
jsonResponseEnabled?: boolean;
|
|
3750
|
+
/** Body param: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room */
|
|
3751
|
+
path?: string;
|
|
3752
|
+
/** Body param: If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will becom */
|
|
3753
|
+
queueAll?: boolean;
|
|
3754
|
+
/** Body param: Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of th */
|
|
3755
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject";
|
|
3756
|
+
/** Body param: HTTP status code returned to a user while in the queue. */
|
|
3757
|
+
queueingStatusCode?: "200" | "202" | "429";
|
|
3758
|
+
/** Body param: Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user */
|
|
3759
|
+
sessionDuration?: number;
|
|
3760
|
+
/** Body param: Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
3761
|
+
suspended?: boolean;
|
|
3762
|
+
/** Body param: Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. ` */
|
|
3763
|
+
turnstileAction?: "log" | "infinite_queue";
|
|
3764
|
+
/** Body param: Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitio */
|
|
3765
|
+
turnstileMode?:
|
|
3766
|
+
| "off"
|
|
3767
|
+
| "invisible"
|
|
3768
|
+
| "visible_non_interactive"
|
|
3769
|
+
| "visible_managed";
|
|
3770
|
+
}
|
|
3771
|
+
|
|
3772
|
+
export const PatchWaitingRoomRequest =
|
|
3773
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
3774
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
3775
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
3776
|
+
host: Schema.String,
|
|
3777
|
+
name: Schema.String,
|
|
3778
|
+
newUsersPerMinute: Schema.Number,
|
|
3779
|
+
totalActiveUsers: Schema.Number,
|
|
3780
|
+
additionalRoutes: Schema.optional(
|
|
3781
|
+
Schema.Array(
|
|
3782
|
+
Schema.Struct({
|
|
3783
|
+
host: Schema.optional(Schema.String),
|
|
3784
|
+
path: Schema.optional(Schema.String),
|
|
3785
|
+
}),
|
|
3786
|
+
),
|
|
3787
|
+
),
|
|
3788
|
+
cookieAttributes: Schema.optional(
|
|
3789
|
+
Schema.Struct({
|
|
3790
|
+
samesite: Schema.optional(
|
|
3791
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
3792
|
+
),
|
|
3793
|
+
secure: Schema.optional(Schema.Literals(["auto", "always", "never"])),
|
|
3794
|
+
}),
|
|
3795
|
+
),
|
|
3796
|
+
cookieSuffix: Schema.optional(Schema.String),
|
|
3797
|
+
customPageHtml: Schema.optional(Schema.String),
|
|
3798
|
+
defaultTemplateLanguage: Schema.optional(
|
|
3799
|
+
Schema.Literals([
|
|
3800
|
+
"en-US",
|
|
3801
|
+
"es-ES",
|
|
3802
|
+
"de-DE",
|
|
3803
|
+
"fr-FR",
|
|
3804
|
+
"it-IT",
|
|
3805
|
+
"ja-JP",
|
|
3806
|
+
"ko-KR",
|
|
3807
|
+
"pt-BR",
|
|
3808
|
+
"zh-CN",
|
|
3809
|
+
"zh-TW",
|
|
3810
|
+
"nl-NL",
|
|
3811
|
+
"pl-PL",
|
|
3812
|
+
"id-ID",
|
|
3813
|
+
"tr-TR",
|
|
3814
|
+
"ar-EG",
|
|
3815
|
+
"ru-RU",
|
|
3816
|
+
"fa-IR",
|
|
3817
|
+
"bg-BG",
|
|
3818
|
+
"hr-HR",
|
|
3819
|
+
"cs-CZ",
|
|
3820
|
+
"da-DK",
|
|
3821
|
+
"fi-FI",
|
|
3822
|
+
"lt-LT",
|
|
3823
|
+
"ms-MY",
|
|
3824
|
+
"nb-NO",
|
|
3825
|
+
"ro-RO",
|
|
3826
|
+
"el-GR",
|
|
3827
|
+
"he-IL",
|
|
3828
|
+
"hi-IN",
|
|
3829
|
+
"hu-HU",
|
|
3830
|
+
"sr-BA",
|
|
3831
|
+
"sk-SK",
|
|
3832
|
+
"sl-SI",
|
|
3833
|
+
"sv-SE",
|
|
3834
|
+
"tl-PH",
|
|
3835
|
+
"th-TH",
|
|
3836
|
+
"uk-UA",
|
|
3837
|
+
"vi-VN",
|
|
3838
|
+
]),
|
|
3839
|
+
),
|
|
3840
|
+
description: Schema.optional(Schema.String),
|
|
3841
|
+
disableSessionRenewal: Schema.optional(Schema.Boolean),
|
|
3842
|
+
enabledOriginCommands: Schema.optional(
|
|
3843
|
+
Schema.Array(Schema.Literal("revoke")),
|
|
3844
|
+
),
|
|
3845
|
+
jsonResponseEnabled: Schema.optional(Schema.Boolean),
|
|
3846
|
+
path: Schema.optional(Schema.String),
|
|
3847
|
+
queueAll: Schema.optional(Schema.Boolean),
|
|
3848
|
+
queueingMethod: Schema.optional(
|
|
3849
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
3850
|
+
),
|
|
3851
|
+
queueingStatusCode: Schema.optional(Schema.Literals(["200", "202", "429"])),
|
|
3852
|
+
sessionDuration: Schema.optional(Schema.Number),
|
|
3853
|
+
suspended: Schema.optional(Schema.Boolean),
|
|
3854
|
+
turnstileAction: Schema.optional(
|
|
3855
|
+
Schema.Literals(["log", "infinite_queue"]),
|
|
3856
|
+
),
|
|
3857
|
+
turnstileMode: Schema.optional(
|
|
3858
|
+
Schema.Literals([
|
|
3859
|
+
"off",
|
|
3860
|
+
"invisible",
|
|
3861
|
+
"visible_non_interactive",
|
|
3862
|
+
"visible_managed",
|
|
3863
|
+
]),
|
|
3864
|
+
),
|
|
3865
|
+
}).pipe(
|
|
3866
|
+
Schema.encodeKeys({
|
|
3867
|
+
host: "host",
|
|
3868
|
+
name: "name",
|
|
3869
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
3870
|
+
totalActiveUsers: "total_active_users",
|
|
3871
|
+
additionalRoutes: "additional_routes",
|
|
3872
|
+
cookieAttributes: "cookie_attributes",
|
|
3873
|
+
cookieSuffix: "cookie_suffix",
|
|
3874
|
+
customPageHtml: "custom_page_html",
|
|
3875
|
+
defaultTemplateLanguage: "default_template_language",
|
|
3876
|
+
description: "description",
|
|
3877
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
3878
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
3879
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
3880
|
+
path: "path",
|
|
3881
|
+
queueAll: "queue_all",
|
|
3882
|
+
queueingMethod: "queueing_method",
|
|
3883
|
+
queueingStatusCode: "queueing_status_code",
|
|
3884
|
+
sessionDuration: "session_duration",
|
|
3885
|
+
suspended: "suspended",
|
|
3886
|
+
turnstileAction: "turnstile_action",
|
|
3887
|
+
turnstileMode: "turnstile_mode",
|
|
3888
|
+
}),
|
|
3889
|
+
T.Http({
|
|
3890
|
+
method: "PATCH",
|
|
3891
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}",
|
|
3892
|
+
}),
|
|
3893
|
+
) as unknown as Schema.Schema<PatchWaitingRoomRequest>;
|
|
3894
|
+
|
|
3895
|
+
export interface PatchWaitingRoomResponse {
|
|
3896
|
+
id?: string | null;
|
|
3897
|
+
/** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. Th */
|
|
3898
|
+
additionalRoutes?: { host?: string | null; path?: string | null }[] | null;
|
|
3899
|
+
/** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */
|
|
3900
|
+
cookieAttributes?: {
|
|
3901
|
+
samesite?: "auto" | "lax" | "none" | "strict" | null;
|
|
3902
|
+
secure?: "auto" | "always" | "never" | null;
|
|
3903
|
+
} | null;
|
|
3904
|
+
/** Appends a '\_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name( cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be ` cf_waitingroom_abcd`. This field is req */
|
|
3905
|
+
cookieSuffix?: string | null;
|
|
3906
|
+
createdOn?: string | null;
|
|
3907
|
+
/** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. Th */
|
|
3908
|
+
customPageHtml?: string | null;
|
|
3909
|
+
/** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */
|
|
3910
|
+
defaultTemplateLanguage?:
|
|
3911
|
+
| "en-US"
|
|
3912
|
+
| "es-ES"
|
|
3913
|
+
| "de-DE"
|
|
3914
|
+
| "fr-FR"
|
|
3915
|
+
| "it-IT"
|
|
3916
|
+
| "ja-JP"
|
|
3917
|
+
| "ko-KR"
|
|
3918
|
+
| "pt-BR"
|
|
3919
|
+
| "zh-CN"
|
|
3920
|
+
| "zh-TW"
|
|
3921
|
+
| "nl-NL"
|
|
3922
|
+
| "pl-PL"
|
|
3923
|
+
| "id-ID"
|
|
3924
|
+
| "tr-TR"
|
|
3925
|
+
| "ar-EG"
|
|
3926
|
+
| "ru-RU"
|
|
3927
|
+
| "fa-IR"
|
|
3928
|
+
| "bg-BG"
|
|
3929
|
+
| "hr-HR"
|
|
3930
|
+
| "cs-CZ"
|
|
3931
|
+
| "da-DK"
|
|
3932
|
+
| "fi-FI"
|
|
3933
|
+
| "lt-LT"
|
|
3934
|
+
| "ms-MY"
|
|
3935
|
+
| "nb-NO"
|
|
3936
|
+
| "ro-RO"
|
|
3937
|
+
| "el-GR"
|
|
3938
|
+
| "he-IL"
|
|
3939
|
+
| "hi-IN"
|
|
3940
|
+
| "hu-HU"
|
|
3941
|
+
| "sr-BA"
|
|
3942
|
+
| "sk-SK"
|
|
3943
|
+
| "sl-SI"
|
|
3944
|
+
| "sv-SE"
|
|
3945
|
+
| "tl-PH"
|
|
3946
|
+
| "th-TH"
|
|
3947
|
+
| "uk-UA"
|
|
3948
|
+
| "vi-VN"
|
|
3949
|
+
| null;
|
|
3950
|
+
/** A note that you can use to add more details about the waiting room. */
|
|
3951
|
+
description?: string | null;
|
|
3952
|
+
/** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, */
|
|
3953
|
+
disableSessionRenewal?: boolean | null;
|
|
3954
|
+
/** A list of enabled origin commands. */
|
|
3955
|
+
enabledOriginCommands?: "revoke"[] | null;
|
|
3956
|
+
/** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */
|
|
3957
|
+
host?: string | null;
|
|
3958
|
+
/** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on th */
|
|
3959
|
+
jsonResponseEnabled?: boolean | null;
|
|
3960
|
+
modifiedOn?: string | null;
|
|
3961
|
+
/** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */
|
|
3962
|
+
name?: string | null;
|
|
3963
|
+
/** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little m */
|
|
3964
|
+
newUsersPerMinute?: number | null;
|
|
3965
|
+
/** An ISO 8601 timestamp that marks when the next event will begin queueing. */
|
|
3966
|
+
nextEventPrequeueStartTime?: string | null;
|
|
3967
|
+
/** An ISO 8601 timestamp that marks when the next event will start. */
|
|
3968
|
+
nextEventStartTime?: string | null;
|
|
3969
|
+
/** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the mos */
|
|
3970
|
+
path?: string | null;
|
|
3971
|
+
/** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailabl */
|
|
3972
|
+
queueAll?: boolean | null;
|
|
3973
|
+
/** Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing m */
|
|
3974
|
+
queueingMethod?: "fifo" | "random" | "passthrough" | "reject" | null;
|
|
3975
|
+
/** HTTP status code returned to a user while in the queue. */
|
|
3976
|
+
queueingStatusCode?: "200" | "202" | "429" | null;
|
|
3977
|
+
/** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits */
|
|
3978
|
+
sessionDuration?: number | null;
|
|
3979
|
+
/** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */
|
|
3980
|
+
suspended?: boolean | null;
|
|
3981
|
+
/** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the */
|
|
3982
|
+
totalActiveUsers?: number | null;
|
|
3983
|
+
/** Which action to take when a bot is detected using Turnstile. `log` will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. `infinite_que */
|
|
3984
|
+
turnstileAction?: "log" | "infinite_queue" | null;
|
|
3985
|
+
/** Which Turnstile widget type to use for detecting bot traffic. See [the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types) for the definitions of these */
|
|
3986
|
+
turnstileMode?:
|
|
3987
|
+
| "off"
|
|
3988
|
+
| "invisible"
|
|
3989
|
+
| "visible_non_interactive"
|
|
3990
|
+
| "visible_managed"
|
|
3991
|
+
| null;
|
|
3992
|
+
}
|
|
3993
|
+
|
|
3994
|
+
export const PatchWaitingRoomResponse =
|
|
3995
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
3996
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
3997
|
+
additionalRoutes: Schema.optional(
|
|
3998
|
+
Schema.Union([
|
|
3999
|
+
Schema.Array(
|
|
4000
|
+
Schema.Struct({
|
|
4001
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4002
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4003
|
+
}),
|
|
4004
|
+
),
|
|
4005
|
+
Schema.Null,
|
|
4006
|
+
]),
|
|
4007
|
+
),
|
|
4008
|
+
cookieAttributes: Schema.optional(
|
|
4009
|
+
Schema.Union([
|
|
4010
|
+
Schema.Struct({
|
|
4011
|
+
samesite: Schema.optional(
|
|
4012
|
+
Schema.Union([
|
|
4013
|
+
Schema.Literals(["auto", "lax", "none", "strict"]),
|
|
4014
|
+
Schema.Null,
|
|
4015
|
+
]),
|
|
4016
|
+
),
|
|
4017
|
+
secure: Schema.optional(
|
|
4018
|
+
Schema.Union([
|
|
4019
|
+
Schema.Literals(["auto", "always", "never"]),
|
|
4020
|
+
Schema.Null,
|
|
4021
|
+
]),
|
|
4022
|
+
),
|
|
4023
|
+
}),
|
|
4024
|
+
Schema.Null,
|
|
4025
|
+
]),
|
|
4026
|
+
),
|
|
4027
|
+
cookieSuffix: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4028
|
+
createdOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4029
|
+
customPageHtml: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4030
|
+
defaultTemplateLanguage: Schema.optional(
|
|
4031
|
+
Schema.Union([
|
|
4032
|
+
Schema.Literals([
|
|
4033
|
+
"en-US",
|
|
4034
|
+
"es-ES",
|
|
4035
|
+
"de-DE",
|
|
4036
|
+
"fr-FR",
|
|
4037
|
+
"it-IT",
|
|
4038
|
+
"ja-JP",
|
|
4039
|
+
"ko-KR",
|
|
4040
|
+
"pt-BR",
|
|
4041
|
+
"zh-CN",
|
|
4042
|
+
"zh-TW",
|
|
4043
|
+
"nl-NL",
|
|
4044
|
+
"pl-PL",
|
|
4045
|
+
"id-ID",
|
|
4046
|
+
"tr-TR",
|
|
4047
|
+
"ar-EG",
|
|
4048
|
+
"ru-RU",
|
|
4049
|
+
"fa-IR",
|
|
4050
|
+
"bg-BG",
|
|
4051
|
+
"hr-HR",
|
|
4052
|
+
"cs-CZ",
|
|
4053
|
+
"da-DK",
|
|
4054
|
+
"fi-FI",
|
|
4055
|
+
"lt-LT",
|
|
4056
|
+
"ms-MY",
|
|
4057
|
+
"nb-NO",
|
|
4058
|
+
"ro-RO",
|
|
4059
|
+
"el-GR",
|
|
4060
|
+
"he-IL",
|
|
4061
|
+
"hi-IN",
|
|
4062
|
+
"hu-HU",
|
|
4063
|
+
"sr-BA",
|
|
4064
|
+
"sk-SK",
|
|
4065
|
+
"sl-SI",
|
|
4066
|
+
"sv-SE",
|
|
4067
|
+
"tl-PH",
|
|
4068
|
+
"th-TH",
|
|
4069
|
+
"uk-UA",
|
|
4070
|
+
"vi-VN",
|
|
4071
|
+
]),
|
|
4072
|
+
Schema.Null,
|
|
4073
|
+
]),
|
|
4074
|
+
),
|
|
4075
|
+
description: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4076
|
+
disableSessionRenewal: Schema.optional(
|
|
4077
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
4078
|
+
),
|
|
4079
|
+
enabledOriginCommands: Schema.optional(
|
|
4080
|
+
Schema.Union([Schema.Array(Schema.Literal("revoke")), Schema.Null]),
|
|
4081
|
+
),
|
|
4082
|
+
host: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4083
|
+
jsonResponseEnabled: Schema.optional(
|
|
4084
|
+
Schema.Union([Schema.Boolean, Schema.Null]),
|
|
4085
|
+
),
|
|
4086
|
+
modifiedOn: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4087
|
+
name: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4088
|
+
newUsersPerMinute: Schema.optional(
|
|
4089
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
4090
|
+
),
|
|
4091
|
+
nextEventPrequeueStartTime: Schema.optional(
|
|
4092
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
4093
|
+
),
|
|
4094
|
+
nextEventStartTime: Schema.optional(
|
|
4095
|
+
Schema.Union([Schema.String, Schema.Null]),
|
|
4096
|
+
),
|
|
4097
|
+
path: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4098
|
+
queueAll: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
4099
|
+
queueingMethod: Schema.optional(
|
|
4100
|
+
Schema.Union([
|
|
4101
|
+
Schema.Literals(["fifo", "random", "passthrough", "reject"]),
|
|
4102
|
+
Schema.Null,
|
|
4103
|
+
]),
|
|
4104
|
+
),
|
|
4105
|
+
queueingStatusCode: Schema.optional(
|
|
4106
|
+
Schema.Union([Schema.Literals(["200", "202", "429"]), Schema.Null]),
|
|
4107
|
+
),
|
|
4108
|
+
sessionDuration: Schema.optional(
|
|
4109
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
4110
|
+
),
|
|
4111
|
+
suspended: Schema.optional(Schema.Union([Schema.Boolean, Schema.Null])),
|
|
4112
|
+
totalActiveUsers: Schema.optional(
|
|
4113
|
+
Schema.Union([Schema.Number, Schema.Null]),
|
|
4114
|
+
),
|
|
4115
|
+
turnstileAction: Schema.optional(
|
|
4116
|
+
Schema.Union([Schema.Literals(["log", "infinite_queue"]), Schema.Null]),
|
|
4117
|
+
),
|
|
4118
|
+
turnstileMode: Schema.optional(
|
|
4119
|
+
Schema.Union([
|
|
4120
|
+
Schema.Literals([
|
|
4121
|
+
"off",
|
|
4122
|
+
"invisible",
|
|
4123
|
+
"visible_non_interactive",
|
|
4124
|
+
"visible_managed",
|
|
4125
|
+
]),
|
|
4126
|
+
Schema.Null,
|
|
4127
|
+
]),
|
|
4128
|
+
),
|
|
4129
|
+
})
|
|
4130
|
+
.pipe(
|
|
4131
|
+
Schema.encodeKeys({
|
|
4132
|
+
id: "id",
|
|
4133
|
+
additionalRoutes: "additional_routes",
|
|
4134
|
+
cookieAttributes: "cookie_attributes",
|
|
4135
|
+
cookieSuffix: "cookie_suffix",
|
|
4136
|
+
createdOn: "created_on",
|
|
4137
|
+
customPageHtml: "custom_page_html",
|
|
4138
|
+
defaultTemplateLanguage: "default_template_language",
|
|
4139
|
+
description: "description",
|
|
4140
|
+
disableSessionRenewal: "disable_session_renewal",
|
|
4141
|
+
enabledOriginCommands: "enabled_origin_commands",
|
|
4142
|
+
host: "host",
|
|
4143
|
+
jsonResponseEnabled: "json_response_enabled",
|
|
4144
|
+
modifiedOn: "modified_on",
|
|
4145
|
+
name: "name",
|
|
4146
|
+
newUsersPerMinute: "new_users_per_minute",
|
|
4147
|
+
nextEventPrequeueStartTime: "next_event_prequeue_start_time",
|
|
4148
|
+
nextEventStartTime: "next_event_start_time",
|
|
4149
|
+
path: "path",
|
|
4150
|
+
queueAll: "queue_all",
|
|
4151
|
+
queueingMethod: "queueing_method",
|
|
4152
|
+
queueingStatusCode: "queueing_status_code",
|
|
4153
|
+
sessionDuration: "session_duration",
|
|
4154
|
+
suspended: "suspended",
|
|
4155
|
+
totalActiveUsers: "total_active_users",
|
|
4156
|
+
turnstileAction: "turnstile_action",
|
|
4157
|
+
turnstileMode: "turnstile_mode",
|
|
4158
|
+
}),
|
|
4159
|
+
)
|
|
4160
|
+
.pipe(
|
|
4161
|
+
T.ResponsePath("result"),
|
|
4162
|
+
) as unknown as Schema.Schema<PatchWaitingRoomResponse>;
|
|
4163
|
+
|
|
4164
|
+
export type PatchWaitingRoomError = DefaultErrors;
|
|
4165
|
+
|
|
4166
|
+
export const patchWaitingRoom: API.OperationMethod<
|
|
4167
|
+
PatchWaitingRoomRequest,
|
|
4168
|
+
PatchWaitingRoomResponse,
|
|
4169
|
+
PatchWaitingRoomError,
|
|
4170
|
+
Credentials | HttpClient.HttpClient
|
|
4171
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
4172
|
+
input: PatchWaitingRoomRequest,
|
|
4173
|
+
output: PatchWaitingRoomResponse,
|
|
4174
|
+
errors: [],
|
|
4175
|
+
}));
|
|
4176
|
+
|
|
4177
|
+
export interface DeleteWaitingRoomRequest {
|
|
4178
|
+
waitingRoomId: string;
|
|
4179
|
+
/** Identifier. */
|
|
4180
|
+
zoneId: string;
|
|
4181
|
+
}
|
|
4182
|
+
|
|
4183
|
+
export const DeleteWaitingRoomRequest =
|
|
4184
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
4185
|
+
waitingRoomId: Schema.String.pipe(T.HttpPath("waitingRoomId")),
|
|
4186
|
+
zoneId: Schema.String.pipe(T.HttpPath("zone_id")),
|
|
4187
|
+
}).pipe(
|
|
4188
|
+
T.Http({
|
|
4189
|
+
method: "DELETE",
|
|
4190
|
+
path: "/zones/{zone_id}/waiting_rooms/{waitingRoomId}",
|
|
4191
|
+
}),
|
|
4192
|
+
) as unknown as Schema.Schema<DeleteWaitingRoomRequest>;
|
|
4193
|
+
|
|
4194
|
+
export interface DeleteWaitingRoomResponse {
|
|
4195
|
+
id?: string | null;
|
|
4196
|
+
}
|
|
4197
|
+
|
|
4198
|
+
export const DeleteWaitingRoomResponse =
|
|
4199
|
+
/*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
|
|
4200
|
+
id: Schema.optional(Schema.Union([Schema.String, Schema.Null])),
|
|
4201
|
+
}).pipe(
|
|
4202
|
+
T.ResponsePath("result"),
|
|
4203
|
+
) as unknown as Schema.Schema<DeleteWaitingRoomResponse>;
|
|
4204
|
+
|
|
4205
|
+
export type DeleteWaitingRoomError = DefaultErrors;
|
|
4206
|
+
|
|
4207
|
+
export const deleteWaitingRoom: API.OperationMethod<
|
|
4208
|
+
DeleteWaitingRoomRequest,
|
|
4209
|
+
DeleteWaitingRoomResponse,
|
|
4210
|
+
DeleteWaitingRoomError,
|
|
4211
|
+
Credentials | HttpClient.HttpClient
|
|
4212
|
+
> = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
|
|
4213
|
+
input: DeleteWaitingRoomRequest,
|
|
4214
|
+
output: DeleteWaitingRoomResponse,
|
|
4215
|
+
errors: [],
|
|
4216
|
+
}));
|