@interfere/sdk 8.1.6 → 9.0.0

package/docs/sdks/health/README.md

@@ -0,0 +1,72 @@
+# Health
+
+## Overview
+
+Health check
+
+### Available Operations
+
+* [get](#get)
+
+## get
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getHealth" method="get" path="/health/" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.health.get();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { healthGet } from "@interfere/sdk/funcs/health-get.js";
+
+// Use `InterfereCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const interfere = new InterfereCore();
+
+async function run() {
+  const res = await healthGet(interfere);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("healthGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.HealthOk](../../models/health-ok.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.HealthError    | 500                   | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |

package/docs/sdks/ingest/README.md

@@ -0,0 +1,175 @@
+# Ingest
+
+## Overview
+
+Event ingestion
+
+### Available Operations
+
+* [post](#post)
+
+## post
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="ingest" method="post" path="/v1/ingest/" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.ingest.post([
+    {
+      type: "replay_chunk",
+      buildId: "<id>",
+      clientTs: 870104,
+      environment: "development",
+      releaseId: "<id>",
+      runtime: "edge",
+      sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
+      uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
+      v: 0,
+      payload: {
+        ts: 4133.68,
+        count: 5545.75,
+        events: [],
+      },
+    },
+    {
+      type: "error",
+      buildId: "<id>",
+      clientTs: 706130,
+      environment: "preview",
+      releaseId: "<id>",
+      runtime: "node",
+      sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
+      uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
+      v: 0,
+      payload: {
+        exceptions: [
+          {
+            type: "<value>",
+            value: "<value>",
+            frames: [],
+          },
+        ],
+      },
+    },
+    {
+      type: "pageview",
+      buildId: "<id>",
+      clientTs: 505979,
+      environment: "preview",
+      releaseId: "<id>",
+      runtime: "edge",
+      sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
+      uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
+      v: 0,
+      payload: {
+        url: "https://same-statue.org/",
+      },
+    },
+  ]);
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { ingestPost } from "@interfere/sdk/funcs/ingest-post.js";
+
+// Use `InterfereCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const interfere = new InterfereCore();
+
+async function run() {
+  const res = await ingestPost(interfere, [
+    {
+      type: "replay_chunk",
+      buildId: "<id>",
+      clientTs: 870104,
+      environment: "development",
+      releaseId: "<id>",
+      runtime: "edge",
+      sessionId: "a2ba99cd-cfa7-4180-8531-8cf43498cb93",
+      uuid: "c6184cb5-7ebf-4da5-8951-879d34f73aaf",
+      v: 0,
+      payload: {
+        ts: 4133.68,
+        count: 5545.75,
+        events: [],
+      },
+    },
+    {
+      type: "error",
+      buildId: "<id>",
+      clientTs: 706130,
+      environment: "preview",
+      releaseId: "<id>",
+      runtime: "node",
+      sessionId: "eb8dc940-e4b3-4f0b-9d81-9d9129ee39d7",
+      uuid: "9c5d368e-bd79-4dcb-8e41-900825ef821a",
+      v: 0,
+      payload: {
+        exceptions: [
+          {
+            type: "<value>",
+            value: "<value>",
+            frames: [],
+          },
+        ],
+      },
+    },
+    {
+      type: "pageview",
+      buildId: "<id>",
+      clientTs: 505979,
+      environment: "preview",
+      releaseId: "<id>",
+      runtime: "edge",
+      sessionId: "4cc5eb79-5187-4fe2-9d83-d5da5974c1d6",
+      uuid: "cb48001e-3621-433b-af3c-476f1ec7ffe8",
+      v: 0,
+      payload: {
+        url: "https://same-statue.org/",
+      },
+    },
+  ]);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ingestPost failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.Envelope[]](../../models/.md)                                                                                                                                          | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.IngestResponse](../../models/ingest-response.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.ErrorsProblem  | 401, 429              | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |

package/docs/sdks/releases/README.md

@@ -0,0 +1,171 @@
+# Releases
+
+## Overview
+
+Release management
+
+### Available Operations
+
+* [getConfig](#getconfig)
+* [create](#create)
+
+## getConfig
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getReleasesConfig" method="get" path="/v1/releases/config" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.releases.getConfig();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { releasesGetConfig } from "@interfere/sdk/funcs/releases-get-config.js";
+
+// Use `InterfereCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const interfere = new InterfereCore();
+
+async function run() {
+  const res = await releasesGetConfig(interfere);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("releasesGetConfig failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.ReleasesConfigResponse](../../models/releases-config-response.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.ErrorsProblem  | 401, 403              | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |
+
+## create
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createRelease" method="post" path="/v1/releases/" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.releases.create({
+    source: {
+      provider: "github",
+      commitMessage: "<value>",
+      branch: "<value>",
+      commitSha: "<value>",
+    },
+    destination: {
+      provider: "vercel",
+      destinationReleaseId: "<id>",
+      environment: "<value>",
+      deploymentId: "<id>",
+      deploymentUrl: "https://narrow-sauerkraut.name",
+      environmentName: "<value>",
+      environmentTarget: "<value>",
+    },
+    buildId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { releasesCreate } from "@interfere/sdk/funcs/releases-create.js";
+
+// Use `InterfereCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const interfere = new InterfereCore();
+
+async function run() {
+  const res = await releasesCreate(interfere, {
+    source: {
+      provider: "github",
+      commitMessage: "<value>",
+      branch: "<value>",
+      commitSha: "<value>",
+    },
+    destination: {
+      provider: "vercel",
+      destinationReleaseId: "<id>",
+      environment: "<value>",
+      deploymentId: "<id>",
+      deploymentUrl: "https://narrow-sauerkraut.name",
+      environmentName: "<value>",
+      environmentTarget: "<value>",
+    },
+    buildId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("releasesCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.ReleasesCreateRequest](../../models/releases-create-request.md)                                                                                                        | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.ReleasesCreateResponse](../../models/releases-create-response.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.ErrorsProblem  | 401, 403, 422         | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |

package/docs/sdks/sessions/README.md

@@ -0,0 +1,156 @@
+# Sessions
+
+## Overview
+
+Session management
+
+### Available Operations
+
+* [create](#create)
+* [identify](#identify)
+
+## create
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createSession" method="post" path="/v1/session/" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.sessions.create({
+    sessionId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { sessionsCreate } from "@interfere/sdk/funcs/sessions-create.js";
+
+// Use `InterfereCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const interfere = new InterfereCore();
+
+async function run() {
+  const res = await sessionsCreate(interfere, {
+    sessionId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("sessionsCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.SessionCreateRequest](../../models/session-create-request.md)                                                                                                          | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.SessionResponse](../../models/session-response.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.ErrorsProblem  | 401                   | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |
+
+## identify
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="identifySession" method="put" path="/v1/session/" -->
+```typescript
+import { Interfere } from "@interfere/sdk";
+
+const interfere = new Interfere();
+
+async function run() {
+  const result = await interfere.sessions.identify({
+    sessionId: "<id>",
+    identifier: "<value>",
+    source: {
+      name: "Clerk",
+      type: "clerk",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { InterfereCore } from "@interfere/sdk/core.js";
+import { sessionsIdentify } from "@interfere/sdk/funcs/sessions-identify.js";
+
+// Use `InterfereCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const interfere = new InterfereCore();
+
+async function run() {
+  const res = await sessionsIdentify(interfere, {
+    sessionId: "<id>",
+    identifier: "<value>",
+    source: {
+      name: "Clerk",
+      type: "clerk",
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("sessionsIdentify failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.SessionIdentifyRequest](../../models/session-identify-request.md)                                                                                                      | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.SessionResponse](../../models/session-response.md)\>**
+
+### Errors
+
+| Error Type            | Status Code           | Content Type          |
+| --------------------- | --------------------- | --------------------- |
+| errors.ErrorsProblem  | 401                   | application/json      |
+| errors.InterfereError | 4XX, 5XX              | \*/\*                 |