@interfere/sdk 9.0.2 → 9.0.3

package/docs/models/device-os.md

@@ -1,16 +0,0 @@
-# DeviceOs
-
-## Example Usage
-
-```typescript
-import { DeviceOs } from "@interfere/sdk/models";
-
-let value: DeviceOs = {};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `version`          | *string*           | :heavy_minus_sign: | N/A                |
-| `name`             | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/display.md

@@ -1,20 +0,0 @@
-# Display
-
-## Example Usage
-
-```typescript
-import { Display } from "@interfere/sdk/models";
-
-let value: Display = {
-  screen: {
-    height: 7531.67,
-    width: 591.54,
-  },
-};
-```
-
-## Fields
-
-| Field                                | Type                                 | Required                             | Description                          |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
-| `screen`                             | [models.Screen](../models/screen.md) | :heavy_check_mark:                   | N/A                                  |

package/docs/models/edge-context.md

@@ -1,19 +0,0 @@
-# EdgeContext
-
-Request context for the Edge runtime.
-
-## Example Usage
-
-```typescript
-import { EdgeContext } from "@interfere/sdk/models";
-
-let value: EdgeContext = {
-  runtime: "edge",
-};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `runtime`          | *"edge"*           | :heavy_check_mark: | N/A                |

package/docs/models/envelope-context.md

@@ -1,47 +0,0 @@
-# EnvelopeContext
-
-Runtime-specific request context attached to every envelope.
-
-
-## Supported Types
-
-### `models.BrowserContext`
-
-```typescript
-const value: models.BrowserContext = {
-  runtime: "browser",
-  browser: {
-    display: {
-      screen: {
-        height: 7531.67,
-        width: 591.54,
-      },
-    },
-  },
-  device: {
-    browser: {},
-    cpu: {},
-    device: {},
-    engine: {},
-    os: {},
-    ua: "<value>",
-  },
-};
-```
-
-### `models.NextjsContext`
-
-```typescript
-const value: models.NextjsContext = {
-  runtime: "nextjs",
-};
-```
-
-### `models.EdgeContext`
-
-```typescript
-const value: models.EdgeContext = {
-  runtime: "edge",
-};
-```
-

package/docs/models/envelope.md

