npm - @indiciaosint/sdk - Versions diffs - 1.2.9 → 2.0.1 - Mend

@indiciaosint/sdk 1.2.9 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1581) hide show

package/README.md DELETED Viewed

@@ -1,595 +0,0 @@
-<h3>
-    <img src="https://indicia.app/branding/wordmark.png" alt="indicia wordmark" width="300">
-    <br />
-</h3>
-# @indiciaosint/sdk
-Developer-friendly & type-safe Typescript SDK for the Indicia API.
-[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=@indiciaosint/sdk&utm_campaign=typescript)
-<!-- Start Summary [summary] -->
-## Summary
-Indicia API: Programmatically access Indicia's features via API keys.
-        Get started by creating an API key in the [Indicia Dashboard](https://indicia.app/dashboard/account).
-       A JavaScript SDK is also available at [`@indiciaosint/sdk`](https://www.npmjs.com/package/@indiciaosint/sdk)
-<!-- End Summary [summary] -->
-<!-- Start Table of Contents [toc] -->
-## Table of Contents
-<!-- $toc-max-depth=2 -->
-* [@indiciaosint/sdk](#indiciaosintsdk)
-  * [SDK Installation](#sdk-installation)
-  * [Requirements](#requirements)
-  * [SDK Example Usage](#sdk-example-usage)
-  * [Authentication](#authentication)
-  * [Available Resources and Operations](#available-resources-and-operations)
-  * [Standalone functions](#standalone-functions)
-  * [Server-sent event streaming](#server-sent-event-streaming)
-  * [File uploads](#file-uploads)
-  * [Retries](#retries)
-  * [Error Handling](#error-handling)
-  * [Server Selection](#server-selection)
-  * [Custom HTTP Client](#custom-http-client)
-  * [Debugging](#debugging)
-* [Development](#development)
-  * [Maturity](#maturity)
-  * [Contributions](#contributions)
-<!-- End Table of Contents [toc] -->
-<!-- Start SDK Installation [installation] -->
-## SDK Installation
-The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
-### NPM
-```bash
-npm add @indiciaosint/sdk
-```
-### PNPM
-```bash
-pnpm add @indiciaosint/sdk
-```
-### Bun
-```bash
-bun add @indiciaosint/sdk
-```
-### Yarn
-```bash
-yarn add @indiciaosint/sdk
-```
-> [!NOTE]
-> This package is published as an ES Module (ESM) only. For applications using
-> CommonJS, use `await import("@indiciaosint/sdk")` to import and use this package.
-<!-- End SDK Installation [installation] -->
-<!-- Start Requirements [requirements] -->
-## Requirements
-For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
-<!-- End Requirements [requirements] -->
-<!-- Start SDK Example Usage [usage] -->
-## SDK Example Usage
-### Example
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-const indicia = new Indicia({
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.users.getInfo();
-  console.log(result);
-}
-run();
-```
-<!-- End SDK Example Usage [usage] -->
-<!-- Start Authentication [security] -->
-## Authentication
-### Per-Client Security Schemes
-This SDK supports the following security scheme globally:
-| Name     | Type   | Scheme  | Environment Variable |
-| -------- | ------ | ------- | -------------------- |
-| `apiKey` | apiKey | API key | `INDICIA_API_KEY`    |
-To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-const indicia = new Indicia({
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.users.getInfo();
-  console.log(result);
-}
-run();
-```
-<!-- End Authentication [security] -->
-<!-- Start Available Resources and Operations [operations] -->
-## Available Resources and Operations
-<details open>
-<summary>Available methods</summary>
-### [Activity](docs/sdks/activity/README.md)
-* [listActivities](docs/sdks/activity/README.md#listactivities) - Get a list of recent activities.
-* [getActivity](docs/sdks/activity/README.md#getactivity) - Get a specific activity by its ID.
-* [deleteActivity](docs/sdks/activity/README.md#deleteactivity) - Delete a specific activity by its ID.
-### [Infrastructure](docs/sdks/infrastructure/README.md)
-* [searchIpInfo](docs/sdks/infrastructure/README.md#searchipinfo) - IP Info
-* [searchDns](docs/sdks/infrastructure/README.md#searchdns) - DNS Reconnaissance
-* [searchShodan](docs/sdks/infrastructure/README.md#searchshodan) - Shodan Search
-* [virusTotalContent](docs/sdks/infrastructure/README.md#virustotalcontent) - VirusTotal Content Search
-* [searchWhois](docs/sdks/infrastructure/README.md#searchwhois) - Whois
-* [scanPorts](docs/sdks/infrastructure/README.md#scanports) - Port Scan
-* [searchCertificates](docs/sdks/infrastructure/README.md#searchcertificates) - Certificate Lookup
-### [Intelligence](docs/sdks/intelligence/README.md)
-* [searchAddress](docs/sdks/intelligence/README.md#searchaddress) - Address Search (US Only)
-* [searchEmail](docs/sdks/intelligence/README.md#searchemail) - Email Search (US Only)
-* [geolocateMedia](docs/sdks/intelligence/README.md#geolocatemedia) - Geolocate Media
-* [searchGmail](docs/sdks/intelligence/README.md#searchgmail) - Gmail Search
-* [searchPerson](docs/sdks/intelligence/README.md#searchperson) - Person Search (US Only)
-* [searchPhone](docs/sdks/intelligence/README.md#searchphone) - Phone Search (Individual data US only)
-* [searchSeon](docs/sdks/intelligence/README.md#searchseon) - SEON Lookup
-* [virusTotalIntelligence](docs/sdks/intelligence/README.md#virustotalintelligence) - VirusTotal File Intelligence
-* [searchWebDatabases](docs/sdks/intelligence/README.md#searchwebdatabases) - Web Databases
-* [searchFace](docs/sdks/intelligence/README.md#searchface) - Reverse Face Search
-* [searchHudsonRock](docs/sdks/intelligence/README.md#searchhudsonrock) - Hudson Rock Search
-### [Organizations](docs/sdks/organizations/README.md)
-* [listOrganizations](docs/sdks/organizations/README.md#listorganizations) - List organizations the authenticated user belongs to.
-* [getOrganization](docs/sdks/organizations/README.md#getorganization) - Get details for a specific organization you are a member of.
-* [listOrganizationMembers](docs/sdks/organizations/README.md#listorganizationmembers) - List members of an organization you belong to.
-* [getOrganizationAuditLog](docs/sdks/organizations/README.md#getorganizationauditlog) - Get the audit log for an organization. Requires owner or admin role.
-* [listOrganizationCases](docs/sdks/organizations/README.md#listorganizationcases) - List cases shared with an organization (filtered by your visibility settings).
-* [sendOrganizationCredits](docs/sdks/organizations/README.md#sendorganizationcredits) - Send credits from your balance to one or more organization members. Requires owner or admin role.
-### [Pricing](docs/sdks/pricing/README.md)
-* [getPricing](docs/sdks/pricing/README.md#getpricing) - Gives credit pricing for all Indicia services
-### [Socials](docs/sdks/socials/README.md)
-* [searchDiscord](docs/sdks/socials/README.md#searchdiscord) - Discord Search
-* [searchGithub](docs/sdks/socials/README.md#searchgithub) - GitHub Search
-* [searchRoblox](docs/sdks/socials/README.md#searchroblox) - Roblox Search
-* [searchTiktok](docs/sdks/socials/README.md#searchtiktok) - TikTok Search
-* [searchUsername](docs/sdks/socials/README.md#searchusername) - Username Search V2
-### [Tools](docs/sdks/tools/README.md)
-* [searchAppStore](docs/sdks/tools/README.md#searchappstore) - App Store Search
-* [analyzeCryptoAddress](docs/sdks/tools/README.md#analyzecryptoaddress) - Crypto Address Analyzer
-* [lookupDiscordAlt](docs/sdks/tools/README.md#lookupdiscordalt) - Discord Alt Lookup
-* [bypassDoubleCounter](docs/sdks/tools/README.md#bypassdoublecounter) - Bypass Double Counter URL
-* [downloadIntelxFile](docs/sdks/tools/README.md#downloadintelxfile) - Download IntelX file
-* [downloadVirusTotalFile](docs/sdks/tools/README.md#downloadvirustotalfile) - Download VirusTotal file
-### [Users](docs/sdks/users/README.md)
-* [getInfo](docs/sdks/users/README.md#getinfo) - Get information about the user, also healthcheck endpoint.
-</details>
-<!-- End Available Resources and Operations [operations] -->
-<!-- Start Standalone functions [standalone-funcs] -->
-## Standalone functions
-All the methods listed above are available as standalone functions. These
-functions are ideal for use in applications running in the browser, serverless
-runtimes or other environments where application bundle size is a primary
-concern. When using a bundler to build your application, all unused
-functionality will be either excluded from the final bundle or tree-shaken away.
-To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
-<details>
-<summary>Available standalone functions</summary>
-- [`activityDeleteActivity`](docs/sdks/activity/README.md#deleteactivity) - Delete a specific activity by its ID.
-- [`activityGetActivity`](docs/sdks/activity/README.md#getactivity) - Get a specific activity by its ID.
-- [`activityListActivities`](docs/sdks/activity/README.md#listactivities) - Get a list of recent activities.
-- [`infrastructureScanPorts`](docs/sdks/infrastructure/README.md#scanports) - Port Scan
-- [`infrastructureSearchCertificates`](docs/sdks/infrastructure/README.md#searchcertificates) - Certificate Lookup
-- [`infrastructureSearchDns`](docs/sdks/infrastructure/README.md#searchdns) - DNS Reconnaissance
-- [`infrastructureSearchIpInfo`](docs/sdks/infrastructure/README.md#searchipinfo) - IP Info
-- [`infrastructureSearchShodan`](docs/sdks/infrastructure/README.md#searchshodan) - Shodan Search
-- [`infrastructureSearchWhois`](docs/sdks/infrastructure/README.md#searchwhois) - Whois
-- [`infrastructureVirusTotalContent`](docs/sdks/infrastructure/README.md#virustotalcontent) - VirusTotal Content Search
-- [`intelligenceGeolocateMedia`](docs/sdks/intelligence/README.md#geolocatemedia) - Geolocate Media
-- [`intelligenceSearchAddress`](docs/sdks/intelligence/README.md#searchaddress) - Address Search (US Only)
-- [`intelligenceSearchEmail`](docs/sdks/intelligence/README.md#searchemail) - Email Search (US Only)
-- [`intelligenceSearchFace`](docs/sdks/intelligence/README.md#searchface) - Reverse Face Search
-- [`intelligenceSearchGmail`](docs/sdks/intelligence/README.md#searchgmail) - Gmail Search
-- [`intelligenceSearchHudsonRock`](docs/sdks/intelligence/README.md#searchhudsonrock) - Hudson Rock Search
-- [`intelligenceSearchPerson`](docs/sdks/intelligence/README.md#searchperson) - Person Search (US Only)
-- [`intelligenceSearchPhone`](docs/sdks/intelligence/README.md#searchphone) - Phone Search (Individual data US only)
-- [`intelligenceSearchSeon`](docs/sdks/intelligence/README.md#searchseon) - SEON Lookup
-- [`intelligenceSearchWebDatabases`](docs/sdks/intelligence/README.md#searchwebdatabases) - Web Databases
-- [`intelligenceVirusTotalIntelligence`](docs/sdks/intelligence/README.md#virustotalintelligence) - VirusTotal File Intelligence
-- [`organizationsGetOrganization`](docs/sdks/organizations/README.md#getorganization) - Get details for a specific organization you are a member of.
-- [`organizationsGetOrganizationAuditLog`](docs/sdks/organizations/README.md#getorganizationauditlog) - Get the audit log for an organization. Requires owner or admin role.
-- [`organizationsListOrganizationCases`](docs/sdks/organizations/README.md#listorganizationcases) - List cases shared with an organization (filtered by your visibility settings).
-- [`organizationsListOrganizationMembers`](docs/sdks/organizations/README.md#listorganizationmembers) - List members of an organization you belong to.
-- [`organizationsListOrganizations`](docs/sdks/organizations/README.md#listorganizations) - List organizations the authenticated user belongs to.
-- [`organizationsSendOrganizationCredits`](docs/sdks/organizations/README.md#sendorganizationcredits) - Send credits from your balance to one or more organization members. Requires owner or admin role.
-- [`pricingGetPricing`](docs/sdks/pricing/README.md#getpricing) - Gives credit pricing for all Indicia services
-- [`socialsSearchDiscord`](docs/sdks/socials/README.md#searchdiscord) - Discord Search
-- [`socialsSearchGithub`](docs/sdks/socials/README.md#searchgithub) - GitHub Search
-- [`socialsSearchRoblox`](docs/sdks/socials/README.md#searchroblox) - Roblox Search
-- [`socialsSearchTiktok`](docs/sdks/socials/README.md#searchtiktok) - TikTok Search
-- [`socialsSearchUsername`](docs/sdks/socials/README.md#searchusername) - Username Search V2
-- [`toolsAnalyzeCryptoAddress`](docs/sdks/tools/README.md#analyzecryptoaddress) - Crypto Address Analyzer
-- [`toolsBypassDoubleCounter`](docs/sdks/tools/README.md#bypassdoublecounter) - Bypass Double Counter URL
-- [`toolsDownloadIntelxFile`](docs/sdks/tools/README.md#downloadintelxfile) - Download IntelX file
-- [`toolsDownloadVirusTotalFile`](docs/sdks/tools/README.md#downloadvirustotalfile) - Download VirusTotal file
-- [`toolsLookupDiscordAlt`](docs/sdks/tools/README.md#lookupdiscordalt) - Discord Alt Lookup
-- [`toolsSearchAppStore`](docs/sdks/tools/README.md#searchappstore) - App Store Search
-- [`usersGetInfo`](docs/sdks/users/README.md#getinfo) - Get information about the user, also healthcheck endpoint.
-</details>
-<!-- End Standalone functions [standalone-funcs] -->
-<!-- Start Server-sent event streaming [eventstream] -->
-## Server-sent event streaming
-[Server-sent events][mdn-sse] are used to stream content from certain
-operations. These operations will expose the stream as an async iterable that
-can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will
-terminate when the server no longer has any events to send and closes the
-underlying connection.
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-import { openAsBlob } from "node:fs";
-const indicia = new Indicia({
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.intelligence.geolocateMedia({
-    media: await openAsBlob("example.file"),
-  });
-  for await (const event of result) {
-    console.log(event);
-  }
-}
-run();
-```
-[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
-[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
-<!-- End Server-sent event streaming [eventstream] -->
-<!-- Start File uploads [file-upload] -->
-## File uploads
-Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
-> [!TIP]
->
-> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
->
-> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
-> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
-> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
-> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-import { openAsBlob } from "node:fs";
-const indicia = new Indicia({
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.intelligence.geolocateMedia({
-    media: await openAsBlob("example.file"),
-  });
-  for await (const event of result) {
-    console.log(event);
-  }
-}
-run();
-```
-<!-- End File uploads [file-upload] -->
-<!-- Start Retries [retries] -->
-## Retries
-Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
-To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-const indicia = new Indicia({
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.users.getInfo({
-    retries: {
-      strategy: "backoff",
-      backoff: {
-        initialInterval: 1,
-        maxInterval: 50,
-        exponent: 1.1,
-        maxElapsedTime: 100,
-      },
-      retryConnectionErrors: false,
-    },
-  });
-  console.log(result);
-}
-run();
-```
-If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-const indicia = new Indicia({
-  retryConfig: {
-    strategy: "backoff",
-    backoff: {
-      initialInterval: 1,
-      maxInterval: 50,
-      exponent: 1.1,
-      maxElapsedTime: 100,
-    },
-    retryConnectionErrors: false,
-  },
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.users.getInfo();
-  console.log(result);
-}
-run();
-```
-<!-- End Retries [retries] -->
-<!-- Start Error Handling [errors] -->
-## Error Handling
-[`IndiciaError`](./src/models/errors/indicia-error.ts) is the base class for all HTTP error responses. It has the following properties:
-| Property            | Type       | Description                                                                             |
-| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
-| `error.message`     | `string`   | Error message                                                                           |
-| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
-| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
-| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
-| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
-| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
-### Example
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-import * as errors from "@indiciaosint/sdk/models/errors";
-const indicia = new Indicia({
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  try {
-    const result = await indicia.intelligence.searchAddress({
-      address1: "<value>",
-      city: "South Osbaldo",
-      state: "Massachusetts",
-      zip: "35947-4056",
-    });
-    console.log(result);
-  } catch (error) {
-    // The base class for HTTP error responses
-    if (error instanceof errors.IndiciaError) {
-      console.log(error.message);
-      console.log(error.statusCode);
-      console.log(error.body);
-      console.log(error.headers);
-      // Depending on the method different errors may be thrown
-      if (error instanceof errors.FailedResponseError) {
-        console.log(error.data$.success); // boolean
-        console.log(error.data$.error); // string
-      }
-    }
-  }
-}
-run();
-```
-### Error Classes
-**Primary error:**
-* [`IndiciaError`](./src/models/errors/indicia-error.ts): The base class for HTTP error responses.
-<details><summary>Less common errors (7)</summary>
-<br />
-**Network errors:**
-* [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
-* [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
-* [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
-* [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
-* [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.
-**Inherit from [`IndiciaError`](./src/models/errors/indicia-error.ts)**:
-* [`FailedResponseError`](./src/models/errors/failed-response-error.ts): A failed API response. Applicable to 29 of 40 methods.*
-* [`ResponseValidationError`](./src/models/errors/response-validation-error.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
-</details>
-\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
-<!-- End Error Handling [errors] -->
-<!-- Start Server Selection [server] -->
-## Server Selection
-### Override Server URL Per-Client
-The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-const indicia = new Indicia({
-  serverURL: "https://api.indicia.app",
-  apiKey: process.env["INDICIA_API_KEY"] ?? "",
-});
-async function run() {
-  const result = await indicia.users.getInfo();
-  console.log(result);
-}
-run();
-```
-<!-- End Server Selection [server] -->
-<!-- Start Custom HTTP Client [http-client] -->
-## Custom HTTP Client
-The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
-[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
-client is a thin wrapper around `fetch` and provides the ability to attach hooks
-around the request lifecycle that can be used to modify the request or handle
-errors and response.
-The `HTTPClient` constructor takes an optional `fetcher` argument that can be
-used to integrate a third-party HTTP client or when writing tests to mock out
-the HTTP client and feed in fixtures.
-The following example shows how to:
-- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
-- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
-- use the `"requestError"` hook to log errors
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-import { ProxyAgent } from "undici";
-import { HTTPClient } from "@indiciaosint/sdk/lib/http";
-const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
-const httpClient = new HTTPClient({
-  // 'fetcher' takes a function that has the same signature as native 'fetch'.
-  fetcher: (input, init) =>
-    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
-    fetch(input, { ...init, dispatcher } as RequestInit),
-});
-httpClient.addHook("beforeRequest", (request) => {
-  const nextRequest = new Request(request, {
-    signal: request.signal || AbortSignal.timeout(5000)
-  });
-  nextRequest.headers.set("x-custom-header", "custom value");
-  return nextRequest;
-});
-httpClient.addHook("requestError", (error, request) => {
-  console.group("Request Error");
-  console.log("Reason:", `${error}`);
-  console.log("Endpoint:", `${request.method} ${request.url}`);
-  console.groupEnd();
-});
-const sdk = new Indicia({ httpClient: httpClient });
-```
-<!-- End Custom HTTP Client [http-client] -->
-<!-- Start Debugging [debug] -->
-## Debugging
-You can setup your SDK to emit debug logs for SDK requests and responses.
-You can pass a logger that matches `console`'s interface as an SDK option.
-> [!WARNING]
-> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
-```typescript
-import { Indicia } from "@indiciaosint/sdk";
-const sdk = new Indicia({ debugLogger: console });
-```
-You can also enable a default debug logger by setting an environment variable `INDICIA_DEBUG` to true.
-<!-- End Debugging [debug] -->
-<!-- Placeholder for Future Speakeasy SDK Sections -->
-# Development
-## Maturity
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
-to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
-looking for the latest version.
-## Contributions
-While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
-### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@indiciaosint/sdk&utm_campaign=typescript)

package/RUNTIMES.md DELETED Viewed

@@ -1,48 +0,0 @@
-# Supported JavaScript runtimes
-This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
-- [Web Fetch API][web-fetch]
-- [Web Streams API][web-streams] and in particular `ReadableStream`
-- [Async iterables][async-iter] using `Symbol.asyncIterator`
-[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
-[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
-[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
-Runtime environments that are explicitly supported are:
-- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
-- Node.js active and maintenance LTS releases
-  - Currently, this is v18 and v20
-- Bun v1 and above
-- Deno v1.39
-  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
-[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
-## Recommended TypeScript compiler options
-The following `tsconfig.json` options are recommended for projects using this
-SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of],
-[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
-so on):
-[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
-[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
-[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
-[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
-```jsonc
-{
-  "compilerOptions": {
-    "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"]
-  }
-}
-```
-While `target` can be set to older ECMAScript versions, it may result in extra,
-unnecessary compatibility code being generated if you are not targeting old
-runtimes.

package/esm/core.d.ts DELETED Viewed

@@ -1,10 +0,0 @@
-import { ClientSDK } from "./lib/sdks.js";
-/**
- * A minimal client to use when calling standalone SDK functions. Typically, an
- * instance of this class would be instantiated once at the start of an
- * application and passed around through some dependency injection mechanism  to
- * parts of an application that need to make SDK calls.
- */
-export declare class IndiciaCore extends ClientSDK {
-}
-//# sourceMappingURL=core.d.ts.map

package/esm/core.d.ts.map DELETED Viewed

	@@ -1 +0,0 @@
1	- {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,SAAS;CAAG"}

package/esm/core.js DELETED Viewed

@@ -1,13 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-import { ClientSDK } from "./lib/sdks.js";
-/**
- * A minimal client to use when calling standalone SDK functions. Typically, an
- * instance of this class would be instantiated once at the start of an
- * application and passed around through some dependency injection mechanism  to
- * parts of an application that need to make SDK calls.
- */
-export class IndiciaCore extends ClientSDK {
-}
-//# sourceMappingURL=core.js.map

package/esm/core.js.map DELETED Viewed

	@@ -1 +0,0 @@
1	- {"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS;CAAG"}