@interfere/sdk 8.1.2 → 9.0.0

package/docs/models/release-build-ref.md

@@ -0,0 +1,17 @@
+# ReleaseBuildRef
+
+## Example Usage
+
+```typescript
+import { ReleaseBuildRef } from "@interfere/sdk/models";
+
+let value: ReleaseBuildRef = {
+  hash: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `hash`             | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/release-destination-ref.md

@@ -0,0 +1,21 @@
+# ReleaseDestinationRef
+
+## Example Usage
+
+```typescript
+import { ReleaseDestinationRef } from "@interfere/sdk/models";
+
+let value: ReleaseDestinationRef = {
+  id: "<id>",
+  slug: "<value>",
+  environment: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | N/A                |
+| `slug`             | *string*           | :heavy_check_mark: | N/A                |
+| `environment`      | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/release-destination.md

@@ -0,0 +1,19 @@
+# ReleaseDestination
+
+
+## Supported Types
+
+### `models.VercelReleaseDestination`
+
+```typescript
+const value: models.VercelReleaseDestination = {
+  provider: "vercel",
+  destinationReleaseId: "<id>",
+  environment: "<value>",
+  deploymentId: "<id>",
+  deploymentUrl: "https://front-kinase.biz",
+  environmentName: null,
+  environmentTarget: "<value>",
+};
+```
+

package/docs/models/release-source-ref.md

@@ -0,0 +1,17 @@
+# ReleaseSourceRef
+
+## Example Usage
+
+```typescript
+import { ReleaseSourceRef } from "@interfere/sdk/models";
+
+let value: ReleaseSourceRef = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/release-source.md

@@ -0,0 +1,16 @@
+# ReleaseSource
+
+
+## Supported Types
+
+### `models.GithubReleaseSource`
+
+```typescript
+const value: models.GithubReleaseSource = {
+  provider: "github",
+  commitMessage: "<value>",
+  branch: "<value>",
+  commitSha: "<value>",
+};
+```
+

package/docs/models/releases-config-response-plugins.md

@@ -0,0 +1,19 @@
+# ReleasesConfigResponsePlugins
+
+## Example Usage
+
+```typescript
+import { ReleasesConfigResponsePlugins } from "@interfere/sdk/models";
+
+let value: ReleasesConfigResponsePlugins = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `errors`           | *boolean*          | :heavy_minus_sign: | N/A                |
+| `device`           | *boolean*          | :heavy_minus_sign: | N/A                |
+| `pageEvents`       | *boolean*          | :heavy_minus_sign: | N/A                |
+| `rageClick`        | *boolean*          | :heavy_minus_sign: | N/A                |
+| `replay`           | *boolean*          | :heavy_minus_sign: | N/A                |

package/docs/models/releases-config-response.md

@@ -0,0 +1,29 @@
+# ReleasesConfigResponse
+
+## Example Usage
+
+```typescript
+import { ReleasesConfigResponse } from "@interfere/sdk/models";
+
+let value: ReleasesConfigResponse = {
+  surface: {
+    id: "<id>",
+    slug: "<value>",
+    allowDirectIngestion: true,
+    sourceProvider: null,
+    destinationProvider: "vercel",
+    sdkConfig: {},
+  },
+  org: {
+    id: "<id>",
+    slug: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                  | Type                                   | Required                               | Description                            |
+| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
+| `surface`                              | [models.Surface](../models/surface.md) | :heavy_check_mark:                     | N/A                                    |
+| `org`                                  | [models.Org](../models/org.md)         | :heavy_check_mark:                     | N/A                                    |

package/docs/models/releases-create-request.md

@@ -0,0 +1,37 @@
+# ReleasesCreateRequest
+
+Request body for creating a release.
+
+## Example Usage
+
+```typescript
+import { ReleasesCreateRequest } from "@interfere/sdk/models";
+
+let value: ReleasesCreateRequest = {
+  source: {
+    provider: "github",
+    commitMessage: "<value>",
+    branch: "<value>",
+    commitSha: "<value>",
+  },
+  destination: {
+    provider: "vercel",
+    destinationReleaseId: "<id>",
+    environment: "<value>",
+    deploymentId: null,
+    deploymentUrl: "https://authorized-gown.name/",
+    environmentName: "<value>",
+    environmentTarget: "<value>",
+  },
+  buildId: "<id>",
+};
+```
+
+## Fields
+
+| Field                       | Type                        | Required                    | Description                 |
+| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
+| `source`                    | *models.ReleaseSource*      | :heavy_check_mark:          | N/A                         |
+| `destination`               | *models.ReleaseDestination* | :heavy_check_mark:          | N/A                         |
+| `buildId`                   | *string*                    | :heavy_check_mark:          | N/A                         |
+| `producerVersion`           | *string*                    | :heavy_minus_sign:          | N/A                         |

package/docs/models/releases-create-response.md

@@ -0,0 +1,41 @@
+# ReleasesCreateResponse
+
+Response body returned after creating a release.
+
+## Example Usage
+
+```typescript
+import { ReleasesCreateResponse } from "@interfere/sdk/models";
+
+let value: ReleasesCreateResponse = {
+  org: {
+    id: "<id>",
+    slug: "<value>",
+  },
+  surface: {
+    id: "<id>",
+    slug: "<value>",
+  },
+  source: {
+    id: "<id>",
+  },
+  destination: {
+    id: "<id>",
+    slug: "<value>",
+    environment: "<value>",
+  },
+  build: {
+    hash: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `org`                                                                | [models.OrgRef](../models/org-ref.md)                                | :heavy_check_mark:                                                   | N/A                                                                  |
+| `surface`                                                            | [models.SurfaceRef](../models/surface-ref.md)                        | :heavy_check_mark:                                                   | N/A                                                                  |
+| `source`                                                             | [models.ReleaseSourceRef](../models/release-source-ref.md)           | :heavy_check_mark:                                                   | N/A                                                                  |
+| `destination`                                                        | [models.ReleaseDestinationRef](../models/release-destination-ref.md) | :heavy_check_mark:                                                   | N/A                                                                  |
+| `build`                                                              | [models.ReleaseBuildRef](../models/release-build-ref.md)             | :heavy_check_mark:                                                   | N/A                                                                  |

package/docs/models/releases-telemetry-request.md

@@ -0,0 +1,31 @@
+# ReleasesTelemetryRequest
+
+Timings and counters reported after a source-map upload.
+
+## Example Usage
+
+```typescript
+import { ReleasesTelemetryRequest } from "@interfere/sdk/models";
+
+let value: ReleasesTelemetryRequest = {
+  discover: 43.96,
+  createRelease: 6949.89,
+  upload: 4437.46,
+  cleanup: 418.22,
+  total: 330.35,
+  fileCount: 7768.78,
+  totalBytes: 6510.58,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `discover`         | *number*           | :heavy_check_mark: | N/A                |
+| `createRelease`    | *number*           | :heavy_check_mark: | N/A                |
+| `upload`           | *number*           | :heavy_check_mark: | N/A                |
+| `cleanup`          | *number*           | :heavy_check_mark: | N/A                |
+| `total`            | *number*           | :heavy_check_mark: | N/A                |
+| `fileCount`        | *number*           | :heavy_check_mark: | N/A                |
+| `totalBytes`       | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/releases-telemetry-response.md

@@ -0,0 +1,17 @@
+# ReleasesTelemetryResponse
+
+## Example Usage
+
+```typescript
+import { ReleasesTelemetryResponse } from "@interfere/sdk/models";
+
+let value: ReleasesTelemetryResponse = {
+  ok: true,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ok`               | *boolean*          | :heavy_check_mark: | N/A                |

package/docs/models/releases-upload-source-maps-request1.md

@@ -0,0 +1,26 @@
+# ReleasesUploadSourceMapsRequest1
+
+Multipart body for uploading source maps for a release.
+
+## Example Usage
+
+```typescript
+import { ReleasesUploadSourceMapsRequest1 } from "@interfere/sdk/models";
+
+let value: ReleasesUploadSourceMapsRequest1 = {
+  files: [
+    new TextEncoder().encode("0x916dE60DCf"),
+  ],
+  metadata: {
+    sourceMapToGenerated: {},
+    hashes: {},
+  },
+};
+```
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `files`                                                                     | *Uint8Array*[]                                                              | :heavy_check_mark:                                                          | Source map files to upload.                                                 |
+| `metadata`                                                                  | [models.UploadSourceMapsMetadata](../models/upload-source-maps-metadata.md) | :heavy_check_mark:                                                          | Metadata attached alongside uploaded source map files.                      |

package/docs/models/releases-upload-source-maps-request2.md

@@ -0,0 +1,27 @@
+# ReleasesUploadSourceMapsRequest2
+
+Multipart body for uploading source maps for a release.
+
+## Example Usage
+
+```typescript
+import { ReleasesUploadSourceMapsRequest2 } from "@interfere/sdk/models";
+import { openAsBlob } from "node:fs";
+
+let value: ReleasesUploadSourceMapsRequest2 = {
+  files: [
+    await openAsBlob("example.file"),
+  ],
+  metadata: {
+    sourceMapToGenerated: {},
+    hashes: {},
+  },
+};
+```
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `files`                                                                     | [models.FileT](../models/file-t.md)[]                                       | :heavy_check_mark:                                                          | Source map files to upload.                                                 |
+| `metadata`                                                                  | [models.UploadSourceMapsMetadata](../models/upload-source-maps-metadata.md) | :heavy_check_mark:                                                          | Metadata attached alongside uploaded source map files.                      |

package/docs/models/releases-upload-source-maps-response.md

@@ -0,0 +1,23 @@
+# ReleasesUploadSourceMapsResponse
+
+## Example Usage
+
+```typescript
+import { ReleasesUploadSourceMapsResponse } from "@interfere/sdk/models";
+
+let value: ReleasesUploadSourceMapsResponse = {
+  ok: true,
+  processed: 6745.12,
+  message: "<value>",
+  fileCount: 7739.9,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ok`               | *boolean*          | :heavy_check_mark: | N/A                |
+| `processed`        | *number*           | :heavy_check_mark: | N/A                |
+| `message`          | *string*           | :heavy_check_mark: | N/A                |
+| `fileCount`        | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/render-source.md

@@ -0,0 +1,15 @@
+# RenderSource
+
+## Example Usage
+
+```typescript
+import { RenderSource } from "@interfere/sdk/models";
+
+let value: RenderSource = "react-server-components";
+```
+
+## Values
+
+```typescript
+"react-server-components" | "react-server-components-payload" | "server-rendering"
+```

package/docs/models/render-type.md

@@ -0,0 +1,15 @@
+# RenderType
+
+## Example Usage
+
+```typescript
+import { RenderType } from "@interfere/sdk/models";
+
+let value: RenderType = "dynamic";
+```
+
+## Values
+
+```typescript
+"dynamic" | "dynamic-resume"
+```

package/docs/models/replay-chunk-envelope.md

@@ -0,0 +1,43 @@
+# ReplayChunkEnvelope
+
+## Example Usage
+
+```typescript
+import { ReplayChunkEnvelope } from "@interfere/sdk/models";
+
+let value: 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: [],
+  },
+};
+```
+
+## Fields
+
+| Field                                                          | Type                                                           | Required                                                       | Description                                                    |
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
+| `type`                                                         | *"replay_chunk"*                                               | :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.ReplayChunkPayload](../models/replay-chunk-payload.md) | :heavy_check_mark:                                             | Payload for a replay-chunk envelope.                           |

package/docs/models/replay-chunk-payload.md

@@ -0,0 +1,28 @@
+# ReplayChunkPayload
+
+Payload for a replay-chunk envelope.
+
+## Example Usage
+
+```typescript
+import { ReplayChunkPayload } from "@interfere/sdk/models";
+
+let value: ReplayChunkPayload = {
+  ts: 294.31,
+  count: 6752.13,
+  events: [
+    "<value 1>",
+    "<value 2>",
+  ],
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ts`               | *number*           | :heavy_check_mark: | N/A                |
+| `count`            | *number*           | :heavy_check_mark: | N/A                |
+| `events`           | *string*[]         | :heavy_check_mark: | N/A                |
+| `firstEventTs`     | *number*           | :heavy_minus_sign: | N/A                |
+| `lastEventTs`      | *number*           | :heavy_minus_sign: | N/A                |

package/docs/models/revalidate-reason.md

@@ -0,0 +1,15 @@
+# RevalidateReason
+
+## Example Usage
+
+```typescript
+import { RevalidateReason } from "@interfere/sdk/models";
+
+let value: RevalidateReason = "on-demand";
+```
+
+## Values
+
+```typescript
+"on-demand" | "stale"
+```

package/docs/models/route-type.md

@@ -0,0 +1,15 @@
+# RouteType
+
+## Example Usage
+
+```typescript
+import { RouteType } from "@interfere/sdk/models";
+
+let value: RouteType = "proxy";
+```
+
+## Values
+
+```typescript
+"render" | "route" | "action" | "middleware" | "proxy"
+```

package/docs/models/router-kind.md

@@ -0,0 +1,15 @@
+# RouterKind
+
+## Example Usage
+
+```typescript
+import { RouterKind } from "@interfere/sdk/models";
+
+let value: RouterKind = "Pages Router";
+```
+
+## Values
+
+```typescript
+"Pages Router" | "App Router"
+```

package/docs/models/runtime-enum.md

@@ -0,0 +1,17 @@
+# RuntimeEnum
+
+JavaScript runtime the SDK is running in.
+
+## Example Usage
+
+```typescript
+import { RuntimeEnum } from "@interfere/sdk/models";
+
+let value: RuntimeEnum = "node";
+```
+
+## Values
+
+```typescript
+"browser" | "node" | "edge"
+```

package/docs/models/screen.md

@@ -0,0 +1,20 @@
+# Screen
+
+## Example Usage
+
+```typescript
+import { Screen } from "@interfere/sdk/models";
+
+let value: Screen = {
+  height: 7975.95,
+  width: 513.05,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `height`           | *number*           | :heavy_check_mark: | N/A                |
+| `width`            | *number*           | :heavy_check_mark: | N/A                |
+| `orientation`      | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/sdk-config.md

@@ -0,0 +1,15 @@
+# SDKConfig
+
+## Example Usage
+
+```typescript
+import { SDKConfig } from "@interfere/sdk/models";
+
+let value: SDKConfig = {};
+```
+
+## Fields
+
+| Field                                                                                 | Type                                                                                  | Required                                                                              | Description                                                                           |
+| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| `plugins`                                                                             | [models.ReleasesConfigResponsePlugins](../models/releases-config-response-plugins.md) | :heavy_minus_sign:                                                                    | N/A                                                                                   |

package/docs/models/session-create-request.md

@@ -0,0 +1,22 @@
+# SessionCreateRequest
+
+Request body for creating a session.
+
+## Example Usage
+
+```typescript
+import { SessionCreateRequest } from "@interfere/sdk/models";
+
+let value: SessionCreateRequest = {
+  sessionId: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `sessionId`        | *string*           | :heavy_check_mark: | N/A                |
+| `deviceId`         | *string*           | :heavy_minus_sign: | N/A                |
+| `fpHash`           | *string*           | :heavy_minus_sign: | N/A                |
+| `visitorId`        | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/session-identify-request.md

@@ -0,0 +1,34 @@
+# SessionIdentifyRequest
+
+Request body for identifying the end user associated with a session.
+
+## Example Usage
+
+```typescript
+import { SessionIdentifyRequest } from "@interfere/sdk/models";
+
+let value: SessionIdentifyRequest = {
+  sessionId: "<id>",
+  identifier: "<value>",
+  source: {
+    name: "Clerk",
+    type: "clerk",
+  },
+};
+```
+
+## Fields
+
+| Field                                            | Type                                             | Required                                         | Description                                      |
+| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| `name`                                           | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `sessionId`                                      | *string*                                         | :heavy_check_mark:                               | N/A                                              |
+| `deviceId`                                       | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `fpHash`                                         | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `visitorId`                                      | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `avatar`                                         | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `email`                                          | *string*                                         | :heavy_minus_sign:                               | N/A                                              |
+| `identifier`                                     | *string*                                         | :heavy_check_mark:                               | N/A                                              |
+| `source`                                         | *models.IdentifySource*                          | :heavy_check_mark:                               | Auth provider that surfaced this identification. |
+| `traits`                                         | Record<string, *any*>                            | :heavy_minus_sign:                               | N/A                                              |
+| `country`                                        | *string*                                         | :heavy_minus_sign:                               | N/A                                              |

package/docs/models/session-response.md

@@ -0,0 +1,17 @@
+# SessionResponse
+
+## Example Usage
+
+```typescript
+import { SessionResponse } from "@interfere/sdk/models";
+
+let value: SessionResponse = {
+  ok: true,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `ok`               | *boolean*          | :heavy_check_mark: | N/A                |