@@ -1,133 +0,0 @@
-# Envelope
-
-A single event envelope accepted by the collector.
-
-
-## Supported Types
-
-### `models.ErrorEnvelope`
-
-```typescript
-const value: models.ErrorEnvelope = {
-  type: "error",
-  buildId: "<id>",
-  clientTs: 357344,
-  environment: "preview",
-  releaseId: "<id>",
-  runtime: "node",
-  sessionId: "3648039f-3c3a-4b4b-8c19-640ff94fb0c7",
-  uuid: "1d56e773-a120-49f8-a9dd-77decaca93ac",
-  v: 9401.22,
-  payload: {
-    exceptions: [],
-  },
-};
-```
-
-### `models.PageviewEnvelope`
-
-```typescript
-const value: models.PageviewEnvelope = {
-  type: "pageview",
-  buildId: "<id>",
-  clientTs: 423290,
-  environment: "preview",
-  releaseId: "<id>",
-  runtime: "browser",
-  sessionId: "6160c037-fae8-432e-8b8b-21a9a51bf4de",
-  uuid: "6a3ec1bd-4590-4f42-8fd8-68ab0d98b1f7",
-  v: 6873.42,
-  payload: {
-    url: "https://well-to-do-scrap.name/",
-  },
-};
-```
-
-### `models.PageleaveEnvelope`
-
-```typescript
-const value: models.PageleaveEnvelope = {
-  type: "pageleave",
-  buildId: "<id>",
-  clientTs: 614175,
-  environment: "preview",
-  releaseId: "<id>",
-  runtime: "node",
-  sessionId: "c63c303f-cebe-4617-bec0-c2cfba30cea4",
-  uuid: "efe06e21-8fee-4af5-b028-f502f43d7da6",
-  v: 2019.69,
-  payload: {
-    url: "https://growing-decongestant.biz/",
-  },
-};
-```
-
-### `models.UiEventEnvelope`
-
-```typescript
-const value: models.UiEventEnvelope = {
-  type: "ui_event",
-  buildId: "<id>",
-  clientTs: 615985,
-  environment: "production",
-  releaseId: "<id>",
-  runtime: "browser",
-  sessionId: "f662ea43-7ae3-4e28-a92a-19a8e07571d1",
-  uuid: "c7111390-2e43-4f1e-b3f8-3ffcc21e5989",
-  v: 3318.86,
-  payload: {
-    event: {
-      "key": "<value>",
-      "key1": "<value>",
-      "key2": "<value>",
-    },
-  },
-};
-```
-
-### `models.ReplayChunkEnvelope`
-
-```typescript
-const value: models.ReplayChunkEnvelope = {
-  type: "replay_chunk",
-  buildId: "<id>",
-  clientTs: 530580,
-  environment: "production",
-  releaseId: "<id>",
-  runtime: "browser",
-  sessionId: "8a694fac-31c8-4297-8f53-6282d91dab2e",
-  uuid: "5d2ad312-9e88-4161-81f1-eb6fb4d33c69",
-  v: 3168.58,
-  payload: {
-    ts: 9116.83,
-    count: 4767.38,
-    events: [],
-  },
-};
-```
-
-### `models.RageClickEnvelope`
-
-```typescript
-const value: models.RageClickEnvelope = {
-  type: "rage_click",
-  buildId: "<id>",
-  clientTs: 343821,
-  environment: "development",
-  releaseId: "<id>",
-  runtime: "edge",
-  sessionId: "cfc9b586-4b9b-499f-8862-e8b5697e3a28",
-  uuid: "6f9b8879-f75a-405a-ba94-cf3d214e7a2a",
-  v: 9600.86,
-  payload: {
-    count: 7353.82,
-    timeWindow: 2917.06,
-    selector: "<value>",
-    text: "<value>",
-    x: 2495.33,
-    y: 2.51,
-    timestamp: 7192.77,
-  },
-};
-```
-

package/docs/models/environment.md

@@ -1,17 +0,0 @@
-# Environment
-
-Deployment environment the SDK is running in.
-
-## Example Usage
-
-```typescript
-import { Environment } from "@interfere/sdk/models";
-
-let value: Environment = "preview";
-```
-
-## Values
-
-```typescript
-"development" | "preview" | "production"
-```

package/docs/models/error-envelope.md

@@ -1,41 +0,0 @@
-# ErrorEnvelope
-
-## Example Usage
-
-```typescript
-import { ErrorEnvelope } from "@interfere/sdk/models";
-
-let value: ErrorEnvelope = {
-  type: "error",
-  buildId: "<id>",
-  clientTs: 357344,
-  environment: "preview",
-  releaseId: "<id>",
-  runtime: "node",
-  sessionId: "3648039f-3c3a-4b4b-8c19-640ff94fb0c7",
-  uuid: "1d56e773-a120-49f8-a9dd-77decaca93ac",
-  v: 9401.22,
-  payload: {
-    exceptions: [],
-  },
-};
-```
-
-## Fields
-
-| Field                                                    | Type                                                     | Required                                                 | Description                                              |
-| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `type`                                                   | *"error"*                                                | :heavy_check_mark:                                       | N/A                                                      |
-| `buildId`                                                | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `clientTs`                                               | *number*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `context`                                                | *models.EnvelopeContext*                                 | :heavy_minus_sign:                                       | N/A                                                      |
-| `environment`                                            | [models.Environment](../models/environment.md)           | :heavy_check_mark:                                       | Deployment environment the SDK is running in.            |
-| `producerVersion`                                        | *string*                                                 | :heavy_minus_sign:                                       | N/A                                                      |
-| `releaseId`                                              | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `runtime`                                                | [models.RuntimeEnum](../models/runtime-enum.md)          | :heavy_check_mark:                                       | JavaScript runtime the SDK is running in.                |
-| `sdkStack`                                               | *string*[]                                               | :heavy_minus_sign:                                       | N/A                                                      |
-| `sessionId`                                              | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `sessionSource`                                          | [models.SessionSource](../models/session-source.md)      | :heavy_minus_sign:                                       | How the server resolved the sessionId for this envelope. |
-| `uuid`                                                   | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `v`                                                      | *number*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `payload`                                                | [models.ErrorPayload](../models/error-payload.md)        | :heavy_check_mark:                                       | Payload for an error envelope.                           |

