@interfere/sdk 8.1.6 → 9.0.2
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/CHANGELOG.md +6 -0
- package/CONTRIBUTING.md +26 -0
- package/README.md +3 -1
- package/USAGE.md +71 -0
- package/docs/lib/utils/retryconfig.md +24 -0
- package/docs/models/auth0-identify-source-name.md +15 -0
- package/docs/models/auth0-identify-source.md +19 -0
- package/docs/models/browser-context.md +37 -0
- package/docs/models/browser-metadata.md +26 -0
- package/docs/models/clerk-identify-source-name.md +15 -0
- package/docs/models/clerk-identify-source.md +19 -0
- package/docs/models/config-response-plugins.md +14 -0
- package/docs/models/config-response.md +17 -0
- package/docs/models/custom-identify-source.md +19 -0
- package/docs/models/debug-ids.md +14 -0
- package/docs/models/destination-provider.md +15 -0
- package/docs/models/details.md +14 -0
- package/docs/models/device-browser.md +18 -0
- package/docs/models/device-cpu.md +15 -0
- package/docs/models/device-engine.md +16 -0
- package/docs/models/device-info.md +17 -0
- package/docs/models/device-metadata.md +29 -0
- package/docs/models/device-os.md +16 -0
- package/docs/models/display.md +20 -0
- package/docs/models/edge-context.md +19 -0
- package/docs/models/envelope-context.md +47 -0
- package/docs/models/envelope.md +133 -0
- package/docs/models/environment.md +17 -0
- package/docs/models/error-envelope.md +41 -0
- package/docs/models/error-mechanism.md +22 -0
- package/docs/models/error-payload.md +27 -0
- package/docs/models/errors/errors-problem.md +20 -0
- package/docs/models/errors/health-error.md +16 -0
- package/docs/models/exception.md +24 -0
- package/docs/models/file-t.md +16 -0
- package/docs/models/frame.md +22 -0
- package/docs/models/github-release-source-provider.md +15 -0
- package/docs/models/github-release-source.md +25 -0
- package/docs/models/hashes.md +14 -0
- package/docs/models/health-ok.md +17 -0
- package/docs/models/identify-source.md +34 -0
- package/docs/models/ingest-response.md +19 -0
- package/docs/models/nextjs-context.md +28 -0
- package/docs/models/operations/confirm-preflight-request.md +17 -0
- package/docs/models/operations/report-telemetry-request.md +27 -0
- package/docs/models/operations/upload-source-maps-multipart-request.md +28 -0
- package/docs/models/operations/upload-source-maps-request.md +29 -0
- package/docs/models/org-ref.md +19 -0
- package/docs/models/org.md +19 -0
- package/docs/models/pageleave-envelope.md +41 -0
- package/docs/models/pageleave-payload.md +20 -0
- package/docs/models/pageview-envelope.md +41 -0
- package/docs/models/pageview-payload.md +20 -0
- package/docs/models/rage-click-envelope.md +47 -0
- package/docs/models/rage-click-payload.md +31 -0
- package/docs/models/release-build-ref.md +17 -0
- package/docs/models/release-destination-ref.md +21 -0
- package/docs/models/release-destination.md +19 -0
- package/docs/models/release-source-ref.md +17 -0
- package/docs/models/release-source.md +16 -0
- package/docs/models/releases-config-response-plugins.md +19 -0
- package/docs/models/releases-config-response.md +29 -0
- package/docs/models/releases-create-request.md +37 -0
- package/docs/models/releases-create-response.md +41 -0
- package/docs/models/releases-preflight-response.md +19 -0
- package/docs/models/releases-telemetry-request.md +31 -0
- package/docs/models/releases-telemetry-response.md +17 -0
- package/docs/models/releases-upload-source-maps-request1.md +26 -0
- package/docs/models/releases-upload-source-maps-request2.md +27 -0
- package/docs/models/releases-upload-source-maps-response.md +23 -0
- package/docs/models/render-source.md +15 -0
- package/docs/models/render-type.md +15 -0
- package/docs/models/replay-chunk-envelope.md +43 -0
- package/docs/models/replay-chunk-payload.md +28 -0
- package/docs/models/revalidate-reason.md +15 -0
- package/docs/models/route-type.md +15 -0
- package/docs/models/router-kind.md +15 -0
- package/docs/models/runtime-enum.md +17 -0
- package/docs/models/screen.md +20 -0
- package/docs/models/sdk-config.md +15 -0
- package/docs/models/session-create-request.md +22 -0
- package/docs/models/session-identify-request.md +34 -0
- package/docs/models/session-response.md +17 -0
- package/docs/models/session-source.md +17 -0
- package/docs/models/source-map-to-generated.md +14 -0
- package/docs/models/source-provider.md +15 -0
- package/docs/models/surface-ref.md +19 -0
- package/docs/models/surface.md +27 -0
- package/docs/models/ui-event-envelope.md +45 -0
- package/docs/models/ui-event-payload.md +23 -0
- package/docs/models/upload-source-maps-metadata.md +23 -0
- package/docs/models/vercel-release-destination-provider.md +15 -0
- package/docs/models/vercel-release-destination.md +31 -0
- package/docs/sdks/config/README.md +72 -0
- package/docs/sdks/health/README.md +72 -0
- package/docs/sdks/ingest/README.md +176 -0
- package/docs/sdks/releases/README.md +240 -0
- package/docs/sdks/sessions/README.md +156 -0
- package/docs/sdks/sourcemaps/README.md +174 -0
- package/docs/sdks/telemetry/README.md +95 -0
- package/esm/core.d.ts +10 -0
- package/esm/core.d.ts.map +1 -0
- package/esm/core.js +13 -0
- package/esm/core.js.map +1 -0
- package/esm/funcs/config-get.d.ts +12 -0
- package/esm/funcs/config-get.d.ts.map +1 -0
- package/esm/funcs/config-get.js +72 -0
- package/esm/funcs/config-get.js.map +1 -0
- package/esm/funcs/health-get.d.ts +12 -0
- package/esm/funcs/health-get.d.ts.map +1 -0
- package/esm/funcs/health-get.js +72 -0
- package/esm/funcs/health-get.js.map +1 -0
- package/esm/funcs/ingest-post.d.ts +12 -0
- package/esm/funcs/ingest-post.d.ts.map +1 -0
- package/esm/funcs/ingest-post.js +83 -0
- package/esm/funcs/ingest-post.js.map +1 -0
- package/esm/funcs/releases-create.d.ts +12 -0
- package/esm/funcs/releases-create.d.ts.map +1 -0
- package/esm/funcs/releases-create.js +83 -0
- package/esm/funcs/releases-create.js.map +1 -0
- package/esm/funcs/releases-get-config.d.ts +12 -0
- package/esm/funcs/releases-get-config.d.ts.map +1 -0
- package/esm/funcs/releases-get-config.js +72 -0
- package/esm/funcs/releases-get-config.js.map +1 -0
- package/esm/funcs/releases-preflight.d.ts +13 -0
- package/esm/funcs/releases-preflight.d.ts.map +1 -0
- package/esm/funcs/releases-preflight.js +89 -0
- package/esm/funcs/releases-preflight.js.map +1 -0
- package/esm/funcs/sessions-create.d.ts +12 -0
- package/esm/funcs/sessions-create.d.ts.map +1 -0
- package/esm/funcs/sessions-create.js +83 -0
- package/esm/funcs/sessions-create.js.map +1 -0
- package/esm/funcs/sessions-identify.d.ts +12 -0
- package/esm/funcs/sessions-identify.d.ts.map +1 -0
- package/esm/funcs/sessions-identify.js +83 -0
- package/esm/funcs/sessions-identify.js.map +1 -0
- package/esm/funcs/source-maps-upload-multipart.d.ts +13 -0
- package/esm/funcs/source-maps-upload-multipart.d.ts.map +1 -0
- package/esm/funcs/source-maps-upload-multipart.js +112 -0
- package/esm/funcs/source-maps-upload-multipart.js.map +1 -0
- package/esm/funcs/source-maps-upload.d.ts +13 -0
- package/esm/funcs/source-maps-upload.d.ts.map +1 -0
- package/esm/funcs/source-maps-upload.js +90 -0
- package/esm/funcs/source-maps-upload.js.map +1 -0
- package/esm/funcs/telemetry-report.d.ts +13 -0
- package/esm/funcs/telemetry-report.d.ts.map +1 -0
- package/esm/funcs/telemetry-report.js +90 -0
- package/esm/funcs/telemetry-report.js.map +1 -0
- package/esm/hooks/hooks.d.ts +25 -0
- package/esm/hooks/hooks.d.ts.map +1 -0
- package/esm/hooks/hooks.js +82 -0
- package/esm/hooks/hooks.js.map +1 -0
- package/esm/hooks/index.d.ts +3 -0
- package/esm/hooks/index.d.ts.map +1 -0
- package/esm/hooks/index.js +6 -0
- package/esm/hooks/index.js.map +1 -0
- package/esm/hooks/registration.d.ts +3 -0
- package/esm/hooks/registration.d.ts.map +1 -0
- package/esm/hooks/registration.js +12 -0
- package/esm/hooks/registration.js.map +1 -0
- package/esm/hooks/types.d.ts +76 -0
- package/esm/hooks/types.d.ts.map +1 -0
- package/esm/hooks/types.js +5 -0
- package/esm/hooks/types.js.map +1 -0
- package/esm/index.d.ts +6 -0
- package/esm/index.d.ts.map +1 -0
- package/esm/index.js +8 -0
- package/esm/index.js.map +1 -0
- package/esm/lib/base64.d.ts +10 -0
- package/esm/lib/base64.d.ts.map +1 -0
- package/esm/lib/base64.js +31 -0
- package/esm/lib/base64.js.map +1 -0
- package/esm/lib/config.d.ts +41 -0
- package/esm/lib/config.d.ts.map +1 -0
- package/esm/lib/config.js +34 -0
- package/esm/lib/config.js.map +1 -0
- package/esm/lib/dlv.d.ts +14 -0
- package/esm/lib/dlv.d.ts.map +1 -0
- package/esm/lib/dlv.js +46 -0
- package/esm/lib/dlv.js.map +1 -0
- package/esm/lib/encodings.d.ts +54 -0
- package/esm/lib/encodings.d.ts.map +1 -0
- package/esm/lib/encodings.js +391 -0
- package/esm/lib/encodings.js.map +1 -0
- package/esm/lib/env.d.ts +14 -0
- package/esm/lib/env.d.ts.map +1 -0
- package/esm/lib/env.js +43 -0
- package/esm/lib/env.js.map +1 -0
- package/esm/lib/files.d.ts +26 -0
- package/esm/lib/files.d.ts.map +1 -0
- package/esm/lib/files.js +91 -0
- package/esm/lib/files.js.map +1 -0
- package/esm/lib/http.d.ts +67 -0
- package/esm/lib/http.d.ts.map +1 -0
- package/esm/lib/http.js +207 -0
- package/esm/lib/http.js.map +1 -0
- package/esm/lib/is-plain-object.d.ts +2 -0
- package/esm/lib/is-plain-object.d.ts.map +1 -0
- package/esm/lib/is-plain-object.js +38 -0
- package/esm/lib/is-plain-object.js.map +1 -0
- package/esm/lib/logger.d.ts +6 -0
- package/esm/lib/logger.d.ts.map +1 -0
- package/esm/lib/logger.js +5 -0
- package/esm/lib/logger.js.map +1 -0
- package/esm/lib/matchers.d.ts +59 -0
- package/esm/lib/matchers.d.ts.map +1 -0
- package/esm/lib/matchers.js +202 -0
- package/esm/lib/matchers.js.map +1 -0
- package/esm/lib/primitives.d.ts +26 -0
- package/esm/lib/primitives.d.ts.map +1 -0
- package/esm/lib/primitives.js +103 -0
- package/esm/lib/primitives.js.map +1 -0
- package/esm/lib/retries.d.ts +38 -0
- package/esm/lib/retries.d.ts.map +1 -0
- package/esm/lib/retries.js +147 -0
- package/esm/lib/retries.js.map +1 -0
- package/esm/lib/schemas.d.ts +21 -0
- package/esm/lib/schemas.d.ts.map +1 -0
- package/esm/lib/schemas.js +57 -0
- package/esm/lib/schemas.js.map +1 -0
- package/esm/lib/sdks.d.ts +63 -0
- package/esm/lib/sdks.d.ts.map +1 -0
- package/esm/lib/sdks.js +271 -0
- package/esm/lib/sdks.js.map +1 -0
- package/esm/lib/security.d.ts +80 -0
- package/esm/lib/security.d.ts.map +1 -0
- package/esm/lib/security.js +120 -0
- package/esm/lib/security.js.map +1 -0
- package/esm/lib/url.d.ts +5 -0
- package/esm/lib/url.d.ts.map +1 -0
- package/esm/lib/url.js +24 -0
- package/esm/lib/url.js.map +1 -0
- package/esm/models/auth0-identify-source.d.ts +21 -0
- package/esm/models/auth0-identify-source.d.ts.map +1 -0
- package/esm/models/auth0-identify-source.js +18 -0
- package/esm/models/auth0-identify-source.js.map +1 -0
- package/esm/models/browser-context.d.ts +65 -0
- package/esm/models/browser-context.d.ts.map +1 -0
- package/esm/models/browser-context.js +41 -0
- package/esm/models/browser-context.js.map +1 -0
- package/esm/models/clerk-identify-source.d.ts +21 -0
- package/esm/models/clerk-identify-source.d.ts.map +1 -0
- package/esm/models/clerk-identify-source.js +18 -0
- package/esm/models/clerk-identify-source.js.map +1 -0
- package/esm/models/config-response.d.ts +14 -0
- package/esm/models/config-response.d.ts.map +1 -0
- package/esm/models/config-response.js +18 -0
- package/esm/models/config-response.js.map +1 -0
- package/esm/models/custom-identify-source.d.ts +14 -0
- package/esm/models/custom-identify-source.d.ts.map +1 -0
- package/esm/models/custom-identify-source.js +13 -0
- package/esm/models/custom-identify-source.js.map +1 -0
- package/esm/models/device-browser.d.ts +18 -0
- package/esm/models/device-browser.d.ts.map +1 -0
- package/esm/models/device-browser.js +15 -0
- package/esm/models/device-browser.js.map +1 -0
- package/esm/models/device-cpu.d.ts +12 -0
- package/esm/models/device-cpu.d.ts.map +1 -0
- package/esm/models/device-cpu.js +12 -0
- package/esm/models/device-cpu.js.map +1 -0
- package/esm/models/device-engine.d.ts +14 -0
- package/esm/models/device-engine.d.ts.map +1 -0
- package/esm/models/device-engine.js +13 -0
- package/esm/models/device-engine.js.map +1 -0
- package/esm/models/device-info.d.ts +16 -0
- package/esm/models/device-info.d.ts.map +1 -0
- package/esm/models/device-info.js +14 -0
- package/esm/models/device-info.js.map +1 -0
- package/esm/models/device-os.d.ts +14 -0
- package/esm/models/device-os.d.ts.map +1 -0
- package/esm/models/device-os.js +13 -0
- package/esm/models/device-os.js.map +1 -0
- package/esm/models/display.d.ts +13 -0
- package/esm/models/display.d.ts.map +1 -0
- package/esm/models/display.js +13 -0
- package/esm/models/display.js.map +1 -0
- package/esm/models/edge-context.d.ts +15 -0
- package/esm/models/edge-context.d.ts.map +1 -0
- package/esm/models/edge-context.js +12 -0
- package/esm/models/edge-context.js.map +1 -0
- package/esm/models/envelope-context.d.ts +14 -0
- package/esm/models/envelope-context.d.ts.map +1 -0
- package/esm/models/envelope-context.js +17 -0
- package/esm/models/envelope-context.js.map +1 -0
- package/esm/models/envelope.d.ts +17 -0
- package/esm/models/envelope.d.ts.map +1 -0
- package/esm/models/envelope.js +23 -0
- package/esm/models/envelope.js.map +1 -0
- package/esm/models/environment.d.ts +17 -0
- package/esm/models/environment.d.ts.map +1 -0
- package/esm/models/environment.js +16 -0
- package/esm/models/environment.js.map +1 -0
- package/esm/models/error-envelope.d.ts +55 -0
- package/esm/models/error-envelope.d.ts.map +1 -0
- package/esm/models/error-envelope.js +30 -0
- package/esm/models/error-envelope.js.map +1 -0
- package/esm/models/error-mechanism.d.ts +19 -0
- package/esm/models/error-mechanism.d.ts.map +1 -0
- package/esm/models/error-mechanism.js +14 -0
- package/esm/models/error-mechanism.js.map +1 -0
- package/esm/models/error-payload.d.ts +16 -0
- package/esm/models/error-payload.d.ts.map +1 -0
- package/esm/models/error-payload.js +13 -0
- package/esm/models/error-payload.js.map +1 -0
- package/esm/models/errors/errors-problem.d.ts +30 -0
- package/esm/models/errors/errors-problem.d.ts.map +1 -0
- package/esm/models/errors/errors-problem.js +41 -0
- package/esm/models/errors/errors-problem.js.map +1 -0
- package/esm/models/errors/health-error.d.ts +19 -0
- package/esm/models/errors/health-error.d.ts.map +1 -0
- package/esm/models/errors/health-error.js +32 -0
- package/esm/models/errors/health-error.js.map +1 -0
- package/esm/models/errors/http-client-errors.d.ts +44 -0
- package/esm/models/errors/http-client-errors.d.ts.map +1 -0
- package/esm/models/errors/http-client-errors.js +69 -0
- package/esm/models/errors/http-client-errors.js.map +1 -0
- package/esm/models/errors/index.d.ts +8 -0
- package/esm/models/errors/index.d.ts.map +1 -0
- package/esm/models/errors/index.js +11 -0
- package/esm/models/errors/index.js.map +1 -0
- package/esm/models/errors/interfere-error.d.ts +10 -0
- package/esm/models/errors/interfere-error.d.ts.map +1 -0
- package/esm/models/errors/interfere-error.js +30 -0
- package/esm/models/errors/interfere-error.js.map +1 -0
- package/esm/models/errors/interfere-http-error.d.ts +19 -0
- package/esm/models/errors/interfere-http-error.d.ts.map +1 -0
- package/esm/models/errors/interfere-http-error.js +16 -0
- package/esm/models/errors/interfere-http-error.js.map +1 -0
- package/esm/models/errors/response-validation-error.d.ts +26 -0
- package/esm/models/errors/response-validation-error.d.ts.map +1 -0
- package/esm/models/errors/response-validation-error.js +29 -0
- package/esm/models/errors/response-validation-error.js.map +1 -0
- package/esm/models/errors/sdk-validation-error.d.ts +21 -0
- package/esm/models/errors/sdk-validation-error.d.ts.map +1 -0
- package/esm/models/errors/sdk-validation-error.js +44 -0
- package/esm/models/errors/sdk-validation-error.js.map +1 -0
- package/esm/models/errors-problem.d.ts +8 -0
- package/esm/models/errors-problem.d.ts.map +1 -0
- package/esm/models/errors-problem.js +11 -0
- package/esm/models/errors-problem.js.map +1 -0
- package/esm/models/exception.d.ts +23 -0
- package/esm/models/exception.d.ts.map +1 -0
- package/esm/models/exception.js +17 -0
- package/esm/models/exception.js.map +1 -0
- package/esm/models/frame.d.ts +25 -0
- package/esm/models/frame.d.ts.map +1 -0
- package/esm/models/frame.js +18 -0
- package/esm/models/frame.js.map +1 -0
- package/esm/models/github-release-source.d.ts +28 -0
- package/esm/models/github-release-source.d.ts.map +1 -0
- package/esm/models/github-release-source.js +20 -0
- package/esm/models/github-release-source.js.map +1 -0
- package/esm/models/health-ok.d.ts +10 -0
- package/esm/models/health-ok.d.ts.map +1 -0
- package/esm/models/health-ok.js +15 -0
- package/esm/models/health-ok.js.map +1 -0
- package/esm/models/identify-source.d.ts +14 -0
- package/esm/models/identify-source.d.ts.map +1 -0
- package/esm/models/identify-source.js +17 -0
- package/esm/models/identify-source.js.map +1 -0
- package/esm/models/index.d.ts +62 -0
- package/esm/models/index.d.ts.map +1 -0
- package/esm/models/index.js +65 -0
- package/esm/models/index.js.map +1 -0
- package/esm/models/ingest-response.d.ts +11 -0
- package/esm/models/ingest-response.d.ts.map +1 -0
- package/esm/models/ingest-response.js +15 -0
- package/esm/models/ingest-response.js.map +1 -0
- package/esm/models/nextjs-context.d.ts +38 -0
- package/esm/models/nextjs-context.d.ts.map +1 -0
- package/esm/models/nextjs-context.js +26 -0
- package/esm/models/nextjs-context.js.map +1 -0
- package/esm/models/operations/confirm-preflight.d.ts +12 -0
- package/esm/models/operations/confirm-preflight.d.ts.map +1 -0
- package/esm/models/operations/confirm-preflight.js +12 -0
- package/esm/models/operations/confirm-preflight.js.map +1 -0
- package/esm/models/operations/index.d.ts +5 -0
- package/esm/models/operations/index.d.ts.map +1 -0
- package/esm/models/operations/index.js +8 -0
- package/esm/models/operations/index.js.map +1 -0
- package/esm/models/operations/report-telemetry.d.ts +18 -0
- package/esm/models/operations/report-telemetry.d.ts.map +1 -0
- package/esm/models/operations/report-telemetry.js +14 -0
- package/esm/models/operations/report-telemetry.js.map +1 -0
- package/esm/models/operations/upload-source-maps-multipart.d.ts +18 -0
- package/esm/models/operations/upload-source-maps-multipart.d.ts.map +1 -0
- package/esm/models/operations/upload-source-maps-multipart.js +14 -0
- package/esm/models/operations/upload-source-maps-multipart.js.map +1 -0
- package/esm/models/operations/upload-source-maps.d.ts +18 -0
- package/esm/models/operations/upload-source-maps.d.ts.map +1 -0
- package/esm/models/operations/upload-source-maps.js +14 -0
- package/esm/models/operations/upload-source-maps.js.map +1 -0
- package/esm/models/org-ref.d.ts +11 -0
- package/esm/models/org-ref.d.ts.map +1 -0
- package/esm/models/org-ref.js +15 -0
- package/esm/models/org-ref.js.map +1 -0
- package/esm/models/pageleave-envelope.d.ts +55 -0
- package/esm/models/pageleave-envelope.d.ts.map +1 -0
- package/esm/models/pageleave-envelope.js +30 -0
- package/esm/models/pageleave-envelope.js.map +1 -0
- package/esm/models/pageleave-payload.d.ts +17 -0
- package/esm/models/pageleave-payload.d.ts.map +1 -0
- package/esm/models/pageleave-payload.js +13 -0
- package/esm/models/pageleave-payload.js.map +1 -0
- package/esm/models/pageview-envelope.d.ts +55 -0
- package/esm/models/pageview-envelope.d.ts.map +1 -0
- package/esm/models/pageview-envelope.js +30 -0
- package/esm/models/pageview-envelope.js.map +1 -0
- package/esm/models/pageview-payload.d.ts +17 -0
- package/esm/models/pageview-payload.d.ts.map +1 -0
- package/esm/models/pageview-payload.js +13 -0
- package/esm/models/pageview-payload.js.map +1 -0
- package/esm/models/rage-click-envelope.d.ts +55 -0
- package/esm/models/rage-click-envelope.d.ts.map +1 -0
- package/esm/models/rage-click-envelope.js +30 -0
- package/esm/models/rage-click-envelope.js.map +1 -0
- package/esm/models/rage-click-payload.d.ts +27 -0
- package/esm/models/rage-click-payload.d.ts.map +1 -0
- package/esm/models/rage-click-payload.js +18 -0
- package/esm/models/rage-click-payload.js.map +1 -0
- package/esm/models/release-build-ref.d.ts +10 -0
- package/esm/models/release-build-ref.d.ts.map +1 -0
- package/esm/models/release-build-ref.js +14 -0
- package/esm/models/release-build-ref.js.map +1 -0
- package/esm/models/release-destination-ref.d.ts +12 -0
- package/esm/models/release-destination-ref.d.ts.map +1 -0
- package/esm/models/release-destination-ref.js +16 -0
- package/esm/models/release-destination-ref.js.map +1 -0
- package/esm/models/release-source-ref.d.ts +10 -0
- package/esm/models/release-source-ref.d.ts.map +1 -0
- package/esm/models/release-source-ref.js +14 -0
- package/esm/models/release-source-ref.js.map +1 -0
- package/esm/models/release-source.d.ts +9 -0
- package/esm/models/release-source.d.ts.map +1 -0
- package/esm/models/release-source.js +10 -0
- package/esm/models/release-source.js.map +1 -0
- package/esm/models/releases-config-response.d.ts +58 -0
- package/esm/models/releases-config-response.d.ts.map +1 -0
- package/esm/models/releases-config-response.js +64 -0
- package/esm/models/releases-config-response.js.map +1 -0
- package/esm/models/releases-create-request.d.ts +60 -0
- package/esm/models/releases-create-request.d.ts.map +1 -0
- package/esm/models/releases-create-request.js +39 -0
- package/esm/models/releases-create-request.js.map +1 -0
- package/esm/models/releases-create-response.d.ts +22 -0
- package/esm/models/releases-create-response.d.ts.map +1 -0
- package/esm/models/releases-create-response.js +22 -0
- package/esm/models/releases-create-response.js.map +1 -0
- package/esm/models/releases-preflight-response.d.ts +13 -0
- package/esm/models/releases-preflight-response.d.ts.map +1 -0
- package/esm/models/releases-preflight-response.js +14 -0
- package/esm/models/releases-preflight-response.js.map +1 -0
- package/esm/models/releases-telemetry-request.d.ts +27 -0
- package/esm/models/releases-telemetry-request.d.ts.map +1 -0
- package/esm/models/releases-telemetry-request.js +18 -0
- package/esm/models/releases-telemetry-request.js.map +1 -0
- package/esm/models/releases-telemetry-response.d.ts +10 -0
- package/esm/models/releases-telemetry-response.d.ts.map +1 -0
- package/esm/models/releases-telemetry-response.js +14 -0
- package/esm/models/releases-telemetry-response.js.map +1 -0
- package/esm/models/releases-upload-source-maps-request-1.d.ts +93 -0
- package/esm/models/releases-upload-source-maps-request-1.d.ts.map +1 -0
- package/esm/models/releases-upload-source-maps-request-1.js +62 -0
- package/esm/models/releases-upload-source-maps-request-1.js.map +1 -0
- package/esm/models/releases-upload-source-maps-response.d.ts +13 -0
- package/esm/models/releases-upload-source-maps-response.d.ts.map +1 -0
- package/esm/models/releases-upload-source-maps-response.js +17 -0
- package/esm/models/releases-upload-source-maps-response.js.map +1 -0
- package/esm/models/render-source.d.ts +11 -0
- package/esm/models/render-source.d.ts.map +1 -0
- package/esm/models/render-source.js +13 -0
- package/esm/models/render-source.js.map +1 -0
- package/esm/models/render-type.d.ts +10 -0
- package/esm/models/render-type.d.ts.map +1 -0
- package/esm/models/render-type.js +12 -0
- package/esm/models/render-type.js.map +1 -0
- package/esm/models/replay-chunk-envelope.d.ts +55 -0
- package/esm/models/replay-chunk-envelope.d.ts.map +1 -0
- package/esm/models/replay-chunk-envelope.js +30 -0
- package/esm/models/replay-chunk-envelope.js.map +1 -0
- package/esm/models/replay-chunk-payload.d.ts +23 -0
- package/esm/models/replay-chunk-payload.d.ts.map +1 -0
- package/esm/models/replay-chunk-payload.js +22 -0
- package/esm/models/replay-chunk-payload.js.map +1 -0
- package/esm/models/revalidate-reason.d.ts +10 -0
- package/esm/models/revalidate-reason.d.ts.map +1 -0
- package/esm/models/revalidate-reason.js +11 -0
- package/esm/models/revalidate-reason.js.map +1 -0
- package/esm/models/route-type.d.ts +13 -0
- package/esm/models/route-type.d.ts.map +1 -0
- package/esm/models/route-type.js +14 -0
- package/esm/models/route-type.js.map +1 -0
- package/esm/models/router-kind.d.ts +10 -0
- package/esm/models/router-kind.d.ts.map +1 -0
- package/esm/models/router-kind.js +12 -0
- package/esm/models/router-kind.js.map +1 -0
- package/esm/models/runtime-enum.d.ts +17 -0
- package/esm/models/runtime-enum.d.ts.map +1 -0
- package/esm/models/runtime-enum.js +16 -0
- package/esm/models/runtime-enum.js.map +1 -0
- package/esm/models/screen.d.ts +16 -0
- package/esm/models/screen.d.ts.map +1 -0
- package/esm/models/screen.js +15 -0
- package/esm/models/screen.js.map +1 -0
- package/esm/models/session-create-request.d.ts +21 -0
- package/esm/models/session-create-request.d.ts.map +1 -0
- package/esm/models/session-create-request.js +15 -0
- package/esm/models/session-create-request.js.map +1 -0
- package/esm/models/session-identify-request.d.ts +43 -0
- package/esm/models/session-identify-request.d.ts.map +1 -0
- package/esm/models/session-identify-request.js +23 -0
- package/esm/models/session-identify-request.js.map +1 -0
- package/esm/models/session-response.d.ts +10 -0
- package/esm/models/session-response.d.ts.map +1 -0
- package/esm/models/session-response.js +14 -0
- package/esm/models/session-response.js.map +1 -0
- package/esm/models/session-source.d.ts +18 -0
- package/esm/models/session-source.d.ts.map +1 -0
- package/esm/models/session-source.js +16 -0
- package/esm/models/session-source.js.map +1 -0
- package/esm/models/surface-ref.d.ts +11 -0
- package/esm/models/surface-ref.d.ts.map +1 -0
- package/esm/models/surface-ref.js +16 -0
- package/esm/models/surface-ref.js.map +1 -0
- package/esm/models/ui-event-envelope.d.ts +55 -0
- package/esm/models/ui-event-envelope.d.ts.map +1 -0
- package/esm/models/ui-event-envelope.js +30 -0
- package/esm/models/ui-event-envelope.js.map +1 -0
- package/esm/models/ui-event-payload.d.ts +19 -0
- package/esm/models/ui-event-payload.d.ts.map +1 -0
- package/esm/models/ui-event-payload.js +12 -0
- package/esm/models/ui-event-payload.js.map +1 -0
- package/esm/sdk/config.d.ts +6 -0
- package/esm/sdk/config.d.ts.map +1 -0
- package/esm/sdk/config.js +12 -0
- package/esm/sdk/config.js.map +1 -0
- package/esm/sdk/health.d.ts +6 -0
- package/esm/sdk/health.d.ts.map +1 -0
- package/esm/sdk/health.js +12 -0
- package/esm/sdk/health.js.map +1 -0
- package/esm/sdk/index.d.ts +2 -0
- package/esm/sdk/index.d.ts.map +1 -0
- package/esm/sdk/index.js +5 -0
- package/esm/sdk/index.js.map +1 -0
- package/esm/sdk/ingest.d.ts +6 -0
- package/esm/sdk/ingest.d.ts.map +1 -0
- package/esm/sdk/ingest.js +12 -0
- package/esm/sdk/ingest.js.map +1 -0
- package/esm/sdk/releases.d.ts +9 -0
- package/esm/sdk/releases.d.ts.map +1 -0
- package/esm/sdk/releases.js +20 -0
- package/esm/sdk/releases.js.map +1 -0
- package/esm/sdk/sdk.d.ts +25 -0
- package/esm/sdk/sdk.d.ts.map +1 -0
- package/esm/sdk/sdk.js +35 -0
- package/esm/sdk/sdk.js.map +1 -0
- package/esm/sdk/sessions.d.ts +7 -0
- package/esm/sdk/sessions.d.ts.map +1 -0
- package/esm/sdk/sessions.js +16 -0
- package/esm/sdk/sessions.js.map +1 -0
- package/esm/sdk/source-maps.d.ts +8 -0
- package/esm/sdk/source-maps.d.ts.map +1 -0
- package/esm/sdk/source-maps.js +16 -0
- package/esm/sdk/source-maps.js.map +1 -0
- package/esm/sdk/telemetry.d.ts +7 -0
- package/esm/sdk/telemetry.d.ts.map +1 -0
- package/esm/sdk/telemetry.js +12 -0
- package/esm/sdk/telemetry.js.map +1 -0
- package/esm/types/async.d.ts +23 -0
- package/esm/types/async.d.ts.map +1 -0
- package/esm/types/async.js +40 -0
- package/esm/types/async.js.map +1 -0
- package/esm/types/blobs.d.ts +4 -0
- package/esm/types/blobs.d.ts.map +1 -0
- package/esm/types/blobs.js +25 -0
- package/esm/types/blobs.js.map +1 -0
- package/esm/types/const-date-time.d.ts +3 -0
- package/esm/types/const-date-time.d.ts.map +1 -0
- package/esm/types/const-date-time.js +10 -0
- package/esm/types/const-date-time.js.map +1 -0
- package/esm/types/default-to-zero-value.d.ts +12 -0
- package/esm/types/default-to-zero-value.d.ts.map +1 -0
- package/esm/types/default-to-zero-value.js +31 -0
- package/esm/types/default-to-zero-value.js.map +1 -0
- package/esm/types/enums.d.ts +9 -0
- package/esm/types/enums.d.ts.map +1 -0
- package/esm/types/enums.js +27 -0
- package/esm/types/enums.js.map +1 -0
- package/esm/types/fp.d.ts +31 -0
- package/esm/types/fp.d.ts.map +1 -0
- package/esm/types/fp.js +31 -0
- package/esm/types/fp.js.map +1 -0
- package/esm/types/index.d.ts +10 -0
- package/esm/types/index.d.ts.map +1 -0
- package/esm/types/index.js +10 -0
- package/esm/types/index.js.map +1 -0
- package/esm/types/operations.d.ts +27 -0
- package/esm/types/operations.d.ts.map +1 -0
- package/esm/types/operations.js +77 -0
- package/esm/types/operations.js.map +1 -0
- package/esm/types/primitives.d.ts +11 -0
- package/esm/types/primitives.d.ts.map +1 -0
- package/esm/types/primitives.js +132 -0
- package/esm/types/primitives.js.map +1 -0
- package/esm/types/rfcdate.d.ts +21 -0
- package/esm/types/rfcdate.d.ts.map +1 -0
- package/esm/types/rfcdate.js +42 -0
- package/esm/types/rfcdate.js.map +1 -0
- package/esm/types/smart-union.d.ts +7 -0
- package/esm/types/smart-union.d.ts.map +1 -0
- package/esm/types/smart-union.js +117 -0
- package/esm/types/smart-union.js.map +1 -0
- package/esm/types/streams.d.ts +2 -0
- package/esm/types/streams.d.ts.map +1 -0
- package/esm/types/streams.js +15 -0
- package/esm/types/streams.js.map +1 -0
- package/esm/types/unrecognized.d.ts +16 -0
- package/esm/types/unrecognized.d.ts.map +1 -0
- package/esm/types/unrecognized.js +31 -0
- package/esm/types/unrecognized.js.map +1 -0
- package/examples/.env.template +9 -0
- package/examples/README.md +31 -0
- package/examples/ingestPost.example.ts +75 -0
- package/examples/package-lock.json +611 -0
- package/examples/package.json +18 -0
- package/package.json +7 -1
- package/jsr.json +0 -27
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Health
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Health check
|
|
6
|
+
|
|
7
|
+
### Available Operations
|
|
8
|
+
|
|
9
|
+
* [get](#get)
|
|
10
|
+
|
|
11
|
+
## get
|
|
12
|
+
|
|
13
|
+
### Example Usage
|
|
14
|
+
|
|
15
|
+
<!-- UsageSnippet language="typescript" operationID="getHealth" method="get" path="/health/" -->
|
|
16
|
+
```typescript
|
|
17
|
+
import { Interfere } from "@interfere/sdk";
|
|
18
|
+
|
|
19
|
+
const interfere = new Interfere();
|
|
20
|
+
|
|
21
|
+
async function run() {
|
|
22
|
+
const result = await interfere.health.get();
|
|
23
|
+
|
|
24
|
+
console.log(result);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
run();
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Standalone function
|
|
31
|
+
|
|
32
|
+
The standalone function version of this method:
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
36
|
+
import { healthGet } from "@interfere/sdk/funcs/health-get.js";
|
|
37
|
+
|
|
38
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
39
|
+
// You can create one instance of it to use across an application.
|
|
40
|
+
const interfere = new InterfereCore();
|
|
41
|
+
|
|
42
|
+
async function run() {
|
|
43
|
+
const res = await healthGet(interfere);
|
|
44
|
+
if (res.ok) {
|
|
45
|
+
const { value: result } = res;
|
|
46
|
+
console.log(result);
|
|
47
|
+
} else {
|
|
48
|
+
console.log("healthGet failed:", res.error);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
run();
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
| Parameter | Type | Required | Description |
|
|
58
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
59
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
60
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
61
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
62
|
+
|
|
63
|
+
### Response
|
|
64
|
+
|
|
65
|
+
**Promise\<[models.HealthOk](../../models/health-ok.md)\>**
|
|
66
|
+
|
|
67
|
+
### Errors
|
|
68
|
+
|
|
69
|
+
| Error Type | Status Code | Content Type |
|
|
70
|
+
| --------------------- | --------------------- | --------------------- |
|
|
71
|
+
| errors.HealthError | 500 | application/json |
|
|
72
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# Ingest
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Event ingestion
|
|
6
|
+
|
|
7
|
+
### Available Operations
|
|
8
|
+
|
|
9
|
+
* [post](#post)
|
|
10
|
+
|
|
11
|
+
## post
|
|
12
|
+
|
|
13
|
+
### Example Usage
|
|
14
|
+
|
|
15
|
+
<!-- UsageSnippet language="typescript" operationID="ingest" method="post" path="/v1/ingest/" -->
|
|
16
|
+
```typescript
|
|
17
|
+
import { Interfere } from "@interfere/sdk";
|
|
18
|
+
|
|
19
|
+
const interfere = new Interfere();
|
|
20
|
+
|
|
21
|
+
async function run() {
|
|
22
|
+
const result = await interfere.ingest.post([
|
|
23
|
+
{
|
|
24
|
+
type: "replay_chunk",
|
|
25
|
+
buildId: "<id>",
|
|
26
|
+
clientTs: 870104,
|
|
27
|
+
environment: "development",
|
|
28
|
+
releaseId: "<id>",
|
|
29
|
+
runtime: "edge",
|
|
30
|
+
sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
|
|
31
|
+
uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
|
|
32
|
+
v: 0,
|
|
33
|
+
payload: {
|
|
34
|
+
ts: 4133.68,
|
|
35
|
+
count: 5545.75,
|
|
36
|
+
events: [],
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
type: "error",
|
|
41
|
+
buildId: "<id>",
|
|
42
|
+
clientTs: 706130,
|
|
43
|
+
environment: "preview",
|
|
44
|
+
releaseId: "<id>",
|
|
45
|
+
runtime: "node",
|
|
46
|
+
sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
|
|
47
|
+
uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
|
|
48
|
+
v: 0,
|
|
49
|
+
payload: {
|
|
50
|
+
exceptions: [
|
|
51
|
+
{
|
|
52
|
+
type: "<value>",
|
|
53
|
+
value: "<value>",
|
|
54
|
+
frames: [],
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
type: "pageview",
|
|
61
|
+
buildId: "<id>",
|
|
62
|
+
clientTs: 505979,
|
|
63
|
+
environment: "preview",
|
|
64
|
+
releaseId: "<id>",
|
|
65
|
+
runtime: "edge",
|
|
66
|
+
sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
|
|
67
|
+
uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
|
|
68
|
+
v: 0,
|
|
69
|
+
payload: {
|
|
70
|
+
url: "https://same-statue.org/",
|
|
71
|
+
},
|
|
72
|
+
},
|
|
73
|
+
]);
|
|
74
|
+
|
|
75
|
+
console.log(result);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
run();
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Standalone function
|
|
82
|
+
|
|
83
|
+
The standalone function version of this method:
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
87
|
+
import { ingestPost } from "@interfere/sdk/funcs/ingest-post.js";
|
|
88
|
+
|
|
89
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
90
|
+
// You can create one instance of it to use across an application.
|
|
91
|
+
const interfere = new InterfereCore();
|
|
92
|
+
|
|
93
|
+
async function run() {
|
|
94
|
+
const res = await ingestPost(interfere, [
|
|
95
|
+
{
|
|
96
|
+
type: "replay_chunk",
|
|
97
|
+
buildId: "<id>",
|
|
98
|
+
clientTs: 870104,
|
|
99
|
+
environment: "development",
|
|
100
|
+
releaseId: "<id>",
|
|
101
|
+
runtime: "edge",
|
|
102
|
+
sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
|
|
103
|
+
uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
|
|
104
|
+
v: 0,
|
|
105
|
+
payload: {
|
|
106
|
+
ts: 4133.68,
|
|
107
|
+
count: 5545.75,
|
|
108
|
+
events: [],
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
type: "error",
|
|
113
|
+
buildId: "<id>",
|
|
114
|
+
clientTs: 706130,
|
|
115
|
+
environment: "preview",
|
|
116
|
+
releaseId: "<id>",
|
|
117
|
+
runtime: "node",
|
|
118
|
+
sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
|
|
119
|
+
uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
|
|
120
|
+
v: 0,
|
|
121
|
+
payload: {
|
|
122
|
+
exceptions: [
|
|
123
|
+
{
|
|
124
|
+
type: "<value>",
|
|
125
|
+
value: "<value>",
|
|
126
|
+
frames: [],
|
|
127
|
+
},
|
|
128
|
+
],
|
|
129
|
+
},
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
type: "pageview",
|
|
133
|
+
buildId: "<id>",
|
|
134
|
+
clientTs: 505979,
|
|
135
|
+
environment: "preview",
|
|
136
|
+
releaseId: "<id>",
|
|
137
|
+
runtime: "edge",
|
|
138
|
+
sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
|
|
139
|
+
uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
|
|
140
|
+
v: 0,
|
|
141
|
+
payload: {
|
|
142
|
+
url: "https://same-statue.org/",
|
|
143
|
+
},
|
|
144
|
+
},
|
|
145
|
+
]);
|
|
146
|
+
if (res.ok) {
|
|
147
|
+
const { value: result } = res;
|
|
148
|
+
console.log(result);
|
|
149
|
+
} else {
|
|
150
|
+
console.log("ingestPost failed:", res.error);
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
run();
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
| Parameter | Type | Required | Description |
|
|
160
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
161
|
+
| `request` | [models.Envelope[]](../../models/.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
162
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
163
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
164
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
165
|
+
|
|
166
|
+
### Response
|
|
167
|
+
|
|
168
|
+
**Promise\<[models.IngestResponse](../../models/ingest-response.md)\>**
|
|
169
|
+
|
|
170
|
+
### Errors
|
|
171
|
+
|
|
172
|
+
| Error Type | Status Code | Content Type |
|
|
173
|
+
| --------------------- | --------------------- | --------------------- |
|
|
174
|
+
| errors.ErrorsProblem | 401, 422, 429 | application/json |
|
|
175
|
+
| errors.ErrorsProblem | 503 | application/json |
|
|
176
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# Releases
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Release management
|
|
6
|
+
|
|
7
|
+
### Available Operations
|
|
8
|
+
|
|
9
|
+
* [getConfig](#getconfig)
|
|
10
|
+
* [create](#create)
|
|
11
|
+
* [preflight](#preflight)
|
|
12
|
+
|
|
13
|
+
## getConfig
|
|
14
|
+
|
|
15
|
+
### Example Usage
|
|
16
|
+
|
|
17
|
+
<!-- UsageSnippet language="typescript" operationID="getReleasesConfig" method="get" path="/v1/releases/config" -->
|
|
18
|
+
```typescript
|
|
19
|
+
import { Interfere } from "@interfere/sdk";
|
|
20
|
+
|
|
21
|
+
const interfere = new Interfere();
|
|
22
|
+
|
|
23
|
+
async function run() {
|
|
24
|
+
const result = await interfere.releases.getConfig();
|
|
25
|
+
|
|
26
|
+
console.log(result);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
run();
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Standalone function
|
|
33
|
+
|
|
34
|
+
The standalone function version of this method:
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
38
|
+
import { releasesGetConfig } from "@interfere/sdk/funcs/releases-get-config.js";
|
|
39
|
+
|
|
40
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
41
|
+
// You can create one instance of it to use across an application.
|
|
42
|
+
const interfere = new InterfereCore();
|
|
43
|
+
|
|
44
|
+
async function run() {
|
|
45
|
+
const res = await releasesGetConfig(interfere);
|
|
46
|
+
if (res.ok) {
|
|
47
|
+
const { value: result } = res;
|
|
48
|
+
console.log(result);
|
|
49
|
+
} else {
|
|
50
|
+
console.log("releasesGetConfig failed:", res.error);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
run();
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Parameters
|
|
58
|
+
|
|
59
|
+
| Parameter | Type | Required | Description |
|
|
60
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
61
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
62
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
63
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
64
|
+
|
|
65
|
+
### Response
|
|
66
|
+
|
|
67
|
+
**Promise\<[models.ReleasesConfigResponse](../../models/releases-config-response.md)\>**
|
|
68
|
+
|
|
69
|
+
### Errors
|
|
70
|
+
|
|
71
|
+
| Error Type | Status Code | Content Type |
|
|
72
|
+
| --------------------- | --------------------- | --------------------- |
|
|
73
|
+
| errors.ErrorsProblem | 401, 403 | application/json |
|
|
74
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|
|
75
|
+
|
|
76
|
+
## create
|
|
77
|
+
|
|
78
|
+
### Example Usage
|
|
79
|
+
|
|
80
|
+
<!-- UsageSnippet language="typescript" operationID="createRelease" method="post" path="/v1/releases/" -->
|
|
81
|
+
```typescript
|
|
82
|
+
import { Interfere } from "@interfere/sdk";
|
|
83
|
+
|
|
84
|
+
const interfere = new Interfere();
|
|
85
|
+
|
|
86
|
+
async function run() {
|
|
87
|
+
const result = await interfere.releases.create({
|
|
88
|
+
source: {
|
|
89
|
+
provider: "github",
|
|
90
|
+
commitMessage: "<value>",
|
|
91
|
+
branch: "<value>",
|
|
92
|
+
commitSha: "<value>",
|
|
93
|
+
},
|
|
94
|
+
destination: {
|
|
95
|
+
provider: "vercel",
|
|
96
|
+
destinationReleaseId: "<id>",
|
|
97
|
+
environment: "<value>",
|
|
98
|
+
deploymentId: "<id>",
|
|
99
|
+
deploymentUrl: "https://narrow-sauerkraut.name",
|
|
100
|
+
environmentName: "<value>",
|
|
101
|
+
environmentTarget: "<value>",
|
|
102
|
+
},
|
|
103
|
+
buildId: "<id>",
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
console.log(result);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
run();
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Standalone function
|
|
113
|
+
|
|
114
|
+
The standalone function version of this method:
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
118
|
+
import { releasesCreate } from "@interfere/sdk/funcs/releases-create.js";
|
|
119
|
+
|
|
120
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
121
|
+
// You can create one instance of it to use across an application.
|
|
122
|
+
const interfere = new InterfereCore();
|
|
123
|
+
|
|
124
|
+
async function run() {
|
|
125
|
+
const res = await releasesCreate(interfere, {
|
|
126
|
+
source: {
|
|
127
|
+
provider: "github",
|
|
128
|
+
commitMessage: "<value>",
|
|
129
|
+
branch: "<value>",
|
|
130
|
+
commitSha: "<value>",
|
|
131
|
+
},
|
|
132
|
+
destination: {
|
|
133
|
+
provider: "vercel",
|
|
134
|
+
destinationReleaseId: "<id>",
|
|
135
|
+
environment: "<value>",
|
|
136
|
+
deploymentId: "<id>",
|
|
137
|
+
deploymentUrl: "https://narrow-sauerkraut.name",
|
|
138
|
+
environmentName: "<value>",
|
|
139
|
+
environmentTarget: "<value>",
|
|
140
|
+
},
|
|
141
|
+
buildId: "<id>",
|
|
142
|
+
});
|
|
143
|
+
if (res.ok) {
|
|
144
|
+
const { value: result } = res;
|
|
145
|
+
console.log(result);
|
|
146
|
+
} else {
|
|
147
|
+
console.log("releasesCreate failed:", res.error);
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
run();
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
| Parameter | Type | Required | Description |
|
|
157
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
158
|
+
| `request` | [models.ReleasesCreateRequest](../../models/releases-create-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
159
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
160
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
161
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
162
|
+
|
|
163
|
+
### Response
|
|
164
|
+
|
|
165
|
+
**Promise\<[models.ReleasesCreateResponse](../../models/releases-create-response.md)\>**
|
|
166
|
+
|
|
167
|
+
### Errors
|
|
168
|
+
|
|
169
|
+
| Error Type | Status Code | Content Type |
|
|
170
|
+
| --------------------- | --------------------- | --------------------- |
|
|
171
|
+
| errors.ErrorsProblem | 401, 403, 422 | application/json |
|
|
172
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|
|
173
|
+
|
|
174
|
+
## preflight
|
|
175
|
+
|
|
176
|
+
### Example Usage
|
|
177
|
+
|
|
178
|
+
<!-- UsageSnippet language="typescript" operationID="confirmPreflight" method="post" path="/v1/releases/{releaseSlug}/preflight" -->
|
|
179
|
+
```typescript
|
|
180
|
+
import { Interfere } from "@interfere/sdk";
|
|
181
|
+
|
|
182
|
+
const interfere = new Interfere();
|
|
183
|
+
|
|
184
|
+
async function run() {
|
|
185
|
+
const result = await interfere.releases.preflight({
|
|
186
|
+
releaseSlug: "<value>",
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
console.log(result);
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
run();
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Standalone function
|
|
196
|
+
|
|
197
|
+
The standalone function version of this method:
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
201
|
+
import { releasesPreflight } from "@interfere/sdk/funcs/releases-preflight.js";
|
|
202
|
+
|
|
203
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
204
|
+
// You can create one instance of it to use across an application.
|
|
205
|
+
const interfere = new InterfereCore();
|
|
206
|
+
|
|
207
|
+
async function run() {
|
|
208
|
+
const res = await releasesPreflight(interfere, {
|
|
209
|
+
releaseSlug: "<value>",
|
|
210
|
+
});
|
|
211
|
+
if (res.ok) {
|
|
212
|
+
const { value: result } = res;
|
|
213
|
+
console.log(result);
|
|
214
|
+
} else {
|
|
215
|
+
console.log("releasesPreflight failed:", res.error);
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
run();
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
| Parameter | Type | Required | Description |
|
|
225
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
226
|
+
| `request` | [operations.ConfirmPreflightRequest](../../models/operations/confirm-preflight-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
227
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
228
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
229
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
230
|
+
|
|
231
|
+
### Response
|
|
232
|
+
|
|
233
|
+
**Promise\<[models.ReleasesPreflightResponse](../../models/releases-preflight-response.md)\>**
|
|
234
|
+
|
|
235
|
+
### Errors
|
|
236
|
+
|
|
237
|
+
| Error Type | Status Code | Content Type |
|
|
238
|
+
| --------------------- | --------------------- | --------------------- |
|
|
239
|
+
| errors.ErrorsProblem | 401, 403, 404 | application/json |
|
|
240
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
# Sessions
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Session management
|
|
6
|
+
|
|
7
|
+
### Available Operations
|
|
8
|
+
|
|
9
|
+
* [create](#create)
|
|
10
|
+
* [identify](#identify)
|
|
11
|
+
|
|
12
|
+
## create
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="createSession" method="post" path="/v1/session/" -->
|
|
17
|
+
```typescript
|
|
18
|
+
import { Interfere } from "@interfere/sdk";
|
|
19
|
+
|
|
20
|
+
const interfere = new Interfere();
|
|
21
|
+
|
|
22
|
+
async function run() {
|
|
23
|
+
const result = await interfere.sessions.create({
|
|
24
|
+
sessionId: "<id>",
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
console.log(result);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
run();
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Standalone function
|
|
34
|
+
|
|
35
|
+
The standalone function version of this method:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
39
|
+
import { sessionsCreate } from "@interfere/sdk/funcs/sessions-create.js";
|
|
40
|
+
|
|
41
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
42
|
+
// You can create one instance of it to use across an application.
|
|
43
|
+
const interfere = new InterfereCore();
|
|
44
|
+
|
|
45
|
+
async function run() {
|
|
46
|
+
const res = await sessionsCreate(interfere, {
|
|
47
|
+
sessionId: "<id>",
|
|
48
|
+
});
|
|
49
|
+
if (res.ok) {
|
|
50
|
+
const { value: result } = res;
|
|
51
|
+
console.log(result);
|
|
52
|
+
} else {
|
|
53
|
+
console.log("sessionsCreate failed:", res.error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
run();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Required | Description |
|
|
63
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
+
| `request` | [models.SessionCreateRequest](../../models/session-create-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
65
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
66
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
67
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
68
|
+
|
|
69
|
+
### Response
|
|
70
|
+
|
|
71
|
+
**Promise\<[models.SessionResponse](../../models/session-response.md)\>**
|
|
72
|
+
|
|
73
|
+
### Errors
|
|
74
|
+
|
|
75
|
+
| Error Type | Status Code | Content Type |
|
|
76
|
+
| --------------------- | --------------------- | --------------------- |
|
|
77
|
+
| errors.ErrorsProblem | 401 | application/json |
|
|
78
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|
|
79
|
+
|
|
80
|
+
## identify
|
|
81
|
+
|
|
82
|
+
### Example Usage
|
|
83
|
+
|
|
84
|
+
<!-- UsageSnippet language="typescript" operationID="identifySession" method="put" path="/v1/session/" -->
|
|
85
|
+
```typescript
|
|
86
|
+
import { Interfere } from "@interfere/sdk";
|
|
87
|
+
|
|
88
|
+
const interfere = new Interfere();
|
|
89
|
+
|
|
90
|
+
async function run() {
|
|
91
|
+
const result = await interfere.sessions.identify({
|
|
92
|
+
sessionId: "<id>",
|
|
93
|
+
identifier: "<value>",
|
|
94
|
+
source: {
|
|
95
|
+
name: "Clerk",
|
|
96
|
+
type: "clerk",
|
|
97
|
+
},
|
|
98
|
+
});
|
|
99
|
+
|
|
100
|
+
console.log(result);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
run();
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Standalone function
|
|
107
|
+
|
|
108
|
+
The standalone function version of this method:
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
import { InterfereCore } from "@interfere/sdk/core.js";
|
|
112
|
+
import { sessionsIdentify } from "@interfere/sdk/funcs/sessions-identify.js";
|
|
113
|
+
|
|
114
|
+
// Use `InterfereCore` for best tree-shaking performance.
|
|
115
|
+
// You can create one instance of it to use across an application.
|
|
116
|
+
const interfere = new InterfereCore();
|
|
117
|
+
|
|
118
|
+
async function run() {
|
|
119
|
+
const res = await sessionsIdentify(interfere, {
|
|
120
|
+
sessionId: "<id>",
|
|
121
|
+
identifier: "<value>",
|
|
122
|
+
source: {
|
|
123
|
+
name: "Clerk",
|
|
124
|
+
type: "clerk",
|
|
125
|
+
},
|
|
126
|
+
});
|
|
127
|
+
if (res.ok) {
|
|
128
|
+
const { value: result } = res;
|
|
129
|
+
console.log(result);
|
|
130
|
+
} else {
|
|
131
|
+
console.log("sessionsIdentify failed:", res.error);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
run();
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Parameters
|
|
139
|
+
|
|
140
|
+
| Parameter | Type | Required | Description |
|
|
141
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
142
|
+
| `request` | [models.SessionIdentifyRequest](../../models/session-identify-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
143
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
144
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
145
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
146
|
+
|
|
147
|
+
### Response
|
|
148
|
+
|
|
149
|
+
**Promise\<[models.SessionResponse](../../models/session-response.md)\>**
|
|
150
|
+
|
|
151
|
+
### Errors
|
|
152
|
+
|
|
153
|
+
| Error Type | Status Code | Content Type |
|
|
154
|
+
| --------------------- | --------------------- | --------------------- |
|
|
155
|
+
| errors.ErrorsProblem | 401 | application/json |
|
|
156
|
+
| errors.InterfereError | 4XX, 5XX | \*/\* |
|