socialtap 1.558.29 → 1.559.31
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 +1 -1
- package/dist/constants.d.ts +2 -2
- package/dist/constants.js +2 -2
- package/dist/errors.d.ts +6 -7
- package/dist/errors.js +6 -7
- package/dist/models.d.ts +8 -20
- package/dist/resources.d.ts +1 -2
- package/dist/resources.js +1 -2
- package/dist/tooldefs.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
SocialTap is the social media scraper API for developers and AI agents. Send a public link, a handle or a search and get live data back in one schema. Failed requests are free.
|
|
6
6
|
|
|
7
7
|
The TypeScript SDK for the SocialTap API: a method for every endpoint, typed models and errors, retries and pagination.
|
|
8
|
-
Generated from the SocialTap catalog (version 1.
|
|
8
|
+
Generated from the SocialTap catalog (version 1.559.31). Docs: https://socialtap.dev/docs.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
package/dist/constants.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** SDK version: 1.<contract facts>.<generator revision> (sdk/README.md). */
|
|
2
|
-
export declare const VERSION = "1.
|
|
2
|
+
export declare const VERSION = "1.559.31";
|
|
3
3
|
/** The production API origin. */
|
|
4
4
|
export declare const DEFAULT_BASE_URL = "https://socialtap.dev";
|
|
5
5
|
/** Environment variable the API key is read from. */
|
|
@@ -42,7 +42,7 @@ export declare const ERROR_CODES: {
|
|
|
42
42
|
readonly forbidden: {
|
|
43
43
|
readonly status: 403;
|
|
44
44
|
readonly retryable: false;
|
|
45
|
-
readonly remediation: "Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret.
|
|
45
|
+
readonly remediation: "Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.";
|
|
46
46
|
};
|
|
47
47
|
readonly insufficient_credits: {
|
|
48
48
|
readonly status: 402;
|
package/dist/constants.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Code generated by engine/cmd/gensdk (make gen) from catalog/catalog.gen.json; DO NOT EDIT.
|
|
2
2
|
/** SDK version: 1.<contract facts>.<generator revision> (sdk/README.md). */
|
|
3
|
-
export const VERSION = "1.
|
|
3
|
+
export const VERSION = "1.559.31";
|
|
4
4
|
/** The production API origin. */
|
|
5
5
|
export const DEFAULT_BASE_URL = "https://socialtap.dev";
|
|
6
6
|
/** Environment variable the API key is read from. */
|
|
@@ -28,7 +28,7 @@ export const ERROR_CODES = {
|
|
|
28
28
|
invalid_input: { status: 400, retryable: false, remediation: "Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one." },
|
|
29
29
|
invalid_cursor: { status: 400, retryable: false, remediation: "Repeat the original request without cursor to start the list again." },
|
|
30
30
|
unauthorized: { status: 401, retryable: false, remediation: "Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url." },
|
|
31
|
-
forbidden: { status: 403, retryable: false, remediation: "Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret.
|
|
31
|
+
forbidden: { status: 403, retryable: false, remediation: "Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP." },
|
|
32
32
|
insufficient_credits: { status: 402, retryable: false, remediation: "Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically." },
|
|
33
33
|
spend_limit_reached: { status: 402, retryable: false, remediation: "Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically." },
|
|
34
34
|
rate_limited: { status: 429, retryable: true, remediation: "Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one." },
|
package/dist/errors.d.ts
CHANGED
|
@@ -29,15 +29,14 @@ export declare class UnauthorizedError extends APIError {
|
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
31
|
* `forbidden` (HTTP 403): The API key is valid but may not make this request, and details.reason says why: the
|
|
32
|
-
* account is suspended, the key lacks the route's scope,
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* private_or_unavailable, also 403, so branch on the code.
|
|
32
|
+
* account is suspended, the key lacks the route's scope, has expired, or was used from an IP outside its
|
|
33
|
+
* allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job
|
|
34
|
+
* stops with it too when its account is suspended or the key that created it is revoked or expires. It is about
|
|
35
|
+
* the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.
|
|
37
36
|
*
|
|
38
37
|
* Remediation: Act on details.reason. suspended: contact support. scope: use a key with details.required_scope.
|
|
39
|
-
* previous_secret: use the new secret.
|
|
40
|
-
*
|
|
38
|
+
* previous_secret: use the new secret. key_expired or key_revoked: create a new key. ip_not_allowed: call from
|
|
39
|
+
* an allowed IP.
|
|
41
40
|
*/
|
|
42
41
|
export declare class ForbiddenError extends APIError {
|
|
43
42
|
name: string;
|
package/dist/errors.js
CHANGED
|
@@ -31,15 +31,14 @@ export class UnauthorizedError extends APIError {
|
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
33
|
* `forbidden` (HTTP 403): The API key is valid but may not make this request, and details.reason says why: the
|
|
34
|
-
* account is suspended, the key lacks the route's scope,
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* private_or_unavailable, also 403, so branch on the code.
|
|
34
|
+
* account is suspended, the key lacks the route's scope, has expired, or was used from an IP outside its
|
|
35
|
+
* allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job
|
|
36
|
+
* stops with it too when its account is suspended or the key that created it is revoked or expires. It is about
|
|
37
|
+
* the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.
|
|
39
38
|
*
|
|
40
39
|
* Remediation: Act on details.reason. suspended: contact support. scope: use a key with details.required_scope.
|
|
41
|
-
* previous_secret: use the new secret.
|
|
42
|
-
*
|
|
40
|
+
* previous_secret: use the new secret. key_expired or key_revoked: create a new key. ip_not_allowed: call from
|
|
41
|
+
* an allowed IP.
|
|
43
42
|
*/
|
|
44
43
|
export class ForbiddenError extends APIError {
|
|
45
44
|
name = "ForbiddenError";
|
package/dist/models.d.ts
CHANGED
|
@@ -8717,11 +8717,8 @@ export interface APIKey {
|
|
|
8717
8717
|
id: string;
|
|
8718
8718
|
/** Your label for the key. */
|
|
8719
8719
|
name: string;
|
|
8720
|
-
/**
|
|
8721
|
-
|
|
8722
|
-
* /v1/account). expired: past expires_at. Known values: active, pending, expired, revoked.
|
|
8723
|
-
*/
|
|
8724
|
-
status: "active" | "pending" | "expired" | "revoked" | (string & {});
|
|
8720
|
+
/** expired: past expires_at. Known values: active, expired, revoked. */
|
|
8721
|
+
status: "active" | "expired" | "revoked" | (string & {});
|
|
8725
8722
|
/** The secret's first characters, to recognize it. */
|
|
8726
8723
|
prefix: string;
|
|
8727
8724
|
/**
|
|
@@ -8773,11 +8770,8 @@ export interface Account {
|
|
|
8773
8770
|
id: string;
|
|
8774
8771
|
/** The owner's email address: sign-in links, receipts and balance alerts go there. */
|
|
8775
8772
|
email: string;
|
|
8776
|
-
/**
|
|
8777
|
-
|
|
8778
|
-
* pending). Known values: active, unverified.
|
|
8779
|
-
*/
|
|
8780
|
-
status: "active" | "unverified" | (string & {});
|
|
8773
|
+
/** The account's state: active. New values may be added. Known values: active. */
|
|
8774
|
+
status: "active" | (string & {});
|
|
8781
8775
|
/** Plan ID. */
|
|
8782
8776
|
plan: string;
|
|
8783
8777
|
/** Credits the account owns, including those held by requests in flight and unfinished jobs. */
|
|
@@ -9254,11 +9248,8 @@ export interface APIKeyCreated {
|
|
|
9254
9248
|
id: string;
|
|
9255
9249
|
/** Your label for the key. */
|
|
9256
9250
|
name: string;
|
|
9257
|
-
/**
|
|
9258
|
-
|
|
9259
|
-
* /v1/account). expired: past expires_at. Known values: active, pending, expired, revoked.
|
|
9260
|
-
*/
|
|
9261
|
-
status: "active" | "pending" | "expired" | "revoked" | (string & {});
|
|
9251
|
+
/** expired: past expires_at. Known values: active, expired, revoked. */
|
|
9252
|
+
status: "active" | "expired" | "revoked" | (string & {});
|
|
9262
9253
|
/** The secret's first characters, to recognize it. */
|
|
9263
9254
|
prefix: string;
|
|
9264
9255
|
/**
|
|
@@ -9322,11 +9313,8 @@ export interface APIKeyRevoked {
|
|
|
9322
9313
|
id: string;
|
|
9323
9314
|
/** Your label for the key. */
|
|
9324
9315
|
name: string;
|
|
9325
|
-
/**
|
|
9326
|
-
|
|
9327
|
-
* /v1/account). expired: past expires_at. Known values: active, pending, expired, revoked.
|
|
9328
|
-
*/
|
|
9329
|
-
status: "active" | "pending" | "expired" | "revoked" | (string & {});
|
|
9316
|
+
/** expired: past expires_at. Known values: active, expired, revoked. */
|
|
9317
|
+
status: "active" | "expired" | "revoked" | (string & {});
|
|
9330
9318
|
/** The secret's first characters, to recognize it. */
|
|
9331
9319
|
prefix: string;
|
|
9332
9320
|
/**
|
package/dist/resources.d.ts
CHANGED
|
@@ -17876,8 +17876,7 @@ export declare class AccountResource {
|
|
|
17876
17876
|
* `account.get`: Get the account, balance and calling key.
|
|
17877
17877
|
*
|
|
17878
17878
|
* The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit
|
|
17879
|
-
* (with what it used this interval) and expiry. Free; never cached.
|
|
17880
|
-
* else) to learn when its owner confirmed.
|
|
17879
|
+
* (with what it used this interval) and expiry. Free; never cached.
|
|
17881
17880
|
*
|
|
17882
17881
|
* Free; needs an API key with the `account:read` scope (GET /v1/account).
|
|
17883
17882
|
*/
|
package/dist/resources.js
CHANGED
|
@@ -4119,8 +4119,7 @@ export class AccountResource {
|
|
|
4119
4119
|
* `account.get`: Get the account, balance and calling key.
|
|
4120
4120
|
*
|
|
4121
4121
|
* The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit
|
|
4122
|
-
* (with what it used this interval) and expiry. Free; never cached.
|
|
4123
|
-
* else) to learn when its owner confirmed.
|
|
4122
|
+
* (with what it used this interval) and expiry. Free; never cached.
|
|
4124
4123
|
*
|
|
4125
4124
|
* Free; needs an API key with the `account:read` scope (GET /v1/account).
|
|
4126
4125
|
*/
|
package/dist/tooldefs.js
CHANGED
|
@@ -994,7 +994,7 @@ export const TOOLS = [
|
|
|
994
994
|
{
|
|
995
995
|
name: "get_account",
|
|
996
996
|
title: "Get account balance",
|
|
997
|
-
description: "Get the account, balance and calling key. The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit (with what it used this interval) and expiry. Free; never cached.
|
|
997
|
+
description: "Get the account, balance and calling key. The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit (with what it used this interval) and expiry. Free; never cached. Use it to check the credit balance before a large task; every other result already states credits_remaining.",
|
|
998
998
|
inputSchema: {
|
|
999
999
|
"type": "object",
|
|
1000
1000
|
"properties": {},
|