package/docs/models/error-mechanism.md

@@ -1,22 +0,0 @@
-# ErrorMechanism
-
-How the exception was captured by the SDK.
-
-## Example Usage
-
-```typescript
-import { ErrorMechanism } from "@interfere/sdk/models";
-
-let value: ErrorMechanism = {
-  type: "<value>",
-  handled: false,
-};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `type`             | *string*           | :heavy_check_mark: | N/A                |
-| `handled`          | *boolean*          | :heavy_check_mark: | N/A                |
-| `synthetic`        | *boolean*          | :heavy_minus_sign: | N/A                |

package/docs/models/error-payload.md

@@ -1,27 +0,0 @@
-# ErrorPayload
-
-Payload for an error envelope.
-
-## Example Usage
-
-```typescript
-import { ErrorPayload } from "@interfere/sdk/models";
-
-let value: ErrorPayload = {
-  exceptions: [
-    {
-      type: "<value>",
-      value: "<value>",
-      frames: [
-        {},
-      ],
-    },
-  ],
-};
-```
-
-## Fields
-
-| Field                                        | Type                                         | Required                                     | Description                                  |
-| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
-| `exceptions`                                 | [models.Exception](../models/exception.md)[] | :heavy_check_mark:                           | N/A                                          |

package/docs/models/exception.md

@@ -1,24 +0,0 @@
-# Exception
-
-A single exception in a chained error.
-
-## Example Usage
-
-```typescript
-import { Exception } from "@interfere/sdk/models";
-
-let value: Exception = {
-  type: "<value>",
-  value: "<value>",
-  frames: [],
-};
-```
-
-## Fields
-
-| Field                                                 | Type                                                  | Required                                              | Description                                           |
-| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
-| `type`                                                | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
-| `value`                                               | *string*                                              | :heavy_check_mark:                                    | N/A                                                   |
-| `mechanism`                                           | [models.ErrorMechanism](../models/error-mechanism.md) | :heavy_minus_sign:                                    | N/A                                                   |
-| `frames`                                              | [models.Frame](../models/frame.md)[]                  | :heavy_check_mark:                                    | N/A                                                   |

package/docs/models/frame.md

@@ -1,22 +0,0 @@
-# Frame
-
-A single stack frame captured from an error.
-
-## Example Usage
-
-```typescript
-import { Frame } from "@interfere/sdk/models";
-
-let value: Frame = {};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `fileName`         | *string*           | :heavy_minus_sign: | N/A                |
-| `functionName`     | *string*           | :heavy_minus_sign: | N/A                |
-| `lineNumber`       | *number*           | :heavy_minus_sign: | N/A                |
-| `columnNumber`     | *number*           | :heavy_minus_sign: | N/A                |
-| `source`           | *string*           | :heavy_minus_sign: | N/A                |
-| `debugId`          | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/hashes.md

@@ -1,14 +0,0 @@
-# Hashes
-
-## Example Usage
-
-```typescript
-import { Hashes } from "@interfere/sdk/models";
-
-let value: Hashes = {};
-```
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/nextjs-context.md

