influship 0.2.0 → 0.3.2
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/CHANGELOG.md +62 -30
- package/LICENSE +1 -1
- package/README.md +88 -43
- package/client.d.mts +49 -29
- package/client.d.mts.map +1 -1
- package/client.d.ts +49 -29
- package/client.d.ts.map +1 -1
- package/client.js +89 -56
- package/client.js.map +1 -1
- package/client.mjs +89 -56
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts +2 -2
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts +2 -2
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.js.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.d.mts +2 -2
- package/core/error.d.mts.map +1 -1
- package/core/error.d.ts +2 -2
- package/core/error.d.ts.map +1 -1
- package/core/error.js +4 -4
- package/core/error.js.map +1 -1
- package/core/error.mjs +2 -2
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts +75 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +75 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +139 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +132 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +3 -3
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts +3 -3
- package/core/resource.d.ts.map +1 -1
- package/core/resource.js.map +1 -1
- package/core/resource.mjs.map +1 -1
- package/index.d.mts +4 -3
- package/index.d.mts.map +1 -1
- package/index.d.ts +4 -3
- package/index.d.ts.map +1 -1
- package/index.js +6 -4
- package/index.js.map +1 -1
- package/index.mjs +4 -3
- package/index.mjs.map +1 -1
- package/internal/parse.d.mts +2 -2
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts +2 -2
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +5 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +5 -0
- package/internal/parse.mjs.map +1 -1
- package/internal/shims.js +1 -1
- package/internal/shims.js.map +1 -1
- package/internal/shims.mjs +1 -1
- package/internal/shims.mjs.map +1 -1
- package/internal/tslib.js +17 -17
- package/internal/uploads.d.mts +4 -4
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts +4 -4
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.js +2 -2
- package/internal/utils/base64.js.map +1 -1
- package/internal/utils/base64.mjs +3 -3
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts +3 -3
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts +3 -3
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.js +1 -1
- package/internal/utils/path.js.map +1 -1
- package/internal/utils/path.mjs +2 -2
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.d.mts +2 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +2 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +10 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +6 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils/values.js +5 -5
- package/internal/utils/values.js.map +1 -1
- package/internal/utils/values.mjs +6 -6
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts +1 -0
- package/internal/utils.d.ts +1 -0
- package/internal/utils.js +1 -0
- package/internal/utils.js.map +1 -1
- package/internal/utils.mjs +1 -0
- package/package.json +24 -3
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/creators.d.mts +326 -247
- package/resources/creators.d.mts.map +1 -1
- package/resources/creators.d.ts +326 -247
- package/resources/creators.d.ts.map +1 -1
- package/resources/creators.js +80 -63
- package/resources/creators.js.map +1 -1
- package/resources/creators.mjs +80 -63
- package/resources/creators.mjs.map +1 -1
- package/resources/health.d.mts +13 -1
- package/resources/health.d.mts.map +1 -1
- package/resources/health.d.ts +13 -1
- package/resources/health.d.ts.map +1 -1
- package/resources/health.js +4 -1
- package/resources/health.js.map +1 -1
- package/resources/health.mjs +4 -1
- package/resources/health.mjs.map +1 -1
- package/resources/index.d.mts +6 -7
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -7
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -3
- package/resources/index.mjs.map +1 -1
- package/resources/posts.d.mts +82 -202
- package/resources/posts.d.mts.map +1 -1
- package/resources/posts.d.ts +82 -202
- package/resources/posts.d.ts.map +1 -1
- package/resources/posts.js +17 -38
- package/resources/posts.js.map +1 -1
- package/resources/posts.mjs +17 -38
- package/resources/posts.mjs.map +1 -1
- package/resources/profiles.d.mts +208 -58
- package/resources/profiles.d.mts.map +1 -1
- package/resources/profiles.d.ts +208 -58
- package/resources/profiles.d.ts.map +1 -1
- package/resources/profiles.js +37 -41
- package/resources/profiles.js.map +1 -1
- package/resources/profiles.mjs +37 -41
- package/resources/profiles.mjs.map +1 -1
- package/resources/raw/index.d.mts +4 -0
- package/resources/raw/index.d.mts.map +1 -0
- package/resources/raw/index.d.ts +4 -0
- package/resources/raw/index.d.ts.map +1 -0
- package/resources/raw/index.js +11 -0
- package/resources/raw/index.js.map +1 -0
- package/resources/raw/index.mjs +5 -0
- package/resources/raw/index.mjs.map +1 -0
- package/resources/raw/instagram.d.mts +215 -0
- package/resources/raw/instagram.d.mts.map +1 -0
- package/resources/raw/instagram.d.ts +215 -0
- package/resources/raw/instagram.d.ts.map +1 -0
- package/resources/raw/instagram.js +31 -0
- package/resources/raw/instagram.js.map +1 -0
- package/resources/raw/instagram.mjs +27 -0
- package/resources/raw/instagram.mjs.map +1 -0
- package/resources/raw/raw.d.mts +14 -0
- package/resources/raw/raw.d.mts.map +1 -0
- package/resources/raw/raw.d.ts +14 -0
- package/resources/raw/raw.d.ts.map +1 -0
- package/resources/raw/raw.js +21 -0
- package/resources/raw/raw.js.map +1 -0
- package/resources/raw/raw.mjs +16 -0
- package/resources/raw/raw.mjs.map +1 -0
- package/resources/raw/youtube.d.mts +455 -0
- package/resources/raw/youtube.d.mts.map +1 -0
- package/resources/raw/youtube.d.ts +455 -0
- package/resources/raw/youtube.d.ts.map +1 -0
- package/resources/raw/youtube.js +61 -0
- package/resources/raw/youtube.js.map +1 -0
- package/resources/raw/youtube.mjs +57 -0
- package/resources/raw/youtube.mjs.map +1 -0
- package/resources/raw.d.mts +2 -0
- package/resources/raw.d.mts.map +1 -0
- package/resources/raw.d.ts +2 -0
- package/resources/raw.d.ts.map +1 -0
- package/resources/raw.js +6 -0
- package/resources/raw.js.map +1 -0
- package/resources/raw.mjs +3 -0
- package/resources/raw.mjs.map +1 -0
- package/resources/search.d.mts +126 -117
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +126 -117
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +46 -13
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +46 -13
- package/resources/search.mjs.map +1 -1
- package/resources/shared.d.mts +55 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +55 -0
- package/resources/shared.d.ts.map +1 -0
- package/resources/shared.js +4 -0
- package/resources/shared.js.map +1 -0
- package/resources/shared.mjs +3 -0
- package/resources/shared.mjs.map +1 -0
- package/src/client.ts +153 -127
- package/src/core/api-promise.ts +4 -4
- package/src/core/error.ts +2 -2
- package/src/core/pagination.ts +232 -0
- package/src/core/resource.ts +3 -3
- package/src/index.ts +4 -3
- package/src/internal/parse.ts +8 -2
- package/src/internal/shims.ts +1 -1
- package/src/internal/uploads.ts +5 -5
- package/src/internal/utils/base64.ts +3 -3
- package/src/internal/utils/log.ts +3 -3
- package/src/internal/utils/path.ts +2 -2
- package/src/internal/utils/query.ts +7 -0
- package/src/internal/utils/values.ts +6 -6
- package/src/internal/utils.ts +1 -0
- package/src/pagination.ts +2 -0
- package/src/resources/creators.ts +369 -271
- package/src/resources/health.ts +13 -1
- package/src/resources/index.ts +22 -41
- package/src/resources/posts.ts +89 -232
- package/src/resources/profiles.ts +252 -59
- package/src/resources/raw/index.ts +16 -0
- package/src/resources/raw/instagram.ts +271 -0
- package/src/resources/raw/raw.ts +47 -0
- package/src/resources/raw/youtube.ts +585 -0
- package/src/resources/raw.ts +3 -0
- package/src/resources/search.ts +145 -131
- package/src/resources/shared.ts +66 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/brand-safety.d.mts +0 -234
- package/resources/brand-safety.d.mts.map +0 -1
- package/resources/brand-safety.d.ts +0 -234
- package/resources/brand-safety.d.ts.map +0 -1
- package/resources/brand-safety.js +0 -75
- package/resources/brand-safety.js.map +0 -1
- package/resources/brand-safety.mjs +0 -71
- package/resources/brand-safety.mjs.map +0 -1
- package/resources/lookalike.d.mts +0 -142
- package/resources/lookalike.d.mts.map +0 -1
- package/resources/lookalike.d.ts +0 -142
- package/resources/lookalike.d.ts.map +0 -1
- package/resources/lookalike.js +0 -28
- package/resources/lookalike.js.map +0 -1
- package/resources/lookalike.mjs +0 -24
- package/resources/lookalike.mjs.map +0 -1
- package/resources/match.d.mts +0 -90
- package/resources/match.d.mts.map +0 -1
- package/resources/match.d.ts +0 -90
- package/resources/match.d.ts.map +0 -1
- package/resources/match.js +0 -22
- package/resources/match.js.map +0 -1
- package/resources/match.mjs +0 -18
- package/resources/match.mjs.map +0 -1
- package/src/resources/brand-safety.ts +0 -304
- package/src/resources/lookalike.ts +0 -186
- package/src/resources/match.ts +0 -115
package/CHANGELOG.md
CHANGED
|
@@ -1,51 +1,83 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## 0.2
|
|
3
|
+
## 0.3.2 (2026-03-17)
|
|
4
4
|
|
|
5
|
-
Full Changelog: [v0.1
|
|
5
|
+
Full Changelog: [v0.3.1...v0.3.2](https://github.com/Influship/influship-sdk-typescript/compare/v0.3.1...v0.3.2)
|
|
6
|
+
|
|
7
|
+
### Chores
|
|
8
|
+
|
|
9
|
+
* **internal:** bump @modelcontextprotocol/sdk, @hono/node-server, and minimatch ([f982b62](https://github.com/Influship/influship-sdk-typescript/commit/f982b629275ba9ce6abd60ae9c9cb59e420755df))
|
|
10
|
+
* **internal:** configure MCP Server hosting ([46301f2](https://github.com/Influship/influship-sdk-typescript/commit/46301f201ba7f4b3c4173855c94f1c1aac1b043e))
|
|
11
|
+
* **internal:** make generated MCP servers compatible with Cloudflare worker environments ([fa720e6](https://github.com/Influship/influship-sdk-typescript/commit/fa720e63ebd09acf1127187623c4878b5ac94c1a))
|
|
12
|
+
* **internal:** support x-stainless-mcp-client-envs header in MCP servers ([e1812ff](https://github.com/Influship/influship-sdk-typescript/commit/e1812ff4868670826e684df0de46f7f791fc7c15))
|
|
13
|
+
* **internal:** support x-stainless-mcp-client-permissions headers in MCP servers ([2f71ccb](https://github.com/Influship/influship-sdk-typescript/commit/2f71ccb14971aa9ae2d09947a17523208e35b204))
|
|
14
|
+
* **internal:** tweak CI branches ([4e88652](https://github.com/Influship/influship-sdk-typescript/commit/4e886528b68bcbd8d321b6c12d683b4505f3742f))
|
|
15
|
+
* **internal:** update dependencies to address dependabot vulnerabilities ([16eae9a](https://github.com/Influship/influship-sdk-typescript/commit/16eae9a35d3f52ac0859aebac65e31e854856ea0))
|
|
16
|
+
|
|
17
|
+
## 0.3.1 (2026-03-08)
|
|
18
|
+
|
|
19
|
+
Full Changelog: [v0.3.0...v0.3.1](https://github.com/Influship/influship-sdk-typescript/compare/v0.3.0...v0.3.1)
|
|
20
|
+
|
|
21
|
+
### Chores
|
|
22
|
+
|
|
23
|
+
* update SDK settings ([8ae1e31](https://github.com/Influship/influship-sdk-typescript/commit/8ae1e319214344034e19b3cc79d21f53e2bce1b5))
|
|
24
|
+
|
|
25
|
+
## 0.3.0 (2026-03-08)
|
|
26
|
+
|
|
27
|
+
Full Changelog: [v0.2.0...v0.3.0](https://github.com/Influship/influship-sdk-typescript/compare/v0.2.0...v0.3.0)
|
|
6
28
|
|
|
7
29
|
### Features
|
|
8
30
|
|
|
9
|
-
* **api:**
|
|
10
|
-
* **api:**
|
|
11
|
-
*
|
|
12
|
-
* **
|
|
13
|
-
* **api:** change env var used for api key ([6415c9b](https://github.com/Influship/influship-sdk-typescript/commit/6415c9be86ac1d3328cc3cf5c7e2475a38f833a3))
|
|
14
|
-
* **mcp:** add detail field to docs search tool ([1706123](https://github.com/Influship/influship-sdk-typescript/commit/170612335b707eb1450898e6eb24e3519dbbb75b))
|
|
15
|
-
* **mcp:** enable optional code execution tool on http mcp servers ([f14531d](https://github.com/Influship/influship-sdk-typescript/commit/f14531d86d9f44d028306781d2d85853c1187ff8))
|
|
16
|
-
* **mcp:** return logs on code tool errors ([04cf723](https://github.com/Influship/influship-sdk-typescript/commit/04cf7236eb572bf866b79c2544b0d1831f7fb071))
|
|
31
|
+
* **api:** add pagination to creators lookalike method ([a6d63b7](https://github.com/Influship/influship-sdk-typescript/commit/a6d63b7eeb7474f56bdeeed3a8d4d98e1eeb0833))
|
|
32
|
+
* **api:** add search_id/total fields, remove cursor param from search ([2a276d0](https://github.com/Influship/influship-sdk-typescript/commit/2a276d03055bc939516505912d4b37e3f1308c08))
|
|
33
|
+
* Fix Stainless pagination and model warnings in SDK config ([98a9e10](https://github.com/Influship/influship-sdk-typescript/commit/98a9e1053b42e5c8ce3b1c1da227c5bc8f17fd31))
|
|
34
|
+
* **mcp:** add an option to disable code tool ([a49e2c9](https://github.com/Influship/influship-sdk-typescript/commit/a49e2c9b1bda3d73dd4b163f687a5206d1da783d))
|
|
17
35
|
|
|
18
36
|
|
|
19
37
|
### Bug Fixes
|
|
20
38
|
|
|
21
|
-
* **
|
|
22
|
-
* **mcp:**
|
|
23
|
-
* **mcp:** return tool execution error on jq failure ([8a66c5b](https://github.com/Influship/influship-sdk-typescript/commit/8a66c5b323c7be4307140c1907cd4d9e1efeae87))
|
|
39
|
+
* **client:** preserve URL params already embedded in path ([47c7a8c](https://github.com/Influship/influship-sdk-typescript/commit/47c7a8c32245d52f9e92c1cdfeaf9a8a0d7aec94))
|
|
40
|
+
* **mcp:** update prompt ([1cce5e6](https://github.com/Influship/influship-sdk-typescript/commit/1cce5e6caaa1ae512c9348b3fd61263940e598bc))
|
|
24
41
|
|
|
25
42
|
|
|
26
43
|
### Chores
|
|
27
44
|
|
|
28
|
-
* **
|
|
29
|
-
*
|
|
30
|
-
* **internal:** codegen related update ([
|
|
31
|
-
* **internal:**
|
|
32
|
-
* **internal:**
|
|
33
|
-
* **internal:**
|
|
34
|
-
* **
|
|
35
|
-
*
|
|
36
|
-
* **mcp:**
|
|
37
|
-
* **mcp:**
|
|
38
|
-
* **mcp:** clarify http auth error ([f700ede](https://github.com/Influship/influship-sdk-typescript/commit/f700ede563243911fab246a56cf8afdf08f89835))
|
|
39
|
-
* **mcp:** upgrade jq-web ([a08153b](https://github.com/Influship/influship-sdk-typescript/commit/a08153b739fe678a72ebeebb7ae629cffa74ad5a))
|
|
40
|
-
* remove custom code ([412eae4](https://github.com/Influship/influship-sdk-typescript/commit/412eae497dcbc2a287fcd8cde8aa69e5df55968b))
|
|
41
|
-
* update SDK settings ([4236774](https://github.com/Influship/influship-sdk-typescript/commit/4236774feb1073c924e40fa22679a2bf24baa66b))
|
|
42
|
-
* use structured error when code execution tool errors ([1eab7ff](https://github.com/Influship/influship-sdk-typescript/commit/1eab7ff78609ba799583c0a6698b1ba2c7e076a7))
|
|
45
|
+
* **ci:** skip uploading artifacts on stainless-internal branches ([a9b3ff7](https://github.com/Influship/influship-sdk-typescript/commit/a9b3ff7f05f6918eb76782a20dacff023822865c))
|
|
46
|
+
* **internal:** codegen related update ([a59d8ea](https://github.com/Influship/influship-sdk-typescript/commit/a59d8eab8c50a870eda2b1a4689960185fb1b582))
|
|
47
|
+
* **internal:** codegen related update ([198c7c3](https://github.com/Influship/influship-sdk-typescript/commit/198c7c3b741b8cb8fa2a11d7675e5eefe03e201d))
|
|
48
|
+
* **internal:** fix MCP Dockerfiles so they can be built without buildkit ([75a1b54](https://github.com/Influship/influship-sdk-typescript/commit/75a1b54d19e9e9e45aca756f67ab36843286d333))
|
|
49
|
+
* **internal:** fix MCP Dockerfiles so they can be built without buildkit ([c6a3043](https://github.com/Influship/influship-sdk-typescript/commit/c6a304380afa2e0d55b6c9db422c32b0474af626))
|
|
50
|
+
* **internal:** make MCP code execution location configurable via a flag ([b29bcf7](https://github.com/Influship/influship-sdk-typescript/commit/b29bcf775bd898322576430c8db485859b910d82))
|
|
51
|
+
* **internal:** move stringifyQuery implementation to internal function ([f13b42b](https://github.com/Influship/influship-sdk-typescript/commit/f13b42bdb740ed1bb1a13f2042f633d87c757c7b))
|
|
52
|
+
* **internal:** use x-stainless-mcp-client-envs header for MCP remote code tool calls ([b77057e](https://github.com/Influship/influship-sdk-typescript/commit/b77057e7d4371ea74c8638420950efac0ff4a44c))
|
|
53
|
+
* **mcp-server:** improve instructions ([48ab5b4](https://github.com/Influship/influship-sdk-typescript/commit/48ab5b423a0f8d23182afefcbab9c2da3addf0d4))
|
|
54
|
+
* **mcp-server:** return access instructions for 404 without API key ([8257c18](https://github.com/Influship/influship-sdk-typescript/commit/8257c18800bb3e656fe34dfe4a696cb16a0a211d))
|
|
43
55
|
|
|
44
56
|
|
|
45
57
|
### Documentation
|
|
46
58
|
|
|
47
|
-
* **
|
|
48
|
-
* **
|
|
59
|
+
* **api:** correct pricing comment in youtube.getChannel ([2997b86](https://github.com/Influship/influship-sdk-typescript/commit/2997b86c594545a67d6c4836bab2251ad5f00449))
|
|
60
|
+
* **api:** update pricing information ([331d003](https://github.com/Influship/influship-sdk-typescript/commit/331d0035f13f16cf65daf4525a3ebdf3f89810fd))
|
|
61
|
+
|
|
62
|
+
## 0.2.0 (2026-02-24)
|
|
63
|
+
|
|
64
|
+
Full Changelog: [v0.1.0...v0.2.0](https://github.com/influship/influship-sdk-typescript/compare/v0.1.0...v0.2.0)
|
|
65
|
+
|
|
66
|
+
### Features
|
|
67
|
+
|
|
68
|
+
* **api:** add instagram getProfile and youtube channel/transcript/search to raw ([abf8573](https://github.com/influship/influship-sdk-typescript/commit/abf85734a59c59b73c50f1541661bea8ecddc691))
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### Bug Fixes
|
|
72
|
+
|
|
73
|
+
* **docs/contributing:** correct pnpm link command ([c9409a6](https://github.com/influship/influship-sdk-typescript/commit/c9409a628bc918216cbb28d4e43e5cbd540b9274))
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### Chores
|
|
77
|
+
|
|
78
|
+
* **internal:** update repository references from inf-labs to influship ([375ee35](https://github.com/influship/influship-sdk-typescript/commit/375ee355691fcdc79aaa13d1648a73e6709f1634))
|
|
79
|
+
* **internal:** upgrade @modelcontextprotocol/sdk and hono ([2ffda1c](https://github.com/influship/influship-sdk-typescript/commit/2ffda1c7c32f8843f5cf03ba1cb97436b9d7b6a7))
|
|
80
|
+
* sync repo ([dab28ce](https://github.com/influship/influship-sdk-typescript/commit/dab28ce90d232523e49d57fdc94b6503efad30a4))
|
|
49
81
|
|
|
50
82
|
## 0.1.0 (2025-10-01)
|
|
51
83
|
|
package/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright 2026 Influship
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -1,13 +1,22 @@
|
|
|
1
|
-
# Influship
|
|
1
|
+
# Influship TypeScript API Library
|
|
2
2
|
|
|
3
3
|
[>)](https://npmjs.org/package/influship) 
|
|
4
4
|
|
|
5
|
-
This library provides convenient access to the Influship
|
|
5
|
+
This library provides convenient access to the Influship REST API from server-side TypeScript or JavaScript.
|
|
6
6
|
|
|
7
|
-
The REST API documentation can be found on [
|
|
7
|
+
The REST API documentation can be found on [influship.mintlify.app](https://influship.mintlify.app). The full API of this library can be found in [api.md](api.md).
|
|
8
8
|
|
|
9
9
|
It is generated with [Stainless](https://www.stainless.com/).
|
|
10
10
|
|
|
11
|
+
## MCP Server
|
|
12
|
+
|
|
13
|
+
Use the Influship MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
|
|
14
|
+
|
|
15
|
+
[](https://cursor.com/en-US/install-mcp?name=influship-mcp&config=eyJuYW1lIjoiaW5mbHVzaGlwLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL2luZmx1c2hpcC1hcGkuc3RsbWNwLmNvbSIsImhlYWRlcnMiOnsiWC1BUEktS2V5IjoiTXkgQVBJIEtleSJ9fQ)
|
|
16
|
+
[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22influship-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Finfluship-api.stlmcp.com%22%2C%22headers%22%3A%7B%22X-API-Key%22%3A%22My%20API%20Key%22%7D%7D)
|
|
17
|
+
|
|
18
|
+
> Note: You may need to set environment variables in your MCP client.
|
|
19
|
+
|
|
11
20
|
## Installation
|
|
12
21
|
|
|
13
22
|
```sh
|
|
@@ -20,19 +29,18 @@ The full API of this library can be found in [api.md](api.md).
|
|
|
20
29
|
|
|
21
30
|
<!-- prettier-ignore -->
|
|
22
31
|
```js
|
|
23
|
-
import
|
|
32
|
+
import Influship from 'influship';
|
|
24
33
|
|
|
25
|
-
const client = new
|
|
34
|
+
const client = new Influship({
|
|
26
35
|
apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
|
|
27
36
|
});
|
|
28
37
|
|
|
29
|
-
const
|
|
30
|
-
query: '
|
|
31
|
-
limit:
|
|
32
|
-
mode: 'detailed',
|
|
38
|
+
const search = await client.search.create({
|
|
39
|
+
query: 'sustainable fashion creators with engaged audiences',
|
|
40
|
+
limit: 25,
|
|
33
41
|
});
|
|
34
42
|
|
|
35
|
-
console.log(
|
|
43
|
+
console.log(search.search_id);
|
|
36
44
|
```
|
|
37
45
|
|
|
38
46
|
### Request & Response types
|
|
@@ -41,17 +49,17 @@ This library includes TypeScript definitions for all request params and response
|
|
|
41
49
|
|
|
42
50
|
<!-- prettier-ignore -->
|
|
43
51
|
```ts
|
|
44
|
-
import
|
|
52
|
+
import Influship from 'influship';
|
|
45
53
|
|
|
46
|
-
const client = new
|
|
54
|
+
const client = new Influship({
|
|
47
55
|
apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
|
|
48
56
|
});
|
|
49
57
|
|
|
50
|
-
const params:
|
|
58
|
+
const params: Influship.SearchCreateParams = {
|
|
51
59
|
query: 'fitness influencers in Los Angeles',
|
|
52
60
|
limit: 10,
|
|
53
61
|
};
|
|
54
|
-
const
|
|
62
|
+
const search: Influship.SearchCreateResponse = await client.search.create(params);
|
|
55
63
|
```
|
|
56
64
|
|
|
57
65
|
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
|
|
@@ -64,10 +72,10 @@ a subclass of `APIError` will be thrown:
|
|
|
64
72
|
|
|
65
73
|
<!-- prettier-ignore -->
|
|
66
74
|
```ts
|
|
67
|
-
const
|
|
68
|
-
.
|
|
75
|
+
const search = await client.search
|
|
76
|
+
.create({ query: 'fitness influencers in Los Angeles', limit: 10 })
|
|
69
77
|
.catch(async (err) => {
|
|
70
|
-
if (err instanceof
|
|
78
|
+
if (err instanceof Influship.APIError) {
|
|
71
79
|
console.log(err.status); // 400
|
|
72
80
|
console.log(err.name); // BadRequestError
|
|
73
81
|
console.log(err.headers); // {server: 'nginx', ...}
|
|
@@ -101,12 +109,12 @@ You can use the `maxRetries` option to configure or disable this:
|
|
|
101
109
|
<!-- prettier-ignore -->
|
|
102
110
|
```js
|
|
103
111
|
// Configure the default for all requests:
|
|
104
|
-
const client = new
|
|
112
|
+
const client = new Influship({
|
|
105
113
|
maxRetries: 0, // default is 2
|
|
106
114
|
});
|
|
107
115
|
|
|
108
116
|
// Or, configure per-request:
|
|
109
|
-
await client.search.
|
|
117
|
+
await client.search.create({ query: 'fitness influencers in Los Angeles', limit: 10 }, {
|
|
110
118
|
maxRetries: 5,
|
|
111
119
|
});
|
|
112
120
|
```
|
|
@@ -118,12 +126,12 @@ Requests time out after 1 minute by default. You can configure this with a `time
|
|
|
118
126
|
<!-- prettier-ignore -->
|
|
119
127
|
```ts
|
|
120
128
|
// Configure the default for all requests:
|
|
121
|
-
const client = new
|
|
129
|
+
const client = new Influship({
|
|
122
130
|
timeout: 20 * 1000, // 20 seconds (default is 1 minute)
|
|
123
131
|
});
|
|
124
132
|
|
|
125
133
|
// Override per-request:
|
|
126
|
-
await client.search.
|
|
134
|
+
await client.search.create({ query: 'fitness influencers in Los Angeles', limit: 10 }, {
|
|
127
135
|
timeout: 5 * 1000,
|
|
128
136
|
});
|
|
129
137
|
```
|
|
@@ -132,6 +140,43 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
|
|
|
132
140
|
|
|
133
141
|
Note that requests which time out will be [retried twice by default](#retries).
|
|
134
142
|
|
|
143
|
+
## Auto-pagination
|
|
144
|
+
|
|
145
|
+
List methods in the Influship API are paginated.
|
|
146
|
+
You can use the `for await … of` syntax to iterate through items across all pages:
|
|
147
|
+
|
|
148
|
+
```ts
|
|
149
|
+
async function fetchAllSearchRetrieveResponses(params) {
|
|
150
|
+
const allSearchRetrieveResponses = [];
|
|
151
|
+
// Automatically fetches more pages as needed.
|
|
152
|
+
for await (const searchRetrieveResponse of client.search.retrieve('search_abc123', {
|
|
153
|
+
cursor: 'eyJvZmZzZXQiOjEwfQ==',
|
|
154
|
+
limit: 10,
|
|
155
|
+
})) {
|
|
156
|
+
allSearchRetrieveResponses.push(searchRetrieveResponse);
|
|
157
|
+
}
|
|
158
|
+
return allSearchRetrieveResponses;
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Alternatively, you can request a single page at a time:
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
let page = await client.search.retrieve('search_abc123', {
|
|
166
|
+
cursor: 'eyJvZmZzZXQiOjEwfQ==',
|
|
167
|
+
limit: 10,
|
|
168
|
+
});
|
|
169
|
+
for (const searchRetrieveResponse of page.data) {
|
|
170
|
+
console.log(searchRetrieveResponse);
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
// Convenience methods are provided for manually paginating:
|
|
174
|
+
while (page.hasNextPage()) {
|
|
175
|
+
page = await page.getNextPage();
|
|
176
|
+
// ...
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
|
|
135
180
|
## Advanced Usage
|
|
136
181
|
|
|
137
182
|
### Accessing raw Response data (e.g., headers)
|
|
@@ -144,19 +189,19 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
|
|
|
144
189
|
|
|
145
190
|
<!-- prettier-ignore -->
|
|
146
191
|
```ts
|
|
147
|
-
const client = new
|
|
192
|
+
const client = new Influship();
|
|
148
193
|
|
|
149
194
|
const response = await client.search
|
|
150
|
-
.
|
|
195
|
+
.create({ query: 'fitness influencers in Los Angeles', limit: 10 })
|
|
151
196
|
.asResponse();
|
|
152
197
|
console.log(response.headers.get('X-My-Header'));
|
|
153
198
|
console.log(response.statusText); // access the underlying Response object
|
|
154
199
|
|
|
155
|
-
const { data:
|
|
156
|
-
.
|
|
200
|
+
const { data: search, response: raw } = await client.search
|
|
201
|
+
.create({ query: 'fitness influencers in Los Angeles', limit: 10 })
|
|
157
202
|
.withResponse();
|
|
158
203
|
console.log(raw.headers.get('X-My-Header'));
|
|
159
|
-
console.log(
|
|
204
|
+
console.log(search.search_id);
|
|
160
205
|
```
|
|
161
206
|
|
|
162
207
|
### Logging
|
|
@@ -169,13 +214,13 @@ console.log(response.filtered_total);
|
|
|
169
214
|
|
|
170
215
|
The log level can be configured in two ways:
|
|
171
216
|
|
|
172
|
-
1. Via the `
|
|
217
|
+
1. Via the `INFLUSHIP_LOG` environment variable
|
|
173
218
|
2. Using the `logLevel` client option (overrides the environment variable if set)
|
|
174
219
|
|
|
175
220
|
```ts
|
|
176
|
-
import
|
|
221
|
+
import Influship from 'influship';
|
|
177
222
|
|
|
178
|
-
const client = new
|
|
223
|
+
const client = new Influship({
|
|
179
224
|
logLevel: 'debug', // Show all log messages
|
|
180
225
|
});
|
|
181
226
|
```
|
|
@@ -201,13 +246,13 @@ When providing a custom logger, the `logLevel` option still controls which messa
|
|
|
201
246
|
below the configured level will not be sent to your logger.
|
|
202
247
|
|
|
203
248
|
```ts
|
|
204
|
-
import
|
|
249
|
+
import Influship from 'influship';
|
|
205
250
|
import pino from 'pino';
|
|
206
251
|
|
|
207
252
|
const logger = pino();
|
|
208
253
|
|
|
209
|
-
const client = new
|
|
210
|
-
logger: logger.child({ name: '
|
|
254
|
+
const client = new Influship({
|
|
255
|
+
logger: logger.child({ name: 'Influship' }),
|
|
211
256
|
logLevel: 'debug', // Send all messages to pino, allowing it to filter
|
|
212
257
|
});
|
|
213
258
|
```
|
|
@@ -236,7 +281,7 @@ parameter. This library doesn't validate at runtime that the request matches the
|
|
|
236
281
|
send will be sent as-is.
|
|
237
282
|
|
|
238
283
|
```ts
|
|
239
|
-
client.search.
|
|
284
|
+
client.search.create({
|
|
240
285
|
// ...
|
|
241
286
|
// @ts-expect-error baz is not yet public
|
|
242
287
|
baz: 'undocumented option',
|
|
@@ -270,10 +315,10 @@ globalThis.fetch = fetch;
|
|
|
270
315
|
Or pass it to the client:
|
|
271
316
|
|
|
272
317
|
```ts
|
|
273
|
-
import
|
|
318
|
+
import Influship from 'influship';
|
|
274
319
|
import fetch from 'my-fetch';
|
|
275
320
|
|
|
276
|
-
const client = new
|
|
321
|
+
const client = new Influship({ fetch });
|
|
277
322
|
```
|
|
278
323
|
|
|
279
324
|
### Fetch options
|
|
@@ -281,9 +326,9 @@ const client = new InflushipAPI({ fetch });
|
|
|
281
326
|
If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
|
|
282
327
|
|
|
283
328
|
```ts
|
|
284
|
-
import
|
|
329
|
+
import Influship from 'influship';
|
|
285
330
|
|
|
286
|
-
const client = new
|
|
331
|
+
const client = new Influship({
|
|
287
332
|
fetchOptions: {
|
|
288
333
|
// `RequestInit` options
|
|
289
334
|
},
|
|
@@ -298,11 +343,11 @@ options to requests:
|
|
|
298
343
|
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
|
|
299
344
|
|
|
300
345
|
```ts
|
|
301
|
-
import
|
|
346
|
+
import Influship from 'influship';
|
|
302
347
|
import * as undici from 'undici';
|
|
303
348
|
|
|
304
349
|
const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
|
|
305
|
-
const client = new
|
|
350
|
+
const client = new Influship({
|
|
306
351
|
fetchOptions: {
|
|
307
352
|
dispatcher: proxyAgent,
|
|
308
353
|
},
|
|
@@ -312,9 +357,9 @@ const client = new InflushipAPI({
|
|
|
312
357
|
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
|
|
313
358
|
|
|
314
359
|
```ts
|
|
315
|
-
import
|
|
360
|
+
import Influship from 'influship';
|
|
316
361
|
|
|
317
|
-
const client = new
|
|
362
|
+
const client = new Influship({
|
|
318
363
|
fetchOptions: {
|
|
319
364
|
proxy: 'http://localhost:8888',
|
|
320
365
|
},
|
|
@@ -324,10 +369,10 @@ const client = new InflushipAPI({
|
|
|
324
369
|
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
|
|
325
370
|
|
|
326
371
|
```ts
|
|
327
|
-
import
|
|
372
|
+
import Influship from 'npm:influship';
|
|
328
373
|
|
|
329
374
|
const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
|
|
330
|
-
const client = new
|
|
375
|
+
const client = new Influship({
|
|
331
376
|
fetchOptions: {
|
|
332
377
|
client: httpClient,
|
|
333
378
|
},
|
package/client.d.mts
CHANGED
|
@@ -3,30 +3,30 @@ import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./
|
|
|
3
3
|
export type { Logger, LogLevel } from "./internal/utils/log.mjs";
|
|
4
4
|
import * as Opts from "./internal/request-options.mjs";
|
|
5
5
|
import * as Errors from "./core/error.mjs";
|
|
6
|
+
import * as Pagination from "./core/pagination.mjs";
|
|
7
|
+
import { type BodyCursorParams, BodyCursorResponse, type QueryCursorParams, QueryCursorResponse } from "./core/pagination.mjs";
|
|
6
8
|
import * as Uploads from "./core/uploads.mjs";
|
|
7
9
|
import * as API from "./resources/index.mjs";
|
|
8
10
|
import { APIPromise } from "./core/api-promise.mjs";
|
|
9
|
-
import {
|
|
10
|
-
import { Creator, CreatorAutocomplete, CreatorAutocompleteParams, CreatorAutocompleteResponse, CreatorListProfilesParams, CreatorListProfilesResponse, CreatorRetrieveParams, CreatorRetrieveResponse, Creators, SocialAccountDetailed, SocialAccountLite } from "./resources/creators.mjs";
|
|
11
|
+
import { CreatorAutocompleteParams, CreatorAutocompleteResponse, CreatorLookalikeParams, CreatorLookalikeResponse, CreatorLookalikeResponsesBodyCursor, CreatorMatchParams, CreatorMatchResponse, CreatorRetrieveParams, CreatorRetrieveResponse, Creators } from "./resources/creators.mjs";
|
|
11
12
|
import { Health, HealthCheckResponse } from "./resources/health.mjs";
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import { Search, SearchFindCreatorsParams, SearchFindCreatorsResponse, SearchItem } from "./resources/search.mjs";
|
|
13
|
+
import { PostListParams, PostListResponse, PostListResponsesQueryCursor, Posts } from "./resources/posts.mjs";
|
|
14
|
+
import { ProfileActivity, ProfileGetParams, ProfileGetResponse, ProfileGrowth, ProfileLookupParams, ProfileLookupResponse, ProfileMetrics, ProfileResponseData, Profiles } from "./resources/profiles.mjs";
|
|
15
|
+
import { MatchInfo, Search, SearchCreateParams, SearchCreateResponse, SearchRetrieveParams, SearchRetrieveResponse, SearchRetrieveResponsesQueryCursor } from "./resources/search.mjs";
|
|
16
|
+
import { Raw } from "./resources/raw/raw.mjs";
|
|
17
17
|
import { type Fetch } from "./internal/builtin-types.mjs";
|
|
18
18
|
import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
|
|
19
19
|
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
|
|
20
20
|
import { type LogLevel, type Logger } from "./internal/utils/log.mjs";
|
|
21
21
|
export interface ClientOptions {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Defaults to process.env['INFLUSHIP_API_KEY'].
|
|
24
24
|
*/
|
|
25
25
|
apiKey?: string | undefined;
|
|
26
26
|
/**
|
|
27
27
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
28
28
|
*
|
|
29
|
-
* Defaults to process.env['
|
|
29
|
+
* Defaults to process.env['INFLUSHIP_BASE_URL'].
|
|
30
30
|
*/
|
|
31
31
|
baseURL?: string | null | undefined;
|
|
32
32
|
/**
|
|
@@ -74,7 +74,7 @@ export interface ClientOptions {
|
|
|
74
74
|
/**
|
|
75
75
|
* Set the log level.
|
|
76
76
|
*
|
|
77
|
-
* Defaults to process.env['
|
|
77
|
+
* Defaults to process.env['INFLUSHIP_LOG'] or 'warn' if it isn't set.
|
|
78
78
|
*/
|
|
79
79
|
logLevel?: LogLevel | undefined;
|
|
80
80
|
/**
|
|
@@ -85,9 +85,9 @@ export interface ClientOptions {
|
|
|
85
85
|
logger?: Logger | undefined;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* API Client for interfacing with the Influship API
|
|
88
|
+
* API Client for interfacing with the Influship API.
|
|
89
89
|
*/
|
|
90
|
-
export declare class
|
|
90
|
+
export declare class Influship {
|
|
91
91
|
#private;
|
|
92
92
|
apiKey: string;
|
|
93
93
|
baseURL: string;
|
|
@@ -100,10 +100,10 @@ export declare class InflushipAPI {
|
|
|
100
100
|
protected idempotencyHeader?: string;
|
|
101
101
|
private _options;
|
|
102
102
|
/**
|
|
103
|
-
* API Client for interfacing with the Influship API
|
|
103
|
+
* API Client for interfacing with the Influship API.
|
|
104
104
|
*
|
|
105
105
|
* @param {string | undefined} [opts.apiKey=process.env['INFLUSHIP_API_KEY'] ?? undefined]
|
|
106
|
-
* @param {string} [opts.baseURL=process.env['
|
|
106
|
+
* @param {string} [opts.baseURL=process.env['INFLUSHIP_BASE_URL'] ?? https://api.influship.com] - Override the default base URL for the API.
|
|
107
107
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
108
108
|
* @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
|
|
109
109
|
* @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -119,7 +119,7 @@ export declare class InflushipAPI {
|
|
|
119
119
|
protected defaultQuery(): Record<string, string | undefined> | undefined;
|
|
120
120
|
protected validateHeaders({ values, nulls }: NullableHeaders): void;
|
|
121
121
|
protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
|
|
122
|
-
protected stringifyQuery(query: Record<string, unknown>): string;
|
|
122
|
+
protected stringifyQuery(query: object | Record<string, unknown>): string;
|
|
123
123
|
private getUserAgent;
|
|
124
124
|
protected defaultIdempotencyKey(): string;
|
|
125
125
|
protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
|
|
@@ -146,6 +146,8 @@ export declare class InflushipAPI {
|
|
|
146
146
|
private methodRequest;
|
|
147
147
|
request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
|
|
148
148
|
private makeRequest;
|
|
149
|
+
getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(path: string, Page: new (...args: any[]) => PageClass, opts?: PromiseOrValue<RequestOptions>): Pagination.PagePromise<PageClass, Item>;
|
|
150
|
+
requestAPIList<Item = unknown, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass, options: PromiseOrValue<FinalRequestOptions>): Pagination.PagePromise<PageClass, Item>;
|
|
149
151
|
fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
|
|
150
152
|
private shouldRetry;
|
|
151
153
|
private retryRequest;
|
|
@@ -158,10 +160,11 @@ export declare class InflushipAPI {
|
|
|
158
160
|
timeout: number;
|
|
159
161
|
}>;
|
|
160
162
|
private buildHeaders;
|
|
163
|
+
private _makeAbort;
|
|
161
164
|
private buildBody;
|
|
162
|
-
static
|
|
165
|
+
static Influship: typeof Influship;
|
|
163
166
|
static DEFAULT_TIMEOUT: number;
|
|
164
|
-
static
|
|
167
|
+
static InflushipError: typeof Errors.InflushipError;
|
|
165
168
|
static APIError: typeof Errors.APIError;
|
|
166
169
|
static APIConnectionError: typeof Errors.APIConnectionError;
|
|
167
170
|
static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
|
|
@@ -175,24 +178,41 @@ export declare class InflushipAPI {
|
|
|
175
178
|
static PermissionDeniedError: typeof Errors.PermissionDeniedError;
|
|
176
179
|
static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
177
180
|
static toFile: typeof Uploads.toFile;
|
|
181
|
+
/**
|
|
182
|
+
* API health and status endpoints
|
|
183
|
+
*/
|
|
178
184
|
health: API.Health;
|
|
179
|
-
|
|
185
|
+
/**
|
|
186
|
+
* Retrieve creator profiles and discover new creators through search, autocomplete, and lookalike matching. Creators are cross-platform entities that may have profiles on multiple social networks.
|
|
187
|
+
*/
|
|
180
188
|
creators: API.Creators;
|
|
189
|
+
/**
|
|
190
|
+
* AI-powered semantic search to find creators using natural language queries. Understands intent and context to match creators based on content themes, audience, and style.
|
|
191
|
+
*/
|
|
192
|
+
search: API.Search;
|
|
193
|
+
/**
|
|
194
|
+
* Access individual social media profiles with detailed metrics, growth data, and activity information. Profiles are platform-specific accounts linked to creators.
|
|
195
|
+
*/
|
|
181
196
|
profiles: API.Profiles;
|
|
182
|
-
|
|
197
|
+
/**
|
|
198
|
+
* Retrieve and analyze social media posts with engagement metrics, media content, and performance data.
|
|
199
|
+
*/
|
|
183
200
|
posts: API.Posts;
|
|
184
|
-
|
|
185
|
-
brandSafety: API.BrandSafety;
|
|
201
|
+
raw: API.Raw;
|
|
186
202
|
}
|
|
187
|
-
export declare namespace
|
|
203
|
+
export declare namespace Influship {
|
|
188
204
|
export type RequestOptions = Opts.RequestOptions;
|
|
205
|
+
export import QueryCursor = Pagination.QueryCursor;
|
|
206
|
+
export { type QueryCursorParams as QueryCursorParams, type QueryCursorResponse as QueryCursorResponse };
|
|
207
|
+
export import BodyCursor = Pagination.BodyCursor;
|
|
208
|
+
export { type BodyCursorParams as BodyCursorParams, type BodyCursorResponse as BodyCursorResponse };
|
|
189
209
|
export { Health as Health, type HealthCheckResponse as HealthCheckResponse };
|
|
190
|
-
export {
|
|
191
|
-
export {
|
|
192
|
-
export { Profiles as Profiles, type
|
|
193
|
-
export {
|
|
194
|
-
export {
|
|
195
|
-
export
|
|
196
|
-
export
|
|
210
|
+
export { Creators as Creators, type CreatorRetrieveResponse as CreatorRetrieveResponse, type CreatorAutocompleteResponse as CreatorAutocompleteResponse, type CreatorLookalikeResponse as CreatorLookalikeResponse, type CreatorMatchResponse as CreatorMatchResponse, type CreatorLookalikeResponsesBodyCursor as CreatorLookalikeResponsesBodyCursor, type CreatorRetrieveParams as CreatorRetrieveParams, type CreatorAutocompleteParams as CreatorAutocompleteParams, type CreatorLookalikeParams as CreatorLookalikeParams, type CreatorMatchParams as CreatorMatchParams, };
|
|
211
|
+
export { Search as Search, type MatchInfo as MatchInfo, type SearchCreateResponse as SearchCreateResponse, type SearchRetrieveResponse as SearchRetrieveResponse, type SearchRetrieveResponsesQueryCursor as SearchRetrieveResponsesQueryCursor, type SearchCreateParams as SearchCreateParams, type SearchRetrieveParams as SearchRetrieveParams, };
|
|
212
|
+
export { Profiles as Profiles, type ProfileActivity as ProfileActivity, type ProfileGrowth as ProfileGrowth, type ProfileMetrics as ProfileMetrics, type ProfileResponseData as ProfileResponseData, type ProfileGetResponse as ProfileGetResponse, type ProfileLookupResponse as ProfileLookupResponse, type ProfileGetParams as ProfileGetParams, type ProfileLookupParams as ProfileLookupParams, };
|
|
213
|
+
export { Posts as Posts, type PostListResponse as PostListResponse, type PostListResponsesQueryCursor as PostListResponsesQueryCursor, type PostListParams as PostListParams, };
|
|
214
|
+
export { Raw as Raw };
|
|
215
|
+
export type CreatorBasic = API.CreatorBasic;
|
|
216
|
+
export type ProfileSummary = API.ProfileSummary;
|
|
197
217
|
}
|
|
198
218
|
//# sourceMappingURL=client.d.mts.map
|
package/client.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.mts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAGT,KAAK,MAAM;OACX,KAAK,
|
|
1
|
+
{"version":3,"file":"client.d.mts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAGT,KAAK,MAAM;OACX,KAAK,UAAU;OACf,EAEL,KAAK,gBAAgB,EACrB,kBAAkB,EAClB,KAAK,iBAAiB,EACtB,mBAAmB,EACpB;OACM,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,sBAAsB,EACtB,wBAAwB,EACxB,mCAAmC,EACnC,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,QAAQ,EACT;OACM,EAAE,MAAM,EAAE,mBAAmB,EAAE;OAC/B,EAAE,cAAc,EAAE,gBAAgB,EAAE,4BAA4B,EAAE,KAAK,EAAE;OACzE,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACT;OACM,EACL,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,kCAAkC,EACnC;OACM,EAAE,GAAG,EAAE;OACP,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAS;;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAuC,EACvC,MAAqC,EACrC,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;cAI5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAI5F,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAoBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA6JzB,UAAU,CAAC,IAAI,EAAE,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAC9F,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,EACvC,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GACpC,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAS1C,cAAc,CACZ,IAAI,GAAG,OAAO,EACd,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAE/E,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,SAAS,EACvF,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,GAC3C,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAKpC,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;YA+BN,WAAW;YAuBX,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAepC,YAAY,CAChB,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C,OAAO,CAAC;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;YAwBzD,YAAY;IAqC1B,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,SAAS;IA6CjB,MAAM,CAAC,SAAS,mBAAQ;IACxB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAqB;CAClC;AASD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IACnD,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAExG,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEpG,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAE7E,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC;IAEtB,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC5C,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;CACjD"}
|