@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,857 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cloudflare BROWSER-RENDERING API
|
|
3
|
+
*
|
|
4
|
+
* Generated from Cloudflare TypeScript SDK.
|
|
5
|
+
* DO NOT EDIT - regenerate with: bun scripts/generate.ts --service browser-rendering
|
|
6
|
+
*/
|
|
7
|
+
import * as Schema from "effect/Schema";
|
|
8
|
+
import type * as HttpClient from "effect/unstable/http/HttpClient";
|
|
9
|
+
import * as API from "../client/api.ts";
|
|
10
|
+
import type { Credentials } from "../credentials.ts";
|
|
11
|
+
import { type DefaultErrors } from "../errors.ts";
|
|
12
|
+
export interface CreateContentRequest {
|
|
13
|
+
/** Path param: Account ID. */
|
|
14
|
+
accountId: string;
|
|
15
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
16
|
+
cacheTTL?: number;
|
|
17
|
+
/** Body param: URL to navigate to, eg. `https://example.com`. */
|
|
18
|
+
url: string;
|
|
19
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
20
|
+
actionTimeout?: number;
|
|
21
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
22
|
+
addScriptTag?: {
|
|
23
|
+
id?: string;
|
|
24
|
+
content?: string;
|
|
25
|
+
type?: string;
|
|
26
|
+
url?: string;
|
|
27
|
+
}[];
|
|
28
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
29
|
+
addStyleTag?: {
|
|
30
|
+
content?: string;
|
|
31
|
+
url?: string;
|
|
32
|
+
}[];
|
|
33
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
34
|
+
allowRequestPattern?: string[];
|
|
35
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
36
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
37
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
38
|
+
authenticate?: {
|
|
39
|
+
password: string;
|
|
40
|
+
username: string;
|
|
41
|
+
};
|
|
42
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
43
|
+
bestAttempt?: boolean;
|
|
44
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
45
|
+
cookies?: {
|
|
46
|
+
name: string;
|
|
47
|
+
value: string;
|
|
48
|
+
domain?: string;
|
|
49
|
+
expires?: number;
|
|
50
|
+
httpOnly?: boolean;
|
|
51
|
+
partitionKey?: string;
|
|
52
|
+
path?: string;
|
|
53
|
+
priority?: "Low" | "Medium" | "High";
|
|
54
|
+
sameParty?: boolean;
|
|
55
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
56
|
+
secure?: boolean;
|
|
57
|
+
sourcePort?: number;
|
|
58
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
59
|
+
url?: string;
|
|
60
|
+
}[];
|
|
61
|
+
/** Body param: */
|
|
62
|
+
emulateMediaType?: string;
|
|
63
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
64
|
+
gotoOptions?: {
|
|
65
|
+
referer?: string;
|
|
66
|
+
referrerPolicy?: string;
|
|
67
|
+
timeout?: number;
|
|
68
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
69
|
+
};
|
|
70
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
71
|
+
rejectRequestPattern?: string[];
|
|
72
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
73
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
74
|
+
/** Body param: */
|
|
75
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
76
|
+
/** Body param: */
|
|
77
|
+
setJavaScriptEnabled?: boolean;
|
|
78
|
+
/** Body param: */
|
|
79
|
+
userAgent?: string;
|
|
80
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
81
|
+
viewport?: {
|
|
82
|
+
height: number;
|
|
83
|
+
width: number;
|
|
84
|
+
deviceScaleFactor?: number;
|
|
85
|
+
hasTouch?: boolean;
|
|
86
|
+
isLandscape?: boolean;
|
|
87
|
+
isMobile?: boolean;
|
|
88
|
+
};
|
|
89
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
90
|
+
waitForSelector?: {
|
|
91
|
+
selector: string;
|
|
92
|
+
hidden?: true;
|
|
93
|
+
timeout?: number;
|
|
94
|
+
visible?: true;
|
|
95
|
+
};
|
|
96
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
97
|
+
waitForTimeout?: number;
|
|
98
|
+
}
|
|
99
|
+
export declare const CreateContentRequest: Schema.Schema<CreateContentRequest>;
|
|
100
|
+
export type CreateContentResponse = string;
|
|
101
|
+
export declare const CreateContentResponse: Schema.Schema<string>;
|
|
102
|
+
export type CreateContentError = DefaultErrors;
|
|
103
|
+
export declare const createContent: API.OperationMethod<CreateContentRequest, CreateContentResponse, CreateContentError, Credentials | HttpClient.HttpClient>;
|
|
104
|
+
export interface CreateJsonRequest {
|
|
105
|
+
/** Path param: Account ID. */
|
|
106
|
+
accountId: string;
|
|
107
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
108
|
+
cacheTTL?: number;
|
|
109
|
+
/** Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set. */
|
|
110
|
+
html: string;
|
|
111
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
112
|
+
actionTimeout?: number;
|
|
113
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
114
|
+
addScriptTag?: {
|
|
115
|
+
id?: string;
|
|
116
|
+
content?: string;
|
|
117
|
+
type?: string;
|
|
118
|
+
url?: string;
|
|
119
|
+
}[];
|
|
120
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
121
|
+
addStyleTag?: {
|
|
122
|
+
content?: string;
|
|
123
|
+
url?: string;
|
|
124
|
+
}[];
|
|
125
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
126
|
+
allowRequestPattern?: string[];
|
|
127
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
128
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
129
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
130
|
+
authenticate?: {
|
|
131
|
+
password: string;
|
|
132
|
+
username: string;
|
|
133
|
+
};
|
|
134
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
135
|
+
bestAttempt?: boolean;
|
|
136
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
137
|
+
cookies?: {
|
|
138
|
+
name: string;
|
|
139
|
+
value: string;
|
|
140
|
+
domain?: string;
|
|
141
|
+
expires?: number;
|
|
142
|
+
httpOnly?: boolean;
|
|
143
|
+
partitionKey?: string;
|
|
144
|
+
path?: string;
|
|
145
|
+
priority?: "Low" | "Medium" | "High";
|
|
146
|
+
sameParty?: boolean;
|
|
147
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
148
|
+
secure?: boolean;
|
|
149
|
+
sourcePort?: number;
|
|
150
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
151
|
+
url?: string;
|
|
152
|
+
}[];
|
|
153
|
+
/** Body param: Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback. */
|
|
154
|
+
customAi?: {
|
|
155
|
+
authorization: string;
|
|
156
|
+
model: string;
|
|
157
|
+
}[];
|
|
158
|
+
/** Body param: */
|
|
159
|
+
emulateMediaType?: string;
|
|
160
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
161
|
+
gotoOptions?: {
|
|
162
|
+
referer?: string;
|
|
163
|
+
referrerPolicy?: string;
|
|
164
|
+
timeout?: number;
|
|
165
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
166
|
+
};
|
|
167
|
+
/** Body param: */
|
|
168
|
+
prompt?: string;
|
|
169
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
170
|
+
rejectRequestPattern?: string[];
|
|
171
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
172
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
173
|
+
/** Body param: */
|
|
174
|
+
responseFormat?: {
|
|
175
|
+
type: string;
|
|
176
|
+
jsonSchema?: Record<string, unknown> | null;
|
|
177
|
+
};
|
|
178
|
+
/** Body param: */
|
|
179
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
180
|
+
/** Body param: */
|
|
181
|
+
setJavaScriptEnabled?: boolean;
|
|
182
|
+
/** Body param: */
|
|
183
|
+
userAgent?: string;
|
|
184
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
185
|
+
viewport?: {
|
|
186
|
+
height: number;
|
|
187
|
+
width: number;
|
|
188
|
+
deviceScaleFactor?: number;
|
|
189
|
+
hasTouch?: boolean;
|
|
190
|
+
isLandscape?: boolean;
|
|
191
|
+
isMobile?: boolean;
|
|
192
|
+
};
|
|
193
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
194
|
+
waitForSelector?: {
|
|
195
|
+
selector: string;
|
|
196
|
+
hidden?: true;
|
|
197
|
+
timeout?: number;
|
|
198
|
+
visible?: true;
|
|
199
|
+
};
|
|
200
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
201
|
+
waitForTimeout?: number;
|
|
202
|
+
}
|
|
203
|
+
export declare const CreateJsonRequest: Schema.Schema<CreateJsonRequest>;
|
|
204
|
+
export type CreateJsonResponse = Record<string, unknown>;
|
|
205
|
+
export declare const CreateJsonResponse: Schema.Schema<CreateJsonResponse>;
|
|
206
|
+
export type CreateJsonError = DefaultErrors;
|
|
207
|
+
export declare const createJson: API.OperationMethod<CreateJsonRequest, CreateJsonResponse, CreateJsonError, Credentials | HttpClient.HttpClient>;
|
|
208
|
+
export interface CreateLinkRequest {
|
|
209
|
+
/** Path param: Account ID. */
|
|
210
|
+
accountId: string;
|
|
211
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
212
|
+
cacheTTL?: number;
|
|
213
|
+
/** Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set. */
|
|
214
|
+
html: string;
|
|
215
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
216
|
+
actionTimeout?: number;
|
|
217
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
218
|
+
addScriptTag?: {
|
|
219
|
+
id?: string;
|
|
220
|
+
content?: string;
|
|
221
|
+
type?: string;
|
|
222
|
+
url?: string;
|
|
223
|
+
}[];
|
|
224
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
225
|
+
addStyleTag?: {
|
|
226
|
+
content?: string;
|
|
227
|
+
url?: string;
|
|
228
|
+
}[];
|
|
229
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
230
|
+
allowRequestPattern?: string[];
|
|
231
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
232
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
233
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
234
|
+
authenticate?: {
|
|
235
|
+
password: string;
|
|
236
|
+
username: string;
|
|
237
|
+
};
|
|
238
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
239
|
+
bestAttempt?: boolean;
|
|
240
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
241
|
+
cookies?: {
|
|
242
|
+
name: string;
|
|
243
|
+
value: string;
|
|
244
|
+
domain?: string;
|
|
245
|
+
expires?: number;
|
|
246
|
+
httpOnly?: boolean;
|
|
247
|
+
partitionKey?: string;
|
|
248
|
+
path?: string;
|
|
249
|
+
priority?: "Low" | "Medium" | "High";
|
|
250
|
+
sameParty?: boolean;
|
|
251
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
252
|
+
secure?: boolean;
|
|
253
|
+
sourcePort?: number;
|
|
254
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
255
|
+
url?: string;
|
|
256
|
+
}[];
|
|
257
|
+
/** Body param: */
|
|
258
|
+
emulateMediaType?: string;
|
|
259
|
+
/** Body param: */
|
|
260
|
+
excludeExternalLinks?: boolean;
|
|
261
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
262
|
+
gotoOptions?: {
|
|
263
|
+
referer?: string;
|
|
264
|
+
referrerPolicy?: string;
|
|
265
|
+
timeout?: number;
|
|
266
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
267
|
+
};
|
|
268
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
269
|
+
rejectRequestPattern?: string[];
|
|
270
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
271
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
272
|
+
/** Body param: */
|
|
273
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
274
|
+
/** Body param: */
|
|
275
|
+
setJavaScriptEnabled?: boolean;
|
|
276
|
+
/** Body param: */
|
|
277
|
+
userAgent?: string;
|
|
278
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
279
|
+
viewport?: {
|
|
280
|
+
height: number;
|
|
281
|
+
width: number;
|
|
282
|
+
deviceScaleFactor?: number;
|
|
283
|
+
hasTouch?: boolean;
|
|
284
|
+
isLandscape?: boolean;
|
|
285
|
+
isMobile?: boolean;
|
|
286
|
+
};
|
|
287
|
+
/** Body param: */
|
|
288
|
+
visibleLinksOnly?: boolean;
|
|
289
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
290
|
+
waitForSelector?: {
|
|
291
|
+
selector: string;
|
|
292
|
+
hidden?: true;
|
|
293
|
+
timeout?: number;
|
|
294
|
+
visible?: true;
|
|
295
|
+
};
|
|
296
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
297
|
+
waitForTimeout?: number;
|
|
298
|
+
}
|
|
299
|
+
export declare const CreateLinkRequest: Schema.Schema<CreateLinkRequest>;
|
|
300
|
+
export type CreateLinkResponse = string[];
|
|
301
|
+
export declare const CreateLinkResponse: Schema.Schema<CreateLinkResponse>;
|
|
302
|
+
export type CreateLinkError = DefaultErrors;
|
|
303
|
+
export declare const createLink: API.OperationMethod<CreateLinkRequest, CreateLinkResponse, CreateLinkError, Credentials | HttpClient.HttpClient>;
|
|
304
|
+
export interface CreateMarkdownRequest {
|
|
305
|
+
/** Path param: Account ID. */
|
|
306
|
+
accountId: string;
|
|
307
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
308
|
+
cacheTTL?: number;
|
|
309
|
+
/** Body param: URL to navigate to, eg. `https://example.com`. */
|
|
310
|
+
url: string;
|
|
311
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
312
|
+
actionTimeout?: number;
|
|
313
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
314
|
+
addScriptTag?: {
|
|
315
|
+
id?: string;
|
|
316
|
+
content?: string;
|
|
317
|
+
type?: string;
|
|
318
|
+
url?: string;
|
|
319
|
+
}[];
|
|
320
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
321
|
+
addStyleTag?: {
|
|
322
|
+
content?: string;
|
|
323
|
+
url?: string;
|
|
324
|
+
}[];
|
|
325
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
326
|
+
allowRequestPattern?: string[];
|
|
327
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
328
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
329
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
330
|
+
authenticate?: {
|
|
331
|
+
password: string;
|
|
332
|
+
username: string;
|
|
333
|
+
};
|
|
334
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
335
|
+
bestAttempt?: boolean;
|
|
336
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
337
|
+
cookies?: {
|
|
338
|
+
name: string;
|
|
339
|
+
value: string;
|
|
340
|
+
domain?: string;
|
|
341
|
+
expires?: number;
|
|
342
|
+
httpOnly?: boolean;
|
|
343
|
+
partitionKey?: string;
|
|
344
|
+
path?: string;
|
|
345
|
+
priority?: "Low" | "Medium" | "High";
|
|
346
|
+
sameParty?: boolean;
|
|
347
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
348
|
+
secure?: boolean;
|
|
349
|
+
sourcePort?: number;
|
|
350
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
351
|
+
url?: string;
|
|
352
|
+
}[];
|
|
353
|
+
/** Body param: */
|
|
354
|
+
emulateMediaType?: string;
|
|
355
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
356
|
+
gotoOptions?: {
|
|
357
|
+
referer?: string;
|
|
358
|
+
referrerPolicy?: string;
|
|
359
|
+
timeout?: number;
|
|
360
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
361
|
+
};
|
|
362
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
363
|
+
rejectRequestPattern?: string[];
|
|
364
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
365
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
366
|
+
/** Body param: */
|
|
367
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
368
|
+
/** Body param: */
|
|
369
|
+
setJavaScriptEnabled?: boolean;
|
|
370
|
+
/** Body param: */
|
|
371
|
+
userAgent?: string;
|
|
372
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
373
|
+
viewport?: {
|
|
374
|
+
height: number;
|
|
375
|
+
width: number;
|
|
376
|
+
deviceScaleFactor?: number;
|
|
377
|
+
hasTouch?: boolean;
|
|
378
|
+
isLandscape?: boolean;
|
|
379
|
+
isMobile?: boolean;
|
|
380
|
+
};
|
|
381
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
382
|
+
waitForSelector?: {
|
|
383
|
+
selector: string;
|
|
384
|
+
hidden?: true;
|
|
385
|
+
timeout?: number;
|
|
386
|
+
visible?: true;
|
|
387
|
+
};
|
|
388
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
389
|
+
waitForTimeout?: number;
|
|
390
|
+
}
|
|
391
|
+
export declare const CreateMarkdownRequest: Schema.Schema<CreateMarkdownRequest>;
|
|
392
|
+
export type CreateMarkdownResponse = string;
|
|
393
|
+
export declare const CreateMarkdownResponse: Schema.Schema<string>;
|
|
394
|
+
export type CreateMarkdownError = DefaultErrors;
|
|
395
|
+
export declare const createMarkdown: API.OperationMethod<CreateMarkdownRequest, CreateMarkdownResponse, CreateMarkdownError, Credentials | HttpClient.HttpClient>;
|
|
396
|
+
export interface CreatePdfRequest {
|
|
397
|
+
/** Path param: Account ID. */
|
|
398
|
+
accountId: string;
|
|
399
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
400
|
+
cacheTTL?: number;
|
|
401
|
+
/** Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set. */
|
|
402
|
+
html: string;
|
|
403
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
404
|
+
actionTimeout?: number;
|
|
405
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
406
|
+
addScriptTag?: {
|
|
407
|
+
id?: string;
|
|
408
|
+
content?: string;
|
|
409
|
+
type?: string;
|
|
410
|
+
url?: string;
|
|
411
|
+
}[];
|
|
412
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
413
|
+
addStyleTag?: {
|
|
414
|
+
content?: string;
|
|
415
|
+
url?: string;
|
|
416
|
+
}[];
|
|
417
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
418
|
+
allowRequestPattern?: string[];
|
|
419
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
420
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
421
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
422
|
+
authenticate?: {
|
|
423
|
+
password: string;
|
|
424
|
+
username: string;
|
|
425
|
+
};
|
|
426
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
427
|
+
bestAttempt?: boolean;
|
|
428
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
429
|
+
cookies?: {
|
|
430
|
+
name: string;
|
|
431
|
+
value: string;
|
|
432
|
+
domain?: string;
|
|
433
|
+
expires?: number;
|
|
434
|
+
httpOnly?: boolean;
|
|
435
|
+
partitionKey?: string;
|
|
436
|
+
path?: string;
|
|
437
|
+
priority?: "Low" | "Medium" | "High";
|
|
438
|
+
sameParty?: boolean;
|
|
439
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
440
|
+
secure?: boolean;
|
|
441
|
+
sourcePort?: number;
|
|
442
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
443
|
+
url?: string;
|
|
444
|
+
}[];
|
|
445
|
+
/** Body param: */
|
|
446
|
+
emulateMediaType?: string;
|
|
447
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
448
|
+
gotoOptions?: {
|
|
449
|
+
referer?: string;
|
|
450
|
+
referrerPolicy?: string;
|
|
451
|
+
timeout?: number;
|
|
452
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
453
|
+
};
|
|
454
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.pdfoptions). */
|
|
455
|
+
pdfOptions?: {
|
|
456
|
+
displayHeaderFooter?: boolean;
|
|
457
|
+
footerTemplate?: string;
|
|
458
|
+
format?: "letter" | "legal" | "tabloid" | "ledger" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "a6";
|
|
459
|
+
headerTemplate?: string;
|
|
460
|
+
height?: string | number;
|
|
461
|
+
landscape?: boolean;
|
|
462
|
+
margin?: {
|
|
463
|
+
bottom?: string | number;
|
|
464
|
+
left?: string | number;
|
|
465
|
+
right?: string | number;
|
|
466
|
+
top?: string | number;
|
|
467
|
+
};
|
|
468
|
+
omitBackground?: boolean;
|
|
469
|
+
outline?: boolean;
|
|
470
|
+
pageRanges?: string;
|
|
471
|
+
preferCSSPageSize?: boolean;
|
|
472
|
+
printBackground?: boolean;
|
|
473
|
+
scale?: number;
|
|
474
|
+
tagged?: boolean;
|
|
475
|
+
timeout?: number;
|
|
476
|
+
width?: string | number;
|
|
477
|
+
};
|
|
478
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
479
|
+
rejectRequestPattern?: string[];
|
|
480
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
481
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
482
|
+
/** Body param: */
|
|
483
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
484
|
+
/** Body param: */
|
|
485
|
+
setJavaScriptEnabled?: boolean;
|
|
486
|
+
/** Body param: */
|
|
487
|
+
userAgent?: string;
|
|
488
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
489
|
+
viewport?: {
|
|
490
|
+
height: number;
|
|
491
|
+
width: number;
|
|
492
|
+
deviceScaleFactor?: number;
|
|
493
|
+
hasTouch?: boolean;
|
|
494
|
+
isLandscape?: boolean;
|
|
495
|
+
isMobile?: boolean;
|
|
496
|
+
};
|
|
497
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
498
|
+
waitForSelector?: {
|
|
499
|
+
selector: string;
|
|
500
|
+
hidden?: true;
|
|
501
|
+
timeout?: number;
|
|
502
|
+
visible?: true;
|
|
503
|
+
};
|
|
504
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
505
|
+
waitForTimeout?: number;
|
|
506
|
+
}
|
|
507
|
+
export declare const CreatePdfRequest: Schema.Schema<CreatePdfRequest>;
|
|
508
|
+
export type CreatePdfResponse = unknown;
|
|
509
|
+
export declare const CreatePdfResponse: Schema.Schema<unknown>;
|
|
510
|
+
export type CreatePdfError = DefaultErrors;
|
|
511
|
+
export declare const createPdf: API.OperationMethod<CreatePdfRequest, CreatePdfResponse, CreatePdfError, Credentials | HttpClient.HttpClient>;
|
|
512
|
+
export interface CreateScrapeRequest {
|
|
513
|
+
/** Path param: Account ID. */
|
|
514
|
+
accountId: string;
|
|
515
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
516
|
+
cacheTTL?: number;
|
|
517
|
+
/** Body param: */
|
|
518
|
+
elements: {
|
|
519
|
+
selector: string;
|
|
520
|
+
}[];
|
|
521
|
+
/** Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set. */
|
|
522
|
+
html: string;
|
|
523
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
524
|
+
actionTimeout?: number;
|
|
525
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
526
|
+
addScriptTag?: {
|
|
527
|
+
id?: string;
|
|
528
|
+
content?: string;
|
|
529
|
+
type?: string;
|
|
530
|
+
url?: string;
|
|
531
|
+
}[];
|
|
532
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
533
|
+
addStyleTag?: {
|
|
534
|
+
content?: string;
|
|
535
|
+
url?: string;
|
|
536
|
+
}[];
|
|
537
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
538
|
+
allowRequestPattern?: string[];
|
|
539
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
540
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
541
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
542
|
+
authenticate?: {
|
|
543
|
+
password: string;
|
|
544
|
+
username: string;
|
|
545
|
+
};
|
|
546
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
547
|
+
bestAttempt?: boolean;
|
|
548
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
549
|
+
cookies?: {
|
|
550
|
+
name: string;
|
|
551
|
+
value: string;
|
|
552
|
+
domain?: string;
|
|
553
|
+
expires?: number;
|
|
554
|
+
httpOnly?: boolean;
|
|
555
|
+
partitionKey?: string;
|
|
556
|
+
path?: string;
|
|
557
|
+
priority?: "Low" | "Medium" | "High";
|
|
558
|
+
sameParty?: boolean;
|
|
559
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
560
|
+
secure?: boolean;
|
|
561
|
+
sourcePort?: number;
|
|
562
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
563
|
+
url?: string;
|
|
564
|
+
}[];
|
|
565
|
+
/** Body param: */
|
|
566
|
+
emulateMediaType?: string;
|
|
567
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
568
|
+
gotoOptions?: {
|
|
569
|
+
referer?: string;
|
|
570
|
+
referrerPolicy?: string;
|
|
571
|
+
timeout?: number;
|
|
572
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
573
|
+
};
|
|
574
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
575
|
+
rejectRequestPattern?: string[];
|
|
576
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
577
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
578
|
+
/** Body param: */
|
|
579
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
580
|
+
/** Body param: */
|
|
581
|
+
setJavaScriptEnabled?: boolean;
|
|
582
|
+
/** Body param: */
|
|
583
|
+
userAgent?: string;
|
|
584
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
585
|
+
viewport?: {
|
|
586
|
+
height: number;
|
|
587
|
+
width: number;
|
|
588
|
+
deviceScaleFactor?: number;
|
|
589
|
+
hasTouch?: boolean;
|
|
590
|
+
isLandscape?: boolean;
|
|
591
|
+
isMobile?: boolean;
|
|
592
|
+
};
|
|
593
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
594
|
+
waitForSelector?: {
|
|
595
|
+
selector: string;
|
|
596
|
+
hidden?: true;
|
|
597
|
+
timeout?: number;
|
|
598
|
+
visible?: true;
|
|
599
|
+
};
|
|
600
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
601
|
+
waitForTimeout?: number;
|
|
602
|
+
}
|
|
603
|
+
export declare const CreateScrapeRequest: Schema.Schema<CreateScrapeRequest>;
|
|
604
|
+
export type CreateScrapeResponse = {
|
|
605
|
+
results: {
|
|
606
|
+
attributes: {
|
|
607
|
+
name: string;
|
|
608
|
+
value: string;
|
|
609
|
+
}[];
|
|
610
|
+
height: number;
|
|
611
|
+
html: string;
|
|
612
|
+
left: number;
|
|
613
|
+
text: string;
|
|
614
|
+
top: number;
|
|
615
|
+
width: number;
|
|
616
|
+
};
|
|
617
|
+
selector: string;
|
|
618
|
+
}[];
|
|
619
|
+
export declare const CreateScrapeResponse: Schema.Schema<CreateScrapeResponse>;
|
|
620
|
+
export type CreateScrapeError = DefaultErrors;
|
|
621
|
+
export declare const createScrape: API.OperationMethod<CreateScrapeRequest, CreateScrapeResponse, CreateScrapeError, Credentials | HttpClient.HttpClient>;
|
|
622
|
+
export interface CreateScreenshotRequest {
|
|
623
|
+
/** Path param: Account ID. */
|
|
624
|
+
accountId: string;
|
|
625
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
626
|
+
cacheTTL?: number;
|
|
627
|
+
/** Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set. */
|
|
628
|
+
html: string;
|
|
629
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
630
|
+
actionTimeout?: number;
|
|
631
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
632
|
+
addScriptTag?: {
|
|
633
|
+
id?: string;
|
|
634
|
+
content?: string;
|
|
635
|
+
type?: string;
|
|
636
|
+
url?: string;
|
|
637
|
+
}[];
|
|
638
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
639
|
+
addStyleTag?: {
|
|
640
|
+
content?: string;
|
|
641
|
+
url?: string;
|
|
642
|
+
}[];
|
|
643
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
644
|
+
allowRequestPattern?: string[];
|
|
645
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
646
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
647
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
648
|
+
authenticate?: {
|
|
649
|
+
password: string;
|
|
650
|
+
username: string;
|
|
651
|
+
};
|
|
652
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
653
|
+
bestAttempt?: boolean;
|
|
654
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
655
|
+
cookies?: {
|
|
656
|
+
name: string;
|
|
657
|
+
value: string;
|
|
658
|
+
domain?: string;
|
|
659
|
+
expires?: number;
|
|
660
|
+
httpOnly?: boolean;
|
|
661
|
+
partitionKey?: string;
|
|
662
|
+
path?: string;
|
|
663
|
+
priority?: "Low" | "Medium" | "High";
|
|
664
|
+
sameParty?: boolean;
|
|
665
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
666
|
+
secure?: boolean;
|
|
667
|
+
sourcePort?: number;
|
|
668
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
669
|
+
url?: string;
|
|
670
|
+
}[];
|
|
671
|
+
/** Body param: */
|
|
672
|
+
emulateMediaType?: string;
|
|
673
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
674
|
+
gotoOptions?: {
|
|
675
|
+
referer?: string;
|
|
676
|
+
referrerPolicy?: string;
|
|
677
|
+
timeout?: number;
|
|
678
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
679
|
+
};
|
|
680
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
681
|
+
rejectRequestPattern?: string[];
|
|
682
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
683
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
684
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.screenshotoptions). */
|
|
685
|
+
screenshotOptions?: {
|
|
686
|
+
captureBeyondViewport?: boolean;
|
|
687
|
+
clip?: {
|
|
688
|
+
height: number;
|
|
689
|
+
width: number;
|
|
690
|
+
x: number;
|
|
691
|
+
y: number;
|
|
692
|
+
scale?: number;
|
|
693
|
+
};
|
|
694
|
+
encoding?: "binary" | "base64";
|
|
695
|
+
fromSurface?: boolean;
|
|
696
|
+
fullPage?: boolean;
|
|
697
|
+
omitBackground?: boolean;
|
|
698
|
+
optimizeForSpeed?: boolean;
|
|
699
|
+
quality?: number;
|
|
700
|
+
type?: "png" | "jpeg" | "webp";
|
|
701
|
+
};
|
|
702
|
+
/** Body param: */
|
|
703
|
+
scrollPage?: boolean;
|
|
704
|
+
/** Body param: */
|
|
705
|
+
selector?: string;
|
|
706
|
+
/** Body param: */
|
|
707
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
708
|
+
/** Body param: */
|
|
709
|
+
setJavaScriptEnabled?: boolean;
|
|
710
|
+
/** Body param: */
|
|
711
|
+
userAgent?: string;
|
|
712
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
713
|
+
viewport?: {
|
|
714
|
+
height: number;
|
|
715
|
+
width: number;
|
|
716
|
+
deviceScaleFactor?: number;
|
|
717
|
+
hasTouch?: boolean;
|
|
718
|
+
isLandscape?: boolean;
|
|
719
|
+
isMobile?: boolean;
|
|
720
|
+
};
|
|
721
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
722
|
+
waitForSelector?: {
|
|
723
|
+
selector: string;
|
|
724
|
+
hidden?: true;
|
|
725
|
+
timeout?: number;
|
|
726
|
+
visible?: true;
|
|
727
|
+
};
|
|
728
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
729
|
+
waitForTimeout?: number;
|
|
730
|
+
}
|
|
731
|
+
export declare const CreateScreenshotRequest: Schema.Schema<CreateScreenshotRequest>;
|
|
732
|
+
export interface CreateScreenshotResponse {
|
|
733
|
+
/** Response status */
|
|
734
|
+
success: boolean;
|
|
735
|
+
errors?: {
|
|
736
|
+
code: number;
|
|
737
|
+
message: string;
|
|
738
|
+
}[] | null;
|
|
739
|
+
}
|
|
740
|
+
export declare const CreateScreenshotResponse: Schema.Schema<CreateScreenshotResponse>;
|
|
741
|
+
export type CreateScreenshotError = DefaultErrors;
|
|
742
|
+
export declare const createScreenshot: API.OperationMethod<CreateScreenshotRequest, CreateScreenshotResponse, CreateScreenshotError, Credentials | HttpClient.HttpClient>;
|
|
743
|
+
export interface CreateSnapshotRequest {
|
|
744
|
+
/** Path param: Account ID. */
|
|
745
|
+
accountId: string;
|
|
746
|
+
/** Query param: Cache TTL default is 5s. Set to 0 to disable. */
|
|
747
|
+
cacheTTL?: number;
|
|
748
|
+
/** Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set. */
|
|
749
|
+
html: string;
|
|
750
|
+
/** Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceed */
|
|
751
|
+
actionTimeout?: number;
|
|
752
|
+
/** Body param: Adds a `<script>` tag into the page with the desired URL or content. */
|
|
753
|
+
addScriptTag?: {
|
|
754
|
+
id?: string;
|
|
755
|
+
content?: string;
|
|
756
|
+
type?: string;
|
|
757
|
+
url?: string;
|
|
758
|
+
}[];
|
|
759
|
+
/** Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content. */
|
|
760
|
+
addStyleTag?: {
|
|
761
|
+
content?: string;
|
|
762
|
+
url?: string;
|
|
763
|
+
}[];
|
|
764
|
+
/** Body param: Only allow requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
765
|
+
allowRequestPattern?: string[];
|
|
766
|
+
/** Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
767
|
+
allowResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
768
|
+
/** Body param: Provide credentials for HTTP authentication. */
|
|
769
|
+
authenticate?: {
|
|
770
|
+
password: string;
|
|
771
|
+
username: string;
|
|
772
|
+
};
|
|
773
|
+
/** Body param: Attempt to proceed when 'awaited' events fail or timeout. */
|
|
774
|
+
bestAttempt?: boolean;
|
|
775
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie). */
|
|
776
|
+
cookies?: {
|
|
777
|
+
name: string;
|
|
778
|
+
value: string;
|
|
779
|
+
domain?: string;
|
|
780
|
+
expires?: number;
|
|
781
|
+
httpOnly?: boolean;
|
|
782
|
+
partitionKey?: string;
|
|
783
|
+
path?: string;
|
|
784
|
+
priority?: "Low" | "Medium" | "High";
|
|
785
|
+
sameParty?: boolean;
|
|
786
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
787
|
+
secure?: boolean;
|
|
788
|
+
sourcePort?: number;
|
|
789
|
+
sourceScheme?: "Unset" | "NonSecure" | "Secure";
|
|
790
|
+
url?: string;
|
|
791
|
+
}[];
|
|
792
|
+
/** Body param: */
|
|
793
|
+
emulateMediaType?: string;
|
|
794
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions). */
|
|
795
|
+
gotoOptions?: {
|
|
796
|
+
referer?: string;
|
|
797
|
+
referrerPolicy?: string;
|
|
798
|
+
timeout?: number;
|
|
799
|
+
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
|
|
800
|
+
};
|
|
801
|
+
/** Body param: Block undesired requests that match the provided regex patterns, eg. '/^.\ \.(css)'. */
|
|
802
|
+
rejectRequestPattern?: string[];
|
|
803
|
+
/** Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'. */
|
|
804
|
+
rejectResourceTypes?: ("document" | "stylesheet" | "image" | "media" | "font" | "script" | "texttrack" | "xhr" | "fetch" | "prefetch" | "eventsource" | "websocket" | "manifest" | "signedexchange" | "ping" | "cspviolationreport" | "preflight" | "other")[];
|
|
805
|
+
/** Body param: */
|
|
806
|
+
screenshotOptions?: {
|
|
807
|
+
captureBeyondViewport?: boolean;
|
|
808
|
+
clip?: {
|
|
809
|
+
height: number;
|
|
810
|
+
width: number;
|
|
811
|
+
x: number;
|
|
812
|
+
y: number;
|
|
813
|
+
scale?: number;
|
|
814
|
+
};
|
|
815
|
+
fromSurface?: boolean;
|
|
816
|
+
fullPage?: boolean;
|
|
817
|
+
omitBackground?: boolean;
|
|
818
|
+
optimizeForSpeed?: boolean;
|
|
819
|
+
quality?: number;
|
|
820
|
+
type?: "png" | "jpeg" | "webp";
|
|
821
|
+
};
|
|
822
|
+
/** Body param: */
|
|
823
|
+
setExtraHTTPHeaders?: Record<string, unknown>;
|
|
824
|
+
/** Body param: */
|
|
825
|
+
setJavaScriptEnabled?: boolean;
|
|
826
|
+
/** Body param: */
|
|
827
|
+
userAgent?: string;
|
|
828
|
+
/** Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport). */
|
|
829
|
+
viewport?: {
|
|
830
|
+
height: number;
|
|
831
|
+
width: number;
|
|
832
|
+
deviceScaleFactor?: number;
|
|
833
|
+
hasTouch?: boolean;
|
|
834
|
+
isLandscape?: boolean;
|
|
835
|
+
isMobile?: boolean;
|
|
836
|
+
};
|
|
837
|
+
/** Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector). */
|
|
838
|
+
waitForSelector?: {
|
|
839
|
+
selector: string;
|
|
840
|
+
hidden?: true;
|
|
841
|
+
timeout?: number;
|
|
842
|
+
visible?: true;
|
|
843
|
+
};
|
|
844
|
+
/** Body param: Waits for a specified timeout before continuing. */
|
|
845
|
+
waitForTimeout?: number;
|
|
846
|
+
}
|
|
847
|
+
export declare const CreateSnapshotRequest: Schema.Schema<CreateSnapshotRequest>;
|
|
848
|
+
export interface CreateSnapshotResponse {
|
|
849
|
+
/** HTML content */
|
|
850
|
+
content: string;
|
|
851
|
+
/** Base64 encoded image */
|
|
852
|
+
screenshot: string;
|
|
853
|
+
}
|
|
854
|
+
export declare const CreateSnapshotResponse: Schema.Schema<CreateSnapshotResponse>;
|
|
855
|
+
export type CreateSnapshotError = DefaultErrors;
|
|
856
|
+
export declare const createSnapshot: API.OperationMethod<CreateSnapshotRequest, CreateSnapshotResponse, CreateSnapshotError, Credentials | HttpClient.HttpClient>;
|
|
857
|
+
//# sourceMappingURL=browser-rendering.d.ts.map
|