@@ -1,28 +0,0 @@
-# NextjsContext
-
-Request context for the Next.js runtime.
-
-## Example Usage
-
-```typescript
-import { NextjsContext } from "@interfere/sdk/models";
-
-let value: NextjsContext = {
-  runtime: "nextjs",
-};
-```
-
-## Fields
-
-| Field                                                     | Type                                                      | Required                                                  | Description                                               |
-| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
-| `errorDigest`                                             | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
-| `renderSource`                                            | [models.RenderSource](../models/render-source.md)         | :heavy_minus_sign:                                        | N/A                                                       |
-| `renderType`                                              | [models.RenderType](../models/render-type.md)             | :heavy_minus_sign:                                        | N/A                                                       |
-| `requestMethod`                                           | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
-| `requestPath`                                             | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
-| `revalidateReason`                                        | [models.RevalidateReason](../models/revalidate-reason.md) | :heavy_minus_sign:                                        | N/A                                                       |
-| `routePath`                                               | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
-| `routeType`                                               | [models.RouteType](../models/route-type.md)               | :heavy_minus_sign:                                        | N/A                                                       |
-| `routerKind`                                              | [models.RouterKind](../models/router-kind.md)             | :heavy_minus_sign:                                        | N/A                                                       |
-| `runtime`                                                 | *"nextjs"*                                                | :heavy_check_mark:                                        | N/A                                                       |

package/docs/models/operations/upload-source-maps-multipart-request.md

@@ -1,28 +0,0 @@
-# UploadSourceMapsMultipartRequest
-
-## Example Usage
-
-```typescript
-import { UploadSourceMapsMultipartRequest } from "@interfere/sdk/models/operations";
-import { openAsBlob } from "node:fs";
-
-let value: UploadSourceMapsMultipartRequest = {
-  releaseSlug: "<value>",
-  body: {
-    files: [
-      await openAsBlob("example.file"),
-    ],
-    metadata: {
-      sourceMapToGenerated: {},
-      hashes: {},
-    },
-  },
-};
-```
-
-## Fields
-
-| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `releaseSlug`                                                                                   | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `body`                                                                                          | [models.ReleasesUploadSourceMapsRequest2](../../models/releases-upload-source-maps-request2.md) | :heavy_check_mark:                                                                              | Multipart body for uploading source maps for a release.                                         |

package/docs/models/pageleave-envelope.md

@@ -1,41 +0,0 @@
-# PageleaveEnvelope
-
-## Example Usage
-
-```typescript
-import { PageleaveEnvelope } from "@interfere/sdk/models";
-
-let value: PageleaveEnvelope = {
-  type: "pageleave",
-  buildId: "<id>",
-  clientTs: 614175,
-  environment: "preview",
-  releaseId: "<id>",
-  runtime: "node",
-  sessionId: "c63c303f-cebe-4617-bec0-c2cfba30cea4",
-  uuid: "efe06e21-8fee-4af5-b028-f502f43d7da6",
-  v: 2019.69,
-  payload: {
-    url: "https://growing-decongestant.biz/",
-  },
-};
-```
-
-## Fields
-
-| Field                                                     | Type                                                      | Required                                                  | Description                                               |
-| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
-| `type`                                                    | *"pageleave"*                                             | :heavy_check_mark:                                        | N/A                                                       |
-| `buildId`                                                 | *string*                                                  | :heavy_check_mark:                                        | N/A                                                       |
-| `clientTs`                                                | *number*                                                  | :heavy_check_mark:                                        | N/A                                                       |
-| `context`                                                 | *models.EnvelopeContext*                                  | :heavy_minus_sign:                                        | N/A                                                       |
-| `environment`                                             | [models.Environment](../models/environment.md)            | :heavy_check_mark:                                        | Deployment environment the SDK is running in.             |
-| `producerVersion`                                         | *string*                                                  | :heavy_minus_sign:                                        | N/A                                                       |
-| `releaseId`                                               | *string*                                                  | :heavy_check_mark:                                        | N/A                                                       |
-| `runtime`                                                 | [models.RuntimeEnum](../models/runtime-enum.md)           | :heavy_check_mark:                                        | JavaScript runtime the SDK is running in.                 |
-| `sdkStack`                                                | *string*[]                                                | :heavy_minus_sign:                                        | N/A                                                       |
-| `sessionId`                                               | *string*                                                  | :heavy_check_mark:                                        | N/A                                                       |
-| `sessionSource`                                           | [models.SessionSource](../models/session-source.md)       | :heavy_minus_sign:                                        | How the server resolved the sessionId for this envelope.  |
-| `uuid`                                                    | *string*                                                  | :heavy_check_mark:                                        | N/A                                                       |
-| `v`                                                       | *number*                                                  | :heavy_check_mark:                                        | N/A                                                       |
-| `payload`                                                 | [models.PageleavePayload](../models/pageleave-payload.md) | :heavy_check_mark:                                        | Payload for a pageleave envelope.                         |

