@indiciaosint/sdk 0.0.1 → 1.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.
- package/README.md +5 -9
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/jsr.json +1 -1
- package/package.json +14 -7
- package/src/lib/config.ts +2 -2
- package/.devcontainer/README.md +0 -30
- package/docs/sdks/indicia/README.md +0 -3053
- package/examples/README.md +0 -31
- package/examples/node_modules/@esbuild/darwin-arm64/README.md +0 -3
- package/examples/node_modules/@types/node/LICENSE +0 -21
- package/examples/node_modules/@types/node/README.md +0 -15
- package/examples/node_modules/@types/node/assert/strict.d.ts +0 -8
- package/examples/node_modules/@types/node/assert.d.ts +0 -1062
- package/examples/node_modules/@types/node/async_hooks.d.ts +0 -605
- package/examples/node_modules/@types/node/buffer.buffer.d.ts +0 -471
- package/examples/node_modules/@types/node/buffer.d.ts +0 -1936
- package/examples/node_modules/@types/node/child_process.d.ts +0 -1475
- package/examples/node_modules/@types/node/cluster.d.ts +0 -577
- package/examples/node_modules/@types/node/compatibility/disposable.d.ts +0 -16
- package/examples/node_modules/@types/node/compatibility/index.d.ts +0 -9
- package/examples/node_modules/@types/node/compatibility/indexable.d.ts +0 -20
- package/examples/node_modules/@types/node/compatibility/iterators.d.ts +0 -21
- package/examples/node_modules/@types/node/console.d.ts +0 -452
- package/examples/node_modules/@types/node/constants.d.ts +0 -21
- package/examples/node_modules/@types/node/crypto.d.ts +0 -4590
- package/examples/node_modules/@types/node/dgram.d.ts +0 -597
- package/examples/node_modules/@types/node/diagnostics_channel.d.ts +0 -578
- package/examples/node_modules/@types/node/dns/promises.d.ts +0 -479
- package/examples/node_modules/@types/node/dns.d.ts +0 -871
- package/examples/node_modules/@types/node/domain.d.ts +0 -170
- package/examples/node_modules/@types/node/events.d.ts +0 -977
- package/examples/node_modules/@types/node/fs/promises.d.ts +0 -1270
- package/examples/node_modules/@types/node/fs.d.ts +0 -4375
- package/examples/node_modules/@types/node/globals.d.ts +0 -172
- package/examples/node_modules/@types/node/globals.typedarray.d.ts +0 -38
- package/examples/node_modules/@types/node/http.d.ts +0 -2049
- package/examples/node_modules/@types/node/http2.d.ts +0 -2712
- package/examples/node_modules/@types/node/https.d.ts +0 -578
- package/examples/node_modules/@types/node/index.d.ts +0 -93
- package/examples/node_modules/@types/node/inspector.generated.d.ts +0 -3966
- package/examples/node_modules/@types/node/module.d.ts +0 -539
- package/examples/node_modules/@types/node/net.d.ts +0 -1031
- package/examples/node_modules/@types/node/os.d.ts +0 -506
- package/examples/node_modules/@types/node/path.d.ts +0 -200
- package/examples/node_modules/@types/node/perf_hooks.d.ts +0 -961
- package/examples/node_modules/@types/node/process.d.ts +0 -1961
- package/examples/node_modules/@types/node/punycode.d.ts +0 -117
- package/examples/node_modules/@types/node/querystring.d.ts +0 -152
- package/examples/node_modules/@types/node/readline/promises.d.ts +0 -162
- package/examples/node_modules/@types/node/readline.d.ts +0 -589
- package/examples/node_modules/@types/node/repl.d.ts +0 -430
- package/examples/node_modules/@types/node/sea.d.ts +0 -153
- package/examples/node_modules/@types/node/stream/consumers.d.ts +0 -38
- package/examples/node_modules/@types/node/stream/promises.d.ts +0 -90
- package/examples/node_modules/@types/node/stream/web.d.ts +0 -533
- package/examples/node_modules/@types/node/stream.d.ts +0 -1698
- package/examples/node_modules/@types/node/string_decoder.d.ts +0 -67
- package/examples/node_modules/@types/node/test.d.ts +0 -1787
- package/examples/node_modules/@types/node/timers/promises.d.ts +0 -108
- package/examples/node_modules/@types/node/timers.d.ts +0 -286
- package/examples/node_modules/@types/node/tls.d.ts +0 -1259
- package/examples/node_modules/@types/node/trace_events.d.ts +0 -197
- package/examples/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +0 -468
- package/examples/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +0 -34
- package/examples/node_modules/@types/node/ts5.6/index.d.ts +0 -93
- package/examples/node_modules/@types/node/tty.d.ts +0 -208
- package/examples/node_modules/@types/node/url.d.ts +0 -964
- package/examples/node_modules/@types/node/util.d.ts +0 -2331
- package/examples/node_modules/@types/node/v8.d.ts +0 -809
- package/examples/node_modules/@types/node/vm.d.ts +0 -1001
- package/examples/node_modules/@types/node/wasi.d.ts +0 -181
- package/examples/node_modules/@types/node/web-globals/abortcontroller.d.ts +0 -34
- package/examples/node_modules/@types/node/web-globals/domexception.d.ts +0 -68
- package/examples/node_modules/@types/node/web-globals/events.d.ts +0 -97
- package/examples/node_modules/@types/node/web-globals/fetch.d.ts +0 -55
- package/examples/node_modules/@types/node/worker_threads.d.ts +0 -715
- package/examples/node_modules/@types/node/zlib.d.ts +0 -598
- package/examples/node_modules/dotenv/LICENSE +0 -23
- package/examples/node_modules/dotenv/README.md +0 -645
- package/examples/node_modules/dotenv/config.d.ts +0 -1
- package/examples/node_modules/dotenv/config.js +0 -9
- package/examples/node_modules/dotenv/lib/cli-options.js +0 -17
- package/examples/node_modules/dotenv/lib/env-options.js +0 -28
- package/examples/node_modules/dotenv/lib/main.d.ts +0 -162
- package/examples/node_modules/dotenv/lib/main.js +0 -386
- package/examples/node_modules/esbuild/LICENSE.md +0 -21
- package/examples/node_modules/esbuild/README.md +0 -3
- package/examples/node_modules/esbuild/install.js +0 -300
- package/examples/node_modules/esbuild/lib/main.d.ts +0 -716
- package/examples/node_modules/esbuild/lib/main.js +0 -2532
- package/examples/node_modules/fsevents/LICENSE +0 -22
- package/examples/node_modules/fsevents/README.md +0 -89
- package/examples/node_modules/fsevents/fsevents.d.ts +0 -46
- package/examples/node_modules/fsevents/fsevents.js +0 -83
- package/examples/node_modules/tsx/LICENSE +0 -21
- package/examples/node_modules/tsx/README.md +0 -32
- package/examples/node_modules/tsx/dist/cjs/api/index.mjs +0 -1
- package/examples/node_modules/tsx/dist/cjs/index.mjs +0 -1
- package/examples/node_modules/tsx/dist/cli.mjs +0 -55
- package/examples/node_modules/tsx/dist/client-D_mPDF5S.mjs +0 -1
- package/examples/node_modules/tsx/dist/esm/api/index.mjs +0 -1
- package/examples/node_modules/tsx/dist/esm/index.mjs +0 -1
- package/examples/node_modules/tsx/dist/get-pipe-path-_tAJyU_v.mjs +0 -1
- package/examples/node_modules/tsx/dist/index-XurvG3JN.mjs +0 -14
- package/examples/node_modules/tsx/dist/index-gbaejti9.mjs +0 -1
- package/examples/node_modules/tsx/dist/lexer-DQCqS3nf.mjs +0 -3
- package/examples/node_modules/tsx/dist/loader.mjs +0 -1
- package/examples/node_modules/tsx/dist/node-features-B9BBLzwu.mjs +0 -1
- package/examples/node_modules/tsx/dist/package-Bj47PlGH.mjs +0 -1
- package/examples/node_modules/tsx/dist/patch-repl.mjs +0 -1
- package/examples/node_modules/tsx/dist/preflight.mjs +0 -1
- package/examples/node_modules/tsx/dist/register-BnTWPeIB.mjs +0 -10
- package/examples/node_modules/tsx/dist/register-CqMfTiWi.mjs +0 -2
- package/examples/node_modules/tsx/dist/repl.mjs +0 -3
- package/examples/node_modules/tsx/dist/require-DzmC1hVr.mjs +0 -1
- package/examples/node_modules/tsx/dist/suppress-warnings.mjs +0 -1
- package/examples/node_modules/tsx/dist/temporary-directory-BDDVQOvU.mjs +0 -1
- package/examples/node_modules/tsx/dist/types-Cxp8y2TL.d.ts +0 -5
- package/examples/node_modules/undici-types/LICENSE +0 -21
- package/examples/node_modules/undici-types/README.md +0 -6
- package/examples/node_modules/undici-types/agent.d.ts +0 -31
- package/examples/node_modules/undici-types/api.d.ts +0 -43
- package/examples/node_modules/undici-types/balanced-pool.d.ts +0 -29
- package/examples/node_modules/undici-types/cache.d.ts +0 -36
- package/examples/node_modules/undici-types/client.d.ts +0 -108
- package/examples/node_modules/undici-types/connector.d.ts +0 -34
- package/examples/node_modules/undici-types/content-type.d.ts +0 -21
- package/examples/node_modules/undici-types/cookies.d.ts +0 -28
- package/examples/node_modules/undici-types/diagnostics-channel.d.ts +0 -66
- package/examples/node_modules/undici-types/dispatcher.d.ts +0 -256
- package/examples/node_modules/undici-types/env-http-proxy-agent.d.ts +0 -21
- package/examples/node_modules/undici-types/errors.d.ts +0 -149
- package/examples/node_modules/undici-types/eventsource.d.ts +0 -61
- package/examples/node_modules/undici-types/fetch.d.ts +0 -209
- package/examples/node_modules/undici-types/file.d.ts +0 -39
- package/examples/node_modules/undici-types/filereader.d.ts +0 -54
- package/examples/node_modules/undici-types/formdata.d.ts +0 -108
- package/examples/node_modules/undici-types/global-dispatcher.d.ts +0 -9
- package/examples/node_modules/undici-types/global-origin.d.ts +0 -7
- package/examples/node_modules/undici-types/handlers.d.ts +0 -15
- package/examples/node_modules/undici-types/header.d.ts +0 -4
- package/examples/node_modules/undici-types/index.d.ts +0 -71
- package/examples/node_modules/undici-types/interceptors.d.ts +0 -17
- package/examples/node_modules/undici-types/mock-agent.d.ts +0 -50
- package/examples/node_modules/undici-types/mock-client.d.ts +0 -25
- package/examples/node_modules/undici-types/mock-errors.d.ts +0 -12
- package/examples/node_modules/undici-types/mock-interceptor.d.ts +0 -93
- package/examples/node_modules/undici-types/mock-pool.d.ts +0 -25
- package/examples/node_modules/undici-types/patch.d.ts +0 -33
- package/examples/node_modules/undici-types/pool-stats.d.ts +0 -19
- package/examples/node_modules/undici-types/pool.d.ts +0 -39
- package/examples/node_modules/undici-types/proxy-agent.d.ts +0 -28
- package/examples/node_modules/undici-types/readable.d.ts +0 -65
- package/examples/node_modules/undici-types/retry-agent.d.ts +0 -8
- package/examples/node_modules/undici-types/retry-handler.d.ts +0 -116
- package/examples/node_modules/undici-types/util.d.ts +0 -18
- package/examples/node_modules/undici-types/webidl.d.ts +0 -228
- package/examples/node_modules/undici-types/websocket.d.ts +0 -150
|
@@ -1,3053 +0,0 @@
|
|
|
1
|
-
# Indicia SDK
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
Indicia API: Development documentation
|
|
6
|
-
|
|
7
|
-
### Available Operations
|
|
8
|
-
|
|
9
|
-
* [getV1Info](#getv1info) - Get information about the user, also healthcheck endpoint.
|
|
10
|
-
* [getV1Pricing](#getv1pricing) - Gives credit pricing for all Indicia services
|
|
11
|
-
* [getV1Activity](#getv1activity) - Get a list of recent activities.
|
|
12
|
-
* [getV1ActivityById](#getv1activitybyid) - Get a specific activity by its ID.
|
|
13
|
-
* [deleteV1ActivityById](#deletev1activitybyid) - Delete a specific activity by its ID.
|
|
14
|
-
* [postV1SearchIntelligenceAddress](#postv1searchintelligenceaddress) - Address Search (US Only)
|
|
15
|
-
* [postV1SearchIntelligenceEmail](#postv1searchintelligenceemail) - Email Search (US Only)
|
|
16
|
-
* [postV1SearchIntelligenceGeolocation](#postv1searchintelligencegeolocation) - Geolocate Media
|
|
17
|
-
* [postV1SearchIntelligenceGmail](#postv1searchintelligencegmail) - Gmail Search
|
|
18
|
-
* [postV1SearchIntelligencePerson](#postv1searchintelligenceperson) - Person Search (US Only)
|
|
19
|
-
* [postV1SearchIntelligencePhone](#postv1searchintelligencephone) - Phone Search (Individual data US only)
|
|
20
|
-
* [postV1SearchIntelligenceSeon](#postv1searchintelligenceseon) - SEON Lookup
|
|
21
|
-
* [postV1SearchIntelligenceWebDbs](#postv1searchintelligencewebdbs) - Web Databases
|
|
22
|
-
* [postV1SearchIntelligenceFacial](#postv1searchintelligencefacial) - Reverse Face Search
|
|
23
|
-
* [postV1SearchIntelligenceHudsonrock](#postv1searchintelligencehudsonrock) - Hudson Rock Search
|
|
24
|
-
* [postV1SearchSocialsDiscord](#postv1searchsocialsdiscord) - Discord Search
|
|
25
|
-
* [postV1SearchSocialsGithub](#postv1searchsocialsgithub) - GitHub Search
|
|
26
|
-
* [postV1SearchSocialsRoblox](#postv1searchsocialsroblox) - Roblox Search
|
|
27
|
-
* [postV1SearchSocialsTiktok](#postv1searchsocialstiktok) - TikTok Search
|
|
28
|
-
* [postV1SearchInfrastructureIpinfo](#postv1searchinfrastructureipinfo) - IP Info
|
|
29
|
-
* [postV1SearchInfrastructureDns](#postv1searchinfrastructuredns) - DNS Reconnaissance
|
|
30
|
-
* [postV1SearchInfrastructureShodan](#postv1searchinfrastructureshodan) - Shodan Search
|
|
31
|
-
* [postV1SearchInfrastructureWhois](#postv1searchinfrastructurewhois) - Whois
|
|
32
|
-
* [postV1SearchInfrastructurePortscan](#postv1searchinfrastructureportscan) - Port Scan
|
|
33
|
-
* [postV1SearchInfrastructureCertificates](#postv1searchinfrastructurecertificates) - Certificate Lookup
|
|
34
|
-
* [postV1ToolsDoogle](#postv1toolsdoogle) - Discord Alt Lookup
|
|
35
|
-
* [postV1ToolsDoublecounter](#postv1toolsdoublecounter) - Bypass Double Counter URL
|
|
36
|
-
* [postV1ToolsIntelx](#postv1toolsintelx) - Download IntelX file
|
|
37
|
-
* [getV1Organizations](#getv1organizations) - List organizations the authenticated user belongs to.
|
|
38
|
-
* [getV1OrganizationsById](#getv1organizationsbyid) - Get details for a specific organization you are a member of.
|
|
39
|
-
* [getV1OrganizationsByIdMembers](#getv1organizationsbyidmembers) - List members of an organization you belong to.
|
|
40
|
-
* [getV1OrganizationsByIdAuditLog](#getv1organizationsbyidauditlog) - Get the audit log for an organization. Requires owner or admin role.
|
|
41
|
-
* [getV1OrganizationsByIdCases](#getv1organizationsbyidcases) - List cases shared with an organization (filtered by your visibility settings).
|
|
42
|
-
* [postV1OrganizationsByIdCredits](#postv1organizationsbyidcredits) - Send credits from your balance to one or more organization members. Requires owner or admin role.
|
|
43
|
-
* [postV2SearchSocialsUsername](#postv2searchsocialsusername) - Username Search V2
|
|
44
|
-
|
|
45
|
-
## getV1Info
|
|
46
|
-
|
|
47
|
-
Get information about the user, also healthcheck endpoint.
|
|
48
|
-
|
|
49
|
-
### Example Usage
|
|
50
|
-
|
|
51
|
-
<!-- UsageSnippet language="typescript" operationID="getV1Info" method="get" path="/v1/info" -->
|
|
52
|
-
```typescript
|
|
53
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
54
|
-
|
|
55
|
-
const indicia = new Indicia({
|
|
56
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
57
|
-
});
|
|
58
|
-
|
|
59
|
-
async function run() {
|
|
60
|
-
const result = await indicia.getV1Info();
|
|
61
|
-
|
|
62
|
-
console.log(result);
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
run();
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
### Standalone function
|
|
69
|
-
|
|
70
|
-
The standalone function version of this method:
|
|
71
|
-
|
|
72
|
-
```typescript
|
|
73
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
74
|
-
import { getV1Info } from "@indiciaosint/sdk/funcs/get-v1-info.js";
|
|
75
|
-
|
|
76
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
77
|
-
// You can create one instance of it to use across an application.
|
|
78
|
-
const indicia = new IndiciaCore({
|
|
79
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
80
|
-
});
|
|
81
|
-
|
|
82
|
-
async function run() {
|
|
83
|
-
const res = await getV1Info(indicia);
|
|
84
|
-
if (res.ok) {
|
|
85
|
-
const { value: result } = res;
|
|
86
|
-
console.log(result);
|
|
87
|
-
} else {
|
|
88
|
-
console.log("getV1Info failed:", res.error);
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
run();
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### Parameters
|
|
96
|
-
|
|
97
|
-
| Parameter | Type | Required | Description |
|
|
98
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
99
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
100
|
-
| `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. |
|
|
101
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
102
|
-
|
|
103
|
-
### Response
|
|
104
|
-
|
|
105
|
-
**Promise\<[operations.GetV1InfoResponse](../../models/operations/get-v1-info-response.md)\>**
|
|
106
|
-
|
|
107
|
-
### Errors
|
|
108
|
-
|
|
109
|
-
| Error Type | Status Code | Content Type |
|
|
110
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
111
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
112
|
-
|
|
113
|
-
## getV1Pricing
|
|
114
|
-
|
|
115
|
-
Gives credit pricing for all Indicia services
|
|
116
|
-
|
|
117
|
-
### Example Usage
|
|
118
|
-
|
|
119
|
-
<!-- UsageSnippet language="typescript" operationID="getV1Pricing" method="get" path="/v1/pricing" -->
|
|
120
|
-
```typescript
|
|
121
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
122
|
-
|
|
123
|
-
const indicia = new Indicia({
|
|
124
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
async function run() {
|
|
128
|
-
const result = await indicia.getV1Pricing();
|
|
129
|
-
|
|
130
|
-
console.log(result);
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
run();
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Standalone function
|
|
137
|
-
|
|
138
|
-
The standalone function version of this method:
|
|
139
|
-
|
|
140
|
-
```typescript
|
|
141
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
142
|
-
import { getV1Pricing } from "@indiciaosint/sdk/funcs/get-v1-pricing.js";
|
|
143
|
-
|
|
144
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
145
|
-
// You can create one instance of it to use across an application.
|
|
146
|
-
const indicia = new IndiciaCore({
|
|
147
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
148
|
-
});
|
|
149
|
-
|
|
150
|
-
async function run() {
|
|
151
|
-
const res = await getV1Pricing(indicia);
|
|
152
|
-
if (res.ok) {
|
|
153
|
-
const { value: result } = res;
|
|
154
|
-
console.log(result);
|
|
155
|
-
} else {
|
|
156
|
-
console.log("getV1Pricing failed:", res.error);
|
|
157
|
-
}
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
run();
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
### Parameters
|
|
164
|
-
|
|
165
|
-
| Parameter | Type | Required | Description |
|
|
166
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
167
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
168
|
-
| `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. |
|
|
169
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
170
|
-
|
|
171
|
-
### Response
|
|
172
|
-
|
|
173
|
-
**Promise\<[operations.GetV1PricingResponse](../../models/operations/get-v1-pricing-response.md)\>**
|
|
174
|
-
|
|
175
|
-
### Errors
|
|
176
|
-
|
|
177
|
-
| Error Type | Status Code | Content Type |
|
|
178
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
179
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
180
|
-
|
|
181
|
-
## getV1Activity
|
|
182
|
-
|
|
183
|
-
Get a list of recent activities.
|
|
184
|
-
|
|
185
|
-
### Example Usage
|
|
186
|
-
|
|
187
|
-
<!-- UsageSnippet language="typescript" operationID="getV1Activity" method="get" path="/v1/activity" -->
|
|
188
|
-
```typescript
|
|
189
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
190
|
-
|
|
191
|
-
const indicia = new Indicia({
|
|
192
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
193
|
-
});
|
|
194
|
-
|
|
195
|
-
async function run() {
|
|
196
|
-
const result = await indicia.getV1Activity();
|
|
197
|
-
|
|
198
|
-
console.log(result);
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
run();
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
### Standalone function
|
|
205
|
-
|
|
206
|
-
The standalone function version of this method:
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
210
|
-
import { getV1Activity } from "@indiciaosint/sdk/funcs/get-v1-activity.js";
|
|
211
|
-
|
|
212
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
213
|
-
// You can create one instance of it to use across an application.
|
|
214
|
-
const indicia = new IndiciaCore({
|
|
215
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
216
|
-
});
|
|
217
|
-
|
|
218
|
-
async function run() {
|
|
219
|
-
const res = await getV1Activity(indicia);
|
|
220
|
-
if (res.ok) {
|
|
221
|
-
const { value: result } = res;
|
|
222
|
-
console.log(result);
|
|
223
|
-
} else {
|
|
224
|
-
console.log("getV1Activity failed:", res.error);
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
run();
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
### Parameters
|
|
232
|
-
|
|
233
|
-
| Parameter | Type | Required | Description |
|
|
234
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
235
|
-
| `request` | [operations.GetV1ActivityRequest](../../models/operations/get-v1-activity-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
236
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
237
|
-
| `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. |
|
|
238
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
239
|
-
|
|
240
|
-
### Response
|
|
241
|
-
|
|
242
|
-
**Promise\<[operations.GetV1ActivityResponse](../../models/operations/get-v1-activity-response.md)\>**
|
|
243
|
-
|
|
244
|
-
### Errors
|
|
245
|
-
|
|
246
|
-
| Error Type | Status Code | Content Type |
|
|
247
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
248
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
249
|
-
|
|
250
|
-
## getV1ActivityById
|
|
251
|
-
|
|
252
|
-
Get a specific activity by its ID.
|
|
253
|
-
|
|
254
|
-
### Example Usage
|
|
255
|
-
|
|
256
|
-
<!-- UsageSnippet language="typescript" operationID="getV1ActivityById" method="get" path="/v1/activity/{id}" -->
|
|
257
|
-
```typescript
|
|
258
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
259
|
-
|
|
260
|
-
const indicia = new Indicia({
|
|
261
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
262
|
-
});
|
|
263
|
-
|
|
264
|
-
async function run() {
|
|
265
|
-
const result = await indicia.getV1ActivityById({
|
|
266
|
-
id: "77c381f8-9655-45e5-85dc-2b3fedd35d7a",
|
|
267
|
-
});
|
|
268
|
-
|
|
269
|
-
console.log(result);
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
run();
|
|
273
|
-
```
|
|
274
|
-
|
|
275
|
-
### Standalone function
|
|
276
|
-
|
|
277
|
-
The standalone function version of this method:
|
|
278
|
-
|
|
279
|
-
```typescript
|
|
280
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
281
|
-
import { getV1ActivityById } from "@indiciaosint/sdk/funcs/get-v1-activity-by-id.js";
|
|
282
|
-
|
|
283
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
284
|
-
// You can create one instance of it to use across an application.
|
|
285
|
-
const indicia = new IndiciaCore({
|
|
286
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
287
|
-
});
|
|
288
|
-
|
|
289
|
-
async function run() {
|
|
290
|
-
const res = await getV1ActivityById(indicia, {
|
|
291
|
-
id: "77c381f8-9655-45e5-85dc-2b3fedd35d7a",
|
|
292
|
-
});
|
|
293
|
-
if (res.ok) {
|
|
294
|
-
const { value: result } = res;
|
|
295
|
-
console.log(result);
|
|
296
|
-
} else {
|
|
297
|
-
console.log("getV1ActivityById failed:", res.error);
|
|
298
|
-
}
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
run();
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
### Parameters
|
|
305
|
-
|
|
306
|
-
| Parameter | Type | Required | Description |
|
|
307
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
308
|
-
| `request` | [operations.GetV1ActivityByIdRequest](../../models/operations/get-v1-activity-by-id-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
309
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
310
|
-
| `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. |
|
|
311
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
312
|
-
|
|
313
|
-
### Response
|
|
314
|
-
|
|
315
|
-
**Promise\<[operations.GetV1ActivityByIdResponse](../../models/operations/get-v1-activity-by-id-response.md)\>**
|
|
316
|
-
|
|
317
|
-
### Errors
|
|
318
|
-
|
|
319
|
-
| Error Type | Status Code | Content Type |
|
|
320
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
321
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
322
|
-
|
|
323
|
-
## deleteV1ActivityById
|
|
324
|
-
|
|
325
|
-
Delete a specific activity by its ID.
|
|
326
|
-
|
|
327
|
-
### Example Usage
|
|
328
|
-
|
|
329
|
-
<!-- UsageSnippet language="typescript" operationID="deleteV1ActivityById" method="delete" path="/v1/activity/{id}" -->
|
|
330
|
-
```typescript
|
|
331
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
332
|
-
|
|
333
|
-
const indicia = new Indicia({
|
|
334
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
335
|
-
});
|
|
336
|
-
|
|
337
|
-
async function run() {
|
|
338
|
-
await indicia.deleteV1ActivityById({
|
|
339
|
-
id: "78462496-5bed-45a5-94e4-0f24527a6734",
|
|
340
|
-
});
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
}
|
|
344
|
-
|
|
345
|
-
run();
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
### Standalone function
|
|
349
|
-
|
|
350
|
-
The standalone function version of this method:
|
|
351
|
-
|
|
352
|
-
```typescript
|
|
353
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
354
|
-
import { deleteV1ActivityById } from "@indiciaosint/sdk/funcs/delete-v1-activity-by-id.js";
|
|
355
|
-
|
|
356
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
357
|
-
// You can create one instance of it to use across an application.
|
|
358
|
-
const indicia = new IndiciaCore({
|
|
359
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
360
|
-
});
|
|
361
|
-
|
|
362
|
-
async function run() {
|
|
363
|
-
const res = await deleteV1ActivityById(indicia, {
|
|
364
|
-
id: "78462496-5bed-45a5-94e4-0f24527a6734",
|
|
365
|
-
});
|
|
366
|
-
if (res.ok) {
|
|
367
|
-
const { value: result } = res;
|
|
368
|
-
|
|
369
|
-
} else {
|
|
370
|
-
console.log("deleteV1ActivityById failed:", res.error);
|
|
371
|
-
}
|
|
372
|
-
}
|
|
373
|
-
|
|
374
|
-
run();
|
|
375
|
-
```
|
|
376
|
-
|
|
377
|
-
### Parameters
|
|
378
|
-
|
|
379
|
-
| Parameter | Type | Required | Description |
|
|
380
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
381
|
-
| `request` | [operations.DeleteV1ActivityByIdRequest](../../models/operations/delete-v1-activity-by-id-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
382
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
383
|
-
| `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. |
|
|
384
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
385
|
-
|
|
386
|
-
### Response
|
|
387
|
-
|
|
388
|
-
**Promise\<void\>**
|
|
389
|
-
|
|
390
|
-
### Errors
|
|
391
|
-
|
|
392
|
-
| Error Type | Status Code | Content Type |
|
|
393
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
394
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
395
|
-
|
|
396
|
-
## postV1SearchIntelligenceAddress
|
|
397
|
-
|
|
398
|
-
Address Search (US Only)
|
|
399
|
-
|
|
400
|
-
### Example Usage
|
|
401
|
-
|
|
402
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceAddress" method="post" path="/v1/search/intelligence/address" -->
|
|
403
|
-
```typescript
|
|
404
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
405
|
-
|
|
406
|
-
const indicia = new Indicia({
|
|
407
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
408
|
-
});
|
|
409
|
-
|
|
410
|
-
async function run() {
|
|
411
|
-
const result = await indicia.postV1SearchIntelligenceAddress({
|
|
412
|
-
address1: "<value>",
|
|
413
|
-
city: "El Monte",
|
|
414
|
-
state: "New York",
|
|
415
|
-
zip: "85601",
|
|
416
|
-
});
|
|
417
|
-
|
|
418
|
-
console.log(result);
|
|
419
|
-
}
|
|
420
|
-
|
|
421
|
-
run();
|
|
422
|
-
```
|
|
423
|
-
|
|
424
|
-
### Standalone function
|
|
425
|
-
|
|
426
|
-
The standalone function version of this method:
|
|
427
|
-
|
|
428
|
-
```typescript
|
|
429
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
430
|
-
import { postV1SearchIntelligenceAddress } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-address.js";
|
|
431
|
-
|
|
432
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
433
|
-
// You can create one instance of it to use across an application.
|
|
434
|
-
const indicia = new IndiciaCore({
|
|
435
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
436
|
-
});
|
|
437
|
-
|
|
438
|
-
async function run() {
|
|
439
|
-
const res = await postV1SearchIntelligenceAddress(indicia, {
|
|
440
|
-
address1: "<value>",
|
|
441
|
-
city: "El Monte",
|
|
442
|
-
state: "New York",
|
|
443
|
-
zip: "85601",
|
|
444
|
-
});
|
|
445
|
-
if (res.ok) {
|
|
446
|
-
const { value: result } = res;
|
|
447
|
-
console.log(result);
|
|
448
|
-
} else {
|
|
449
|
-
console.log("postV1SearchIntelligenceAddress failed:", res.error);
|
|
450
|
-
}
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
run();
|
|
454
|
-
```
|
|
455
|
-
|
|
456
|
-
### Parameters
|
|
457
|
-
|
|
458
|
-
| Parameter | Type | Required | Description |
|
|
459
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
460
|
-
| `request` | [operations.PostV1SearchIntelligenceAddressRequest](../../models/operations/post-v1-search-intelligence-address-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
461
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
462
|
-
| `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. |
|
|
463
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
464
|
-
|
|
465
|
-
### Response
|
|
466
|
-
|
|
467
|
-
**Promise\<[operations.PostV1SearchIntelligenceAddressResponse](../../models/operations/post-v1-search-intelligence-address-response.md)\>**
|
|
468
|
-
|
|
469
|
-
### Errors
|
|
470
|
-
|
|
471
|
-
| Error Type | Status Code | Content Type |
|
|
472
|
-
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
|
473
|
-
| errors.PostV1SearchIntelligenceAddressInternalServerError | 500 | application/json |
|
|
474
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
475
|
-
|
|
476
|
-
## postV1SearchIntelligenceEmail
|
|
477
|
-
|
|
478
|
-
Search for individuals by email address.
|
|
479
|
-
|
|
480
|
-
### Example Usage
|
|
481
|
-
|
|
482
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceEmail" method="post" path="/v1/search/intelligence/email" -->
|
|
483
|
-
```typescript
|
|
484
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
485
|
-
|
|
486
|
-
const indicia = new Indicia({
|
|
487
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
488
|
-
});
|
|
489
|
-
|
|
490
|
-
async function run() {
|
|
491
|
-
const result = await indicia.postV1SearchIntelligenceEmail({
|
|
492
|
-
query: "Rafaela_Carroll96@gmail.com",
|
|
493
|
-
});
|
|
494
|
-
|
|
495
|
-
console.log(result);
|
|
496
|
-
}
|
|
497
|
-
|
|
498
|
-
run();
|
|
499
|
-
```
|
|
500
|
-
|
|
501
|
-
### Standalone function
|
|
502
|
-
|
|
503
|
-
The standalone function version of this method:
|
|
504
|
-
|
|
505
|
-
```typescript
|
|
506
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
507
|
-
import { postV1SearchIntelligenceEmail } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-email.js";
|
|
508
|
-
|
|
509
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
510
|
-
// You can create one instance of it to use across an application.
|
|
511
|
-
const indicia = new IndiciaCore({
|
|
512
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
513
|
-
});
|
|
514
|
-
|
|
515
|
-
async function run() {
|
|
516
|
-
const res = await postV1SearchIntelligenceEmail(indicia, {
|
|
517
|
-
query: "Rafaela_Carroll96@gmail.com",
|
|
518
|
-
});
|
|
519
|
-
if (res.ok) {
|
|
520
|
-
const { value: result } = res;
|
|
521
|
-
console.log(result);
|
|
522
|
-
} else {
|
|
523
|
-
console.log("postV1SearchIntelligenceEmail failed:", res.error);
|
|
524
|
-
}
|
|
525
|
-
}
|
|
526
|
-
|
|
527
|
-
run();
|
|
528
|
-
```
|
|
529
|
-
|
|
530
|
-
### Parameters
|
|
531
|
-
|
|
532
|
-
| Parameter | Type | Required | Description |
|
|
533
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
534
|
-
| `request` | [operations.PostV1SearchIntelligenceEmailRequest](../../models/operations/post-v1-search-intelligence-email-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
535
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
536
|
-
| `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. |
|
|
537
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
538
|
-
|
|
539
|
-
### Response
|
|
540
|
-
|
|
541
|
-
**Promise\<[operations.PostV1SearchIntelligenceEmailResponse](../../models/operations/post-v1-search-intelligence-email-response.md)\>**
|
|
542
|
-
|
|
543
|
-
### Errors
|
|
544
|
-
|
|
545
|
-
| Error Type | Status Code | Content Type |
|
|
546
|
-
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
547
|
-
| errors.PostV1SearchIntelligenceEmailInternalServerError | 500 | application/json |
|
|
548
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
549
|
-
|
|
550
|
-
## postV1SearchIntelligenceGeolocation
|
|
551
|
-
|
|
552
|
-
Geolocate an image or video using AI-powered analysis. Streams progress updates via Server-Sent Events.
|
|
553
|
-
|
|
554
|
-
Response type:
|
|
555
|
-
```ts
|
|
556
|
-
interface GeolocationResponse {
|
|
557
|
-
location: string | null;
|
|
558
|
-
coordinates: string | null;
|
|
559
|
-
certainty: string;
|
|
560
|
-
reasoning: string;
|
|
561
|
-
mapsUrl?: `https://www.google.com/maps/search/?api=1&query=${string}`;
|
|
562
|
-
}
|
|
563
|
-
```
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
### Example Usage: analyzing
|
|
567
|
-
|
|
568
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceGeolocation" method="post" path="/v1/search/intelligence/geolocation" example="analyzing" -->
|
|
569
|
-
```typescript
|
|
570
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
571
|
-
|
|
572
|
-
const indicia = new Indicia({
|
|
573
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
574
|
-
});
|
|
575
|
-
|
|
576
|
-
async function run() {
|
|
577
|
-
const result = await indicia.postV1SearchIntelligenceGeolocation({
|
|
578
|
-
media: "<value>",
|
|
579
|
-
});
|
|
580
|
-
|
|
581
|
-
console.log(result);
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
run();
|
|
585
|
-
```
|
|
586
|
-
|
|
587
|
-
### Standalone function
|
|
588
|
-
|
|
589
|
-
The standalone function version of this method:
|
|
590
|
-
|
|
591
|
-
```typescript
|
|
592
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
593
|
-
import { postV1SearchIntelligenceGeolocation } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-geolocation.js";
|
|
594
|
-
|
|
595
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
596
|
-
// You can create one instance of it to use across an application.
|
|
597
|
-
const indicia = new IndiciaCore({
|
|
598
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
599
|
-
});
|
|
600
|
-
|
|
601
|
-
async function run() {
|
|
602
|
-
const res = await postV1SearchIntelligenceGeolocation(indicia, {
|
|
603
|
-
media: "<value>",
|
|
604
|
-
});
|
|
605
|
-
if (res.ok) {
|
|
606
|
-
const { value: result } = res;
|
|
607
|
-
console.log(result);
|
|
608
|
-
} else {
|
|
609
|
-
console.log("postV1SearchIntelligenceGeolocation failed:", res.error);
|
|
610
|
-
}
|
|
611
|
-
}
|
|
612
|
-
|
|
613
|
-
run();
|
|
614
|
-
```
|
|
615
|
-
### Example Usage: complete
|
|
616
|
-
|
|
617
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceGeolocation" method="post" path="/v1/search/intelligence/geolocation" example="complete" -->
|
|
618
|
-
```typescript
|
|
619
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
620
|
-
|
|
621
|
-
const indicia = new Indicia({
|
|
622
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
623
|
-
});
|
|
624
|
-
|
|
625
|
-
async function run() {
|
|
626
|
-
const result = await indicia.postV1SearchIntelligenceGeolocation({
|
|
627
|
-
media: "<value>",
|
|
628
|
-
});
|
|
629
|
-
|
|
630
|
-
console.log(result);
|
|
631
|
-
}
|
|
632
|
-
|
|
633
|
-
run();
|
|
634
|
-
```
|
|
635
|
-
|
|
636
|
-
### Standalone function
|
|
637
|
-
|
|
638
|
-
The standalone function version of this method:
|
|
639
|
-
|
|
640
|
-
```typescript
|
|
641
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
642
|
-
import { postV1SearchIntelligenceGeolocation } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-geolocation.js";
|
|
643
|
-
|
|
644
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
645
|
-
// You can create one instance of it to use across an application.
|
|
646
|
-
const indicia = new IndiciaCore({
|
|
647
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
648
|
-
});
|
|
649
|
-
|
|
650
|
-
async function run() {
|
|
651
|
-
const res = await postV1SearchIntelligenceGeolocation(indicia, {
|
|
652
|
-
media: "<value>",
|
|
653
|
-
});
|
|
654
|
-
if (res.ok) {
|
|
655
|
-
const { value: result } = res;
|
|
656
|
-
console.log(result);
|
|
657
|
-
} else {
|
|
658
|
-
console.log("postV1SearchIntelligenceGeolocation failed:", res.error);
|
|
659
|
-
}
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
run();
|
|
663
|
-
```
|
|
664
|
-
### Example Usage: error
|
|
665
|
-
|
|
666
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceGeolocation" method="post" path="/v1/search/intelligence/geolocation" example="error" -->
|
|
667
|
-
```typescript
|
|
668
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
669
|
-
|
|
670
|
-
const indicia = new Indicia({
|
|
671
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
672
|
-
});
|
|
673
|
-
|
|
674
|
-
async function run() {
|
|
675
|
-
const result = await indicia.postV1SearchIntelligenceGeolocation({
|
|
676
|
-
media: "<value>",
|
|
677
|
-
});
|
|
678
|
-
|
|
679
|
-
console.log(result);
|
|
680
|
-
}
|
|
681
|
-
|
|
682
|
-
run();
|
|
683
|
-
```
|
|
684
|
-
|
|
685
|
-
### Standalone function
|
|
686
|
-
|
|
687
|
-
The standalone function version of this method:
|
|
688
|
-
|
|
689
|
-
```typescript
|
|
690
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
691
|
-
import { postV1SearchIntelligenceGeolocation } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-geolocation.js";
|
|
692
|
-
|
|
693
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
694
|
-
// You can create one instance of it to use across an application.
|
|
695
|
-
const indicia = new IndiciaCore({
|
|
696
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
697
|
-
});
|
|
698
|
-
|
|
699
|
-
async function run() {
|
|
700
|
-
const res = await postV1SearchIntelligenceGeolocation(indicia, {
|
|
701
|
-
media: "<value>",
|
|
702
|
-
});
|
|
703
|
-
if (res.ok) {
|
|
704
|
-
const { value: result } = res;
|
|
705
|
-
console.log(result);
|
|
706
|
-
} else {
|
|
707
|
-
console.log("postV1SearchIntelligenceGeolocation failed:", res.error);
|
|
708
|
-
}
|
|
709
|
-
}
|
|
710
|
-
|
|
711
|
-
run();
|
|
712
|
-
```
|
|
713
|
-
|
|
714
|
-
### Parameters
|
|
715
|
-
|
|
716
|
-
| Parameter | Type | Required | Description |
|
|
717
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
718
|
-
| `request` | [operations.PostV1SearchIntelligenceGeolocationRequest](../../models/operations/post-v1-search-intelligence-geolocation-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
719
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
720
|
-
| `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. |
|
|
721
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
722
|
-
|
|
723
|
-
### Response
|
|
724
|
-
|
|
725
|
-
**Promise\<[string](../../models/.md)\>**
|
|
726
|
-
|
|
727
|
-
### Errors
|
|
728
|
-
|
|
729
|
-
| Error Type | Status Code | Content Type |
|
|
730
|
-
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
731
|
-
| errors.PostV1SearchIntelligenceGeolocationBadRequestError | 400 | application/json |
|
|
732
|
-
| errors.PostV1SearchIntelligenceGeolocationPaymentRequiredError | 402 | application/json |
|
|
733
|
-
| errors.PostV1SearchIntelligenceGeolocationInternalServerError | 500 | application/json |
|
|
734
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
735
|
-
|
|
736
|
-
## postV1SearchIntelligenceGmail
|
|
737
|
-
|
|
738
|
-
Fetches Gmail account information based on the provided email address using the Ghunt library.
|
|
739
|
-
|
|
740
|
-
### Example Usage
|
|
741
|
-
|
|
742
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceGmail" method="post" path="/v1/search/intelligence/gmail" -->
|
|
743
|
-
```typescript
|
|
744
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
745
|
-
|
|
746
|
-
const indicia = new Indicia({
|
|
747
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
748
|
-
});
|
|
749
|
-
|
|
750
|
-
async function run() {
|
|
751
|
-
const result = await indicia.postV1SearchIntelligenceGmail({
|
|
752
|
-
email: "Ellie40@yahoo.com",
|
|
753
|
-
});
|
|
754
|
-
|
|
755
|
-
console.log(result);
|
|
756
|
-
}
|
|
757
|
-
|
|
758
|
-
run();
|
|
759
|
-
```
|
|
760
|
-
|
|
761
|
-
### Standalone function
|
|
762
|
-
|
|
763
|
-
The standalone function version of this method:
|
|
764
|
-
|
|
765
|
-
```typescript
|
|
766
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
767
|
-
import { postV1SearchIntelligenceGmail } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-gmail.js";
|
|
768
|
-
|
|
769
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
770
|
-
// You can create one instance of it to use across an application.
|
|
771
|
-
const indicia = new IndiciaCore({
|
|
772
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
773
|
-
});
|
|
774
|
-
|
|
775
|
-
async function run() {
|
|
776
|
-
const res = await postV1SearchIntelligenceGmail(indicia, {
|
|
777
|
-
email: "Ellie40@yahoo.com",
|
|
778
|
-
});
|
|
779
|
-
if (res.ok) {
|
|
780
|
-
const { value: result } = res;
|
|
781
|
-
console.log(result);
|
|
782
|
-
} else {
|
|
783
|
-
console.log("postV1SearchIntelligenceGmail failed:", res.error);
|
|
784
|
-
}
|
|
785
|
-
}
|
|
786
|
-
|
|
787
|
-
run();
|
|
788
|
-
```
|
|
789
|
-
|
|
790
|
-
### Parameters
|
|
791
|
-
|
|
792
|
-
| Parameter | Type | Required | Description |
|
|
793
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
794
|
-
| `request` | [operations.PostV1SearchIntelligenceGmailRequest](../../models/operations/post-v1-search-intelligence-gmail-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
795
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
796
|
-
| `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. |
|
|
797
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
798
|
-
|
|
799
|
-
### Response
|
|
800
|
-
|
|
801
|
-
**Promise\<[operations.PostV1SearchIntelligenceGmailResponse](../../models/operations/post-v1-search-intelligence-gmail-response.md)\>**
|
|
802
|
-
|
|
803
|
-
### Errors
|
|
804
|
-
|
|
805
|
-
| Error Type | Status Code | Content Type |
|
|
806
|
-
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
807
|
-
| errors.PostV1SearchIntelligenceGmailInternalServerError | 500 | application/json |
|
|
808
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
809
|
-
|
|
810
|
-
## postV1SearchIntelligencePerson
|
|
811
|
-
|
|
812
|
-
Search for individuals by name and state.
|
|
813
|
-
|
|
814
|
-
### Example Usage
|
|
815
|
-
|
|
816
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligencePerson" method="post" path="/v1/search/intelligence/person" -->
|
|
817
|
-
```typescript
|
|
818
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
819
|
-
|
|
820
|
-
const indicia = new Indicia({
|
|
821
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
822
|
-
});
|
|
823
|
-
|
|
824
|
-
async function run() {
|
|
825
|
-
const result = await indicia.postV1SearchIntelligencePerson({
|
|
826
|
-
name: "<value>",
|
|
827
|
-
});
|
|
828
|
-
|
|
829
|
-
console.log(result);
|
|
830
|
-
}
|
|
831
|
-
|
|
832
|
-
run();
|
|
833
|
-
```
|
|
834
|
-
|
|
835
|
-
### Standalone function
|
|
836
|
-
|
|
837
|
-
The standalone function version of this method:
|
|
838
|
-
|
|
839
|
-
```typescript
|
|
840
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
841
|
-
import { postV1SearchIntelligencePerson } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-person.js";
|
|
842
|
-
|
|
843
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
844
|
-
// You can create one instance of it to use across an application.
|
|
845
|
-
const indicia = new IndiciaCore({
|
|
846
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
847
|
-
});
|
|
848
|
-
|
|
849
|
-
async function run() {
|
|
850
|
-
const res = await postV1SearchIntelligencePerson(indicia, {
|
|
851
|
-
name: "<value>",
|
|
852
|
-
});
|
|
853
|
-
if (res.ok) {
|
|
854
|
-
const { value: result } = res;
|
|
855
|
-
console.log(result);
|
|
856
|
-
} else {
|
|
857
|
-
console.log("postV1SearchIntelligencePerson failed:", res.error);
|
|
858
|
-
}
|
|
859
|
-
}
|
|
860
|
-
|
|
861
|
-
run();
|
|
862
|
-
```
|
|
863
|
-
|
|
864
|
-
### Parameters
|
|
865
|
-
|
|
866
|
-
| Parameter | Type | Required | Description |
|
|
867
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
868
|
-
| `request` | [operations.PostV1SearchIntelligencePersonRequest](../../models/operations/post-v1-search-intelligence-person-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
869
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
870
|
-
| `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. |
|
|
871
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
872
|
-
|
|
873
|
-
### Response
|
|
874
|
-
|
|
875
|
-
**Promise\<[operations.PostV1SearchIntelligencePersonResponse](../../models/operations/post-v1-search-intelligence-person-response.md)\>**
|
|
876
|
-
|
|
877
|
-
### Errors
|
|
878
|
-
|
|
879
|
-
| Error Type | Status Code | Content Type |
|
|
880
|
-
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
|
881
|
-
| errors.PostV1SearchIntelligencePersonInternalServerError | 500 | application/json |
|
|
882
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
883
|
-
|
|
884
|
-
## postV1SearchIntelligencePhone
|
|
885
|
-
|
|
886
|
-
Search for individuals by phone number.
|
|
887
|
-
|
|
888
|
-
### Example Usage
|
|
889
|
-
|
|
890
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligencePhone" method="post" path="/v1/search/intelligence/phone" -->
|
|
891
|
-
```typescript
|
|
892
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
893
|
-
|
|
894
|
-
const indicia = new Indicia({
|
|
895
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
896
|
-
});
|
|
897
|
-
|
|
898
|
-
async function run() {
|
|
899
|
-
const result = await indicia.postV1SearchIntelligencePhone({
|
|
900
|
-
query: "<value>",
|
|
901
|
-
});
|
|
902
|
-
|
|
903
|
-
console.log(result);
|
|
904
|
-
}
|
|
905
|
-
|
|
906
|
-
run();
|
|
907
|
-
```
|
|
908
|
-
|
|
909
|
-
### Standalone function
|
|
910
|
-
|
|
911
|
-
The standalone function version of this method:
|
|
912
|
-
|
|
913
|
-
```typescript
|
|
914
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
915
|
-
import { postV1SearchIntelligencePhone } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-phone.js";
|
|
916
|
-
|
|
917
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
918
|
-
// You can create one instance of it to use across an application.
|
|
919
|
-
const indicia = new IndiciaCore({
|
|
920
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
921
|
-
});
|
|
922
|
-
|
|
923
|
-
async function run() {
|
|
924
|
-
const res = await postV1SearchIntelligencePhone(indicia, {
|
|
925
|
-
query: "<value>",
|
|
926
|
-
});
|
|
927
|
-
if (res.ok) {
|
|
928
|
-
const { value: result } = res;
|
|
929
|
-
console.log(result);
|
|
930
|
-
} else {
|
|
931
|
-
console.log("postV1SearchIntelligencePhone failed:", res.error);
|
|
932
|
-
}
|
|
933
|
-
}
|
|
934
|
-
|
|
935
|
-
run();
|
|
936
|
-
```
|
|
937
|
-
|
|
938
|
-
### Parameters
|
|
939
|
-
|
|
940
|
-
| Parameter | Type | Required | Description |
|
|
941
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
942
|
-
| `request` | [operations.PostV1SearchIntelligencePhoneRequest](../../models/operations/post-v1-search-intelligence-phone-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
943
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
944
|
-
| `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. |
|
|
945
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
946
|
-
|
|
947
|
-
### Response
|
|
948
|
-
|
|
949
|
-
**Promise\<[operations.PostV1SearchIntelligencePhoneResponse](../../models/operations/post-v1-search-intelligence-phone-response.md)\>**
|
|
950
|
-
|
|
951
|
-
### Errors
|
|
952
|
-
|
|
953
|
-
| Error Type | Status Code | Content Type |
|
|
954
|
-
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
955
|
-
| errors.PostV1SearchIntelligencePhoneInternalServerError | 500 | application/json |
|
|
956
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
957
|
-
|
|
958
|
-
## postV1SearchIntelligenceSeon
|
|
959
|
-
|
|
960
|
-
Evaluate potential threats with SEON’s counter fraud intelligence systems.
|
|
961
|
-
|
|
962
|
-
### Example Usage
|
|
963
|
-
|
|
964
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceSeon" method="post" path="/v1/search/intelligence/seon" -->
|
|
965
|
-
```typescript
|
|
966
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
967
|
-
|
|
968
|
-
const indicia = new Indicia({
|
|
969
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
970
|
-
});
|
|
971
|
-
|
|
972
|
-
async function run() {
|
|
973
|
-
const result = await indicia.postV1SearchIntelligenceSeon({
|
|
974
|
-
query: "<value>",
|
|
975
|
-
type: "bin",
|
|
976
|
-
});
|
|
977
|
-
|
|
978
|
-
console.log(result);
|
|
979
|
-
}
|
|
980
|
-
|
|
981
|
-
run();
|
|
982
|
-
```
|
|
983
|
-
|
|
984
|
-
### Standalone function
|
|
985
|
-
|
|
986
|
-
The standalone function version of this method:
|
|
987
|
-
|
|
988
|
-
```typescript
|
|
989
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
990
|
-
import { postV1SearchIntelligenceSeon } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-seon.js";
|
|
991
|
-
|
|
992
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
993
|
-
// You can create one instance of it to use across an application.
|
|
994
|
-
const indicia = new IndiciaCore({
|
|
995
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
996
|
-
});
|
|
997
|
-
|
|
998
|
-
async function run() {
|
|
999
|
-
const res = await postV1SearchIntelligenceSeon(indicia, {
|
|
1000
|
-
query: "<value>",
|
|
1001
|
-
type: "bin",
|
|
1002
|
-
});
|
|
1003
|
-
if (res.ok) {
|
|
1004
|
-
const { value: result } = res;
|
|
1005
|
-
console.log(result);
|
|
1006
|
-
} else {
|
|
1007
|
-
console.log("postV1SearchIntelligenceSeon failed:", res.error);
|
|
1008
|
-
}
|
|
1009
|
-
}
|
|
1010
|
-
|
|
1011
|
-
run();
|
|
1012
|
-
```
|
|
1013
|
-
|
|
1014
|
-
### Parameters
|
|
1015
|
-
|
|
1016
|
-
| Parameter | Type | Required | Description |
|
|
1017
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1018
|
-
| `request` | [operations.PostV1SearchIntelligenceSeonRequest](../../models/operations/post-v1-search-intelligence-seon-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1019
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1020
|
-
| `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. |
|
|
1021
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1022
|
-
|
|
1023
|
-
### Response
|
|
1024
|
-
|
|
1025
|
-
**Promise\<[operations.PostV1SearchIntelligenceSeonResponse](../../models/operations/post-v1-search-intelligence-seon-response.md)\>**
|
|
1026
|
-
|
|
1027
|
-
### Errors
|
|
1028
|
-
|
|
1029
|
-
| Error Type | Status Code | Content Type |
|
|
1030
|
-
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
|
1031
|
-
| errors.PostV1SearchIntelligenceSeonInternalServerError | 500 | application/json |
|
|
1032
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1033
|
-
|
|
1034
|
-
## postV1SearchIntelligenceWebDbs
|
|
1035
|
-
|
|
1036
|
-
Deep web intelligence gathering and comprehensive data breach analysis
|
|
1037
|
-
|
|
1038
|
-
### Example Usage
|
|
1039
|
-
|
|
1040
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceWebDbs" method="post" path="/v1/search/intelligence/web-dbs" -->
|
|
1041
|
-
```typescript
|
|
1042
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1043
|
-
|
|
1044
|
-
const indicia = new Indicia({
|
|
1045
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1046
|
-
});
|
|
1047
|
-
|
|
1048
|
-
async function run() {
|
|
1049
|
-
const result = await indicia.postV1SearchIntelligenceWebDbs({
|
|
1050
|
-
query: "<value>",
|
|
1051
|
-
services: [
|
|
1052
|
-
"snusbase",
|
|
1053
|
-
],
|
|
1054
|
-
});
|
|
1055
|
-
|
|
1056
|
-
console.log(result);
|
|
1057
|
-
}
|
|
1058
|
-
|
|
1059
|
-
run();
|
|
1060
|
-
```
|
|
1061
|
-
|
|
1062
|
-
### Standalone function
|
|
1063
|
-
|
|
1064
|
-
The standalone function version of this method:
|
|
1065
|
-
|
|
1066
|
-
```typescript
|
|
1067
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1068
|
-
import { postV1SearchIntelligenceWebDbs } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-web-dbs.js";
|
|
1069
|
-
|
|
1070
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1071
|
-
// You can create one instance of it to use across an application.
|
|
1072
|
-
const indicia = new IndiciaCore({
|
|
1073
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1074
|
-
});
|
|
1075
|
-
|
|
1076
|
-
async function run() {
|
|
1077
|
-
const res = await postV1SearchIntelligenceWebDbs(indicia, {
|
|
1078
|
-
query: "<value>",
|
|
1079
|
-
services: [
|
|
1080
|
-
"snusbase",
|
|
1081
|
-
],
|
|
1082
|
-
});
|
|
1083
|
-
if (res.ok) {
|
|
1084
|
-
const { value: result } = res;
|
|
1085
|
-
console.log(result);
|
|
1086
|
-
} else {
|
|
1087
|
-
console.log("postV1SearchIntelligenceWebDbs failed:", res.error);
|
|
1088
|
-
}
|
|
1089
|
-
}
|
|
1090
|
-
|
|
1091
|
-
run();
|
|
1092
|
-
```
|
|
1093
|
-
|
|
1094
|
-
### Parameters
|
|
1095
|
-
|
|
1096
|
-
| Parameter | Type | Required | Description |
|
|
1097
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1098
|
-
| `request` | [operations.PostV1SearchIntelligenceWebDbsRequest](../../models/operations/post-v1-search-intelligence-web-dbs-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1099
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1100
|
-
| `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. |
|
|
1101
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1102
|
-
|
|
1103
|
-
### Response
|
|
1104
|
-
|
|
1105
|
-
**Promise\<[operations.PostV1SearchIntelligenceWebDbsResponse](../../models/operations/post-v1-search-intelligence-web-dbs-response.md)\>**
|
|
1106
|
-
|
|
1107
|
-
### Errors
|
|
1108
|
-
|
|
1109
|
-
| Error Type | Status Code | Content Type |
|
|
1110
|
-
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
|
1111
|
-
| errors.PostV1SearchIntelligenceWebDbsPaymentRequiredError | 402 | application/json |
|
|
1112
|
-
| errors.PostV1SearchIntelligenceWebDbsInternalServerError | 500 | application/json |
|
|
1113
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1114
|
-
|
|
1115
|
-
## postV1SearchIntelligenceFacial
|
|
1116
|
-
|
|
1117
|
-
Search for faces across the internet using facial recognition. Streams progress updates via Server-Sent Events.
|
|
1118
|
-
|
|
1119
|
-
Response type:
|
|
1120
|
-
```ts
|
|
1121
|
-
interface FacialSearchResult {
|
|
1122
|
-
time: number;
|
|
1123
|
-
results: {
|
|
1124
|
-
id: string;
|
|
1125
|
-
hash: string;
|
|
1126
|
-
group: number;
|
|
1127
|
-
quality: number;
|
|
1128
|
-
imageUrl: string;
|
|
1129
|
-
crawledAt: number;
|
|
1130
|
-
sourceUrl: string;
|
|
1131
|
-
thumbnailUrl: string;
|
|
1132
|
-
}[];
|
|
1133
|
-
searchHash: string;
|
|
1134
|
-
numberOfResults: number;
|
|
1135
|
-
}
|
|
1136
|
-
```
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
### Example Usage: error
|
|
1140
|
-
|
|
1141
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceFacial" method="post" path="/v1/search/intelligence/facial" example="error" -->
|
|
1142
|
-
```typescript
|
|
1143
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1144
|
-
|
|
1145
|
-
const indicia = new Indicia({
|
|
1146
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1147
|
-
});
|
|
1148
|
-
|
|
1149
|
-
async function run() {
|
|
1150
|
-
const result = await indicia.postV1SearchIntelligenceFacial({
|
|
1151
|
-
media: "<value>",
|
|
1152
|
-
});
|
|
1153
|
-
|
|
1154
|
-
console.log(result);
|
|
1155
|
-
}
|
|
1156
|
-
|
|
1157
|
-
run();
|
|
1158
|
-
```
|
|
1159
|
-
|
|
1160
|
-
### Standalone function
|
|
1161
|
-
|
|
1162
|
-
The standalone function version of this method:
|
|
1163
|
-
|
|
1164
|
-
```typescript
|
|
1165
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1166
|
-
import { postV1SearchIntelligenceFacial } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-facial.js";
|
|
1167
|
-
|
|
1168
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1169
|
-
// You can create one instance of it to use across an application.
|
|
1170
|
-
const indicia = new IndiciaCore({
|
|
1171
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1172
|
-
});
|
|
1173
|
-
|
|
1174
|
-
async function run() {
|
|
1175
|
-
const res = await postV1SearchIntelligenceFacial(indicia, {
|
|
1176
|
-
media: "<value>",
|
|
1177
|
-
});
|
|
1178
|
-
if (res.ok) {
|
|
1179
|
-
const { value: result } = res;
|
|
1180
|
-
console.log(result);
|
|
1181
|
-
} else {
|
|
1182
|
-
console.log("postV1SearchIntelligenceFacial failed:", res.error);
|
|
1183
|
-
}
|
|
1184
|
-
}
|
|
1185
|
-
|
|
1186
|
-
run();
|
|
1187
|
-
```
|
|
1188
|
-
### Example Usage: faces
|
|
1189
|
-
|
|
1190
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceFacial" method="post" path="/v1/search/intelligence/facial" example="faces" -->
|
|
1191
|
-
```typescript
|
|
1192
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1193
|
-
|
|
1194
|
-
const indicia = new Indicia({
|
|
1195
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1196
|
-
});
|
|
1197
|
-
|
|
1198
|
-
async function run() {
|
|
1199
|
-
const result = await indicia.postV1SearchIntelligenceFacial({
|
|
1200
|
-
media: "<value>",
|
|
1201
|
-
});
|
|
1202
|
-
|
|
1203
|
-
console.log(result);
|
|
1204
|
-
}
|
|
1205
|
-
|
|
1206
|
-
run();
|
|
1207
|
-
```
|
|
1208
|
-
|
|
1209
|
-
### Standalone function
|
|
1210
|
-
|
|
1211
|
-
The standalone function version of this method:
|
|
1212
|
-
|
|
1213
|
-
```typescript
|
|
1214
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1215
|
-
import { postV1SearchIntelligenceFacial } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-facial.js";
|
|
1216
|
-
|
|
1217
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1218
|
-
// You can create one instance of it to use across an application.
|
|
1219
|
-
const indicia = new IndiciaCore({
|
|
1220
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1221
|
-
});
|
|
1222
|
-
|
|
1223
|
-
async function run() {
|
|
1224
|
-
const res = await postV1SearchIntelligenceFacial(indicia, {
|
|
1225
|
-
media: "<value>",
|
|
1226
|
-
});
|
|
1227
|
-
if (res.ok) {
|
|
1228
|
-
const { value: result } = res;
|
|
1229
|
-
console.log(result);
|
|
1230
|
-
} else {
|
|
1231
|
-
console.log("postV1SearchIntelligenceFacial failed:", res.error);
|
|
1232
|
-
}
|
|
1233
|
-
}
|
|
1234
|
-
|
|
1235
|
-
run();
|
|
1236
|
-
```
|
|
1237
|
-
|
|
1238
|
-
### Parameters
|
|
1239
|
-
|
|
1240
|
-
| Parameter | Type | Required | Description |
|
|
1241
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1242
|
-
| `request` | [operations.PostV1SearchIntelligenceFacialRequest](../../models/operations/post-v1-search-intelligence-facial-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1243
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1244
|
-
| `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. |
|
|
1245
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1246
|
-
|
|
1247
|
-
### Response
|
|
1248
|
-
|
|
1249
|
-
**Promise\<[string](../../models/.md)\>**
|
|
1250
|
-
|
|
1251
|
-
### Errors
|
|
1252
|
-
|
|
1253
|
-
| Error Type | Status Code | Content Type |
|
|
1254
|
-
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
|
1255
|
-
| errors.PostV1SearchIntelligenceFacialBadRequestError | 400 | application/json |
|
|
1256
|
-
| errors.PostV1SearchIntelligenceFacialPaymentRequiredError | 402 | application/json |
|
|
1257
|
-
| errors.PostV1SearchIntelligenceFacialInternalServerError | 500 | application/json |
|
|
1258
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1259
|
-
|
|
1260
|
-
## postV1SearchIntelligenceHudsonrock
|
|
1261
|
-
|
|
1262
|
-
Search for compromised data on Hudson Rock
|
|
1263
|
-
|
|
1264
|
-
### Example Usage
|
|
1265
|
-
|
|
1266
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchIntelligenceHudsonrock" method="post" path="/v1/search/intelligence/hudsonrock" -->
|
|
1267
|
-
```typescript
|
|
1268
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1269
|
-
|
|
1270
|
-
const indicia = new Indicia({
|
|
1271
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1272
|
-
});
|
|
1273
|
-
|
|
1274
|
-
async function run() {
|
|
1275
|
-
const result = await indicia.postV1SearchIntelligenceHudsonrock({
|
|
1276
|
-
query: "<value>",
|
|
1277
|
-
type: "username",
|
|
1278
|
-
});
|
|
1279
|
-
|
|
1280
|
-
console.log(result);
|
|
1281
|
-
}
|
|
1282
|
-
|
|
1283
|
-
run();
|
|
1284
|
-
```
|
|
1285
|
-
|
|
1286
|
-
### Standalone function
|
|
1287
|
-
|
|
1288
|
-
The standalone function version of this method:
|
|
1289
|
-
|
|
1290
|
-
```typescript
|
|
1291
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1292
|
-
import { postV1SearchIntelligenceHudsonrock } from "@indiciaosint/sdk/funcs/post-v1-search-intelligence-hudsonrock.js";
|
|
1293
|
-
|
|
1294
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1295
|
-
// You can create one instance of it to use across an application.
|
|
1296
|
-
const indicia = new IndiciaCore({
|
|
1297
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1298
|
-
});
|
|
1299
|
-
|
|
1300
|
-
async function run() {
|
|
1301
|
-
const res = await postV1SearchIntelligenceHudsonrock(indicia, {
|
|
1302
|
-
query: "<value>",
|
|
1303
|
-
type: "username",
|
|
1304
|
-
});
|
|
1305
|
-
if (res.ok) {
|
|
1306
|
-
const { value: result } = res;
|
|
1307
|
-
console.log(result);
|
|
1308
|
-
} else {
|
|
1309
|
-
console.log("postV1SearchIntelligenceHudsonrock failed:", res.error);
|
|
1310
|
-
}
|
|
1311
|
-
}
|
|
1312
|
-
|
|
1313
|
-
run();
|
|
1314
|
-
```
|
|
1315
|
-
|
|
1316
|
-
### Parameters
|
|
1317
|
-
|
|
1318
|
-
| Parameter | Type | Required | Description |
|
|
1319
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1320
|
-
| `request` | [operations.PostV1SearchIntelligenceHudsonrockRequest](../../models/operations/post-v1-search-intelligence-hudsonrock-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1321
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1322
|
-
| `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. |
|
|
1323
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1324
|
-
|
|
1325
|
-
### Response
|
|
1326
|
-
|
|
1327
|
-
**Promise\<[operations.PostV1SearchIntelligenceHudsonrockResponse](../../models/operations/post-v1-search-intelligence-hudsonrock-response.md)\>**
|
|
1328
|
-
|
|
1329
|
-
### Errors
|
|
1330
|
-
|
|
1331
|
-
| Error Type | Status Code | Content Type |
|
|
1332
|
-
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
1333
|
-
| errors.PostV1SearchIntelligenceHudsonrockInternalServerError | 500 | application/json |
|
|
1334
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1335
|
-
|
|
1336
|
-
## postV1SearchSocialsDiscord
|
|
1337
|
-
|
|
1338
|
-
Search Discord users for profile and server info
|
|
1339
|
-
|
|
1340
|
-
### Example Usage
|
|
1341
|
-
|
|
1342
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchSocialsDiscord" method="post" path="/v1/search/socials/discord" -->
|
|
1343
|
-
```typescript
|
|
1344
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1345
|
-
|
|
1346
|
-
const indicia = new Indicia({
|
|
1347
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1348
|
-
});
|
|
1349
|
-
|
|
1350
|
-
async function run() {
|
|
1351
|
-
const result = await indicia.postV1SearchSocialsDiscord({
|
|
1352
|
-
query: "<value>",
|
|
1353
|
-
});
|
|
1354
|
-
|
|
1355
|
-
console.log(result);
|
|
1356
|
-
}
|
|
1357
|
-
|
|
1358
|
-
run();
|
|
1359
|
-
```
|
|
1360
|
-
|
|
1361
|
-
### Standalone function
|
|
1362
|
-
|
|
1363
|
-
The standalone function version of this method:
|
|
1364
|
-
|
|
1365
|
-
```typescript
|
|
1366
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1367
|
-
import { postV1SearchSocialsDiscord } from "@indiciaosint/sdk/funcs/post-v1-search-socials-discord.js";
|
|
1368
|
-
|
|
1369
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1370
|
-
// You can create one instance of it to use across an application.
|
|
1371
|
-
const indicia = new IndiciaCore({
|
|
1372
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1373
|
-
});
|
|
1374
|
-
|
|
1375
|
-
async function run() {
|
|
1376
|
-
const res = await postV1SearchSocialsDiscord(indicia, {
|
|
1377
|
-
query: "<value>",
|
|
1378
|
-
});
|
|
1379
|
-
if (res.ok) {
|
|
1380
|
-
const { value: result } = res;
|
|
1381
|
-
console.log(result);
|
|
1382
|
-
} else {
|
|
1383
|
-
console.log("postV1SearchSocialsDiscord failed:", res.error);
|
|
1384
|
-
}
|
|
1385
|
-
}
|
|
1386
|
-
|
|
1387
|
-
run();
|
|
1388
|
-
```
|
|
1389
|
-
|
|
1390
|
-
### Parameters
|
|
1391
|
-
|
|
1392
|
-
| Parameter | Type | Required | Description |
|
|
1393
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1394
|
-
| `request` | [operations.PostV1SearchSocialsDiscordRequest](../../models/operations/post-v1-search-socials-discord-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1395
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1396
|
-
| `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. |
|
|
1397
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1398
|
-
|
|
1399
|
-
### Response
|
|
1400
|
-
|
|
1401
|
-
**Promise\<[operations.PostV1SearchSocialsDiscordResponse](../../models/operations/post-v1-search-socials-discord-response.md)\>**
|
|
1402
|
-
|
|
1403
|
-
### Errors
|
|
1404
|
-
|
|
1405
|
-
| Error Type | Status Code | Content Type |
|
|
1406
|
-
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
|
1407
|
-
| errors.PostV1SearchSocialsDiscordInternalServerError | 500 | application/json |
|
|
1408
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1409
|
-
|
|
1410
|
-
## postV1SearchSocialsGithub
|
|
1411
|
-
|
|
1412
|
-
Search GitHub profiles, info, and commit emails
|
|
1413
|
-
|
|
1414
|
-
### Example Usage
|
|
1415
|
-
|
|
1416
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchSocialsGithub" method="post" path="/v1/search/socials/github" -->
|
|
1417
|
-
```typescript
|
|
1418
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1419
|
-
|
|
1420
|
-
const indicia = new Indicia({
|
|
1421
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1422
|
-
});
|
|
1423
|
-
|
|
1424
|
-
async function run() {
|
|
1425
|
-
const result = await indicia.postV1SearchSocialsGithub({
|
|
1426
|
-
query: "<value>",
|
|
1427
|
-
});
|
|
1428
|
-
|
|
1429
|
-
console.log(result);
|
|
1430
|
-
}
|
|
1431
|
-
|
|
1432
|
-
run();
|
|
1433
|
-
```
|
|
1434
|
-
|
|
1435
|
-
### Standalone function
|
|
1436
|
-
|
|
1437
|
-
The standalone function version of this method:
|
|
1438
|
-
|
|
1439
|
-
```typescript
|
|
1440
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1441
|
-
import { postV1SearchSocialsGithub } from "@indiciaosint/sdk/funcs/post-v1-search-socials-github.js";
|
|
1442
|
-
|
|
1443
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1444
|
-
// You can create one instance of it to use across an application.
|
|
1445
|
-
const indicia = new IndiciaCore({
|
|
1446
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1447
|
-
});
|
|
1448
|
-
|
|
1449
|
-
async function run() {
|
|
1450
|
-
const res = await postV1SearchSocialsGithub(indicia, {
|
|
1451
|
-
query: "<value>",
|
|
1452
|
-
});
|
|
1453
|
-
if (res.ok) {
|
|
1454
|
-
const { value: result } = res;
|
|
1455
|
-
console.log(result);
|
|
1456
|
-
} else {
|
|
1457
|
-
console.log("postV1SearchSocialsGithub failed:", res.error);
|
|
1458
|
-
}
|
|
1459
|
-
}
|
|
1460
|
-
|
|
1461
|
-
run();
|
|
1462
|
-
```
|
|
1463
|
-
|
|
1464
|
-
### Parameters
|
|
1465
|
-
|
|
1466
|
-
| Parameter | Type | Required | Description |
|
|
1467
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1468
|
-
| `request` | [operations.PostV1SearchSocialsGithubRequest](../../models/operations/post-v1-search-socials-github-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1469
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1470
|
-
| `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. |
|
|
1471
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1472
|
-
|
|
1473
|
-
### Response
|
|
1474
|
-
|
|
1475
|
-
**Promise\<[operations.PostV1SearchSocialsGithubResponse](../../models/operations/post-v1-search-socials-github-response.md)\>**
|
|
1476
|
-
|
|
1477
|
-
### Errors
|
|
1478
|
-
|
|
1479
|
-
| Error Type | Status Code | Content Type |
|
|
1480
|
-
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
|
1481
|
-
| errors.PostV1SearchSocialsGithubInternalServerError | 500 | application/json |
|
|
1482
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1483
|
-
|
|
1484
|
-
## postV1SearchSocialsRoblox
|
|
1485
|
-
|
|
1486
|
-
Lookup Roblox users, game statistics, and profile information
|
|
1487
|
-
|
|
1488
|
-
### Example Usage
|
|
1489
|
-
|
|
1490
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchSocialsRoblox" method="post" path="/v1/search/socials/roblox" -->
|
|
1491
|
-
```typescript
|
|
1492
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1493
|
-
|
|
1494
|
-
const indicia = new Indicia({
|
|
1495
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1496
|
-
});
|
|
1497
|
-
|
|
1498
|
-
async function run() {
|
|
1499
|
-
const result = await indicia.postV1SearchSocialsRoblox({
|
|
1500
|
-
query: "<value>",
|
|
1501
|
-
});
|
|
1502
|
-
|
|
1503
|
-
console.log(result);
|
|
1504
|
-
}
|
|
1505
|
-
|
|
1506
|
-
run();
|
|
1507
|
-
```
|
|
1508
|
-
|
|
1509
|
-
### Standalone function
|
|
1510
|
-
|
|
1511
|
-
The standalone function version of this method:
|
|
1512
|
-
|
|
1513
|
-
```typescript
|
|
1514
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1515
|
-
import { postV1SearchSocialsRoblox } from "@indiciaosint/sdk/funcs/post-v1-search-socials-roblox.js";
|
|
1516
|
-
|
|
1517
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1518
|
-
// You can create one instance of it to use across an application.
|
|
1519
|
-
const indicia = new IndiciaCore({
|
|
1520
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1521
|
-
});
|
|
1522
|
-
|
|
1523
|
-
async function run() {
|
|
1524
|
-
const res = await postV1SearchSocialsRoblox(indicia, {
|
|
1525
|
-
query: "<value>",
|
|
1526
|
-
});
|
|
1527
|
-
if (res.ok) {
|
|
1528
|
-
const { value: result } = res;
|
|
1529
|
-
console.log(result);
|
|
1530
|
-
} else {
|
|
1531
|
-
console.log("postV1SearchSocialsRoblox failed:", res.error);
|
|
1532
|
-
}
|
|
1533
|
-
}
|
|
1534
|
-
|
|
1535
|
-
run();
|
|
1536
|
-
```
|
|
1537
|
-
|
|
1538
|
-
### Parameters
|
|
1539
|
-
|
|
1540
|
-
| Parameter | Type | Required | Description |
|
|
1541
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1542
|
-
| `request` | [operations.PostV1SearchSocialsRobloxRequest](../../models/operations/post-v1-search-socials-roblox-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1543
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1544
|
-
| `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. |
|
|
1545
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1546
|
-
|
|
1547
|
-
### Response
|
|
1548
|
-
|
|
1549
|
-
**Promise\<[operations.PostV1SearchSocialsRobloxResponse](../../models/operations/post-v1-search-socials-roblox-response.md)\>**
|
|
1550
|
-
|
|
1551
|
-
### Errors
|
|
1552
|
-
|
|
1553
|
-
| Error Type | Status Code | Content Type |
|
|
1554
|
-
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
|
1555
|
-
| errors.PostV1SearchSocialsRobloxInternalServerError | 500 | application/json |
|
|
1556
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1557
|
-
|
|
1558
|
-
## postV1SearchSocialsTiktok
|
|
1559
|
-
|
|
1560
|
-
Aggregate intelligence and data of a TikTok account
|
|
1561
|
-
|
|
1562
|
-
### Example Usage
|
|
1563
|
-
|
|
1564
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchSocialsTiktok" method="post" path="/v1/search/socials/tiktok" -->
|
|
1565
|
-
```typescript
|
|
1566
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1567
|
-
|
|
1568
|
-
const indicia = new Indicia({
|
|
1569
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1570
|
-
});
|
|
1571
|
-
|
|
1572
|
-
async function run() {
|
|
1573
|
-
const result = await indicia.postV1SearchSocialsTiktok({
|
|
1574
|
-
query: "<value>",
|
|
1575
|
-
});
|
|
1576
|
-
|
|
1577
|
-
console.log(result);
|
|
1578
|
-
}
|
|
1579
|
-
|
|
1580
|
-
run();
|
|
1581
|
-
```
|
|
1582
|
-
|
|
1583
|
-
### Standalone function
|
|
1584
|
-
|
|
1585
|
-
The standalone function version of this method:
|
|
1586
|
-
|
|
1587
|
-
```typescript
|
|
1588
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1589
|
-
import { postV1SearchSocialsTiktok } from "@indiciaosint/sdk/funcs/post-v1-search-socials-tiktok.js";
|
|
1590
|
-
|
|
1591
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1592
|
-
// You can create one instance of it to use across an application.
|
|
1593
|
-
const indicia = new IndiciaCore({
|
|
1594
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1595
|
-
});
|
|
1596
|
-
|
|
1597
|
-
async function run() {
|
|
1598
|
-
const res = await postV1SearchSocialsTiktok(indicia, {
|
|
1599
|
-
query: "<value>",
|
|
1600
|
-
});
|
|
1601
|
-
if (res.ok) {
|
|
1602
|
-
const { value: result } = res;
|
|
1603
|
-
console.log(result);
|
|
1604
|
-
} else {
|
|
1605
|
-
console.log("postV1SearchSocialsTiktok failed:", res.error);
|
|
1606
|
-
}
|
|
1607
|
-
}
|
|
1608
|
-
|
|
1609
|
-
run();
|
|
1610
|
-
```
|
|
1611
|
-
|
|
1612
|
-
### Parameters
|
|
1613
|
-
|
|
1614
|
-
| Parameter | Type | Required | Description |
|
|
1615
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1616
|
-
| `request` | [operations.PostV1SearchSocialsTiktokRequest](../../models/operations/post-v1-search-socials-tiktok-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1617
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1618
|
-
| `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. |
|
|
1619
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1620
|
-
|
|
1621
|
-
### Response
|
|
1622
|
-
|
|
1623
|
-
**Promise\<[operations.PostV1SearchSocialsTiktokResponse](../../models/operations/post-v1-search-socials-tiktok-response.md)\>**
|
|
1624
|
-
|
|
1625
|
-
### Errors
|
|
1626
|
-
|
|
1627
|
-
| Error Type | Status Code | Content Type |
|
|
1628
|
-
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
|
1629
|
-
| errors.PostV1SearchSocialsTiktokInternalServerError | 500 | application/json |
|
|
1630
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1631
|
-
|
|
1632
|
-
## postV1SearchInfrastructureIpinfo
|
|
1633
|
-
|
|
1634
|
-
Analyze details of an IP Address.
|
|
1635
|
-
|
|
1636
|
-
### Example Usage
|
|
1637
|
-
|
|
1638
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructureIpinfo" method="post" path="/v1/search/infrastructure/ipinfo" -->
|
|
1639
|
-
```typescript
|
|
1640
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1641
|
-
|
|
1642
|
-
const indicia = new Indicia({
|
|
1643
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1644
|
-
});
|
|
1645
|
-
|
|
1646
|
-
async function run() {
|
|
1647
|
-
const result = await indicia.postV1SearchInfrastructureIpinfo({
|
|
1648
|
-
query: "<value>",
|
|
1649
|
-
});
|
|
1650
|
-
|
|
1651
|
-
console.log(result);
|
|
1652
|
-
}
|
|
1653
|
-
|
|
1654
|
-
run();
|
|
1655
|
-
```
|
|
1656
|
-
|
|
1657
|
-
### Standalone function
|
|
1658
|
-
|
|
1659
|
-
The standalone function version of this method:
|
|
1660
|
-
|
|
1661
|
-
```typescript
|
|
1662
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1663
|
-
import { postV1SearchInfrastructureIpinfo } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-ipinfo.js";
|
|
1664
|
-
|
|
1665
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1666
|
-
// You can create one instance of it to use across an application.
|
|
1667
|
-
const indicia = new IndiciaCore({
|
|
1668
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1669
|
-
});
|
|
1670
|
-
|
|
1671
|
-
async function run() {
|
|
1672
|
-
const res = await postV1SearchInfrastructureIpinfo(indicia, {
|
|
1673
|
-
query: "<value>",
|
|
1674
|
-
});
|
|
1675
|
-
if (res.ok) {
|
|
1676
|
-
const { value: result } = res;
|
|
1677
|
-
console.log(result);
|
|
1678
|
-
} else {
|
|
1679
|
-
console.log("postV1SearchInfrastructureIpinfo failed:", res.error);
|
|
1680
|
-
}
|
|
1681
|
-
}
|
|
1682
|
-
|
|
1683
|
-
run();
|
|
1684
|
-
```
|
|
1685
|
-
|
|
1686
|
-
### Parameters
|
|
1687
|
-
|
|
1688
|
-
| Parameter | Type | Required | Description |
|
|
1689
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1690
|
-
| `request` | [operations.PostV1SearchInfrastructureIpinfoRequest](../../models/operations/post-v1-search-infrastructure-ipinfo-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1691
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1692
|
-
| `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. |
|
|
1693
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1694
|
-
|
|
1695
|
-
### Response
|
|
1696
|
-
|
|
1697
|
-
**Promise\<[operations.PostV1SearchInfrastructureIpinfoResponse](../../models/operations/post-v1-search-infrastructure-ipinfo-response.md)\>**
|
|
1698
|
-
|
|
1699
|
-
### Errors
|
|
1700
|
-
|
|
1701
|
-
| Error Type | Status Code | Content Type |
|
|
1702
|
-
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
1703
|
-
| errors.PostV1SearchInfrastructureIpinfoInternalServerError | 500 | application/json |
|
|
1704
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1705
|
-
|
|
1706
|
-
## postV1SearchInfrastructureDns
|
|
1707
|
-
|
|
1708
|
-
Perform deep DNS analysis and find hidden subdomains
|
|
1709
|
-
|
|
1710
|
-
### Example Usage
|
|
1711
|
-
|
|
1712
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructureDns" method="post" path="/v1/search/infrastructure/dns" -->
|
|
1713
|
-
```typescript
|
|
1714
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1715
|
-
|
|
1716
|
-
const indicia = new Indicia({
|
|
1717
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1718
|
-
});
|
|
1719
|
-
|
|
1720
|
-
async function run() {
|
|
1721
|
-
const result = await indicia.postV1SearchInfrastructureDns({
|
|
1722
|
-
query: "<value>",
|
|
1723
|
-
});
|
|
1724
|
-
|
|
1725
|
-
console.log(result);
|
|
1726
|
-
}
|
|
1727
|
-
|
|
1728
|
-
run();
|
|
1729
|
-
```
|
|
1730
|
-
|
|
1731
|
-
### Standalone function
|
|
1732
|
-
|
|
1733
|
-
The standalone function version of this method:
|
|
1734
|
-
|
|
1735
|
-
```typescript
|
|
1736
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1737
|
-
import { postV1SearchInfrastructureDns } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-dns.js";
|
|
1738
|
-
|
|
1739
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1740
|
-
// You can create one instance of it to use across an application.
|
|
1741
|
-
const indicia = new IndiciaCore({
|
|
1742
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1743
|
-
});
|
|
1744
|
-
|
|
1745
|
-
async function run() {
|
|
1746
|
-
const res = await postV1SearchInfrastructureDns(indicia, {
|
|
1747
|
-
query: "<value>",
|
|
1748
|
-
});
|
|
1749
|
-
if (res.ok) {
|
|
1750
|
-
const { value: result } = res;
|
|
1751
|
-
console.log(result);
|
|
1752
|
-
} else {
|
|
1753
|
-
console.log("postV1SearchInfrastructureDns failed:", res.error);
|
|
1754
|
-
}
|
|
1755
|
-
}
|
|
1756
|
-
|
|
1757
|
-
run();
|
|
1758
|
-
```
|
|
1759
|
-
|
|
1760
|
-
### Parameters
|
|
1761
|
-
|
|
1762
|
-
| Parameter | Type | Required | Description |
|
|
1763
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1764
|
-
| `request` | [operations.PostV1SearchInfrastructureDnsRequest](../../models/operations/post-v1-search-infrastructure-dns-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1765
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1766
|
-
| `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. |
|
|
1767
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1768
|
-
|
|
1769
|
-
### Response
|
|
1770
|
-
|
|
1771
|
-
**Promise\<[operations.PostV1SearchInfrastructureDnsResponse](../../models/operations/post-v1-search-infrastructure-dns-response.md)\>**
|
|
1772
|
-
|
|
1773
|
-
### Errors
|
|
1774
|
-
|
|
1775
|
-
| Error Type | Status Code | Content Type |
|
|
1776
|
-
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
1777
|
-
| errors.PostV1SearchInfrastructureDnsInternalServerError | 500 | application/json |
|
|
1778
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1779
|
-
|
|
1780
|
-
## postV1SearchInfrastructureShodan
|
|
1781
|
-
|
|
1782
|
-
IP service and software intelligence
|
|
1783
|
-
|
|
1784
|
-
### Example Usage
|
|
1785
|
-
|
|
1786
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructureShodan" method="post" path="/v1/search/infrastructure/shodan" -->
|
|
1787
|
-
```typescript
|
|
1788
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1789
|
-
|
|
1790
|
-
const indicia = new Indicia({
|
|
1791
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1792
|
-
});
|
|
1793
|
-
|
|
1794
|
-
async function run() {
|
|
1795
|
-
const result = await indicia.postV1SearchInfrastructureShodan({
|
|
1796
|
-
query: "<value>",
|
|
1797
|
-
});
|
|
1798
|
-
|
|
1799
|
-
console.log(result);
|
|
1800
|
-
}
|
|
1801
|
-
|
|
1802
|
-
run();
|
|
1803
|
-
```
|
|
1804
|
-
|
|
1805
|
-
### Standalone function
|
|
1806
|
-
|
|
1807
|
-
The standalone function version of this method:
|
|
1808
|
-
|
|
1809
|
-
```typescript
|
|
1810
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1811
|
-
import { postV1SearchInfrastructureShodan } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-shodan.js";
|
|
1812
|
-
|
|
1813
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1814
|
-
// You can create one instance of it to use across an application.
|
|
1815
|
-
const indicia = new IndiciaCore({
|
|
1816
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1817
|
-
});
|
|
1818
|
-
|
|
1819
|
-
async function run() {
|
|
1820
|
-
const res = await postV1SearchInfrastructureShodan(indicia, {
|
|
1821
|
-
query: "<value>",
|
|
1822
|
-
});
|
|
1823
|
-
if (res.ok) {
|
|
1824
|
-
const { value: result } = res;
|
|
1825
|
-
console.log(result);
|
|
1826
|
-
} else {
|
|
1827
|
-
console.log("postV1SearchInfrastructureShodan failed:", res.error);
|
|
1828
|
-
}
|
|
1829
|
-
}
|
|
1830
|
-
|
|
1831
|
-
run();
|
|
1832
|
-
```
|
|
1833
|
-
|
|
1834
|
-
### Parameters
|
|
1835
|
-
|
|
1836
|
-
| Parameter | Type | Required | Description |
|
|
1837
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1838
|
-
| `request` | [operations.PostV1SearchInfrastructureShodanRequest](../../models/operations/post-v1-search-infrastructure-shodan-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1839
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1840
|
-
| `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. |
|
|
1841
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1842
|
-
|
|
1843
|
-
### Response
|
|
1844
|
-
|
|
1845
|
-
**Promise\<[operations.PostV1SearchInfrastructureShodanResponse](../../models/operations/post-v1-search-infrastructure-shodan-response.md)\>**
|
|
1846
|
-
|
|
1847
|
-
### Errors
|
|
1848
|
-
|
|
1849
|
-
| Error Type | Status Code | Content Type |
|
|
1850
|
-
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
1851
|
-
| errors.PostV1SearchInfrastructureShodanInternalServerError | 500 | application/json |
|
|
1852
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1853
|
-
|
|
1854
|
-
## postV1SearchInfrastructureWhois
|
|
1855
|
-
|
|
1856
|
-
Return information on a domain and its registration
|
|
1857
|
-
|
|
1858
|
-
### Example Usage
|
|
1859
|
-
|
|
1860
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructureWhois" method="post" path="/v1/search/infrastructure/whois" -->
|
|
1861
|
-
```typescript
|
|
1862
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
1863
|
-
|
|
1864
|
-
const indicia = new Indicia({
|
|
1865
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1866
|
-
});
|
|
1867
|
-
|
|
1868
|
-
async function run() {
|
|
1869
|
-
const result = await indicia.postV1SearchInfrastructureWhois({
|
|
1870
|
-
query: "<value>",
|
|
1871
|
-
});
|
|
1872
|
-
|
|
1873
|
-
console.log(result);
|
|
1874
|
-
}
|
|
1875
|
-
|
|
1876
|
-
run();
|
|
1877
|
-
```
|
|
1878
|
-
|
|
1879
|
-
### Standalone function
|
|
1880
|
-
|
|
1881
|
-
The standalone function version of this method:
|
|
1882
|
-
|
|
1883
|
-
```typescript
|
|
1884
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
1885
|
-
import { postV1SearchInfrastructureWhois } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-whois.js";
|
|
1886
|
-
|
|
1887
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
1888
|
-
// You can create one instance of it to use across an application.
|
|
1889
|
-
const indicia = new IndiciaCore({
|
|
1890
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
1891
|
-
});
|
|
1892
|
-
|
|
1893
|
-
async function run() {
|
|
1894
|
-
const res = await postV1SearchInfrastructureWhois(indicia, {
|
|
1895
|
-
query: "<value>",
|
|
1896
|
-
});
|
|
1897
|
-
if (res.ok) {
|
|
1898
|
-
const { value: result } = res;
|
|
1899
|
-
console.log(result);
|
|
1900
|
-
} else {
|
|
1901
|
-
console.log("postV1SearchInfrastructureWhois failed:", res.error);
|
|
1902
|
-
}
|
|
1903
|
-
}
|
|
1904
|
-
|
|
1905
|
-
run();
|
|
1906
|
-
```
|
|
1907
|
-
|
|
1908
|
-
### Parameters
|
|
1909
|
-
|
|
1910
|
-
| Parameter | Type | Required | Description |
|
|
1911
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1912
|
-
| `request` | [operations.PostV1SearchInfrastructureWhoisRequest](../../models/operations/post-v1-search-infrastructure-whois-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1913
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1914
|
-
| `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. |
|
|
1915
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1916
|
-
|
|
1917
|
-
### Response
|
|
1918
|
-
|
|
1919
|
-
**Promise\<[operations.PostV1SearchInfrastructureWhoisResponse](../../models/operations/post-v1-search-infrastructure-whois-response.md)\>**
|
|
1920
|
-
|
|
1921
|
-
### Errors
|
|
1922
|
-
|
|
1923
|
-
| Error Type | Status Code | Content Type |
|
|
1924
|
-
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
|
1925
|
-
| errors.PostV1SearchInfrastructureWhoisInternalServerError | 500 | application/json |
|
|
1926
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
1927
|
-
|
|
1928
|
-
## postV1SearchInfrastructurePortscan
|
|
1929
|
-
|
|
1930
|
-
Perform a port scan on a given IP address or domain.
|
|
1931
|
-
|
|
1932
|
-
Response type:
|
|
1933
|
-
```ts
|
|
1934
|
-
interface NmapScanResult {
|
|
1935
|
-
$: {
|
|
1936
|
-
scanner: string;
|
|
1937
|
-
args: string;
|
|
1938
|
-
start: string;
|
|
1939
|
-
startstr: string;
|
|
1940
|
-
version: string;
|
|
1941
|
-
xmloutputversion: string;
|
|
1942
|
-
};
|
|
1943
|
-
scaninfo: Array<{
|
|
1944
|
-
$: {
|
|
1945
|
-
type: string;
|
|
1946
|
-
protocol: string;
|
|
1947
|
-
numservices: string;
|
|
1948
|
-
services: string;
|
|
1949
|
-
};
|
|
1950
|
-
}>;
|
|
1951
|
-
verbose: Array<{ $: { level: string } }>;
|
|
1952
|
-
debugging: Array<{ $: { level: string } }>;
|
|
1953
|
-
taskprogress?: Array<{
|
|
1954
|
-
$: {
|
|
1955
|
-
task: string;
|
|
1956
|
-
time: string;
|
|
1957
|
-
percent: string;
|
|
1958
|
-
remaining: string;
|
|
1959
|
-
etc: string;
|
|
1960
|
-
};
|
|
1961
|
-
}>;
|
|
1962
|
-
host?: Array<{
|
|
1963
|
-
$: {
|
|
1964
|
-
starttime: string;
|
|
1965
|
-
endtime: string;
|
|
1966
|
-
};
|
|
1967
|
-
status: Array<{
|
|
1968
|
-
$: {
|
|
1969
|
-
state: string;
|
|
1970
|
-
reason: string;
|
|
1971
|
-
reason_ttl: string;
|
|
1972
|
-
};
|
|
1973
|
-
}>;
|
|
1974
|
-
address: Array<{
|
|
1975
|
-
$: {
|
|
1976
|
-
addr: string;
|
|
1977
|
-
addrtype: string;
|
|
1978
|
-
};
|
|
1979
|
-
}>;
|
|
1980
|
-
hostnames?: Array<{
|
|
1981
|
-
hostname: Array<{
|
|
1982
|
-
$: {
|
|
1983
|
-
name: string;
|
|
1984
|
-
type: string;
|
|
1985
|
-
};
|
|
1986
|
-
}>;
|
|
1987
|
-
}>;
|
|
1988
|
-
ports?: Array<{
|
|
1989
|
-
extraports?: Array<{
|
|
1990
|
-
$: {
|
|
1991
|
-
state: string;
|
|
1992
|
-
count: string;
|
|
1993
|
-
};
|
|
1994
|
-
extrareasons: Array<{
|
|
1995
|
-
$: {
|
|
1996
|
-
reason: string;
|
|
1997
|
-
count: string;
|
|
1998
|
-
proto: string;
|
|
1999
|
-
ports: string;
|
|
2000
|
-
};
|
|
2001
|
-
}>;
|
|
2002
|
-
}>;
|
|
2003
|
-
port?: Array<{
|
|
2004
|
-
$: {
|
|
2005
|
-
protocol: string;
|
|
2006
|
-
portid: string;
|
|
2007
|
-
};
|
|
2008
|
-
state: Array<{
|
|
2009
|
-
$: {
|
|
2010
|
-
state: string;
|
|
2011
|
-
reason: string;
|
|
2012
|
-
reason_ttl: string;
|
|
2013
|
-
};
|
|
2014
|
-
}>;
|
|
2015
|
-
service?: Array<{
|
|
2016
|
-
$: {
|
|
2017
|
-
name: string;
|
|
2018
|
-
product?: string;
|
|
2019
|
-
version?: string;
|
|
2020
|
-
extrainfo?: string;
|
|
2021
|
-
ostype?: string;
|
|
2022
|
-
method: string;
|
|
2023
|
-
conf: string;
|
|
2024
|
-
};
|
|
2025
|
-
cpe?: string[];
|
|
2026
|
-
}>;
|
|
2027
|
-
}>;
|
|
2028
|
-
}>;
|
|
2029
|
-
times?: Array<{
|
|
2030
|
-
$: {
|
|
2031
|
-
srtt: string;
|
|
2032
|
-
rttvar: string;
|
|
2033
|
-
to: string;
|
|
2034
|
-
};
|
|
2035
|
-
}>;
|
|
2036
|
-
}>;
|
|
2037
|
-
runstats: Array<{
|
|
2038
|
-
finished: Array<{
|
|
2039
|
-
$: {
|
|
2040
|
-
time: string;
|
|
2041
|
-
timestr: string;
|
|
2042
|
-
summary: string;
|
|
2043
|
-
elapsed: string;
|
|
2044
|
-
exit: string;
|
|
2045
|
-
};
|
|
2046
|
-
}>;
|
|
2047
|
-
hosts: Array<{
|
|
2048
|
-
$: {
|
|
2049
|
-
up: string;
|
|
2050
|
-
down: string;
|
|
2051
|
-
total: string;
|
|
2052
|
-
};
|
|
2053
|
-
}>;
|
|
2054
|
-
}>;
|
|
2055
|
-
}
|
|
2056
|
-
```
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
### Example Usage: analyzing
|
|
2060
|
-
|
|
2061
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructurePortscan" method="post" path="/v1/search/infrastructure/portscan" example="analyzing" -->
|
|
2062
|
-
```typescript
|
|
2063
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2064
|
-
|
|
2065
|
-
const indicia = new Indicia({
|
|
2066
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2067
|
-
});
|
|
2068
|
-
|
|
2069
|
-
async function run() {
|
|
2070
|
-
const result = await indicia.postV1SearchInfrastructurePortscan({
|
|
2071
|
-
host: "self-reliant-taro.info",
|
|
2072
|
-
options: {},
|
|
2073
|
-
});
|
|
2074
|
-
|
|
2075
|
-
console.log(result);
|
|
2076
|
-
}
|
|
2077
|
-
|
|
2078
|
-
run();
|
|
2079
|
-
```
|
|
2080
|
-
|
|
2081
|
-
### Standalone function
|
|
2082
|
-
|
|
2083
|
-
The standalone function version of this method:
|
|
2084
|
-
|
|
2085
|
-
```typescript
|
|
2086
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2087
|
-
import { postV1SearchInfrastructurePortscan } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-portscan.js";
|
|
2088
|
-
|
|
2089
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2090
|
-
// You can create one instance of it to use across an application.
|
|
2091
|
-
const indicia = new IndiciaCore({
|
|
2092
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2093
|
-
});
|
|
2094
|
-
|
|
2095
|
-
async function run() {
|
|
2096
|
-
const res = await postV1SearchInfrastructurePortscan(indicia, {
|
|
2097
|
-
host: "self-reliant-taro.info",
|
|
2098
|
-
options: {},
|
|
2099
|
-
});
|
|
2100
|
-
if (res.ok) {
|
|
2101
|
-
const { value: result } = res;
|
|
2102
|
-
console.log(result);
|
|
2103
|
-
} else {
|
|
2104
|
-
console.log("postV1SearchInfrastructurePortscan failed:", res.error);
|
|
2105
|
-
}
|
|
2106
|
-
}
|
|
2107
|
-
|
|
2108
|
-
run();
|
|
2109
|
-
```
|
|
2110
|
-
### Example Usage: complete
|
|
2111
|
-
|
|
2112
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructurePortscan" method="post" path="/v1/search/infrastructure/portscan" example="complete" -->
|
|
2113
|
-
```typescript
|
|
2114
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2115
|
-
|
|
2116
|
-
const indicia = new Indicia({
|
|
2117
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2118
|
-
});
|
|
2119
|
-
|
|
2120
|
-
async function run() {
|
|
2121
|
-
const result = await indicia.postV1SearchInfrastructurePortscan({
|
|
2122
|
-
host: "self-reliant-taro.info",
|
|
2123
|
-
options: {},
|
|
2124
|
-
});
|
|
2125
|
-
|
|
2126
|
-
console.log(result);
|
|
2127
|
-
}
|
|
2128
|
-
|
|
2129
|
-
run();
|
|
2130
|
-
```
|
|
2131
|
-
|
|
2132
|
-
### Standalone function
|
|
2133
|
-
|
|
2134
|
-
The standalone function version of this method:
|
|
2135
|
-
|
|
2136
|
-
```typescript
|
|
2137
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2138
|
-
import { postV1SearchInfrastructurePortscan } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-portscan.js";
|
|
2139
|
-
|
|
2140
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2141
|
-
// You can create one instance of it to use across an application.
|
|
2142
|
-
const indicia = new IndiciaCore({
|
|
2143
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2144
|
-
});
|
|
2145
|
-
|
|
2146
|
-
async function run() {
|
|
2147
|
-
const res = await postV1SearchInfrastructurePortscan(indicia, {
|
|
2148
|
-
host: "self-reliant-taro.info",
|
|
2149
|
-
options: {},
|
|
2150
|
-
});
|
|
2151
|
-
if (res.ok) {
|
|
2152
|
-
const { value: result } = res;
|
|
2153
|
-
console.log(result);
|
|
2154
|
-
} else {
|
|
2155
|
-
console.log("postV1SearchInfrastructurePortscan failed:", res.error);
|
|
2156
|
-
}
|
|
2157
|
-
}
|
|
2158
|
-
|
|
2159
|
-
run();
|
|
2160
|
-
```
|
|
2161
|
-
### Example Usage: error
|
|
2162
|
-
|
|
2163
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructurePortscan" method="post" path="/v1/search/infrastructure/portscan" example="error" -->
|
|
2164
|
-
```typescript
|
|
2165
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2166
|
-
|
|
2167
|
-
const indicia = new Indicia({
|
|
2168
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2169
|
-
});
|
|
2170
|
-
|
|
2171
|
-
async function run() {
|
|
2172
|
-
const result = await indicia.postV1SearchInfrastructurePortscan({
|
|
2173
|
-
host: "self-reliant-taro.info",
|
|
2174
|
-
options: {},
|
|
2175
|
-
});
|
|
2176
|
-
|
|
2177
|
-
console.log(result);
|
|
2178
|
-
}
|
|
2179
|
-
|
|
2180
|
-
run();
|
|
2181
|
-
```
|
|
2182
|
-
|
|
2183
|
-
### Standalone function
|
|
2184
|
-
|
|
2185
|
-
The standalone function version of this method:
|
|
2186
|
-
|
|
2187
|
-
```typescript
|
|
2188
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2189
|
-
import { postV1SearchInfrastructurePortscan } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-portscan.js";
|
|
2190
|
-
|
|
2191
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2192
|
-
// You can create one instance of it to use across an application.
|
|
2193
|
-
const indicia = new IndiciaCore({
|
|
2194
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2195
|
-
});
|
|
2196
|
-
|
|
2197
|
-
async function run() {
|
|
2198
|
-
const res = await postV1SearchInfrastructurePortscan(indicia, {
|
|
2199
|
-
host: "self-reliant-taro.info",
|
|
2200
|
-
options: {},
|
|
2201
|
-
});
|
|
2202
|
-
if (res.ok) {
|
|
2203
|
-
const { value: result } = res;
|
|
2204
|
-
console.log(result);
|
|
2205
|
-
} else {
|
|
2206
|
-
console.log("postV1SearchInfrastructurePortscan failed:", res.error);
|
|
2207
|
-
}
|
|
2208
|
-
}
|
|
2209
|
-
|
|
2210
|
-
run();
|
|
2211
|
-
```
|
|
2212
|
-
|
|
2213
|
-
### Parameters
|
|
2214
|
-
|
|
2215
|
-
| Parameter | Type | Required | Description |
|
|
2216
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2217
|
-
| `request` | [operations.PostV1SearchInfrastructurePortscanRequest](../../models/operations/post-v1-search-infrastructure-portscan-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2218
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2219
|
-
| `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. |
|
|
2220
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2221
|
-
|
|
2222
|
-
### Response
|
|
2223
|
-
|
|
2224
|
-
**Promise\<[string](../../models/.md)\>**
|
|
2225
|
-
|
|
2226
|
-
### Errors
|
|
2227
|
-
|
|
2228
|
-
| Error Type | Status Code | Content Type |
|
|
2229
|
-
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
2230
|
-
| errors.PostV1SearchInfrastructurePortscanBadRequestError | 400 | application/json |
|
|
2231
|
-
| errors.PostV1SearchInfrastructurePortscanPaymentRequiredError | 402 | application/json |
|
|
2232
|
-
| errors.PostV1SearchInfrastructurePortscanInternalServerError | 500 | application/json |
|
|
2233
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2234
|
-
|
|
2235
|
-
## postV1SearchInfrastructureCertificates
|
|
2236
|
-
|
|
2237
|
-
Lookup details about a TLS certificate by domain.
|
|
2238
|
-
|
|
2239
|
-
### Example Usage
|
|
2240
|
-
|
|
2241
|
-
<!-- UsageSnippet language="typescript" operationID="postV1SearchInfrastructureCertificates" method="post" path="/v1/search/infrastructure/certificates" -->
|
|
2242
|
-
```typescript
|
|
2243
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2244
|
-
|
|
2245
|
-
const indicia = new Indicia({
|
|
2246
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2247
|
-
});
|
|
2248
|
-
|
|
2249
|
-
async function run() {
|
|
2250
|
-
const result = await indicia.postV1SearchInfrastructureCertificates({
|
|
2251
|
-
query: "<value>",
|
|
2252
|
-
});
|
|
2253
|
-
|
|
2254
|
-
console.log(result);
|
|
2255
|
-
}
|
|
2256
|
-
|
|
2257
|
-
run();
|
|
2258
|
-
```
|
|
2259
|
-
|
|
2260
|
-
### Standalone function
|
|
2261
|
-
|
|
2262
|
-
The standalone function version of this method:
|
|
2263
|
-
|
|
2264
|
-
```typescript
|
|
2265
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2266
|
-
import { postV1SearchInfrastructureCertificates } from "@indiciaosint/sdk/funcs/post-v1-search-infrastructure-certificates.js";
|
|
2267
|
-
|
|
2268
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2269
|
-
// You can create one instance of it to use across an application.
|
|
2270
|
-
const indicia = new IndiciaCore({
|
|
2271
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2272
|
-
});
|
|
2273
|
-
|
|
2274
|
-
async function run() {
|
|
2275
|
-
const res = await postV1SearchInfrastructureCertificates(indicia, {
|
|
2276
|
-
query: "<value>",
|
|
2277
|
-
});
|
|
2278
|
-
if (res.ok) {
|
|
2279
|
-
const { value: result } = res;
|
|
2280
|
-
console.log(result);
|
|
2281
|
-
} else {
|
|
2282
|
-
console.log("postV1SearchInfrastructureCertificates failed:", res.error);
|
|
2283
|
-
}
|
|
2284
|
-
}
|
|
2285
|
-
|
|
2286
|
-
run();
|
|
2287
|
-
```
|
|
2288
|
-
|
|
2289
|
-
### Parameters
|
|
2290
|
-
|
|
2291
|
-
| Parameter | Type | Required | Description |
|
|
2292
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2293
|
-
| `request` | [operations.PostV1SearchInfrastructureCertificatesRequest](../../models/operations/post-v1-search-infrastructure-certificates-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2294
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2295
|
-
| `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. |
|
|
2296
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2297
|
-
|
|
2298
|
-
### Response
|
|
2299
|
-
|
|
2300
|
-
**Promise\<[operations.PostV1SearchInfrastructureCertificatesResponse](../../models/operations/post-v1-search-infrastructure-certificates-response.md)\>**
|
|
2301
|
-
|
|
2302
|
-
### Errors
|
|
2303
|
-
|
|
2304
|
-
| Error Type | Status Code | Content Type |
|
|
2305
|
-
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
2306
|
-
| errors.PostV1SearchInfrastructureCertificatesInternalServerError | 500 | application/json |
|
|
2307
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2308
|
-
|
|
2309
|
-
## postV1ToolsDoogle
|
|
2310
|
-
|
|
2311
|
-
Correlate and identify alternative Discord accounts of a user.
|
|
2312
|
-
|
|
2313
|
-
### Example Usage
|
|
2314
|
-
|
|
2315
|
-
<!-- UsageSnippet language="typescript" operationID="postV1ToolsDoogle" method="post" path="/v1/tools/doogle" -->
|
|
2316
|
-
```typescript
|
|
2317
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2318
|
-
|
|
2319
|
-
const indicia = new Indicia({
|
|
2320
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2321
|
-
});
|
|
2322
|
-
|
|
2323
|
-
async function run() {
|
|
2324
|
-
const result = await indicia.postV1ToolsDoogle({
|
|
2325
|
-
query: "<value>",
|
|
2326
|
-
});
|
|
2327
|
-
|
|
2328
|
-
console.log(result);
|
|
2329
|
-
}
|
|
2330
|
-
|
|
2331
|
-
run();
|
|
2332
|
-
```
|
|
2333
|
-
|
|
2334
|
-
### Standalone function
|
|
2335
|
-
|
|
2336
|
-
The standalone function version of this method:
|
|
2337
|
-
|
|
2338
|
-
```typescript
|
|
2339
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2340
|
-
import { postV1ToolsDoogle } from "@indiciaosint/sdk/funcs/post-v1-tools-doogle.js";
|
|
2341
|
-
|
|
2342
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2343
|
-
// You can create one instance of it to use across an application.
|
|
2344
|
-
const indicia = new IndiciaCore({
|
|
2345
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2346
|
-
});
|
|
2347
|
-
|
|
2348
|
-
async function run() {
|
|
2349
|
-
const res = await postV1ToolsDoogle(indicia, {
|
|
2350
|
-
query: "<value>",
|
|
2351
|
-
});
|
|
2352
|
-
if (res.ok) {
|
|
2353
|
-
const { value: result } = res;
|
|
2354
|
-
console.log(result);
|
|
2355
|
-
} else {
|
|
2356
|
-
console.log("postV1ToolsDoogle failed:", res.error);
|
|
2357
|
-
}
|
|
2358
|
-
}
|
|
2359
|
-
|
|
2360
|
-
run();
|
|
2361
|
-
```
|
|
2362
|
-
|
|
2363
|
-
### Parameters
|
|
2364
|
-
|
|
2365
|
-
| Parameter | Type | Required | Description |
|
|
2366
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2367
|
-
| `request` | [operations.PostV1ToolsDoogleRequest](../../models/operations/post-v1-tools-doogle-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2368
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2369
|
-
| `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. |
|
|
2370
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2371
|
-
|
|
2372
|
-
### Response
|
|
2373
|
-
|
|
2374
|
-
**Promise\<[operations.PostV1ToolsDoogleResponse](../../models/operations/post-v1-tools-doogle-response.md)\>**
|
|
2375
|
-
|
|
2376
|
-
### Errors
|
|
2377
|
-
|
|
2378
|
-
| Error Type | Status Code | Content Type |
|
|
2379
|
-
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
|
2380
|
-
| errors.PostV1ToolsDoogleInternalServerError | 500 | application/json |
|
|
2381
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2382
|
-
|
|
2383
|
-
## postV1ToolsDoublecounter
|
|
2384
|
-
|
|
2385
|
-
Bypass alt detection for Discord servers.
|
|
2386
|
-
|
|
2387
|
-
### Example Usage
|
|
2388
|
-
|
|
2389
|
-
<!-- UsageSnippet language="typescript" operationID="postV1ToolsDoublecounter" method="post" path="/v1/tools/doublecounter" -->
|
|
2390
|
-
```typescript
|
|
2391
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2392
|
-
|
|
2393
|
-
const indicia = new Indicia({
|
|
2394
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2395
|
-
});
|
|
2396
|
-
|
|
2397
|
-
async function run() {
|
|
2398
|
-
const result = await indicia.postV1ToolsDoublecounter({
|
|
2399
|
-
url: "https://terrible-monster.com",
|
|
2400
|
-
});
|
|
2401
|
-
|
|
2402
|
-
console.log(result);
|
|
2403
|
-
}
|
|
2404
|
-
|
|
2405
|
-
run();
|
|
2406
|
-
```
|
|
2407
|
-
|
|
2408
|
-
### Standalone function
|
|
2409
|
-
|
|
2410
|
-
The standalone function version of this method:
|
|
2411
|
-
|
|
2412
|
-
```typescript
|
|
2413
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2414
|
-
import { postV1ToolsDoublecounter } from "@indiciaosint/sdk/funcs/post-v1-tools-doublecounter.js";
|
|
2415
|
-
|
|
2416
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2417
|
-
// You can create one instance of it to use across an application.
|
|
2418
|
-
const indicia = new IndiciaCore({
|
|
2419
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2420
|
-
});
|
|
2421
|
-
|
|
2422
|
-
async function run() {
|
|
2423
|
-
const res = await postV1ToolsDoublecounter(indicia, {
|
|
2424
|
-
url: "https://terrible-monster.com",
|
|
2425
|
-
});
|
|
2426
|
-
if (res.ok) {
|
|
2427
|
-
const { value: result } = res;
|
|
2428
|
-
console.log(result);
|
|
2429
|
-
} else {
|
|
2430
|
-
console.log("postV1ToolsDoublecounter failed:", res.error);
|
|
2431
|
-
}
|
|
2432
|
-
}
|
|
2433
|
-
|
|
2434
|
-
run();
|
|
2435
|
-
```
|
|
2436
|
-
|
|
2437
|
-
### Parameters
|
|
2438
|
-
|
|
2439
|
-
| Parameter | Type | Required | Description |
|
|
2440
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2441
|
-
| `request` | [operations.PostV1ToolsDoublecounterRequest](../../models/operations/post-v1-tools-doublecounter-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2442
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2443
|
-
| `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. |
|
|
2444
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2445
|
-
|
|
2446
|
-
### Response
|
|
2447
|
-
|
|
2448
|
-
**Promise\<[operations.PostV1ToolsDoublecounterResponse](../../models/operations/post-v1-tools-doublecounter-response.md)\>**
|
|
2449
|
-
|
|
2450
|
-
### Errors
|
|
2451
|
-
|
|
2452
|
-
| Error Type | Status Code | Content Type |
|
|
2453
|
-
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
2454
|
-
| errors.PostV1ToolsDoublecounterInternalServerError | 500 | application/json |
|
|
2455
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2456
|
-
|
|
2457
|
-
## postV1ToolsIntelx
|
|
2458
|
-
|
|
2459
|
-
Download a file from IntelX storage. Use storageId + bucket for a standalone file (5 credits), or systemId with bucket "leaks.logs" for a stealer log (10 credits).
|
|
2460
|
-
|
|
2461
|
-
### Example Usage
|
|
2462
|
-
|
|
2463
|
-
<!-- UsageSnippet language="typescript" operationID="postV1ToolsIntelx" method="post" path="/v1/tools/intelx" -->
|
|
2464
|
-
```typescript
|
|
2465
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2466
|
-
|
|
2467
|
-
const indicia = new Indicia({
|
|
2468
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2469
|
-
});
|
|
2470
|
-
|
|
2471
|
-
async function run() {
|
|
2472
|
-
const result = await indicia.postV1ToolsIntelx({
|
|
2473
|
-
bucket: "leaks.logs",
|
|
2474
|
-
systemId: "<id>",
|
|
2475
|
-
});
|
|
2476
|
-
|
|
2477
|
-
console.log(result);
|
|
2478
|
-
}
|
|
2479
|
-
|
|
2480
|
-
run();
|
|
2481
|
-
```
|
|
2482
|
-
|
|
2483
|
-
### Standalone function
|
|
2484
|
-
|
|
2485
|
-
The standalone function version of this method:
|
|
2486
|
-
|
|
2487
|
-
```typescript
|
|
2488
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2489
|
-
import { postV1ToolsIntelx } from "@indiciaosint/sdk/funcs/post-v1-tools-intelx.js";
|
|
2490
|
-
|
|
2491
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2492
|
-
// You can create one instance of it to use across an application.
|
|
2493
|
-
const indicia = new IndiciaCore({
|
|
2494
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2495
|
-
});
|
|
2496
|
-
|
|
2497
|
-
async function run() {
|
|
2498
|
-
const res = await postV1ToolsIntelx(indicia, {
|
|
2499
|
-
bucket: "leaks.logs",
|
|
2500
|
-
systemId: "<id>",
|
|
2501
|
-
});
|
|
2502
|
-
if (res.ok) {
|
|
2503
|
-
const { value: result } = res;
|
|
2504
|
-
console.log(result);
|
|
2505
|
-
} else {
|
|
2506
|
-
console.log("postV1ToolsIntelx failed:", res.error);
|
|
2507
|
-
}
|
|
2508
|
-
}
|
|
2509
|
-
|
|
2510
|
-
run();
|
|
2511
|
-
```
|
|
2512
|
-
|
|
2513
|
-
### Parameters
|
|
2514
|
-
|
|
2515
|
-
| Parameter | Type | Required | Description |
|
|
2516
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2517
|
-
| `request` | [operations.PostV1ToolsIntelxRequest](../../models/operations/post-v1-tools-intelx-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2518
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2519
|
-
| `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. |
|
|
2520
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2521
|
-
|
|
2522
|
-
### Response
|
|
2523
|
-
|
|
2524
|
-
**Promise\<[operations.PostV1ToolsIntelxResponse](../../models/operations/post-v1-tools-intelx-response.md)\>**
|
|
2525
|
-
|
|
2526
|
-
### Errors
|
|
2527
|
-
|
|
2528
|
-
| Error Type | Status Code | Content Type |
|
|
2529
|
-
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
|
2530
|
-
| errors.PostV1ToolsIntelxBadRequestError | 400 | application/json |
|
|
2531
|
-
| errors.PostV1ToolsIntelxInternalServerError | 500 | application/json |
|
|
2532
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2533
|
-
|
|
2534
|
-
## getV1Organizations
|
|
2535
|
-
|
|
2536
|
-
List organizations the authenticated user belongs to.
|
|
2537
|
-
|
|
2538
|
-
### Example Usage
|
|
2539
|
-
|
|
2540
|
-
<!-- UsageSnippet language="typescript" operationID="getV1Organizations" method="get" path="/v1/organizations" -->
|
|
2541
|
-
```typescript
|
|
2542
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2543
|
-
|
|
2544
|
-
const indicia = new Indicia({
|
|
2545
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2546
|
-
});
|
|
2547
|
-
|
|
2548
|
-
async function run() {
|
|
2549
|
-
const result = await indicia.getV1Organizations();
|
|
2550
|
-
|
|
2551
|
-
console.log(result);
|
|
2552
|
-
}
|
|
2553
|
-
|
|
2554
|
-
run();
|
|
2555
|
-
```
|
|
2556
|
-
|
|
2557
|
-
### Standalone function
|
|
2558
|
-
|
|
2559
|
-
The standalone function version of this method:
|
|
2560
|
-
|
|
2561
|
-
```typescript
|
|
2562
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2563
|
-
import { getV1Organizations } from "@indiciaosint/sdk/funcs/get-v1-organizations.js";
|
|
2564
|
-
|
|
2565
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2566
|
-
// You can create one instance of it to use across an application.
|
|
2567
|
-
const indicia = new IndiciaCore({
|
|
2568
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2569
|
-
});
|
|
2570
|
-
|
|
2571
|
-
async function run() {
|
|
2572
|
-
const res = await getV1Organizations(indicia);
|
|
2573
|
-
if (res.ok) {
|
|
2574
|
-
const { value: result } = res;
|
|
2575
|
-
console.log(result);
|
|
2576
|
-
} else {
|
|
2577
|
-
console.log("getV1Organizations failed:", res.error);
|
|
2578
|
-
}
|
|
2579
|
-
}
|
|
2580
|
-
|
|
2581
|
-
run();
|
|
2582
|
-
```
|
|
2583
|
-
|
|
2584
|
-
### Parameters
|
|
2585
|
-
|
|
2586
|
-
| Parameter | Type | Required | Description |
|
|
2587
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2588
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2589
|
-
| `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. |
|
|
2590
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2591
|
-
|
|
2592
|
-
### Response
|
|
2593
|
-
|
|
2594
|
-
**Promise\<[operations.GetV1OrganizationsResponse](../../models/operations/get-v1-organizations-response.md)\>**
|
|
2595
|
-
|
|
2596
|
-
### Errors
|
|
2597
|
-
|
|
2598
|
-
| Error Type | Status Code | Content Type |
|
|
2599
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
2600
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2601
|
-
|
|
2602
|
-
## getV1OrganizationsById
|
|
2603
|
-
|
|
2604
|
-
Get details for a specific organization you are a member of.
|
|
2605
|
-
|
|
2606
|
-
### Example Usage
|
|
2607
|
-
|
|
2608
|
-
<!-- UsageSnippet language="typescript" operationID="getV1OrganizationsById" method="get" path="/v1/organizations/{id}" -->
|
|
2609
|
-
```typescript
|
|
2610
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2611
|
-
|
|
2612
|
-
const indicia = new Indicia({
|
|
2613
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2614
|
-
});
|
|
2615
|
-
|
|
2616
|
-
async function run() {
|
|
2617
|
-
const result = await indicia.getV1OrganizationsById({
|
|
2618
|
-
id: "<id>",
|
|
2619
|
-
});
|
|
2620
|
-
|
|
2621
|
-
console.log(result);
|
|
2622
|
-
}
|
|
2623
|
-
|
|
2624
|
-
run();
|
|
2625
|
-
```
|
|
2626
|
-
|
|
2627
|
-
### Standalone function
|
|
2628
|
-
|
|
2629
|
-
The standalone function version of this method:
|
|
2630
|
-
|
|
2631
|
-
```typescript
|
|
2632
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2633
|
-
import { getV1OrganizationsById } from "@indiciaosint/sdk/funcs/get-v1-organizations-by-id.js";
|
|
2634
|
-
|
|
2635
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2636
|
-
// You can create one instance of it to use across an application.
|
|
2637
|
-
const indicia = new IndiciaCore({
|
|
2638
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2639
|
-
});
|
|
2640
|
-
|
|
2641
|
-
async function run() {
|
|
2642
|
-
const res = await getV1OrganizationsById(indicia, {
|
|
2643
|
-
id: "<id>",
|
|
2644
|
-
});
|
|
2645
|
-
if (res.ok) {
|
|
2646
|
-
const { value: result } = res;
|
|
2647
|
-
console.log(result);
|
|
2648
|
-
} else {
|
|
2649
|
-
console.log("getV1OrganizationsById failed:", res.error);
|
|
2650
|
-
}
|
|
2651
|
-
}
|
|
2652
|
-
|
|
2653
|
-
run();
|
|
2654
|
-
```
|
|
2655
|
-
|
|
2656
|
-
### Parameters
|
|
2657
|
-
|
|
2658
|
-
| Parameter | Type | Required | Description |
|
|
2659
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2660
|
-
| `request` | [operations.GetV1OrganizationsByIdRequest](../../models/operations/get-v1-organizations-by-id-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2661
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2662
|
-
| `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. |
|
|
2663
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2664
|
-
|
|
2665
|
-
### Response
|
|
2666
|
-
|
|
2667
|
-
**Promise\<[operations.GetV1OrganizationsByIdResponse](../../models/operations/get-v1-organizations-by-id-response.md)\>**
|
|
2668
|
-
|
|
2669
|
-
### Errors
|
|
2670
|
-
|
|
2671
|
-
| Error Type | Status Code | Content Type |
|
|
2672
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
2673
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2674
|
-
|
|
2675
|
-
## getV1OrganizationsByIdMembers
|
|
2676
|
-
|
|
2677
|
-
List members of an organization you belong to.
|
|
2678
|
-
|
|
2679
|
-
### Example Usage
|
|
2680
|
-
|
|
2681
|
-
<!-- UsageSnippet language="typescript" operationID="getV1OrganizationsByIdMembers" method="get" path="/v1/organizations/{id}/members" -->
|
|
2682
|
-
```typescript
|
|
2683
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2684
|
-
|
|
2685
|
-
const indicia = new Indicia({
|
|
2686
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2687
|
-
});
|
|
2688
|
-
|
|
2689
|
-
async function run() {
|
|
2690
|
-
const result = await indicia.getV1OrganizationsByIdMembers({
|
|
2691
|
-
id: "<id>",
|
|
2692
|
-
});
|
|
2693
|
-
|
|
2694
|
-
console.log(result);
|
|
2695
|
-
}
|
|
2696
|
-
|
|
2697
|
-
run();
|
|
2698
|
-
```
|
|
2699
|
-
|
|
2700
|
-
### Standalone function
|
|
2701
|
-
|
|
2702
|
-
The standalone function version of this method:
|
|
2703
|
-
|
|
2704
|
-
```typescript
|
|
2705
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2706
|
-
import { getV1OrganizationsByIdMembers } from "@indiciaosint/sdk/funcs/get-v1-organizations-by-id-members.js";
|
|
2707
|
-
|
|
2708
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2709
|
-
// You can create one instance of it to use across an application.
|
|
2710
|
-
const indicia = new IndiciaCore({
|
|
2711
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2712
|
-
});
|
|
2713
|
-
|
|
2714
|
-
async function run() {
|
|
2715
|
-
const res = await getV1OrganizationsByIdMembers(indicia, {
|
|
2716
|
-
id: "<id>",
|
|
2717
|
-
});
|
|
2718
|
-
if (res.ok) {
|
|
2719
|
-
const { value: result } = res;
|
|
2720
|
-
console.log(result);
|
|
2721
|
-
} else {
|
|
2722
|
-
console.log("getV1OrganizationsByIdMembers failed:", res.error);
|
|
2723
|
-
}
|
|
2724
|
-
}
|
|
2725
|
-
|
|
2726
|
-
run();
|
|
2727
|
-
```
|
|
2728
|
-
|
|
2729
|
-
### Parameters
|
|
2730
|
-
|
|
2731
|
-
| Parameter | Type | Required | Description |
|
|
2732
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2733
|
-
| `request` | [operations.GetV1OrganizationsByIdMembersRequest](../../models/operations/get-v1-organizations-by-id-members-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2734
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2735
|
-
| `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. |
|
|
2736
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2737
|
-
|
|
2738
|
-
### Response
|
|
2739
|
-
|
|
2740
|
-
**Promise\<[operations.GetV1OrganizationsByIdMembersResponse](../../models/operations/get-v1-organizations-by-id-members-response.md)\>**
|
|
2741
|
-
|
|
2742
|
-
### Errors
|
|
2743
|
-
|
|
2744
|
-
| Error Type | Status Code | Content Type |
|
|
2745
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
2746
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2747
|
-
|
|
2748
|
-
## getV1OrganizationsByIdAuditLog
|
|
2749
|
-
|
|
2750
|
-
Get the audit log for an organization. Requires owner or admin role.
|
|
2751
|
-
|
|
2752
|
-
### Example Usage
|
|
2753
|
-
|
|
2754
|
-
<!-- UsageSnippet language="typescript" operationID="getV1OrganizationsByIdAuditLog" method="get" path="/v1/organizations/{id}/audit-log" -->
|
|
2755
|
-
```typescript
|
|
2756
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2757
|
-
|
|
2758
|
-
const indicia = new Indicia({
|
|
2759
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2760
|
-
});
|
|
2761
|
-
|
|
2762
|
-
async function run() {
|
|
2763
|
-
const result = await indicia.getV1OrganizationsByIdAuditLog({
|
|
2764
|
-
id: "<id>",
|
|
2765
|
-
});
|
|
2766
|
-
|
|
2767
|
-
console.log(result);
|
|
2768
|
-
}
|
|
2769
|
-
|
|
2770
|
-
run();
|
|
2771
|
-
```
|
|
2772
|
-
|
|
2773
|
-
### Standalone function
|
|
2774
|
-
|
|
2775
|
-
The standalone function version of this method:
|
|
2776
|
-
|
|
2777
|
-
```typescript
|
|
2778
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2779
|
-
import { getV1OrganizationsByIdAuditLog } from "@indiciaosint/sdk/funcs/get-v1-organizations-by-id-audit-log.js";
|
|
2780
|
-
|
|
2781
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2782
|
-
// You can create one instance of it to use across an application.
|
|
2783
|
-
const indicia = new IndiciaCore({
|
|
2784
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2785
|
-
});
|
|
2786
|
-
|
|
2787
|
-
async function run() {
|
|
2788
|
-
const res = await getV1OrganizationsByIdAuditLog(indicia, {
|
|
2789
|
-
id: "<id>",
|
|
2790
|
-
});
|
|
2791
|
-
if (res.ok) {
|
|
2792
|
-
const { value: result } = res;
|
|
2793
|
-
console.log(result);
|
|
2794
|
-
} else {
|
|
2795
|
-
console.log("getV1OrganizationsByIdAuditLog failed:", res.error);
|
|
2796
|
-
}
|
|
2797
|
-
}
|
|
2798
|
-
|
|
2799
|
-
run();
|
|
2800
|
-
```
|
|
2801
|
-
|
|
2802
|
-
### Parameters
|
|
2803
|
-
|
|
2804
|
-
| Parameter | Type | Required | Description |
|
|
2805
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2806
|
-
| `request` | [operations.GetV1OrganizationsByIdAuditLogRequest](../../models/operations/get-v1-organizations-by-id-audit-log-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2807
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2808
|
-
| `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. |
|
|
2809
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2810
|
-
|
|
2811
|
-
### Response
|
|
2812
|
-
|
|
2813
|
-
**Promise\<[operations.GetV1OrganizationsByIdAuditLogResponse](../../models/operations/get-v1-organizations-by-id-audit-log-response.md)\>**
|
|
2814
|
-
|
|
2815
|
-
### Errors
|
|
2816
|
-
|
|
2817
|
-
| Error Type | Status Code | Content Type |
|
|
2818
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
2819
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2820
|
-
|
|
2821
|
-
## getV1OrganizationsByIdCases
|
|
2822
|
-
|
|
2823
|
-
List cases shared with an organization (filtered by your visibility settings).
|
|
2824
|
-
|
|
2825
|
-
### Example Usage
|
|
2826
|
-
|
|
2827
|
-
<!-- UsageSnippet language="typescript" operationID="getV1OrganizationsByIdCases" method="get" path="/v1/organizations/{id}/cases" -->
|
|
2828
|
-
```typescript
|
|
2829
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2830
|
-
|
|
2831
|
-
const indicia = new Indicia({
|
|
2832
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2833
|
-
});
|
|
2834
|
-
|
|
2835
|
-
async function run() {
|
|
2836
|
-
const result = await indicia.getV1OrganizationsByIdCases({
|
|
2837
|
-
id: "<id>",
|
|
2838
|
-
});
|
|
2839
|
-
|
|
2840
|
-
console.log(result);
|
|
2841
|
-
}
|
|
2842
|
-
|
|
2843
|
-
run();
|
|
2844
|
-
```
|
|
2845
|
-
|
|
2846
|
-
### Standalone function
|
|
2847
|
-
|
|
2848
|
-
The standalone function version of this method:
|
|
2849
|
-
|
|
2850
|
-
```typescript
|
|
2851
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2852
|
-
import { getV1OrganizationsByIdCases } from "@indiciaosint/sdk/funcs/get-v1-organizations-by-id-cases.js";
|
|
2853
|
-
|
|
2854
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2855
|
-
// You can create one instance of it to use across an application.
|
|
2856
|
-
const indicia = new IndiciaCore({
|
|
2857
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2858
|
-
});
|
|
2859
|
-
|
|
2860
|
-
async function run() {
|
|
2861
|
-
const res = await getV1OrganizationsByIdCases(indicia, {
|
|
2862
|
-
id: "<id>",
|
|
2863
|
-
});
|
|
2864
|
-
if (res.ok) {
|
|
2865
|
-
const { value: result } = res;
|
|
2866
|
-
console.log(result);
|
|
2867
|
-
} else {
|
|
2868
|
-
console.log("getV1OrganizationsByIdCases failed:", res.error);
|
|
2869
|
-
}
|
|
2870
|
-
}
|
|
2871
|
-
|
|
2872
|
-
run();
|
|
2873
|
-
```
|
|
2874
|
-
|
|
2875
|
-
### Parameters
|
|
2876
|
-
|
|
2877
|
-
| Parameter | Type | Required | Description |
|
|
2878
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2879
|
-
| `request` | [operations.GetV1OrganizationsByIdCasesRequest](../../models/operations/get-v1-organizations-by-id-cases-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2880
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2881
|
-
| `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. |
|
|
2882
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2883
|
-
|
|
2884
|
-
### Response
|
|
2885
|
-
|
|
2886
|
-
**Promise\<[operations.GetV1OrganizationsByIdCasesResponse](../../models/operations/get-v1-organizations-by-id-cases-response.md)\>**
|
|
2887
|
-
|
|
2888
|
-
### Errors
|
|
2889
|
-
|
|
2890
|
-
| Error Type | Status Code | Content Type |
|
|
2891
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
2892
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2893
|
-
|
|
2894
|
-
## postV1OrganizationsByIdCredits
|
|
2895
|
-
|
|
2896
|
-
Send credits from your balance to one or more organization members. Requires owner or admin role.
|
|
2897
|
-
|
|
2898
|
-
### Example Usage
|
|
2899
|
-
|
|
2900
|
-
<!-- UsageSnippet language="typescript" operationID="postV1OrganizationsByIdCredits" method="post" path="/v1/organizations/{id}/credits" -->
|
|
2901
|
-
```typescript
|
|
2902
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2903
|
-
|
|
2904
|
-
const indicia = new Indicia({
|
|
2905
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2906
|
-
});
|
|
2907
|
-
|
|
2908
|
-
async function run() {
|
|
2909
|
-
const result = await indicia.postV1OrganizationsByIdCredits({
|
|
2910
|
-
id: "<id>",
|
|
2911
|
-
body: {
|
|
2912
|
-
creditsEach: 8955.74,
|
|
2913
|
-
recipientMemberIds: [
|
|
2914
|
-
"<value 1>",
|
|
2915
|
-
"<value 2>",
|
|
2916
|
-
],
|
|
2917
|
-
},
|
|
2918
|
-
});
|
|
2919
|
-
|
|
2920
|
-
console.log(result);
|
|
2921
|
-
}
|
|
2922
|
-
|
|
2923
|
-
run();
|
|
2924
|
-
```
|
|
2925
|
-
|
|
2926
|
-
### Standalone function
|
|
2927
|
-
|
|
2928
|
-
The standalone function version of this method:
|
|
2929
|
-
|
|
2930
|
-
```typescript
|
|
2931
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
2932
|
-
import { postV1OrganizationsByIdCredits } from "@indiciaosint/sdk/funcs/post-v1-organizations-by-id-credits.js";
|
|
2933
|
-
|
|
2934
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
2935
|
-
// You can create one instance of it to use across an application.
|
|
2936
|
-
const indicia = new IndiciaCore({
|
|
2937
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2938
|
-
});
|
|
2939
|
-
|
|
2940
|
-
async function run() {
|
|
2941
|
-
const res = await postV1OrganizationsByIdCredits(indicia, {
|
|
2942
|
-
id: "<id>",
|
|
2943
|
-
body: {
|
|
2944
|
-
creditsEach: 8955.74,
|
|
2945
|
-
recipientMemberIds: [
|
|
2946
|
-
"<value 1>",
|
|
2947
|
-
"<value 2>",
|
|
2948
|
-
],
|
|
2949
|
-
},
|
|
2950
|
-
});
|
|
2951
|
-
if (res.ok) {
|
|
2952
|
-
const { value: result } = res;
|
|
2953
|
-
console.log(result);
|
|
2954
|
-
} else {
|
|
2955
|
-
console.log("postV1OrganizationsByIdCredits failed:", res.error);
|
|
2956
|
-
}
|
|
2957
|
-
}
|
|
2958
|
-
|
|
2959
|
-
run();
|
|
2960
|
-
```
|
|
2961
|
-
|
|
2962
|
-
### Parameters
|
|
2963
|
-
|
|
2964
|
-
| Parameter | Type | Required | Description |
|
|
2965
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2966
|
-
| `request` | [operations.PostV1OrganizationsByIdCreditsRequest](../../models/operations/post-v1-organizations-by-id-credits-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2967
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2968
|
-
| `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. |
|
|
2969
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2970
|
-
|
|
2971
|
-
### Response
|
|
2972
|
-
|
|
2973
|
-
**Promise\<[operations.PostV1OrganizationsByIdCreditsResponse](../../models/operations/post-v1-organizations-by-id-credits-response.md)\>**
|
|
2974
|
-
|
|
2975
|
-
### Errors
|
|
2976
|
-
|
|
2977
|
-
| Error Type | Status Code | Content Type |
|
|
2978
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
2979
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|
|
2980
|
-
|
|
2981
|
-
## postV2SearchSocialsUsername
|
|
2982
|
-
|
|
2983
|
-
Search various sites for a specific username
|
|
2984
|
-
|
|
2985
|
-
### Example Usage
|
|
2986
|
-
|
|
2987
|
-
<!-- UsageSnippet language="typescript" operationID="postV2SearchSocialsUsername" method="post" path="/v2/search/socials/username" -->
|
|
2988
|
-
```typescript
|
|
2989
|
-
import { Indicia } from "@indiciaosint/sdk";
|
|
2990
|
-
|
|
2991
|
-
const indicia = new Indicia({
|
|
2992
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
2993
|
-
});
|
|
2994
|
-
|
|
2995
|
-
async function run() {
|
|
2996
|
-
const result = await indicia.postV2SearchSocialsUsername({
|
|
2997
|
-
query: "<value>",
|
|
2998
|
-
});
|
|
2999
|
-
|
|
3000
|
-
console.log(result);
|
|
3001
|
-
}
|
|
3002
|
-
|
|
3003
|
-
run();
|
|
3004
|
-
```
|
|
3005
|
-
|
|
3006
|
-
### Standalone function
|
|
3007
|
-
|
|
3008
|
-
The standalone function version of this method:
|
|
3009
|
-
|
|
3010
|
-
```typescript
|
|
3011
|
-
import { IndiciaCore } from "@indiciaosint/sdk/core.js";
|
|
3012
|
-
import { postV2SearchSocialsUsername } from "@indiciaosint/sdk/funcs/post-v2-search-socials-username.js";
|
|
3013
|
-
|
|
3014
|
-
// Use `IndiciaCore` for best tree-shaking performance.
|
|
3015
|
-
// You can create one instance of it to use across an application.
|
|
3016
|
-
const indicia = new IndiciaCore({
|
|
3017
|
-
apiKeyAuth: process.env["INDICIA_API_KEY_AUTH"] ?? "",
|
|
3018
|
-
});
|
|
3019
|
-
|
|
3020
|
-
async function run() {
|
|
3021
|
-
const res = await postV2SearchSocialsUsername(indicia, {
|
|
3022
|
-
query: "<value>",
|
|
3023
|
-
});
|
|
3024
|
-
if (res.ok) {
|
|
3025
|
-
const { value: result } = res;
|
|
3026
|
-
console.log(result);
|
|
3027
|
-
} else {
|
|
3028
|
-
console.log("postV2SearchSocialsUsername failed:", res.error);
|
|
3029
|
-
}
|
|
3030
|
-
}
|
|
3031
|
-
|
|
3032
|
-
run();
|
|
3033
|
-
```
|
|
3034
|
-
|
|
3035
|
-
### Parameters
|
|
3036
|
-
|
|
3037
|
-
| Parameter | Type | Required | Description |
|
|
3038
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3039
|
-
| `request` | [operations.PostV2SearchSocialsUsernameRequest](../../models/operations/post-v2-search-socials-username-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3040
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3041
|
-
| `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. |
|
|
3042
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3043
|
-
|
|
3044
|
-
### Response
|
|
3045
|
-
|
|
3046
|
-
**Promise\<[operations.PostV2SearchSocialsUsernameResponse](../../models/operations/post-v2-search-socials-username-response.md)\>**
|
|
3047
|
-
|
|
3048
|
-
### Errors
|
|
3049
|
-
|
|
3050
|
-
| Error Type | Status Code | Content Type |
|
|
3051
|
-
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
|
3052
|
-
| errors.PostV2SearchSocialsUsernameInternalServerError | 500 | application/json |
|
|
3053
|
-
| errors.IndiciaDefaultError | 4XX, 5XX | \*/\* |
|