package/docs/models/pageleave-payload.md

@@ -1,20 +0,0 @@
-# PageleavePayload
-
-Payload for a pageleave envelope.
-
-## Example Usage
-
-```typescript
-import { PageleavePayload } from "@interfere/sdk/models";
-
-let value: PageleavePayload = {
-  url: "https://hollow-divine.com/",
-};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `url`              | *string*           | :heavy_check_mark: | N/A                |
-| `durationMs`       | *number*           | :heavy_minus_sign: | N/A                |

package/docs/models/pageview-envelope.md

@@ -1,41 +0,0 @@
-# PageviewEnvelope
-
-## Example Usage
-
-```typescript
-import { PageviewEnvelope } from "@interfere/sdk/models";
-
-let value: PageviewEnvelope = {
-  type: "pageview",
-  buildId: "<id>",
-  clientTs: 423290,
-  environment: "preview",
-  releaseId: "<id>",
-  runtime: "browser",
-  sessionId: "6160c037-fae8-432e-8b8b-21a9a51bf4de",
-  uuid: "6a3ec1bd-4590-4f42-8fd8-68ab0d98b1f7",
-  v: 6873.42,
-  payload: {
-    url: "https://well-to-do-scrap.name/",
-  },
-};
-```
-
-## Fields
-
-| Field                                                    | Type                                                     | Required                                                 | Description                                              |
-| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `type`                                                   | *"pageview"*                                             | :heavy_check_mark:                                       | N/A                                                      |
-| `buildId`                                                | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `clientTs`                                               | *number*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `context`                                                | *models.EnvelopeContext*                                 | :heavy_minus_sign:                                       | N/A                                                      |
-| `environment`                                            | [models.Environment](../models/environment.md)           | :heavy_check_mark:                                       | Deployment environment the SDK is running in.            |
-| `producerVersion`                                        | *string*                                                 | :heavy_minus_sign:                                       | N/A                                                      |
-| `releaseId`                                              | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `runtime`                                                | [models.RuntimeEnum](../models/runtime-enum.md)          | :heavy_check_mark:                                       | JavaScript runtime the SDK is running in.                |
-| `sdkStack`                                               | *string*[]                                               | :heavy_minus_sign:                                       | N/A                                                      |
-| `sessionId`                                              | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `sessionSource`                                          | [models.SessionSource](../models/session-source.md)      | :heavy_minus_sign:                                       | How the server resolved the sessionId for this envelope. |
-| `uuid`                                                   | *string*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `v`                                                      | *number*                                                 | :heavy_check_mark:                                       | N/A                                                      |
-| `payload`                                                | [models.PageviewPayload](../models/pageview-payload.md)  | :heavy_check_mark:                                       | Payload for a pageview envelope.                         |

package/docs/models/pageview-payload.md

@@ -1,20 +0,0 @@
-# PageviewPayload
-
-Payload for a pageview envelope.
-
-## Example Usage
-
-```typescript
-import { PageviewPayload } from "@interfere/sdk/models";
-
-let value: PageviewPayload = {
-  url: "https://sore-minion.com",
-};
-```
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `url`              | *string*           | :heavy_check_mark: | N/A                |
-| `title`            | *string*           | :heavy_minus_sign: | N/A                |